@wildboar/pkcs
Version:
Public Key Cryptography Standard PDUs in TypeScript
207 lines • 5.3 kB
text/typescript
import { ASN1Element as _Element, OCTET_STRING, OPTIONAL } from "@wildboar/asn1";
import * as $ from "@wildboar/asn1/functional";
import { OtherPrimeInfos } from "../PKCS-1/OtherPrimeInfos.ta.mjs";
import { Version } from "../PKCS-1/Version.ta.mjs";
/**
* @summary RSAPrivateKey
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* RSAPrivateKey ::= SEQUENCE {
* version Version,
* modulus INTEGER, -- n
* publicExponent INTEGER, -- e
* privateExponent INTEGER, -- d
* prime1 INTEGER, -- p
* prime2 INTEGER, -- q
* exponent1 INTEGER, -- d mod (p-1)
* exponent2 INTEGER, -- d mod (q-1)
* coefficient INTEGER, -- (inverse of q) mod p
* otherPrimeInfos OtherPrimeInfos OPTIONAL
* }
* ```
*
*/
export declare class RSAPrivateKey {
/**
* @summary `version`.
* @public
* @readonly
*/
readonly version: Version;
/**
* @summary `modulus`.
* @public
* @readonly
*/
readonly modulus: OCTET_STRING;
/**
* @summary `publicExponent`.
* @public
* @readonly
*/
readonly publicExponent: OCTET_STRING;
/**
* @summary `privateExponent`.
* @public
* @readonly
*/
readonly privateExponent: OCTET_STRING;
/**
* @summary `prime1`.
* @public
* @readonly
*/
readonly prime1: OCTET_STRING;
/**
* @summary `prime2`.
* @public
* @readonly
*/
readonly prime2: OCTET_STRING;
/**
* @summary `exponent1`.
* @public
* @readonly
*/
readonly exponent1: OCTET_STRING;
/**
* @summary `exponent2`.
* @public
* @readonly
*/
readonly exponent2: OCTET_STRING;
/**
* @summary `coefficient`.
* @public
* @readonly
*/
readonly coefficient: OCTET_STRING;
/**
* @summary `otherPrimeInfos`.
* @public
* @readonly
*/
readonly otherPrimeInfos?: OPTIONAL<OtherPrimeInfos>;
constructor(
/**
* @summary `version`.
* @public
* @readonly
*/
version: Version,
/**
* @summary `modulus`.
* @public
* @readonly
*/
modulus: OCTET_STRING,
/**
* @summary `publicExponent`.
* @public
* @readonly
*/
publicExponent: OCTET_STRING,
/**
* @summary `privateExponent`.
* @public
* @readonly
*/
privateExponent: OCTET_STRING,
/**
* @summary `prime1`.
* @public
* @readonly
*/
prime1: OCTET_STRING,
/**
* @summary `prime2`.
* @public
* @readonly
*/
prime2: OCTET_STRING,
/**
* @summary `exponent1`.
* @public
* @readonly
*/
exponent1: OCTET_STRING,
/**
* @summary `exponent2`.
* @public
* @readonly
*/
exponent2: OCTET_STRING,
/**
* @summary `coefficient`.
* @public
* @readonly
*/
coefficient: OCTET_STRING,
/**
* @summary `otherPrimeInfos`.
* @public
* @readonly
*/
otherPrimeInfos?: OPTIONAL<OtherPrimeInfos>);
/**
* @summary Restructures an object into a RSAPrivateKey
* @description
*
* This takes an `object` and converts it to a `RSAPrivateKey`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `RSAPrivateKey`.
* @returns {RSAPrivateKey}
*/
static _from_object(_o: {
[_K in keyof RSAPrivateKey]: RSAPrivateKey[_K];
}): RSAPrivateKey;
}
/**
* @summary The Leading Root Component Types of RSAPrivateKey
* @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_RSAPrivateKey: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of RSAPrivateKey
* @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_RSAPrivateKey: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of RSAPrivateKey
* @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_RSAPrivateKey: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) RSAPrivateKey
* @function
* @param {_Element} el The element being decoded.
* @returns {RSAPrivateKey} The decoded data structure.
*/
export declare function _decode_RSAPrivateKey(el: _Element): RSAPrivateKey;
/**
* @summary Encodes a(n) RSAPrivateKey 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 RSAPrivateKey, encoded as an ASN.1 Element.
*/
export declare function _encode_RSAPrivateKey(value: RSAPrivateKey, elGetter: $.ASN1Encoder<RSAPrivateKey>): _Element;
//# sourceMappingURL=RSAPrivateKey.ta.d.mts.map