Chunk objects, shard the store, and make filler configurable

File bodies are now cut into 4 MiB objects, the last padded to its
power-of-two bucket, so every object is 64 KiB to 4 MiB whatever the file
size. Object IDs are HMAC'd from a secret per-record seed, so nothing on
disk links a file's pieces, and each object still leads with its own ID,
binding it to its record and position. Chunks are encrypted and synced by
a small worker pool so their fsyncs overlap.

records/ and objects/ are sharded into 256 subdirectories by ID prefix,
all created at init, with every shard's mtime pinned to the epoch.

vault init --filler SIZE writes at least SIZE of filler. Filler entries
are now real entries for a throwaway key, of log-uniform random sizes, so
they carry multi-chunk files like a real collection.

The marker becomes VAULT 2; earlier vaults are not supported.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Andy Dixon
2026-09-26 18:20:51 +01:00
co-authored by Claude Opus 5.5
parent 8f3a755bf9
commit eea16c9076
17 changed files with 556 additions and 175 deletions
+258 -118
View File
@@ -5,18 +5,23 @@ package main
import (
"bytes"
"crypto/hmac"
"crypto/rand"
"crypto/sha256"
"encoding/binary"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"io"
"math"
mrand "math/rand/v2"
"os"
"path"
"path/filepath"
"sort"
"strings"
"sync"
"time"
"unicode"
"unicode/utf8"
@@ -26,31 +31,40 @@ import (
// On disk a vault is:
//
// DIR/.vault marker
// DIR/records/<id> one encrypted catalogue record per file
// DIR/objects/<id> one encrypted file body per record
// DIR/.vault marker
// DIR/records/<xx>/<id> one encrypted catalogue record per file
// DIR/objects/<xx>/<id> the encrypted body of a file, in one or more chunks
//
// IDs are random. Records are padded to one fixed size and objects to
// power-of-two buckets, so the storage reveals neither names, exact sizes nor
// timestamps. Every ciphertext's mtime is pinned to the epoch.
// <xx> is the first two hex digits of <id>, spreading entries over 256
// shards. IDs look random: record IDs are, and a file's object IDs derive
// from a secret seed in its record, so nothing on disk links a file's
// chunks. Records are padded to one fixed size. A body is cut into
// chunkSize objects and the last is padded to a power-of-two bucket, so
// every object is 64 KiB to 4 MiB whatever the file size. Every ciphertext's
// and shard's mtime is pinned to the epoch.
const (
markerName = ".vault"
markerContent = "VAULT 1\n"
recordsDir = "records"
objectsDir = "objects"
recordSize = 4096
nameLimit = 1024
fileLimit = int64(1) << 40
minPadding = int64(64 << 10)
idSize = 16
fillerMin = 8
fillerMax = 32
markerName = ".vault"
markerContent = "VAULT 2\n"
recordsDir = "records"
objectsDir = "objects"
recordSize = 4096
nameLimit = 1024
fileLimit = int64(1) << 40
minPadding = int64(64 << 10)
chunkSize = minPadding << 6 // 4 MiB, the largest bucket
chunkData = chunkSize - idSize
idSize = 16
objectSeedSize = 32
fillerMin = 8
fillerMax = 32
)
var epoch = time.Unix(0, 0)
type record struct {
Name string `json:"name"`
Object string `json:"object"`
Seed string `json:"seed"` // derives the file's object IDs
Size int64 `json:"size"`
Mode uint32 `json:"mode"`
Modified time.Time `json:"modified"`
@@ -65,57 +79,68 @@ type store struct {
noSync bool // filler needs no per-file durability
}
func initStore(root string) error {
// initStore creates a vault at root holding at least filler bytes of filler.
func initStore(root string, filler int64) error {
if _, err := os.Stat(filepath.Join(root, markerName)); err == nil {
return fmt.Errorf("%s is already a vault", root)
}
for _, dir := range []string{root, filepath.Join(root, recordsDir), filepath.Join(root, objectsDir)} {
if err := os.MkdirAll(dir, 0o700); err != nil {
return err
// Every shard exists from the start, so the tree's shape says nothing.
for _, dir := range []string{recordsDir, objectsDir} {
for i := range 256 {
if err := os.MkdirAll(filepath.Join(root, dir, fmt.Sprintf("%02x", i)), 0o700); err != nil {
return err
}
}
}
if err := writeFiller(root); err != nil {
if err := writeFiller(root, filler); err != nil {
return err
}
for _, dir := range []string{recordsDir, objectsDir} {
shards, _ := filepath.Glob(filepath.Join(root, dir, "??"))
for _, p := range append(shards, filepath.Join(root, dir)) {
if err := os.Chtimes(p, epoch, epoch); err != nil {
return err
}
}
}
return os.WriteFile(filepath.Join(root, markerName), []byte(markerContent), 0o600)
}
// writeFiller stores a random number of record/object pairs sealed to a key
// that is thrown away. Every vault therefore holds entries nobody can open,
// so a file hidden from a decoy passphrase is indistinguishable from filler.
func writeFiller(root string) error {
// writeFiller stores random entries sealed to a key that is thrown away.
// Every vault therefore holds entries nobody can open, so a file hidden from
// a decoy passphrase is indistinguishable from filler. Filler entries are
// real entries, written by the same code as add, of log-uniformly random
// sizes: fillerMin to fillerMax of them, or more until they total target
// bytes.
func writeFiller(root string, target int64) error {
throwaway, err := pqcrypt.GeneratePQIdentity()
if err != nil {
return err
}
defer throwaway.Close()
s := &store{root: root, id: throwaway, noSync: true}
var b [2]byte
if _, err := rand.Read(b[:1]); err != nil {
return err
}
for range fillerMin + int(b[0])%(fillerMax-fillerMin+1) {
if _, err := rand.Read(b[:]); err != nil {
// Bigger targets allow bigger files, so the filler holds multi-chunk
// files in about the proportion a real collection would.
upper := float64(min(max(target/8, chunkSize), 1<<30))
count := fillerMin + mrand.IntN(fillerMax-fillerMin+1)
for i, total := 0, int64(0); i < count || total < target; i++ {
size := int64(1024 * math.Exp(mrand.Float64()*math.Log(upper/1024)))
seed, err := randomHex(objectSeedSize)
if err != nil {
return err
}
// Object buckets from 64 KiB to 4 MiB, weighted towards small ones.
objSize := minPadding << (min(b[0]%8, b[1]%8) % 7)
for _, part := range []struct {
dir string
size int64
}{{recordsDir, recordSize}, {objectsDir, objSize}} {
id, err := randomID()
if err != nil {
return err
}
err = s.writeCiphertext(part.dir, id, func(w io.Writer) error {
_, err := io.CopyN(w, rand.Reader, part.size)
return err
})
if err != nil {
return err
}
if err := s.writeObjects(rand.Reader, seed, size); err != nil {
return err
}
name, err := randomHex(8)
if err != nil {
return err
}
now := time.Now().UTC()
if err := s.writeRecord(&record{Name: name, Seed: seed, Size: size, Mode: 0o600, Modified: now, Added: now}); err != nil {
return err
}
total += size
}
return nil
}
@@ -128,17 +153,47 @@ func openStore(root string, id *pqcrypt.PQIdentity) (*store, error) {
return &store{root: root, id: id}, nil
}
func randomID() (string, error) {
b := make([]byte, idSize)
func randomHex(n int) (string, error) {
b := make([]byte, n)
if _, err := rand.Read(b); err != nil {
return "", err
}
return hex.EncodeToString(b), nil
}
func validID(s string) bool {
func validHex(s string, n int) bool {
b, err := hex.DecodeString(s)
return err == nil && len(b) == idSize && hex.EncodeToString(b) == s
return err == nil && len(b) == n && hex.EncodeToString(b) == s
}
func validID(s string) bool { return validHex(s, idSize) }
// objectID derives the ID of a file's i-th object from its record's seed.
// Without the seed the IDs are unlinkable, so a file's chunks can't be told
// apart from any other object.
func objectID(seed string, i int64) string {
key, _ := hex.DecodeString(seed)
m := hmac.New(sha256.New, key)
binary.Write(m, binary.BigEndian, i)
return hex.EncodeToString(m.Sum(nil)[:idSize])
}
// objectCount is how many objects hold a file of size bytes.
func objectCount(size int64) int64 {
return max(1, (size+chunkData-1)/chunkData)
}
func (s *store) path(dir, id string) string {
return filepath.Join(s.root, dir, id[:2], id)
}
// removeFile deletes dir/id and re-pins its shard's mtime.
func (s *store) removeFile(dir, id string) error {
p := s.path(dir, id)
if err := os.Remove(p); err != nil {
return err
}
return os.Chtimes(filepath.Dir(p), epoch, epoch)
}
func validName(name string) bool {
@@ -166,7 +221,8 @@ func paddedSize(size int64) int64 {
// writeCiphertext encrypts to dir/id via a temporary file, so a partial
// ciphertext never appears under a real ID.
func (s *store) writeCiphertext(dir, id string, write func(io.Writer) error) error {
dir = filepath.Join(s.root, dir)
dst := s.path(dir, id)
dir = filepath.Dir(dst)
tmp, err := os.CreateTemp(dir, ".pending-")
if err != nil {
return err
@@ -191,11 +247,13 @@ func (s *store) writeCiphertext(dir, id string, write func(io.Writer) error) err
if err := tmp.Close(); err != nil {
return err
}
epoch := time.Unix(0, 0)
if err := os.Chtimes(tmp.Name(), epoch, epoch); err != nil {
return err
}
if err := os.Rename(tmp.Name(), filepath.Join(dir, id)); err != nil || s.noSync {
if err := os.Rename(tmp.Name(), dst); err != nil {
return err
}
if err := os.Chtimes(dir, epoch, epoch); err != nil || s.noSync {
return err
}
return syncDir(dir)
@@ -224,7 +282,7 @@ func (s *store) writeRecord(r *record) error {
if _, err := rand.Read(plain[4+len(data):]); err != nil {
return err
}
if r.id, err = randomID(); err != nil {
if r.id, err = randomHex(idSize); err != nil {
return err
}
return s.writeCiphertext(recordsDir, r.id, func(w io.Writer) error {
@@ -236,25 +294,34 @@ func (s *store) writeRecord(r *record) error {
// catalogue decrypts every record this identity can open. Records sealed to
// a different key are skipped silently: they are simply not ours.
func (s *store) catalogue() (map[string][]*record, error) {
entries, err := os.ReadDir(filepath.Join(s.root, recordsDir))
shards, err := os.ReadDir(filepath.Join(s.root, recordsDir))
if err != nil {
return nil, err
}
byName := map[string][]*record{}
for _, e := range entries {
if !validID(e.Name()) {
continue
}
r, err := s.readRecord(e.Name())
var noMatch *pqcrypt.NoIdentityMatchError
if errors.As(err, &noMatch) {
for _, shard := range shards {
if !shard.IsDir() {
continue
}
entries, err := os.ReadDir(filepath.Join(s.root, recordsDir, shard.Name()))
if err != nil {
fmt.Fprintf(os.Stderr, "vault: skipping unreadable record %s: %v\n", e.Name(), err)
continue
return nil, err
}
for _, e := range entries {
if !validID(e.Name()) || e.Name()[:2] != shard.Name() {
continue
}
r, err := s.readRecord(e.Name())
var noMatch *pqcrypt.NoIdentityMatchError
if errors.As(err, &noMatch) {
continue
}
if err != nil {
fmt.Fprintf(os.Stderr, "vault: skipping unreadable record %s: %v\n", e.Name(), err)
continue
}
byName[r.Name] = append(byName[r.Name], r)
}
byName[r.Name] = append(byName[r.Name], r)
}
// Newest first, so [0] is current. Duplicates only exist after an
// interrupted replace; the next write of that name cleans them up.
@@ -265,7 +332,7 @@ func (s *store) catalogue() (map[string][]*record, error) {
}
func (s *store) readRecord(id string) (*record, error) {
f, err := os.Open(filepath.Join(s.root, recordsDir, id))
f, err := os.Open(s.path(recordsDir, id))
if err != nil {
return nil, err
}
@@ -291,7 +358,7 @@ func (s *store) readRecord(id string) (*record, error) {
if err := dec.Decode(r); err != nil {
return nil, err
}
if !validName(r.Name) || !validID(r.Object) || r.Size < 0 || r.Size > fileLimit {
if !validName(r.Name) || !validHex(r.Seed, objectSeedSize) || r.Size < 0 || r.Size > fileLimit {
return nil, errors.New("malformed record")
}
return r, nil
@@ -315,36 +382,23 @@ func (s *store) add(cat map[string][]*record, src, name string) (bool, error) {
if !info.Mode().IsRegular() || info.Size() > fileLimit {
return false, fmt.Errorf("%s: not a regular file of at most 1 TiB", src)
}
objID, err := randomID()
seed, err := randomHex(objectSeedSize)
if err != nil {
return false, err
}
err = s.writeCiphertext(objectsDir, objID, func(w io.Writer) error {
// The object ID leads the plaintext so a record can only ever
// open the object it names, not one swapped in under its ID.
raw, _ := hex.DecodeString(objID)
if _, err := w.Write(raw); err != nil {
return err
if err := s.writeObjects(f, seed, info.Size()); err != nil {
s.dropObjects(seed, info.Size())
if errors.Is(err, io.ErrUnexpectedEOF) || errors.Is(err, io.EOF) {
err = fmt.Errorf("%s changed while being added", src)
}
n, err := io.Copy(w, io.LimitReader(f, info.Size()))
if err != nil {
return err
}
if n != info.Size() {
return fmt.Errorf("%s changed while being added", src)
}
_, err = io.CopyN(w, rand.Reader, paddedSize(idSize+n)-idSize-n)
return err
})
if err != nil {
return false, err
}
r := &record{
Name: name, Object: objID, Size: info.Size(), Mode: uint32(info.Mode().Perm()),
Name: name, Seed: seed, Size: info.Size(), Mode: uint32(info.Mode().Perm()),
Modified: info.ModTime().UTC(), Added: time.Now().UTC(),
}
if err := s.writeRecord(r); err != nil {
os.Remove(filepath.Join(s.root, objectsDir, objID))
s.dropObjects(seed, info.Size())
return false, err
}
replaced := len(cat[name]) > 0
@@ -355,6 +409,67 @@ func (s *store) add(cat map[string][]*record, src, name string) (bool, error) {
return replaced, nil
}
// writeObjects reads size bytes from f into the objects derived from seed.
// Chunks are read in order but encrypted, written and synced by a few
// workers at once, so their fsyncs overlap instead of queueing.
func (s *store) writeObjects(f io.Reader, seed string, size int64) error {
var (
wg sync.WaitGroup
mu sync.Mutex
firstErr error
)
fail := func(err error) {
mu.Lock()
defer mu.Unlock()
if firstErr == nil {
firstErr = err
}
}
failed := func() bool {
mu.Lock()
defer mu.Unlock()
return firstErr != nil
}
slots := make(chan struct{}, 8) // at most 8 chunks, 32 MiB, in memory
remaining := size
for i := range objectCount(size) {
if failed() {
break
}
// The object ID leads the plaintext so a record can only ever
// open the objects it derives, each in its place, not one
// swapped in under its ID.
id := objectID(seed, i)
part := min(remaining, chunkData)
remaining -= part
slots <- struct{}{}
buf := make([]byte, idSize+part)
hex.Decode(buf, []byte(id))
if _, err := io.ReadFull(f, buf[idSize:]); err != nil {
<-slots
fail(err)
break
}
wg.Add(1)
go func() {
defer wg.Done()
defer func() { <-slots }()
err := s.writeCiphertext(objectsDir, id, func(w io.Writer) error {
if _, err := w.Write(buf); err != nil {
return err
}
_, err := io.CopyN(w, rand.Reader, paddedSize(int64(len(buf)))-int64(len(buf)))
return err
})
if err != nil {
fail(err)
}
}()
}
wg.Wait()
return firstErr
}
// remove deletes every record for name and, when dropObjects is set, any of
// their objects no other record still uses. Records go first, so an
// interruption only ever leaves an orphaned object.
@@ -363,16 +478,16 @@ func (s *store) remove(cat map[string][]*record, name string, dropObjects bool)
for n, rs := range cat {
for _, r := range rs {
if n != name {
inUse[r.Object] = true
inUse[r.Seed] = true
}
}
}
for _, r := range cat[name] {
if err := os.Remove(filepath.Join(s.root, recordsDir, r.id)); err != nil {
if err := s.removeFile(recordsDir, r.id); err != nil {
return err
}
if dropObjects && !inUse[r.Object] {
if err := os.Remove(filepath.Join(s.root, objectsDir, r.Object)); err != nil && !os.IsNotExist(err) {
if dropObjects && !inUse[r.Seed] {
if err := s.dropObjects(r.Seed, r.Size); err != nil {
return err
}
}
@@ -380,6 +495,17 @@ func (s *store) remove(cat map[string][]*record, name string, dropObjects bool)
return nil
}
// dropObjects deletes the objects holding a file of size bytes, skipping any
// already gone.
func (s *store) dropObjects(seed string, size int64) error {
for i := range objectCount(size) {
if err := s.removeFile(objectsDir, objectID(seed, i)); err != nil && !os.IsNotExist(err) {
return err
}
}
return nil
}
func (s *store) lookup(name string) (map[string][]*record, *record, error) {
cat, err := s.catalogue()
if err != nil {
@@ -419,7 +545,7 @@ func (s *store) rename(oldName, newName string) error {
return s.remove(cat, oldName, false)
}
// get decrypts name to out. Nothing appears at out until the entire object,
// get decrypts name to out. Nothing appears at out until every object,
// padding included, has authenticated.
func (s *store) get(name, out string) error {
_, r, err := s.lookup(name)
@@ -429,34 +555,19 @@ func (s *store) get(name, out string) error {
if _, err := os.Lstat(out); err == nil {
return fmt.Errorf("%s already exists", out)
}
f, err := os.Open(filepath.Join(s.root, objectsDir, r.Object))
if err != nil {
return err
}
defer f.Close()
pr, err := pqcrypt.Decrypt(f, s.id)
if err != nil {
return err
}
head := make([]byte, idSize)
if _, err := io.ReadFull(pr, head); err != nil || hex.EncodeToString(head) != r.Object {
return errors.New("object does not match its catalogue record")
}
tmp, err := os.CreateTemp(filepath.Dir(out), ".vault-get-")
if err != nil {
return err
}
defer os.Remove(tmp.Name())
defer tmp.Close()
if _, err := io.CopyN(tmp, pr, r.Size); err != nil {
return err
}
pad, err := io.Copy(io.Discard, pr)
if err != nil {
return err
}
if idSize+r.Size+pad != paddedSize(idSize+r.Size) {
return errors.New("object size does not match its catalogue record")
remaining := r.Size
for i := range objectCount(r.Size) {
part := min(remaining, chunkData)
if err := s.readObject(tmp, objectID(r.Seed, i), part); err != nil {
return err
}
remaining -= part
}
if err := tmp.Chmod(os.FileMode(r.Mode) & 0o777); err != nil {
return err
@@ -472,3 +583,32 @@ func (s *store) get(name, out string) error {
}
return os.Rename(tmp.Name(), out)
}
// readObject decrypts object id to w, checking it leads with its own ID and
// holds part bytes padded to their bucket.
func (s *store) readObject(w io.Writer, id string, part int64) error {
f, err := os.Open(s.path(objectsDir, id))
if err != nil {
return err
}
defer f.Close()
pr, err := pqcrypt.Decrypt(f, s.id)
if err != nil {
return err
}
head := make([]byte, idSize)
if _, err := io.ReadFull(pr, head); err != nil || hex.EncodeToString(head) != id {
return errors.New("object does not match its catalogue record")
}
if _, err := io.CopyN(w, pr, part); err != nil {
return err
}
pad, err := io.Copy(io.Discard, pr)
if err != nil {
return err
}
if idSize+part+pad != paddedSize(idSize+part) {
return errors.New("object size does not match its catalogue record")
}
return nil
}