@wildboar/pkcs
Version:
Public Key Cryptography Standard PDUs in TypeScript
122 lines • 3.67 kB
text/typescript
import { ASN1Element as _Element, BOOLEAN, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { Identifier } from "../PKCS-15/Identifier.ta.mjs";
/**
* @summary AuthKeyAttributes
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* AuthKeyAttributes ::= SEQUENCE {
* derivedKey BOOLEAN DEFAULT TRUE,
* authKeyId Identifier,
* ... -- For future extensions
* }
* ```
*
*/
export declare class AuthKeyAttributes {
/**
* @summary `derivedKey`.
* @public
* @readonly
*/
readonly derivedKey: OPTIONAL<BOOLEAN>;
/**
* @summary `authKeyId`.
* @public
* @readonly
*/
readonly authKeyId: Identifier;
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
readonly _unrecognizedExtensionsList: _Element[];
constructor(
/**
* @summary `derivedKey`.
* @public
* @readonly
*/
derivedKey: OPTIONAL<BOOLEAN>,
/**
* @summary `authKeyId`.
* @public
* @readonly
*/
authKeyId: Identifier,
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
_unrecognizedExtensionsList?: _Element[]);
/**
* @summary Restructures an object into a AuthKeyAttributes
* @description
*
* This takes an `object` and converts it to a `AuthKeyAttributes`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `AuthKeyAttributes`.
* @returns {AuthKeyAttributes}
*/
static _from_object(_o: {
[_K in keyof AuthKeyAttributes]: AuthKeyAttributes[_K];
}): AuthKeyAttributes;
/**
* @summary Getter that returns the default value for `derivedKey`.
* @public
* @static
* @method
*/
static get _default_value_for_derivedKey(): boolean;
}
/**
* @summary The Leading Root Component Types of AuthKeyAttributes
* @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_AuthKeyAttributes: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of AuthKeyAttributes
* @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_AuthKeyAttributes: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of AuthKeyAttributes
* @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_AuthKeyAttributes: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) AuthKeyAttributes
* @function
* @param {_Element} el The element being decoded.
* @returns {AuthKeyAttributes} The decoded data structure.
*/
export declare function _decode_AuthKeyAttributes(el: _Element): AuthKeyAttributes;
/**
* @summary Encodes a(n) AuthKeyAttributes 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 AuthKeyAttributes, encoded as an ASN.1 Element.
*/
export declare function _encode_AuthKeyAttributes(value: AuthKeyAttributes, elGetter: $.ASN1Encoder<AuthKeyAttributes>): _Element;
//# sourceMappingURL=AuthKeyAttributes.ta.d.mts.map