@wildboar/pkcs/src/lib/modules/CryptographicMessageSyntax/KEKRecipientInfo.ta.d.ts

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { CMSVersion } from "../CryptographicMessageSyntax/CMSVersion.ta";
import { EncryptedKey } from "../CryptographicMessageSyntax/EncryptedKey.ta";
import { KEKIdentifier } from "../CryptographicMessageSyntax/KEKIdentifier.ta";
import { KeyEncryptionAlgorithmIdentifier } from "../CryptographicMessageSyntax/KeyEncryptionAlgorithmIdentifier.ta";
export { CMSVersion, CMSVersion_v0, CMSVersion_v1, CMSVersion_v2, CMSVersion_v3, CMSVersion_v4, v0, v1, v2, v3, v4, _decode_CMSVersion, _encode_CMSVersion, } from "../CryptographicMessageSyntax/CMSVersion.ta";
export { EncryptedKey, _decode_EncryptedKey, _encode_EncryptedKey, } from "../CryptographicMessageSyntax/EncryptedKey.ta";
export { KEKIdentifier, _decode_KEKIdentifier, _encode_KEKIdentifier, } from "../CryptographicMessageSyntax/KEKIdentifier.ta";
export { KeyEncryptionAlgorithmIdentifier, _decode_KeyEncryptionAlgorithmIdentifier, _encode_KeyEncryptionAlgorithmIdentifier, } from "../CryptographicMessageSyntax/KeyEncryptionAlgorithmIdentifier.ta";
/**
 * @summary KEKRecipientInfo
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * KEKRecipientInfo ::= SEQUENCE {
 *   version                 CMSVersion, -- always set to 4
 *   kekid                   KEKIdentifier,
 *   keyEncryptionAlgorithm  KeyEncryptionAlgorithmIdentifier,
 *   encryptedKey            EncryptedKey
 * }
 * ```
 *
 * @class
 */
export declare class KEKRecipientInfo {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: CMSVersion;
    /**
     * @summary `kekid`.
     * @public
     * @readonly
     */
    readonly kekid: KEKIdentifier;
    /**
     * @summary `keyEncryptionAlgorithm`.
     * @public
     * @readonly
     */
    readonly keyEncryptionAlgorithm: KeyEncryptionAlgorithmIdentifier;
    /**
     * @summary `encryptedKey`.
     * @public
     * @readonly
     */
    readonly encryptedKey: EncryptedKey;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: CMSVersion, 
    /**
     * @summary `kekid`.
     * @public
     * @readonly
     */
    kekid: KEKIdentifier, 
    /**
     * @summary `keyEncryptionAlgorithm`.
     * @public
     * @readonly
     */
    keyEncryptionAlgorithm: KeyEncryptionAlgorithmIdentifier, 
    /**
     * @summary `encryptedKey`.
     * @public
     * @readonly
     */
    encryptedKey: EncryptedKey);
    /**
     * @summary Restructures an object into a KEKRecipientInfo
     * @description
     *
     * This takes an `object` and converts it to a `KEKRecipientInfo`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `KEKRecipientInfo`.
     * @returns {KEKRecipientInfo}
     */
    static _from_object(_o: {
        [_K in keyof KEKRecipientInfo]: KEKRecipientInfo[_K];
    }): KEKRecipientInfo;
}
/**
 * @summary The Leading Root Component Types of KEKRecipientInfo
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the leading root component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _root_component_type_list_1_spec_for_KEKRecipientInfo: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of KEKRecipientInfo
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the trailing root component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _root_component_type_list_2_spec_for_KEKRecipientInfo: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of KEKRecipientInfo
 * @description
 *
 * This is an array of `ComponentSpec`s that define how to decode the extension addition component type list of a SET or SEQUENCE.
 *
 * @constant
 */
export declare const _extension_additions_list_spec_for_KEKRecipientInfo: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) KEKRecipientInfo
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {KEKRecipientInfo} The decoded data structure.
 */
export declare function _decode_KEKRecipientInfo(el: _Element): KEKRecipientInfo;
/**
 * @summary Encodes a(n) KEKRecipientInfo into an ASN.1 Element.
 * @function
 * @param {value} el The element being decoded.
 * @param elGetter A function that can be used to get new ASN.1 elements.
 * @returns {_Element} The KEKRecipientInfo, encoded as an ASN.1 Element.
 */
export declare function _encode_KEKRecipientInfo(value: KEKRecipientInfo, elGetter: $.ASN1Encoder<KEKRecipientInfo>): _Element;