Class RSAPrivateKey

Represents an RSA private key as defined in RFC 8017 (PKCS #1 v2.2).

This class specifically implements the RSAPrivateKey ASN.1 structure from PKCS #1, which differs from the generic PrivateKeyInfo structure defined in PKCS #8.

Use this class when:

Working directly with RSA-specific parameters (modulus, exponents, etc.)
Parsing or creating traditional RSA private key formats
Need access to the Chinese Remainder Theorem (CRT) parameters

For general private key handling (including non-RSA keys), use PrivateKeyInfo instead.

Asn

RSAPrivateKey ::= SEQUENCE {
    version           Version,  -- Integer, always 0 for two-prime, 1 for multi-prime
    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
}

Hierarchy (View Summary)

PkiBase<RSAPrivateKey>
- RSAPrivateKey

Index

Constructors

constructor

new RSAPrivateKey(
    options: {
        coefficient: Uint8Array;
        exponent1: Uint8Array;
        exponent2: Uint8Array;
        modulus: Uint8Array;
        prime1: Uint8Array;
        prime2: Uint8Array;
        privateExponent: Uint8Array;
        publicExponent: Uint8Array;
        version?: number;
    },
): RSAPrivateKey
Creates a new RSAPrivateKey instance.
Parameters
- options: {
      coefficient: Uint8Array;
      exponent1: Uint8Array;
      exponent2: Uint8Array;
      modulus: Uint8Array;
      prime1: Uint8Array;
      prime2: Uint8Array;
      privateExponent: Uint8Array;
      publicExponent: Uint8Array;
      version?: number;
  }
Returns RSAPrivateKey
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:71

Properties

coefficient

coefficient: Uint8Array

The CRT coefficient ((inverse of q) mod p)

exponent1

exponent1: Uint8Array

The first exponent (d mod (p-1))

exponent2

exponent2: Uint8Array

The second exponent (d mod (q-1))

modulus

modulus: Uint8Array

The modulus (n)

prime1

prime1: Uint8Array

The first prime factor (p)

prime2

prime2: Uint8Array

The second prime factor (q)

privateExponent

privateExponent: Uint8Array

The private exponent (d)

publicExponent

publicExponent: Uint8Array

The exponent (e)

version

version: number

The version (always 0 for two-prime RSA)

Accessors

pemHeader

get pemHeader(): string
Gets the PEM header name for this object type. Converts the class name to uppercase for use in PEM encoding.

Returns string
Overrides PkiBase.pemHeader
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:107

pkiType

get pkiType(): string
Gets the PKI type name for this object (typically the class name). Used for PEM headers and debugging output.

Returns string
Inherited from PkiBase.pkiType
- Defined in packages/pki-lite/src/core/PkiBase.ts:52

Methods

equals

equals(other: PkiBase<any>): boolean
Compares this PKI object with another for equality. Two objects are considered equal if their DER encodings are identical.
Parameters
- other: PkiBase<any>
  The other PKI object to compare with
Returns boolean
true if the objects are equal, false otherwise
Inherited from PkiBase.equals
- Defined in packages/pki-lite/src/core/PkiBase.ts:122

parseAs

parseAs<T>(type: ParseableAsn1<T>): T
Parses this object as a different PKI type. Useful for converting between related PKI structures.
Type Parameters
- T
  The target type to parse as
Parameters
- type: ParseableAsn1<T>
  The target type constructor with parsing capabilities
Returns T
A new instance of the target type
Inherited from PkiBase.parseAs
- Defined in packages/pki-lite/src/core/PkiBase.ts:134

toAsn1

toAsn1(): Asn1BaseBlock
Converts the RSA private key to an ASN.1 structure.

Returns Asn1BaseBlock
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:114

toDer

toDer(): Uint8Array
Converts the RSA private key to DER format.

Returns Uint8Array
Overrides PkiBase.toDer
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:133

toHumanString

toHumanString(): string
Returns a human-readable string representation of this object. By default, returns the same as toString(), but subclasses can override for more user-friendly output.

Returns string
A human-readable string representation
Inherited from PkiBase.toHumanString
- Defined in packages/pki-lite/src/core/PkiBase.ts:90

toJSON

toJSON(): ToJson<T>
Converts this object to a JSON representation.

Returns ToJson<T>
A JSON-serializable representation of this object
Inherited from PkiBase.toJSON
- Defined in packages/pki-lite/src/core/PkiBase.ts:69

toPem

toPem(): string
Converts this PKI object to PEM (Privacy-Enhanced Mail) format.

Returns string
A PEM-encoded string with appropriate headers
Inherited from PkiBase.toPem
- Defined in packages/pki-lite/src/core/PkiBase.ts:109

toPublicKey

toPublicKey(): any
Extracts the RSA key component from this private key.

Returns any
A new RSAPublicKey containing the parts of this key
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:143

toString

toString(): string
Returns a string representation of this PKI object. Includes the type name and ASN.1 structure.

Returns string
A string representation for debugging
Inherited from PkiBase.toString
- Defined in packages/pki-lite/src/core/PkiBase.ts:79

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): RSAPrivateKey
Parses an ASN.1 structure to create an RSAPrivateKey.
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 structure
Returns RSAPrivateKey
A new RSAPrivateKey instance
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:158

`Static`fromDer

fromDer(der: Uint8Array): RSAPrivateKey
Parses DER encoded data to create an RSAPrivateKey.
Parameters
- der: Uint8Array
  The DER encoded data
Returns RSAPrivateKey
A new RSAPrivateKey instance
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:217

`Static`fromPem

fromPem(pem: string): RSAPrivateKey
Parses PEM encoded data to create an RSAPrivateKey.
Parameters
- pem: string
  The PEM encoded data
Returns RSAPrivateKey
A new RSAPrivateKey instance
- Defined in packages/pki-lite/src/keys/RSAPrivateKey.ts:228

Class RSAPrivateKey

Asn

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RSAPrivateKey

Properties

coefficient

exponent1

exponent2

modulus

prime1

prime2

privateExponent

publicExponent

version

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toDer

Returns Uint8Array

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toPublicKey

Returns any

toString

Returns string

StaticfromAsn1

Parameters

Returns RSAPrivateKey

StaticfromDer

Parameters

Returns RSAPrivateKey

StaticfromPem

Parameters

Returns RSAPrivateKey

Settings

On This Page

`Static`fromAsn1

`Static`fromDer

`Static`fromPem