@wildboar/pkcs/src/lib/modules/PKCS-15/EnvelopedData.ta.d.mts

Public Key Cryptography Standard PDUs in TypeScript

import { OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { Attribute } from "@wildboar/x500/InformationFramework";
import { OriginatorInfo } from "../CryptographicMessageSyntax/OriginatorInfo.ta.mjs";
import { RecipientInfos } from "../CryptographicMessageSyntax/RecipientInfos.ta.mjs";
import { EncryptedContentInfo } from "../PKCS-15/EncryptedContentInfo.ta.mjs";
import { EnvelopedData_version } from "../PKCS-15/EnvelopedData-version.ta.mjs";
/**
 * @summary EnvelopedData
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * EnvelopedData {Type} ::= SEQUENCE {
 *     version INTEGER{v0(0),v1(1),v2(2),v3(3),v4(4)}(v0|v1|v2,...),
 *     originatorInfo [0] OriginatorInfo OPTIONAL,
 *     recipientInfos  RecipientInfos,
 *     encryptedContentInfo EncryptedContentInfo{Type},
 *     unprotectedAttrs [1] SET SIZE (1..MAX) OF Attribute OPTIONAL
 * }
 * ```
 *
 */
export declare class EnvelopedData<Type> {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: EnvelopedData_version;
    /**
     * @summary `originatorInfo`.
     * @public
     * @readonly
     */
    readonly originatorInfo: OPTIONAL<OriginatorInfo>;
    /**
     * @summary `recipientInfos`.
     * @public
     * @readonly
     */
    readonly recipientInfos: RecipientInfos;
    /**
     * @summary `encryptedContentInfo`.
     * @public
     * @readonly
     */
    readonly encryptedContentInfo: EncryptedContentInfo<Type>;
    /**
     * @summary `unprotectedAttrs`.
     * @public
     * @readonly
     */
    readonly unprotectedAttrs?: OPTIONAL<Attribute[]>;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: EnvelopedData_version, 
    /**
     * @summary `originatorInfo`.
     * @public
     * @readonly
     */
    originatorInfo: OPTIONAL<OriginatorInfo>, 
    /**
     * @summary `recipientInfos`.
     * @public
     * @readonly
     */
    recipientInfos: RecipientInfos, 
    /**
     * @summary `encryptedContentInfo`.
     * @public
     * @readonly
     */
    encryptedContentInfo: EncryptedContentInfo<Type>, 
    /**
     * @summary `unprotectedAttrs`.
     * @public
     * @readonly
     */
    unprotectedAttrs?: OPTIONAL<Attribute[]>);
    /**
     * @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<any>]: EnvelopedData<any>[_K];
    }): EnvelopedData<any>;
}
/**
 * @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 Returns a function that will decode an ASN.1 element into a(n) EnvelopedData
 * @function
 * @param {_Element} el The element being decoded.
 * @returns A function that will decode an ASN.1 element.
 */
export declare function _get_decoder_for_EnvelopedData<Type>(_decode_Type: $.ASN1Decoder<Type>): $.ASN1Decoder<EnvelopedData<Type>>;
/**
 * @summary Returns a function that will encode a(n) EnvelopedData into an ASN.1 Element.
 * @function
 * @returns A function that will encode a(n) EnvelopedData as an ASN.1 element.
 */
export declare function _get_encoder_for_EnvelopedData<Type>(_encode_Type: $.ASN1Encoder<Type>): $.ASN1Encoder<EnvelopedData<Type>>;
//# sourceMappingURL=EnvelopedData.ta.d.mts.map