@wildboar/pkcs
Version:
Public Key Cryptography Standard PDUs in TypeScript
102 lines • 3.01 kB
text/typescript
import { ASN1Element as _Element, OBJECT_IDENTIFIER, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { KeyUsage } from "@wildboar/x500/CertificateExtensions";
/**
* @summary Usage
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* Usage ::= SEQUENCE {
* keyUsage KeyUsage OPTIONAL,
* extKeyUsage SEQUENCE SIZE (1..MAX) OF OBJECT IDENTIFIER OPTIONAL
* }(WITH COMPONENTS {..., keyUsage PRESENT} | WITH COMPONENTS {..., extKeyUsage PRESENT})
* ```
*
*/
export declare class Usage {
/**
* @summary `keyUsage`.
* @public
* @readonly
*/
readonly keyUsage?: OPTIONAL<KeyUsage>;
/**
* @summary `extKeyUsage`.
* @public
* @readonly
*/
readonly extKeyUsage?: OPTIONAL<OBJECT_IDENTIFIER[]>;
constructor(
/**
* @summary `keyUsage`.
* @public
* @readonly
*/
keyUsage?: OPTIONAL<KeyUsage>,
/**
* @summary `extKeyUsage`.
* @public
* @readonly
*/
extKeyUsage?: OPTIONAL<OBJECT_IDENTIFIER[]>);
/**
* @summary Restructures an object into a Usage
* @description
*
* This takes an `object` and converts it to a `Usage`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `Usage`.
* @returns {Usage}
*/
static _from_object(_o: {
[_K in keyof Usage]: Usage[_K];
}): Usage;
}
/**
* @summary The Leading Root Component Types of Usage
* @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_Usage: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of Usage
* @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_Usage: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of Usage
* @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_Usage: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) Usage
* @function
* @param {_Element} el The element being decoded.
* @returns {Usage} The decoded data structure.
*/
export declare function _decode_Usage(el: _Element): Usage;
/**
* @summary Encodes a(n) Usage 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 Usage, encoded as an ASN.1 Element.
*/
export declare function _encode_Usage(value: Usage, elGetter: $.ASN1Encoder<Usage>): _Element;
//# sourceMappingURL=Usage.ta.d.mts.map