@wildboar/pkcs
Version:
Public Key Cryptography Standard PDUs in TypeScript
116 lines • 3.9 kB
text/typescript
import { ASN1Element as _Element, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { Name } from "@wildboar/x500/InformationFramework";
import { CredentialIdentifier } from "../PKCS-15/CredentialIdentifier.ta.mjs";
/**
* @summary CommonPrivateKeyAttributes
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* CommonPrivateKeyAttributes ::= SEQUENCE {
* subjectName Name OPTIONAL,
* keyIdentifiers [0] SEQUENCE OF CredentialIdentifier {{KeyIdentifiers}} OPTIONAL,
* ... -- For future extensions
* }
* ```
*
*/
export declare class CommonPrivateKeyAttributes {
/**
* @summary `subjectName`.
* @public
* @readonly
*/
readonly subjectName?: OPTIONAL<Name>;
/**
* @summary `keyIdentifiers`.
* @public
* @readonly
*/
readonly keyIdentifiers?: OPTIONAL<CredentialIdentifier[]>;
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
readonly _unrecognizedExtensionsList: _Element[];
constructor(
/**
* @summary `subjectName`.
* @public
* @readonly
*/
subjectName?: OPTIONAL<Name>,
/**
* @summary `keyIdentifiers`.
* @public
* @readonly
*/
keyIdentifiers?: OPTIONAL<CredentialIdentifier[]>,
/**
* @summary Extensions that are not recognized.
* @public
* @readonly
*/
_unrecognizedExtensionsList?: _Element[]);
/**
* @summary Restructures an object into a CommonPrivateKeyAttributes
* @description
*
* This takes an `object` and converts it to a `CommonPrivateKeyAttributes`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `CommonPrivateKeyAttributes`.
* @returns {CommonPrivateKeyAttributes}
*/
static _from_object(_o: {
[_K in keyof CommonPrivateKeyAttributes]: CommonPrivateKeyAttributes[_K];
}): CommonPrivateKeyAttributes;
}
/**
* @summary The Leading Root Component Types of CommonPrivateKeyAttributes
* @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_CommonPrivateKeyAttributes: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of CommonPrivateKeyAttributes
* @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_CommonPrivateKeyAttributes: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of CommonPrivateKeyAttributes
* @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_CommonPrivateKeyAttributes: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) CommonPrivateKeyAttributes
* @function
* @param {_Element} el The element being decoded.
* @returns {CommonPrivateKeyAttributes} The decoded data structure.
*/
export declare function _decode_CommonPrivateKeyAttributes(el: _Element): CommonPrivateKeyAttributes;
/**
* @summary Encodes a(n) CommonPrivateKeyAttributes 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 CommonPrivateKeyAttributes, encoded as an ASN.1 Element.
*/
export declare function _encode_CommonPrivateKeyAttributes(value: CommonPrivateKeyAttributes, elGetter: $.ASN1Encoder<CommonPrivateKeyAttributes>): _Element;
//# sourceMappingURL=CommonPrivateKeyAttributes.ta.d.mts.map