@wildboar/pkcs/src/lib/modules/PKCS-12/PFX.ta.d.mts

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { MacData } from "../PKCS-12/MacData.ta.mjs";
import { PFX_version } from "../PKCS-12/PFX-version.ta.mjs";
import { ContentInfo } from "../PKCS7/ContentInfo.ta.mjs";
/**
 * @summary PFX
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * PFX ::= SEQUENCE {
 *     version    INTEGER {v3(3)}(v3,...),
 *     authSafe   ContentInfo,
 *     macData    MacData OPTIONAL
 * }
 * ```
 *
 */
export declare class PFX {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: PFX_version;
    /**
     * @summary `authSafe`.
     * @public
     * @readonly
     */
    readonly authSafe: ContentInfo;
    /**
     * @summary `macData`.
     * @public
     * @readonly
     */
    readonly macData?: OPTIONAL<MacData>;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: PFX_version, 
    /**
     * @summary `authSafe`.
     * @public
     * @readonly
     */
    authSafe: ContentInfo, 
    /**
     * @summary `macData`.
     * @public
     * @readonly
     */
    macData?: OPTIONAL<MacData>);
    /**
     * @summary Restructures an object into a PFX
     * @description
     *
     * This takes an `object` and converts it to a `PFX`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `PFX`.
     * @returns {PFX}
     */
    static _from_object(_o: {
        [_K in keyof PFX]: PFX[_K];
    }): PFX;
}
/**
 * @summary The Leading Root Component Types of PFX
 * @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_PFX: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of PFX
 * @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_PFX: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of PFX
 * @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_PFX: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) PFX
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {PFX} The decoded data structure.
 */
export declare function _decode_PFX(el: _Element): PFX;
/**
 * @summary Encodes a(n) PFX 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 PFX, encoded as an ASN.1 Element.
 */
export declare function _encode_PFX(value: PFX, elGetter: $.ASN1Encoder<PFX>): _Element;
//# sourceMappingURL=PFX.ta.d.mts.map