summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/OriginatorInfo.ts
blob: 21b24b6968815dcf658d20c0ed91c39e8d7b7d36 (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
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { CertificateSet, CertificateSetJson } from "./CertificateSet";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import { RevocationInfoChoices, RevocationInfoChoicesJson } from "./RevocationInfoChoices";
import * as Schema from "./Schema";

const CERTS = "certs";
const CRLS = "crls";
const CLEAR_PROPS = [
  CERTS,
  CRLS,
];

export interface IOriginatorInfo {
  /**
   * Collection of certificates. In may contain originator certificates associated with several different
   * key management algorithms. It may also contain attribute certificates associated with the originator.
   */
  certs?: CertificateSet;
  /**
   * Collection of CRLs. It is intended that the set contain information sufficient to determine whether
   * or not the certificates in the certs field are valid, but such correspondence is not necessary
   */
  crls?: RevocationInfoChoices;
}

export interface OriginatorInfoJson {
  certs?: CertificateSetJson;
  crls?: RevocationInfoChoicesJson;
}

export type OriginatorInfoParameters = PkiObjectParameters & Partial<IOriginatorInfo>;

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

  public static override CLASS_NAME = "OriginatorInfo";

  public certs?: CertificateSet;
  public crls?: RevocationInfoChoices;

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

    this.crls = pvutils.getParametersValue(parameters, CRLS, OriginatorInfo.defaultValues(CRLS));

    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 CERTS): CertificateSet;
  public static override defaultValues(memberName: typeof CRLS): RevocationInfoChoices;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case CERTS:
        return new CertificateSet();
      case CRLS:
        return new RevocationInfoChoices();
      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 CERTS:
        return (memberValue.certificates.length === 0);
      case CRLS:
        return ((memberValue.crls.length === 0) && (memberValue.otherRevocationInfos.length === 0));
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * OriginatorInfo ::= SEQUENCE {
   *    certs [0] IMPLICIT CertificateSet OPTIONAL,
   *    crls [1] IMPLICIT RevocationInfoChoices OPTIONAL }
   *```
   */
  public static override schema(parameters: Schema.SchemaParameters<{
    certs?: string;
    crls?: string;
  }> = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        new asn1js.Constructed({
          name: (names.certs || EMPTY_STRING),
          optional: true,
          idBlock: {
            tagClass: 3, // CONTEXT-SPECIFIC
            tagNumber: 0 // [0]
          },
          value: CertificateSet.schema().valueBlock.value
        }),
        new asn1js.Constructed({
          name: (names.crls || EMPTY_STRING),
          optional: true,
          idBlock: {
            tagClass: 3, // CONTEXT-SPECIFIC
            tagNumber: 1 // [1]
          },
          value: RevocationInfoChoices.schema().valueBlock.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,
      OriginatorInfo.schema({
        names: {
          certs: CERTS,
          crls: CRLS
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    if (CERTS in asn1.result) {
      this.certs = new CertificateSet({
        schema: new asn1js.Set({
          value: asn1.result.certs.valueBlock.value
        })
      });
    }
    if (CRLS in asn1.result) {
      this.crls = new RevocationInfoChoices({
        schema: new asn1js.Set({
          value: asn1.result.crls.valueBlock.value
        })
      });
    }
  }

  public toSchema(): asn1js.Sequence {
    const sequenceValue = [];

    if (this.certs) {
      sequenceValue.push(new asn1js.Constructed({
        idBlock: {
          tagClass: 3, // CONTEXT-SPECIFIC
          tagNumber: 0 // [0]
        },
        value: this.certs.toSchema().valueBlock.value
      }));
    }

    if (this.crls) {
      sequenceValue.push(new asn1js.Constructed({
        idBlock: {
          tagClass: 3, // CONTEXT-SPECIFIC
          tagNumber: 1 // [1]
        },
        value: this.crls.toSchema().valueBlock.value
      }));
    }

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

  public toJSON(): OriginatorInfoJson {
    const res: OriginatorInfoJson = {};

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

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

    return res;
  }

}