Andy DixonandClaude Opus 5.5
0d45ecea59
rm -r FOLDER deletes a folder and everything under it, records and objects, so the space is freed. It lists what will go (the first 20 names, then a count) with the total size and asks on the terminal; no answer or no terminal deletes nothing. -f skips the question and makes a missing name a no-op, -rf and -fr combine them, and rm -r / is refused. Objects still in use are worked out once per delete, not once per file. ls now shows one level, like ls(1): sub-folders once with a trailing slash, their total size and newest date, then the files, with names relative to the folder. list keeps the recursive listing of full names that scripts pipe through cut -c31-, and ls -r is the same. Docs, man pages, the guide (new rm-r screenshot) and README follow. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
3.0 KiB
3.0 KiB
CLAUDE.md
This file provides guidance to Claude Code when working with this repository.
Overview
vault is a post-quantum encrypted file vault: one package main at the repo
root that builds a single vault binary. Module github.com/andydixon/vault.
main.go- CLI:genkey,init,add(file, directory or URL),migrate(add, then delete originals),mirror,absorb(tar on stdin,absorb.go),ls(one folder level),list(recursive),get,mv,rm(-rfor a folder, asks unless-f).keyfile.go- key file with two passphrase slots (Argon2id + XChaCha20-Poly1305 sealing a suite ID and 32-byte master seed). The second slot is either a decoy identity or random bytes; slot order is random.store.go- on-disk vault:records/holds fixed-size encrypted catalogue records,objects/holds file bodies cut into 4 MiB chunks (last one bucket-padded) whose IDs are HMAC'd from a per-record seed. Both are sharded into 256xx/subdirectories by ID prefix. Records a key cannot open are skipped, not treated as errors.lock*.go- vault lock onDIR/.lock: fcntl on unix, LockFileEx on Windows, an exclusive lock file elsewhere. Writers lock exclusively, readers shared, taken after the passphrase prompt.docs/guide- LaTeX user guide (build-pdf.shvia Tectonic;shots.pyre-shoots screenshots from the real binary). Keep it in step with the CLI.build.sh- cross-compiles everygo tool dist listtarget except iOS and android/386, amd64, arm (cgo-only).internal/pqcrypt- file encryption (header + STREAM ChaCha20-Poly1305), suite registry, hybrid FrodoKEM-640 + ML-KEM-768 default suite.internal/format,internal/stream,internal/term- header encoding, chunked payload encryption, terminal passphrase prompts.
Commands
go test ./...
go build .
./build.sh # all platforms, into ./dist
TARGETS="linux/amd64" ./build.sh # a subset
End-to-end check:
export VAULT_PASSPHRASE=test VAULT_KEY=$PWD/k VAULT_DIR=$PWD/s
./vault genkey && ./vault init && ./vault add README.md docs && ./vault list
Invariants
- Never write a seed or private key unencrypted.
- Keep suite IDs, stanza tags, HKDF info strings and
fileKeySize(32) stable. - Every ciphertext's and shard directory's mtime is pinned to the epoch; records stay one fixed size; objects stay at most 4 MiB and bucket-padded. These hide metadata from the storage host.
- An object's plaintext starts with its own ID, binding it to its record and its position in the file.
getpublishes output only after every object has authenticated.- Decoy deniability: both key slots stay the same size and are both always
tried;
initalways writes filler; foreign records are skipped silently. - Every command that changes the vault holds the exclusive lock.
- Keep dependencies pure Go and CGO_ENABLED=0 builds working.
- Diagnostics go to standard error, lower-case, no trailing full stops.