@wildboar/pkcs/src/lib/modules/PKCS7/EnvelopedData.ta.d.ts

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { Attributes } from "../PKCS7/Attributes.ta";
import { EncryptedContentInfo } from "../PKCS7/EncryptedContentInfo.ta";
import { OriginatorInfo } from "../PKCS7/OriginatorInfo.ta";
import { RecipientInfos } from "../PKCS7/RecipientInfos.ta";
import { Version } from "../PKCS7/Version.ta";
export { Attributes, _decode_Attributes, _encode_Attributes, } from "../PKCS7/Attributes.ta";
export { EncryptedContentInfo, _decode_EncryptedContentInfo, _encode_EncryptedContentInfo, } from "../PKCS7/EncryptedContentInfo.ta";
export { OriginatorInfo, _decode_OriginatorInfo, _encode_OriginatorInfo, } from "../PKCS7/OriginatorInfo.ta";
export { RecipientInfos, _decode_RecipientInfos, _encode_RecipientInfos, } from "../PKCS7/RecipientInfos.ta";
export { Version, _decode_Version, _encode_Version } from "../PKCS7/Version.ta";
/**
 * @summary EnvelopedData
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * EnvelopedData ::= SEQUENCE {
 *     version                Version,
 *     originatorInfo         [0]  OriginatorInfo OPTIONAL,
 *     recipientInfos         RecipientInfos,
 *     encryptedContentInfo   EncryptedContentInfo,
 *     unprotectedAttributes  [1]  Attributes OPTIONAL
 * }
 * ```
 *
 * @class
 */
export declare class EnvelopedData {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: Version;
    /**
     * @summary `originatorInfo`.
     * @public
     * @readonly
     */
    readonly originatorInfo: OPTIONAL<OriginatorInfo>;
    /**
     * @summary `recipientInfos`.
     * @public
     * @readonly
     */
    readonly recipientInfos: RecipientInfos;
    /**
     * @summary `encryptedContentInfo`.
     * @public
     * @readonly
     */
    readonly encryptedContentInfo: EncryptedContentInfo;
    /**
     * @summary `unprotectedAttributes`.
     * @public
     * @readonly
     */
    readonly unprotectedAttributes: OPTIONAL<Attributes>;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: Version, 
    /**
     * @summary `originatorInfo`.
     * @public
     * @readonly
     */
    originatorInfo: OPTIONAL<OriginatorInfo>, 
    /**
     * @summary `recipientInfos`.
     * @public
     * @readonly
     */
    recipientInfos: RecipientInfos, 
    /**
     * @summary `encryptedContentInfo`.
     * @public
     * @readonly
     */
    encryptedContentInfo: EncryptedContentInfo, 
    /**
     * @summary `unprotectedAttributes`.
     * @public
     * @readonly
     */
    unprotectedAttributes: OPTIONAL<Attributes>);
    /**
     * @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} el The element being decoded.
 * @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;