summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/SubjectDirectoryAttributes.ts
blob: 83c1b58a6af2237868d5a2e448046bd47c7351cf (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
import * as asn1js from "asn1js";
import * as pvutils from "pvutils";
import { Attribute, AttributeJson } from "./Attribute";
import { EMPTY_STRING } from "./constants";
import { AsnError } from "./errors";
import { PkiObject, PkiObjectParameters } from "./PkiObject";
import * as Schema from "./Schema";

const ATTRIBUTES = "attributes";
const CLEAR_PROPS = [
  ATTRIBUTES
];

export interface ISubjectDirectoryAttributes {
  attributes: Attribute[];
}

export interface SubjectDirectoryAttributesJson {
  attributes: AttributeJson[];
}

export type SubjectDirectoryAttributesParameters = PkiObjectParameters & Partial<ISubjectDirectoryAttributes>;

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

  public static override CLASS_NAME = "SubjectDirectoryAttributes";

  public attributes!: Attribute[];

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

    this.attributes = pvutils.getParametersValue(parameters, ATTRIBUTES, SubjectDirectoryAttributes.defaultValues(ATTRIBUTES));

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

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * SubjectDirectoryAttributes ::= SEQUENCE SIZE (1..MAX) OF Attribute
   *```
   */
  public static override schema(parameters: Schema.SchemaParameters<{
    attributes?: 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.Repeated({
          name: (names.attributes || EMPTY_STRING),
          value: Attribute.schema()
        })
      ]
    }));
  }

  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,
      SubjectDirectoryAttributes.schema({
        names: {
          attributes: ATTRIBUTES
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

    // Get internal properties from parsed schema
    this.attributes = Array.from(asn1.result.attributes, element => new Attribute({ schema: element }));
  }

  public toSchema(): asn1js.Sequence {
    // Construct and return new ASN.1 schema for this object
    return (new asn1js.Sequence({
      value: Array.from(this.attributes, o => o.toSchema())
    }));
  }

  public toJSON(): SubjectDirectoryAttributesJson {
    return {
      attributes: Array.from(this.attributes, o => o.toJSON())
    };
  }

}