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

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element, INTEGER, OCTET_STRING, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
/**
 * @summary Path
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * Path ::= SEQUENCE {
 *     path OCTET STRING,
 *     index  INTEGER (0..pkcs15-ub-index) OPTIONAL,
 *     length [0] INTEGER (0..pkcs15-ub-index) OPTIONAL
 * }( WITH COMPONENTS {..., index PRESENT, length PRESENT} | WITH COMPONENTS {..., index ABSENT, length ABSENT})
 * ```
 *
 */
export declare class Path {
    /**
     * @summary `path`.
     * @public
     * @readonly
     */
    readonly path: OCTET_STRING;
    /**
     * @summary `index`.
     * @public
     * @readonly
     */
    readonly index?: OPTIONAL<INTEGER>;
    /**
     * @summary `length`.
     * @public
     * @readonly
     */
    readonly length?: OPTIONAL<INTEGER>;
    constructor(
    /**
     * @summary `path`.
     * @public
     * @readonly
     */
    path: OCTET_STRING, 
    /**
     * @summary `index`.
     * @public
     * @readonly
     */
    index?: OPTIONAL<INTEGER>, 
    /**
     * @summary `length`.
     * @public
     * @readonly
     */
    length?: OPTIONAL<INTEGER>);
    /**
     * @summary Restructures an object into a Path
     * @description
     *
     * This takes an `object` and converts it to a `Path`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `Path`.
     * @returns {Path}
     */
    static _from_object(_o: {
        [_K in keyof Path]: Path[_K];
    }): Path;
}
/**
 * @summary The Leading Root Component Types of Path
 * @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_Path: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of Path
 * @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_Path: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of Path
 * @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_Path: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) Path
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {Path} The decoded data structure.
 */
export declare function _decode_Path(el: _Element): Path;
/**
 * @summary Encodes a(n) Path 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 Path, encoded as an ASN.1 Element.
 */
export declare function _encode_Path(value: Path, elGetter: $.ASN1Encoder<Path>): _Element;
//# sourceMappingURL=Path.ta.d.mts.map