@wildboar/pkcs/src/lib/modules/CryptographicMessageSyntax/KeyAgreeRecipientInfo.ta.d.mts

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { CMSVersion } from "../CryptographicMessageSyntax/CMSVersion.ta.mjs";
import { KeyEncryptionAlgorithmIdentifier } from "../CryptographicMessageSyntax/KeyEncryptionAlgorithmIdentifier.ta.mjs";
import { OriginatorIdentifierOrKey } from "../CryptographicMessageSyntax/OriginatorIdentifierOrKey.ta.mjs";
import { RecipientEncryptedKeys } from "../CryptographicMessageSyntax/RecipientEncryptedKeys.ta.mjs";
import { UserKeyingMaterial } from "../CryptographicMessageSyntax/UserKeyingMaterial.ta.mjs";
/**
 * @summary KeyAgreeRecipientInfo
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * KeyAgreeRecipientInfo ::= SEQUENCE {
 *   version                 CMSVersion, -- always set to 3
 *   originator              [0] EXPLICIT OriginatorIdentifierOrKey,
 *   ukm                     [1] EXPLICIT UserKeyingMaterial OPTIONAL,
 *   keyEncryptionAlgorithm  KeyEncryptionAlgorithmIdentifier,
 *   recipientEncryptedKeys  RecipientEncryptedKeys
 * }
 * ```
 *
 */
export declare class KeyAgreeRecipientInfo {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: CMSVersion;
    /**
     * @summary `originator`.
     * @public
     * @readonly
     */
    readonly originator: OriginatorIdentifierOrKey;
    /**
     * @summary `ukm`.
     * @public
     * @readonly
     */
    readonly ukm: OPTIONAL<UserKeyingMaterial>;
    /**
     * @summary `keyEncryptionAlgorithm`.
     * @public
     * @readonly
     */
    readonly keyEncryptionAlgorithm: KeyEncryptionAlgorithmIdentifier;
    /**
     * @summary `recipientEncryptedKeys`.
     * @public
     * @readonly
     */
    readonly recipientEncryptedKeys: RecipientEncryptedKeys;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: CMSVersion, 
    /**
     * @summary `originator`.
     * @public
     * @readonly
     */
    originator: OriginatorIdentifierOrKey, 
    /**
     * @summary `ukm`.
     * @public
     * @readonly
     */
    ukm: OPTIONAL<UserKeyingMaterial>, 
    /**
     * @summary `keyEncryptionAlgorithm`.
     * @public
     * @readonly
     */
    keyEncryptionAlgorithm: KeyEncryptionAlgorithmIdentifier, 
    /**
     * @summary `recipientEncryptedKeys`.
     * @public
     * @readonly
     */
    recipientEncryptedKeys: RecipientEncryptedKeys);
    /**
     * @summary Restructures an object into a KeyAgreeRecipientInfo
     * @description
     *
     * This takes an `object` and converts it to a `KeyAgreeRecipientInfo`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `KeyAgreeRecipientInfo`.
     * @returns {KeyAgreeRecipientInfo}
     */
    static _from_object(_o: {
        [_K in keyof KeyAgreeRecipientInfo]: KeyAgreeRecipientInfo[_K];
    }): KeyAgreeRecipientInfo;
}
/**
 * @summary The Leading Root Component Types of KeyAgreeRecipientInfo
 * @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_KeyAgreeRecipientInfo: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of KeyAgreeRecipientInfo
 * @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_KeyAgreeRecipientInfo: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of KeyAgreeRecipientInfo
 * @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_KeyAgreeRecipientInfo: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) KeyAgreeRecipientInfo
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {KeyAgreeRecipientInfo} The decoded data structure.
 */
export declare function _decode_KeyAgreeRecipientInfo(el: _Element): KeyAgreeRecipientInfo;
/**
 * @summary Encodes a(n) KeyAgreeRecipientInfo into an ASN.1 Element.
 * @function
 * @param value The element being encoded.
 * @param elGetter A function that can be used to get new ASN.1 elements.
 * @returns {_Element} The KeyAgreeRecipientInfo, encoded as an ASN.1 Element.
 */
export declare function _encode_KeyAgreeRecipientInfo(value: KeyAgreeRecipientInfo, elGetter: $.ASN1Encoder<KeyAgreeRecipientInfo>): _Element;
//# sourceMappingURL=KeyAgreeRecipientInfo.ta.d.mts.map