Class PrivateKey

Represents a private key with associated public key and cryptographic algorithm. Provides methods for signing messages, exporting to PEM, and generating public keys.

Hierarchy

PrivateKey

Index

Constructors

constructor

new PrivateKey(alg: KeyAlgorithm, pub: PublicKey, priv: PrivateKeyInternal): PrivateKey
Creates an instance of PrivateKey.
Parameters
- alg: KeyAlgorithm
  
  The cryptographic algorithm.
- pub: PublicKey
  
  The associated public key.
- priv: PrivateKeyInternal
  
  The private key implementation.
Returns PrivateKey
- Defined in src/types/keypair/PrivateKey.ts:48

Properties

`Private` alg

alg: KeyAlgorithm

The cryptographic algorithm used for the key.

`Private` priv

priv: PrivateKeyInternal

The internal private key implementation.

`Private` pub

pub: PublicKey

The public key associated with this private key.

Accessors

publicKey

get publicKey(): PublicKey
Gets the public key associated with this private key.

Returns
The associated PublicKey instance.

Returns PublicKey
- Defined in src/types/keypair/PrivateKey.ts:62

Methods

rawSign

rawSign(msg: Uint8Array): Promise<Uint8Array>
Signs a message without including the algorithm byte.

Returns
A promise resolving to the raw signature bytes.
Parameters
- msg: Uint8Array
  
  The message to sign.
Returns Promise<Uint8Array>
- Defined in src/types/keypair/PrivateKey.ts:99

sign

sign(msg: Uint8Array): Uint8Array
Signs a message using the private key.

Returns
A promise resolving to the signature bytes.
Parameters
- msg: Uint8Array
  
  The message to sign.
Returns Uint8Array
- Defined in src/types/keypair/PrivateKey.ts:79

signAndAddAlgorithmBytes

signAndAddAlgorithmBytes(msg: Uint8Array): Uint8Array
Signs a message using the private key and includes the algorithm byte in the signature.

Returns
A promise resolving to the signature bytes with the algorithm byte.
Parameters
- msg: Uint8Array
  
  The message to sign.
Returns Uint8Array
- Defined in src/types/keypair/PrivateKey.ts:88

toBytes

toBytes(): Uint8Array
Returns Uint8Array
- Defined in src/types/keypair/PrivateKey.ts:54

toPem

toPem(): string
Exports the private key to PEM format.

Returns
A PEM-encoded string of the private key.

Returns string
- Defined in src/types/keypair/PrivateKey.ts:70

`Static` fromHex

fromHex(key: string, algorithm: KeyAlgorithm): PrivateKey
Creates a private key from a hexadecimal string.

Returns
A promise resolving to a PrivateKey instance.
Parameters
- key: string
  
  The hexadecimal string of the private key.
- algorithm: KeyAlgorithm
  
  The cryptographic algorithm to use.
Returns PrivateKey
- Defined in src/types/keypair/PrivateKey.ts:142

`Static` fromPem

fromPem(content: string, algorithm: KeyAlgorithm): PrivateKey
Creates a private key from a PEM-encoded string.

Returns
A promise resolving to a PrivateKey instance.
Parameters
- content: string
  
  The PEM-encoded string.
- algorithm: KeyAlgorithm
  
  The cryptographic algorithm to use.
Returns PrivateKey
- Defined in src/types/keypair/PrivateKey.ts:122

`Static` generate

generate(algorithm: KeyAlgorithm): PrivateKey
Generates a new private key with the specified algorithm.

Returns
A promise resolving to a new PrivateKey instance.
Parameters
- algorithm: KeyAlgorithm
  
  The cryptographic algorithm to use.
Returns PrivateKey
- Defined in src/types/keypair/PrivateKey.ts:108

Class PrivateKey

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

alg: KeyAlgorithm

pub: PublicKey

priv: PrivateKeyInternal

Returns PrivateKey

Properties

Private alg

Private priv

Private pub

Accessors

publicKey

Returns

Returns PublicKey

Methods

rawSign

Returns

Parameters

msg: Uint8Array

Returns Promise<Uint8Array>

sign

Returns

Parameters

msg: Uint8Array

Returns Uint8Array

signAndAddAlgorithmBytes

Returns

Parameters

msg: Uint8Array

Returns Uint8Array

toBytes

Returns Uint8Array

toPem

Returns

Returns string

Static fromHex

Returns

Parameters

key: string

algorithm: KeyAlgorithm

Returns PrivateKey

Static fromPem

Returns

Parameters

content: string

algorithm: KeyAlgorithm

Returns PrivateKey

Static generate

Returns

Parameters

algorithm: KeyAlgorithm

Returns PrivateKey

Settings

Member Visibility

Theme

`Private` alg

`Private` priv

`Private` pub

`Static` fromHex

`Static` fromPem

`Static` generate