Class SymmetricKey

Static ReadonlySYMMETRIC_KEY_SIZE

Static ReadonlyUR_TYPE

Staticnew

• new(): SymmetricKey

  Create a new random symmetric key.

  Returns SymmetricKey

StaticfromData

• fromData(data: Uint8Array): SymmetricKey

  Create a new symmetric key from data.

  Parameters

  • data: Uint8Array

  Returns SymmetricKey

StaticfromDataRef

• fromDataRef(data: Uint8Array): SymmetricKey

  Create a new symmetric key from data (validates length).

  Parameters

  • data: Uint8Array

  Returns SymmetricKey

Staticfrom

• from(data: Uint8Array): SymmetricKey

  Create a SymmetricKey from raw bytes (legacy alias).

  Parameters

  • data: Uint8Array

  Returns SymmetricKey

StaticfromHex

• fromHex(hex: string): SymmetricKey

  Create a SymmetricKey from hex string.

  Parameters

  • hex: string

  Returns SymmetricKey

Staticrandom

• random(): SymmetricKey

  Generate a random symmetric key.

  Returns SymmetricKey

StaticrandomUsing

• randomUsing(rng: SecureRandomNumberGenerator): SymmetricKey

  Generate a random symmetric key using provided RNG.

  Parameters

  • rng: SecureRandomNumberGenerator

  Returns SymmetricKey

data

• data(): Uint8Array

  Get the data of the symmetric key.

  Returns Uint8Array

asBytes

• asBytes(): Uint8Array

  Get the data of the symmetric key as a byte slice.

  Returns Uint8Array

toData

• toData(): Uint8Array

  Get a copy of the raw key bytes.

  Returns Uint8Array

hex

• hex(): string

  Get hex string representation.

  Returns string

toHex

• toHex(): string

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

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

equals

• equals(other: SymmetricKey): boolean

  Compare with another SymmetricKey.

  Parameters

  • other: SymmetricKey

  Returns boolean

toString

• toString(): string

  Get string representation.

  Returns string

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

decrypt

• decrypt(message: EncryptedMessage): Uint8Array

  Decrypt the given encrypted message with this key.

  Parameters

  • message: EncryptedMessage

  Returns Uint8Array

cborTags

• cborTags(): Tag[]

  Returns the CBOR tags associated with SymmetricKey.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

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

  Returns Cbor

taggedCbor

• taggedCbor(): Cbor

  Returns the tagged CBOR encoding.

  Returns Cbor

taggedCborData

• taggedCborData(): Uint8Array

  Returns the tagged value in CBOR binary representation.

  Returns Uint8Array

fromUntaggedCbor

• fromUntaggedCbor(cbor: Cbor): SymmetricKey

  Creates a SymmetricKey by decoding it from untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns SymmetricKey

fromTaggedCbor

• fromTaggedCbor(cbor: Cbor): SymmetricKey

  Creates a SymmetricKey by decoding it from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns SymmetricKey

StaticfromTaggedCbor

• fromTaggedCbor(cbor: Cbor): SymmetricKey

  Static method to decode from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns SymmetricKey

StaticfromTaggedCborData

• fromTaggedCborData(data: Uint8Array): SymmetricKey

  Static method to decode from tagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns SymmetricKey

StaticfromUntaggedCborData

• fromUntaggedCborData(data: Uint8Array): SymmetricKey

  Static method to decode from untagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns SymmetricKey

ur

• ur(): UR

  Returns the UR representation of the symmetric key.

  Returns UR

urString

• urString(): string

  Returns the UR string representation of the symmetric key.

  Returns string

StaticfromUR

• fromUR(ur: UR): SymmetricKey

  Creates a SymmetricKey from a UR.

  Parameters

  • ur: UR

  Returns SymmetricKey

StaticfromURString

• fromURString(urString: string): SymmetricKey

  Creates a SymmetricKey from a UR string.

  Parameters

  • urString: string

  Returns SymmetricKey

StaticfromUrString

• fromUrString(urString: string): SymmetricKey

  Alias for fromURString for Rust API compatibility.

  Parameters

  • urString: string

  Returns SymmetricKey