@wildboar/pki-stub/src/lib/modules/PKI-Stub/Extension.ta.d.mts

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

import { OPTIONAL, BOOLEAN, OCTET_STRING, OBJECT_IDENTIFIER, ASN1Element as _Element, DERElement } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
/**
 * @summary Extension
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * Extension ::= SEQUENCE {
 *   extnId     EXTENSION.&id({ExtensionSet}),
 *   critical   BOOLEAN DEFAULT FALSE,
 *   extnValue  OCTET STRING
 *     (CONTAINING EXTENSION.&ExtnType({ExtensionSet}{@extnId})
 *        ENCODED BY der),
 *   ... }
 * ```
 *
 */
export declare class Extension {
    /**
     * @summary `extnId`.
     * @public
     * @readonly
     */
    readonly extnId: OBJECT_IDENTIFIER;
    /**
     * @summary `critical`.
     * @public
     * @readonly
     */
    readonly critical: OPTIONAL<BOOLEAN>;
    /**
     * @summary `extnValue`.
     * @public
     * @readonly
     */
    readonly extnValue: OCTET_STRING;
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    readonly _unrecognizedExtensionsList: _Element[];
    constructor(
    /**
     * @summary `extnId`.
     * @public
     * @readonly
     */
    extnId: OBJECT_IDENTIFIER, 
    /**
     * @summary `critical`.
     * @public
     * @readonly
     */
    critical: OPTIONAL<BOOLEAN>, 
    /**
     * @summary `extnValue`.
     * @public
     * @readonly
     */
    extnValue: OCTET_STRING, 
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    _unrecognizedExtensionsList?: _Element[]);
    /**
     * @summary Restructures an object into a Extension
     * @description
     *
     * This takes an `object` and converts it to a `Extension`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `Extension`.
     * @returns {Extension}
     */
    static _from_object(_o: {
        [_K in keyof Extension]: Extension[_K];
    }): Extension;
    /**
     * @summary Getter that returns the default value for `critical`.
     * @public
     * @static
     * @method
     */
    static get _default_value_for_critical(): BOOLEAN;
    valueElement(): DERElement;
}
/**
 * @summary The Leading Root Component Types of Extension
 * @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_Extension: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of Extension
 * @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_Extension: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of Extension
 * @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_Extension: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) Extension
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {Extension} The decoded data structure.
 */
export declare function _decode_Extension(el: _Element): Extension;
/**
 * @summary Encodes a(n) Extension 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 Extension, encoded as an ASN.1 Element.
 */
export declare function _encode_Extension(value: Extension): _Element;
//# sourceMappingURL=Extension.ta.d.mts.map