summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/ContentInfo.ts
blob: 020e42434554a2fb44edefff51dd2ee56dfbce90 (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
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { id_ContentType_Data, id_ContentType_EncryptedData, id_ContentType_EnvelopedData, id_ContentType_SignedData } from "./ObjectIdentifiers";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const CONTENT_TYPE = "contentType";
const CONTENT = "content";
const CLEAR_PROPS = [CONTENT_TYPE, CONTENT];

export interface IContentInfo {
  contentType: string;
  content: any;
}

export type ContentInfoParameters = PkiObjectParameters & Partial<IContentInfo>;

export type ContentInfoSchema = Schema.SchemaParameters<{
  contentType?: string;
  content?: string;
}>;

export interface ContentInfoJson {
  contentType: string;
  content?: any;
}

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

  public static override CLASS_NAME = "ContentInfo";
  public static readonly DATA = id_ContentType_Data;
  public static readonly SIGNED_DATA = id_ContentType_SignedData;
  public static readonly ENVELOPED_DATA = id_ContentType_EnvelopedData;
  public static readonly ENCRYPTED_DATA = id_ContentType_EncryptedData;

  public contentType!: string;
  public content: any;

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

    this.contentType = pvutils.getParametersValue(parameters, CONTENT_TYPE, ContentInfo.defaultValues(CONTENT_TYPE));
    this.content = pvutils.getParametersValue(parameters, CONTENT, ContentInfo.defaultValues(CONTENT));

    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): any;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case CONTENT_TYPE:
        return EMPTY_STRING;
      case CONTENT:
        return new asn1js.Any();
      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
   */
  static compareWithDefault<T>(memberName: string, memberValue: T): memberValue is T {
    switch (memberName) {
      case CONTENT_TYPE:
        return (typeof memberValue === "string" &&
          memberValue === this.defaultValues(CONTENT_TYPE));
      case CONTENT:
        return (memberValue instanceof asn1js.Any);
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * ContentInfo ::= SEQUENCE {
   *    contentType ContentType,
   *    content [0] EXPLICIT ANY DEFINED BY contentType }
   *```
   */
  public static override schema(parameters: ContentInfoSchema = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    if (("optional" in names) === false) {
      names.optional = false;
    }

    return (new asn1js.Sequence({
      name: (names.blockName || "ContentInfo"),
      optional: names.optional,
      value: [
        new asn1js.ObjectIdentifier({ name: (names.contentType || CONTENT_TYPE) }),
        new asn1js.Constructed({
          idBlock: {
            tagClass: 3, // CONTEXT-SPECIFIC
            tagNumber: 0 // [0]
          },
          value: [new asn1js.Any({ name: (names.content || CONTENT) })] // EXPLICIT ANY value
        })
      ]
    }));
  }

  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,
      ContentInfo.schema()
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.contentType = asn1.result.contentType.valueBlock.toString();
    this.content = asn1.result.content;
  }

  public toSchema(): asn1js.Sequence {
    //#region Construct and return new ASN.1 schema for this object
    return (new asn1js.Sequence({
      value: [
        new asn1js.ObjectIdentifier({ value: this.contentType }),
        new asn1js.Constructed({
          idBlock: {
            tagClass: 3, // CONTEXT-SPECIFIC
            tagNumber: 0 // [0]
          },
          value: [this.content] // EXPLICIT ANY value
        })
      ]
    }));
    //#endregion
  }

  public toJSON(): ContentInfoJson {
    const object: ContentInfoJson = {
      contentType: this.contentType
    };

    if (!(this.content instanceof asn1js.Any)) {
      object.content = this.content.toJSON();
    }

    return object;
  }

}