Type Alias VerifyKey

VerifyKey:
    | { mode: "hmac"; secret: string
    | Uint8Array }
    | { mode: "ed25519"; publicKey: Ed25519Key }

The key that checks an envelope signature: the shared HMAC secret (at least 32 bytes) or the Ed25519 public key (32 bytes, 64-char lowercase hex, PEM or KeyObject).

Type Declaration

{ mode: "hmac"; secret: string | Uint8Array }
- mode: "hmac"
  
  Shared-secret HMAC-SHA256.
- secret: string | Uint8Array
  
  The HMAC secret, at least 32 bytes (a string counts its UTF-8 bytes).
{ mode: "ed25519"; publicKey: Ed25519Key }
- mode: "ed25519"
  
  Ed25519 public-key signatures.
- publicKey: Ed25519Key
  
  The Ed25519 public key: 32 bytes, 64-char lowercase hex, PEM or KeyObject.

Type Alias VerifyKey

Type Declaration

mode: "hmac"

secret: string | Uint8Array

mode: "ed25519"

publicKey: Ed25519Key

Settings