Class PrivateKeys

PrivateKeys - Container for a signing key and an encapsulation key.

This type provides a convenient way to manage a pair of private keys for both signing and encryption operations.

Implements

Signer
Decrypter
ReferenceProvider
CborTaggedEncodable
CborTaggedDecodable<PrivateKeys>
UREncodable

Methods

`Static`withKeys

withKeys(
signingPrivateKey: SigningPrivateKey,
encapsulationPrivateKey: EncapsulationPrivateKey,
): PrivateKeys
Create a new PrivateKeys container with the given keys.
Parameters
- signingPrivateKey: SigningPrivateKey
- encapsulationPrivateKey: EncapsulationPrivateKey
Returns PrivateKeys
- Defined in components/src/private-keys.ts:95

`Static`new

new(): PrivateKeys
Create a new PrivateKeys container with random Ed25519/X25519 keys.

Returns PrivateKeys
- Defined in components/src/private-keys.ts:105

signingPrivateKey

signingPrivateKey(): SigningPrivateKey
Returns the signing private key.

Returns SigningPrivateKey
- Defined in components/src/private-keys.ts:118

encapsulationPrivateKey

encapsulationPrivateKey(): EncapsulationPrivateKey
Returns the encapsulation private key.

Note: Named to match Rust's API (which has a typo but we maintain compatibility)

Returns EncapsulationPrivateKey
Implementation of Decrypter.encapsulationPrivateKey
- Defined in components/src/private-keys.ts:127

publicKeys

publicKeys(): PublicKeys
Derive the corresponding public keys.

Returns PublicKeys
- Defined in components/src/private-keys.ts:134

signWithOptions

signWithOptions(message: Uint8Array, options?: SigningOptions): Signature
Sign a message with optional signing options using the signing private key.
Parameters
- message: Uint8Array
- Optionaloptions: SigningOptions
Returns Signature
Implementation of Signer.signWithOptions
- Defined in components/src/private-keys.ts:147

sign

sign(message: Uint8Array): Signature
Sign a message using the signing private key.
Parameters
- message: Uint8Array
Returns Signature
Implementation of Signer.sign
- Defined in components/src/private-keys.ts:154

decapsulateSharedSecret

decapsulateSharedSecret(ciphertext: EncapsulationCiphertext): SymmetricKey
Decapsulate a shared secret from a ciphertext.

This implements the Decrypter interface, allowing PrivateKeys to be used in encryption contexts where a shared secret needs to be recovered.
Parameters
- ciphertext: EncapsulationCiphertext
Returns SymmetricKey
Implementation of Decrypter.decapsulateSharedSecret
- Defined in components/src/private-keys.ts:168

reference

reference(): Reference
Returns a unique reference to this PrivateKeys instance.

The reference is derived from the SHA-256 hash of the tagged CBOR representation, providing a unique, content-addressable identifier.

Returns Reference
Implementation of ReferenceProvider.reference
- Defined in components/src/private-keys.ts:182

equals

equals(other: PrivateKeys): boolean
Compare with another PrivateKeys.
Parameters
- other: PrivateKeys
Returns boolean
- Defined in components/src/private-keys.ts:194

toString

toString(): string
Get string representation.

Format matches Rust: PrivateKeys(<short_reference>)

Returns string
- Defined in components/src/private-keys.ts:206

cborTags

cborTags(): Tag[]
Returns the CBOR tags associated with PrivateKeys.

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/private-keys.ts:217

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding.

Format: [, ]

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/private-keys.ts:226

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/private-keys.ts:233

taggedCborData

taggedCborData(): Uint8Array
Returns the tagged value in CBOR binary representation.

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/private-keys.ts:240

fromUntaggedCbor

fromUntaggedCbor(cborValue: Cbor): PrivateKeys
Creates a PrivateKeys by decoding it from untagged CBOR.
Parameters
- cborValue: Cbor
Returns PrivateKeys
Implementation of CborTaggedDecodable.fromUntaggedCbor
- Defined in components/src/private-keys.ts:251

fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): PrivateKeys
Creates a PrivateKeys by decoding it from tagged CBOR.
Parameters
- cborValue: Cbor
Returns PrivateKeys
Implementation of CborTaggedDecodable.fromTaggedCbor
- Defined in components/src/private-keys.ts:267

`Static`fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): PrivateKeys
Static method to decode from tagged CBOR.
Parameters
- cborValue: Cbor
Returns PrivateKeys
- Defined in components/src/private-keys.ts:276

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): PrivateKeys
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns PrivateKeys
- Defined in components/src/private-keys.ts:285

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): PrivateKeys
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns PrivateKeys
- Defined in components/src/private-keys.ts:293

ur

ur(): UR
Returns the UR representation.

Returns UR
Implementation of UREncodable.ur
- Defined in components/src/private-keys.ts:306

urString

urString(): string
Returns the UR string representation.

Returns string
Implementation of UREncodable.urString
- Defined in components/src/private-keys.ts:317

`Static`fromUR

fromUR(ur: UR): PrivateKeys
Creates a PrivateKeys from a UR.
Parameters
- ur: UR
Returns PrivateKeys
- Defined in components/src/private-keys.ts:324

`Static`fromURString

fromURString(urString: string): PrivateKeys
Creates a PrivateKeys from a UR string.
Parameters
- urString: string
Returns PrivateKeys
- Defined in components/src/private-keys.ts:335