Class SymmetricKey

Implements

CborTaggedEncodable
CborTaggedDecodable<SymmetricKey>

Properties

`Static` `Readonly`SYMMETRIC_KEY_SIZE

SYMMETRIC_KEY_SIZE: 32 = SYMMETRIC_KEY_SIZE

`Static` `Readonly`UR_TYPE

UR_TYPE: "crypto-key"

Get the UR type for symmetric keys.

Methods

`Static`new

new(): SymmetricKey
Create a new random symmetric key.

Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:68

`Static`fromData

fromData(data: Uint8Array): SymmetricKey
Create a new symmetric key from data.
Parameters
- data: Uint8Array
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:75

`Static`fromDataRef

fromDataRef(data: Uint8Array): SymmetricKey
Create a new symmetric key from data (validates length).
Parameters
- data: Uint8Array
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:82

`Static`from

from(data: Uint8Array): SymmetricKey
Create a SymmetricKey from raw bytes (legacy alias).
Parameters
- data: Uint8Array
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:92

`Static`fromHex

fromHex(hex: string): SymmetricKey
Create a SymmetricKey from hex string.
Parameters
- hex: string
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:99

`Static`random

random(): SymmetricKey
Generate a random symmetric key.

Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:106

`Static`randomUsing

randomUsing(rng: SecureRandomNumberGenerator): SymmetricKey
Generate a random symmetric key using provided RNG.
Parameters
- rng: SecureRandomNumberGenerator
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:114

data

data(): Uint8Array
Get the data of the symmetric key.

Returns Uint8Array
- Defined in components/src/symmetric/symmetric-key.ts:125

asBytes

asBytes(): Uint8Array
Get the data of the symmetric key as a byte slice.

Returns Uint8Array
- Defined in components/src/symmetric/symmetric-key.ts:132

toData

toData(): Uint8Array
Get a copy of the raw key bytes.

Returns Uint8Array
- Defined in components/src/symmetric/symmetric-key.ts:139

hex

hex(): string
Get hex string representation.

Returns string
- Defined in components/src/symmetric/symmetric-key.ts:146

toHex

toHex(): string
Get hex string representation (alias for hex()).

Returns string
- Defined in components/src/symmetric/symmetric-key.ts:153

toBase64

toBase64(): string
Get base64 representation.

Returns string
- Defined in components/src/symmetric/symmetric-key.ts:160

equals

equals(other: SymmetricKey): boolean
Compare with another SymmetricKey.
Parameters
- other: SymmetricKey
Returns boolean
- Defined in components/src/symmetric/symmetric-key.ts:167

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/symmetric/symmetric-key.ts:178

encrypt

encrypt(
    plaintext: Uint8Array,
    aad?: Uint8Array<ArrayBufferLike>,
    nonce?: Nonce,
): EncryptedMessage
Encrypt the given plaintext with this key, and the given additional authenticated data and nonce.
Parameters
- plaintext: Uint8Array
- Optionalaad: Uint8Array<ArrayBufferLike>
- Optionalnonce: Nonce
Returns EncryptedMessage
- Defined in components/src/symmetric/symmetric-key.ts:190

decrypt

decrypt(message: EncryptedMessage): Uint8Array
Decrypt the given encrypted message with this key.
Parameters
- message: EncryptedMessage
Returns Uint8Array
- Defined in components/src/symmetric/symmetric-key.ts:207

cborTags

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

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/symmetric/symmetric-key.ts:224

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding (as a byte string).

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/symmetric/symmetric-key.ts:231

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/symmetric/symmetric-key.ts:238

taggedCborData

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

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/symmetric/symmetric-key.ts:245

fromUntaggedCbor

fromUntaggedCbor(cbor: Cbor): SymmetricKey
Creates a SymmetricKey by decoding it from untagged CBOR.
Parameters
- cbor: Cbor
Returns SymmetricKey
Implementation of CborTaggedDecodable.fromUntaggedCbor
- Defined in components/src/symmetric/symmetric-key.ts:256

fromTaggedCbor

fromTaggedCbor(cbor: Cbor): SymmetricKey
Creates a SymmetricKey by decoding it from tagged CBOR.
Parameters
- cbor: Cbor
Returns SymmetricKey
Implementation of CborTaggedDecodable.fromTaggedCbor
- Defined in components/src/symmetric/symmetric-key.ts:264

`Static`fromTaggedCbor

fromTaggedCbor(cbor: Cbor): SymmetricKey
Static method to decode from tagged CBOR.
Parameters
- cbor: Cbor
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:273

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): SymmetricKey
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:281

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): SymmetricKey
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:289

ur

ur(): UR
Returns the UR representation of the symmetric key.

Returns UR
- Defined in components/src/symmetric/symmetric-key.ts:307

urString

urString(): string
Returns the UR string representation of the symmetric key.

Returns string
- Defined in components/src/symmetric/symmetric-key.ts:314

`Static`fromUR

fromUR(ur: UR): SymmetricKey
Creates a SymmetricKey from a UR.
Parameters
- ur: UR
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:321

`Static`fromURString

fromURString(urString: string): SymmetricKey
Creates a SymmetricKey from a UR string.
Parameters
- urString: string
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:329

`Static`fromUrString

fromUrString(urString: string): SymmetricKey
Alias for fromURString for Rust API compatibility.
Parameters
- urString: string
Returns SymmetricKey
- Defined in components/src/symmetric/symmetric-key.ts:337