@wildboar/pkcs/src/lib/modules/CryptographicMessageSyntax/SignerInfo.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 { CMSVersion } from "../CryptographicMessageSyntax/CMSVersion.ta.mjs";
import { DigestAlgorithmIdentifier } from "../CryptographicMessageSyntax/DigestAlgorithmIdentifier.ta.mjs";
import { SignatureAlgorithmIdentifier } from "../CryptographicMessageSyntax/SignatureAlgorithmIdentifier.ta.mjs";
import { SignatureValue } from "../CryptographicMessageSyntax/SignatureValue.ta.mjs";
import { SignedAttributes } from "../CryptographicMessageSyntax/SignedAttributes.ta.mjs";
import { SignerIdentifier } from "../CryptographicMessageSyntax/SignerIdentifier.ta.mjs";
import { UnsignedAttributes } from "../CryptographicMessageSyntax/UnsignedAttributes.ta.mjs";
/**
 * @summary SignerInfo
 * @description
 *
 * ### ASN.1 Definition:
 *
 * ```asn1
 * SignerInfo ::= SEQUENCE {
 *   version             CMSVersion,
 *   sid                 SignerIdentifier,
 *   digestAlgorithm     DigestAlgorithmIdentifier,
 *   signedAttrs         [0] IMPLICIT SignedAttributes OPTIONAL,
 *   signatureAlgorithm  SignatureAlgorithmIdentifier,
 *   signature           SignatureValue,
 *   unsignedAttrs       [1] IMPLICIT UnsignedAttributes OPTIONAL
 * }
 * ```
 *
 */
export declare class SignerInfo {
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    readonly version: CMSVersion;
    /**
     * @summary `sid`.
     * @public
     * @readonly
     */
    readonly sid: SignerIdentifier;
    /**
     * @summary `digestAlgorithm`.
     * @public
     * @readonly
     */
    readonly digestAlgorithm: DigestAlgorithmIdentifier;
    /**
     * @summary `signedAttrs`.
     * @public
     * @readonly
     */
    readonly signedAttrs: OPTIONAL<SignedAttributes>;
    /**
     * @summary `signatureAlgorithm`.
     * @public
     * @readonly
     */
    readonly signatureAlgorithm: SignatureAlgorithmIdentifier;
    /**
     * @summary `signature`.
     * @public
     * @readonly
     */
    readonly signature: SignatureValue;
    /**
     * @summary `unsignedAttrs`.
     * @public
     * @readonly
     */
    readonly unsignedAttrs?: OPTIONAL<UnsignedAttributes>;
    constructor(
    /**
     * @summary `version`.
     * @public
     * @readonly
     */
    version: CMSVersion, 
    /**
     * @summary `sid`.
     * @public
     * @readonly
     */
    sid: SignerIdentifier, 
    /**
     * @summary `digestAlgorithm`.
     * @public
     * @readonly
     */
    digestAlgorithm: DigestAlgorithmIdentifier, 
    /**
     * @summary `signedAttrs`.
     * @public
     * @readonly
     */
    signedAttrs: OPTIONAL<SignedAttributes>, 
    /**
     * @summary `signatureAlgorithm`.
     * @public
     * @readonly
     */
    signatureAlgorithm: SignatureAlgorithmIdentifier, 
    /**
     * @summary `signature`.
     * @public
     * @readonly
     */
    signature: SignatureValue, 
    /**
     * @summary `unsignedAttrs`.
     * @public
     * @readonly
     */
    unsignedAttrs?: OPTIONAL<UnsignedAttributes>);
    /**
     * @summary Restructures an object into a SignerInfo
     * @description
     *
     * This takes an `object` and converts it to a `SignerInfo`.
     *
     * @public
     * @static
     * @method
     * @param {Object} _o An object having all of the keys and values of a `SignerInfo`.
     * @returns {SignerInfo}
     */
    static _from_object(_o: {
        [_K in keyof SignerInfo]: SignerInfo[_K];
    }): SignerInfo;
}
/**
 * @summary The Leading Root Component Types of SignerInfo
 * @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_SignerInfo: $.ComponentSpec[];
/**
 * @summary The Trailing Root Component Types of SignerInfo
 * @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_SignerInfo: $.ComponentSpec[];
/**
 * @summary The Extension Addition Component Types of SignerInfo
 * @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_SignerInfo: $.ComponentSpec[];
/**
 * @summary Decodes an ASN.1 element into a(n) SignerInfo
 * @function
 * @param {_Element} el The element being decoded.
 * @returns {SignerInfo} The decoded data structure.
 */
export declare function _decode_SignerInfo(el: _Element): SignerInfo;
/**
 * @summary Encodes a(n) SignerInfo 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 SignerInfo, encoded as an ASN.1 Element.
 */
export declare function _encode_SignerInfo(value: SignerInfo, elGetter: $.ASN1Encoder<SignerInfo>): _Element;
//# sourceMappingURL=SignerInfo.ta.d.mts.map