Class EncapsulationPublicKey

Represents a public key for key encapsulation.

Use this to encapsulate a shared secret for a recipient.

Implements

ReferenceProvider
CborTaggedEncodable
CborTaggedDecodable<EncapsulationPublicKey>
UREncodable

Methods

`Static`fromX25519PublicKey

fromX25519PublicKey(publicKey: X25519PublicKey): EncapsulationPublicKey
Create an EncapsulationPublicKey from an X25519PublicKey.
Parameters
- publicKey: X25519PublicKey
Returns EncapsulationPublicKey
- Defined in components/src/encapsulation/encapsulation-public-key.ts:72

`Static`fromX25519Data

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

encapsulationScheme

encapsulationScheme(): EncapsulationScheme
Returns the encapsulation scheme.

Returns EncapsulationScheme
- Defined in components/src/encapsulation/encapsulation-public-key.ts:91

isX25519

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

Returns boolean
- Defined in components/src/encapsulation/encapsulation-public-key.ts:98

x25519PublicKey

x25519PublicKey(): X25519PublicKey
Returns the X25519 public key if this is an X25519 encapsulation key.

Returns X25519PublicKey
Throws
Error if this is not an X25519 key
- Defined in components/src/encapsulation/encapsulation-public-key.ts:106

data

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

Returns Uint8Array
- Defined in components/src/encapsulation/encapsulation-public-key.ts:116

encapsulateNewSharedSecret

encapsulateNewSharedSecret(): [SymmetricKey, EncapsulationCiphertext]
Encapsulate a new shared secret for this public key.

This generates a random shared secret and encapsulates it so that only the holder of the corresponding private key can recover it.

Returns [SymmetricKey, EncapsulationCiphertext]
A tuple of [sharedSecret, ciphertext]
- Defined in components/src/encapsulation/encapsulation-public-key.ts:136

equals

equals(other: EncapsulationPublicKey): boolean
Compare with another EncapsulationPublicKey.
Parameters
- other: EncapsulationPublicKey
Returns boolean
- Defined in components/src/encapsulation/encapsulation-public-key.ts:160

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/encapsulation/encapsulation-public-key.ts:177

reference

reference(): Reference
Returns a unique reference to this EncapsulationPublicKey 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-public-key.ts:196

cborTags

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

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

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding.

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

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

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

taggedCborData

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

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

fromUntaggedCbor

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

fromTaggedCbor

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

`Static`fromTaggedCbor

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

`Static`fromTaggedCborData

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

`Static`fromUntaggedCborData

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

ur

ur(): UR
Returns the UR representation.

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

urString

urString(): string
Returns the UR string representation.

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

`Static`fromUR

fromUR(ur: UR): EncapsulationPublicKey
Creates an EncapsulationPublicKey from a UR.
Parameters
- ur: UR
Returns EncapsulationPublicKey
- Defined in components/src/encapsulation/encapsulation-public-key.ts:334

`Static`fromURString

fromURString(urString: string): EncapsulationPublicKey
Creates an EncapsulationPublicKey from a UR string.
Parameters
- urString: string
Returns EncapsulationPublicKey
- Defined in components/src/encapsulation/encapsulation-public-key.ts:349