Static ReadonlySYMMETRIC_KEY_SIZE

bytes

• get bytes(): Uint8Array

  A copy of the bytes; mutating it does not touch this value.

  Returns Uint8Array

Staticcodec

• get codec(): ComponentCodec<SymmetricKey>

  Tagged-CBOR codec; decode also accepts the untagged form.

  Returns ComponentCodec<SymmetricKey>

Staticrandom

• random(__namedParameters?: RngOptions): SymmetricKey

  A fresh random value; pass rng to make it deterministic.

  Parameters

  • __namedParameters: RngOptions = {}

  Returns SymmetricKey

Staticfrom

• from(data: Uint8Array): SymmetricKey

  Create a new symmetric key from data.

  Parameters

  • data: Uint8Array

  Returns SymmetricKey

StaticfromHex

• fromHex(hex: string): SymmetricKey

  Create a SymmetricKey from hex string.

  Parameters

  • hex: string

  Returns SymmetricKey

toHex

• toHex(): string

  Get hex string representation.

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

equals

• equals(other: SymmetricKey): boolean

  Compare with another SymmetricKey.

  Parameters

  • other: SymmetricKey

  Returns boolean

reference

• reference(): Reference

  The reference: the digest of the tagged CBOR, as the reference computes it.

  Returns Reference

refHexShort

• refHexShort(): string

  The first four bytes of reference() in hex, the reference's ref_hex_short.

  Returns string

toString

• toString(): string

  The reference's Display: the type name over the short reference.

  Returns string

encrypt

• encrypt(
      plaintext: Uint8Array,
      __namedParameters?: { aad?: Uint8Array<ArrayBufferLike>; nonce?: Nonce },
  ): EncryptedMessage

  Encrypt the given plaintext with this key, and the given additional authenticated data and nonce.

  Parameters

  • plaintext: Uint8Array
  • __namedParameters: { aad?: Uint8Array<ArrayBufferLike>; nonce?: Nonce } = {}

  Returns EncryptedMessage

decrypt

• decrypt(message: EncryptedMessage): Uint8Array

  Decrypt the given encrypted message with this key.

  Parameters

  • message: EncryptedMessage

  Returns Uint8Array

cborTags

• cborTags(): Tag[]

  The CBOR tags this type decodes from; the first one is used to encode.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

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

  Returns Cbor

toCbor

• toCbor(): Cbor

  The tagged CBOR form.

  Returns Cbor

toUR

• toUR(): UR

  As a UR, typed by the first tag's name.

  Returns UR

StaticfromCbor

• fromCbor(cbor: Cbor): SymmetricKey

  Decode tagged or untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns SymmetricKey