summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/QCStatements.ts
blob: 7484235e427180c7c07f4fc1861b823d7e66b9aa (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
286
287
288
289
290
291
292
293
294
295
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const ID = "id";
const TYPE = "type";
const VALUES = "values";
const QC_STATEMENT_CLEAR_PROPS = [
  ID,
  TYPE
];
const QC_STATEMENTS_CLEAR_PROPS = [
  VALUES
];

export interface IQCStatement {
  id: string;
  type?: any;
}

export interface QCStatementJson {
  id: string;
  type?: any;
}

export type QCStatementParameters = PkiObjectParameters & Partial<IQCStatement>;

export type QCStatementSchema = Schema.SchemaParameters<{
  id?: string;
  type?: string;
}>;

/**
 * Represents the QCStatement structure described in [RFC3739](https://datatracker.ietf.org/doc/html/rfc3739)
 */
export class QCStatement extends PkiObject implements IQCStatement {

  public static override CLASS_NAME = "QCStatement";

  public id!: string;
  public type?: any;

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

    this.id = pvutils.getParametersValue(parameters, ID, QCStatement.defaultValues(ID));
    if (TYPE in parameters) {
      this.type = pvutils.getParametersValue(parameters, TYPE, QCStatement.defaultValues(TYPE));
    }

    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 ID): string;
  public static override defaultValues(memberName: typeof TYPE): any;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case ID:
        return EMPTY_STRING;
      case TYPE:
        return new asn1js.Null();
      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 ID:
        return (memberValue === EMPTY_STRING);
      case TYPE:
        return (memberValue instanceof asn1js.Null);
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * QCStatement ::= SEQUENCE {
   *       statementId   QC-STATEMENT.&id({SupportedStatements}),
   *       statementInfo QC-STATEMENT.&Type({SupportedStatements}{@statementId}) OPTIONAL
   *   }
   *```
   */
  public static override schema(parameters: QCStatementSchema = {}): 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.id || EMPTY_STRING) }),
        new asn1js.Any({
          name: (names.type || EMPTY_STRING),
          optional: true
        })
      ]
    }));
  }

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

    // Check the schema is valid
    const asn1 = asn1js.compareSchema(schema,
      schema,
      QCStatement.schema({
        names: {
          id: ID,
          type: TYPE
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.id = asn1.result.id.valueBlock.toString();
    if (TYPE in asn1.result)
      this.type = asn1.result.type;
  }

  public toSchema(): asn1js.Sequence {
    const value = [
      new asn1js.ObjectIdentifier({ value: this.id })
    ];

    if (TYPE in this)
      value.push(this.type);

    // Construct and return new ASN.1 schema for this object
    return (new asn1js.Sequence({
      value,
    }));
  }

  public toJSON(): QCStatementJson {
    const object: any = {
      id: this.id
    };

    if (this.type) {
      object.type = this.type.toJSON();
    }

    return object;
  }

}

export interface IQCStatements {
  values: QCStatement[];
}

export interface QCStatementsJson {
  values: QCStatementJson[];
}

export type QCStatementsParameters = PkiObjectParameters & Partial<IQCStatements>;

/**
 * Represents the QCStatements structure described in [RFC3739](https://datatracker.ietf.org/doc/html/rfc3739)
 */
export class QCStatements extends PkiObject implements IQCStatements {

  public static override CLASS_NAME = "QCStatements";

  public values!: QCStatement[];

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

    this.values = pvutils.getParametersValue(parameters, VALUES, QCStatements.defaultValues(VALUES));

    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 VALUES): QCStatement[];
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case VALUES:
        return [];
      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 VALUES:
        return (memberValue.length === 0);
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * QCStatements ::= SEQUENCE OF QCStatement
   *```
   */
  public static override schema(parameters: Schema.SchemaParameters<{
    values?: string;
    value?: QCStatementSchema;
  }> = {}): Schema.SchemaType {
    /**
     * @type {Object}
     * @property {string} [blockName]
     * @property {string} [values]
     */
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        new asn1js.Repeated({
          name: (names.values || EMPTY_STRING),
          value: QCStatement.schema(names.value || {})
        }),
      ]
    }));
  }

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

    // Check the schema is valid
    const asn1 = asn1js.compareSchema(schema,
      schema,
      QCStatements.schema({
        names: {
          values: VALUES
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.values = Array.from(asn1.result.values, element => new QCStatement({ schema: element }));
  }

  public toSchema(): asn1js.Sequence {
    // Construct and return new ASN.1 schema for this object
    return (new asn1js.Sequence({
      value: Array.from(this.values, o => o.toSchema())
    }));
  }

  public toJSON(): QCStatementsJson {
    return {
      values: Array.from(this.values, o => o.toJSON())
    };
  }

}