Class PublicKeys

PublicKeys - Container for a signing public key and an encapsulation public key.

This type provides a convenient way to share public keys for both signature verification and encryption operations.

Implements

Verifier
Encrypter
ReferenceProvider
CborTaggedEncodable
CborTaggedDecodable<PublicKeys>
UREncodable

Methods

`Static`new

new(
signingPublicKey: SigningPublicKey,
encapsulationPublicKey: EncapsulationPublicKey,
): PublicKeys
Create a new PublicKeys container with the given keys.
Parameters
- signingPublicKey: SigningPublicKey
- encapsulationPublicKey: EncapsulationPublicKey
Returns PublicKeys
- Defined in components/src/public-keys.ts:95

signingPublicKey

signingPublicKey(): SigningPublicKey
Returns the signing public key.

Returns SigningPublicKey
- Defined in components/src/public-keys.ts:109

encapsulationPublicKey

encapsulationPublicKey(): EncapsulationPublicKey
Returns the encapsulation public key.

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

Returns EncapsulationPublicKey
Implementation of Encrypter.encapsulationPublicKey
- Defined in components/src/public-keys.ts:118

verify

verify(signature: Signature, message: Uint8Array): boolean
Verify a signature against a message.
Parameters
- signature: Signature
- message: Uint8Array
Returns boolean
Implementation of Verifier.verify
- Defined in components/src/public-keys.ts:129

encapsulateNewSharedSecret

encapsulateNewSharedSecret(): [SymmetricKey, EncapsulationCiphertext]
Encapsulate a new shared secret using the encapsulation public key.

This implements the Encrypter interface, allowing PublicKeys to be used in encryption contexts where a shared secret needs to be generated.

Returns [SymmetricKey, EncapsulationCiphertext]
A tuple of [SymmetricKey, EncapsulationCiphertext]
Implementation of Encrypter.encapsulateNewSharedSecret
- Defined in components/src/public-keys.ts:145

reference

reference(): Reference
Returns a unique reference to this PublicKeys 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/public-keys.ts:159

equals

equals(other: PublicKeys): boolean
Compare with another PublicKeys.
Parameters
- other: PublicKeys
Returns boolean
- Defined in components/src/public-keys.ts:171

toString

toString(): string
Get string representation.

Format matches Rust: PublicKeys(<short_reference>)

Returns string
- Defined in components/src/public-keys.ts:183

cborTags

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

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

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding.

Format: [, ]

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

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

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

taggedCborData

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

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

fromUntaggedCbor

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

fromTaggedCbor

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

`Static`fromTaggedCbor

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

`Static`fromTaggedCborData

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

`Static`fromUntaggedCborData

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

ur

ur(): UR
Returns the UR representation.

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

urString

urString(): string
Returns the UR string representation.

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

`Static`fromUR

fromUR(ur: UR): PublicKeys
Creates a PublicKeys from a UR.
Parameters
- ur: UR
Returns PublicKeys
- Defined in components/src/public-keys.ts:323

`Static`fromURString

fromURString(urString: string): PublicKeys
Creates a PublicKeys from a UR string.
Parameters
- urString: string
Returns PublicKeys
- Defined in components/src/public-keys.ts:345

Class PublicKeys

Implements

Index

Methods

Methods

Staticnew

Parameters

Returns PublicKeys

signingPublicKey

Returns SigningPublicKey

encapsulationPublicKey

Returns EncapsulationPublicKey

verify

Parameters

Returns boolean

encapsulateNewSharedSecret

Returns [SymmetricKey, EncapsulationCiphertext]

reference

Returns Reference

equals

Parameters

Returns boolean

toString

Returns string

cborTags

Returns Tag[]

untaggedCbor

Returns Cbor

taggedCbor

Returns Cbor

taggedCborData

Returns Uint8Array

fromUntaggedCbor

Parameters

Returns PublicKeys

fromTaggedCbor

Parameters

Returns PublicKeys

StaticfromTaggedCbor

Parameters

Returns PublicKeys

StaticfromTaggedCborData

Parameters

Returns PublicKeys

StaticfromUntaggedCborData

Parameters

Returns PublicKeys

ur

Returns UR

urString

Returns string

StaticfromUR

Parameters

Returns PublicKeys

StaticfromURString

Parameters

Returns PublicKeys

Settings

On This Page

`Static`new

`Static`fromTaggedCbor

`Static`fromTaggedCborData

`Static`fromUntaggedCborData

`Static`fromUR

`Static`fromURString