summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/BasicConstraints.ts
blob: 928ae52fb1c3159637654e9c6a94d61dc40d3943 (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
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 PATH_LENGTH_CONSTRAINT = "pathLenConstraint";
const CA = "cA";

export interface IBasicConstraints {
  cA: boolean;
  pathLenConstraint?: number | asn1js.Integer;
}

export type BasicConstraintsParameters = PkiObjectParameters & Partial<IBasicConstraints>;

export interface BasicConstraintsJson {
  cA?: boolean;
  pathLenConstraint?: asn1js.IntegerJson | number;
}

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

  public static override CLASS_NAME = "BasicConstraints";

  public cA!: boolean;
  public pathLenConstraint?: number | asn1js.Integer;

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

    this.cA = pvutils.getParametersValue(parameters, CA, false);
    if (PATH_LENGTH_CONSTRAINT in parameters) {
      this.pathLenConstraint = pvutils.getParametersValue(parameters, PATH_LENGTH_CONSTRAINT, 0);
    }

    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 CA): boolean;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case CA:
        return false;
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * BasicConstraints ::= SEQUENCE {
   *    cA                      BOOLEAN DEFAULT FALSE,
   *    pathLenConstraint       INTEGER (0..MAX) OPTIONAL }
   *```
   */
  static override schema(parameters: Schema.SchemaParameters<{ cA?: string; pathLenConstraint?: 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.Boolean({
          optional: true,
          name: (names.cA || EMPTY_STRING)
        }),
        new asn1js.Integer({
          optional: true,
          name: (names.pathLenConstraint || EMPTY_STRING)
        })
      ]
    }));
  }

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

    // Check the schema is valid
    const asn1 = asn1js.compareSchema(schema,
      schema,
      BasicConstraints.schema({
        names: {
          cA: CA,
          pathLenConstraint: PATH_LENGTH_CONSTRAINT
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    //#region Get internal properties from parsed schema
    if (CA in asn1.result) {
      this.cA = asn1.result.cA.valueBlock.value;
    }

    if (PATH_LENGTH_CONSTRAINT in asn1.result) {
      if (asn1.result.pathLenConstraint.valueBlock.isHexOnly) {
        this.pathLenConstraint = asn1.result.pathLenConstraint;
      } else {
        this.pathLenConstraint = asn1.result.pathLenConstraint.valueBlock.valueDec;
      }
    }
    //#endregion
  }

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

    if (this.cA !== BasicConstraints.defaultValues(CA))
      outputArray.push(new asn1js.Boolean({ value: this.cA }));

    if (PATH_LENGTH_CONSTRAINT in this) {
      if (this.pathLenConstraint instanceof asn1js.Integer) {
        outputArray.push(this.pathLenConstraint);
      } else {
        outputArray.push(new asn1js.Integer({ value: this.pathLenConstraint }));
      }
    }
    //#endregion

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

  /**
   * Conversion for the class to JSON object
   * @returns
   */
  public toJSON(): BasicConstraintsJson {
    const object: BasicConstraintsJson = {};

    if (this.cA !== BasicConstraints.defaultValues(CA)) {
      object.cA = this.cA;
    }

    if (PATH_LENGTH_CONSTRAINT in this) {
      if (this.pathLenConstraint instanceof asn1js.Integer) {
        object.pathLenConstraint = this.pathLenConstraint.toJSON();
      } else {
        object.pathLenConstraint = this.pathLenConstraint;
      }
    }

    return object;
  }

}