summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/IssuerAndSerialNumber.ts
blob: 94972ccbb5fe90f45e5a80650920e0f4621d21f0 (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
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 { RelativeDistinguishedNames, RelativeDistinguishedNamesJson, RelativeDistinguishedNamesSchema } from "./RelativeDistinguishedNames";
import * as Schema from "./Schema";

const ISSUER = "issuer";
const SERIAL_NUMBER = "serialNumber";
const CLEAR_PROPS = [
  ISSUER,
  SERIAL_NUMBER,
];

export interface IIssuerAndSerialNumber {
  /**
   * Certificate issuer name
   */
  issuer: RelativeDistinguishedNames;
  /**
   * Certificate serial number
   */
  serialNumber: asn1js.Integer;
}

export interface IssuerAndSerialNumberJson {
  issuer: RelativeDistinguishedNamesJson;
  serialNumber: asn1js.IntegerJson;
}

export type IssuerAndSerialNumberParameters = PkiObjectParameters & Partial<IIssuerAndSerialNumber>;

export type IssuerAndSerialNumberSchema = Schema.SchemaParameters<{
  issuer?: RelativeDistinguishedNamesSchema;
  serialNumber?: string;
}>;

/**
 * Represents the IssuerAndSerialNumber structure described in [RFC5652](https://datatracker.ietf.org/doc/html/rfc5652)
 */
export class IssuerAndSerialNumber extends PkiObject implements IIssuerAndSerialNumber {

  public static override CLASS_NAME = "IssuerAndSerialNumber";

  public issuer!: RelativeDistinguishedNames;
  public serialNumber!: asn1js.Integer;

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

    this.issuer = pvutils.getParametersValue(parameters, ISSUER, IssuerAndSerialNumber.defaultValues(ISSUER));
    this.serialNumber = pvutils.getParametersValue(parameters, SERIAL_NUMBER, IssuerAndSerialNumber.defaultValues(SERIAL_NUMBER));

    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 ISSUER): RelativeDistinguishedNames;
  public static override defaultValues(memberName: typeof SERIAL_NUMBER): asn1js.Integer;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case ISSUER:
        return new RelativeDistinguishedNames();
      case SERIAL_NUMBER:
        return new asn1js.Integer();
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * IssuerAndSerialNumber ::= SEQUENCE {
   *    issuer Name,
   *    serialNumber CertificateSerialNumber }
   *
   * CertificateSerialNumber ::= INTEGER
   *```
   */
  public static override schema(parameters: IssuerAndSerialNumberSchema = {}): Schema.SchemaType {
    /**
     * @type {Object}
     * @property {string} [blockName]
     * @property {string} [issuer]
     * @property {string} [serialNumber]
     */
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        RelativeDistinguishedNames.schema(names.issuer || {}),
        new asn1js.Integer({ name: (names.serialNumber || 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,
      IssuerAndSerialNumber.schema({
        names: {
          issuer: {
            names: {
              blockName: ISSUER
            }
          },
          serialNumber: SERIAL_NUMBER
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.issuer = new RelativeDistinguishedNames({ schema: asn1.result.issuer });
    this.serialNumber = asn1.result.serialNumber;
  }

  public toSchema(): asn1js.Sequence {
    // Construct and return new ASN.1 schema for this object
    return (new asn1js.Sequence({
      value: [
        this.issuer.toSchema(),
        this.serialNumber
      ]
    }));
  }

  public toJSON(): IssuerAndSerialNumberJson {
    return {
      issuer: this.issuer.toJSON(),
      serialNumber: this.serialNumber.toJSON(),
    };
  }

}