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

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element, OBJECT_IDENTIFIER, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { Path } from "../PKCS-15/Path.ta.mjs";
/**
 * @summary DDO
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * DDO ::= SEQUENCE {
 *     oid    OBJECT IDENTIFIER,
 *     odfPath    Path OPTIONAL,
 *     tokenInfoPath [0] Path OPTIONAL,
 *     unusedPath [1] Path OPTIONAL,
 *     ... -- For future extensions
 * }
 * ```
 *
 */
export declare class DDO {
    /**
     * @summary `oid`.
     * @public
     * @readonly
     */
    readonly oid: OBJECT_IDENTIFIER;
    /**
     * @summary `odfPath`.
     * @public
     * @readonly
     */
    readonly odfPath?: OPTIONAL<Path>;
    /**
     * @summary `tokenInfoPath`.
     * @public
     * @readonly
     */
    readonly tokenInfoPath?: OPTIONAL<Path>;
    /**
     * @summary `unusedPath`.
     * @public
     * @readonly
     */
    readonly unusedPath?: OPTIONAL<Path>;
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    readonly _unrecognizedExtensionsList: _Element[];
    constructor(
    /**
     * @summary `oid`.
     * @public
     * @readonly
     */
    oid: OBJECT_IDENTIFIER, 
    /**
     * @summary `odfPath`.
     * @public
     * @readonly
     */
    odfPath?: OPTIONAL<Path>, 
    /**
     * @summary `tokenInfoPath`.
     * @public
     * @readonly
     */
    tokenInfoPath?: OPTIONAL<Path>, 
    /**
     * @summary `unusedPath`.
     * @public
     * @readonly
     */
    unusedPath?: OPTIONAL<Path>, 
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    _unrecognizedExtensionsList?: _Element[]);
    /**
     * @summary Restructures an object into a DDO
     * @description
     *
     * This takes an `object` and converts it to a `DDO`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `DDO`.
     * @returns {DDO}
     */
    static _from_object(_o: {
        [_K in keyof DDO]: DDO[_K];
    }): DDO;
}
/**
 * @summary The Leading Root Component Types of DDO
 * @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_DDO: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of DDO
 * @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_DDO: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of DDO
 * @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_DDO: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) DDO
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {DDO} The decoded data structure.
 */
export declare function _decode_DDO(el: _Element): DDO;
/**
 * @summary Encodes a(n) DDO 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 DDO, encoded as an ASN.1 Element.
 */
export declare function _encode_DDO(value: DDO, elGetter: $.ASN1Encoder<DDO>): _Element;
//# sourceMappingURL=DDO.ta.d.mts.map