summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/KEKIdentifier.ts
blob: 46f2e04a13cc6b11b9531350ee6093c9657daf4d (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
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { OtherKeyAttribute, OtherKeyAttributeJson, OtherKeyAttributeSchema } from "./OtherKeyAttribute";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const KEY_IDENTIFIER = "keyIdentifier";
const DATE = "date";
const OTHER = "other";
const CLEAR_PROPS = [
  KEY_IDENTIFIER,
  DATE,
  OTHER,
];

export interface IKEKIdentifier {
  keyIdentifier: asn1js.OctetString;
  date?: asn1js.GeneralizedTime;
  other?: OtherKeyAttribute;
}

export interface KEKIdentifierJson {
  keyIdentifier: asn1js.OctetStringJson;
  date?: asn1js.GeneralizedTime;
  other?: OtherKeyAttributeJson;
}

export type KEKIdentifierParameters = PkiObjectParameters & Partial<IKEKIdentifier>;

export type KEKIdentifierSchema = Schema.SchemaParameters<{
  keyIdentifier?: string;
  date?: string;
  other?: OtherKeyAttributeSchema;
}>;

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

  public static override CLASS_NAME = "KEKIdentifier";

  public keyIdentifier!: asn1js.OctetString;
  public date?: asn1js.GeneralizedTime;
  public other?: OtherKeyAttribute;

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

    this.keyIdentifier = pvutils.getParametersValue(parameters, KEY_IDENTIFIER, KEKIdentifier.defaultValues(KEY_IDENTIFIER));
    if (DATE in parameters) {
      this.date = pvutils.getParametersValue(parameters, DATE, KEKIdentifier.defaultValues(DATE));
    }
    if (OTHER in parameters) {
      this.other = pvutils.getParametersValue(parameters, OTHER, KEKIdentifier.defaultValues(OTHER));
    }

    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 KEY_IDENTIFIER): asn1js.OctetString;
  public static override defaultValues(memberName: typeof DATE): asn1js.GeneralizedTime;
  public static override defaultValues(memberName: typeof OTHER): OtherKeyAttribute;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case KEY_IDENTIFIER:
        return new asn1js.OctetString();
      case DATE:
        return new asn1js.GeneralizedTime();
      case OTHER:
        return new OtherKeyAttribute();
      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(memberName: string, memberValue: any): boolean {
    switch (memberName) {
      case KEY_IDENTIFIER:
        return (memberValue.isEqual(KEKIdentifier.defaultValues(KEY_IDENTIFIER)));
      case DATE:
        return ((memberValue.year === 0) &&
          (memberValue.month === 0) &&
          (memberValue.day === 0) &&
          (memberValue.hour === 0) &&
          (memberValue.minute === 0) &&
          (memberValue.second === 0) &&
          (memberValue.millisecond === 0));
      case OTHER:
        return ((memberValue.compareWithDefault("keyAttrId", memberValue.keyAttrId)) &&
          (("keyAttr" in memberValue) === false));
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * KEKIdentifier ::= SEQUENCE {
   *    keyIdentifier OCTET STRING,
   *    date GeneralizedTime OPTIONAL,
   *    other OtherKeyAttribute OPTIONAL }
   *```
   */
  public static override schema(parameters: KEKIdentifierSchema = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        new asn1js.OctetString({ name: (names.keyIdentifier || EMPTY_STRING) }),
        new asn1js.GeneralizedTime({
          optional: true,
          name: (names.date || EMPTY_STRING)
        }),
        OtherKeyAttribute.schema(names.other || {})
      ]
    }));
  }

  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,
      KEKIdentifier.schema({
        names: {
          keyIdentifier: KEY_IDENTIFIER,
          date: DATE,
          other: {
            names: {
              blockName: OTHER
            }
          }
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.keyIdentifier = asn1.result.keyIdentifier;
    if (DATE in asn1.result)
      this.date = asn1.result.date;
    if (OTHER in asn1.result)
      this.other = new OtherKeyAttribute({ schema: asn1.result.other });
  }

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

    outputArray.push(this.keyIdentifier);

    if (this.date) {
      outputArray.push(this.date);
    }
    if (this.other) {
      outputArray.push(this.other.toSchema());
    }
    //#endregion

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

  public toJSON(): KEKIdentifierJson {
    const res: KEKIdentifierJson = {
      keyIdentifier: this.keyIdentifier.toJSON()
    };

    if (this.date) {
      res.date = this.date;
    }

    if (this.other) {
      res.other = this.other.toJSON();
    }

    return res;
  }

}