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