@wildboar/pkcs/src/lib/modules/PKCS-12/SafeBag.ta.d.ts

Public Key Cryptography Standard PDUs in TypeScript

import { ASN1Element as _Element, OBJECT_IDENTIFIER, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { PKCS12Attribute } from "../PKCS-12/PKCS12Attribute.ta";
export { BAG_TYPE } from "../PKCS-12/BAG-TYPE.oca";
export { PKCS12Attribute, _decode_PKCS12Attribute, _encode_PKCS12Attribute, } from "../PKCS-12/PKCS12Attribute.ta";
export { PKCS12BagSet } from "../PKCS-12/PKCS12BagSet.osa";
/**
 * @summary SafeBag
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * SafeBag ::= SEQUENCE {
 *     bagId         BAG-TYPE.&id ({PKCS12BagSet}),
 *     bagValue      [0] EXPLICIT BAG-TYPE.&Type({PKCS12BagSet}{@bagId}),
 *     bagAttributes SET OF PKCS12Attribute OPTIONAL
 * }
 * ```
 *
 * @class
 */
export declare class SafeBag {
    /**
     * @summary `bagId`.
     * @public
     * @readonly
     */
    readonly bagId: OBJECT_IDENTIFIER;
    /**
     * @summary `bagValue`.
     * @public
     * @readonly
     */
    readonly bagValue: _Element;
    /**
     * @summary `bagAttributes`.
     * @public
     * @readonly
     */
    readonly bagAttributes: OPTIONAL<PKCS12Attribute[]>;
    constructor(
    /**
     * @summary `bagId`.
     * @public
     * @readonly
     */
    bagId: OBJECT_IDENTIFIER, 
    /**
     * @summary `bagValue`.
     * @public
     * @readonly
     */
    bagValue: _Element, 
    /**
     * @summary `bagAttributes`.
     * @public
     * @readonly
     */
    bagAttributes: OPTIONAL<PKCS12Attribute[]>);
    /**
     * @summary Restructures an object into a SafeBag
     * @description
     *
     * This takes an `object` and converts it to a `SafeBag`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `SafeBag`.
     * @returns {SafeBag}
     */
    static _from_object(_o: {
        [_K in keyof SafeBag]: SafeBag[_K];
    }): SafeBag;
}
/**
 * @summary The Leading Root Component Types of SafeBag
 * @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_SafeBag: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of SafeBag
 * @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_SafeBag: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of SafeBag
 * @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_SafeBag: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) SafeBag
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {SafeBag} The decoded data structure.
 */
export declare function _decode_SafeBag(el: _Element): SafeBag;
/**
 * @summary Encodes a(n) SafeBag 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 SafeBag, encoded as an ASN.1 Element.
 */
export declare function _encode_SafeBag(value: SafeBag, elGetter: $.ASN1Encoder<SafeBag>): _Element;