@wildboar/pkcs/src/lib/modules/PKCS-15/PasswordInfo.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 { AlgorithmIdentifier } from "@wildboar/x500/src/lib/modules/AuthenticationFramework/AlgorithmIdentifier.ta";
import { Label } from "../PKCS-15/Label.ta";
export { Label, _decode_Label, _encode_Label } from "../PKCS-15/Label.ta";
/**
 * @summary PasswordInfo
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * PasswordInfo ::= SEQUENCE {
 *     hint Label OPTIONAL,
 *     algId AlgorithmIdentifier {{KeyDerivationAlgorithms}},
 *     ...
 * } (CONSTRAINED BY {--keyID shall point to a KEKRecipientInfo--})
 * ```
 *
 * @class
 */
export declare class PasswordInfo {
    /**
     * @summary `hint`.
     * @public
     * @readonly
     */
    readonly hint: OPTIONAL<Label>;
    /**
     * @summary `algId`.
     * @public
     * @readonly
     */
    readonly algId: AlgorithmIdentifier;
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    readonly _unrecognizedExtensionsList: _Element[];
    constructor(
    /**
     * @summary `hint`.
     * @public
     * @readonly
     */
    hint: OPTIONAL<Label>, 
    /**
     * @summary `algId`.
     * @public
     * @readonly
     */
    algId: AlgorithmIdentifier, 
    /**
     * @summary Extensions that are not recognized.
     * @public
     * @readonly
     */
    _unrecognizedExtensionsList?: _Element[]);
    /**
     * @summary Restructures an object into a PasswordInfo
     * @description
     *
     * This takes an `object` and converts it to a `PasswordInfo`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `PasswordInfo`.
     * @returns {PasswordInfo}
     */
    static _from_object(_o: {
        [_K in keyof PasswordInfo]: PasswordInfo[_K];
    }): PasswordInfo;
}
/**
 * @summary The Leading Root Component Types of PasswordInfo
 * @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_PasswordInfo: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of PasswordInfo
 * @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_PasswordInfo: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of PasswordInfo
 * @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_PasswordInfo: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) PasswordInfo
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {PasswordInfo} The decoded data structure.
 */
export declare function _decode_PasswordInfo(el: _Element): PasswordInfo;
/**
 * @summary Encodes a(n) PasswordInfo 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 PasswordInfo, encoded as an ASN.1 Element.
 */
export declare function _encode_PasswordInfo(value: PasswordInfo, elGetter: $.ASN1Encoder<PasswordInfo>): _Element;