@wildboar/pkcs/src/lib/modules/PKCS-15/PrivateECKeyAttributes.ta.d.ts

Public Key Cryptography Standard PDUs in TypeScript

import { Parameters } from "@wildboar/ansi-x9-62/src/lib/modules/ANSI-X9-62/Parameters.ta";
import { ASN1Element as _Element, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { ECPrivateKey } from "../PKCS-15/ECPrivateKey.ta";
import { KeyInfo } from "../PKCS-15/KeyInfo.ta";
import { ObjectValue } from "../PKCS-15/ObjectValue.ta";
import { PublicKeyOperations } from "../PKCS-15/PublicKeyOperations.ta";
/**
 * @summary PrivateECKeyAttributes
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * PrivateECKeyAttributes ::= SEQUENCE {
 *     value  ObjectValue {ECPrivateKey},
 *     keyInfo KeyInfo {Parameters, PublicKeyOperations} OPTIONAL,
 *     ... -- For future extensions
 * }
 * ```
 *
 * @class
 */
export declare class PrivateECKeyAttributes {
    /**
     * @summary `value`.
     * @public
     * @readonly
     */
    readonly value: ObjectValue<ECPrivateKey>;
    /**
     * @summary `keyInfo`.
     * @public
     * @readonly
     */
    readonly keyInfo: OPTIONAL<KeyInfo<Parameters, PublicKeyOperations>>;
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    readonly _unrecognizedExtensionsList: _Element[];
    constructor(
    /**
     * @summary `value`.
     * @public
     * @readonly
     */
    value: ObjectValue<ECPrivateKey>, 
    /**
     * @summary `keyInfo`.
     * @public
     * @readonly
     */
    keyInfo: OPTIONAL<KeyInfo<Parameters, PublicKeyOperations>>, 
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    _unrecognizedExtensionsList?: _Element[]);
    /**
     * @summary Restructures an object into a PrivateECKeyAttributes
     * @description
     *
     * This takes an `object` and converts it to a `PrivateECKeyAttributes`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `PrivateECKeyAttributes`.
     * @returns {PrivateECKeyAttributes}
     */
    static _from_object(_o: {
        [_K in keyof PrivateECKeyAttributes]: PrivateECKeyAttributes[_K];
    }): PrivateECKeyAttributes;
}
/**
 * @summary The Leading Root Component Types of PrivateECKeyAttributes
 * @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_PrivateECKeyAttributes: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of PrivateECKeyAttributes
 * @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_PrivateECKeyAttributes: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of PrivateECKeyAttributes
 * @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_PrivateECKeyAttributes: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) PrivateECKeyAttributes
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {PrivateECKeyAttributes} The decoded data structure.
 */
export declare function _decode_PrivateECKeyAttributes(el: _Element): PrivateECKeyAttributes;
/**
 * @summary Encodes a(n) PrivateECKeyAttributes 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 PrivateECKeyAttributes, encoded as an ASN.1 Element.
 */
export declare function _encode_PrivateECKeyAttributes(value: PrivateECKeyAttributes, elGetter: $.ASN1Encoder<PrivateECKeyAttributes>): _Element;