summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/EncryptedContentInfo.ts
blob: 9dd6b6c270368c0618bc4ef1900a2df9ef7516ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { AlgorithmIdentifier, AlgorithmIdentifierJson, AlgorithmIdentifierSchema } from "./AlgorithmIdentifier";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const CONTENT_TYPE = "contentType";
const CONTENT_ENCRYPTION_ALGORITHM = "contentEncryptionAlgorithm";
const ENCRYPTED_CONTENT = "encryptedContent";
const CLEAR_PROPS = [
  CONTENT_TYPE,
  CONTENT_ENCRYPTION_ALGORITHM,
  ENCRYPTED_CONTENT,
];

export interface IEncryptedContentInfo {
  contentType: string;
  contentEncryptionAlgorithm: AlgorithmIdentifier;
  encryptedContent?: asn1js.OctetString;
}

export interface EncryptedContentInfoJson {
  contentType: string;
  contentEncryptionAlgorithm: AlgorithmIdentifierJson;
  encryptedContent?: asn1js.OctetStringJson;
}

export type EncryptedContentParameters = PkiObjectParameters & Partial<IEncryptedContentInfo>;

export type EncryptedContentInfoSchema = Schema.SchemaParameters<{
  contentType?: string;
  contentEncryptionAlgorithm?: AlgorithmIdentifierSchema;
  encryptedContent?: string;
}>;

/**
 * Represents the EncryptedContentInfo structure described in [RFC5652](https://datatracker.ietf.org/doc/html/rfc5652)
 */
export class EncryptedContentInfo extends PkiObject implements IEncryptedContentInfo {

  public static override CLASS_NAME = "EncryptedContentInfo";

  public contentType!: string;
  public contentEncryptionAlgorithm!: AlgorithmIdentifier;
  public encryptedContent?: asn1js.OctetString;

  /**
   * Initializes a new instance of the {@link EncryptedContent} class
   * @param parameters Initialization parameters
   */
  constructor(parameters: EncryptedContentParameters = {}) {
    super();

    this.contentType = pvutils.getParametersValue(parameters, CONTENT_TYPE, EncryptedContentInfo.defaultValues(CONTENT_TYPE));
    this.contentEncryptionAlgorithm = pvutils.getParametersValue(parameters, CONTENT_ENCRYPTION_ALGORITHM, EncryptedContentInfo.defaultValues(CONTENT_ENCRYPTION_ALGORITHM));

    if (ENCRYPTED_CONTENT in parameters && parameters.encryptedContent) {
      // encryptedContent (!!!) could be constructive or primitive value (!!!)
      this.encryptedContent = parameters.encryptedContent;

      if ((this.encryptedContent.idBlock.tagClass === 1) &&
        (this.encryptedContent.idBlock.tagNumber === 4)) {
        //#region Divide OCTET STRING value down to small pieces
        if (this.encryptedContent.idBlock.isConstructed === false) {
          const constrString = new asn1js.OctetString({
            idBlock: { isConstructed: true },
            isConstructed: true
          });

          let offset = 0;
          const valueHex = this.encryptedContent.valueBlock.valueHexView.slice().buffer;
          let length = valueHex.byteLength;

          const pieceSize = 1024;
          while (length > 0) {
            const pieceView = new Uint8Array(valueHex, offset, ((offset + pieceSize) > valueHex.byteLength) ? (valueHex.byteLength - offset) : pieceSize);
            const _array = new ArrayBuffer(pieceView.length);
            const _view = new Uint8Array(_array);

            for (let i = 0; i < _view.length; i++)
              _view[i] = pieceView[i];

            constrString.valueBlock.value.push(new asn1js.OctetString({ valueHex: _array }));

            length -= pieceView.length;
            offset += pieceView.length;
          }

          this.encryptedContent = constrString;
        }
        //#endregion
      }
    }

    if (parameters.schema) {
      this.fromSchema(parameters.schema);
    }
  }

  /**
   * Returns default values for all class members
   * @param memberName String name for a class member
   * @returns Default value
   */
  public static override defaultValues(memberName: typeof CONTENT_TYPE): string;
  public static override defaultValues(memberName: typeof CONTENT_ENCRYPTION_ALGORITHM): AlgorithmIdentifier;
  public static override defaultValues(memberName: typeof ENCRYPTED_CONTENT): asn1js.OctetString;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case CONTENT_TYPE:
        return EMPTY_STRING;
      case CONTENT_ENCRYPTION_ALGORITHM:
        return new AlgorithmIdentifier();
      case ENCRYPTED_CONTENT:
        return new asn1js.OctetString();
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * Compare values with default values for all class members
   * @param memberName String name for a class member
   * @param memberValue Value to compare with default value
   */
  public static compareWithDefault(memberName: string, memberValue: any): boolean {
    switch (memberName) {
      case CONTENT_TYPE:
        return (memberValue === EMPTY_STRING);
      case CONTENT_ENCRYPTION_ALGORITHM:
        return ((memberValue.algorithmId === EMPTY_STRING) && (("algorithmParams" in memberValue) === false));
      case ENCRYPTED_CONTENT:
        return (memberValue.isEqual(EncryptedContentInfo.defaultValues(ENCRYPTED_CONTENT)));
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * EncryptedContentInfo ::= SEQUENCE {
   *    contentType ContentType,
   *    contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
   *    encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL }
   *
   * Comment: Strange, but modern crypto engines create ENCRYPTED_CONTENT as "[0] EXPLICIT EncryptedContent"
   *
   * EncryptedContent ::= OCTET STRING
   *```
   */
  public static override schema(parameters: EncryptedContentInfoSchema = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        new asn1js.ObjectIdentifier({ name: (names.contentType || EMPTY_STRING) }),
        AlgorithmIdentifier.schema(names.contentEncryptionAlgorithm || {}),
        // The CHOICE we need because ENCRYPTED_CONTENT could have either "constructive"
        // or "primitive" form of encoding and we need to handle both variants
        new asn1js.Choice({
          value: [
            new asn1js.Constructed({
              name: (names.encryptedContent || EMPTY_STRING),
              idBlock: {
                tagClass: 3, // CONTEXT-SPECIFIC
                tagNumber: 0 // [0]
              },
              value: [
                new asn1js.Repeated({
                  value: new asn1js.OctetString()
                })
              ]
            }),
            new asn1js.Primitive({
              name: (names.encryptedContent || EMPTY_STRING),
              idBlock: {
                tagClass: 3, // CONTEXT-SPECIFIC
                tagNumber: 0 // [0]
              }
            })
          ]
        })
      ]
    }));
  }

  public fromSchema(schema: Schema.SchemaType): void {
    // Clear input data first
    pvutils.clearProps(schema, CLEAR_PROPS);

    // Check the schema is valid
    const asn1 = asn1js.compareSchema(schema,
      schema,
      EncryptedContentInfo.schema({
        names: {
          contentType: CONTENT_TYPE,
          contentEncryptionAlgorithm: {
            names: {
              blockName: CONTENT_ENCRYPTION_ALGORITHM
            }
          },
          encryptedContent: ENCRYPTED_CONTENT
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.contentType = asn1.result.contentType.valueBlock.toString();
    this.contentEncryptionAlgorithm = new AlgorithmIdentifier({ schema: asn1.result.contentEncryptionAlgorithm });
    if (ENCRYPTED_CONTENT in asn1.result) {
      this.encryptedContent = asn1.result.encryptedContent as asn1js.OctetString;

      this.encryptedContent.idBlock.tagClass = 1; // UNIVERSAL
      this.encryptedContent.idBlock.tagNumber = 4; // OCTET STRING (!!!) The value still has instance of "in_window.org.pkijs.asn1.ASN1_CONSTRUCTED / ASN1_PRIMITIVE"
    }
  }

  public toSchema(): asn1js.Sequence {
    //#region Create array for output sequence
    const sequenceLengthBlock = {
      isIndefiniteForm: false
    };

    const outputArray = [];

    outputArray.push(new asn1js.ObjectIdentifier({ value: this.contentType }));
    outputArray.push(this.contentEncryptionAlgorithm.toSchema());

    if (this.encryptedContent) {
      sequenceLengthBlock.isIndefiniteForm = this.encryptedContent.idBlock.isConstructed;

      const encryptedValue = this.encryptedContent;

      encryptedValue.idBlock.tagClass = 3; // CONTEXT-SPECIFIC
      encryptedValue.idBlock.tagNumber = 0; // [0]

      encryptedValue.lenBlock.isIndefiniteForm = this.encryptedContent.idBlock.isConstructed;

      outputArray.push(encryptedValue);
    }
    //#endregion

    //#region Construct and return new ASN.1 schema for this object
    return (new asn1js.Sequence({
      lenBlock: sequenceLengthBlock,
      value: outputArray
    }));
    //#endregion
  }

  public toJSON(): EncryptedContentInfoJson {
    const res: EncryptedContentInfoJson = {
      contentType: this.contentType,
      contentEncryptionAlgorithm: this.contentEncryptionAlgorithm.toJSON()
    };

    if (this.encryptedContent) {
      res.encryptedContent = this.encryptedContent.toJSON();
    }

    return res;
  }

  /**
   * Returns concatenated buffer from `encryptedContent` field.
   * @returns Array buffer
   * @since 3.0.0
   * @throws Throws Error if `encryptedContent` is undefined
   */
  public getEncryptedContent(): ArrayBuffer {
    if (!this.encryptedContent) {
      throw new Error("Parameter 'encryptedContent' is undefined");
    }
    // NOTE encryptedContent can be CONSTRUCTED/PRIMITIVE
    return asn1js.OctetString.prototype.getValue.call(this.encryptedContent);
  }

}