@wildboar/pkcs/src/lib/modules/AsymmetricKeyPackageModuleV1/OneAsymmetricKey.ta.d.ts

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { Attributes } from "../AsymmetricKeyPackageModuleV1/Attributes.ta";
import { PrivateKey } from "../AsymmetricKeyPackageModuleV1/PrivateKey.ta";
import { PrivateKeyAlgorithmIdentifier } from "../AsymmetricKeyPackageModuleV1/PrivateKeyAlgorithmIdentifier.ta";
import { Version } from "../AsymmetricKeyPackageModuleV1/Version.ta";
import { PublicKey } from "../AsymmetricKeyPackageModuleV1/PublicKey.ta";
/**
 * @summary OneAsymmetricKey
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * OneAsymmetricKey ::= SEQUENCE {
 *     version                   Version,
 *     privateKeyAlgorithm       PrivateKeyAlgorithmIdentifier,
 *     privateKey                PrivateKey,
 *     attributes            [0] Attributes OPTIONAL,
 *     ...,
 *     [[2: publicKey        [1] PublicKey OPTIONAL ]],
 *     ...
 * }
 * ```
 *
 * @class
 */
export declare class OneAsymmetricKey {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: Version;
    /**
     * @summary `privateKeyAlgorithm`.
     * @public
     * @readonly
     */
    readonly privateKeyAlgorithm: PrivateKeyAlgorithmIdentifier;
    /**
     * @summary `privateKey`.
     * @public
     * @readonly
     */
    readonly privateKey: PrivateKey;
    /**
     * @summary `attributes`.
     * @public
     * @readonly
     */
    readonly attributes: OPTIONAL<Attributes>;
    /**
     * @summary `publicKey`.
     * @public
     * @readonly
     */
    readonly publicKey: OPTIONAL<PublicKey>;
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    readonly _unrecognizedExtensionsList: _Element[];
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: Version, 
    /**
     * @summary `privateKeyAlgorithm`.
     * @public
     * @readonly
     */
    privateKeyAlgorithm: PrivateKeyAlgorithmIdentifier, 
    /**
     * @summary `privateKey`.
     * @public
     * @readonly
     */
    privateKey: PrivateKey, 
    /**
     * @summary `attributes`.
     * @public
     * @readonly
     */
    attributes: OPTIONAL<Attributes>, 
    /**
     * @summary `publicKey`.
     * @public
     * @readonly
     */
    publicKey: OPTIONAL<PublicKey>, 
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    _unrecognizedExtensionsList?: _Element[]);
    /**
     * @summary Restructures an object into a OneAsymmetricKey
     * @description
     *
     * This takes an `object` and converts it to a `OneAsymmetricKey`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `OneAsymmetricKey`.
     * @returns {OneAsymmetricKey}
     */
    static _from_object(_o: {
        [_K in keyof OneAsymmetricKey]: OneAsymmetricKey[_K];
    }): OneAsymmetricKey;
}
/**
 * @summary The Leading Root Component Types of OneAsymmetricKey
 * @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_OneAsymmetricKey: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of OneAsymmetricKey
 * @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_OneAsymmetricKey: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of OneAsymmetricKey
 * @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_OneAsymmetricKey: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) OneAsymmetricKey
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {OneAsymmetricKey} The decoded data structure.
 */
export declare function _decode_OneAsymmetricKey(el: _Element): OneAsymmetricKey;
/**
 * @summary Encodes a(n) OneAsymmetricKey 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 OneAsymmetricKey, encoded as an ASN.1 Element.
 */
export declare function _encode_OneAsymmetricKey(value: OneAsymmetricKey, elGetter: $.ASN1Encoder<OneAsymmetricKey>): _Element;