summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/GeneralSubtree.ts
blob: 15f1c1f86070d69ecde6cd04cabc0c592f24f495 (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
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { GeneralName, GeneralNameJson, GeneralNameSchema } from "./GeneralName";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const BASE = "base";
const MINIMUM = "minimum";
const MAXIMUM = "maximum";
const CLEAR_PROPS = [
  BASE,
  MINIMUM,
  MAXIMUM
];

export interface IGeneralSubtree {
  base: GeneralName;
  minimum: number | asn1js.Integer;
  maximum?: number | asn1js.Integer;
}

export interface GeneralSubtreeJson {
  base: GeneralNameJson;
  minimum?: number | asn1js.IntegerJson;
  maximum?: number | asn1js.IntegerJson;
}

export type GeneralSubtreeParameters = PkiObjectParameters & Partial<IGeneralSubtree>;

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

  public static override CLASS_NAME = "GeneralSubtree";

  public base!: GeneralName;
  public minimum!: number | asn1js.Integer;
  public maximum?: number | asn1js.Integer;

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

    this.base = pvutils.getParametersValue(parameters, BASE, GeneralSubtree.defaultValues(BASE));
    this.minimum = pvutils.getParametersValue(parameters, MINIMUM, GeneralSubtree.defaultValues(MINIMUM));
    if (MAXIMUM in parameters) {
      this.maximum = pvutils.getParametersValue(parameters, MAXIMUM, GeneralSubtree.defaultValues(MAXIMUM));
    }

    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 BASE): GeneralName;
  public static override defaultValues(memberName: typeof MINIMUM): number;
  public static override defaultValues(memberName: typeof MAXIMUM): number;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case BASE:
        return new GeneralName();
      case MINIMUM:
        return 0;
      case MAXIMUM:
        return 0;
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * GeneralSubtree ::= SEQUENCE {
   *    base                    GeneralName,
   *    minimum         [0]     BaseDistance DEFAULT 0,
   *    maximum         [1]     BaseDistance OPTIONAL }
   *
   * BaseDistance ::= INTEGER (0..MAX)
   *```
   */
  public static override schema(parameters: Schema.SchemaParameters<{
    base?: GeneralNameSchema;
    minimum?: string;
    maximum?: string;
  }> = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        GeneralName.schema(names.base || {}),
        new asn1js.Constructed({
          optional: true,
          idBlock: {
            tagClass: 3, // CONTEXT-SPECIFIC
            tagNumber: 0 // [0]
          },
          value: [new asn1js.Integer({ name: (names.minimum || EMPTY_STRING) })]
        }),
        new asn1js.Constructed({
          optional: true,
          idBlock: {
            tagClass: 3, // CONTEXT-SPECIFIC
            tagNumber: 1 // [1]
          },
          value: [new asn1js.Integer({ name: (names.maximum || EMPTY_STRING) })]
        })
      ]
    }));
  }

  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,
      GeneralSubtree.schema({
        names: {
          base: {
            names: {
              blockName: BASE
            }
          },
          minimum: MINIMUM,
          maximum: MAXIMUM
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.base = new GeneralName({ schema: asn1.result.base });

    if (MINIMUM in asn1.result) {
      if (asn1.result.minimum.valueBlock.isHexOnly)
        this.minimum = asn1.result.minimum;
      else
        this.minimum = asn1.result.minimum.valueBlock.valueDec;
    }

    if (MAXIMUM in asn1.result) {
      if (asn1.result.maximum.valueBlock.isHexOnly)
        this.maximum = asn1.result.maximum;
      else
        this.maximum = asn1.result.maximum.valueBlock.valueDec;
    }
  }

  public toSchema(): asn1js.Sequence {
    //#region Create array for output sequence
    const outputArray = [];

    outputArray.push(this.base.toSchema());

    if (this.minimum !== 0) {
      let valueMinimum: number | asn1js.Integer = 0;

      if (this.minimum instanceof asn1js.Integer) {
        valueMinimum = this.minimum;
      } else {
        valueMinimum = new asn1js.Integer({ value: this.minimum });
      }

      outputArray.push(new asn1js.Constructed({
        optional: true,
        idBlock: {
          tagClass: 3, // CONTEXT-SPECIFIC
          tagNumber: 0 // [0]
        },
        value: [valueMinimum]
      }));
    }

    if (MAXIMUM in this) {
      let valueMaximum: number | asn1js.Integer = 0;

      if (this.maximum instanceof asn1js.Integer) {
        valueMaximum = this.maximum;
      } else {
        valueMaximum = new asn1js.Integer({ value: this.maximum });
      }

      outputArray.push(new asn1js.Constructed({
        optional: true,
        idBlock: {
          tagClass: 3, // CONTEXT-SPECIFIC
          tagNumber: 1 // [1]
        },
        value: [valueMaximum]
      }));
    }
    //#endregion

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

  public toJSON(): GeneralSubtreeJson {
    const res: GeneralSubtreeJson = {
      base: this.base.toJSON()
    };

    if (this.minimum !== 0) {
      if (typeof this.minimum === "number") {
        res.minimum = this.minimum;
      } else {
        res.minimum = this.minimum.toJSON();
      }
    }

    if (this.maximum !== undefined) {
      if (typeof this.maximum === "number") {
        res.maximum = this.maximum;
      } else {
        res.maximum = this.maximum.toJSON();
      }
    }

    return res;
  }

}