summaryrefslogtreecommitdiffstats
path: root/third_party/js/PKI.js/src/OtherRecipientInfo.ts
blob: a750aab56473beb074bc01e4ab29f85b7b911073 (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
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 ORI_TYPE = "oriType";
const ORI_VALUE = "oriValue";
const CLEAR_PROPS = [
  ORI_TYPE,
  ORI_VALUE
];

export interface IOtherRecipientInfo {
  oriType: string;
  oriValue: any;
}

export interface OtherRecipientInfoJson {
  oriType: string;
  oriValue?: any;
}

export type OtherRecipientInfoParameters = PkiObjectParameters & Partial<IOtherRecipientInfo>;

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

  public static override CLASS_NAME = "OtherRecipientInfo";

  public oriType!: string;
  public oriValue: any;

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

    this.oriType = pvutils.getParametersValue(parameters, ORI_TYPE, OtherRecipientInfo.defaultValues(ORI_TYPE));
    this.oriValue = pvutils.getParametersValue(parameters, ORI_VALUE, OtherRecipientInfo.defaultValues(ORI_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
   */
  static override defaultValues(memberName: typeof ORI_TYPE): string;
  static override defaultValues(memberName: typeof ORI_VALUE): any;
  static override defaultValues(memberName: string): any {
    switch (memberName) {
      case ORI_TYPE:
        return EMPTY_STRING;
      case ORI_VALUE:
        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 ORI_TYPE:
        return (memberValue === EMPTY_STRING);
      case ORI_VALUE:
        return (Object.keys(memberValue).length === 0);
      default:
        return super.defaultValues(memberName);
    }
  }

  /**
   * @inheritdoc
   * @asn ASN.1 schema
   * ```asn
   * OtherRecipientInfo ::= SEQUENCE {
   *    oriType OBJECT IDENTIFIER,
   *    oriValue ANY DEFINED BY oriType }
   *```
   */
  public static override schema(parameters: Schema.SchemaParameters<{
    oriType?: string;
    oriValue?: string;
  }> = {}) {
    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.oriType || EMPTY_STRING) }),
        new asn1js.Any({ name: (names.oriValue || 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,
      OtherRecipientInfo.schema({
        names: {
          oriType: ORI_TYPE,
          oriValue: ORI_VALUE
        }
      })
    );
    AsnError.assertSchema(asn1, this.className);

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

  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.oriType }),
        this.oriValue
      ]
    }));
    //#endregion
  }

  public toJSON(): OtherRecipientInfoJson {
    const res: OtherRecipientInfoJson = {
      oriType: this.oriType
    };

    if (!OtherRecipientInfo.compareWithDefault(ORI_VALUE, this.oriValue)) {
      res.oriValue = this.oriValue.toJSON();
    }

    return res;
  }

}