Class EncapsulationPrivateKey

Represents a private key for key encapsulation.

Use this to decapsulate a shared secret from ciphertext.

Implements

ReferenceProvider
CborTaggedEncodable
CborTaggedDecodable<EncapsulationPrivateKey>
UREncodable

Methods

`Static`fromX25519PrivateKey

fromX25519PrivateKey(privateKey: X25519PrivateKey): EncapsulationPrivateKey
Create an EncapsulationPrivateKey from an X25519PrivateKey.
Parameters
- privateKey: X25519PrivateKey
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:111

`Static`fromX25519Data

fromX25519Data(data: Uint8Array): EncapsulationPrivateKey
Create an EncapsulationPrivateKey from raw X25519 private key bytes.
Parameters
- data: Uint8Array
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:118

`Static`fromMlkem

fromMlkem(privateKey: MLKEMPrivateKey): EncapsulationPrivateKey
Create an EncapsulationPrivateKey from an MLKEMPrivateKey.
Parameters
- privateKey: MLKEMPrivateKey
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:126

`Static`fromMlkemData

fromMlkemData(level: MLKEMLevel, data: Uint8Array): EncapsulationPrivateKey
Create an EncapsulationPrivateKey from raw MLKEM private key bytes.
Parameters
- level: MLKEMLevel
- data: Uint8Array
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:134

`Static`new

new(): EncapsulationPrivateKey
Generate a new random X25519 encapsulation private key.

Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:142

`Static`random

random(): EncapsulationPrivateKey
Generate a new random X25519 encapsulation private key.

Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:149

`Static`newUsing

newUsing(rng: RandomNumberGenerator): EncapsulationPrivateKey
Generate a new random X25519 encapsulation private key using provided RNG.
Parameters
- rng: RandomNumberGenerator
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:157

`Static`newMlkem

newMlkem(level?: MLKEMLevel): EncapsulationPrivateKey
Generate a new MLKEM encapsulation private key.
Parameters
- level: MLKEMLevel = MLKEMLevel.MLKEM768
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:165

`Static`newMlkemUsing

newMlkemUsing(
level: MLKEMLevel,
rng: RandomNumberGenerator,
): EncapsulationPrivateKey
Generate a new MLKEM encapsulation private key using provided RNG.
Parameters
- level: MLKEMLevel
- rng: RandomNumberGenerator
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:173

`Static`keypair

keypair(): [EncapsulationPrivateKey, EncapsulationPublicKey]
Generate a new keypair for X25519.

Returns [EncapsulationPrivateKey, EncapsulationPublicKey]
- Defined in components/src/encapsulation/encapsulation-private-key.ts:181

`Static`keypairUsing

keypairUsing(
rng: RandomNumberGenerator,
): [EncapsulationPrivateKey, EncapsulationPublicKey]
Generate a new keypair using the given RNG (X25519).
Parameters
- rng: RandomNumberGenerator
Returns [EncapsulationPrivateKey, EncapsulationPublicKey]
- Defined in components/src/encapsulation/encapsulation-private-key.ts:190

`Static`mlkemKeypair

mlkemKeypair(
level?: MLKEMLevel,
): [EncapsulationPrivateKey, EncapsulationPublicKey]
Generate a new MLKEM keypair.
Parameters
- level: MLKEMLevel = MLKEMLevel.MLKEM768
Returns [EncapsulationPrivateKey, EncapsulationPublicKey]
- Defined in components/src/encapsulation/encapsulation-private-key.ts:201

`Static`mlkemKeypairUsing

mlkemKeypairUsing(
level: MLKEMLevel,
rng: RandomNumberGenerator,
): [EncapsulationPrivateKey, EncapsulationPublicKey]
Generate a new MLKEM keypair using the given RNG.
Parameters
- level: MLKEMLevel
- rng: RandomNumberGenerator
Returns [EncapsulationPrivateKey, EncapsulationPublicKey]
- Defined in components/src/encapsulation/encapsulation-private-key.ts:213

encapsulationScheme

encapsulationScheme(): EncapsulationScheme
Returns the encapsulation scheme.

Returns EncapsulationScheme
- Defined in components/src/encapsulation/encapsulation-private-key.ts:230

isX25519

isX25519(): boolean
Returns true if this is an X25519 private key.

Returns boolean
- Defined in components/src/encapsulation/encapsulation-private-key.ts:237

isMlkem

isMlkem(): boolean
Returns true if this is an MLKEM private key.

Returns boolean
- Defined in components/src/encapsulation/encapsulation-private-key.ts:244

x25519PrivateKey

x25519PrivateKey(): X25519PrivateKey
Returns the X25519 private key if this is an X25519 encapsulation key.

Returns X25519PrivateKey
Throws
Error if this is not an X25519 key
- Defined in components/src/encapsulation/encapsulation-private-key.ts:252

mlkemPrivateKey

mlkemPrivateKey(): MLKEMPrivateKey
Returns the MLKEM private key if this is an MLKEM encapsulation key.

Returns MLKEMPrivateKey
Throws
Error if this is not an MLKEM key
- Defined in components/src/encapsulation/encapsulation-private-key.ts:263

toX25519

toX25519(): X25519PrivateKey | null
Returns the X25519 private key if available, or null.

Returns X25519PrivateKey | null
- Defined in components/src/encapsulation/encapsulation-private-key.ts:273

toMlkem

toMlkem(): MLKEMPrivateKey | null
Returns the MLKEM private key if available, or null.

Returns MLKEMPrivateKey | null
- Defined in components/src/encapsulation/encapsulation-private-key.ts:280

data

data(): Uint8Array
Returns the raw private key data.

Returns Uint8Array
- Defined in components/src/encapsulation/encapsulation-private-key.ts:287

publicKey

publicKey(): EncapsulationPublicKey
Get the public key corresponding to this private key.

Returns EncapsulationPublicKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:303

decapsulateSharedSecret

decapsulateSharedSecret(ciphertext: EncapsulationCiphertext): SymmetricKey
Decapsulate a shared secret from ciphertext.
Parameters
- ciphertext: EncapsulationCiphertext
  The ciphertext from encapsulation
Returns SymmetricKey
The decapsulated shared secret

Throws
CryptoError if the scheme doesn't match
- Defined in components/src/encapsulation/encapsulation-private-key.ts:325

equals

equals(other: EncapsulationPrivateKey): boolean
Compare with another EncapsulationPrivateKey.
Parameters
- other: EncapsulationPrivateKey
Returns boolean
- Defined in components/src/encapsulation/encapsulation-private-key.ts:355

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/encapsulation/encapsulation-private-key.ts:374

reference

reference(): Reference
Returns a unique reference to this EncapsulationPrivateKey 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/encapsulation/encapsulation-private-key.ts:393

cborTags

cborTags(): Tag[]
Returns the CBOR tags associated with this private key.

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/encapsulation/encapsulation-private-key.ts:405

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/encapsulation/encapsulation-private-key.ts:417

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/encapsulation/encapsulation-private-key.ts:433

taggedCborData

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

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/encapsulation/encapsulation-private-key.ts:440

fromUntaggedCbor

fromUntaggedCbor(cborValue: Cbor): EncapsulationPrivateKey
Creates an EncapsulationPrivateKey by decoding it from untagged CBOR. Note: Without tags, we assume X25519 scheme.
Parameters
- cborValue: Cbor
Returns EncapsulationPrivateKey
Implementation of CborTaggedDecodable.fromUntaggedCbor
- Defined in components/src/encapsulation/encapsulation-private-key.ts:452

fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): EncapsulationPrivateKey
Creates an EncapsulationPrivateKey by decoding it from tagged CBOR.
Parameters
- cborValue: Cbor
Returns EncapsulationPrivateKey
Implementation of CborTaggedDecodable.fromTaggedCbor
- Defined in components/src/encapsulation/encapsulation-private-key.ts:461

`Static`fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): EncapsulationPrivateKey
Static method to decode from tagged CBOR.
Parameters
- cborValue: Cbor
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:482

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): EncapsulationPrivateKey
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:492

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): EncapsulationPrivateKey
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:500

ur

ur(): UR
Returns the UR representation.

Returns UR
Implementation of UREncodable.ur
- Defined in components/src/encapsulation/encapsulation-private-key.ts:515

urString

urString(): string
Returns the UR string representation.

Returns string
Implementation of UREncodable.urString
- Defined in components/src/encapsulation/encapsulation-private-key.ts:531

`Static`fromUR

fromUR(ur: UR): EncapsulationPrivateKey
Creates an EncapsulationPrivateKey from a UR.
Parameters
- ur: UR
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:538

`Static`fromURString

fromURString(urString: string): EncapsulationPrivateKey
Creates an EncapsulationPrivateKey from a UR string.
Parameters
- urString: string
Returns EncapsulationPrivateKey
- Defined in components/src/encapsulation/encapsulation-private-key.ts:558