Class EncryptionKey

Readonlyalgorithm

ReadonlycustomerKey

ReadonlycustomerKeyMd5

Readonlymode

toJSON

• toJSON(): {
      algorithm: "AES256";
      customerKey: string;
      customerKeyMd5: string;
      mode: "SSE-C";
  }

  Hides the key bytes from JSON.stringify.

  Returns {
      algorithm: "AES256";
      customerKey: string;
      customerKeyMd5: string;
      mode: "SSE-C";
  }

  A redacted shape: same mode and algorithm, but the key and MD5 replaced with a placeholder string.

  • algorithm: "AES256"

    Encryption algorithm.

  • customerKey: string

    Always the literal redaction placeholder; the real key never leaves the instance.

  • customerKeyMd5: string

    Always the literal redaction placeholder; the real MD5 never leaves the instance.

  • mode: "SSE-C"

    Encryption mode discriminant.

toString

• toString(): string

  Hides the key bytes from default toString().

  Returns string

  A short opaque label indicating this is an SSE-C key.

StaticfromBase64

• fromBase64(customerKey: string, customerKeyMd5: string): EncryptionKey

  Builds an EncryptionKey from precomputed base64 strings. Use this in environments where MD5 must be computed externally (e.g., browsers).

  Parameters

  • customerKey: string

    Base64-encoded 256-bit encryption key.

  • customerKeyMd5: string

    Base64-encoded MD5 digest of the key.

  Returns EncryptionKey

  A safely-wrapped EncryptionKey ready for upload/download.

StaticfromBytes

• fromBytes(rawKey: Uint8Array): Promise<EncryptionKey>

  Builds an EncryptionKey from a raw 32-byte (256-bit) key. Computes the required base64 MD5 digest internally.

  Parameters

  • rawKey: Uint8Array

    The raw 256-bit key as bytes. Must be exactly 32 bytes.

  Returns Promise<EncryptionKey>

  A safely-wrapped EncryptionKey ready for upload/download.

  Throws

  If the key is not exactly 32 bytes.