summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/OtherKeyAttribute.ts
blob: 80e243535f0a9db2f68f357f5540198a694ddb08 (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
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 KEY_ATTR_ID = "keyAttrId";
const KEY_ATTR = "keyAttr";
const CLEAR_PROPS = [
  KEY_ATTR_ID,
  KEY_ATTR,
];

export interface IOtherKeyAttribute {
  keyAttrId: string;
  keyAttr?: any;
}

export interface OtherKeyAttributeJson {
  keyAttrId: string;
  keyAttr?: any;
}

export type OtherKeyAttributeParameters = PkiObjectParameters & Partial<IOtherKeyAttribute>;

export type OtherKeyAttributeSchema = Schema.SchemaType;

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

  public static override CLASS_NAME = "OtherKeyAttribute";

  public keyAttrId!: string;
  public keyAttr?: any;

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

    this.keyAttrId = pvutils.getParametersValue(parameters, KEY_ATTR_ID, OtherKeyAttribute.defaultValues(KEY_ATTR_ID));
    if (KEY_ATTR in parameters) {
      this.keyAttr = pvutils.getParametersValue(parameters, KEY_ATTR, OtherKeyAttribute.defaultValues(KEY_ATTR));
    }

    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_ATTR_ID): string;
  public static override defaultValues(memberName: typeof KEY_ATTR): any;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case KEY_ATTR_ID:
        return EMPTY_STRING;
      case KEY_ATTR:
        return {};
      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>(memberName: string, memberValue: T): memberValue is T {
    switch (memberName) {
      case KEY_ATTR_ID:
        return (typeof memberValue === "string" && memberValue === EMPTY_STRING);
      case KEY_ATTR:
        return (Object.keys(memberValue).length === 0);
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * OtherKeyAttribute ::= SEQUENCE {
   *    keyAttrId OBJECT IDENTIFIER,
   *    keyAttr ANY DEFINED BY keyAttrId OPTIONAL }
   *```
   */
  public static override schema(parameters: OtherKeyAttributeSchema = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      optional: (names.optional || true),
      name: (names.blockName || EMPTY_STRING),
      value: [
        new asn1js.ObjectIdentifier({ name: (names.keyAttrId || EMPTY_STRING) }),
        new asn1js.Any({
          optional: true,
          name: (names.keyAttr || 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,
      OtherKeyAttribute.schema({
        names: {
          keyAttrId: KEY_ATTR_ID,
          keyAttr: KEY_ATTR
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.keyAttrId = asn1.result.keyAttrId.valueBlock.toString();
    if (KEY_ATTR in asn1.result) {
      this.keyAttr = asn1.result.keyAttr;
    }
  }

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

    outputArray.push(new asn1js.ObjectIdentifier({ value: this.keyAttrId }));

    if (KEY_ATTR in this) {
      outputArray.push(this.keyAttr);
    }
    //#endregion

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

  public toJSON(): OtherKeyAttributeJson {
    const res: OtherKeyAttributeJson = {
      keyAttrId: this.keyAttrId
    };

    if (KEY_ATTR in this) {
      res.keyAttr = this.keyAttr.toJSON();
    }

    return res;
  }

}