@wildboar/pkcs
Version:
Public Key Cryptography Standard PDUs in TypeScript
181 lines (180 loc) • 6.19 kB
TypeScript
import { ASN1Element as _Element, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { CMSVersion } from "../CryptographicMessageSyntax/CMSVersion.ta";
import { DigestAlgorithmIdentifier } from "../CryptographicMessageSyntax/DigestAlgorithmIdentifier.ta";
import { SignatureAlgorithmIdentifier } from "../CryptographicMessageSyntax/SignatureAlgorithmIdentifier.ta";
import { SignatureValue } from "../CryptographicMessageSyntax/SignatureValue.ta";
import { SignedAttributes } from "../CryptographicMessageSyntax/SignedAttributes.ta";
import { SignerIdentifier } from "../CryptographicMessageSyntax/SignerIdentifier.ta";
import { UnsignedAttributes } from "../CryptographicMessageSyntax/UnsignedAttributes.ta";
export { CMSVersion, CMSVersion_v0, CMSVersion_v1, CMSVersion_v2, CMSVersion_v3, CMSVersion_v4, v0, v1, v2, v3, v4, _decode_CMSVersion, _encode_CMSVersion, } from "../CryptographicMessageSyntax/CMSVersion.ta";
export { DigestAlgorithmIdentifier, _decode_DigestAlgorithmIdentifier, _encode_DigestAlgorithmIdentifier, } from "../CryptographicMessageSyntax/DigestAlgorithmIdentifier.ta";
export { SignatureAlgorithmIdentifier, _decode_SignatureAlgorithmIdentifier, _encode_SignatureAlgorithmIdentifier, } from "../CryptographicMessageSyntax/SignatureAlgorithmIdentifier.ta";
export { SignatureValue, _decode_SignatureValue, _encode_SignatureValue, } from "../CryptographicMessageSyntax/SignatureValue.ta";
export { SignedAttributes, _decode_SignedAttributes, _encode_SignedAttributes, } from "../CryptographicMessageSyntax/SignedAttributes.ta";
export { SignerIdentifier, _decode_SignerIdentifier, _encode_SignerIdentifier, } from "../CryptographicMessageSyntax/SignerIdentifier.ta";
export { UnsignedAttributes, _decode_UnsignedAttributes, _encode_UnsignedAttributes, } from "../CryptographicMessageSyntax/UnsignedAttributes.ta";
/**
* @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
* }
* ```
*
* @class
*/
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} el The element being decoded.
* @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;