@wildboar/pkcs
Version:
Public Key Cryptography Standard PDUs in TypeScript
177 lines • 5 kB
text/typescript
import { ASN1Element as _Element, GeneralizedTime, OBJECT_IDENTIFIER, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { BiometricFlags } from "../PKCS-15/BiometricFlags.ta.mjs";
import { BiometricType } from "../PKCS-15/BiometricType.ta.mjs";
import { Path } from "../PKCS-15/Path.ta.mjs";
import { Reference } from "../PKCS-15/Reference.ta.mjs";
/**
* @summary BiometricAttributes
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* BiometricAttributes ::= SEQUENCE {
* bioFlags BiometricFlags,
* templateId OBJECT IDENTIFIER,
* bioType BiometricType,
* bioReference Reference DEFAULT 0,
* lastChange GeneralizedTime OPTIONAL,
* path Path OPTIONAL,
* ... -- For future extensions
* }
* ```
*
*/
export declare class BiometricAttributes {
/**
* @summary `bioFlags`.
* @public
* @readonly
*/
readonly bioFlags: BiometricFlags;
/**
* @summary `templateId`.
* @public
* @readonly
*/
readonly templateId: OBJECT_IDENTIFIER;
/**
* @summary `bioType`.
* @public
* @readonly
*/
readonly bioType: BiometricType;
/**
* @summary `bioReference`.
* @public
* @readonly
*/
readonly bioReference?: OPTIONAL<Reference>;
/**
* @summary `lastChange`.
* @public
* @readonly
*/
readonly lastChange?: OPTIONAL<GeneralizedTime>;
/**
* @summary `path`.
* @public
* @readonly
*/
readonly path?: OPTIONAL<Path>;
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
readonly _unrecognizedExtensionsList: _Element[];
constructor(
/**
* @summary `bioFlags`.
* @public
* @readonly
*/
bioFlags: BiometricFlags,
/**
* @summary `templateId`.
* @public
* @readonly
*/
templateId: OBJECT_IDENTIFIER,
/**
* @summary `bioType`.
* @public
* @readonly
*/
bioType: BiometricType,
/**
* @summary `bioReference`.
* @public
* @readonly
*/
bioReference?: OPTIONAL<Reference>,
/**
* @summary `lastChange`.
* @public
* @readonly
*/
lastChange?: OPTIONAL<GeneralizedTime>,
/**
* @summary `path`.
* @public
* @readonly
*/
path?: OPTIONAL<Path>,
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
_unrecognizedExtensionsList?: _Element[]);
/**
* @summary Restructures an object into a BiometricAttributes
* @description
*
* This takes an `object` and converts it to a `BiometricAttributes`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `BiometricAttributes`.
* @returns {BiometricAttributes}
*/
static _from_object(_o: {
[_K in keyof BiometricAttributes]: BiometricAttributes[_K];
}): BiometricAttributes;
/**
* @summary Getter that returns the default value for `bioReference`.
* @public
* @static
* @method
*/
static get _default_value_for_bioReference(): Reference;
}
/**
* @summary The Leading Root Component Types of BiometricAttributes
* @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_BiometricAttributes: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of BiometricAttributes
* @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_BiometricAttributes: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of BiometricAttributes
* @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_BiometricAttributes: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) BiometricAttributes
* @function
* @param {_Element} el The element being decoded.
* @returns {BiometricAttributes} The decoded data structure.
*/
export declare function _decode_BiometricAttributes(el: _Element): BiometricAttributes;
/**
* @summary Encodes a(n) BiometricAttributes 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 BiometricAttributes, encoded as an ASN.1 Element.
*/
export declare function _encode_BiometricAttributes(value: BiometricAttributes, elGetter: $.ASN1Encoder<BiometricAttributes>): _Element;
//# sourceMappingURL=BiometricAttributes.ta.d.mts.map