Skip to main content

Documentation Index

Fetch the complete documentation index at: https://aivault.moldable.sh/docs/llms.txt

Use this file to discover all available pages before exploring further.

The vault is aivault’s encrypted secret store. It holds all secrets at rest, encrypted with XChaCha20-Poly1305, and manages the key hierarchy that protects them.

​
Key hierarchy

Key Provider (Keychain / passphrase / env / file)
  │
  ▼
KEK (Key Encryption Key)
  │
  ▼
DEK (Data Encryption Key) — per-secret, wrapped by KEK
  │
  ▼
Encrypted secret value (XChaCha20-Poly1305 AEAD)
The KEK is derived from or stored by the key provider. Each secret has its own DEK, which is wrapped (encrypted) by the KEK and stored alongside the ciphertext. Decrypting a secret requires unwrapping the DEK with the KEK, then decrypting the value with the DEK.

​
Key providers

aivault supports four key providers. Choose one when initializing the vault.

​
macOS Keychain (default on macOS)

aivault init --provider macos-keychain
The KEK is stored in the macOS system Keychain under a configurable service/account name. The vault is “unlocked” whenever the Keychain is unlocked (typically when you log in). No passphrase is needed. Customize the Keychain entry: 
aivault init --provider macos-keychain \
  --keychain-service my-app \
  --keychain-account my-account

​
Passphrase

aivault init --provider passphrase --passphrase "your-passphrase"
The KEK is derived from the passphrase using Argon2 (key derivation function). The vault must be explicitly unlocked after each restart: 
aivault unlock --passphrase "your-passphrase"
And can be locked at any time: 
aivault lock

​
Environment variable

aivault init --provider env --env-var AIVAULT_KEY
The KEK is read from the specified environment variable at startup. The variable must contain a base64-encoded 32-byte key.

​
File

aivault init --provider file --file-path /path/to/keyfile
The KEK is read from a file on disk. The file must contain a base64-encoded 32-byte key.

​
Auto-initialization

On first run, aivault status (or any command that needs the vault) auto-initializes with safe defaults:
  • macOS (canonical install): uses macOS Keychain with service aivault (and falls back to the file provider if Keychain is unavailable)
  • Other platforms (canonical install): uses the file provider with a key at ~/.aivault/keys/kek.key (outside the vault directory)
  • When AIVAULT_DIR is set: uses the file provider with a key at $AIVAULT_DIR/kek.key (useful for isolated tests)
Auto-initialization includes a stale init-lock detector (30-second timeout) and Keychain self-healing (recreates a lost Keychain entry if no secrets exist yet).

​
Secret lifecycle

EventWhat happens
CreateSecret value encrypted, DEK wrapped, metadata stored, audit event logged
ReadMetadata returned (value never returned to caller)
RotateNew value encrypted with new DEK, old DEK discarded, audit event logged
DeleteSecret record removed, audit event logged
Attach/detach groupSecret’s group membership updated for isolation

​
Associated data (AAD)

Each encrypted secret includes authenticated associated data (AAD v2+):
  • Secret ID
  • Scope (global / workspace / group)
  • Pinned provider (if registry-matched)
This means a ciphertext for one secret cannot be swapped into another secret’s record — the AEAD authentication will fail.

​
Master key rotation

aivault rotate-master --new-key <base64-key>
# or
aivault rotate-master --new-passphrase "new-passphrase"
This re-wraps every DEK with the new KEK. Secret values themselves are not re-encrypted (the DEKs are unchanged), but the DEK wrappers are updated atomically. Next: Broker