@wildboar/pki-stub/src/lib/modules/PKI-Stub/ObjectDigestInfo.ta.d.ts

X.510 PKI-Stub ASN.1 data structures in TypeScript

import { OPTIONAL, BIT_STRING, OBJECT_IDENTIFIER, ASN1Element as _Element } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { ObjectDigestInfo_digestedObjectType, _enum_for_ObjectDigestInfo_digestedObjectType } from "../PKI-Stub/ObjectDigestInfo-digestedObjectType.ta";
export { ObjectDigestInfo_digestedObjectType, _enum_for_ObjectDigestInfo_digestedObjectType, ObjectDigestInfo_digestedObjectType_publicKey, publicKey, ObjectDigestInfo_digestedObjectType_publicKeyCert, publicKeyCert, ObjectDigestInfo_digestedObjectType_otherObjectTypes, otherObjectTypes, _decode_ObjectDigestInfo_digestedObjectType, _encode_ObjectDigestInfo_digestedObjectType, } from "../PKI-Stub/ObjectDigestInfo-digestedObjectType.ta";
import { AlgorithmIdentifier } from "../PKI-Stub/AlgorithmIdentifier.ta";
/**
 * @summary ObjectDigestInfo
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * ObjectDigestInfo ::= SEQUENCE {
 *   digestedObjectType   ENUMERATED {
 *     publicKey        (0),
 *     publicKeyCert    (1),
 *     otherObjectTypes (2)},
 *   otherObjectTypeID   OBJECT IDENTIFIER OPTIONAL,
 *   digestAlgorithm     AlgorithmIdentifier{{SupportedAlgorithms}},
 *   objectDigest        BIT STRING,
 *   ... }
 * ```
 *
 * @class
 */
export declare class ObjectDigestInfo {
    /**
     * @summary `digestedObjectType`.
     * @public
     * @readonly
     */
    readonly digestedObjectType: ObjectDigestInfo_digestedObjectType;
    /**
     * @summary `otherObjectTypeID`.
     * @public
     * @readonly
     */
    readonly otherObjectTypeID: OPTIONAL<OBJECT_IDENTIFIER>;
    /**
     * @summary `digestAlgorithm`.
     * @public
     * @readonly
     */
    readonly digestAlgorithm: AlgorithmIdentifier;
    /**
     * @summary `objectDigest`.
     * @public
     * @readonly
     */
    readonly objectDigest: BIT_STRING;
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    readonly _unrecognizedExtensionsList: _Element[];
    constructor(
    /**
     * @summary `digestedObjectType`.
     * @public
     * @readonly
     */
    digestedObjectType: ObjectDigestInfo_digestedObjectType, 
    /**
     * @summary `otherObjectTypeID`.
     * @public
     * @readonly
     */
    otherObjectTypeID: OPTIONAL<OBJECT_IDENTIFIER>, 
    /**
     * @summary `digestAlgorithm`.
     * @public
     * @readonly
     */
    digestAlgorithm: AlgorithmIdentifier, 
    /**
     * @summary `objectDigest`.
     * @public
     * @readonly
     */
    objectDigest: BIT_STRING, 
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    _unrecognizedExtensionsList?: _Element[]);
    /**
     * @summary Restructures an object into a ObjectDigestInfo
     * @description
     *
     * This takes an `object` and converts it to a `ObjectDigestInfo`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `ObjectDigestInfo`.
     * @returns {ObjectDigestInfo}
     */
    static _from_object(_o: {
        [_K in keyof ObjectDigestInfo]: ObjectDigestInfo[_K];
    }): ObjectDigestInfo;
    /**
     * @summary The enum used as the type of the component `digestedObjectType`
     * @public
     * @static
     */
    static _enum_for_digestedObjectType: typeof _enum_for_ObjectDigestInfo_digestedObjectType;
}
/**
 * @summary The Leading Root Component Types of ObjectDigestInfo
 * @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_ObjectDigestInfo: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of ObjectDigestInfo
 * @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_ObjectDigestInfo: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of ObjectDigestInfo
 * @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_ObjectDigestInfo: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) ObjectDigestInfo
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {ObjectDigestInfo} The decoded data structure.
 */
export declare function _decode_ObjectDigestInfo(el: _Element): ObjectDigestInfo;
/**
 * @summary Encodes a(n) ObjectDigestInfo 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 ObjectDigestInfo, encoded as an ASN.1 Element.
 */
export declare function _encode_ObjectDigestInfo(value: ObjectDigestInfo, elGetter: $.ASN1Encoder<ObjectDigestInfo>): _Element;