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

const NAMES = "names";
const GENERAL_NAMES = "generalNames";

export interface IGeneralNames {
  names: GeneralName[];
}

export type GeneralNamesParameters = PkiObjectParameters & Partial<IGeneralNames>;

export type GeneralNamesSchema = Schema.SchemaParameters<{
  generalNames?: string;
}>;

export interface GeneralNamesJson {
  names: GeneralNameJson[];
}

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

  public static override CLASS_NAME = "GeneralNames";

  /**
   * Array of "general names"
   */
  public names!: GeneralName[];

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

    this.names = pvutils.getParametersValue(parameters, NAMES, GeneralNames.defaultValues(NAMES));

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

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * GeneralNames ::= SEQUENCE SIZE (1..MAX) OF GeneralName
   * ```
   *
   * @param parameters Input parameters for the schema
   * @param optional Flag would be element optional or not
   * @returns ASN.1 schema object
   */
  public static override schema(parameters: GeneralNamesSchema = {}, optional = false): Schema.SchemaType {
    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.generalNames || EMPTY_STRING),
          value: GeneralName.schema()
        })
      ]
    }));
  }

  public fromSchema(schema: Schema.SchemaType): void {
    //#region Clear input data first
    pvutils.clearProps(schema, [
      NAMES,
      GENERAL_NAMES
    ]);
    //#endregion

    //#region Check the schema is valid
    const asn1 = asn1js.compareSchema(schema,
      schema,
      GeneralNames.schema({
        names: {
          blockName: NAMES,
          generalNames: GENERAL_NAMES
        }
      })
    );

    AsnError.assertSchema(asn1, this.className);
    //#endregion

    this.names = Array.from(asn1.result.generalNames, element => new GeneralName({ schema: element }));
  }

  public toSchema(): asn1js.Sequence {
    return (new asn1js.Sequence({
      value: Array.from(this.names, o => o.toSchema())
    }));
  }

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

}