@wildboar/pkcs/src/lib/modules/PKCS7/ContentInfo.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";
export { PKCS7_CONTENT_TYPE } from "../PKCS7/PKCS7-CONTENT-TYPE.oca";
export { PKCS7ContentTable } from "../PKCS7/PKCS7ContentTable.osa";
/**
 * @summary ContentInfo
 * @description
 *
 * NOTE: This was modified from the original definition in ITU X.420 to make
 * `pkcs7-content` explicitly encoded, because the ITU X.420 definition uses
 * implicit encoding, which conflicts with the authoritative IETF RFC version.
 * `pkcs7-content` was also made optional.
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * ContentInfo ::= SEQUENCE {
 *     content-type   PKCS7-CONTENT-TYPE.&id({PKCS7ContentTable}),
 *     pkcs7-content  [0] EXPLICIT PKCS7-CONTENT-TYPE.&Type({PKCS7ContentTable}) OPTIONAL
 * }
 * ```
 *
 * @class
 */
export declare class ContentInfo {
    /**
     * @summary `content_type`.
     * @public
     * @readonly
     */
    readonly content_type: OBJECT_IDENTIFIER;
    /**
     * @summary `pkcs7_content`.
     * @public
     * @readonly
     */
    readonly pkcs7_content: OPTIONAL<_Element>;
    constructor(
    /**
     * @summary `content_type`.
     * @public
     * @readonly
     */
    content_type: OBJECT_IDENTIFIER, 
    /**
     * @summary `pkcs7_content`.
     * @public
     * @readonly
     */
    pkcs7_content: OPTIONAL<_Element>);
    /**
     * @summary Restructures an object into a ContentInfo
     * @description
     *
     * This takes an `object` and converts it to a `ContentInfo`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `ContentInfo`.
     * @returns {ContentInfo}
     */
    static _from_object(_o: {
        [_K in keyof ContentInfo]: ContentInfo[_K];
    }): ContentInfo;
}
/**
 * @summary The Leading Root Component Types of ContentInfo
 * @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_ContentInfo: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of ContentInfo
 * @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_ContentInfo: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of ContentInfo
 * @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_ContentInfo: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) ContentInfo
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {ContentInfo} The decoded data structure.
 */
export declare function _decode_ContentInfo(el: _Element): ContentInfo;
/**
 * @summary Encodes a(n) ContentInfo 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 ContentInfo, encoded as an ASN.1 Element.
 */
export declare function _encode_ContentInfo(value: ContentInfo, elGetter: $.ASN1Encoder<ContentInfo>): _Element;