summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/AttributeTypeAndValue.ts
blob: 786b39f9ca40059a80a78b5c1a5714c2c34e99ae (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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
import * as asn1js from "asn1js";
import * as pvtsutils from "pvtsutils";
import * as pvutils from "pvutils";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { stringPrep } from "./Helpers";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const TYPE = "type";
const VALUE = "value";

export interface IAttributeTypeAndValue {
  type: string;
  value: AttributeValueType;
}

export type AttributeTypeAndValueParameters = PkiObjectParameters & Partial<IAttributeTypeAndValue>;

export type AttributeValueType = asn1js.Utf8String
  | asn1js.BmpString
  | asn1js.UniversalString
  | asn1js.NumericString
  | asn1js.PrintableString
  | asn1js.TeletexString
  | asn1js.VideotexString
  | asn1js.IA5String
  | asn1js.GraphicString
  | asn1js.VisibleString
  | asn1js.GeneralString
  | asn1js.CharacterString;

export interface AttributeTypeAndValueJson {
  type: string;
  value: any;
}

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

  public static override CLASS_NAME = "AttributeTypeAndValue";

  public type!: string;
  public value!: AttributeValueType;

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

    this.type = pvutils.getParametersValue(parameters, TYPE, AttributeTypeAndValue.defaultValues(TYPE));
    this.value = pvutils.getParametersValue(parameters, VALUE, AttributeTypeAndValue.defaultValues(VALUE));

    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 TYPE): string;
  public static override defaultValues(memberName: typeof VALUE): AttributeValueType;
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case TYPE:
        return EMPTY_STRING;
      case VALUE:
        return {};
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * AttributeTypeAndValue ::= Sequence {
   *    type     AttributeType,
   *    value    AttributeValue }
   *
   * AttributeType ::= OBJECT IDENTIFIER
   *
   * AttributeValue ::= ANY -- DEFINED BY AttributeType
   *```
   */
  static override schema(parameters: Schema.SchemaParameters<{ type?: string, value?: string; }> = {}): Schema.SchemaType {
    const names = pvutils.getParametersValue<NonNullable<typeof parameters.names>>(parameters, "names", {});

    return (new asn1js.Sequence({
      name: (names.blockName || EMPTY_STRING),
      value: [
        new asn1js.ObjectIdentifier({ name: (names.type || EMPTY_STRING) }),
        new asn1js.Any({ name: (names.value || EMPTY_STRING) })
      ]
    }));
  }

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

    //#region Check the schema is valid
    const asn1 = asn1js.compareSchema(schema,
      schema,
      AttributeTypeAndValue.schema({
        names: {
          type: TYPE,
          value: "typeValue"
        }
      })
    );

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

    //#region Get internal properties from parsed schema
    this.type = asn1.result.type.valueBlock.toString();
    this.value = asn1.result.typeValue;
    //#endregion
  }

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

  public toJSON(): AttributeTypeAndValueJson {
    const _object = {
      type: this.type
    } as AttributeTypeAndValueJson;

    if (Object.keys(this.value).length !== 0) {
      _object.value = (this.value).toJSON();
    } else {
      _object.value = this.value;
    }

    return _object;
  }

  /**
   * Compares two AttributeTypeAndValue values, or AttributeTypeAndValue with ArrayBuffer value
   * @param compareTo The value compare to current
   */
  public isEqual(compareTo: AttributeTypeAndValue | ArrayBuffer): boolean {
    const stringBlockNames = [
      asn1js.Utf8String.blockName(),
      asn1js.BmpString.blockName(),
      asn1js.UniversalString.blockName(),
      asn1js.NumericString.blockName(),
      asn1js.PrintableString.blockName(),
      asn1js.TeletexString.blockName(),
      asn1js.VideotexString.blockName(),
      asn1js.IA5String.blockName(),
      asn1js.GraphicString.blockName(),
      asn1js.VisibleString.blockName(),
      asn1js.GeneralString.blockName(),
      asn1js.CharacterString.blockName()
    ];

    if (compareTo instanceof ArrayBuffer) {
      return pvtsutils.BufferSourceConverter.isEqual(this.value.valueBeforeDecodeView, compareTo);
    }

    if ((compareTo.constructor as typeof AttributeTypeAndValue).blockName() === AttributeTypeAndValue.blockName()) {
      if (this.type !== compareTo.type)
        return false;

      //#region Check we do have both strings
      const isStringPair = [false, false];
      const thisName = (this.value.constructor as typeof asn1js.BaseBlock).blockName();
      for (const name of stringBlockNames) {
        if (thisName === name) {
          isStringPair[0] = true;
        }
        if ((compareTo.value.constructor as typeof asn1js.BaseBlock).blockName() === name) {
          isStringPair[1] = true;
        }
      }

      if (isStringPair[0] !== isStringPair[1]) {
        return false;
      }

      const isString = (isStringPair[0] && isStringPair[1]);
      //#endregion

      if (isString) {
        const value1 = stringPrep(this.value.valueBlock.value);
        const value2 = stringPrep(compareTo.value.valueBlock.value);

        if (value1.localeCompare(value2) !== 0)
          return false;
      }
      else // Comparing as two ArrayBuffers
      {
        if (!pvtsutils.BufferSourceConverter.isEqual(this.value.valueBeforeDecodeView, compareTo.value.valueBeforeDecodeView))
          return false;
      }

      return true;
    }

    return false;
  }

}