@wildboar/pkcs/src/lib/modules/CryptographicMessageSyntax/EnvelopedData.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 { EncryptedContentInfo } from "../CryptographicMessageSyntax/EncryptedContentInfo.ta.mjs";
import { OriginatorInfo } from "../CryptographicMessageSyntax/OriginatorInfo.ta.mjs";
import { RecipientInfos } from "../CryptographicMessageSyntax/RecipientInfos.ta.mjs";
import { UnprotectedAttributes } from "../CryptographicMessageSyntax/UnprotectedAttributes.ta.mjs";
/**
 * @summary EnvelopedData
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * EnvelopedData ::= SEQUENCE {
 *   version               CMSVersion,
 *   originatorInfo        [0] IMPLICIT OriginatorInfo OPTIONAL,
 *   recipientInfos        RecipientInfos,
 *   encryptedContentInfo  EncryptedContentInfo,
 *   unprotectedAttrs      [1] IMPLICIT UnprotectedAttributes OPTIONAL
 * }
 * ```
 *
 */
export declare class EnvelopedData {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: CMSVersion;
    /**
     * @summary `originatorInfo`.
     * @public
     * @readonly
     */
    readonly originatorInfo: OPTIONAL<OriginatorInfo>;
    /**
     * @summary `recipientInfos`.
     * @public
     * @readonly
     */
    readonly recipientInfos: RecipientInfos;
    /**
     * @summary `encryptedContentInfo`.
     * @public
     * @readonly
     */
    readonly encryptedContentInfo: EncryptedContentInfo;
    /**
     * @summary `unprotectedAttrs`.
     * @public
     * @readonly
     */
    readonly unprotectedAttrs?: OPTIONAL<UnprotectedAttributes>;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: CMSVersion, 
    /**
     * @summary `originatorInfo`.
     * @public
     * @readonly
     */
    originatorInfo: OPTIONAL<OriginatorInfo>, 
    /**
     * @summary `recipientInfos`.
     * @public
     * @readonly
     */
    recipientInfos: RecipientInfos, 
    /**
     * @summary `encryptedContentInfo`.
     * @public
     * @readonly
     */
    encryptedContentInfo: EncryptedContentInfo, 
    /**
     * @summary `unprotectedAttrs`.
     * @public
     * @readonly
     */
    unprotectedAttrs?: OPTIONAL<UnprotectedAttributes>);
    /**
     * @summary Restructures an object into a EnvelopedData
     * @description
     *
     * This takes an `object` and converts it to a `EnvelopedData`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `EnvelopedData`.
     * @returns {EnvelopedData}
     */
    static _from_object(_o: {
        [_K in keyof EnvelopedData]: EnvelopedData[_K];
    }): EnvelopedData;
}
/**
 * @summary The Leading Root Component Types of EnvelopedData
 * @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_EnvelopedData: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of EnvelopedData
 * @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_EnvelopedData: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of EnvelopedData
 * @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_EnvelopedData: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) EnvelopedData
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {EnvelopedData} The decoded data structure.
 */
export declare function _decode_EnvelopedData(el: _Element): EnvelopedData;
/**
 * @summary Encodes a(n) EnvelopedData 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 EnvelopedData, encoded as an ASN.1 Element.
 */
export declare function _encode_EnvelopedData(value: EnvelopedData, elGetter: $.ASN1Encoder<EnvelopedData>): _Element;
//# sourceMappingURL=EnvelopedData.ta.d.mts.map