@wildboar/pkcs
Version:
Public Key Cryptography Standard PDUs in TypeScript
120 lines (119 loc) • 3.54 kB
TypeScript
import { ASN1Element as _Element, BIT_STRING, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { AlgorithmIdentifier } from "@wildboar/x500/src/lib/modules/AuthenticationFramework/AlgorithmIdentifier.ta";
import { CertId } from "../PKIXCRMF-2009/CertId.ta";
/**
* @summary OOBCertHash
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* OOBCertHash ::= SEQUENCE {
* hashAlg [0] AlgorithmIdentifier{DIGEST-ALGORITHM, {...}}
* OPTIONAL,
* certId [1] CertId OPTIONAL,
* hashVal BIT STRING
* -- hashVal is calculated over the DER encoding of the
* -- self-signed certificate with the identifier certID.
* }
* ```
*
* @class
*/
export declare class OOBCertHash {
/**
* @summary `hashAlg`.
* @public
* @readonly
*/
readonly hashAlg: OPTIONAL<AlgorithmIdentifier>;
/**
* @summary `certId`.
* @public
* @readonly
*/
readonly certId: OPTIONAL<CertId>;
/**
* @summary `hashVal`.
* @public
* @readonly
*/
readonly hashVal: BIT_STRING;
constructor(
/**
* @summary `hashAlg`.
* @public
* @readonly
*/
hashAlg: OPTIONAL<AlgorithmIdentifier>,
/**
* @summary `certId`.
* @public
* @readonly
*/
certId: OPTIONAL<CertId>,
/**
* @summary `hashVal`.
* @public
* @readonly
*/
hashVal: BIT_STRING);
/**
* @summary Restructures an object into a OOBCertHash
* @description
*
* This takes an `object` and converts it to a `OOBCertHash`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `OOBCertHash`.
* @returns {OOBCertHash}
*/
static _from_object(_o: {
[_K in keyof OOBCertHash]: OOBCertHash[_K];
}): OOBCertHash;
}
/**
* @summary The Leading Root Component Types of OOBCertHash
* @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_OOBCertHash: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of OOBCertHash
* @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_OOBCertHash: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of OOBCertHash
* @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_OOBCertHash: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) OOBCertHash
* @function
* @param {_Element} el The element being decoded.
* @returns {OOBCertHash} The decoded data structure.
*/
export declare function _decode_OOBCertHash(el: _Element): OOBCertHash;
/**
* @summary Encodes a(n) OOBCertHash 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 OOBCertHash, encoded as an ASN.1 Element.
*/
export declare function _encode_OOBCertHash(value: OOBCertHash, elGetter: $.ASN1Encoder<OOBCertHash>): _Element;