Class EncryptedMessage

Implements

CborTaggedEncodable
CborTaggedDecodable<EncryptedMessage>
UREncodable

Methods

`Static`new

new(
    ciphertext: Uint8Array,
    aad: Uint8Array,
    nonce: Nonce,
    auth: Uint8Array<ArrayBufferLike> | AuthenticationTag,
): EncryptedMessage
Restores an EncryptedMessage from its components.
Parameters
- ciphertext: Uint8Array
- aad: Uint8Array
- nonce: Nonce
- auth: Uint8Array<ArrayBufferLike> | AuthenticationTag
Returns EncryptedMessage
- Defined in components/src/symmetric/encrypted-message.ts:91

`Static`from

from(
    nonce: Nonce,
    ciphertext: Uint8Array,
    tag: AuthenticationTag,
    aad?: Uint8Array<ArrayBufferLike>,
): EncryptedMessage
Create an EncryptedMessage from components (legacy alias).
Parameters
- nonce: Nonce
- ciphertext: Uint8Array
- tag: AuthenticationTag
- Optionalaad: Uint8Array<ArrayBufferLike>
Returns EncryptedMessage
- Defined in components/src/symmetric/encrypted-message.ts:104

ciphertext

ciphertext(): Uint8Array
Returns a reference to the ciphertext data.

Returns Uint8Array
- Defined in components/src/symmetric/encrypted-message.ts:120

aad

aad(): Uint8Array
Returns a reference to the additional authenticated data (AAD).

Returns Uint8Array
- Defined in components/src/symmetric/encrypted-message.ts:127

nonce

nonce(): Nonce
Returns a reference to the nonce value used for encryption.

Returns Nonce
- Defined in components/src/symmetric/encrypted-message.ts:134

authenticationTag

authenticationTag(): AuthenticationTag
Returns a reference to the authentication tag value used for encryption.

Returns AuthenticationTag
- Defined in components/src/symmetric/encrypted-message.ts:141

aadCbor

aadCbor(): Cbor | null
Returns a CBOR representation in the AAD field, if it exists.

Returns Cbor | null
- Defined in components/src/symmetric/encrypted-message.ts:148

aadDigest

aadDigest(): Digest | null
Returns a Digest instance if the AAD data can be parsed as CBOR.

Returns Digest | null
- Defined in components/src/symmetric/encrypted-message.ts:162

hasDigest

hasDigest(): boolean
Returns true if the AAD data can be parsed as a Digest.

Returns boolean
- Defined in components/src/symmetric/encrypted-message.ts:177

equals

equals(other: EncryptedMessage): boolean
Compare with another EncryptedMessage.
Parameters
- other: EncryptedMessage
Returns boolean
- Defined in components/src/symmetric/encrypted-message.ts:184

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/symmetric/encrypted-message.ts:199

cborTags

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

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/symmetric/encrypted-message.ts:210

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding (as an array). Array format: [ciphertext, nonce, auth, ?aad]

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/symmetric/encrypted-message.ts:218

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/symmetric/encrypted-message.ts:235

taggedCborData

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

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/symmetric/encrypted-message.ts:242

fromUntaggedCbor

fromUntaggedCbor(cborValue: Cbor): EncryptedMessage
Creates an EncryptedMessage by decoding it from untagged CBOR.
Parameters
- cborValue: Cbor
Returns EncryptedMessage
Implementation of CborTaggedDecodable.fromUntaggedCbor
- Defined in components/src/symmetric/encrypted-message.ts:253

fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): EncryptedMessage
Creates an EncryptedMessage by decoding it from tagged CBOR.
Parameters
- cborValue: Cbor
Returns EncryptedMessage
Implementation of CborTaggedDecodable.fromTaggedCbor
- Defined in components/src/symmetric/encrypted-message.ts:273

`Static`fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): EncryptedMessage
Static method to decode from tagged CBOR.
Parameters
- cborValue: Cbor
Returns EncryptedMessage
- Defined in components/src/symmetric/encrypted-message.ts:282

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): EncryptedMessage
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns EncryptedMessage
- Defined in components/src/symmetric/encrypted-message.ts:296

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): EncryptedMessage
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns EncryptedMessage
- Defined in components/src/symmetric/encrypted-message.ts:304

ur

ur(): UR
Returns the UR representation of the EncryptedMessage. Note: URs use untagged CBOR since the type is conveyed by the UR type itself.

Returns UR
Implementation of UREncodable.ur
- Defined in components/src/symmetric/encrypted-message.ts:323

urString

urString(): string
Returns the UR string representation.

Returns string
Implementation of UREncodable.urString
- Defined in components/src/symmetric/encrypted-message.ts:330

`Static`fromUR

fromUR(ur: UR): EncryptedMessage
Creates an EncryptedMessage from a UR.
Parameters
- ur: UR
Returns EncryptedMessage
- Defined in components/src/symmetric/encrypted-message.ts:337

`Static`fromURString

fromURString(urString: string): EncryptedMessage
Creates an EncryptedMessage from a UR string.
Parameters
- urString: string
Returns EncryptedMessage
- Defined in components/src/symmetric/encrypted-message.ts:351