summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/RecipientEncryptedKeys.ts
blob: 68a812d9aa3952eded3574b9f30d449fec475edb (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
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 { RecipientEncryptedKey, RecipientEncryptedKeyJson } from "./RecipientEncryptedKey";
import * as Schema from "./Schema";

const ENCRYPTED_KEYS = "encryptedKeys";
const RECIPIENT_ENCRYPTED_KEYS = "RecipientEncryptedKeys";
const CLEAR_PROPS = [
  RECIPIENT_ENCRYPTED_KEYS,
];

export interface IRecipientEncryptedKeys {
  encryptedKeys: RecipientEncryptedKey[];
}

export interface RecipientEncryptedKeysJson {
  encryptedKeys: RecipientEncryptedKeyJson[];
}

export type RecipientEncryptedKeysParameters = PkiObjectParameters & Partial<IRecipientEncryptedKeys>;

export type RecipientEncryptedKeysSchema = Schema.SchemaParameters<{
  RecipientEncryptedKeys?: string;
}>;

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

  public static override CLASS_NAME = "RecipientEncryptedKeys";

  public encryptedKeys!: RecipientEncryptedKey[];

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

    this.encryptedKeys = pvutils.getParametersValue(parameters, ENCRYPTED_KEYS, RecipientEncryptedKeys.defaultValues(ENCRYPTED_KEYS));

    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 ENCRYPTED_KEYS): RecipientEncryptedKey[];
  public static override defaultValues(memberName: string): any {
    switch (memberName) {
      case ENCRYPTED_KEYS:
        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(memberName: string, memberValue: any): boolean {
    switch (memberName) {
      case ENCRYPTED_KEYS:
        return (memberValue.length === 0);
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * RecipientEncryptedKeys ::= SEQUENCE OF RecipientEncryptedKey
   *```
   */
  public static override schema(parameters: RecipientEncryptedKeysSchema = {}): 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.RecipientEncryptedKeys || EMPTY_STRING),
          value: RecipientEncryptedKey.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,
      RecipientEncryptedKeys.schema({
        names: {
          RecipientEncryptedKeys: RECIPIENT_ENCRYPTED_KEYS
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

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

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

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

}