Class EncapsulationCiphertext

Represents the ciphertext from a key encapsulation operation.

For X25519, this wraps an ephemeral public key.

Implements

CborTaggedEncodable
CborTaggedDecodable<EncapsulationCiphertext>

Index

Methods

fromX25519PublicKey encapsulationScheme isX25519 x25519PublicKey data equals toString cborTags untaggedCbor taggedCbor taggedCborData fromUntaggedCbor fromTaggedCbor fromTaggedCbor fromTaggedCborData fromUntaggedCborData

Methods

`Static`fromX25519PublicKey

fromX25519PublicKey(publicKey: X25519PublicKey): EncapsulationCiphertext
Create an EncapsulationCiphertext from an X25519PublicKey.
Parameters
- publicKey: X25519PublicKey
Returns EncapsulationCiphertext
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:56

encapsulationScheme

encapsulationScheme(): EncapsulationScheme
Returns the encapsulation scheme.

Returns EncapsulationScheme
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:67

isX25519

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

Returns boolean
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:74

x25519PublicKey

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

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

data

data(): Uint8Array
Returns the raw ciphertext data.

Returns Uint8Array
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:92

equals

equals(other: EncapsulationCiphertext): boolean
Compare with another EncapsulationCiphertext.
Parameters
- other: EncapsulationCiphertext
Returns boolean
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:107

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:124

cborTags

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

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:140

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:152

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:167

taggedCborData

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

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:174

fromUntaggedCbor

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

fromTaggedCbor

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

`Static`fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): EncapsulationCiphertext
Static method to decode from tagged CBOR.
Parameters
- cborValue: Cbor
Returns EncapsulationCiphertext
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:211

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): EncapsulationCiphertext
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns EncapsulationCiphertext
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:221

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): EncapsulationCiphertext
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns EncapsulationCiphertext
- Defined in components/src/encapsulation/encapsulation-ciphertext.ts:229