summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/OriginatorPublicKey.ts
blob: 57e2a902750b2e2f5867244cf34ce1d810293868 (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
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { AlgorithmIdentifier, AlgorithmIdentifierJson, AlgorithmIdentifierSchema } from "./AlgorithmIdentifier";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const ALGORITHM = "algorithm";
const PUBLIC_KEY = "publicKey";
const CLEAR_PROPS = [
  ALGORITHM,
  PUBLIC_KEY
];

export interface IOriginatorPublicKey {
  algorithm: AlgorithmIdentifier;
  publicKey: asn1js.BitString;
}

export interface OriginatorPublicKeyJson {
  algorithm: AlgorithmIdentifierJson;
  publicKey: asn1js.BitStringJson;
}

export type OriginatorPublicKeyParameters = PkiObjectParameters & Partial<IOriginatorPublicKey>;

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

  public static override CLASS_NAME = "OriginatorPublicKey";

  public algorithm!: AlgorithmIdentifier;
  public publicKey!: asn1js.BitString;

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

    this.algorithm = pvutils.getParametersValue(parameters, ALGORITHM, OriginatorPublicKey.defaultValues(ALGORITHM));
    this.publicKey = pvutils.getParametersValue(parameters, PUBLIC_KEY, OriginatorPublicKey.defaultValues(PUBLIC_KEY));

    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 ALGORITHM): AlgorithmIdentifier;
  public static override defaultValues(memberName: typeof PUBLIC_KEY): asn1js.BitString;
  public static override defaultValues(memberName: string): any;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case ALGORITHM:
        return new AlgorithmIdentifier();
      case PUBLIC_KEY:
        return new asn1js.BitString();
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * Compare values with default values for all class members
   * @param memberName String name for a class member
   * @param memberValue Value to compare with default value
   */
  public static compareWithDefault<T extends { isEqual(data: any): boolean; }>(memberName: string, memberValue: T): memberValue is T {
    switch (memberName) {
      case ALGORITHM:
      case PUBLIC_KEY:
        return (memberValue.isEqual(OriginatorPublicKey.defaultValues(memberName)));
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * OriginatorPublicKey ::= SEQUENCE {
   *    algorithm AlgorithmIdentifier,
   *    publicKey BIT STRING }
   *```
   */
  static override schema(parameters: Schema.SchemaParameters<{
    algorithm?: AlgorithmIdentifierSchema;
    publicKey?: string;
  }> = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        AlgorithmIdentifier.schema(names.algorithm || {}),
        new asn1js.BitString({ name: (names.publicKey || 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,
      OriginatorPublicKey.schema({
        names: {
          algorithm: {
            names: {
              blockName: ALGORITHM
            }
          },
          publicKey: PUBLIC_KEY
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.algorithm = new AlgorithmIdentifier({ schema: asn1.result.algorithm });
    this.publicKey = asn1.result.publicKey;
  }

  public toSchema(): asn1js.Sequence {
    //#region Construct and return new ASN.1 schema for this object
    return (new asn1js.Sequence({
      value: [
        this.algorithm.toSchema(),
        this.publicKey
      ]
    }));
    //#endregion
  }

  public toJSON(): OriginatorPublicKeyJson {
    return {
      algorithm: this.algorithm.toJSON(),
      publicKey: this.publicKey.toJSON(),
    };
  }

}