summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/Attribute.ts
blob: 81de5655e147f159f5b6ef6468887b18498ed2ac (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
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 TYPE = "type";
const VALUES = "values";
const CLEAR_PROPS = [
  TYPE,
  VALUES
];

export interface IAttribute {
  /**
   * Specifies type of attribute value
   */
  type: string;
  /**
   * List of attribute values
   */
  values: any[];
}

export type AttributeParameters = PkiObjectParameters & Partial<IAttribute>;

export type AttributeSchema = Schema.SchemaParameters<{
  setName?: string;
  type?: string;
  values?: string;
}>;

export interface AttributeJson {
  type: string;
  values: any[];
}

/**
 * Represents the Attribute structure described in [RFC2986](https://datatracker.ietf.org/doc/html/rfc2986)
 */
export class Attribute extends PkiObject implements IAttribute {

  public static override CLASS_NAME = "Attribute";

  public type!: string;
  public values!: any[];

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

    this.type = pvutils.getParametersValue(parameters, TYPE, Attribute.defaultValues(TYPE));
    this.values = pvutils.getParametersValue(parameters, VALUES, Attribute.defaultValues(VALUES));

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

  /**
   * Compares 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 TYPE:
        return (memberValue === EMPTY_STRING);
      case VALUES:
        return (memberValue.length === 0);
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * Attribute { ATTRIBUTE:IOSet } ::= SEQUENCE {
   *    type   ATTRIBUTE.&id({IOSet}),
   *    values SET SIZE(1..MAX) OF ATTRIBUTE.&Type({IOSet}{@type})
   * }
   *```
   */
  public static override schema(parameters: AttributeSchema = {}) {
    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.Set({
          name: (names.setName || EMPTY_STRING),
          value: [
            new asn1js.Repeated({
              name: (names.values || EMPTY_STRING),
              value: new asn1js.Any()
            })
          ]
        })
      ]
    }));
  }

  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,
      Attribute.schema({
        names: {
          type: TYPE,
          values: VALUES
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.type = asn1.result.type.valueBlock.toString();
    this.values = asn1.result.values;
  }

  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 }),
        new asn1js.Set({
          value: this.values
        })
      ]
    }));
    //#endregion
  }

  public toJSON(): AttributeJson {
    return {
      type: this.type,
      values: Array.from(this.values, o => o.toJSON())
    };
  }

}