summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/Extensions.ts
blob: d5624332cbb5d42a8c835491c5072fda1f297aab (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
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { Extension, ExtensionJson, ExtensionSchema } from "./Extension";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const EXTENSIONS = "extensions";
const CLEAR_PROPS = [
  EXTENSIONS,
];

export interface IExtensions {
  /**
   * List of extensions
   */
  extensions: Extension[];
}

export type ExtensionsParameters = PkiObjectParameters & Partial<IExtensions>;

export type ExtensionsSchema = Schema.SchemaParameters<{
  extensions?: string;
  extension?: ExtensionSchema;
}>;

export interface ExtensionsJson {
  extensions: ExtensionJson[];
}

/**
 * Represents the Extensions structure described in [RFC5280](https://datatracker.ietf.org/doc/html/rfc5280)
 */
export class Extensions extends PkiObject implements IExtensions {

  public static override CLASS_NAME = "Extensions";

  public extensions!: Extension[];

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

    this.extensions = pvutils.getParametersValue(parameters, EXTENSIONS, Extensions.defaultValues(EXTENSIONS));

    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 EXTENSIONS): Extension[];
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case EXTENSIONS:
        return [];
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
   * ```
   *
   * @param parameters Input parameters for the schema
   * @param optional Flag that current schema should be optional
   * @returns ASN.1 schema object
   */
  public static override schema(parameters: ExtensionsSchema = {}, optional = false) {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      optional,
      name: (names.blockName || EMPTY_STRING),
      value: [
        new asn1js.Repeated({
          name: (names.extensions || EMPTY_STRING),
          value: Extension.schema(names.extension || {})
        })
      ]
    }));
  }

  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,
      Extensions.schema({
        names: {
          extensions: EXTENSIONS
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

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

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

  public toJSON(): ExtensionsJson {
    return {
      extensions: this.extensions.map(o => o.toJSON())
    };
  }

}