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

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { HASH } from "@wildboar/x500/src/lib/modules/AuthenticationFramework/HASH.ta";
import { ContentInfo } from "../PKCS7/ContentInfo.ta";
import { DigestAlgorithmIdentifier } from "../PKCS7/DigestAlgorithmIdentifier.ta";
import { Version } from "../PKCS7/Version.ta";
/**
 * @summary DigestedData
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * DigestedData ::= SEQUENCE {
 *     version          Version,
 *     digestAlgorithm  DigestAlgorithmIdentifier,
 *     contentInfo      ContentInfo,
 *     digest           HASH{PKCS7-CONTENT-TYPE.&Type({PKCS7ContentTable})}
 * }
 * ```
 *
 * @class
 */
export declare class DigestedData {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: Version;
    /**
     * @summary `digestAlgorithm`.
     * @public
     * @readonly
     */
    readonly digestAlgorithm: DigestAlgorithmIdentifier;
    /**
     * @summary `contentInfo`.
     * @public
     * @readonly
     */
    readonly contentInfo: ContentInfo;
    /**
     * @summary `digest`.
     * @public
     * @readonly
     */
    readonly digest: HASH<_Element>;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: Version, 
    /**
     * @summary `digestAlgorithm`.
     * @public
     * @readonly
     */
    digestAlgorithm: DigestAlgorithmIdentifier, 
    /**
     * @summary `contentInfo`.
     * @public
     * @readonly
     */
    contentInfo: ContentInfo, 
    /**
     * @summary `digest`.
     * @public
     * @readonly
     */
    digest: HASH<_Element>);
    /**
     * @summary Restructures an object into a DigestedData
     * @description
     *
     * This takes an `object` and converts it to a `DigestedData`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `DigestedData`.
     * @returns {DigestedData}
     */
    static _from_object(_o: {
        [_K in keyof DigestedData]: DigestedData[_K];
    }): DigestedData;
}
/**
 * @summary The Leading Root Component Types of DigestedData
 * @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_DigestedData: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of DigestedData
 * @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_DigestedData: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of DigestedData
 * @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_DigestedData: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) DigestedData
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {DigestedData} The decoded data structure.
 */
export declare function _decode_DigestedData(el: _Element): DigestedData;
/**
 * @summary Encodes a(n) DigestedData 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 DigestedData, encoded as an ASN.1 Element.
 */
export declare function _encode_DigestedData(value: DigestedData, elGetter: $.ASN1Encoder<DigestedData>): _Element;