Compare commits
1
Commits
next
..
1658fa10ac
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1658fa10ac |
@@ -20,21 +20,33 @@ jobs:
|
|||||||
# check.yml runs script/cibuild, which does all of its work inside
|
# check.yml runs script/cibuild, which does all of its work inside
|
||||||
# the digest-pinned Dockerfile images -- so without this step the
|
# the digest-pinned Dockerfile images -- so without this step the
|
||||||
# release either fails at the before-hook or, worse, ships binaries
|
# release either fails at the before-hook or, worse, ships binaries
|
||||||
# built by whatever Go the runner happens to carry.
|
# built by whatever unpinned Go the runner happens to carry.
|
||||||
|
# REPO_POLICIES.md requires every external reference to be pinned,
|
||||||
|
# and script/release already refuses a goreleaser that is not the
|
||||||
|
# pinned build; the compiler that actually produces the artifacts
|
||||||
|
# is the last thing that should be exempt from that.
|
||||||
#
|
#
|
||||||
# actions/setup-go would pin the action by commit sha, but the Go
|
# go-version-file rather than a literal: go.mod's `go 1.26.1` is
|
||||||
# tarball it downloads at runtime is verified against no value in
|
# the single source of truth for the toolchain, the same way the
|
||||||
# this repo, and the action exposes no checksum input.
|
# Dockerfile FROM line is the single source of truth for the
|
||||||
# REPO_POLICIES.md requires every external reference to be pinned
|
# linter version that script/lint enforces. It is a three-component
|
||||||
# by hash with no exceptions, and this is the compiler that
|
# version, so setup-go resolves it exactly -- no silent drift onto
|
||||||
# produces the published binaries -- the input where a substituted
|
# a newer patch release.
|
||||||
# artifact matters most. So Go is installed the way goreleaser is:
|
#
|
||||||
# script/install-go downloads the exact archive for go.mod's `go`
|
# actions/setup-go v5.6.0, 2025-12-15. Pinned by commit sha, like
|
||||||
# directive and refuses it unless its sha256 matches the value
|
# the checkout above. v5.x is a node20 action, matching the node20
|
||||||
# committed in the script, then puts .tool/go/bin on PATH for the
|
# actions/checkout v4 already in use here; the v6/v7 line requires
|
||||||
# steps below.
|
# a node24 runner, which this Gitea runner has never been asked
|
||||||
|
# for and cannot be assumed to provide.
|
||||||
- name: Install Go
|
- name: Install Go
|
||||||
run: script/install-go
|
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff
|
||||||
|
with:
|
||||||
|
go-version-file: go.mod
|
||||||
|
# setup-go's module cache needs a runner-side cache backend.
|
||||||
|
# A release is cut rarely and a cold module download costs
|
||||||
|
# seconds; a release failing because a cache service is absent
|
||||||
|
# costs a re-tag. Off, deliberately.
|
||||||
|
cache: false
|
||||||
- name: Install goreleaser
|
- name: Install goreleaser
|
||||||
run: script/install-goreleaser
|
run: script/install-goreleaser
|
||||||
- name: Release
|
- name: Release
|
||||||
@@ -46,8 +58,3 @@ jobs:
|
|||||||
# It is deliberately not the runner's automatic token, which is
|
# It is deliberately not the runner's automatic token, which is
|
||||||
# not guaranteed to carry that scope.
|
# not guaranteed to carry that scope.
|
||||||
GITEA_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
GITEA_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
||||||
# Build with the toolchain install-go just verified, never a
|
|
||||||
# different one auto-downloaded from a `toolchain` directive:
|
|
||||||
# the point of the hash pin is that this exact compiler makes
|
|
||||||
# the release.
|
|
||||||
GOTOOLCHAIN: local
|
|
||||||
|
|||||||
@@ -104,12 +104,7 @@ Version: 2025-06-08
|
|||||||
|
|
||||||
13. Pre-1.0: NEVER write database migrations. There are no live databases
|
13. Pre-1.0: NEVER write database migrations. There are no live databases
|
||||||
anywhere — every user's local index can be rebuilt from a fresh full
|
anywhere — every user's local index can be rebuilt from a fresh full
|
||||||
backup. To change the schema, edit `internal/database/schema/001.sql`
|
backup. When the schema changes, just change `schema.sql` (and any code
|
||||||
(and any code that touches the affected tables) directly; do not add new
|
that touches the affected tables). The local index is disposable until
|
||||||
numbered schema files. Those numbered files and the `schema_migrations`
|
1.0 ships and is tagged.
|
||||||
table they populate only bootstrap a fresh database — they are not an
|
|
||||||
upgrade path. The local index is disposable until 1.0 ships and is
|
|
||||||
tagged; once 1.0 is tagged that clause expires and the question of
|
|
||||||
upgrading existing indexes returns. See [`docs/DATAMODEL.md`](docs/DATAMODEL.md)
|
|
||||||
for the full explanation.
|
|
||||||
|
|
||||||
|
|||||||
+6
-11
@@ -63,7 +63,7 @@ A content-addressed unit of data. Files are split into variable-size chunks usin
|
|||||||
- `ChunkHash`: SHA256 hash of chunk content (primary key)
|
- `ChunkHash`: SHA256 hash of chunk content (primary key)
|
||||||
- `Size`: Chunk size in bytes
|
- `Size`: Chunk size in bytes
|
||||||
|
|
||||||
Chunk sizes vary between `avgChunkSize/4` and `avgChunkSize*4` (2.5MB-40MB for the 10MB default average).
|
Chunk sizes vary between `avgChunkSize/4` and `avgChunkSize*4` (typically 16KB-256KB for 64KB average).
|
||||||
|
|
||||||
#### FileChunk (`database.FileChunk`)
|
#### FileChunk (`database.FileChunk`)
|
||||||
Maps files to their constituent chunks:
|
Maps files to their constituent chunks:
|
||||||
@@ -120,7 +120,7 @@ The CLI uses fx for dependency injection. Here's the instantiation order:
|
|||||||
```go
|
```go
|
||||||
// cli/app.go: NewApp()
|
// cli/app.go: NewApp()
|
||||||
fx.New(
|
fx.New(
|
||||||
fx.Supply(config.Path(opts.ConfigPath)), // 1. Config path
|
fx.Supply(config.ConfigPath(opts.ConfigPath)), // 1. Config path
|
||||||
fx.Supply(opts.LogOptions), // 2. Log options
|
fx.Supply(opts.LogOptions), // 2. Log options
|
||||||
fx.Provide(globals.New), // 3. Globals
|
fx.Provide(globals.New), // 3. Globals
|
||||||
fx.Provide(log.New), // 4. Logger config
|
fx.Provide(log.New), // 4. Logger config
|
||||||
@@ -193,7 +193,7 @@ scanner := v.ScannerFactory(snapshot.ScannerParams{
|
|||||||
- **Created by**: `chunker.NewChunker(avgChunkSize)`
|
- **Created by**: `chunker.NewChunker(avgChunkSize)`
|
||||||
- **When**: Inside `snapshot.NewScanner()`
|
- **When**: Inside `snapshot.NewScanner()`
|
||||||
- **Configuration**:
|
- **Configuration**:
|
||||||
- `avgChunkSize`: From config (default 10MB)
|
- `avgChunkSize`: From config (typically 64KB)
|
||||||
- `minChunkSize`: avgChunkSize / 4
|
- `minChunkSize`: avgChunkSize / 4
|
||||||
- `maxChunkSize`: avgChunkSize * 4
|
- `maxChunkSize`: avgChunkSize * 4
|
||||||
|
|
||||||
@@ -286,6 +286,7 @@ Key methods:
|
|||||||
- `CreateSnapshot(ctx, hostname, version, commit)` → Create snapshot record
|
- `CreateSnapshot(ctx, hostname, version, commit)` → Create snapshot record
|
||||||
- `CompleteSnapshot(ctx, snapshotID)` → Mark snapshot complete
|
- `CompleteSnapshot(ctx, snapshotID)` → Mark snapshot complete
|
||||||
- `ExportSnapshotMetadata(ctx, dbPath, snapshotID)` → Export to S3
|
- `ExportSnapshotMetadata(ctx, dbPath, snapshotID)` → Export to S3
|
||||||
|
- `CleanupIncompleteSnapshots(ctx, hostname)` → Remove failed snapshots
|
||||||
|
|
||||||
### `internal/database`
|
### `internal/database`
|
||||||
SQLite database for local index. Single-writer mode for thread safety.
|
SQLite database for local index. Single-writer mode for thread safety.
|
||||||
@@ -306,7 +307,7 @@ Repository interfaces:
|
|||||||
```
|
```
|
||||||
CreateSnapshot(opts)
|
CreateSnapshot(opts)
|
||||||
│
|
│
|
||||||
├─► PruneDatabase() // Critical: avoid dedup errors
|
├─► CleanupIncompleteSnapshots() // Critical: avoid dedup errors
|
||||||
│
|
│
|
||||||
├─► SnapshotManager.CreateSnapshot() // Create DB record
|
├─► SnapshotManager.CreateSnapshot() // Create DB record
|
||||||
│
|
│
|
||||||
@@ -365,17 +366,11 @@ bucket/
|
|||||||
│ └── {full-hash} # Compressed+encrypted blob
|
│ └── {full-hash} # Compressed+encrypted blob
|
||||||
│
|
│
|
||||||
└── metadata/
|
└── metadata/
|
||||||
└── {remote-key}/
|
└── {snapshot-id}/
|
||||||
├── db.zst.age # Encrypted binary SQLite database
|
├── db.zst.age # Encrypted binary SQLite database
|
||||||
└── manifest.json.zst # Blob list (for pruning/verification)
|
└── manifest.json.zst # Blob list (for pruning/verification)
|
||||||
```
|
```
|
||||||
|
|
||||||
The `{remote-key}` directory name is a one-way double SHA-256 hash of the human
|
|
||||||
snapshot ID, so the human ID (hostname, snapshot name, timestamp) is never
|
|
||||||
written to the store as a directory name. See
|
|
||||||
[docs/REPOSTRUCTURE.md](docs/REPOSTRUCTURE.md#remote-key-derivation) for the
|
|
||||||
derivation and a worked example.
|
|
||||||
|
|
||||||
## Thread Safety
|
## Thread Safety
|
||||||
|
|
||||||
- `Packer`: Thread-safe via mutex. Multiple goroutines can call `AddChunk()`.
|
- `Packer`: Thread-safe via mutex. Multiple goroutines can call `AddChunk()`.
|
||||||
|
|||||||
+6
-29
@@ -20,10 +20,10 @@
|
|||||||
# golang:1.26.1-alpine, 2026-03-17
|
# golang:1.26.1-alpine, 2026-03-17
|
||||||
FROM golang:1.26.1-alpine@sha256:2389ebfa5b7f43eeafbd6be0c3700cc46690ef842ad962f6c5bd6be49ed82039 AS builder
|
FROM golang:1.26.1-alpine@sha256:2389ebfa5b7f43eeafbd6be0c3700cc46690ef842ad962f6c5bd6be49ed82039 AS builder
|
||||||
|
|
||||||
# Build tooling: make, plus a C toolchain because `go test -race` needs cgo.
|
ARG VERSION=dev
|
||||||
# The sqlite driver is pure Go (modernc.org/sqlite), so no sqlite library or
|
|
||||||
# CLI is required.
|
# Install build dependencies for CGO (mattn/go-sqlite3) and sqlite3 CLI (tests)
|
||||||
RUN apk add --no-cache make build-base
|
RUN apk add --no-cache make build-base sqlite
|
||||||
|
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
|
|
||||||
@@ -64,37 +64,14 @@ RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
|||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && make fmt-check
|
RUN echo "check epoch: ${CHECK_EPOCH}" && make fmt-check
|
||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && make test
|
RUN echo "check epoch: ${CHECK_EPOCH}" && make test
|
||||||
|
|
||||||
# Version, commit and build date are computed on the host by
|
|
||||||
# script/docker and script/cibuild (where .git exists) and passed in as
|
|
||||||
# build args. The build context excludes .git (see .dockerignore), so
|
|
||||||
# the build cannot derive them itself: it used to try, with `git
|
|
||||||
# rev-parse` inside this stage, and always got "unknown". VERSION comes
|
|
||||||
# from script/version, the source of truth shared with the Makefile, so
|
|
||||||
# it carries the same tag / dev-<sha> / -dirty rules and a Docker image
|
|
||||||
# reports the same string a local build of the same tree would.
|
|
||||||
#
|
|
||||||
# The defaults are the fallback for a bare `docker build .` that passes
|
|
||||||
# none of them: an unset arg would otherwise stamp an empty string and
|
|
||||||
# produce an image that cannot report its own version, commit or date.
|
|
||||||
# They match what an out-of-git build reports elsewhere.
|
|
||||||
#
|
|
||||||
# These ARGs sit here, after the checks, rather than at the top of the
|
|
||||||
# stage: every commit changes their values, and a value change
|
|
||||||
# invalidates all layers below the ARG. Declared up top they would bust
|
|
||||||
# `go mod download`; here they only rekey this build layer, which the
|
|
||||||
# COPY of the sources above already rebuilds on any change anyway.
|
|
||||||
ARG VERSION=dev
|
|
||||||
ARG COMMIT=unknown
|
|
||||||
ARG COMMIT_DATE=unknown
|
|
||||||
|
|
||||||
# Build (pure Go, no CGO required since we use modernc.org/sqlite)
|
# Build (pure Go, no CGO required since we use modernc.org/sqlite)
|
||||||
RUN CGO_ENABLED=0 go build -ldflags "-X 'sneak.berlin/go/vaultik/internal/globals.Version=${VERSION}' -X 'sneak.berlin/go/vaultik/internal/globals.Commit=${COMMIT}' -X 'sneak.berlin/go/vaultik/internal/globals.CommitDate=${COMMIT_DATE}'" -o /vaultik ./cmd/vaultik
|
RUN CGO_ENABLED=0 go build -ldflags "-X 'sneak.berlin/go/vaultik/internal/globals.Version=${VERSION}' -X 'sneak.berlin/go/vaultik/internal/globals.Commit=$(git rev-parse HEAD 2>/dev/null || echo unknown)' -X 'sneak.berlin/go/vaultik/internal/globals.CommitDate=$(git show -s --format=%cs HEAD 2>/dev/null || echo unknown)'" -o /vaultik ./cmd/vaultik
|
||||||
|
|
||||||
# Runtime stage
|
# Runtime stage
|
||||||
# alpine:3.21, 2026-02-25
|
# alpine:3.21, 2026-02-25
|
||||||
FROM alpine:3.21@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
FROM alpine:3.21@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
||||||
|
|
||||||
RUN apk add --no-cache ca-certificates
|
RUN apk add --no-cache ca-certificates sqlite
|
||||||
|
|
||||||
# Copy binary from builder
|
# Copy binary from builder
|
||||||
COPY --from=builder /vaultik /usr/local/bin/vaultik
|
COPY --from=builder /vaultik /usr/local/bin/vaultik
|
||||||
|
|||||||
@@ -71,77 +71,19 @@ Requirements that no existing tool meets:
|
|||||||
## daily use
|
## daily use
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# verify a snapshot (shallow: checks all blobs are present with the listed size)
|
# verify a snapshot (shallow: checks all blobs exist)
|
||||||
vaultik snapshot verify <snapshot-id>
|
vaultik snapshot verify <snapshot-id>
|
||||||
|
|
||||||
# put the private key file in the environment (reading it from the file
|
|
||||||
# keeps the key out of your shell history); the whole age-keygen file,
|
|
||||||
# with one or more identities, is accepted
|
|
||||||
export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"
|
|
||||||
|
|
||||||
# deep verify (downloads and cryptographically verifies every blob)
|
# deep verify (downloads and cryptographically verifies every blob)
|
||||||
vaultik snapshot verify --deep <snapshot-id>
|
VAULTIK_AGE_SECRET_KEY='AGE-SECRET-KEY-...' vaultik snapshot verify --deep <snapshot-id>
|
||||||
|
|
||||||
# restore (requires the private key)
|
# restore (requires the private key)
|
||||||
vaultik snapshot restore <snapshot-id> /tmp/restored
|
VAULTIK_AGE_SECRET_KEY='AGE-SECRET-KEY-...' vaultik snapshot restore <snapshot-id> /tmp/restored
|
||||||
|
|
||||||
# daily cron job: back up, keep a 4-week rolling window of snapshots
|
# daily cron job: back up, keep a 4-week rolling window of snapshots
|
||||||
# 0 3 * * * vaultik snapshot create --cron --prune --keep-newer-than 4w
|
# 0 3 * * * vaultik snapshot create --cron --prune --keep-newer-than 4w
|
||||||
```
|
```
|
||||||
|
|
||||||
## restoring on another machine
|
|
||||||
|
|
||||||
Restoring on a host that never ran the backup — a replacement machine
|
|
||||||
after the original is gone — is the case vaultik is built for. That host
|
|
||||||
needs only three things: the `vaultik` binary, the age **private** key,
|
|
||||||
and the storage credentials for the destination. It does **not** need the
|
|
||||||
local index, the original config file, or the original hostname.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# install
|
|
||||||
go install sneak.berlin/go/vaultik/cmd/vaultik@latest
|
|
||||||
|
|
||||||
# create a config and point it at the ORIGINAL backup destination
|
|
||||||
vaultik config init
|
|
||||||
vaultik config set storage_url "s3://bucket/prefix?endpoint=https://s3.example.com"
|
|
||||||
vaultik config set s3.access_key_id "..."
|
|
||||||
vaultik config set s3.secret_access_key "..."
|
|
||||||
|
|
||||||
# see what is on the destination store
|
|
||||||
vaultik snapshot list
|
|
||||||
```
|
|
||||||
|
|
||||||
`snapshot list` reads the destination store without the private key. A
|
|
||||||
snapshot that is not in this host's (empty) local index is shown as
|
|
||||||
remote-only: its row is identified by `<remote only:...>` rather than by
|
|
||||||
a `hostname_name_timestamp` name, because the name lives only in the
|
|
||||||
local index and the encrypted database and cannot be recovered from the
|
|
||||||
store. Its timestamp and compressed size are real. (See the `snapshot
|
|
||||||
list` description under [command details](#command-details) for the full
|
|
||||||
explanation.)
|
|
||||||
|
|
||||||
Use that remote key — the hex printed inside `<remote only:...>`, or the
|
|
||||||
full `remote_key` from `snapshot list --json` — to restore and verify:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# put the private key file in the environment (reading it from the file
|
|
||||||
# keeps the key out of your shell history)
|
|
||||||
export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"
|
|
||||||
|
|
||||||
# restore everything to /tmp/restored, then check every restored file's
|
|
||||||
# chunk hashes
|
|
||||||
vaultik snapshot restore --verify <remote-key> /tmp/restored
|
|
||||||
|
|
||||||
# optionally, deep-verify the snapshot against the store (downloads and
|
|
||||||
# cryptographically checks every blob)
|
|
||||||
vaultik snapshot verify --deep <remote-key>
|
|
||||||
```
|
|
||||||
|
|
||||||
`age_recipients` (the public key) is not needed to restore — only the
|
|
||||||
private key in `VAULTIK_AGE_SECRET_KEY`. Both the abbreviated key printed
|
|
||||||
in the table and the full 64-character key from `--json` are accepted; a
|
|
||||||
leading part of the key is enough as long as it is unambiguous.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## cli
|
## cli
|
||||||
@@ -154,10 +96,10 @@ vaultik [--config <path>] config edit
|
|||||||
vaultik [--config <path>] config get <key>
|
vaultik [--config <path>] config get <key>
|
||||||
vaultik [--config <path>] config set <key> <value>
|
vaultik [--config <path>] config set <key> <value>
|
||||||
vaultik [--config <path>] snapshot create [snapshot-names...] [--cron] [--prune] [--keep-newer-than <duration>]
|
vaultik [--config <path>] snapshot create [snapshot-names...] [--cron] [--prune] [--keep-newer-than <duration>]
|
||||||
vaultik [--config <path>] snapshot list [--json] # alias: ls
|
vaultik [--config <path>] snapshot list [--json]
|
||||||
vaultik [--config <path>] snapshot verify <snapshot-id> [--deep] [--json]
|
vaultik [--config <path>] snapshot verify <snapshot-id> [--deep] [--json]
|
||||||
vaultik [--config <path>] snapshot purge [--keep-latest | --older-than <duration>] [--snapshot <name>...] [--force]
|
vaultik [--config <path>] snapshot purge [--keep-latest | --older-than <duration>] [--snapshot <name>...] [--force]
|
||||||
vaultik [--config <path>] snapshot remove <snapshot-id> [--dry-run] [--force] [--local-only] [--json] # alias: rm
|
vaultik [--config <path>] snapshot remove <snapshot-id> [--dry-run] [--force] [--local-only] [--json]
|
||||||
vaultik [--config <path>] snapshot restore <snapshot-id> <target-dir> [paths...] [--verify]
|
vaultik [--config <path>] snapshot restore <snapshot-id> <target-dir> [paths...] [--verify]
|
||||||
vaultik [--config <path>] prune [--force] [--json]
|
vaultik [--config <path>] prune [--force] [--json]
|
||||||
vaultik [--config <path>] info
|
vaultik [--config <path>] info
|
||||||
@@ -174,24 +116,7 @@ vaultik version
|
|||||||
* `--verbose`, `-v`: Enable verbose output (on stderr — see below)
|
* `--verbose`, `-v`: Enable verbose output (on stderr — see below)
|
||||||
* `--debug`: Enable debug output (on stderr — see below)
|
* `--debug`: Enable debug output (on stderr — see below)
|
||||||
* `--quiet`, `-q`: Suppress non-error output (also suppresses startup banner)
|
* `--quiet`, `-q`: Suppress non-error output (also suppresses startup banner)
|
||||||
* `--skip-errors`: Skip files that cannot be read when creating a snapshot, or that cannot be restored when restoring, instead of aborting. Packing and storage errors (which would leave a chunk recorded but not stored) still abort the run.
|
* `--skip-errors`: Continue past per-file errors instead of aborting (applies to `snapshot create` and `restore`)
|
||||||
|
|
||||||
### locking
|
|
||||||
|
|
||||||
Commands that write persistent state — `snapshot create`, `snapshot
|
|
||||||
purge`, `snapshot remove`, `prune`, and `remote nuke` — take a
|
|
||||||
process-wide lock at `$XDG_DATA_HOME/vaultik/vaultik.pid`
|
|
||||||
(`~/.local/share/vaultik/vaultik.pid` on Linux) for the whole run. Only
|
|
||||||
one of them runs at a time: a second one exits immediately with an
|
|
||||||
"already running" error rather than waiting, so two writers can never
|
|
||||||
corrupt the local index or the destination store.
|
|
||||||
|
|
||||||
Read-only commands — `info`, `snapshot list`, `snapshot verify`, and
|
|
||||||
`remote info` — do not take the lock and are never blocked, so they run
|
|
||||||
even while a backup is in progress. `snapshot restore` does not take the
|
|
||||||
lock either: it writes only to the target directory you name, not the
|
|
||||||
local index or the destination store. `config`, `database delete`,
|
|
||||||
`completion`, and `version` do not take the lock.
|
|
||||||
|
|
||||||
### stdout and stderr
|
### stdout and stderr
|
||||||
|
|
||||||
@@ -224,11 +149,9 @@ and `vaultik prune --json | jq .` both work as written.
|
|||||||
|
|
||||||
### environment variables
|
### environment variables
|
||||||
|
|
||||||
* `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for `snapshot restore` and `snapshot verify --deep`). May hold the whole `age-keygen` file — comments and every identity in it are accepted. Set it from the file, e.g. `export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"`, so the key is not typed into your shell history.
|
* `VAULTIK_AGE_SECRET_KEY`: Age private key for decryption (required for `snapshot restore` and `snapshot verify --deep`)
|
||||||
* `VAULTIK_CONFIG`: Path to config file (overridden by `--config`)
|
* `VAULTIK_CONFIG`: Path to config file (overridden by `--config`)
|
||||||
* `VAULTIK_INDEX_PATH`: Override local SQLite index path
|
* `VAULTIK_INDEX_PATH`: Override local SQLite index path
|
||||||
* `VAULTIK_CPUPROFILE`: Write a CPU profile to this path for the duration of the run (development/debugging)
|
|
||||||
* `VAULTIK_MEMPROFILE`: Write a heap profile to this path when the run exits (development/debugging)
|
|
||||||
|
|
||||||
### shell completion
|
### shell completion
|
||||||
|
|
||||||
@@ -319,21 +242,16 @@ local index alone, and still exits zero.
|
|||||||
logger, so stdout stays a single parseable document.
|
logger, so stdout stays a single parseable document.
|
||||||
|
|
||||||
**`snapshot verify`**: Verify snapshot integrity.
|
**`snapshot verify`**: Verify snapshot integrity.
|
||||||
* Default (shallow): checks that every blob the manifest lists is present in
|
* Default (shallow): checks that all blobs referenced in the manifest exist in storage
|
||||||
storage with the size the manifest records, and that the encrypted database is
|
|
||||||
present. It does not read blob contents.
|
|
||||||
* `--deep`: Downloads and decrypts each blob, verifies chunk hashes against the
|
* `--deep`: Downloads and decrypts each blob, verifies chunk hashes against the
|
||||||
encrypted metadata database
|
encrypted metadata database
|
||||||
* Accepts the same identifiers as `snapshot restore`: a snapshot ID, or a
|
|
||||||
remote-only snapshot's remote key (or an unambiguous leading part of it)
|
|
||||||
* `--json`: Output results as JSON
|
* `--json`: Output results as JSON
|
||||||
|
|
||||||
**`snapshot purge`**: Remove old snapshots based on criteria. Retention is
|
**`snapshot purge`**: Remove old snapshots based on criteria. Retention is
|
||||||
per-snapshot-name (`--keep-latest` keeps the latest of each name, not the
|
per-snapshot-name (`--keep-latest` keeps the latest of each name, not the
|
||||||
latest globally).
|
latest globally).
|
||||||
* `--keep-latest`: Keep only the most recent snapshot of each name
|
* `--keep-latest`: Keep only the most recent snapshot of each name
|
||||||
* `--older-than <duration>`: Remove snapshots older than duration (e.g. `30d`,
|
* `--older-than <duration>`: Remove snapshots older than duration (e.g. `30d`, `6m`, `1y`)
|
||||||
`4w`, `6mo`, `1y`; `m` is minutes, `mo` is months)
|
|
||||||
* `--snapshot <name>`: Restrict to specific snapshot names (repeat for multiple)
|
* `--snapshot <name>`: Restrict to specific snapshot names (repeat for multiple)
|
||||||
* `--force`: Skip confirmation prompt
|
* `--force`: Skip confirmation prompt
|
||||||
|
|
||||||
@@ -356,10 +274,6 @@ on the destination in one go, use `vaultik remote nuke --force`.
|
|||||||
|
|
||||||
**`snapshot restore`**: Restore files from a backup snapshot.
|
**`snapshot restore`**: Restore files from a backup snapshot.
|
||||||
* Requires `VAULTIK_AGE_SECRET_KEY` environment variable
|
* Requires `VAULTIK_AGE_SECRET_KEY` environment variable
|
||||||
* Accepts a snapshot ID, or — for a snapshot only on the destination
|
|
||||||
store — its remote key (or an unambiguous leading part of it) as shown
|
|
||||||
by `snapshot list`. See
|
|
||||||
[restoring on another machine](#restoring-on-another-machine).
|
|
||||||
* Optional path arguments to restore specific files/directories (default: all)
|
* Optional path arguments to restore specific files/directories (default: all)
|
||||||
* Preserves file permissions, timestamps, ownership (ownership requires root),
|
* Preserves file permissions, timestamps, ownership (ownership requires root),
|
||||||
symlinks, and empty directories
|
symlinks, and empty directories
|
||||||
@@ -423,10 +337,6 @@ both are set.
|
|||||||
|
|
||||||
## architecture
|
## architecture
|
||||||
|
|
||||||
For an implementation-level view of the internals — the data model, the
|
|
||||||
`fx` dependency-injection wiring, and the scanner — see
|
|
||||||
[`ARCHITECTURE.md`](ARCHITECTURE.md).
|
|
||||||
|
|
||||||
### remote storage layout
|
### remote storage layout
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -434,7 +344,7 @@ For an implementation-level view of the internals — the data model, the
|
|||||||
├── blobs/
|
├── blobs/
|
||||||
│ └── <aa>/<bb>/<full_blob_hash>
|
│ └── <aa>/<bb>/<full_blob_hash>
|
||||||
└── metadata/
|
└── metadata/
|
||||||
└── <remote-key>/
|
└── <snapshot_id>/
|
||||||
├── db.zst.age # Encrypted binary SQLite database
|
├── db.zst.age # Encrypted binary SQLite database
|
||||||
└── manifest.json.zst # Unencrypted blob list (for pruning)
|
└── manifest.json.zst # Unencrypted blob list (for pruning)
|
||||||
```
|
```
|
||||||
@@ -445,18 +355,8 @@ For an implementation-level view of the internals — the data model, the
|
|||||||
* `manifest.json.zst` is an unencrypted compressed JSON blob list, enabling
|
* `manifest.json.zst` is an unencrypted compressed JSON blob list, enabling
|
||||||
pruning without the private key
|
pruning without the private key
|
||||||
|
|
||||||
Snapshot IDs follow the human-readable format
|
Snapshot IDs follow the format `<hostname>_<snapshot-name>_<RFC3339-timestamp>`
|
||||||
`<hostname>_<snapshot-name>_<RFC3339-timestamp>` (e.g.
|
(e.g. `server1_home_2025-06-01T12:00:00Z`).
|
||||||
`server1_home_2025-06-01T12:00:00Z`), but this ID is never written to the
|
|
||||||
destination store in plaintext. Each snapshot's metadata directory is named
|
|
||||||
with its `<remote-key>`, a one-way double SHA-256 hash of the ID, so a listing
|
|
||||||
of the store reveals no hostname or snapshot name. The backup time is not
|
|
||||||
hidden: manifest.json.zst carries a plaintext timestamp, and object
|
|
||||||
modification times are visible at the storage layer regardless. For example,
|
|
||||||
`server1_home_2025-06-01T12:00:00Z` is stored under
|
|
||||||
`metadata/17f97bcde958748af076b926af59823943db59e80ce7170b40f124dfa28f64aa/`.
|
|
||||||
See [docs/REPOSTRUCTURE.md](docs/REPOSTRUCTURE.md#remote-key-derivation) for the
|
|
||||||
derivation.
|
|
||||||
|
|
||||||
### data flow
|
### data flow
|
||||||
|
|
||||||
@@ -473,7 +373,7 @@ derivation.
|
|||||||
|
|
||||||
**restore:**
|
**restore:**
|
||||||
|
|
||||||
1. Download and decrypt `metadata/<remote-key>/db.zst.age`
|
1. Download and decrypt `metadata/<snapshot_id>/db.zst.age`
|
||||||
2. Open the binary SQLite database
|
2. Open the binary SQLite database
|
||||||
3. Query files (optionally filtered by paths)
|
3. Query files (optionally filtered by paths)
|
||||||
4. Download and decrypt required blobs
|
4. Download and decrypt required blobs
|
||||||
@@ -504,30 +404,25 @@ derivation.
|
|||||||
|
|
||||||
### compression
|
### compression
|
||||||
|
|
||||||
* zstd compression at configurable level (1-19, default 3). The level is
|
* zstd compression at configurable level (1-19, default 3)
|
||||||
accepted as 1-19 but maps onto zstd's four internal speed presets:
|
|
||||||
1-2 fastest, 3-5 default, 6-9 better, 10-19 best. Levels within the
|
|
||||||
same band compress identically.
|
|
||||||
* Applied before encryption at the blob level
|
* Applied before encryption at the blob level
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## configuration reference
|
## configuration reference
|
||||||
|
|
||||||
Run `vaultik config init` to generate a fully commented config file; a
|
Run `vaultik config init` to generate a fully commented config file.
|
||||||
complete annotated example also lives in
|
Key fields:
|
||||||
[`config.example.yml`](config.example.yml). Key fields:
|
|
||||||
|
|
||||||
| Field | Default | Description |
|
| Field | Default | Description |
|
||||||
|-------|---------|-------------|
|
|-------|---------|-------------|
|
||||||
| `age_recipients` | (required) | Age public keys for encryption |
|
| `age_recipients` | (required) | Age public keys for encryption |
|
||||||
| `age_secret_key` | (unset) | Age private key for decryption (`snapshot restore`, `snapshot verify --deep`). Setting it in the config file places the private key on the backed-up host, defeating the public-key-only design (see "why" above). Prefer the `VAULTIK_AGE_SECRET_KEY` environment variable, supplied only on the machine you restore from. |
|
|
||||||
| `snapshots` | (required) | Named snapshot definitions with paths and excludes |
|
| `snapshots` | (required) | Named snapshot definitions with paths and excludes |
|
||||||
| `storage_url` | | Storage backend URL (`s3://`, `file://`, `rclone://`) |
|
| `storage_url` | | Storage backend URL (`s3://`, `file://`, `rclone://`) |
|
||||||
| `s3.*` | | Legacy S3 configuration (endpoint, bucket, credentials) |
|
| `s3.*` | | Legacy S3 configuration (endpoint, bucket, credentials) |
|
||||||
| `exclude` | | Global exclude patterns (applied to all snapshots) |
|
| `exclude` | | Global exclude patterns (applied to all snapshots) |
|
||||||
| `chunk_size` | `10MB` | Average chunk size for content-defined chunking |
|
| `chunk_size` | `10MB` | Average chunk size for content-defined chunking |
|
||||||
| `blob_size_limit` | `10GB` | Maximum blob size before splitting. Must be at least four times `chunk_size` (the largest chunk the chunker can emit), otherwise a single-chunk blob could exceed the limit |
|
| `blob_size_limit` | `10GB` | Maximum blob size before splitting |
|
||||||
| `compression_level` | `3` | zstd compression level (1-19) |
|
| `compression_level` | `3` | zstd compression level (1-19) |
|
||||||
| `hostname` | system hostname | Hostname used in snapshot IDs |
|
| `hostname` | system hostname | Hostname used in snapshot IDs |
|
||||||
| `index_path` | platform data dir | Local SQLite index path |
|
| `index_path` | platform data dir | Local SQLite index path |
|
||||||
@@ -551,13 +446,9 @@ complete annotated example also lives in
|
|||||||
sequentially. Restore speed is bound by single-stream throughput.
|
sequentially. Restore speed is bound by single-stream throughput.
|
||||||
* **Device nodes, named pipes, and sockets are silently skipped.** Only
|
* **Device nodes, named pipes, and sockets are silently skipped.** Only
|
||||||
regular files, directories, and symlinks are backed up.
|
regular files, directories, and symlinks are backed up.
|
||||||
* **No upgrade path between versions.** There is no supported way to carry
|
* **No database migrations.** If the local SQLite schema changes between
|
||||||
an existing local index across a schema change; if the local SQLite
|
versions, delete the local database (`vaultik database delete`) and run
|
||||||
schema changes between versions, delete the local database (`vaultik
|
a full backup. Remote storage is unaffected.
|
||||||
database delete`) and run a full backup. Remote storage is unaffected.
|
|
||||||
(The binary does embed numbered schema files and a `schema_migrations`
|
|
||||||
table to bootstrap a fresh database — see [`docs/DATAMODEL.md`](docs/DATAMODEL.md)
|
|
||||||
— but that is not an upgrade path.)
|
|
||||||
* **Files that change during backup may be inconsistent.** There is no
|
* **Files that change during backup may be inconsistent.** There is no
|
||||||
filesystem snapshot or freeze. If a file is modified between the scan
|
filesystem snapshot or freeze. If a file is modified between the scan
|
||||||
and chunk phases, the backed-up copy may reflect a partial write.
|
and chunk phases, the backed-up copy may reflect a partial write.
|
||||||
@@ -623,12 +514,14 @@ priority.
|
|||||||
|
|
||||||
### infrastructure
|
### infrastructure
|
||||||
|
|
||||||
* **Cross-version schema upgrades.** There is no upgrade path between
|
* **Cross-machine restore documentation.** The "restore from
|
||||||
released versions — pre-1.0 schema changes are handled by `vaultik
|
another host" workflow works but isn't documented as a
|
||||||
database delete` plus a full re-scan (see
|
first-class operation in this README. Worth a dedicated section
|
||||||
[`docs/DATAMODEL.md`](docs/DATAMODEL.md)). Post-1.0 we'll need a
|
once it's settled.
|
||||||
migration story to keep existing index databases usable across
|
* **Schema migrations.** Currently nonexistent — pre-1.0 schema
|
||||||
upgrades.
|
changes are handled by `vaultik database delete` plus a full
|
||||||
|
re-scan. Post-1.0 we'll need a migration story to keep existing
|
||||||
|
index databases usable across upgrades.
|
||||||
* **Storage backend coverage tests.** S3, file://, and rclone://
|
* **Storage backend coverage tests.** S3, file://, and rclone://
|
||||||
all share the Storer interface but the rclone path is the least
|
all share the Storer interface but the rclone path is the least
|
||||||
exercised in CI.
|
exercised in CI.
|
||||||
@@ -637,17 +530,9 @@ priority.
|
|||||||
|
|
||||||
## output style
|
## output style
|
||||||
|
|
||||||
The operational narration of the long-running commands — the Begin,
|
All user-facing output goes through helpers in `internal/ui` and conforms
|
||||||
Complete, Progress, and status lines of `snapshot create`, `prune`,
|
to a uniform style. Color is enabled when stdout is a TTY and the
|
||||||
`snapshot restore`, and the like — goes through helpers in `internal/ui`
|
`NO_COLOR` environment variable is unset (https://no-color.org/).
|
||||||
and conforms to the uniform style below. Some commands instead write
|
|
||||||
plain text straight to stdout (`version`, `info`, `config`, the
|
|
||||||
`database delete` prompt, and the `snapshot list` table); that output is
|
|
||||||
unstyled and does not honor `--quiet`. Routing it through `internal/ui`
|
|
||||||
is tracked in
|
|
||||||
[issue #149](https://git.eeqj.de/sneak/vaultik/issues/149). Color is
|
|
||||||
enabled when stdout is a TTY and the `NO_COLOR` environment variable is
|
|
||||||
unset (https://no-color.org/).
|
|
||||||
|
|
||||||
`internal/ui` writes to stdout; it is the output the user asked for.
|
`internal/ui` writes to stdout; it is the output the user asked for.
|
||||||
Structured log records are a different thing and go through
|
Structured log records are a different thing and go through
|
||||||
@@ -718,6 +603,7 @@ regardless of color setting (emoji are not color).
|
|||||||
and the pre-commit hook both run it. A `golangci-lint` installed on
|
and the pre-commit hook both run it. A `golangci-lint` installed on
|
||||||
`PATH` is not a substitute and is never used on a host, whatever its
|
`PATH` is not a substitute and is never used on a host, whatever its
|
||||||
version.
|
version.
|
||||||
|
* `sqlite3` CLI, which the test suite shells out to
|
||||||
* S3-compatible object storage (or local filesystem, or rclone remote)
|
* S3-compatible object storage (or local filesystem, or rclone remote)
|
||||||
|
|
||||||
## development workflow
|
## development workflow
|
||||||
@@ -748,8 +634,8 @@ standard: normalized scripts in `script/` are the entrypoints for the
|
|||||||
development workflow, and the Makefile targets are thin shims that call
|
development workflow, and the Makefile targets are thin shims that call
|
||||||
them. We provide:
|
them. We provide:
|
||||||
|
|
||||||
* `script/bootstrap` — install all development dependencies (go, Go
|
* `script/bootstrap` — install all development dependencies (go, sqlite3,
|
||||||
module download). It deliberately does not install `golangci-lint`;
|
Go module download). It deliberately does not install `golangci-lint`;
|
||||||
see `script/lint` below.
|
see `script/lint` below.
|
||||||
* `script/setup` — make a fresh clone ready for development: runs
|
* `script/setup` — make a fresh clone ready for development: runs
|
||||||
`script/bootstrap`, then `script/install-precommit`
|
`script/bootstrap`, then `script/install-precommit`
|
||||||
@@ -763,14 +649,6 @@ them. We provide:
|
|||||||
called by `script/bootstrap`; the release workflow calls it directly
|
called by `script/bootstrap`; the release workflow calls it directly
|
||||||
because it needs `goreleaser` but not the Docker daemon
|
because it needs `goreleaser` but not the Docker daemon
|
||||||
`script/bootstrap` insists on.
|
`script/bootstrap` insists on.
|
||||||
* `script/install-go` — install the Go toolchain named by `go.mod`'s
|
|
||||||
`go` directive into `.tool/go` from a sha256-verified `go.dev`
|
|
||||||
archive, and put it on `PATH`. Idempotent. Called only by the release
|
|
||||||
workflow, which needs a host Go for `goreleaser` to shell out to;
|
|
||||||
nothing else on the release runner does. `actions/setup-go` is not
|
|
||||||
used because it verifies the downloaded toolchain against no value in
|
|
||||||
this repo. Bumping Go edits `go.mod`, the checksum in this script, and
|
|
||||||
the `Dockerfile` `golang` digest together.
|
|
||||||
* `script/release` — cross-compile and publish the release artifacts
|
* `script/release` — cross-compile and publish the release artifacts
|
||||||
with the pinned `goreleaser`. Refuses a `goreleaser` on `PATH` whose
|
with the pinned `goreleaser`. Refuses a `goreleaser` on `PATH` whose
|
||||||
version is not the pinned one, on the same reasoning as `script/lint`.
|
version is not the pinned one, on the same reasoning as `script/lint`.
|
||||||
|
|||||||
@@ -25,137 +25,12 @@ release" is exactly the contradiction
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-09-22: Validated blob hashes, offsets and lengths read back from
|
|
||||||
the destination before using them
|
|
||||||
([issue #155](https://git.eeqj.de/sneak/vaultik/issues/155)). A blob
|
|
||||||
hash taken from the downloaded database or the store listing was
|
|
||||||
trusted unchecked, so a hostile remote could drive a decrypted blob to
|
|
||||||
be written outside the cache directory (a hash like `aa/../../etc`) or
|
|
||||||
crash a command with a short or negative value. `blobDiskCache.path`
|
|
||||||
now refuses any key containing a path separator, and `ReadAt` rejects a
|
|
||||||
negative offset or length and bounds with `length > size-offset` so a
|
|
||||||
sum cannot overflow past the check. A new `isBlobHash` helper (a plain
|
|
||||||
function, not a method — the packer stores `temp-placeholder-{uuid}` as
|
|
||||||
a hash) gates `FetchBlob`, shallow and deep verify; the `blobs/` and
|
|
||||||
`metadata/` listings skip a non-conforming name with a warning; and
|
|
||||||
short-hash prefixes in log and error text go through a `shortHash`
|
|
||||||
helper that cannot panic. `verify`'s chunk reader also rejects a
|
|
||||||
negative `blob_chunks` length and streams the chunk instead of
|
|
||||||
allocating a database-supplied size. `restore.go` and
|
|
||||||
`internal/database` were left untouched to avoid colliding with the
|
|
||||||
in-flight [issue #156](https://git.eeqj.de/sneak/vaultik/issues/156)
|
|
||||||
work; the cache-path and `FetchBlob` guards already stop the unsafe
|
|
||||||
write and fetch, so restore's own `buildBlobIndexes` early check is
|
|
||||||
deferred as fail-fast defense in depth.
|
|
||||||
|
|
||||||
- 2026-09-21: Stopped an interrupted blob upload from making a later
|
|
||||||
backup deduplicate against data that was never stored
|
|
||||||
([issue #148](https://git.eeqj.de/sneak/vaultik/issues/148)). The
|
|
||||||
packer commits a blob's `chunks`, `blob_chunks`, and `blobs` rows
|
|
||||||
before the upload is attempted, so a failed upload left chunk rows
|
|
||||||
behind and the next run skipped re-uploading them, producing a
|
|
||||||
snapshot that reported success but could not be restored. A run now
|
|
||||||
deduplicates only against chunks held by a blob whose `uploaded_ts` is
|
|
||||||
set, and at startup drops any un-uploaded blob rows (and the chunks
|
|
||||||
they orphan) so the affected data is re-chunked and re-uploaded. Blobs
|
|
||||||
recorded with no remote backend are marked uploaded so this invariant
|
|
||||||
holds uniformly.
|
|
||||||
|
|
||||||
- 2026-09-22: Made restore refuse any snapshot path that would write
|
|
||||||
outside the target directory
|
|
||||||
([issue #154](https://git.eeqj.de/sneak/vaultik/issues/154)).
|
|
||||||
`restoreFile` and `verifyRestoredFiles` joined the stored path onto the
|
|
||||||
target with no containment check, so a `..` segment or an absolute path
|
|
||||||
escaped the target and a restored symlink could redirect a later child
|
|
||||||
write anywhere on disk. Every stored path is now rejected unless
|
|
||||||
`filepath.IsLocal` accepts it with the leading separator removed, and
|
|
||||||
each existing ancestor directory below the target is `Lstat`ed to refuse
|
|
||||||
descending through a symlink; honest symlinks pointing outside the tree
|
|
||||||
are still written verbatim. age decryption proves a snapshot is
|
|
||||||
readable, not honest, and restore usually runs as root.
|
|
||||||
|
|
||||||
- 2026-09-21: Stopped `--json` from silencing stderr diagnostics
|
|
||||||
([issue #112](https://git.eeqj.de/sneak/vaultik/issues/112)). `--json`
|
|
||||||
used to be folded into `Quiet`, which pinned the log level to `WARN`,
|
|
||||||
so `prune --json` gave a machine consumer no record of the local index
|
|
||||||
rows it deleted even under `--verbose`. `--json` now quiets only the
|
|
||||||
stdout UI (the JSON document must stay clean, per
|
|
||||||
[issue #108](https://git.eeqj.de/sneak/vaultik/issues/108)); the stderr
|
|
||||||
log level follows `--verbose`/`--debug` again. The coupling was
|
|
||||||
removed the same way for `snapshot verify`, `snapshot remove`, and
|
|
||||||
`remote info`, which carried it for the same outdated reason.
|
|
||||||
|
|
||||||
- 2026-09-21: Stopped `prune` from reporting a failed row count as 0
|
|
||||||
([issue #96](https://git.eeqj.de/sneak/vaultik/issues/96)). The seven
|
|
||||||
`getTableCount` reads in `PruneDatabase` discarded their error, so a
|
|
||||||
query that could not run became a plausible `0` and the before/after
|
|
||||||
delta computed from it looked like real work. Each read now logs at
|
|
||||||
warn on failure and renders as `unknown`, never `0`, so an empty table
|
|
||||||
is distinguishable from one that could not be queried. The counts have
|
|
||||||
no `--json` representation — under `--json` the summary is suppressed
|
|
||||||
entirely — so nothing there can show a false `0`.
|
|
||||||
|
|
||||||
- 2026-09-21: Made the s3 storage backend report a missing object as
|
|
||||||
`storage.ErrNotFound`, like the `file` and `rclone` backends and as the
|
|
||||||
`Storer` interface documents. `S3Storer.Get` and `Stat` returned the raw
|
|
||||||
AWS SDK error, so `errors.Is(err, storage.ErrNotFound)` was false on s3
|
|
||||||
and callers branched differently per backend. Added a small `s3.IsNotFound`
|
|
||||||
helper (reused by `HeadObject`) and a test that a missing key maps to
|
|
||||||
`ErrNotFound`
|
|
||||||
([issue #129](https://git.eeqj.de/sneak/vaultik/issues/129)).
|
|
||||||
- 2026-09-21: Fixed `verify --deep` reporting healthy snapshots as
|
|
||||||
corrupt. Its final blob-integrity check hashed the encrypted
|
|
||||||
downloaded bytes with a single SHA256 and compared that to the blob
|
|
||||||
ID, which is the double SHA256 of the plaintext, so the two could
|
|
||||||
never match. It now hashes the decompressed plaintext and compares the
|
|
||||||
double SHA256. Added a test that backs up a real snapshot, deep-verifies
|
|
||||||
it, then flips a byte in one stored blob and confirms deep verification
|
|
||||||
then fails
|
|
||||||
([issue #131](https://git.eeqj.de/sneak/vaultik/issues/131)).
|
|
||||||
|
|
||||||
- 2026-09-21: Made `snapshot create` VACUUM the per-snapshot metadata
|
|
||||||
database through the `modernc.org/sqlite` driver instead of shelling
|
|
||||||
out to the external `sqlite` command-line binary (issue #120). A
|
|
||||||
backup no longer needs that binary on `PATH`, so `make check` passes
|
|
||||||
on a stock `go install` host; `script/bootstrap` and the `Dockerfile`
|
|
||||||
(both the test-build and the shipped runtime stage) no longer install
|
|
||||||
it, and a new test asserts the uploaded database keeps no pages from
|
|
||||||
deleted rows. Dropped the now-false note on the 2026-08-07 entry below
|
|
||||||
that said bootstrap installs it.
|
|
||||||
- 2026-09-21: Made `.gitea/workflows/check.yml` run on pushes to `main`
|
- 2026-09-21: Made `.gitea/workflows/check.yml` run on pushes to `main`
|
||||||
and `next` and on pull requests against either, so unit PRs (whose
|
and `next` and on pull requests against either, so unit PRs (whose
|
||||||
base is `next`) and `next` itself get a CI run instead of relying on a
|
base is `next`) and `next` itself get a CI run instead of relying on a
|
||||||
local `make check`
|
local `make check`
|
||||||
([issue #122](https://git.eeqj.de/sneak/vaultik/issues/122)).
|
([issue #122](https://git.eeqj.de/sneak/vaultik/issues/122)).
|
||||||
|
|
||||||
- 2026-09-21: Hash-verified the Go toolchain in the release workflow
|
|
||||||
([issue #105](https://git.eeqj.de/sneak/vaultik/issues/105)). New
|
|
||||||
`script/install-go` downloads the exact `go.dev` archive for `go.mod`'s
|
|
||||||
`go` directive and refuses it unless its sha256 matches a value
|
|
||||||
committed in the script; `.gitea/workflows/release.yml` calls it
|
|
||||||
instead of `actions/setup-go`, which verified the downloaded toolchain
|
|
||||||
against nothing in the repo. `GOTOOLCHAIN: local` on the release step
|
|
||||||
keeps that exact compiler from auto-switching. Bumping Go now touches
|
|
||||||
`go.mod`, the checksum, and the `Dockerfile` `golang` digest together.
|
|
||||||
|
|
||||||
- 2026-09-21: Collapsed the two duration parsers into one and fixed the
|
|
||||||
`--older-than` months example
|
|
||||||
([issue #123](https://git.eeqj.de/sneak/vaultik/issues/123)). Two
|
|
||||||
functions named `parseDuration` existed with different grammars;
|
|
||||||
`snapshot purge --older-than` and `--keep-newer-than` both already went
|
|
||||||
through the one in `internal/vaultik`, while the richer copy in
|
|
||||||
`internal/cli/duration.go` was reachable only from its own test. Kept
|
|
||||||
the live-path parser and deleted the unused one, so no flag's accepted
|
|
||||||
grammar changes. The trap the issue was filed over: `README.md`
|
|
||||||
documented `6m` as the months example for `--older-than`, but `m` is
|
|
||||||
minutes, so the documented command deleted every snapshot older than
|
|
||||||
six minutes on a destructive flag. Corrected the doc to `6mo` and put
|
|
||||||
both flags' help text on one example list that states `m` is minutes
|
|
||||||
and `mo` is months. The surviving parser now rejects negatives, which
|
|
||||||
it previously accepted (`-5h`) or silently made positive (`-5d`).
|
|
||||||
Table-driven tests cover every unit, `6m` as six minutes, `6mo` as 180
|
|
||||||
days, and rejection of a bare number, an unknown unit, and a negative.
|
|
||||||
|
|
||||||
- 2026-08-10: Moved every lint run into its own container, as a build
|
- 2026-08-10: Moved every lint run into its own container, as a build
|
||||||
step ([issue #113](https://git.eeqj.de/sneak/vaultik/issues/113)).
|
step ([issue #113](https://git.eeqj.de/sneak/vaultik/issues/113)).
|
||||||
New root `Dockerfile.lint`, built by `script/lint`, runs
|
New root `Dockerfile.lint`, built by `script/lint`, runs
|
||||||
@@ -184,11 +59,10 @@ release" is exactly the contradiction
|
|||||||
into each check command, and a fresh `$(date +%s%N)$$` per invocation
|
into each check command, and a fresh `$(date +%s%N)$$` per invocation
|
||||||
computed as a bare assignment. `cmd/vaultik/lintdocker_test.go`
|
computed as a bare assignment. `cmd/vaultik/lintdocker_test.go`
|
||||||
parses both Dockerfiles and both scripts and fails if any part of
|
parses both Dockerfiles and both scripts and fails if any part of
|
||||||
that is dropped, because every way of losing it is silent. No test
|
that is dropped, because every way of losing it is silent. Its
|
||||||
asserts that no script runs the host linter: `script/lint` is the one
|
host-lint assertion is structural — no script runs `golangci-lint`
|
||||||
lint entry point and runs `golangci-lint` only inside the container,
|
except through `docker` — rather than a search for the one retired
|
||||||
and keeping it that way is a review matter, not something a test
|
variable name, which nothing could ever reintroduce.
|
||||||
proves.
|
|
||||||
|
|
||||||
The product `Dockerfile` lost its lint stage rather than gaining a
|
The product `Dockerfile` lost its lint stage rather than gaining a
|
||||||
second linter pin: `make lint` is now `docker build`, so the stage
|
second linter pin: `make lint` is now `docker build`, so the stage
|
||||||
@@ -655,7 +529,7 @@ release" is exactly the contradiction
|
|||||||
was green was wrong.
|
was green was wrong.
|
||||||
- 2026-08-07: Added the standard `.golangci.yml` and `.editorconfig`
|
- 2026-08-07: Added the standard `.golangci.yml` and `.editorconfig`
|
||||||
(issue #59); lint findings under the new config are tracked in issue
|
(issue #59); lint findings under the new config are tracked in issue
|
||||||
#61.
|
#61. `script/bootstrap` now installs sqlite3 (needed by tests).
|
||||||
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints,
|
- 2026-07-07 Adopted scripts-to-rule-them-all: `script/` entrypoints,
|
||||||
Makefile shims, README Entrypoints section
|
Makefile shims, README Entrypoints section
|
||||||
- 2026-07-02: Consolidated CLI verbs, retired overlapping commands; bound
|
- 2026-07-02: Consolidated CLI verbs, retired overlapping commands; bound
|
||||||
|
|||||||
@@ -1,102 +0,0 @@
|
|||||||
package main_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// This file guards the version stamping of the product image (issue
|
|
||||||
// #75). The failure it protects against is silent: the image still
|
|
||||||
// builds and runs, but `vaultik version` inside it reports "commit:
|
|
||||||
// unknown", so an operator cannot tell which source produced a given
|
|
||||||
// backup. .dockerignore excludes .git, so the build cannot derive the
|
|
||||||
// commit itself; the values must be computed on the host and passed in.
|
|
||||||
//
|
|
||||||
// These are parses of the committed files, for the same reason the lint
|
|
||||||
// guards next door are: shelling out to docker would nest a build
|
|
||||||
// inside `make test`. That `vaultik version` in the built image really
|
|
||||||
// prints the host's version is verified by hand and recorded on the
|
|
||||||
// pull request.
|
|
||||||
|
|
||||||
// dockerScript is script/docker, relative to the repository root.
|
|
||||||
const dockerScript = "script/docker"
|
|
||||||
|
|
||||||
// versionArgs are the ldflag targets the build stamps and, matching
|
|
||||||
// them, the build args the host must supply. The names line up so the
|
|
||||||
// same list checks both files.
|
|
||||||
func versionArgs() []string {
|
|
||||||
return []string{"VERSION", "COMMIT", "COMMIT_DATE"}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestProductDockerfileTakesVersionAsBuildArgs fails unless the build
|
|
||||||
// declares each version arg and stamps it into the binary by ldflag
|
|
||||||
// reference, rather than computing it in the container.
|
|
||||||
func TestProductDockerfileTakesVersionAsBuildArgs(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
found := instructions(t, productDockerfile)
|
|
||||||
|
|
||||||
for _, arg := range versionArgs() {
|
|
||||||
require.GreaterOrEqual(t, indexOf(found, "ARG "+arg), 0,
|
|
||||||
"%s must declare `ARG %s` so the host can pass it in",
|
|
||||||
productDockerfile, arg)
|
|
||||||
|
|
||||||
assertLdflagReferences(t, found, arg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestProductDockerfileDoesNotDeriveVersionItself is the anti-regression
|
|
||||||
// for the original defect: the container ran `git rev-parse`, but .git
|
|
||||||
// is not in the build context, so it always resolved to "unknown". No
|
|
||||||
// git command may reach into a build that cannot see the history.
|
|
||||||
func TestProductDockerfileDoesNotDeriveVersionItself(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
text := instructionText(readRepoFile(t, productDockerfile))
|
|
||||||
|
|
||||||
assert.NotContains(t, text, "git ",
|
|
||||||
"%s must not run git: .git is excluded from the build context, so"+
|
|
||||||
" any value it derives is wrong. Pass version, commit and date"+
|
|
||||||
" in as build args instead.", productDockerfile)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDockerScriptComputesVersionOnTheHost fails unless script/docker
|
|
||||||
// derives each value where .git exists and passes it as a build arg,
|
|
||||||
// with VERSION coming from script/version so a Docker build reports the
|
|
||||||
// same string a local build of the same tree would.
|
|
||||||
func TestDockerScriptComputesVersionOnTheHost(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
script := readRepoFile(t, dockerScript)
|
|
||||||
|
|
||||||
for _, arg := range versionArgs() {
|
|
||||||
assert.Contains(t, script, "--build-arg "+arg+"=",
|
|
||||||
"%s must pass --build-arg %s to the build", dockerScript, arg)
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.Contains(t, script, "/version",
|
|
||||||
"%s must take VERSION from script/version, the source of truth"+
|
|
||||||
" shared with the Makefile", dockerScript)
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertLdflagReferences fails unless some build instruction stamps the
|
|
||||||
// named variable from the ARG (a ${arg} reference), not from a value
|
|
||||||
// computed inside the container.
|
|
||||||
func assertLdflagReferences(t *testing.T, found []string, arg string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
for _, instruction := range found {
|
|
||||||
if strings.HasPrefix(instruction, "RUN ") &&
|
|
||||||
strings.Contains(instruction, "go build") &&
|
|
||||||
strings.Contains(instruction, "${"+arg+"}") {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.Fail(t, "version arg is declared but never stamped",
|
|
||||||
"the go build in %s must reference ${%s} in its ldflags, or the"+
|
|
||||||
" arg is passed and discarded", productDockerfile, arg)
|
|
||||||
}
|
|
||||||
+305
-13
@@ -1,6 +1,8 @@
|
|||||||
package main_test
|
package main_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -28,11 +30,6 @@ import (
|
|||||||
// -- that a real finding actually fails the build -- is verified by
|
// -- that a real finding actually fails the build -- is verified by
|
||||||
// hand against a deliberately broken tree, recorded on the pull
|
// hand against a deliberately broken tree, recorded on the pull
|
||||||
// request.
|
// request.
|
||||||
//
|
|
||||||
// One property is deliberately NOT tested here: that no script runs the
|
|
||||||
// linter on the host. script/lint is the only lint entry point, and it
|
|
||||||
// runs golangci-lint only inside the container; keeping it that way is a
|
|
||||||
// review matter, not something a test in this file establishes.
|
|
||||||
|
|
||||||
// The files under guard, relative to the repository root.
|
// The files under guard, relative to the repository root.
|
||||||
const (
|
const (
|
||||||
@@ -42,8 +39,9 @@ const (
|
|||||||
cibuildScript = "script/cibuild"
|
cibuildScript = "script/cibuild"
|
||||||
)
|
)
|
||||||
|
|
||||||
// linterBinary is the linter's command name, used to locate the
|
// linterBinary is the linter's command name. Every occurrence of it in
|
||||||
// config-verify and lint steps in Dockerfile.lint.
|
// executable shell in this repo must be inside a docker invocation; see
|
||||||
|
// TestNoHostLintPathRemains.
|
||||||
const linterBinary = "golangci-lint"
|
const linterBinary = "golangci-lint"
|
||||||
|
|
||||||
// checkEpochARG is the declaration, with no default value. A default
|
// checkEpochARG is the declaration, with no default value. A default
|
||||||
@@ -223,6 +221,175 @@ func TestCibuildBuildsBothDockerfilesWithFreshEpochs(t *testing.T) {
|
|||||||
"%s must build %s", cibuildScript, lintDockerfile)
|
"%s must build %s", cibuildScript, lintDockerfile)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestNoHostLintPathRemains fails if any escape hatch to a host linter
|
||||||
|
// comes back. The owner's ruling is that every lint run happens inside
|
||||||
|
// a container; a PATH binary that happens to match the pinned version
|
||||||
|
// is a different build reached by a different code path, and admitting
|
||||||
|
// it is what lets a local pass disagree with CI.
|
||||||
|
//
|
||||||
|
// This asserts the PROPERTY -- no script invokes the linter except
|
||||||
|
// through docker -- rather than the absence of any particular variable
|
||||||
|
// name. An earlier version of this test looked only for the literal
|
||||||
|
// VAULTIK_LINT_IN_CONTAINER, the name of the hatch that was removed
|
||||||
|
// alongside it, so nothing could ever trip it again: a hatch under any
|
||||||
|
// other name left it passing. A structural test that passes on a broken
|
||||||
|
// tree is worse than no test, because it is what a later reader trusts
|
||||||
|
// instead of re-deriving the invariant.
|
||||||
|
//
|
||||||
|
// script/lint-fix is not exempted. It is the one script that runs the
|
||||||
|
// linter as a container rather than as a build step, but it still runs
|
||||||
|
// it in one, so the same property holds of it.
|
||||||
|
func TestNoHostLintPathRemains(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
root := repoRoot(t)
|
||||||
|
|
||||||
|
entries, err := os.ReadDir(filepath.Join(root, "script"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotEmpty(t, entries, "no scripts found to scan")
|
||||||
|
|
||||||
|
for _, entry := range entries {
|
||||||
|
if entry.IsDir() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
name := filepath.Join("script", entry.Name())
|
||||||
|
|
||||||
|
lines, err := shellCode(readRepoFile(t, name))
|
||||||
|
require.NoError(t, err, "scanning %s", name)
|
||||||
|
|
||||||
|
for _, line := range lines {
|
||||||
|
assertLinterIsContainerised(t, name, line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// assertLinterIsContainerised fails unless every command that names the
|
||||||
|
// linter on this joined line is a docker command. Merely mentioning
|
||||||
|
// docker somewhere on the line is not enough; see linterRunsInDocker.
|
||||||
|
func assertLinterIsContainerised(t *testing.T, name, line string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
assert.True(t, linterRunsInDocker(line),
|
||||||
|
"%s runs %s outside a container; every command that names the"+
|
||||||
|
" linter must begin with docker (line: %s)", name, linterBinary,
|
||||||
|
line)
|
||||||
|
}
|
||||||
|
|
||||||
|
// linterRunsInDocker reports whether the linter, wherever it appears on
|
||||||
|
// this joined shell line, is only ever the argument of a docker command.
|
||||||
|
// The line is cut into the simple commands the shell would run -- on
|
||||||
|
// `;`, `&&`, `||` and `|` -- and every command that names the linter
|
||||||
|
// must begin with `docker`. This is what distinguishes the one
|
||||||
|
// legitimate invocation, script/lint-fix's `docker run ... golangci-lint
|
||||||
|
// run ...`, from evasions like `docker info; golangci-lint run` or
|
||||||
|
// `docker info || golangci-lint run`, where the linter sits in a command
|
||||||
|
// of its own that docker does not introduce.
|
||||||
|
func linterRunsInDocker(line string) bool {
|
||||||
|
for _, command := range splitShellCommands(line) {
|
||||||
|
if !strings.Contains(command, linterBinary) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.HasPrefix(strings.TrimSpace(command), "docker") {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitShellCommands breaks a joined shell line into the separate simple
|
||||||
|
// commands the shell would run, cutting at the `;`, `&&`, `||` and `|`
|
||||||
|
// operators (`||` before `|`, so the two-character operator is not split
|
||||||
|
// twice). It is deliberately blind to quoting and to `$(...)`: no line
|
||||||
|
// under guard puts one of these operators inside a string, and a scan
|
||||||
|
// that tried to account for that would be the kind of half-parser this
|
||||||
|
// file avoids.
|
||||||
|
func splitShellCommands(line string) []string {
|
||||||
|
for _, op := range []string{"&&", "||", "|", ";"} {
|
||||||
|
line = strings.ReplaceAll(line, op, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.Split(line, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestShellCodeSeesCodeAndNotProse keeps the scanner above honest. It
|
||||||
|
// has to ignore comments and here-document bodies, because script/lint
|
||||||
|
// and script/bootstrap both NAME golangci-lint in prose -- in comments,
|
||||||
|
// and in the error text they print -- precisely to say that the host
|
||||||
|
// binary is never used. A scanner that went blind, by over-eager
|
||||||
|
// stripping or by failing to join continuation lines, would make
|
||||||
|
// TestNoHostLintPathRemains pass on everything.
|
||||||
|
func TestShellCodeSeesCodeAndNotProse(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// A `<<` inside quotes is not a here-document, so the code after it
|
||||||
|
// is still scanned; a real `<<EOF` opens one and its body is dropped.
|
||||||
|
script := strings.Join([]string{
|
||||||
|
"#!/bin/sh",
|
||||||
|
"# a comment naming golangci-lint",
|
||||||
|
"cat >&2 <<EOF",
|
||||||
|
"prose naming golangci-lint, printed not executed",
|
||||||
|
"EOF",
|
||||||
|
`echo "a left shift << is not a here-document"`,
|
||||||
|
"docker run --rm \\",
|
||||||
|
" \"$image\" \\",
|
||||||
|
" golangci-lint run ./...",
|
||||||
|
}, "\n")
|
||||||
|
|
||||||
|
lines, err := shellCode(script)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t,
|
||||||
|
[]string{
|
||||||
|
"cat >&2 <<EOF",
|
||||||
|
`echo "a left shift << is not a here-document"`,
|
||||||
|
`docker run --rm "$image" golangci-lint run ./...`,
|
||||||
|
},
|
||||||
|
lines)
|
||||||
|
|
||||||
|
// A here-document still open at end of file must be a loud error,
|
||||||
|
// not a silent truncation of everything the scanner has yet to see.
|
||||||
|
unterminated := strings.Join([]string{
|
||||||
|
"cat <<EOF",
|
||||||
|
"body line naming golangci-lint, no terminator follows",
|
||||||
|
}, "\n")
|
||||||
|
|
||||||
|
_, err = shellCode(unterminated)
|
||||||
|
require.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLinterCommandMustBeginWithDocker pins the property that a mention
|
||||||
|
// of docker somewhere on the line is not enough: the command that
|
||||||
|
// actually runs the linter has to be a docker command. The two evasions
|
||||||
|
// from the issue place the linter in a command of its own, joined to a
|
||||||
|
// harmless docker command by `;` or `||`; both must be rejected. The
|
||||||
|
// containerised invocation script/lint-fix writes -- docker run with the
|
||||||
|
// linter as its argument -- must still be accepted.
|
||||||
|
func TestLinterCommandMustBeginWithDocker(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
rejected := []string{
|
||||||
|
"docker info >/dev/null; golangci-lint run ./...",
|
||||||
|
"docker info || golangci-lint run ./...",
|
||||||
|
"docker build . && golangci-lint run ./... | tee log",
|
||||||
|
}
|
||||||
|
for _, line := range rejected {
|
||||||
|
assert.False(t, linterRunsInDocker(line),
|
||||||
|
"a linter command docker does not introduce must be rejected: %s",
|
||||||
|
line)
|
||||||
|
}
|
||||||
|
|
||||||
|
accepted := []string{
|
||||||
|
`docker run --rm "$image" golangci-lint run ./...`,
|
||||||
|
`docker run --rm --user x --volume "$ROOT:/src" img golangci-lint run --fix ./...`,
|
||||||
|
}
|
||||||
|
for _, line := range accepted {
|
||||||
|
assert.True(t, linterRunsInDocker(line),
|
||||||
|
"a docker-introduced linter command must be accepted: %s", line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// assertEpochExpandedInto fails unless some instruction runs the named
|
// assertEpochExpandedInto fails unless some instruction runs the named
|
||||||
// command with the epoch expanded into it. Expansion, not mere
|
// command with the epoch expanded into it. Expansion, not mere
|
||||||
// declaration: an ARG that no instruction references is not guaranteed
|
// declaration: an ARG that no instruction references is not guaranteed
|
||||||
@@ -304,14 +471,10 @@ func instructionText(contents string) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// indexOf returns the position of the first instruction equal to, or
|
// indexOf returns the position of the first instruction equal to, or
|
||||||
// beginning with, want; -1 if there is none. An `ARG NAME=default`
|
// beginning with, want; -1 if there is none.
|
||||||
// counts as beginning with `ARG NAME`, so a declared arg is found
|
|
||||||
// whether or not it carries a default.
|
|
||||||
func indexOf(found []string, want string) int {
|
func indexOf(found []string, want string) int {
|
||||||
for i, instruction := range found {
|
for i, instruction := range found {
|
||||||
if instruction == want ||
|
if instruction == want || strings.HasPrefix(instruction, want+" ") {
|
||||||
strings.HasPrefix(instruction, want+" ") ||
|
|
||||||
strings.HasPrefix(instruction, want+"=") {
|
|
||||||
return i
|
return i
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -331,6 +494,135 @@ func indexContaining(found []string, want string) int {
|
|||||||
return -1
|
return -1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// shellCode returns a POSIX shell script's executable lines: comments
|
||||||
|
// dropped, here-document bodies dropped, and backslash continuations
|
||||||
|
// joined so a multi-line command is a single string. Whitespace is
|
||||||
|
// collapsed, as it is for Dockerfile instructions. A here-document left
|
||||||
|
// open at end of file is an error rather than a silent truncation of
|
||||||
|
// everything after its opener.
|
||||||
|
//
|
||||||
|
// Both exclusions are load-bearing rather than tidiness. The scripts
|
||||||
|
// name golangci-lint in prose to state that the host binary is never
|
||||||
|
// used, and joining continuations is what lets the one legitimate
|
||||||
|
// container invocation -- script/lint-fix's `docker run`, whose linter
|
||||||
|
// command sits several lines below the word `docker` -- be recognised
|
||||||
|
// as containerised.
|
||||||
|
//
|
||||||
|
// This is a text scan, not a shell: it cannot see a linter name
|
||||||
|
// assembled at runtime, one split across a continuation, a script in a
|
||||||
|
// subdirectory of script/, or anything in the Makefile.
|
||||||
|
func shellCode(contents string) ([]string, error) {
|
||||||
|
var (
|
||||||
|
out []string
|
||||||
|
joined string
|
||||||
|
terminate string
|
||||||
|
)
|
||||||
|
|
||||||
|
for line := range strings.SplitSeq(contents, "\n") {
|
||||||
|
trimmed := strings.TrimSpace(line)
|
||||||
|
|
||||||
|
if terminate != "" {
|
||||||
|
if trimmed == terminate {
|
||||||
|
terminate = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if joined == "" && (trimmed == "" || strings.HasPrefix(trimmed, "#")) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
joined += strings.TrimSuffix(trimmed, `\`) + " "
|
||||||
|
if strings.HasSuffix(trimmed, `\`) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
joined = strings.Join(strings.Fields(joined), " ")
|
||||||
|
terminate = heredocTerminator(joined)
|
||||||
|
|
||||||
|
out = append(out, joined)
|
||||||
|
joined = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
if terminate != "" {
|
||||||
|
return nil, fmt.Errorf("%w: terminator %q", errUnterminatedHeredoc,
|
||||||
|
terminate)
|
||||||
|
}
|
||||||
|
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// errUnterminatedHeredoc is what shellCode returns when a here-document
|
||||||
|
// is still open at end of file. Its callers require its absence, so an
|
||||||
|
// unterminated body -- which would otherwise be swallowed silently --
|
||||||
|
// fails the guard loudly.
|
||||||
|
var errUnterminatedHeredoc = errors.New(
|
||||||
|
"here-document opened but never closed before end of file")
|
||||||
|
|
||||||
|
// heredocTerminator returns the delimiter word of the here-document the
|
||||||
|
// command opens, or "" if it opens none. A `<<` only opens one when it
|
||||||
|
// is a real redirection: outside single and double quotes, and followed
|
||||||
|
// by a delimiter word. A `<<` inside a quoted string, or an arithmetic
|
||||||
|
// left shift like `$((x << 2))`, is not a here-document; the former is
|
||||||
|
// the case this guards, the latter appears in no script here. Only the
|
||||||
|
// first opener on a line is recognised; nothing in script/ opens two.
|
||||||
|
func heredocTerminator(line string) string {
|
||||||
|
var quote byte // 0 when outside quotes, else '\'' or '"'
|
||||||
|
|
||||||
|
for i := 0; i+1 < len(line); i++ {
|
||||||
|
c := line[i]
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case quote != 0:
|
||||||
|
if c == quote {
|
||||||
|
quote = 0
|
||||||
|
}
|
||||||
|
case c == '\'' || c == '"':
|
||||||
|
quote = c
|
||||||
|
case c == '<' && line[i+1] == '<':
|
||||||
|
return heredocWord(line[i+2:])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// heredocWord extracts the delimiter that follows `<<` or `<<-`: it drops
|
||||||
|
// an optional `-`, skips blanks, then reads the delimiter -- quoted or
|
||||||
|
// bare -- and returns it with quotes removed. `<<-'EOF'` and `<< EOF`
|
||||||
|
// both yield "EOF". It returns "" when no word follows, so a bare `<<`
|
||||||
|
// opens nothing.
|
||||||
|
func heredocWord(after string) string {
|
||||||
|
after = strings.TrimLeft(strings.TrimPrefix(after, "-"), " \t")
|
||||||
|
|
||||||
|
var (
|
||||||
|
word strings.Builder
|
||||||
|
quote byte
|
||||||
|
)
|
||||||
|
|
||||||
|
for i := range len(after) {
|
||||||
|
c := after[i]
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case quote != 0:
|
||||||
|
if c == quote {
|
||||||
|
quote = 0
|
||||||
|
} else {
|
||||||
|
word.WriteByte(c)
|
||||||
|
}
|
||||||
|
case c == '\'' || c == '"':
|
||||||
|
quote = c
|
||||||
|
case c == ' ' || c == '\t':
|
||||||
|
return word.String()
|
||||||
|
default:
|
||||||
|
word.WriteByte(c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return word.String()
|
||||||
|
}
|
||||||
|
|
||||||
// readRepoFile reads a file by its path relative to the repository
|
// readRepoFile reads a file by its path relative to the repository
|
||||||
// root.
|
// root.
|
||||||
func readRepoFile(t *testing.T, name string) string {
|
func readRepoFile(t *testing.T, name string) string {
|
||||||
|
|||||||
+1
-11
@@ -10,16 +10,6 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
os.Exit(run())
|
|
||||||
}
|
|
||||||
|
|
||||||
// run sets up optional profiling, runs the CLI, and returns the process
|
|
||||||
// exit code. os.Exit lives in main so it fires only after run's deferred
|
|
||||||
// profile writers have flushed. cli.Entry returns a status code rather
|
|
||||||
// than calling os.Exit itself: an os.Exit from inside it would skip
|
|
||||||
// these defers and truncate the profile of a failing command -- exactly
|
|
||||||
// the command one most often wants to profile.
|
|
||||||
func run() int {
|
|
||||||
// CPU profiling: set VAULTIK_CPUPROFILE=/path/to/cpu.prof
|
// CPU profiling: set VAULTIK_CPUPROFILE=/path/to/cpu.prof
|
||||||
if cpuProfile := os.Getenv("VAULTIK_CPUPROFILE"); cpuProfile != "" {
|
if cpuProfile := os.Getenv("VAULTIK_CPUPROFILE"); cpuProfile != "" {
|
||||||
f, err := os.Create(cpuProfile) //nolint:gosec // G304: operator-set path
|
f, err := os.Create(cpuProfile) //nolint:gosec // G304: operator-set path
|
||||||
@@ -56,5 +46,5 @@ func run() int {
|
|||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
return cli.Entry()
|
cli.Entry()
|
||||||
}
|
}
|
||||||
|
|||||||
+5
-7
@@ -257,16 +257,16 @@ exclude:
|
|||||||
|
|
||||||
# Storage URL - use either this OR the s3 section below
|
# Storage URL - use either this OR the s3 section below
|
||||||
# Supports: s3://bucket/prefix, file:///path, rclone://remote/path
|
# Supports: s3://bucket/prefix, file:///path, rclone://remote/path
|
||||||
storage_url: "rclone://myremote/path/to/backups"
|
storage_url: "rclone://las1stor1//srv/pool.2024.04/backups/heraklion"
|
||||||
|
|
||||||
# S3-compatible storage configuration
|
# S3-compatible storage configuration
|
||||||
#s3:
|
#s3:
|
||||||
# # S3-compatible endpoint URL
|
# # S3-compatible endpoint URL
|
||||||
# # Examples: https://s3.amazonaws.com, https://storage.googleapis.com
|
# # Examples: https://s3.amazonaws.com, https://storage.googleapis.com
|
||||||
# endpoint: https://s3.example.com
|
# endpoint: http://10.100.205.122:8333
|
||||||
#
|
#
|
||||||
# # Bucket name where backups will be stored
|
# # Bucket name where backups will be stored
|
||||||
# bucket: mybucket
|
# bucket: testbucket
|
||||||
#
|
#
|
||||||
# # Prefix (folder) within the bucket for this host's backups
|
# # Prefix (folder) within the bucket for this host's backups
|
||||||
# # Useful for organizing backups from multiple hosts
|
# # Useful for organizing backups from multiple hosts
|
||||||
@@ -274,8 +274,8 @@ storage_url: "rclone://myremote/path/to/backups"
|
|||||||
# #prefix: "hosts/myserver/"
|
# #prefix: "hosts/myserver/"
|
||||||
#
|
#
|
||||||
# # S3 access credentials
|
# # S3 access credentials
|
||||||
# access_key_id: YOUR_ACCESS_KEY
|
# access_key_id: Z9GT22M9YFU08WRMC5D4
|
||||||
# secret_access_key: YOUR_SECRET_KEY
|
# secret_access_key: Pi0tPKjFbN4rZlRhcA4zBtEkib04yy2WcIzI+AXk
|
||||||
#
|
#
|
||||||
# # S3 region
|
# # S3 region
|
||||||
# # Default: us-east-1
|
# # Default: us-east-1
|
||||||
@@ -304,8 +304,6 @@ storage_url: "rclone://myremote/path/to/backups"
|
|||||||
|
|
||||||
# Maximum blob size
|
# Maximum blob size
|
||||||
# Multiple chunks are packed into blobs up to this size
|
# Multiple chunks are packed into blobs up to this size
|
||||||
# Must be at least four times chunk_size (the largest chunk the chunker can
|
|
||||||
# emit); a smaller limit would let a single-chunk blob exceed it.
|
|
||||||
# Supports: 1GB, 10G, 500MB, 1GiB, etc.
|
# Supports: 1GB, 10G, 500MB, 1GiB, etc.
|
||||||
# Default: 10GB
|
# Default: 10GB
|
||||||
#blob_size_limit: 10GB
|
#blob_size_limit: 10GB
|
||||||
|
|||||||
+8
-29
@@ -5,30 +5,11 @@
|
|||||||
Vaultik uses a local SQLite database to track file metadata, chunk mappings, and blob associations during the backup process. This database serves as an index for incremental backups and enables efficient deduplication.
|
Vaultik uses a local SQLite database to track file metadata, chunk mappings, and blob associations during the backup process. This database serves as an index for incremental backups and enables efficient deduplication.
|
||||||
|
|
||||||
**Important Notes:**
|
**Important Notes:**
|
||||||
|
- **No Migration Support (pre-1.0)**: Vaultik does not support database schema
|
||||||
This section is the authoritative explanation of the schema/migration story;
|
migrations. The local index is treated as disposable — if the schema changes,
|
||||||
other documents (the README and `AGENTS.md`) link here.
|
delete the local SQLite database (`vaultik database delete`) and run a full
|
||||||
|
backup. The remote storage is unaffected; the new index will re-deduplicate
|
||||||
- **No upgrade path between versions (pre-1.0)**: Vaultik has no supported way to
|
against existing remote blobs.
|
||||||
carry an existing local index across a schema change. The index is disposable
|
|
||||||
— if the on-disk schema changes between versions, delete the local SQLite
|
|
||||||
database (`vaultik database delete`) and run a full backup. Remote storage is
|
|
||||||
unaffected; the new index re-deduplicates against existing remote blobs. This
|
|
||||||
is the standing project policy, and it is separate from the schema bootstrap
|
|
||||||
described next.
|
|
||||||
- **Schema bootstrap**: a fresh database is populated from numbered SQL files
|
|
||||||
embedded in the binary under `internal/database/schema/`. `000.sql` creates the
|
|
||||||
`schema_migrations` table; `001.sql` creates the application tables. On opening
|
|
||||||
a database the code applies each numbered file that has not yet run and records
|
|
||||||
its version in `schema_migrations`. This bootstraps a new database; it does not
|
|
||||||
upgrade an existing one between released versions.
|
|
||||||
- **Changing the schema (pre-1.0)**: edit `internal/database/schema/001.sql` (and
|
|
||||||
the code that touches the affected tables) directly. Do not add new numbered
|
|
||||||
files — there is no installed base to migrate.
|
|
||||||
- **Disposability expires at 1.0**: the index is treated as disposable only until
|
|
||||||
1.0 ships and is tagged. Once 1.0 is tagged that clause expires and the
|
|
||||||
question of upgrading existing indexes returns. It is deliberately left open
|
|
||||||
here.
|
|
||||||
- **Version Compatibility**: In rare cases, you may need to use the same version
|
- **Version Compatibility**: In rare cases, you may need to use the same version
|
||||||
of Vaultik to restore a backup as was used to create it. This ensures
|
of Vaultik to restore a backup as was used to create it. This ensures
|
||||||
compatibility with the metadata format stored in S3.
|
compatibility with the metadata format stored in S3.
|
||||||
@@ -211,12 +192,10 @@ Tracks blob upload metrics.
|
|||||||
After a snapshot is completed:
|
After a snapshot is completed:
|
||||||
1. Copy database to temporary file
|
1. Copy database to temporary file
|
||||||
2. Clean temporary database to contain only current snapshot data
|
2. Clean temporary database to contain only current snapshot data
|
||||||
3. VACUUM the trimmed database so deleted rows leave no pages behind
|
3. Export to SQL dump using sqlite3
|
||||||
4. Compress with zstd and encrypt with age
|
4. Compress with zstd and encrypt with age
|
||||||
5. Upload to S3 as `metadata/{remote-key}/db.zst.age`
|
5. Upload to S3 as `metadata/{snapshot-id}/db.zst.age`
|
||||||
6. Generate blob manifest and upload as `metadata/{remote-key}/manifest.json.zst`
|
6. Generate blob manifest and upload as `metadata/{snapshot-id}/manifest.json.zst`
|
||||||
|
|
||||||
The `{remote-key}` directory name is a one-way hash of the human snapshot ID, so the ID is never written to the store in plaintext; see [REPOSTRUCTURE.md](REPOSTRUCTURE.md#remote-key-derivation).
|
|
||||||
|
|
||||||
### 4. Restore Process
|
### 4. Restore Process
|
||||||
|
|
||||||
|
|||||||
+20
-40
@@ -17,13 +17,11 @@ Vaultik stores all backup data in an S3-compatible object store. The repository
|
|||||||
│ └── <hash[2:4]>/
|
│ └── <hash[2:4]>/
|
||||||
│ └── <full-hash>
|
│ └── <full-hash>
|
||||||
└── metadata/
|
└── metadata/
|
||||||
└── <remote-key>/
|
└── <snapshot-id>/
|
||||||
├── db.zst.age
|
├── db.zst.age
|
||||||
└── manifest.json.zst
|
└── manifest.json.zst
|
||||||
```
|
```
|
||||||
|
|
||||||
The metadata subdirectory is named with the **remote key**, a one-way hash of the snapshot ID, not with the human-readable snapshot ID itself. See [Remote Key Derivation](#remote-key-derivation).
|
|
||||||
|
|
||||||
## Blobs Directory (`blobs/`)
|
## Blobs Directory (`blobs/`)
|
||||||
|
|
||||||
### Structure
|
### Structure
|
||||||
@@ -42,11 +40,9 @@ Blobs contain the actual file data from backups and must be encrypted for securi
|
|||||||
|
|
||||||
## Metadata Directory (`metadata/`)
|
## Metadata Directory (`metadata/`)
|
||||||
|
|
||||||
Each snapshot has its own subdirectory. The directory is **not** named with the human-readable snapshot ID; it is named with the remote key — a one-way hash of that ID. The human ID is never written to the destination store as a directory name (see [Remote Key Derivation](#remote-key-derivation)).
|
Each snapshot has its own subdirectory named with the snapshot ID.
|
||||||
|
|
||||||
### Snapshot ID Format
|
### Snapshot ID Format
|
||||||
|
|
||||||
The human-readable snapshot ID is used in CLI arguments, log lines, and the local database. It is not written to the destination store.
|
|
||||||
- **Format**: `<hostname>_<snapshot-name>_<RFC3339>` (or `<hostname>_<RFC3339>` if no
|
- **Format**: `<hostname>_<snapshot-name>_<RFC3339>` (or `<hostname>_<RFC3339>` if no
|
||||||
name was specified)
|
name was specified)
|
||||||
- **Example**: `laptop_home_2024-01-15T14:30:52Z`
|
- **Example**: `laptop_home_2024-01-15T14:30:52Z`
|
||||||
@@ -55,19 +51,6 @@ The human-readable snapshot ID is used in CLI arguments, log lines, and the loca
|
|||||||
- Snapshot name from the configured `snapshots:` map (optional)
|
- Snapshot name from the configured `snapshots:` map (optional)
|
||||||
- RFC3339 UTC timestamp
|
- RFC3339 UTC timestamp
|
||||||
|
|
||||||
This ID reveals the hostname, the configured snapshot name, and the backup time, so it is never used as the on-disk directory name — the remote key is used instead.
|
|
||||||
|
|
||||||
### Remote Key Derivation
|
|
||||||
|
|
||||||
The remote key is `hex(SHA256(SHA256("vaultik|" + snapshot-id)))`: a double SHA-256 over the snapshot ID, with a `vaultik|` domain-separation prefix. The result is a 64-character hex string with no structure a remote observer can reverse. Implemented in `internal/snapshot/remotekey.go`.
|
|
||||||
|
|
||||||
Worked example:
|
|
||||||
- Snapshot ID: `server1_home_2025-06-01T12:00:00Z`
|
|
||||||
- Remote key: `17f97bcde958748af076b926af59823943db59e80ce7170b40f124dfa28f64aa`
|
|
||||||
- Directory: `metadata/17f97bcde958748af076b926af59823943db59e80ce7170b40f124dfa28f64aa/`
|
|
||||||
|
|
||||||
Because the hash is one-way, a listing of the destination store reveals neither the hostname nor the snapshot name of any backup. The same remote key is stored in the manifest's `snapshot_id` field.
|
|
||||||
|
|
||||||
### Files in Each Snapshot Directory
|
### Files in Each Snapshot Directory
|
||||||
|
|
||||||
#### `db.zst.age` - Encrypted Database
|
#### `db.zst.age` - Encrypted Database
|
||||||
@@ -85,17 +68,16 @@ Because the hash is one-way, a listing of the destination store reveals neither
|
|||||||
- **Structure**:
|
- **Structure**:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"snapshot_id": "17f97bcde958748af076b926af59823943db59e80ce7170b40f124dfa28f64aa",
|
"snapshot_id": "laptop_home_2024-01-15T14:30:52Z",
|
||||||
"timestamp": "2025-06-01T12:00:00Z",
|
"timestamp": "2024-01-15T14:30:52Z",
|
||||||
"blob_count": 42,
|
"blob_count": 42,
|
||||||
"total_compressed_size": 1048576,
|
|
||||||
"blobs": [
|
"blobs": [
|
||||||
{ "hash": "cafebabe1234567890abcdef1234567890abcdef1234567890abcdef12345678", "compressed_size": 24576 },
|
"cafebabe1234567890abcdef1234567890abcdef1234567890abcdef12345678",
|
||||||
{ "hash": "deadbeef1234567890abcdef1234567890abcdef1234567890abcdef12345678", "compressed_size": 32768 }
|
"deadbeef1234567890abcdef1234567890abcdef1234567890abcdef12345678",
|
||||||
|
...
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
`snapshot_id` is the remote key (a hash), not the human ID; `timestamp` is written in the clear.
|
|
||||||
|
|
||||||
### Why Manifest is Unencrypted
|
### Why Manifest is Unencrypted
|
||||||
The manifest must be readable without the private key to enable:
|
The manifest must be readable without the private key to enable:
|
||||||
@@ -104,7 +86,7 @@ The manifest must be readable without the private key to enable:
|
|||||||
3. **Verification** - Checking blob existence without decryption
|
3. **Verification** - Checking blob existence without decryption
|
||||||
4. **Cross-snapshot deduplication analysis** - Finding shared blobs between snapshots
|
4. **Cross-snapshot deduplication analysis** - Finding shared blobs between snapshots
|
||||||
|
|
||||||
The manifest contains the remote key, the backup timestamp, the blob count and total compressed size, and each blob's hash and compressed size. It contains no file names, paths, or other decrypted metadata.
|
The manifest only contains blob hashes, not file names or any other sensitive information.
|
||||||
|
|
||||||
## Security Considerations
|
## Security Considerations
|
||||||
|
|
||||||
@@ -114,21 +96,19 @@ The manifest contains the remote key, the backup timestamp, the blob count and t
|
|||||||
- **File-to-chunk mappings** (in db.zst.age)
|
- **File-to-chunk mappings** (in db.zst.age)
|
||||||
|
|
||||||
### What's Not Encrypted
|
### What's Not Encrypted
|
||||||
- **The remote key** — directory names and the manifest `snapshot_id`, a one-way hash of the snapshot ID (see [Remote Key Derivation](#remote-key-derivation))
|
- **Blob hashes** (in manifest.json.zst)
|
||||||
- **The backup timestamp** (in manifest.json.zst)
|
- **Snapshot IDs** (directory names)
|
||||||
- **Blob hashes and their compressed sizes** (in manifest.json.zst)
|
- **Blob count per snapshot** (in manifest.json.zst)
|
||||||
- **Blob count and total compressed size per snapshot** (in manifest.json.zst)
|
|
||||||
|
|
||||||
### Privacy Implications
|
### Privacy Implications
|
||||||
From the unencrypted data, an observer of the destination store can determine:
|
From the unencrypted data, an observer can determine:
|
||||||
- **When each backup was taken** — not from the directory name, which is a one-way hash, but from the plaintext `timestamp` field in manifest.json.zst, which is published in the clear
|
- When backups were taken (from snapshot IDs)
|
||||||
- How many blobs each snapshot references, and the total compressed size
|
- Which hostname created backups (from snapshot IDs)
|
||||||
- The compressed size of each blob, and which blobs are shared between snapshots (deduplication patterns)
|
- How many blobs each snapshot references
|
||||||
|
- Which blobs are shared between snapshots (deduplication patterns)
|
||||||
Together these give an observer a timing-and-size profile of every snapshot. This is an accepted, documented property of the format, not a defect: the manifest is unencrypted so that pruning can run without the private key, and the timing channel could not be closed by encrypting it anyway — object creation times and per-object sizes stay visible at the storage layer on both `s3://` and `file://` destinations regardless.
|
- The size of each encrypted blob
|
||||||
|
|
||||||
An observer cannot determine:
|
An observer cannot determine:
|
||||||
- The hostname or snapshot name of any backup (the directory name and the manifest `snapshot_id` are one-way hashes of the human ID)
|
|
||||||
- File names or paths
|
- File names or paths
|
||||||
- File contents
|
- File contents
|
||||||
- File permissions or ownership
|
- File permissions or ownership
|
||||||
@@ -145,10 +125,10 @@ An observer cannot determine:
|
|||||||
## Pruning Safety
|
## Pruning Safety
|
||||||
|
|
||||||
The prune operation is safe because:
|
The prune operation is safe because:
|
||||||
1. It keeps every blob listed in any snapshot's manifest and deletes only blobs that no manifest references
|
1. It only deletes blobs not referenced in any manifest
|
||||||
2. Manifests are unencrypted and can be read without keys
|
2. Manifests are unencrypted and can be read without keys
|
||||||
3. If any manifest cannot be downloaded or decoded, prune deletes nothing and exits with an error, rather than treating that snapshot's blobs as unreferenced
|
3. The operation compares the latest local DB snapshot with the latest S3 snapshot to ensure consistency
|
||||||
4. Prune requires exclusive access to the destination: running it during a concurrent backup can race a snapshot whose manifest is not yet written, so do not prune while a backup is in progress
|
4. Pruning will fail if these don't match, preventing accidental deletion of needed blobs
|
||||||
|
|
||||||
## Restoration Requirements
|
## Restoration Requirements
|
||||||
|
|
||||||
|
|||||||
@@ -487,7 +487,7 @@ func (p *Packer) closeBlobWriter() (string, int64, error) {
|
|||||||
return "", 0, fmt.Errorf("seeking to start: %w", err)
|
return "", 0, fmt.Errorf("seeking to start: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
finalHash := p.currentBlob.writer.ContentID()
|
finalHash := p.currentBlob.writer.Sum256()
|
||||||
|
|
||||||
return hex.EncodeToString(finalHash), finalSize, nil
|
return hex.EncodeToString(finalHash), finalSize, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,89 @@
|
|||||||
|
// Package blobgen implements the blob data pipeline: streaming zstd
|
||||||
|
// compression, age encryption, and SHA256 content hashing for blob
|
||||||
|
// creation, plus the matching decrypt/decompress/verify reader.
|
||||||
|
package blobgen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/hex"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CompressResult contains the results of compression
|
||||||
|
type CompressResult struct {
|
||||||
|
Data []byte
|
||||||
|
UncompressedSize int64
|
||||||
|
CompressedSize int64
|
||||||
|
SHA256 string
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompressData compresses and encrypts data, returning the result with hash
|
||||||
|
func CompressData(
|
||||||
|
data []byte, compressionLevel int, recipients []string,
|
||||||
|
) (*CompressResult, error) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
// Create writer
|
||||||
|
w, err := NewWriter(&buf, compressionLevel, recipients)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("creating writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write data
|
||||||
|
_, err = w.Write(data)
|
||||||
|
if err != nil {
|
||||||
|
_ = w.Close()
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("writing data: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close to flush
|
||||||
|
err = w.Close()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("closing writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &CompressResult{
|
||||||
|
Data: buf.Bytes(),
|
||||||
|
UncompressedSize: int64(len(data)),
|
||||||
|
CompressedSize: int64(buf.Len()),
|
||||||
|
SHA256: hex.EncodeToString(w.Sum256()),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompressStream compresses and encrypts from reader to writer, returning
|
||||||
|
// the number of uncompressed bytes written and the content hash.
|
||||||
|
func CompressStream(
|
||||||
|
dst io.Writer, src io.Reader, compressionLevel int, recipients []string,
|
||||||
|
) (int64, string, error) {
|
||||||
|
// Create writer
|
||||||
|
w, err := NewWriter(dst, compressionLevel, recipients)
|
||||||
|
if err != nil {
|
||||||
|
return 0, "", fmt.Errorf("creating writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
closed := false
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
if !closed {
|
||||||
|
_ = w.Close()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Copy data
|
||||||
|
_, err = io.Copy(w, src)
|
||||||
|
if err != nil {
|
||||||
|
return 0, "", fmt.Errorf("copying data: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close to flush
|
||||||
|
err = w.Close()
|
||||||
|
if err != nil {
|
||||||
|
return 0, "", fmt.Errorf("closing writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
closed = true
|
||||||
|
|
||||||
|
return w.BytesWritten(), hex.EncodeToString(w.Sum256()), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,80 @@
|
|||||||
|
package blobgen_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/rand"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/vaultik/internal/blobgen"
|
||||||
|
)
|
||||||
|
|
||||||
|
// testRecipient is a static age recipient for tests.
|
||||||
|
const testRecipient = "age1cplgrwj77ta54dnmydvvmzn64ltk83ankxl5sww04mrtmu62kv3s89gmvv"
|
||||||
|
|
||||||
|
// TestCompressStreamNoDoubleClose is a regression test for issue #28.
|
||||||
|
// It verifies that CompressStream does not panic or return an error due to
|
||||||
|
// double-closing the underlying blobgen.Writer. Before the fix in PR #33,
|
||||||
|
// the explicit Close() on the happy path combined with defer Close() would
|
||||||
|
// cause a double close.
|
||||||
|
func TestCompressStreamNoDoubleClose(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
input := []byte("regression test data for issue #28 double-close fix")
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
written, hash, err := blobgen.CompressStream(
|
||||||
|
&buf, bytes.NewReader(input), 3, []string{testRecipient})
|
||||||
|
require.NoError(t, err, "CompressStream should not return an error")
|
||||||
|
assert.Positive(t, written, "expected bytes written > 0")
|
||||||
|
assert.NotEmpty(t, hash, "expected non-empty hash")
|
||||||
|
assert.Positive(t, buf.Len(), "expected non-empty output")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCompressStreamLargeInput exercises CompressStream with a larger payload
|
||||||
|
// to ensure no double-close issues surface under heavier I/O.
|
||||||
|
func TestCompressStreamLargeInput(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
data := make([]byte, 512*1024) // 512 KB
|
||||||
|
_, err := rand.Read(data)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
written, hash, err := blobgen.CompressStream(
|
||||||
|
&buf, bytes.NewReader(data), 3, []string{testRecipient})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Positive(t, written)
|
||||||
|
assert.NotEmpty(t, hash)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCompressStreamEmptyInput verifies CompressStream handles empty input
|
||||||
|
// without double-close issues.
|
||||||
|
func TestCompressStreamEmptyInput(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
_, hash, err := blobgen.CompressStream(
|
||||||
|
&buf, strings.NewReader(""), 3, []string{testRecipient})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.NotEmpty(t, hash)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCompressDataNoDoubleClose mirrors the stream test for CompressData,
|
||||||
|
// ensuring the explicit Close + error-path Close pattern is also safe.
|
||||||
|
func TestCompressDataNoDoubleClose(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
input := []byte("CompressData regression test for double-close")
|
||||||
|
|
||||||
|
result, err := blobgen.CompressData(input, 3, []string{testRecipient})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Positive(t, result.CompressedSize)
|
||||||
|
assert.Equal(t, result.UncompressedSize, int64(len(input)))
|
||||||
|
assert.NotEmpty(t, result.SHA256)
|
||||||
|
}
|
||||||
@@ -1,119 +0,0 @@
|
|||||||
package blobgen_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"crypto/rand"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ageChunkSize is age's STREAM plaintext chunk size (64 KiB); each encrypted
|
|
||||||
// chunk adds a 16-byte ChaCha20-Poly1305 tag.
|
|
||||||
const (
|
|
||||||
ageChunkSize = 64 * 1024
|
|
||||||
ageChunkTagSize = 16
|
|
||||||
ageSegmentSize = ageChunkSize + ageChunkTagSize
|
|
||||||
ageNonceSize = 16
|
|
||||||
)
|
|
||||||
|
|
||||||
// makeIdentity returns a fresh X25519 identity and its recipient string.
|
|
||||||
func makeIdentity(t *testing.T) (*age.X25519Identity, string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
id, err := age.GenerateX25519Identity()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
return id, id.Recipient().String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// randomBytes returns n cryptographically random bytes, which do not compress
|
|
||||||
// so the encrypted payload spans multiple age segments.
|
|
||||||
func randomBytes(t *testing.T, n int) []byte {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
b := make([]byte, n)
|
|
||||||
_, err := rand.Read(b)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
return b
|
|
||||||
}
|
|
||||||
|
|
||||||
// compressibleBytes returns n bytes of a repeating pattern, which zstd packs
|
|
||||||
// down to a small payload.
|
|
||||||
func compressibleBytes(n int) []byte {
|
|
||||||
pattern := bytes.Repeat([]byte("compressible-"), n/13+1)
|
|
||||||
|
|
||||||
return pattern[:n]
|
|
||||||
}
|
|
||||||
|
|
||||||
// encryptBlob compresses, encrypts and returns a blob for plaintext at
|
|
||||||
// compression level 1.
|
|
||||||
func encryptBlob(t *testing.T, plaintext []byte, recipients ...string) []byte {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
w, err := blobgen.NewWriter(&buf, 1, recipients)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
_, err = w.Write(plaintext)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, w.Close())
|
|
||||||
|
|
||||||
return buf.Bytes()
|
|
||||||
}
|
|
||||||
|
|
||||||
// ageHeaderLen returns the byte length of blob's age header, i.e. the offset
|
|
||||||
// of the 16-byte payload nonce that follows it. The header ends with a MAC
|
|
||||||
// line "--- <mac>\n"; the nonce begins right after that newline.
|
|
||||||
func ageHeaderLen(t *testing.T, blob []byte) int {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
i := bytes.Index(blob, []byte("\n--- "))
|
|
||||||
require.GreaterOrEqual(t, i, 0, "age MAC footer line not found")
|
|
||||||
|
|
||||||
nl := bytes.IndexByte(blob[i+1:], '\n')
|
|
||||||
require.GreaterOrEqual(t, nl, 0, "newline ending MAC line not found")
|
|
||||||
|
|
||||||
return i + 1 + nl + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
// requireBlobUnreadable asserts that data never decrypts to a plaintext with a
|
|
||||||
// nil error: either NewReader fails, or reading it does.
|
|
||||||
func requireBlobUnreadable(t *testing.T, data []byte, id age.Identity) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
r, err := blobgen.NewReader(bytes.NewReader(data), id)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = io.ReadAll(r)
|
|
||||||
_ = r.Close()
|
|
||||||
|
|
||||||
require.Error(t, err, "reading a damaged blob must fail")
|
|
||||||
}
|
|
||||||
|
|
||||||
// errFailWriter is returned by failAfterWriter once its byte limit is passed.
|
|
||||||
var errFailWriter = errors.New("destination write failed")
|
|
||||||
|
|
||||||
// failAfterWriter accepts writes until more than limit bytes have been sent,
|
|
||||||
// then fails every write. It models a destination that dies mid-blob.
|
|
||||||
type failAfterWriter struct {
|
|
||||||
limit int
|
|
||||||
written int
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *failAfterWriter) Write(p []byte) (int, error) {
|
|
||||||
f.written += len(p)
|
|
||||||
if f.written > f.limit {
|
|
||||||
return 0, errFailWriter
|
|
||||||
}
|
|
||||||
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
package blobgen
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrOutputTooLarge is returned by a reader from LimitReader once it has
|
|
||||||
// been asked for more than its limit. It bounds how far an untrusted
|
|
||||||
// compressed stream may expand, so a small, highly compressible object
|
|
||||||
// from the store cannot decompress without limit.
|
|
||||||
var ErrOutputTooLarge = errors.New("output exceeds size limit")
|
|
||||||
|
|
||||||
// LimitReader returns a reader that yields at most limit bytes from r and
|
|
||||||
// then fails with ErrOutputTooLarge. Unlike io.LimitReader, which reports
|
|
||||||
// a silent io.EOF at the limit (indistinguishable from a stream that
|
|
||||||
// simply ended), this fails, so a caller decoding or copying the stream
|
|
||||||
// sees an error rather than a truncated value. A stream of exactly limit
|
|
||||||
// bytes reads back cleanly to EOF; the first byte beyond it is the error.
|
|
||||||
func LimitReader(r io.Reader, limit int64) io.Reader {
|
|
||||||
// remaining counts down from limit+1: the extra byte is the one that,
|
|
||||||
// if it ever arrives, proves the stream is longer than the limit.
|
|
||||||
return &limitReader{r: r, remaining: limit + 1}
|
|
||||||
}
|
|
||||||
|
|
||||||
type limitReader struct {
|
|
||||||
r io.Reader
|
|
||||||
remaining int64
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l *limitReader) Read(p []byte) (int, error) {
|
|
||||||
if l.remaining <= 0 {
|
|
||||||
return 0, ErrOutputTooLarge
|
|
||||||
}
|
|
||||||
|
|
||||||
if int64(len(p)) > l.remaining {
|
|
||||||
p = p[:l.remaining]
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := l.r.Read(p)
|
|
||||||
l.remaining -= int64(n)
|
|
||||||
|
|
||||||
if l.remaining <= 0 {
|
|
||||||
// The (limit+1)th byte was just read: the stream is too long.
|
|
||||||
return n, ErrOutputTooLarge
|
|
||||||
}
|
|
||||||
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
package blobgen_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"io"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestLimitReaderPassesExactSize checks that a stream of exactly the limit
|
|
||||||
// reads back cleanly to EOF: the bound must not reject a legitimate blob
|
|
||||||
// whose plaintext equals its recorded size.
|
|
||||||
func TestLimitReaderPassesExactSize(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const n = 1000
|
|
||||||
|
|
||||||
r := blobgen.LimitReader(bytes.NewReader(bytes.Repeat([]byte("a"), n)), n)
|
|
||||||
|
|
||||||
got, err := io.ReadAll(r)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Len(t, got, n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLimitReaderFailsPastLimit feeds a large, highly compressible run of
|
|
||||||
// zeros — the decompressed output a zip bomb would produce — through a
|
|
||||||
// small limit and checks it fails within the bound rather than passing
|
|
||||||
// the whole stream through.
|
|
||||||
func TestLimitReaderFailsPastLimit(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const limit = 1000
|
|
||||||
|
|
||||||
r := blobgen.LimitReader(
|
|
||||||
bytes.NewReader(bytes.Repeat([]byte{0}, limit*1000)), limit)
|
|
||||||
|
|
||||||
n, err := io.Copy(io.Discard, r)
|
|
||||||
require.ErrorIs(t, err, blobgen.ErrOutputTooLarge)
|
|
||||||
require.LessOrEqual(t, n, int64(limit)+1,
|
|
||||||
"reader must stop within one byte of the limit")
|
|
||||||
}
|
|
||||||
@@ -1,190 +0,0 @@
|
|||||||
package blobgen_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestNewReaderWrongIdentity covers issue case 4: opening a blob with an
|
|
||||||
// identity other than the recipient reports no matching identity.
|
|
||||||
func TestNewReaderWrongIdentity(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, recipient := makeIdentity(t)
|
|
||||||
other, _ := makeIdentity(t)
|
|
||||||
|
|
||||||
blob := encryptBlob(t, []byte("secret payload"), recipient)
|
|
||||||
|
|
||||||
_, err := blobgen.NewReader(bytes.NewReader(blob), other)
|
|
||||||
require.Error(t, err)
|
|
||||||
|
|
||||||
var noMatch *age.NoIdentityMatchError
|
|
||||||
assert.ErrorAs(t, err, &noMatch)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewReaderTruncated covers issue case 6: a multi-segment blob cut at
|
|
||||||
// several points must never read back as valid data. The point immediately
|
|
||||||
// after the header and nonce is intentionally excluded: it reads as a valid
|
|
||||||
// empty blob today and is the regression case for
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/152.
|
|
||||||
func TestNewReaderTruncated(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
id, recipient := makeIdentity(t)
|
|
||||||
blob := encryptBlob(t, randomBytes(t, 4*65536+123), recipient)
|
|
||||||
h := ageHeaderLen(t, blob)
|
|
||||||
|
|
||||||
require.Greater(t, len(blob), h+ageNonceSize+ageSegmentSize,
|
|
||||||
"test needs a blob of at least two age segments")
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
size int
|
|
||||||
}{
|
|
||||||
{"inside header", h / 2},
|
|
||||||
{"inside nonce", h + 8},
|
|
||||||
{"inside first segment", h + ageNonceSize + 100},
|
|
||||||
{"end of first full segment", h + ageNonceSize + ageSegmentSize},
|
|
||||||
{"last byte removed", len(blob) - 1},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
requireBlobUnreadable(t, blob[:tc.size], id)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewReaderCorrupted covers issue case 7: one flipped byte in each region
|
|
||||||
// of a multi-segment blob makes it unreadable.
|
|
||||||
func TestNewReaderCorrupted(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
id, recipient := makeIdentity(t)
|
|
||||||
blob := encryptBlob(t, randomBytes(t, 4*65536+123), recipient)
|
|
||||||
h := ageHeaderLen(t, blob)
|
|
||||||
|
|
||||||
firstNL := bytes.IndexByte(blob, '\n')
|
|
||||||
require.Positive(t, firstNL, "header must have a version line")
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
pos int
|
|
||||||
}{
|
|
||||||
{"header stanza", firstNL + 5},
|
|
||||||
{"header MAC line", h - 2},
|
|
||||||
{"nonce", h + 4},
|
|
||||||
{"body segment", h + ageNonceSize + 50},
|
|
||||||
{"final tag", len(blob) - 1},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
corrupt := append([]byte(nil), blob...)
|
|
||||||
corrupt[tc.pos] ^= 0xff
|
|
||||||
requireBlobUnreadable(t, corrupt, id)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewReaderTrailingAndGarbage covers issue case 8: bytes appended after a
|
|
||||||
// valid blob, empty input, and random garbage each fail to read.
|
|
||||||
func TestNewReaderTrailingAndGarbage(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
id, recipient := makeIdentity(t)
|
|
||||||
|
|
||||||
valid := encryptBlob(t, []byte("small payload"), recipient)
|
|
||||||
appended := append(append([]byte(nil), valid...), []byte("trailing junk")...)
|
|
||||||
|
|
||||||
t.Run("appended bytes", func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
requireBlobUnreadable(t, appended, id)
|
|
||||||
})
|
|
||||||
t.Run("empty input", func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
requireBlobUnreadable(t, []byte{}, id)
|
|
||||||
})
|
|
||||||
t.Run("random garbage", func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
requireBlobUnreadable(t, randomBytes(t, 512), id)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewWriterInvalidLevel covers the rejected end of issue case 9: an
|
|
||||||
// out-of-range compression level errors and writes nothing to the destination.
|
|
||||||
func TestNewWriterInvalidLevel(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, recipient := makeIdentity(t)
|
|
||||||
|
|
||||||
for _, level := range []int{0, -1, 20} {
|
|
||||||
t.Run(fmt.Sprintf("level%d", level), func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
w, err := blobgen.NewWriter(&buf, level, []string{recipient})
|
|
||||||
require.ErrorIs(t, err, blobgen.ErrInvalidCompressionLevel)
|
|
||||||
assert.Nil(t, w)
|
|
||||||
assert.Zero(t, buf.Len(), "nothing written on an invalid level")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewWriterInvalidRecipients covers issue case 10: nil and empty recipient
|
|
||||||
// lists and an unparsable recipient string each error.
|
|
||||||
func TestNewWriterInvalidRecipients(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
recipients []string
|
|
||||||
}{
|
|
||||||
{"nil list", nil},
|
|
||||||
{"empty list", []string{}},
|
|
||||||
{"invalid recipient string", []string{"not-a-recipient"}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
w, err := blobgen.NewWriter(&buf, 1, tc.recipients)
|
|
||||||
require.Error(t, err)
|
|
||||||
assert.Nil(t, w)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewWriterFailingDestination covers issue case 11: a destination that
|
|
||||||
// fails mid-blob surfaces its error from Write or Close.
|
|
||||||
func TestNewWriterFailingDestination(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, recipient := makeIdentity(t)
|
|
||||||
|
|
||||||
// The limit clears the age header and nonce so NewWriter succeeds, then
|
|
||||||
// trips once the compressed body starts flowing.
|
|
||||||
dst := &failAfterWriter{limit: 512}
|
|
||||||
|
|
||||||
w, err := blobgen.NewWriter(dst, 1, []string{recipient})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
_, writeErr := w.Write(randomBytes(t, 256*1024))
|
|
||||||
closeErr := w.Close()
|
|
||||||
|
|
||||||
assert.True(t, writeErr != nil || closeErr != nil,
|
|
||||||
"destination failure must surface from Write or Close")
|
|
||||||
}
|
|
||||||
@@ -2,7 +2,6 @@ package blobgen
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"crypto/sha256"
|
"crypto/sha256"
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"hash"
|
"hash"
|
||||||
"io"
|
"io"
|
||||||
@@ -21,12 +20,10 @@ type Reader struct {
|
|||||||
bytesRead int64
|
bytesRead int64
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewReader creates a new Reader that decrypts, decompresses, and verifies
|
// NewReader creates a new Reader that decrypts, decompresses, and verifies data
|
||||||
// data. Every supplied identity is offered to age.Decrypt, so a blob
|
func NewReader(r io.Reader, identity age.Identity) (*Reader, error) {
|
||||||
// encrypted to any one of them can be read.
|
|
||||||
func NewReader(r io.Reader, identities ...age.Identity) (*Reader, error) {
|
|
||||||
// Create decryption reader
|
// Create decryption reader
|
||||||
decReader, err := age.Decrypt(r, identities...)
|
decReader, err := age.Decrypt(r, identity)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("creating decryption reader: %w", err)
|
return nil, fmt.Errorf("creating decryption reader: %w", err)
|
||||||
}
|
}
|
||||||
@@ -57,22 +54,6 @@ func (r *Reader) Read(p []byte) (int, error) {
|
|||||||
n, err := r.teeReader.Read(p)
|
n, err := r.teeReader.Read(p)
|
||||||
r.bytesRead += int64(n)
|
r.bytesRead += int64(n)
|
||||||
|
|
||||||
// When the ciphertext is cut right after the age header plus its
|
|
||||||
// 16-byte nonce, the age reader's first read fails with
|
|
||||||
// io.ErrUnexpectedEOF, and the zstd decoder maps that to a clean
|
|
||||||
// io.EOF at frame start. That makes a truncated stream look like a
|
|
||||||
// valid empty one. Distinguish the two: on EOF, read once more from
|
|
||||||
// the age reader. A genuine end leaves it at (0, io.EOF); a truncated
|
|
||||||
// stream leaves its stored io.ErrUnexpectedEOF, which we surface.
|
|
||||||
if errors.Is(err, io.EOF) {
|
|
||||||
var probe [1]byte
|
|
||||||
|
|
||||||
m, ageErr := r.decryptor.Read(probe[:])
|
|
||||||
if m != 0 || !errors.Is(ageErr, io.EOF) {
|
|
||||||
return n, io.ErrUnexpectedEOF
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return n, err
|
return n, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -83,9 +64,7 @@ func (r *Reader) Close() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sum256 returns the single SHA-256 of the plaintext read so far. This is the
|
// Sum256 returns the SHA256 hash of all data read
|
||||||
// first hash only; the stored object name is its double hash, which callers
|
|
||||||
// obtain by passing this digest to DoubleSHA256.
|
|
||||||
func (r *Reader) Sum256() []byte {
|
func (r *Reader) Sum256() []byte {
|
||||||
return r.hasher.Sum(nil)
|
return r.hasher.Sum(nil)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,54 +0,0 @@
|
|||||||
package blobgen_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"io"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestMultipleRecipients verifies that data written for several recipients can
|
|
||||||
// be read back by each recipient's identity. Moved from internal/crypto, which
|
|
||||||
// held the only multi-recipient test; blobgen is now the sole encryption path.
|
|
||||||
func TestMultipleRecipients(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
identities := make([]*age.X25519Identity, 3)
|
|
||||||
recipients := make([]string, 3)
|
|
||||||
|
|
||||||
for i := range identities {
|
|
||||||
identity, err := age.GenerateX25519Identity()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
identities[i] = identity
|
|
||||||
recipients[i] = identity.Recipient().String()
|
|
||||||
}
|
|
||||||
|
|
||||||
plaintext := []byte("Secret message for multiple recipients")
|
|
||||||
|
|
||||||
var encrypted bytes.Buffer
|
|
||||||
|
|
||||||
writer, err := blobgen.NewWriter(&encrypted, 3, recipients)
|
|
||||||
require.NoError(t, err)
|
|
||||||
_, err = writer.Write(plaintext)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, writer.Close())
|
|
||||||
|
|
||||||
// Every recipient's identity must recover the original plaintext.
|
|
||||||
for i, identity := range identities {
|
|
||||||
reader, err := blobgen.NewReader(
|
|
||||||
bytes.NewReader(encrypted.Bytes()), identity)
|
|
||||||
require.NoError(t, err, "recipient %d should open the reader", i+1)
|
|
||||||
|
|
||||||
got, err := io.ReadAll(reader)
|
|
||||||
require.NoError(t, err, "recipient %d should read the plaintext", i+1)
|
|
||||||
require.NoError(t, reader.Close())
|
|
||||||
|
|
||||||
assert.Equal(t, plaintext, got,
|
|
||||||
"recipient %d should recover the original plaintext", i+1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,132 +0,0 @@
|
|||||||
package blobgen_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"crypto/sha256"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// checkRoundTrip writes input through a Writer, reads it back through a Reader,
|
|
||||||
// and verifies the plaintext, the byte counts, and the content hashes.
|
|
||||||
func checkRoundTrip(
|
|
||||||
t *testing.T, id *age.X25519Identity, recipient string,
|
|
||||||
level int, input []byte,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
w, err := blobgen.NewWriter(&buf, level, []string{recipient})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
n, err := w.Write(input)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, len(input), n)
|
|
||||||
require.NoError(t, w.Close())
|
|
||||||
require.Equal(t, int64(len(input)), w.BytesWritten())
|
|
||||||
|
|
||||||
r, err := blobgen.NewReader(bytes.NewReader(buf.Bytes()), id)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
got, err := io.ReadAll(r)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, r.Close())
|
|
||||||
|
|
||||||
assert.Equal(t, input, got, "decrypted output must equal input")
|
|
||||||
require.Equal(t, int64(len(input)), r.BytesRead())
|
|
||||||
|
|
||||||
// The hash values are checked by decrypting: the reader's single SHA-256
|
|
||||||
// is the hash of the plaintext, and hashing it once more (DoubleSHA256)
|
|
||||||
// gives the writer's ContentID.
|
|
||||||
single := sha256.Sum256(got)
|
|
||||||
assert.Equal(t, single[:], r.Sum256())
|
|
||||||
assert.Equal(t, blobgen.DoubleSHA256(r.Sum256()), w.ContentID())
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWriterReaderRoundTrip covers issue cases 1 and 2: every size round trips
|
|
||||||
// for both random and compressible data, and the reader hash, its double hash
|
|
||||||
// and the byte counts all agree.
|
|
||||||
func TestWriterReaderRoundTrip(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
id, recipient := makeIdentity(t)
|
|
||||||
|
|
||||||
// Sizes exercise the age segment boundary (64 KiB) from just below to a
|
|
||||||
// few segments above it, plus the empty and single-byte edges.
|
|
||||||
sizes := []int{0, 1, 65535, 65536, 65537, 4*65536 + 123}
|
|
||||||
|
|
||||||
kinds := []struct {
|
|
||||||
name string
|
|
||||||
fill func(*testing.T, int) []byte
|
|
||||||
}{
|
|
||||||
{"random", randomBytes},
|
|
||||||
{"compressible", func(_ *testing.T, n int) []byte {
|
|
||||||
return compressibleBytes(n)
|
|
||||||
}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, k := range kinds {
|
|
||||||
for _, size := range sizes {
|
|
||||||
name := fmt.Sprintf("%s/%d", k.name, size)
|
|
||||||
t.Run(name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
checkRoundTrip(t, id, recipient, 1, k.fill(t, size))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestZeroLengthNoWrite covers issue case 3: a Writer closed with no Write at
|
|
||||||
// all produces the double hash of the empty input, and the blob reads back as
|
|
||||||
// empty with no error.
|
|
||||||
func TestZeroLengthNoWrite(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
id, recipient := makeIdentity(t)
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
w, err := blobgen.NewWriter(&buf, 1, []string{recipient})
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, w.Close())
|
|
||||||
assert.Equal(t, int64(0), w.BytesWritten())
|
|
||||||
|
|
||||||
empty := sha256.Sum256(nil)
|
|
||||||
doubled := sha256.Sum256(empty[:])
|
|
||||||
assert.Equal(t, doubled[:], w.ContentID(),
|
|
||||||
"ContentID of empty input is SHA256(SHA256(\"\"))")
|
|
||||||
|
|
||||||
r, err := blobgen.NewReader(bytes.NewReader(buf.Bytes()), id)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
got, err := io.ReadAll(r)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, r.Close())
|
|
||||||
|
|
||||||
assert.Empty(t, got, "empty blob decrypts to empty output")
|
|
||||||
assert.Equal(t, int64(0), r.BytesRead())
|
|
||||||
assert.Equal(t, empty[:], r.Sum256())
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewWriterValidLevelsRoundTrip covers the accepted end of issue case 9:
|
|
||||||
// the boundary compression levels 1 and 19 both round trip.
|
|
||||||
func TestNewWriterValidLevelsRoundTrip(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
id, recipient := makeIdentity(t)
|
|
||||||
input := randomBytes(t, 4096)
|
|
||||||
|
|
||||||
for _, level := range []int{1, 19} {
|
|
||||||
t.Run(fmt.Sprintf("level%d", level), func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
checkRoundTrip(t, id, recipient, level, input)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
package blobgen_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"io"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestReaderRejectsHeaderNonceTruncation guards against a stream cut right
|
|
||||||
// after the age header plus its 16-byte nonce. age.Decrypt still succeeds on
|
|
||||||
// such an object, and the zstd decoder maps the age reader's
|
|
||||||
// io.ErrUnexpectedEOF to a clean io.EOF at frame start, so without the extra
|
|
||||||
// check the truncated stream would read as a valid empty one. Reading it must
|
|
||||||
// now fail.
|
|
||||||
func TestReaderRejectsHeaderNonceTruncation(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
identity, err := age.GenerateX25519Identity()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Encrypting empty plaintext yields header + nonce(16) + a single
|
|
||||||
// 16-byte final chunk tag. Dropping the trailing tag leaves exactly the
|
|
||||||
// age header plus its nonce — the truncation point that triggers the bug.
|
|
||||||
var full bytes.Buffer
|
|
||||||
|
|
||||||
w, err := age.Encrypt(&full, identity.Recipient())
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, w.Close())
|
|
||||||
|
|
||||||
truncated := full.Bytes()[:full.Len()-16]
|
|
||||||
|
|
||||||
reader, err := blobgen.NewReader(bytes.NewReader(truncated), identity)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = reader.Close() }()
|
|
||||||
|
|
||||||
_, err = io.ReadAll(reader)
|
|
||||||
require.Error(t, err)
|
|
||||||
require.ErrorIs(t, err, io.ErrUnexpectedEOF)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestReaderReadsGenuinelyEmptyBlob confirms the truncation check does not
|
|
||||||
// reject a legitimately empty payload: a blob written with no data must round
|
|
||||||
// trip back to zero bytes with no error.
|
|
||||||
func TestReaderReadsGenuinelyEmptyBlob(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
identity, err := age.GenerateX25519Identity()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
var encrypted bytes.Buffer
|
|
||||||
|
|
||||||
writer, err := blobgen.NewWriter(
|
|
||||||
&encrypted, 3, []string{identity.Recipient().String()})
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, writer.Close())
|
|
||||||
|
|
||||||
reader, err := blobgen.NewReader(bytes.NewReader(encrypted.Bytes()), identity)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = reader.Close() }()
|
|
||||||
|
|
||||||
data, err := io.ReadAll(reader)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Empty(t, data)
|
|
||||||
}
|
|
||||||
+13
-30
@@ -1,6 +1,3 @@
|
|||||||
// Package blobgen implements the blob data pipeline: streaming zstd
|
|
||||||
// compression, age encryption, and SHA256 content hashing for blob
|
|
||||||
// creation, plus the matching decrypt/decompress/verify reader.
|
|
||||||
package blobgen
|
package blobgen
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -15,18 +12,6 @@ import (
|
|||||||
"github.com/klauspost/compress/zstd"
|
"github.com/klauspost/compress/zstd"
|
||||||
)
|
)
|
||||||
|
|
||||||
// DoubleSHA256 returns the double SHA-256 of content whose single SHA-256
|
|
||||||
// digest is sum: it hashes that digest once more. Stored objects are named by
|
|
||||||
// this second hash so that a name never reveals whether known content is
|
|
||||||
// present — an attacker who knows a plaintext, and thus its SHA-256, still
|
|
||||||
// cannot derive the stored name without hashing the digest again. Both a blob
|
|
||||||
// and the metadata database export are named this way.
|
|
||||||
func DoubleSHA256(sum []byte) []byte {
|
|
||||||
h := sha256.Sum256(sum)
|
|
||||||
|
|
||||||
return h[:]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Zstd compression level bounds accepted by NewWriter.
|
// Zstd compression level bounds accepted by NewWriter.
|
||||||
const (
|
const (
|
||||||
minCompressionLevel = 1
|
minCompressionLevel = 1
|
||||||
@@ -42,11 +27,6 @@ const reservedCompressionCPUs = 2
|
|||||||
var ErrInvalidCompressionLevel = errors.New(
|
var ErrInvalidCompressionLevel = errors.New(
|
||||||
"invalid compression level: must be between 1 and 19")
|
"invalid compression level: must be between 1 and 19")
|
||||||
|
|
||||||
// errInvalidRecipient is returned when a recipient string does not parse as
|
|
||||||
// an X25519 age1... public key. It omits the value, which can be sensitive.
|
|
||||||
var errInvalidRecipient = errors.New(
|
|
||||||
"not a valid X25519 age1... recipient")
|
|
||||||
|
|
||||||
// Writer wraps compression and encryption with SHA256 hashing.
|
// Writer wraps compression and encryption with SHA256 hashing.
|
||||||
// Data flows: input -> tee(hasher, compressor -> encryptor -> destination)
|
// Data flows: input -> tee(hasher, compressor -> encryptor -> destination)
|
||||||
// The hash is computed on the uncompressed input for deterministic content-addressing.
|
// The hash is computed on the uncompressed input for deterministic content-addressing.
|
||||||
@@ -77,12 +57,10 @@ func NewWriter(
|
|||||||
// Parse recipients
|
// Parse recipients
|
||||||
var ageRecipients []age.Recipient
|
var ageRecipients []age.Recipient
|
||||||
|
|
||||||
for i, recipient := range recipients {
|
for _, recipient := range recipients {
|
||||||
// The recipient string can be sensitive (e.g. a secret key pasted by
|
|
||||||
// mistake), so the error names its position, never its value.
|
|
||||||
r, err := age.ParseX25519Recipient(recipient)
|
r, err := age.ParseX25519Recipient(recipient)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("%w: recipient %d", errInvalidRecipient, i)
|
return nil, fmt.Errorf("parsing recipient %s: %w", recipient, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
ageRecipients = append(ageRecipients, r)
|
ageRecipients = append(ageRecipients, r)
|
||||||
@@ -145,12 +123,17 @@ func (w *Writer) Close() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ContentID returns the double SHA-256 of the uncompressed input data: the
|
// Sum256 returns the double SHA256 hash of the uncompressed input data.
|
||||||
// name under which this content is stored. It is the second hash of the
|
// Double hashing (SHA256(SHA256(data))) prevents information leakage about
|
||||||
// running SHA-256, via DoubleSHA256; see that function for why content is
|
// the plaintext - an attacker cannot confirm existence of known content
|
||||||
// named this way rather than by its plain SHA-256.
|
// by computing its hash and checking for a matching blob filename.
|
||||||
func (w *Writer) ContentID() []byte {
|
func (w *Writer) Sum256() []byte {
|
||||||
return DoubleSHA256(w.hasher.Sum(nil))
|
// First hash: SHA256(plaintext)
|
||||||
|
firstHash := w.hasher.Sum(nil)
|
||||||
|
// Second hash: SHA256(firstHash) - this is the blob ID
|
||||||
|
secondHash := sha256.Sum256(firstHash)
|
||||||
|
|
||||||
|
return secondHash[:]
|
||||||
}
|
}
|
||||||
|
|
||||||
// BytesWritten returns the number of uncompressed bytes written
|
// BytesWritten returns the number of uncompressed bytes written
|
||||||
|
|||||||
@@ -12,10 +12,9 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
"sneak.berlin/go/vaultik/internal/blobgen"
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestWriterHashIsDoubleHash verifies that Writer.ContentID() returns
|
// TestWriterHashIsDoubleHash verifies that Writer.Sum256() returns
|
||||||
// SHA256(SHA256(plaintext)). Stored objects are named by this second hash so a
|
// the double hash SHA256(SHA256(plaintext)) for security.
|
||||||
// name is not the plaintext's own SHA-256; this does not stop someone who
|
// Double hashing prevents attackers from confirming existence of known content.
|
||||||
// already holds the plaintext from confirming it.
|
|
||||||
func TestWriterHashIsDoubleHash(t *testing.T) {
|
func TestWriterHashIsDoubleHash(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -44,7 +43,7 @@ func TestWriterHashIsDoubleHash(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Get the hash from the writer
|
// Get the hash from the writer
|
||||||
writerHash := hex.EncodeToString(writer.ContentID())
|
writerHash := hex.EncodeToString(writer.Sum256())
|
||||||
|
|
||||||
// Calculate the expected double hash: SHA256(SHA256(plaintext))
|
// Calculate the expected double hash: SHA256(SHA256(plaintext))
|
||||||
firstHash := sha256.Sum256(testData)
|
firstHash := sha256.Sum256(testData)
|
||||||
@@ -61,11 +60,11 @@ func TestWriterHashIsDoubleHash(t *testing.T) {
|
|||||||
|
|
||||||
// The writer hash should match the double hash
|
// The writer hash should match the double hash
|
||||||
assert.Equal(t, expectedDoubleHash, writerHash,
|
assert.Equal(t, expectedDoubleHash, writerHash,
|
||||||
"Writer.ContentID() must be SHA256(SHA256(plaintext))")
|
"Writer.Sum256() should return SHA256(SHA256(plaintext)) for security")
|
||||||
|
|
||||||
// It must be the second hash, not the plaintext's own SHA-256.
|
// Verify it's NOT the single hash (would leak information)
|
||||||
assert.NotEqual(t, singleHashStr, writerHash,
|
assert.NotEqual(t, singleHashStr, writerHash,
|
||||||
"Writer hash must be the double hash, not the single SHA-256")
|
"Writer hash should not be single hash (would allow content confirmation attacks)")
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestWriterDeterministicHash verifies that the same input always produces
|
// TestWriterDeterministicHash verifies that the same input always produces
|
||||||
@@ -94,8 +93,8 @@ func TestWriterDeterministicHash(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, writer2.Close())
|
require.NoError(t, writer2.Close())
|
||||||
|
|
||||||
hash1 := hex.EncodeToString(writer1.ContentID())
|
hash1 := hex.EncodeToString(writer1.Sum256())
|
||||||
hash2 := hex.EncodeToString(writer2.ContentID())
|
hash2 := hex.EncodeToString(writer2.Sum256())
|
||||||
|
|
||||||
// Hashes should be identical (deterministic)
|
// Hashes should be identical (deterministic)
|
||||||
assert.Equal(t, hash1, hash2, "Same input should produce same hash")
|
assert.Equal(t, hash1, hash2, "Same input should produce same hash")
|
||||||
@@ -109,20 +108,3 @@ func TestWriterDeterministicHash(t *testing.T) {
|
|||||||
t.Logf("Encrypted size 1: %d bytes", buf1.Len())
|
t.Logf("Encrypted size 1: %d bytes", buf1.Len())
|
||||||
t.Logf("Encrypted size 2: %d bytes", buf2.Len())
|
t.Logf("Encrypted size 2: %d bytes", buf2.Len())
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestNewWriterSecretKeyNotEchoed verifies that a secret key mistakenly passed
|
|
||||||
// as a recipient does not appear in the returned error. A recipient string can
|
|
||||||
// be sensitive, so the error must name only the position, not the value.
|
|
||||||
func TestNewWriterSecretKeyNotEchoed(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
secretKey := "AGE-SECRET-KEY-19CR5YSFW59HM4TLD6GX" +
|
|
||||||
"VEDMZFTVVF7PPHKUT68TXSFPK7APHXA2QS2NJA5"
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
_, err := blobgen.NewWriter(&buf, 3, []string{secretKey})
|
|
||||||
require.Error(t, err)
|
|
||||||
assert.NotContains(t, err.Error(), secretKey,
|
|
||||||
"error must not echo the recipient value")
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -33,10 +33,9 @@ type Chunker struct {
|
|||||||
maxChunkSize int
|
maxChunkSize int
|
||||||
}
|
}
|
||||||
|
|
||||||
// ChunkSizeSpread is the FastCDC-recommended factor between the average
|
// chunkSizeSpread is the FastCDC-recommended factor between the average
|
||||||
// chunk size and the minimum (avg/spread) and maximum (avg*spread) sizes.
|
// chunk size and the minimum (avg/spread) and maximum (avg*spread) sizes.
|
||||||
// The largest chunk the chunker can emit is therefore avg*ChunkSizeSpread.
|
const chunkSizeSpread = 4
|
||||||
const ChunkSizeSpread = 4
|
|
||||||
|
|
||||||
// NewChunker creates a new chunker with the specified average chunk size.
|
// NewChunker creates a new chunker with the specified average chunk size.
|
||||||
// The actual chunk sizes will vary between avgChunkSize/4 and avgChunkSize*4
|
// The actual chunk sizes will vary between avgChunkSize/4 and avgChunkSize*4
|
||||||
@@ -46,8 +45,8 @@ func NewChunker(avgChunkSize int64) *Chunker {
|
|||||||
// FastCDC recommends min = avg/4 and max = avg*4
|
// FastCDC recommends min = avg/4 and max = avg*4
|
||||||
return &Chunker{
|
return &Chunker{
|
||||||
avgChunkSize: int(avgChunkSize),
|
avgChunkSize: int(avgChunkSize),
|
||||||
minChunkSize: int(avgChunkSize / ChunkSizeSpread),
|
minChunkSize: int(avgChunkSize / chunkSizeSpread),
|
||||||
maxChunkSize: int(avgChunkSize * ChunkSizeSpread),
|
maxChunkSize: int(avgChunkSize * chunkSizeSpread),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+104
-192
@@ -7,9 +7,11 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/signal"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/adrg/xdg"
|
"github.com/adrg/xdg"
|
||||||
@@ -30,33 +32,14 @@ import (
|
|||||||
// may take before we give up.
|
// may take before we give up.
|
||||||
const shutdownTimeout = 30 * time.Second
|
const shutdownTimeout = 30 * time.Second
|
||||||
|
|
||||||
// lockMode says whether a command mutates persistent state — the local
|
// AppOptions contains common options for creating the fx application.
|
||||||
// index database or the remote store — and so must hold the process-wide
|
// It includes the configuration file path, logging options, and additional
|
||||||
// PID lock, or only reads that state and may run alongside a mutator.
|
// fx modules and invocations that should be included in the application.
|
||||||
type lockMode int
|
|
||||||
|
|
||||||
const (
|
|
||||||
// mutating commands (snapshot create, snapshot purge, snapshot remove,
|
|
||||||
// prune, remote nuke) write the local index or the remote store. They
|
|
||||||
// hold the PID lock so that at most one runs at a time.
|
|
||||||
mutating lockMode = iota
|
|
||||||
// readOnly commands (info, snapshot list, snapshot verify, remote info,
|
|
||||||
// snapshot restore) do not write the local index or the remote store,
|
|
||||||
// so they run without the lock and are never blocked by a running
|
|
||||||
// mutator. restore writes only to the target directory it is given.
|
|
||||||
readOnly
|
|
||||||
)
|
|
||||||
|
|
||||||
// AppOptions contains common options for creating and running the fx
|
|
||||||
// application: the configuration file path, logging options, additional fx
|
|
||||||
// modules and invocations, and whether the command mutates persistent
|
|
||||||
// state (which decides whether it takes the PID lock).
|
|
||||||
type AppOptions struct {
|
type AppOptions struct {
|
||||||
ConfigPath string
|
ConfigPath string
|
||||||
LogOptions log.Options
|
LogOptions log.Options
|
||||||
Modules []fx.Option
|
Modules []fx.Option
|
||||||
Invokes []fx.Option
|
Invokes []fx.Option
|
||||||
Mode lockMode
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// setupGlobals records the startup time and, when an output-suppression
|
// setupGlobals records the startup time and, when an output-suppression
|
||||||
@@ -65,11 +48,6 @@ type AppOptions struct {
|
|||||||
// silenced — per the documented convention that --quiet suppresses
|
// silenced — per the documented convention that --quiet suppresses
|
||||||
// non-error output only. The startup banner is printed by Entry
|
// non-error output only. The startup banner is printed by Entry
|
||||||
// before cobra parses arguments, gated by the same arg-level check.
|
// before cobra parses arguments, gated by the same arg-level check.
|
||||||
//
|
|
||||||
// --json quiets the UI here too, because stdout then carries a JSON
|
|
||||||
// document and human narration would corrupt it. Unlike Quiet it does
|
|
||||||
// not lower the stderr log level (issue #112), so --verbose/--debug
|
|
||||||
// still surface diagnostics alongside the document.
|
|
||||||
func setupGlobals(
|
func setupGlobals(
|
||||||
lc fx.Lifecycle, g *globals.Globals, v *vaultik.Vaultik, opts log.Options,
|
lc fx.Lifecycle, g *globals.Globals, v *vaultik.Vaultik, opts log.Options,
|
||||||
) {
|
) {
|
||||||
@@ -77,7 +55,7 @@ func setupGlobals(
|
|||||||
OnStart: func(_ context.Context) error {
|
OnStart: func(_ context.Context) error {
|
||||||
g.StartTime = time.Now().UTC()
|
g.StartTime = time.Now().UTC()
|
||||||
|
|
||||||
if opts.Cron || opts.Quiet || opts.JSON {
|
if opts.Cron || opts.Quiet {
|
||||||
v.UI.SetQuiet(true)
|
v.UI.SetQuiet(true)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -158,148 +136,75 @@ func cleanStartupError(err error) error {
|
|||||||
return &startupError{msg: msg}
|
return &startupError{msg: msg}
|
||||||
}
|
}
|
||||||
|
|
||||||
// RunApp starts the fx application, blocks until it is asked to stop, and
|
// RunApp starts and stops the fx application within the given context.
|
||||||
// then stops it. The app is asked to stop either by an OS interrupt
|
// It handles graceful shutdown on interrupt signals (SIGINT, SIGTERM) and
|
||||||
// (SIGINT/SIGTERM — fx installs its own handler when app.Wait is called) or,
|
// ensures the application stops cleanly. The function blocks until the
|
||||||
// on normal completion, by the finished operation calling
|
// application completes or is interrupted. Returns an error if startup fails.
|
||||||
// Shutdowner.Shutdown(); both arrive on the app.Wait channel.
|
|
||||||
//
|
|
||||||
// Stopping runs the fx OnStop hooks, and RunApp does not return until Stop
|
|
||||||
// returns. On an interrupt the operation's OnStop hook cancels the running
|
|
||||||
// command and waits for it to unwind — removing its decrypted scratch files —
|
|
||||||
// so the process cannot proceed to exit mid-cleanup (issue #159). Waiting for
|
|
||||||
// Stop before returning is what makes that hook effective: routing the
|
|
||||||
// interrupt through app.Stop and not returning until it completes is required,
|
|
||||||
// because fx also fires the app.Wait channel on the signal, and an earlier
|
|
||||||
// version returned on that alone — unwinding to os.Exit while the concurrent
|
|
||||||
// cleanup still ran. The stop is bounded by shutdownTimeout. Returns an error
|
|
||||||
// if startup fails.
|
|
||||||
func RunApp(ctx context.Context, app *fx.App) error {
|
func RunApp(ctx context.Context, app *fx.App) error {
|
||||||
|
// Set up signal handling for graceful shutdown
|
||||||
|
sigChan := make(chan os.Signal, 1)
|
||||||
|
signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM)
|
||||||
|
|
||||||
|
// Create a context that will be cancelled on signal
|
||||||
|
ctx, cancel := context.WithCancel(ctx)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
// Start the app
|
||||||
err := app.Start(ctx)
|
err := app.Start(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return cleanStartupError(err)
|
return cleanStartupError(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Block until an interrupt or the finished operation's
|
// Handle shutdown
|
||||||
// Shutdowner.Shutdown() arrives, then stop the app in this goroutine so we
|
shutdownComplete := make(chan struct{})
|
||||||
// return only after its OnStop hooks — including the operation's cleanup
|
|
||||||
// wait — have run. Detach the stop from ctx's cancellation but keep its
|
|
||||||
// values, and bound it by shutdownTimeout.
|
|
||||||
<-app.Wait()
|
|
||||||
|
|
||||||
shutdownCtx, cancel := context.WithTimeout(
|
go func() {
|
||||||
|
defer close(shutdownComplete)
|
||||||
|
|
||||||
|
<-sigChan
|
||||||
|
log.Notice("Received interrupt signal, shutting down gracefully...")
|
||||||
|
|
||||||
|
// Create a timeout context for shutdown. The parent ctx is being
|
||||||
|
// cancelled, so detach from its cancellation but keep its values.
|
||||||
|
shutdownCtx, shutdownCancel := context.WithTimeout(
|
||||||
context.WithoutCancel(ctx), shutdownTimeout)
|
context.WithoutCancel(ctx), shutdownTimeout)
|
||||||
defer cancel()
|
defer shutdownCancel()
|
||||||
|
|
||||||
err = app.Stop(shutdownCtx)
|
err := app.Stop(shutdownCtx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Error("Error during shutdown", "error", err)
|
log.Error("Error during shutdown", "error", err)
|
||||||
}
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Wait for the signal handler to complete shutdown or the app to
|
||||||
|
// request shutdown.
|
||||||
|
select {
|
||||||
|
case <-shutdownComplete:
|
||||||
|
// Shutdown completed via signal
|
||||||
return nil
|
return nil
|
||||||
}
|
case <-ctx.Done():
|
||||||
|
// Context cancelled (shouldn't happen in normal operation)
|
||||||
// errReported marks a failure the operation has already shown the user
|
err := app.Stop(context.WithoutCancel(ctx))
|
||||||
// (and deliberately withheld under --json). Entry turns it into a
|
|
||||||
// non-zero exit status without printing anything further, so the error
|
|
||||||
// line is not doubled. It flows up from RunOperation through cobra to
|
|
||||||
// Entry.
|
|
||||||
var errReported = errors.New("operation failed")
|
|
||||||
|
|
||||||
// RunOperation runs op against the Vaultik instance inside the fx app
|
|
||||||
// and turns a failure into a returned error rather than an os.Exit from
|
|
||||||
// within the goroutine. An os.Exit there skipped main's deferred
|
|
||||||
// profile writers -- so profiling a failing command yielded a truncated
|
|
||||||
// profile (issue #75) -- and RunWithApp's PID-lock release, and denied
|
|
||||||
// the app any graceful shutdown; returning the error to the top runs
|
|
||||||
// all three.
|
|
||||||
//
|
|
||||||
// op runs in a goroutine so OnStart returns promptly and an interrupt
|
|
||||||
// can still cancel through OnStop; when it finishes, success or failure,
|
|
||||||
// it triggers shutdown, which is what lets RunWithApp return. On an
|
|
||||||
// interrupt OnStop cancels op and waits for the goroutine to return, so
|
|
||||||
// op's cleanup (removing decrypted scratch files) runs before the
|
|
||||||
// process exits; the wait is bounded by shutdownTimeout. report is
|
|
||||||
// called with a non-canceled failure so the caller can log it (and
|
|
||||||
// suppress it under --json) before it becomes errReported. A context
|
|
||||||
// cancellation is the interrupt path, not a failure: it is neither
|
|
||||||
// reported nor counted as one.
|
|
||||||
func RunOperation(
|
|
||||||
ctx context.Context, opts AppOptions,
|
|
||||||
op func(v *vaultik.Vaultik) error, report func(err error),
|
|
||||||
) error {
|
|
||||||
var (
|
|
||||||
mu sync.Mutex
|
|
||||||
failed bool
|
|
||||||
)
|
|
||||||
|
|
||||||
opts.Invokes = append(opts.Invokes,
|
|
||||||
fx.Invoke(func(v *vaultik.Vaultik, lc fx.Lifecycle) {
|
|
||||||
var stop func(context.Context) bool
|
|
||||||
|
|
||||||
lc.Append(fx.Hook{
|
|
||||||
OnStart: func(_ context.Context) error {
|
|
||||||
stop = v.StartOperation(func() {
|
|
||||||
err := op(v)
|
|
||||||
if err != nil && !errors.Is(err, context.Canceled) {
|
|
||||||
report(err)
|
|
||||||
|
|
||||||
mu.Lock()
|
|
||||||
failed = true
|
|
||||||
mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
stopErr := v.Shutdowner.Shutdown()
|
|
||||||
if stopErr != nil {
|
|
||||||
log.Error("Failed to shutdown", "error", stopErr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
// On an interrupt, cancel the operation and wait for it to
|
|
||||||
// unwind so its cleanup defers (which remove decrypted
|
|
||||||
// scratch files from the temp directory) run before the
|
|
||||||
// process exits. The wait is bounded by ctx, the existing
|
|
||||||
// shutdownTimeout.
|
|
||||||
OnStop: func(ctx context.Context) error {
|
|
||||||
if !stop(ctx) {
|
|
||||||
log.Warn("Shutdown timed out before the operation " +
|
|
||||||
"finished; decrypted temporary files may remain")
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
})
|
|
||||||
}))
|
|
||||||
|
|
||||||
err := RunWithApp(ctx, opts)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
log.Error("Error stopping app", "error", err)
|
||||||
}
|
|
||||||
|
|
||||||
// The goroutine sets failed before triggering the shutdown that lets
|
|
||||||
// RunWithApp return, so the write is in place by the time we read it.
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
|
|
||||||
if failed {
|
|
||||||
return errReported
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return ctx.Err()
|
||||||
|
case <-app.Done():
|
||||||
|
// App finished running (e.g., backup completed)
|
||||||
return nil
|
return nil
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// runVaultikApp runs the standard single-operation command lifecycle
|
// runVaultikApp runs the standard single-operation command lifecycle
|
||||||
// shared by the snapshot list/purge/remove and remote nuke subcommands:
|
// shared by the list/purge/verify/remove/remote-info subcommands:
|
||||||
// resolve the config, then run op against the Vaultik instance through
|
// resolve the config, start the fx app, run op against the Vaultik
|
||||||
// RunOperation, reporting a failure prefixed with failMsg (suppressed
|
// instance in a goroutine, report a failure prefixed with failMsg
|
||||||
// while suppressErrors is true, e.g. under --json). mode says whether the
|
// (suppressed while suppressErrors is true, e.g. under --json), then
|
||||||
// command takes the PID lock. jsonOutput marks a command whose stdout is a
|
// trigger shutdown. The operation is cancelled when the app stops.
|
||||||
// JSON document: it quiets the UI but, unlike Quiet, leaves the stderr log
|
// extraQuiet is OR-ed into LogOptions.Quiet (e.g. --json output modes).
|
||||||
// level alone.
|
|
||||||
func runVaultikApp(
|
func runVaultikApp(
|
||||||
cmd *cobra.Command, mode lockMode, jsonOutput, suppressErrors bool,
|
cmd *cobra.Command, extraQuiet, suppressErrors bool,
|
||||||
failMsg string, op func(v *vaultik.Vaultik) error,
|
failMsg string, op func(v *vaultik.Vaultik) error,
|
||||||
) error {
|
) error {
|
||||||
configPath, err := ResolveConfigPath()
|
configPath, err := ResolveConfigPath()
|
||||||
@@ -309,68 +214,75 @@ func runVaultikApp(
|
|||||||
|
|
||||||
rootFlags := GetRootFlags()
|
rootFlags := GetRootFlags()
|
||||||
|
|
||||||
return RunOperation(cmd.Context(), AppOptions{
|
return RunWithApp(cmd.Context(), AppOptions{
|
||||||
ConfigPath: configPath,
|
ConfigPath: configPath,
|
||||||
LogOptions: log.Options{
|
LogOptions: log.Options{
|
||||||
Verbose: rootFlags.Verbose,
|
Verbose: rootFlags.Verbose,
|
||||||
Debug: rootFlags.Debug,
|
Debug: rootFlags.Debug,
|
||||||
Quiet: rootFlags.Quiet,
|
Quiet: rootFlags.Quiet || extraQuiet,
|
||||||
JSON: jsonOutput,
|
|
||||||
},
|
},
|
||||||
Mode: mode,
|
Modules: []fx.Option{},
|
||||||
}, op, func(err error) {
|
Invokes: []fx.Option{
|
||||||
if suppressErrors {
|
fx.Invoke(func(v *vaultik.Vaultik, lc fx.Lifecycle) {
|
||||||
return
|
lc.Append(fx.Hook{
|
||||||
}
|
OnStart: func(_ context.Context) error {
|
||||||
|
go func() {
|
||||||
|
err := op(v)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
|
if !suppressErrors {
|
||||||
log.Error(failMsg, "error", err)
|
log.Error(failMsg, "error", err)
|
||||||
ReportErrorf("%s: %v", failMsg, err)
|
ReportErrorf("%s: %v", failMsg, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err = v.Shutdowner.Shutdown()
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to shutdown", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
v.Cancel()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}),
|
||||||
|
},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// RunWithApp is a helper that creates and runs an fx app with the given options.
|
// RunWithApp is a helper that creates and runs an fx app with the given options.
|
||||||
// It combines NewApp and RunApp into a single convenient function. This is the
|
// It combines NewApp and RunApp into a single convenient function. This is the
|
||||||
// preferred way to run CLI commands that need the full application context.
|
// preferred way to run CLI commands that need the full application context.
|
||||||
// A mutating command takes the process-wide PID lock before starting so that
|
// It acquires a PID lock before starting to prevent concurrent instances.
|
||||||
// only one runs at a time; a read-only command runs without it and is not
|
|
||||||
// blocked while a mutator holds the lock (opts.Mode).
|
|
||||||
func RunWithApp(ctx context.Context, opts AppOptions) error {
|
func RunWithApp(ctx context.Context, opts AppOptions) error {
|
||||||
release, err := acquireLockIfMutating(opts.Mode,
|
// Acquire PID lock to prevent concurrent instances
|
||||||
filepath.Join(xdg.DataHome, "vaultik"))
|
lockDir := filepath.Join(xdg.DataHome, "vaultik")
|
||||||
|
|
||||||
|
lock, err := pidlock.Acquire(lockDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
if errors.Is(err, pidlock.ErrAlreadyRunning) {
|
||||||
|
return fmt.Errorf("cannot start: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
defer release()
|
return fmt.Errorf("failed to acquire lock: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
err := lock.Release()
|
||||||
|
if err != nil {
|
||||||
|
log.Warn("Failed to release PID lock", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
app := NewApp(opts)
|
app := NewApp(opts)
|
||||||
|
|
||||||
return RunApp(ctx, app)
|
return RunApp(ctx, app)
|
||||||
}
|
}
|
||||||
|
|
||||||
// acquireLockIfMutating takes the process-wide PID lock in lockDir for a
|
|
||||||
// mutating command and returns a function that releases it. A read-only
|
|
||||||
// command takes no lock, so it returns a no-op release and is never blocked
|
|
||||||
// while a mutator holds the lock. ErrAlreadyRunning (another mutator holds
|
|
||||||
// the lock) is surfaced as a "cannot start" error.
|
|
||||||
func acquireLockIfMutating(mode lockMode, lockDir string) (func(), error) {
|
|
||||||
if mode != mutating {
|
|
||||||
return func() {}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
lock, err := pidlock.Acquire(lockDir)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pidlock.ErrAlreadyRunning) {
|
|
||||||
return nil, fmt.Errorf("cannot start: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, fmt.Errorf("failed to acquire lock: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return func() {
|
|
||||||
err := lock.Release()
|
|
||||||
if err != nil {
|
|
||||||
log.Warn("Failed to release PID lock", "error", err)
|
|
||||||
}
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -2,10 +2,7 @@ package cli //nolint:testpackage // needs access to unexported cleanStartupError
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/pidlock"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestCleanStartupError(t *testing.T) {
|
func TestCleanStartupError(t *testing.T) {
|
||||||
@@ -56,42 +53,3 @@ func TestCleanStartupError(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestLockScopedToMutatingCommands proves the partition the PID lock now
|
|
||||||
// enforces: a read-only command runs while a mutator holds the lock, and
|
|
||||||
// two mutating commands still mutually exclude.
|
|
||||||
func TestLockScopedToMutatingCommands(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
lockDir := filepath.Join(t.TempDir(), "vaultik")
|
|
||||||
|
|
||||||
// A mutating command takes the process-wide lock.
|
|
||||||
releaseMutator, err := acquireLockIfMutating(mutating, lockDir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("mutating command could not acquire lock: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A read-only command runs to completion even while the lock is held.
|
|
||||||
releaseReader, err := acquireLockIfMutating(readOnly, lockDir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read-only command was blocked by held lock: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
releaseReader()
|
|
||||||
|
|
||||||
// A second mutating command is refused while the first holds the lock.
|
|
||||||
_, err = acquireLockIfMutating(mutating, lockDir)
|
|
||||||
if !errors.Is(err, pidlock.ErrAlreadyRunning) {
|
|
||||||
t.Fatalf("second mutating command was not excluded, got: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Once the first mutator releases, another mutating command may run.
|
|
||||||
releaseMutator()
|
|
||||||
|
|
||||||
release, err := acquireLockIfMutating(mutating, lockDir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("mutating command could not acquire released lock: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
release()
|
|
||||||
}
|
|
||||||
|
|||||||
+13
-58
@@ -1,10 +1,8 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -26,11 +24,6 @@ const configSetArgs = 2
|
|||||||
// parent config dirs (e.g. ~/.config) are conventionally traversable.
|
// parent config dirs (e.g. ~/.config) are conventionally traversable.
|
||||||
const configDirMode = 0o755
|
const configDirMode = 0o755
|
||||||
|
|
||||||
// configYAMLIndent matches the 2-space indentation of defaultConfigTemplate,
|
|
||||||
// so `config set` writes the file back with the same indentation rather than
|
|
||||||
// yaml.Marshal's 4-space default.
|
|
||||||
const configYAMLIndent = 2
|
|
||||||
|
|
||||||
var (
|
var (
|
||||||
errConfigExists = errors.New("config file already exists")
|
errConfigExists = errors.New("config file already exists")
|
||||||
errEmptyConfig = errors.New("empty config file")
|
errEmptyConfig = errors.New("empty config file")
|
||||||
@@ -193,8 +186,8 @@ storage_url: ""
|
|||||||
# access_key_id: YOUR_ACCESS_KEY
|
# access_key_id: YOUR_ACCESS_KEY
|
||||||
# secret_access_key: YOUR_SECRET_KEY
|
# secret_access_key: YOUR_SECRET_KEY
|
||||||
# # region: us-east-1 # Default: us-east-1
|
# # region: us-east-1 # Default: us-east-1
|
||||||
|
# # use_ssl: true # Default: true
|
||||||
# # part_size: 5MB # Multipart upload part size. Default: 5MB
|
# # part_size: 5MB # Multipart upload part size. Default: 5MB
|
||||||
# # For the s3:// form, disable TLS with ?ssl=false in the URL, not use_ssl.
|
|
||||||
|
|
||||||
# ─── OPTIONAL ────────────────────────────────────────────────────────────────
|
# ─── OPTIONAL ────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
@@ -213,8 +206,6 @@ storage_url: ""
|
|||||||
# chunk_size: 10MB
|
# chunk_size: 10MB
|
||||||
|
|
||||||
# Maximum blob size before splitting into a new blob.
|
# Maximum blob size before splitting into a new blob.
|
||||||
# Must be at least four times chunk_size (the largest chunk the chunker can
|
|
||||||
# emit); a smaller limit would let a single-chunk blob exceed it.
|
|
||||||
# Accepts: 1GB, 10G, 500MB, etc.
|
# Accepts: 1GB, 10G, 500MB, etc.
|
||||||
# Default: 10GB
|
# Default: 10GB
|
||||||
# blob_size_limit: 10GB
|
# blob_size_limit: 10GB
|
||||||
@@ -380,74 +371,38 @@ Examples:
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
return writeConfigSet(os.Stdout, path, args[0], args[1])
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeConfigSet applies key=value to the config at path, writes it back
|
|
||||||
// owner-only, and confirms the write by printing just the key name to w.
|
|
||||||
// The value is never echoed: it may be a secret such as
|
|
||||||
// s3.secret_access_key, and captured stdout or a pasted terminal would
|
|
||||||
// then leak it.
|
|
||||||
func writeConfigSet(w io.Writer, path, key, value string) error {
|
|
||||||
root, err := loadYAMLFile(path)
|
root, err := loadYAMLFile(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
err = yamlPathSet(root, strings.Split(key, "."), value)
|
err = yamlPathSet(root, strings.Split(args[0], "."), args[1])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
out, err := marshalConfigYAML(root)
|
out, err := yaml.Marshal(root)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("marshaling config: %w", err)
|
return fmt.Errorf("marshaling config: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = os.WriteFile(path, out, configFileMode)
|
mode := os.FileMode(configFileMode)
|
||||||
|
|
||||||
|
info, statErr := os.Stat(path)
|
||||||
|
if statErr == nil {
|
||||||
|
mode = info.Mode().Perm()
|
||||||
|
}
|
||||||
|
|
||||||
|
err = os.WriteFile(path, out, mode)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("writing config file: %w", err)
|
return fmt.Errorf("writing config file: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// os.WriteFile does not change the mode of a file that already exists,
|
_, _ = fmt.Fprintf(os.Stdout, "%s = %s\n", args[0], args[1])
|
||||||
// so a config that was group- or world-readable stays that way. As it
|
|
||||||
// may hold S3 credentials, tighten it to owner-only after writing.
|
|
||||||
info, statErr := os.Stat(path)
|
|
||||||
if statErr == nil && info.Mode().Perm()&0o044 != 0 {
|
|
||||||
err = os.Chmod(path, configFileMode)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("tightening config file permissions: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
_, _ = fmt.Fprintln(w, key)
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
},
|
||||||
|
|
||||||
// marshalConfigYAML renders a config document tree with 2-space indentation,
|
|
||||||
// matching defaultConfigTemplate. yaml.Marshal defaults to 4 spaces, which
|
|
||||||
// would reindent the whole file on the first `config set` despite the promise
|
|
||||||
// to preserve formatting.
|
|
||||||
func marshalConfigYAML(root *yaml.Node) ([]byte, error) {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
enc := yaml.NewEncoder(&buf)
|
|
||||||
enc.SetIndent(configYAMLIndent)
|
|
||||||
|
|
||||||
err := enc.Encode(root)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
err = enc.Close()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return buf.Bytes(), nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// loadYAMLFile parses a YAML file into a yaml.Node document tree,
|
// loadYAMLFile parses a YAML file into a yaml.Node document tree,
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
package cli //nolint:testpackage // exercises unexported yamlPathGet/yamlPathSet
|
package cli //nolint:testpackage // exercises unexported yamlPathGet/yamlPathSet
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -191,109 +188,6 @@ func TestYAMLPathSet(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestConfigSetPreservesFormatting asserts the `config set` write path
|
|
||||||
// (marshalConfigYAML) round-trips a 2-space-indented file without reindenting
|
|
||||||
// it to yaml.Marshal's 4-space default, and keeps comments.
|
|
||||||
func TestConfigSetPreservesFormatting(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
root := parseTestYAML(t)
|
|
||||||
|
|
||||||
err := yamlPathSet(root, splitPath("s3.bucket"), "newbucket")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("set s3.bucket: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
out, err := marshalConfigYAML(root)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("marshal: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
text := string(out)
|
|
||||||
|
|
||||||
for _, want := range []string{"# top comment", "# inline comment"} {
|
|
||||||
if !contains(text, want) {
|
|
||||||
t.Errorf("round-tripped YAML dropped comment %q:\n%s", want, text)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Nested map keys stay at 2-space indent; the bug reindented them to 4.
|
|
||||||
if !contains(text, "\n bucket: newbucket") {
|
|
||||||
t.Errorf("expected 2-space indent for s3.bucket, got:\n%s", text)
|
|
||||||
}
|
|
||||||
|
|
||||||
if contains(text, "\n bucket:") {
|
|
||||||
t.Errorf("s3.bucket reindented to 4 spaces:\n%s", text)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sequence items under a key also stay at 2 spaces.
|
|
||||||
if !contains(text, "\n - age1aaa") {
|
|
||||||
t.Errorf("expected 2-space indent for sequence item, got:\n%s", text)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWriteConfigSetHidesSecret checks that setting a secret key prints
|
|
||||||
// only the key name, never the value, to the confirmation output.
|
|
||||||
func TestWriteConfigSetHidesSecret(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const secret = "SUPERSECRETVALUE"
|
|
||||||
|
|
||||||
path := filepath.Join(t.TempDir(), "config.yaml")
|
|
||||||
|
|
||||||
err := os.WriteFile(path, []byte("version: 1\n"), 0o600)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("seed config: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var out bytes.Buffer
|
|
||||||
|
|
||||||
err = writeConfigSet(&out, path, "s3.secret_access_key", secret)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("writeConfigSet: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Contains(out.String(), secret) {
|
|
||||||
t.Errorf("output echoed the secret value: %q", out.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(out.String(), "s3.secret_access_key") {
|
|
||||||
t.Errorf("output did not confirm the key name: %q", out.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWriteConfigSetTightensMode checks that a pre-existing group- or
|
|
||||||
// world-readable config is tightened to owner-only after a set, since
|
|
||||||
// os.WriteFile leaves an existing file's mode untouched.
|
|
||||||
func TestWriteConfigSetTightensMode(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
path := filepath.Join(t.TempDir(), "config.yaml")
|
|
||||||
|
|
||||||
// Seed a world-readable config; the loose mode is the condition under
|
|
||||||
// test, so gosec's G306 is expected here.
|
|
||||||
err := os.WriteFile(path, []byte("version: 1\n"), 0o644) //nolint:gosec // G306
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("seed config: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var out bytes.Buffer
|
|
||||||
|
|
||||||
err = writeConfigSet(&out, path, "compression_level", "9")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("writeConfigSet: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
info, err := os.Stat(path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stat config: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if info.Mode().Perm() != 0o600 {
|
|
||||||
t.Errorf("config mode = %04o, want 0600", info.Mode().Perm())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func splitPath(s string) []string {
|
func splitPath(s string) []string {
|
||||||
return strings.Split(s, ".")
|
return strings.Split(s, ".")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,126 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Approximate lengths of the extended calendar units accepted by
|
||||||
|
// parseDuration.
|
||||||
|
const (
|
||||||
|
durationDay = 24 * time.Hour
|
||||||
|
durationWeek = 7 * durationDay
|
||||||
|
durationMonth = 30 * durationDay
|
||||||
|
durationYear = 365 * durationDay
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
errNegativeDuration = errors.New("negative durations are not supported")
|
||||||
|
errInvalidDuration = errors.New("invalid duration format")
|
||||||
|
errUnknownTimeUnit = errors.New("unknown time unit")
|
||||||
|
)
|
||||||
|
|
||||||
|
// parseDuration parses duration strings. Supports standard Go duration format
|
||||||
|
// (e.g., "3h30m", "1h45m30s") as well as extended units:
|
||||||
|
// - d: days (e.g., "30d", "7d")
|
||||||
|
// - w: weeks (e.g., "2w", "4w")
|
||||||
|
// - mo: months (30 days) (e.g., "6mo", "1mo")
|
||||||
|
// - y: years (365 days) (e.g., "1y", "2y")
|
||||||
|
//
|
||||||
|
// Can combine units: "1y6mo", "2w3d", "1d12h30m"
|
||||||
|
func parseDuration(s string) (time.Duration, error) {
|
||||||
|
// First try standard Go duration parsing
|
||||||
|
d, err := time.ParseDuration(s)
|
||||||
|
if err == nil {
|
||||||
|
return d, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extended duration parsing
|
||||||
|
// Check for negative values
|
||||||
|
if strings.HasPrefix(strings.TrimSpace(s), "-") {
|
||||||
|
return 0, errNegativeDuration
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pattern matches: number + unit, repeated
|
||||||
|
re := regexp.MustCompile(`(\d+(?:\.\d+)?)\s*([a-zA-Z]+)`)
|
||||||
|
matches := re.FindAllStringSubmatch(s, -1)
|
||||||
|
|
||||||
|
if len(matches) == 0 {
|
||||||
|
return 0, fmt.Errorf("%w: %q", errInvalidDuration, s)
|
||||||
|
}
|
||||||
|
|
||||||
|
var total time.Duration
|
||||||
|
|
||||||
|
for _, match := range matches {
|
||||||
|
valueStr := match[1]
|
||||||
|
unit := strings.ToLower(match[2])
|
||||||
|
|
||||||
|
value, err := strconv.ParseFloat(valueStr, 64)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("invalid number %q: %w", valueStr, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
d, err := durationForUnit(value, unit)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
total += d
|
||||||
|
}
|
||||||
|
|
||||||
|
return total, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// durationForUnit converts a value with a (case-normalized) unit suffix
|
||||||
|
// into a time.Duration, accepting Go's standard units plus the extended
|
||||||
|
// calendar units.
|
||||||
|
func durationForUnit(value float64, unit string) (time.Duration, error) {
|
||||||
|
switch unit {
|
||||||
|
// Standard time units
|
||||||
|
case "ns", "nanosecond", "nanoseconds":
|
||||||
|
return time.Duration(value), nil
|
||||||
|
case "us", "µs", "microsecond", "microseconds":
|
||||||
|
return time.Duration(value * float64(time.Microsecond)), nil
|
||||||
|
case "ms", "millisecond", "milliseconds":
|
||||||
|
return time.Duration(value * float64(time.Millisecond)), nil
|
||||||
|
case "s", "sec", "second", "seconds":
|
||||||
|
return time.Duration(value * float64(time.Second)), nil
|
||||||
|
case "m", "min", "minute", "minutes":
|
||||||
|
return time.Duration(value * float64(time.Minute)), nil
|
||||||
|
case "h", "hr", "hour", "hours":
|
||||||
|
return time.Duration(value * float64(time.Hour)), nil
|
||||||
|
// Extended units
|
||||||
|
case "d", "day", "days":
|
||||||
|
return time.Duration(value * float64(durationDay)), nil
|
||||||
|
case "w", "week", "weeks":
|
||||||
|
return time.Duration(value * float64(durationWeek)), nil
|
||||||
|
case "mo", "month", "months":
|
||||||
|
// Using 30 days as approximation
|
||||||
|
return time.Duration(value * float64(durationMonth)), nil
|
||||||
|
case "y", "year", "years":
|
||||||
|
// Using 365 days as approximation
|
||||||
|
return time.Duration(value * float64(durationYear)), nil
|
||||||
|
default:
|
||||||
|
// Try parsing as standard Go duration unit
|
||||||
|
testStr := "1" + unit
|
||||||
|
|
||||||
|
_, err := time.ParseDuration(testStr)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("%w: %q", errUnknownTimeUnit, unit)
|
||||||
|
}
|
||||||
|
|
||||||
|
// It's a valid Go duration unit, parse the full value
|
||||||
|
fullStr := fmt.Sprintf("%g%s", value, unit)
|
||||||
|
|
||||||
|
d, err := time.ParseDuration(fullStr)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("invalid duration %q: %w", fullStr, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return d, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,299 @@
|
|||||||
|
package cli //nolint:testpackage // needs access to unexported parseDuration
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
type parseDurationCase struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
expected time.Duration
|
||||||
|
wantErr bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// runParseDurationCases executes a table of parseDuration cases as
|
||||||
|
// parallel subtests.
|
||||||
|
func runParseDurationCases(t *testing.T, tests []parseDurationCase) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
got, err := parseDuration(tt.input)
|
||||||
|
|
||||||
|
if tt.wantErr {
|
||||||
|
require.Error(t, err, "expected error for input %q", tt.input)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, err, "unexpected error for input %q", tt.input)
|
||||||
|
assert.Equal(t, tt.expected, got, "duration mismatch for input %q", tt.input)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseDurationStandard(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
runParseDurationCases(t, []parseDurationCase{
|
||||||
|
{
|
||||||
|
name: "standard seconds",
|
||||||
|
input: "30s",
|
||||||
|
expected: 30 * time.Second,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "standard minutes",
|
||||||
|
input: "45m",
|
||||||
|
expected: 45 * time.Minute,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "standard hours",
|
||||||
|
input: "2h",
|
||||||
|
expected: 2 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "standard combined",
|
||||||
|
input: "3h30m",
|
||||||
|
expected: 3*time.Hour + 30*time.Minute,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "standard complex",
|
||||||
|
input: "1h45m30s",
|
||||||
|
expected: 1*time.Hour + 45*time.Minute + 30*time.Second,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "standard with milliseconds",
|
||||||
|
input: "1s500ms",
|
||||||
|
expected: 1*time.Second + 500*time.Millisecond,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseDurationExtendedUnits(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
runParseDurationCases(t, []parseDurationCase{
|
||||||
|
// Extended units - days
|
||||||
|
{
|
||||||
|
name: "single day",
|
||||||
|
input: "1d",
|
||||||
|
expected: 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "multiple days",
|
||||||
|
input: "7d",
|
||||||
|
expected: 7 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "fractional days",
|
||||||
|
input: "1.5d",
|
||||||
|
expected: 36 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "days spelled out",
|
||||||
|
input: "3days",
|
||||||
|
expected: 3 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
// Extended units - weeks
|
||||||
|
{
|
||||||
|
name: "single week",
|
||||||
|
input: "1w",
|
||||||
|
expected: 7 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "multiple weeks",
|
||||||
|
input: "4w",
|
||||||
|
expected: 4 * 7 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "weeks spelled out",
|
||||||
|
input: "2weeks",
|
||||||
|
expected: 2 * 7 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
// Extended units - months
|
||||||
|
{
|
||||||
|
name: "single month",
|
||||||
|
input: "1mo",
|
||||||
|
expected: 30 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "multiple months",
|
||||||
|
input: "6mo",
|
||||||
|
expected: 6 * 30 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "months spelled out",
|
||||||
|
input: "3months",
|
||||||
|
expected: 3 * 30 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
// Extended units - years
|
||||||
|
{
|
||||||
|
name: "single year",
|
||||||
|
input: "1y",
|
||||||
|
expected: 365 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "multiple years",
|
||||||
|
input: "2y",
|
||||||
|
expected: 2 * 365 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "years spelled out",
|
||||||
|
input: "1year",
|
||||||
|
expected: 365 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseDurationCombinedAndErrors(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
runParseDurationCases(t, []parseDurationCase{
|
||||||
|
// Combined extended units
|
||||||
|
{
|
||||||
|
name: "weeks and days",
|
||||||
|
input: "2w3d",
|
||||||
|
expected: 2*7*24*time.Hour + 3*24*time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "years and months",
|
||||||
|
input: "1y6mo",
|
||||||
|
expected: 365*24*time.Hour + 6*30*24*time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "days and hours",
|
||||||
|
input: "1d12h",
|
||||||
|
expected: 24*time.Hour + 12*time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "complex combination",
|
||||||
|
input: "1y2mo3w4d5h6m7s",
|
||||||
|
expected: 365*24*time.Hour + 2*30*24*time.Hour +
|
||||||
|
3*7*24*time.Hour + 4*24*time.Hour +
|
||||||
|
5*time.Hour + 6*time.Minute + 7*time.Second,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "with spaces",
|
||||||
|
input: "1d 12h 30m",
|
||||||
|
expected: 24*time.Hour + 12*time.Hour + 30*time.Minute,
|
||||||
|
},
|
||||||
|
// Edge cases
|
||||||
|
{
|
||||||
|
name: "zero duration",
|
||||||
|
input: "0s",
|
||||||
|
expected: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "large duration",
|
||||||
|
input: "10y",
|
||||||
|
expected: 10 * 365 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
// Error cases
|
||||||
|
{
|
||||||
|
name: "empty string",
|
||||||
|
input: "",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid format",
|
||||||
|
input: "abc",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unknown unit",
|
||||||
|
input: "5x",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid number",
|
||||||
|
input: "xyzd",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "negative not supported",
|
||||||
|
input: "-5d",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseDurationSpecialCases(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// Test that standard Go durations work exactly as expected
|
||||||
|
standardDurations := []string{
|
||||||
|
"300ms",
|
||||||
|
"1.5h",
|
||||||
|
"2h45m",
|
||||||
|
"72h",
|
||||||
|
"1us",
|
||||||
|
"1µs",
|
||||||
|
"1ns",
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, d := range standardDurations {
|
||||||
|
expected, err := time.ParseDuration(d)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
got, err := parseDuration(d)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, expected, got, "standard duration %q should parse identically", d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseDurationRealWorldExamples(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// Test real-world snapshot purge scenarios
|
||||||
|
tests := []struct {
|
||||||
|
description string
|
||||||
|
input string
|
||||||
|
olderThan time.Duration
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
description: "keep snapshots from last 30 days",
|
||||||
|
input: "30d",
|
||||||
|
olderThan: 30 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
description: "keep snapshots from last 6 months",
|
||||||
|
input: "6mo",
|
||||||
|
olderThan: 6 * 30 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
description: "keep snapshots from last year",
|
||||||
|
input: "1y",
|
||||||
|
olderThan: 365 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
description: "keep snapshots from last week and a half",
|
||||||
|
input: "1w3d",
|
||||||
|
olderThan: 10 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
description: "keep snapshots from last 90 days",
|
||||||
|
input: "90d",
|
||||||
|
olderThan: 90 * 24 * time.Hour,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.description, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
got, err := parseDuration(tt.input)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, tt.olderThan, got)
|
||||||
|
|
||||||
|
// Verify the duration makes sense for snapshot purging
|
||||||
|
assert.Greater(t, got, time.Hour,
|
||||||
|
"snapshot purge duration should be at least an hour")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+2
-17
@@ -1,7 +1,6 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -20,11 +19,7 @@ const shortCommitLen = 12
|
|||||||
// flag is present in os.Args — see bannerSuppressedInArgs), executes the
|
// flag is present in os.Args — see bannerSuppressedInArgs), executes the
|
||||||
// root cobra command, and routes any returned error through the
|
// root cobra command, and routes any returned error through the
|
||||||
// ui.Writer so the user sees a properly formatted "🛑 ERROR:" line.
|
// ui.Writer so the user sees a properly formatted "🛑 ERROR:" line.
|
||||||
//
|
func Entry() {
|
||||||
// It returns the process exit code (0 on success, 1 on error) rather
|
|
||||||
// than calling os.Exit, so that main's deferred profile writers run
|
|
||||||
// before the process ends. See run in cmd/vaultik/main.go.
|
|
||||||
func Entry() int {
|
|
||||||
emitStartupBanner(os.Args[1:], os.Stdout)
|
emitStartupBanner(os.Args[1:], os.Stdout)
|
||||||
|
|
||||||
rootCmd := NewRootCommand()
|
rootCmd := NewRootCommand()
|
||||||
@@ -32,19 +27,9 @@ func Entry() int {
|
|||||||
|
|
||||||
err := rootCmd.Execute()
|
err := rootCmd.Execute()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// An operation that ran inside the fx app has already reported
|
|
||||||
// its own failure (and suppressed it under --json); errReported
|
|
||||||
// says so. Printing it again here would double the error line.
|
|
||||||
// Every other error — bad arguments, a config that would not
|
|
||||||
// load — reaches Entry unreported, so it is shown here.
|
|
||||||
if !errors.Is(err, errReported) {
|
|
||||||
ReportErrorf("%s", err.Error())
|
ReportErrorf("%s", err.Error())
|
||||||
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
return 1
|
|
||||||
}
|
|
||||||
|
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// emitStartupBanner writes the startup banner to w unless args (the
|
// emitStartupBanner writes the startup banner to w unless args (the
|
||||||
|
|||||||
@@ -230,7 +230,7 @@ func TestEntryJSONStdoutIsExactlyOneDocument(t *testing.T) {
|
|||||||
programName, flagConfig, configPath, cmdSnapshot, cmdList, flagJSON,
|
programName, flagConfig, configPath, cmdSnapshot, cmdList, flagJSON,
|
||||||
}
|
}
|
||||||
|
|
||||||
stdout := captureProcessStdout(t, func() { _ = Entry() })
|
stdout := captureProcessStdout(t, Entry)
|
||||||
|
|
||||||
requireExactlyOneJSONDocument(t, stdout)
|
requireExactlyOneJSONDocument(t, stdout)
|
||||||
|
|
||||||
|
|||||||
@@ -1,140 +0,0 @@
|
|||||||
package cli //nolint:testpackage // shares the prune fixtures and capture helpers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// staleRecordLogMessage is the local-cleanup audit line CleanupLocalSnapshots
|
|
||||||
// logs for each stale record. It is exactly the signal issue #112 says a
|
|
||||||
// machine consumer lost under --json: gated off stdout, and pinned below
|
|
||||||
// the log level on stderr because --json used to force Quiet.
|
|
||||||
const staleRecordLogMessage = "Removing stale local snapshot record"
|
|
||||||
|
|
||||||
// TestEntryPruneJSONStderrHonoursVerbosity is the end-to-end regression
|
|
||||||
// guard for issue #112. Under --json the log level must still follow
|
|
||||||
// --verbose/--debug rather than being pinned to WARN, so the
|
|
||||||
// local-cleanup records reach stderr under --verbose while stdout stays
|
|
||||||
// exactly one JSON document; without --verbose they stay below the
|
|
||||||
// level, as they do without --json.
|
|
||||||
//
|
|
||||||
// Both halves are asserted together on the same run, because the fix has
|
|
||||||
// to keep the document clean (issue #108) while freeing stderr.
|
|
||||||
//
|
|
||||||
// Not parallel: it replaces os.Args, os.Stdout, os.Stderr and the xdg
|
|
||||||
// globals.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // replaces os.Args, os.Stdout, os.Stderr and the xdg globals
|
|
||||||
func TestEntryPruneJSONStderrHonoursVerbosity(t *testing.T) {
|
|
||||||
for _, testCase := range []struct {
|
|
||||||
name string
|
|
||||||
verbose bool
|
|
||||||
wantOnStderr bool
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "verbose json surfaces the cleanup record on stderr",
|
|
||||||
verbose: true,
|
|
||||||
wantOnStderr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "json alone keeps the cleanup record below the level",
|
|
||||||
verbose: false,
|
|
||||||
wantOnStderr: false,
|
|
||||||
},
|
|
||||||
} {
|
|
||||||
t.Run(testCase.name, func(t *testing.T) {
|
|
||||||
configPath := writeHermeticPruneConfig(t, true)
|
|
||||||
|
|
||||||
previousArgs := os.Args
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
os.Args = previousArgs
|
|
||||||
rootFlags = RootFlags{}
|
|
||||||
})
|
|
||||||
|
|
||||||
args := []string{
|
|
||||||
programName, flagConfig, configPath, cmdPrune, flagJSON,
|
|
||||||
}
|
|
||||||
if testCase.verbose {
|
|
||||||
args = append(args, "--verbose")
|
|
||||||
}
|
|
||||||
|
|
||||||
os.Args = args
|
|
||||||
|
|
||||||
stdout, stderr := captureProcessStdoutAndStderr(t,
|
|
||||||
func() { _ = Entry() })
|
|
||||||
|
|
||||||
// The document stays clean in both cases: freeing stderr must
|
|
||||||
// not regress issue #108.
|
|
||||||
requireExactlyOneJSONDocument(t, stdout)
|
|
||||||
|
|
||||||
if testCase.wantOnStderr {
|
|
||||||
assert.Contains(t, stderr, staleRecordLogMessage,
|
|
||||||
"--verbose --json must emit the cleanup record on stderr")
|
|
||||||
assert.Contains(t, stderr, stalePruneSnapshotID,
|
|
||||||
"the record must name the snapshot it removed")
|
|
||||||
} else {
|
|
||||||
assert.NotContains(t, stderr, staleRecordLogMessage,
|
|
||||||
"without --verbose the record stays below the log level")
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// captureProcessStdoutAndStderr redirects both of the process's own
|
|
||||||
// standard streams to pipes for the duration of fn and returns what was
|
|
||||||
// written to each. The redirection is at the file-descriptor level
|
|
||||||
// because the logger binds os.Stderr when it initializes inside fn, and
|
|
||||||
// the JSON document reaches os.Stdout independently; the point is to see
|
|
||||||
// where each actually lands.
|
|
||||||
//
|
|
||||||
// Not parallel-safe: os.Stdout and os.Stderr are process-global.
|
|
||||||
func captureProcessStdoutAndStderr(t *testing.T, fn func()) (string, string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
outReader, outWriter, err := os.Pipe()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
errReader, errWriter, err := os.Pipe()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
previousOut, previousErr := os.Stdout, os.Stderr
|
|
||||||
os.Stdout, os.Stderr = outWriter, errWriter
|
|
||||||
|
|
||||||
capturedOut := drain(outReader)
|
|
||||||
capturedErr := drain(errReader)
|
|
||||||
|
|
||||||
fn()
|
|
||||||
|
|
||||||
os.Stdout, os.Stderr = previousOut, previousErr
|
|
||||||
|
|
||||||
require.NoError(t, outWriter.Close())
|
|
||||||
require.NoError(t, errWriter.Close())
|
|
||||||
|
|
||||||
out, errOut := <-capturedOut, <-capturedErr
|
|
||||||
|
|
||||||
require.NoError(t, outReader.Close())
|
|
||||||
require.NoError(t, errReader.Close())
|
|
||||||
|
|
||||||
return out, errOut
|
|
||||||
}
|
|
||||||
|
|
||||||
// drain copies a reader to a string on a goroutine and delivers the
|
|
||||||
// result once the writer end is closed.
|
|
||||||
func drain(reader io.Reader) <-chan string {
|
|
||||||
captured := make(chan string, 1)
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
_, _ = io.Copy(&buf, reader)
|
|
||||||
captured <- buf.String()
|
|
||||||
}()
|
|
||||||
|
|
||||||
return captured
|
|
||||||
}
|
|
||||||
@@ -81,7 +81,7 @@ func TestEntryPruneJSONStdoutIsExactlyOneDocument(t *testing.T) {
|
|||||||
programName, flagConfig, configPath, cmdPrune, flagJSON,
|
programName, flagConfig, configPath, cmdPrune, flagJSON,
|
||||||
}
|
}
|
||||||
|
|
||||||
stdout := captureProcessStdout(t, func() { _ = Entry() })
|
stdout := captureProcessStdout(t, Entry)
|
||||||
|
|
||||||
requireExactlyOneJSONDocument(t, stdout)
|
requireExactlyOneJSONDocument(t, stdout)
|
||||||
|
|
||||||
|
|||||||
@@ -1,58 +0,0 @@
|
|||||||
package cli //nolint:testpackage // shares programName and the capture helpers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestEntryReturnsStatusCode pins the contract main() relies on for
|
|
||||||
// issue #75: Entry reports success or failure through its return value
|
|
||||||
// and never calls os.Exit. An os.Exit from inside Entry would skip
|
|
||||||
// main's deferred profile writers and truncate the profile of a failing
|
|
||||||
// command. main turns this code into os.Exit only after those defers
|
|
||||||
// run, so a failing command must come back with a non-zero code rather
|
|
||||||
// than ending the process here.
|
|
||||||
//
|
|
||||||
// Stdout is captured only to keep the banner and command output off the
|
|
||||||
// test log; the assertion is on the returned code.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // replaces os.Args and rootFlags
|
|
||||||
func TestEntryReturnsStatusCode(t *testing.T) {
|
|
||||||
for _, testCase := range []struct {
|
|
||||||
name string
|
|
||||||
args []string
|
|
||||||
want int
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
// version is self-contained: it needs no config and no
|
|
||||||
// destination store, so it exercises the success path.
|
|
||||||
name: "successful command returns zero",
|
|
||||||
args: []string{programName, "version"},
|
|
||||||
want: 0,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "unknown command returns one",
|
|
||||||
args: []string{programName, "no-such-command"},
|
|
||||||
want: 1,
|
|
||||||
},
|
|
||||||
} {
|
|
||||||
t.Run(testCase.name, func(t *testing.T) {
|
|
||||||
previousArgs := os.Args
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
os.Args = previousArgs
|
|
||||||
rootFlags = RootFlags{}
|
|
||||||
})
|
|
||||||
|
|
||||||
os.Args = testCase.args
|
|
||||||
|
|
||||||
var code int
|
|
||||||
|
|
||||||
_ = captureProcessStdout(t, func() { code = Entry() })
|
|
||||||
|
|
||||||
assert.Equal(t, testCase.want, code)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+35
-5
@@ -1,7 +1,12 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
"go.uber.org/fx"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
@@ -28,19 +33,44 @@ func NewInfoCommand() *cobra.Command {
|
|||||||
// Use the app framework
|
// Use the app framework
|
||||||
rootFlags := GetRootFlags()
|
rootFlags := GetRootFlags()
|
||||||
|
|
||||||
return RunOperation(cmd.Context(), AppOptions{
|
return RunWithApp(cmd.Context(), AppOptions{
|
||||||
ConfigPath: configPath,
|
ConfigPath: configPath,
|
||||||
LogOptions: log.Options{
|
LogOptions: log.Options{
|
||||||
Verbose: rootFlags.Verbose,
|
Verbose: rootFlags.Verbose,
|
||||||
Debug: rootFlags.Debug,
|
Debug: rootFlags.Debug,
|
||||||
Quiet: rootFlags.Quiet,
|
Quiet: rootFlags.Quiet,
|
||||||
},
|
},
|
||||||
Mode: readOnly,
|
Modules: []fx.Option{},
|
||||||
}, func(v *vaultik.Vaultik) error {
|
Invokes: []fx.Option{
|
||||||
return v.ShowInfo()
|
fx.Invoke(func(v *vaultik.Vaultik, lc fx.Lifecycle) {
|
||||||
}, func(err error) {
|
lc.Append(fx.Hook{
|
||||||
|
OnStart: func(_ context.Context) error {
|
||||||
|
go func() {
|
||||||
|
err := v.ShowInfo()
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
log.Error("Failed to show info", "error", err)
|
log.Error("Failed to show info", "error", err)
|
||||||
ReportErrorf("Failed to show info: %v", err)
|
ReportErrorf("Failed to show info: %v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err = v.Shutdowner.Shutdown()
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to shutdown", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
v.Cancel()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}),
|
||||||
|
},
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
+43
-11
@@ -1,7 +1,12 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
"go.uber.org/fx"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
@@ -36,24 +41,51 @@ work (e.g. after a crashed backup or to reclaim storage).`,
|
|||||||
// Use the app framework like other commands
|
// Use the app framework like other commands
|
||||||
rootFlags := GetRootFlags()
|
rootFlags := GetRootFlags()
|
||||||
|
|
||||||
return RunOperation(cmd.Context(), AppOptions{
|
return RunWithApp(cmd.Context(), AppOptions{
|
||||||
ConfigPath: configPath,
|
ConfigPath: configPath,
|
||||||
LogOptions: log.Options{
|
LogOptions: log.Options{
|
||||||
Verbose: rootFlags.Verbose,
|
Verbose: rootFlags.Verbose,
|
||||||
Debug: rootFlags.Debug,
|
Debug: rootFlags.Debug,
|
||||||
Quiet: rootFlags.Quiet,
|
Quiet: rootFlags.Quiet || opts.JSON,
|
||||||
JSON: opts.JSON,
|
|
||||||
},
|
},
|
||||||
Mode: mutating,
|
Modules: []fx.Option{},
|
||||||
}, func(v *vaultik.Vaultik) error {
|
Invokes: []fx.Option{
|
||||||
return v.Prune(opts)
|
fx.Invoke(func(v *vaultik.Vaultik, lc fx.Lifecycle) {
|
||||||
}, func(err error) {
|
lc.Append(fx.Hook{
|
||||||
if opts.JSON {
|
OnStart: func(_ context.Context) error {
|
||||||
return
|
// Start the prune operation in a goroutine
|
||||||
}
|
go func() {
|
||||||
|
// Run the prune operation
|
||||||
|
err := v.Prune(opts)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
|
if !opts.JSON {
|
||||||
log.Error("Prune operation failed", "error", err)
|
log.Error("Prune operation failed", "error", err)
|
||||||
ReportErrorf("Prune failed: %v", err)
|
ReportErrorf("Prune failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Shutdown the app when prune completes
|
||||||
|
err = v.Shutdowner.Shutdown()
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to shutdown", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
log.Debug("Stopping prune operation")
|
||||||
|
v.Cancel()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}),
|
||||||
|
},
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
+38
-12
@@ -1,9 +1,12 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
"go.uber.org/fx"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
@@ -45,7 +48,7 @@ This is destructive and irreversible. Requires --force.`,
|
|||||||
return errNukeNeedsForce
|
return errNukeNeedsForce
|
||||||
}
|
}
|
||||||
|
|
||||||
return runVaultikApp(cmd, mutating, false, false, "Remote nuke failed",
|
return runVaultikApp(cmd, false, false, "Remote nuke failed",
|
||||||
func(v *vaultik.Vaultik) error {
|
func(v *vaultik.Vaultik) error {
|
||||||
return v.NukeRemote(true)
|
return v.NukeRemote(true)
|
||||||
})
|
})
|
||||||
@@ -80,24 +83,47 @@ func newRemoteInfoCommand() *cobra.Command {
|
|||||||
|
|
||||||
rootFlags := GetRootFlags()
|
rootFlags := GetRootFlags()
|
||||||
|
|
||||||
return RunOperation(cmd.Context(), AppOptions{
|
return RunWithApp(cmd.Context(), AppOptions{
|
||||||
ConfigPath: configPath,
|
ConfigPath: configPath,
|
||||||
LogOptions: log.Options{
|
LogOptions: log.Options{
|
||||||
Verbose: rootFlags.Verbose,
|
Verbose: rootFlags.Verbose,
|
||||||
Debug: rootFlags.Debug,
|
Debug: rootFlags.Debug,
|
||||||
Quiet: rootFlags.Quiet,
|
Quiet: rootFlags.Quiet || jsonOutput,
|
||||||
JSON: jsonOutput,
|
|
||||||
},
|
},
|
||||||
Mode: readOnly,
|
Modules: []fx.Option{},
|
||||||
}, func(v *vaultik.Vaultik) error {
|
Invokes: []fx.Option{
|
||||||
return v.RemoteInfo(jsonOutput)
|
fx.Invoke(func(v *vaultik.Vaultik, lc fx.Lifecycle) {
|
||||||
}, func(err error) {
|
lc.Append(fx.Hook{
|
||||||
if jsonOutput {
|
OnStart: func(_ context.Context) error {
|
||||||
return
|
go func() {
|
||||||
}
|
err := v.RemoteInfo(jsonOutput)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
|
if !jsonOutput {
|
||||||
log.Error("Failed to get remote info", "error", err)
|
log.Error("Failed to get remote info", "error", err)
|
||||||
ReportErrorf("Failed to get remote info: %v", err)
|
ReportErrorf("Failed to get remote info: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err = v.Shutdowner.Shutdown()
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to shutdown", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
v.Cancel()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}),
|
||||||
|
},
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -57,9 +57,8 @@ on the source system.`,
|
|||||||
cmd.PersistentFlags().BoolVarP(&rootFlags.Quiet, "quiet", "q", false,
|
cmd.PersistentFlags().BoolVarP(&rootFlags.Quiet, "quiet", "q", false,
|
||||||
"Suppress non-error output")
|
"Suppress non-error output")
|
||||||
cmd.PersistentFlags().BoolVar(&rootFlags.SkipErrors, "skip-errors", false,
|
cmd.PersistentFlags().BoolVar(&rootFlags.SkipErrors, "skip-errors", false,
|
||||||
"Skip files that cannot be read when creating a snapshot, or "+
|
"Continue past per-file errors instead of aborting "+
|
||||||
"that cannot be restored when restoring, instead of aborting "+
|
"(applies to snapshot create and restore)")
|
||||||
"(packing and storage errors still abort)")
|
|
||||||
|
|
||||||
// Add subcommands
|
// Add subcommands
|
||||||
cmd.AddCommand(
|
cmd.AddCommand(
|
||||||
|
|||||||
@@ -1,97 +0,0 @@
|
|||||||
package cli_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"go.uber.org/fx"
|
|
||||||
"sneak.berlin/go/vaultik/internal/cli"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestRunAppWaitsForOperationCleanupOnShutdown drives RunApp with an fx app
|
|
||||||
// wired the way RunOperation wires a command: a single lifecycle hook whose
|
|
||||||
// OnStart launches the operation in its own goroutine and whose OnStop cancels
|
|
||||||
// it and blocks until that goroutine returns. The operation stands in for a
|
|
||||||
// restore blocked mid-download — it holds a decrypted "scratch" file and only
|
|
||||||
// removes it as it unwinds on cancellation.
|
|
||||||
//
|
|
||||||
// The app is asked to stop once the operation is running (standing in for an
|
|
||||||
// OS interrupt; fx delivers a real signal and Shutdowner.Shutdown() on the
|
|
||||||
// same app.Wait channel, so both drive the identical shutdown path). RunApp
|
|
||||||
// must not return until app.Stop has run the OnStop hook, so the scratch file
|
|
||||||
// must be gone by the time RunApp returns. Before the fix RunApp returned as
|
|
||||||
// soon as the app.Wait/Done channel fired, without running app.Stop, so the
|
|
||||||
// cleanup never ran and this file would still be on disk (issue #159).
|
|
||||||
func TestRunAppWaitsForOperationCleanupOnShutdown(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
scratch := filepath.Join(t.TempDir(), "decrypted-scratch")
|
|
||||||
require.NoError(t, os.WriteFile(scratch, []byte("secret"), 0o600))
|
|
||||||
|
|
||||||
// Cancel and reap the operation even if RunApp returns without doing so
|
|
||||||
// (the buggy path), so the goroutine cannot leak past the test.
|
|
||||||
opCtx, opCancel := context.WithCancel(context.Background())
|
|
||||||
t.Cleanup(opCancel)
|
|
||||||
|
|
||||||
var stop func(context.Context) bool
|
|
||||||
|
|
||||||
app := fx.New(
|
|
||||||
fx.NopLogger,
|
|
||||||
fx.Invoke(func(lc fx.Lifecycle, sh fx.Shutdowner) {
|
|
||||||
lc.Append(fx.Hook{
|
|
||||||
OnStart: func(_ context.Context) error {
|
|
||||||
done := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
defer close(done)
|
|
||||||
|
|
||||||
// Blocked mid-operation until cancelled, then run the
|
|
||||||
// cleanup an interrupted restore would run.
|
|
||||||
<-opCtx.Done()
|
|
||||||
|
|
||||||
_ = os.Remove(scratch)
|
|
||||||
}()
|
|
||||||
|
|
||||||
stop = func(ctx context.Context) bool {
|
|
||||||
opCancel()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
return true
|
|
||||||
case <-ctx.Done():
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Ask the app to stop now that the operation is running.
|
|
||||||
go func() { _ = sh.Shutdown() }()
|
|
||||||
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
OnStop: func(ctx context.Context) error {
|
|
||||||
stop(ctx)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
})
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
done := make(chan error, 1)
|
|
||||||
go func() { done <- cli.RunApp(context.Background(), app) }()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
require.NoError(t, err)
|
|
||||||
case <-time.After(30 * time.Second):
|
|
||||||
t.Fatal("RunApp did not return after shutdown was requested")
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := os.Stat(scratch)
|
|
||||||
require.True(t, os.IsNotExist(err),
|
|
||||||
"RunApp returned before the operation removed its decrypted scratch file")
|
|
||||||
}
|
|
||||||
+79
-32
@@ -1,10 +1,13 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
"go.uber.org/fx"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
@@ -83,8 +86,7 @@ specifying a path using --config or by setting VAULTIK_CONFIG to a path.`,
|
|||||||
// Use the backup functionality from cli package
|
// Use the backup functionality from cli package
|
||||||
rootFlags := GetRootFlags()
|
rootFlags := GetRootFlags()
|
||||||
|
|
||||||
// --cron suppression is wired through v.UI by setupGlobals.
|
return RunWithApp(cmd.Context(), AppOptions{
|
||||||
return RunOperation(cmd.Context(), AppOptions{
|
|
||||||
ConfigPath: configPath,
|
ConfigPath: configPath,
|
||||||
LogOptions: log.Options{
|
LogOptions: log.Options{
|
||||||
Verbose: rootFlags.Verbose,
|
Verbose: rootFlags.Verbose,
|
||||||
@@ -92,12 +94,42 @@ specifying a path using --config or by setting VAULTIK_CONFIG to a path.`,
|
|||||||
Cron: opts.Cron,
|
Cron: opts.Cron,
|
||||||
Quiet: rootFlags.Quiet,
|
Quiet: rootFlags.Quiet,
|
||||||
},
|
},
|
||||||
Mode: mutating,
|
Modules: []fx.Option{},
|
||||||
}, func(v *vaultik.Vaultik) error {
|
Invokes: []fx.Option{
|
||||||
return v.CreateSnapshot(opts)
|
fx.Invoke(func(v *vaultik.Vaultik, lc fx.Lifecycle) {
|
||||||
}, func(err error) {
|
lc.Append(fx.Hook{
|
||||||
|
OnStart: func(_ context.Context) error {
|
||||||
|
// Start the snapshot creation in a goroutine
|
||||||
|
go func() {
|
||||||
|
// --cron suppression is wired through v.UI by setupGlobals.
|
||||||
|
err := v.CreateSnapshot(opts)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
log.Error("Snapshot creation failed", "error", err)
|
log.Error("Snapshot creation failed", "error", err)
|
||||||
ReportErrorf("Snapshot creation failed: %v", err)
|
ReportErrorf("Snapshot creation failed: %v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Shutdown the app when snapshot completes
|
||||||
|
err = v.Shutdowner.Shutdown()
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to shutdown", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
log.Debug("Stopping snapshot creation")
|
||||||
|
// Cancel the Vaultik context
|
||||||
|
v.Cancel()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}),
|
||||||
|
},
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@@ -109,8 +141,7 @@ specifying a path using --config or by setting VAULTIK_CONFIG to a path.`,
|
|||||||
"orphaned blobs")
|
"orphaned blobs")
|
||||||
cmd.Flags().StringVar(&opts.KeepNewerThan, "keep-newer-than", "",
|
cmd.Flags().StringVar(&opts.KeepNewerThan, "keep-newer-than", "",
|
||||||
"With --prune: keep snapshots newer than this duration "+
|
"With --prune: keep snapshots newer than this duration "+
|
||||||
"(e.g. 30d, 4w, 6mo, 1y; m is minutes, mo is months) "+
|
"(e.g. 4w, 30d, 6mo) instead of only the latest")
|
||||||
"instead of only the latest")
|
|
||||||
|
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
@@ -126,7 +157,7 @@ func newSnapshotListCommand() *cobra.Command {
|
|||||||
Long: "Lists all snapshots with their ID, timestamp, and compressed size",
|
Long: "Lists all snapshots with their ID, timestamp, and compressed size",
|
||||||
Args: cobra.NoArgs,
|
Args: cobra.NoArgs,
|
||||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
return runVaultikApp(cmd, readOnly, false, false,
|
return runVaultikApp(cmd, false, false,
|
||||||
"Failed to list snapshots",
|
"Failed to list snapshots",
|
||||||
func(v *vaultik.Vaultik) error {
|
func(v *vaultik.Vaultik) error {
|
||||||
return v.ListSnapshots(jsonOutput)
|
return v.ListSnapshots(jsonOutput)
|
||||||
@@ -162,7 +193,7 @@ restrict the operation to specific snapshot names.`,
|
|||||||
return errPurgeCriteriaBoth
|
return errPurgeCriteriaBoth
|
||||||
}
|
}
|
||||||
|
|
||||||
return runVaultikApp(cmd, mutating, false, false,
|
return runVaultikApp(cmd, false, false,
|
||||||
"Failed to purge snapshots",
|
"Failed to purge snapshots",
|
||||||
func(v *vaultik.Vaultik) error {
|
func(v *vaultik.Vaultik) error {
|
||||||
return v.PurgeSnapshotsWithOptions(opts)
|
return v.PurgeSnapshotsWithOptions(opts)
|
||||||
@@ -173,8 +204,7 @@ restrict the operation to specific snapshot names.`,
|
|||||||
cmd.Flags().BoolVar(&opts.KeepLatest, "keep-latest", false,
|
cmd.Flags().BoolVar(&opts.KeepLatest, "keep-latest", false,
|
||||||
"Keep only the latest snapshot of each name")
|
"Keep only the latest snapshot of each name")
|
||||||
cmd.Flags().StringVar(&opts.OlderThan, "older-than", "",
|
cmd.Flags().StringVar(&opts.OlderThan, "older-than", "",
|
||||||
"Remove snapshots older than duration "+
|
"Remove snapshots older than duration (e.g., 30d, 6m, 1y)")
|
||||||
"(e.g. 30d, 4w, 6mo, 1y; m is minutes, mo is months)")
|
|
||||||
cmd.Flags().BoolVar(&opts.Force, "force", false, "Skip confirmation prompt")
|
cmd.Flags().BoolVar(&opts.Force, "force", false, "Skip confirmation prompt")
|
||||||
cmd.Flags().StringArrayVar(&opts.Names, "snapshot", nil,
|
cmd.Flags().StringArrayVar(&opts.Names, "snapshot", nil,
|
||||||
"Restrict to snapshots with these names (repeat for multiple)")
|
"Restrict to snapshots with these names (repeat for multiple)")
|
||||||
@@ -188,14 +218,8 @@ func newSnapshotVerifyCommand() *cobra.Command {
|
|||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "verify <snapshot-id>",
|
Use: "verify <snapshot-id>",
|
||||||
Short: "Check a snapshot's blobs are present with the listed size",
|
Short: "Verify snapshot integrity",
|
||||||
Long: "Checks that every blob the snapshot's manifest lists is present\n" +
|
Long: "Verifies that all blobs referenced in a snapshot exist",
|
||||||
"in storage with the size the manifest records, and that the\n" +
|
|
||||||
"snapshot's encrypted database is present. It does not read blob\n" +
|
|
||||||
"contents; use --deep to download and cryptographically verify them.\n\n" +
|
|
||||||
"The snapshot may be named by its ID or, on a host with no local\n" +
|
|
||||||
"index, by the remote key that 'snapshot list' prints for a\n" +
|
|
||||||
"remote-only snapshot (an unambiguous leading part is enough).",
|
|
||||||
Args: requireSnapshotIDArg,
|
Args: requireSnapshotIDArg,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
snapshotID := args[0]
|
snapshotID := args[0]
|
||||||
@@ -208,24 +232,47 @@ func newSnapshotVerifyCommand() *cobra.Command {
|
|||||||
|
|
||||||
rootFlags := GetRootFlags()
|
rootFlags := GetRootFlags()
|
||||||
|
|
||||||
return RunOperation(cmd.Context(), AppOptions{
|
return RunWithApp(cmd.Context(), AppOptions{
|
||||||
ConfigPath: configPath,
|
ConfigPath: configPath,
|
||||||
LogOptions: log.Options{
|
LogOptions: log.Options{
|
||||||
Verbose: rootFlags.Verbose,
|
Verbose: rootFlags.Verbose,
|
||||||
Debug: rootFlags.Debug,
|
Debug: rootFlags.Debug,
|
||||||
Quiet: rootFlags.Quiet,
|
Quiet: rootFlags.Quiet || opts.JSON,
|
||||||
JSON: opts.JSON,
|
|
||||||
},
|
},
|
||||||
Mode: readOnly,
|
Modules: []fx.Option{},
|
||||||
}, func(v *vaultik.Vaultik) error {
|
Invokes: []fx.Option{
|
||||||
return v.VerifySnapshotWithOptions(snapshotID, opts)
|
fx.Invoke(func(v *vaultik.Vaultik, lc fx.Lifecycle) {
|
||||||
}, func(err error) {
|
lc.Append(fx.Hook{
|
||||||
if opts.JSON {
|
OnStart: func(_ context.Context) error {
|
||||||
return
|
go func() {
|
||||||
}
|
err := v.VerifySnapshotWithOptions(snapshotID, opts)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
|
if !opts.JSON {
|
||||||
log.Error("Verification failed", "error", err)
|
log.Error("Verification failed", "error", err)
|
||||||
ReportErrorf("Verification failed: %v", err)
|
ReportErrorf("Verification failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err = v.Shutdowner.Shutdown()
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to shutdown", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
v.Cancel()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}),
|
||||||
|
},
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@@ -264,7 +311,7 @@ To wipe the entire destination store and start over, use 'vaultik remote
|
|||||||
nuke --force' — it is the single supported entry point for that.`,
|
nuke --force' — it is the single supported entry point for that.`,
|
||||||
Args: requireSnapshotIDArg,
|
Args: requireSnapshotIDArg,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
return runVaultikApp(cmd, mutating, opts.JSON, opts.JSON,
|
return runVaultikApp(cmd, opts.JSON, opts.JSON,
|
||||||
"Failed to remove snapshot",
|
"Failed to remove snapshot",
|
||||||
func(v *vaultik.Vaultik) error {
|
func(v *vaultik.Vaultik) error {
|
||||||
_, err := v.RemoveSnapshot(args[0], opts)
|
_, err := v.RemoveSnapshot(args[0], opts)
|
||||||
|
|||||||
@@ -1,8 +1,16 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
"go.uber.org/fx"
|
||||||
|
"sneak.berlin/go/vaultik/internal/config"
|
||||||
|
"sneak.berlin/go/vaultik/internal/globals"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/storage"
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -17,6 +25,15 @@ type RestoreOptions struct {
|
|||||||
Verify bool // Verify restored files after restore
|
Verify bool // Verify restored files after restore
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RestoreApp contains all dependencies needed for restore
|
||||||
|
type RestoreApp struct {
|
||||||
|
Globals *globals.Globals
|
||||||
|
Config *config.Config
|
||||||
|
Storage storage.Storer
|
||||||
|
Vaultik *vaultik.Vaultik
|
||||||
|
Shutdowner fx.Shutdowner
|
||||||
|
}
|
||||||
|
|
||||||
// newSnapshotRestoreCommand creates the 'snapshot restore' subcommand
|
// newSnapshotRestoreCommand creates the 'snapshot restore' subcommand
|
||||||
func newSnapshotRestoreCommand() *cobra.Command {
|
func newSnapshotRestoreCommand() *cobra.Command {
|
||||||
opts := &RestoreOptions{}
|
opts := &RestoreOptions{}
|
||||||
@@ -31,16 +48,8 @@ target directory.
|
|||||||
If no paths are specified, all files are restored.
|
If no paths are specified, all files are restored.
|
||||||
If paths are specified, only matching files/directories are restored.
|
If paths are specified, only matching files/directories are restored.
|
||||||
|
|
||||||
The snapshot may be named by its ID or, when restoring on a host with no
|
Requires the VAULTIK_AGE_SECRET_KEY environment variable to be set with
|
||||||
local index, by the remote key that 'snapshot list' prints for a
|
the age private key.
|
||||||
remote-only snapshot (an unambiguous leading part is enough).
|
|
||||||
|
|
||||||
Requires the age private key in the VAULTIK_AGE_SECRET_KEY environment
|
|
||||||
variable. The variable may hold the whole age-keygen file (comments and
|
|
||||||
all of its identities are accepted); read it from the file rather than
|
|
||||||
typing the key, so it does not land in your shell history:
|
|
||||||
|
|
||||||
export VAULTIK_AGE_SECRET_KEY="$(cat vaultik_backup_private_key.txt)"
|
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
# Restore entire snapshot
|
# Restore entire snapshot
|
||||||
@@ -68,8 +77,7 @@ Examples:
|
|||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
// runRestore parses arguments and runs the restore operation through the
|
// runRestore parses arguments and runs the restore operation through the app framework
|
||||||
// app framework.
|
|
||||||
func runRestore(cmd *cobra.Command, args []string, opts *RestoreOptions) error {
|
func runRestore(cmd *cobra.Command, args []string, opts *RestoreOptions) error {
|
||||||
snapshotID := args[0]
|
snapshotID := args[0]
|
||||||
|
|
||||||
@@ -78,31 +86,87 @@ func runRestore(cmd *cobra.Command, args []string, opts *RestoreOptions) error {
|
|||||||
opts.Paths = args[restoreMinArgs:]
|
opts.Paths = args[restoreMinArgs:]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Use unified config resolution
|
||||||
configPath, err := ResolveConfigPath()
|
configPath, err := ResolveConfigPath()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Use the app framework like other commands
|
||||||
rootFlags := GetRootFlags()
|
rootFlags := GetRootFlags()
|
||||||
|
|
||||||
return RunOperation(cmd.Context(), AppOptions{
|
return RunWithApp(cmd.Context(), AppOptions{
|
||||||
ConfigPath: configPath,
|
ConfigPath: configPath,
|
||||||
LogOptions: log.Options{
|
LogOptions: log.Options{
|
||||||
Verbose: rootFlags.Verbose,
|
Verbose: rootFlags.Verbose,
|
||||||
Debug: rootFlags.Debug,
|
Debug: rootFlags.Debug,
|
||||||
Quiet: rootFlags.Quiet,
|
Quiet: rootFlags.Quiet,
|
||||||
},
|
},
|
||||||
Mode: readOnly,
|
Modules: buildRestoreModules(),
|
||||||
}, func(v *vaultik.Vaultik) error {
|
Invokes: buildRestoreInvokes(snapshotID, opts),
|
||||||
return v.Restore(&vaultik.RestoreOptions{
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildRestoreModules returns the fx.Options for dependency injection in restore
|
||||||
|
func buildRestoreModules() []fx.Option {
|
||||||
|
return []fx.Option{
|
||||||
|
fx.Provide(fx.Annotate(
|
||||||
|
func(g *globals.Globals, cfg *config.Config,
|
||||||
|
storer storage.Storer, v *vaultik.Vaultik, shutdowner fx.Shutdowner) *RestoreApp {
|
||||||
|
return &RestoreApp{
|
||||||
|
Globals: g,
|
||||||
|
Config: cfg,
|
||||||
|
Storage: storer,
|
||||||
|
Vaultik: v,
|
||||||
|
Shutdowner: shutdowner,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildRestoreInvokes returns the fx.Options that wire up the restore lifecycle
|
||||||
|
func buildRestoreInvokes(snapshotID string, opts *RestoreOptions) []fx.Option {
|
||||||
|
return []fx.Option{
|
||||||
|
fx.Invoke(func(app *RestoreApp, lc fx.Lifecycle) {
|
||||||
|
lc.Append(fx.Hook{
|
||||||
|
OnStart: func(_ context.Context) error {
|
||||||
|
// Start the restore operation in a goroutine
|
||||||
|
go func() {
|
||||||
|
// Run the restore operation
|
||||||
|
restoreOpts := &vaultik.RestoreOptions{
|
||||||
SnapshotID: snapshotID,
|
SnapshotID: snapshotID,
|
||||||
TargetDir: opts.TargetDir,
|
TargetDir: opts.TargetDir,
|
||||||
Paths: opts.Paths,
|
Paths: opts.Paths,
|
||||||
Verify: opts.Verify,
|
Verify: opts.Verify,
|
||||||
SkipErrors: rootFlags.SkipErrors,
|
SkipErrors: GetRootFlags().SkipErrors,
|
||||||
})
|
}
|
||||||
}, func(err error) {
|
|
||||||
|
err := app.Vaultik.Restore(restoreOpts)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
log.Error("Restore operation failed", "error", err)
|
log.Error("Restore operation failed", "error", err)
|
||||||
ReportErrorf("Restore failed: %v", err)
|
ReportErrorf("Restore failed: %v", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Shutdown the app when restore completes
|
||||||
|
err = app.Shutdowner.Shutdown()
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to shutdown", "error", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
OnStop: func(_ context.Context) error {
|
||||||
|
log.Debug("Stopping restore operation")
|
||||||
|
app.Vaultik.Cancel()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
},
|
||||||
})
|
})
|
||||||
|
}),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,37 +0,0 @@
|
|||||||
package cli //nolint:testpackage // exercises the unexported command constructor
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/spf13/pflag"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestRestoreCommandDoesNotTakeKeyAsArgument guards the fix for the age
|
|
||||||
// key being echoed on the command line: restore must take the key only
|
|
||||||
// from the environment, never as a flag value, and its help must show the
|
|
||||||
// file-based form rather than a literal key that would land in shell
|
|
||||||
// history.
|
|
||||||
func TestRestoreCommandDoesNotTakeKeyAsArgument(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cmd := newSnapshotRestoreCommand()
|
|
||||||
|
|
||||||
cmd.Flags().VisitAll(func(f *pflag.Flag) {
|
|
||||||
lower := strings.ToLower(f.Name)
|
|
||||||
for _, banned := range []string{"key", "secret", "age", "identity"} {
|
|
||||||
if strings.Contains(lower, banned) {
|
|
||||||
t.Errorf("restore must not accept the key as a flag; found --%s", f.Name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
help := cmd.Long
|
|
||||||
if strings.Contains(help, "AGE-SECRET-KEY-") {
|
|
||||||
t.Error("restore help must not show a literal age private key to type")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(help, "$(cat ") {
|
|
||||||
t.Error("restore help should read the key from a file, e.g. $(cat ...)")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import "time"
|
||||||
|
|
||||||
|
// SnapshotInfo represents snapshot information for listing
|
||||||
|
//
|
||||||
|
//nolint:tagliatelle // snake_case is the established output format
|
||||||
|
type SnapshotInfo struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Timestamp time.Time `json:"timestamp"`
|
||||||
|
CompressedSize int64 `json:"compressed_size"`
|
||||||
|
}
|
||||||
+26
-97
@@ -16,19 +16,11 @@ import (
|
|||||||
"github.com/adrg/xdg"
|
"github.com/adrg/xdg"
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
"gopkg.in/yaml.v3"
|
"gopkg.in/yaml.v3"
|
||||||
"sneak.berlin/go/vaultik/internal/chunker"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
)
|
)
|
||||||
|
|
||||||
const appName = "vaultik"
|
const appName = "vaultik"
|
||||||
|
|
||||||
// secretKeyPrefix marks an age secret (private) key. It is compared
|
|
||||||
// case-insensitively so a recipient entry that is actually a private key is
|
|
||||||
// caught and never passed to age or echoed back.
|
|
||||||
//
|
|
||||||
//nolint:gosec // G101: marker for detecting a pasted secret key, not a credential
|
|
||||||
const secretKeyPrefix = "AGE-SECRET-KEY-"
|
|
||||||
|
|
||||||
// Defaults and validation bounds for tunable settings.
|
// Defaults and validation bounds for tunable settings.
|
||||||
const (
|
const (
|
||||||
defaultBlobSizeLimit = Size(10 * 1024 * 1024 * 1024) // 10GB
|
defaultBlobSizeLimit = Size(10 * 1024 * 1024 * 1024) // 10GB
|
||||||
@@ -45,17 +37,11 @@ var (
|
|||||||
errNoConfigPath = errors.New("config path not provided")
|
errNoConfigPath = errors.New("config path not provided")
|
||||||
errNoAgeRecipients = errors.New(
|
errNoAgeRecipients = errors.New(
|
||||||
"at least one age_recipient is required (generate with: age-keygen)")
|
"at least one age_recipient is required (generate with: age-keygen)")
|
||||||
errRecipientIsSecretKey = errors.New(
|
|
||||||
"an age secret key was given where a public key (age1...) belongs")
|
|
||||||
errRecipientNotX25519 = errors.New(
|
|
||||||
"not a valid recipient; only X25519 age1... public keys are supported")
|
|
||||||
errNoSnapshots = errors.New(
|
errNoSnapshots = errors.New(
|
||||||
"at least one snapshot must be configured (see config.example.yml)")
|
"at least one snapshot must be configured (see config.example.yml)")
|
||||||
errSnapshotNoPaths = errors.New("snapshot must have at least one path")
|
errSnapshotNoPaths = errors.New("snapshot must have at least one path")
|
||||||
errChunkSizeTooSmall = errors.New("chunk_size must be at least 1MB")
|
errChunkSizeTooSmall = errors.New("chunk_size must be at least 1MB")
|
||||||
errBlobSizeTooSmall = errors.New(
|
errBlobSizeTooSmall = errors.New("blob_size_limit must be at least chunk_size")
|
||||||
"blob_size_limit must be at least the largest chunk the chunker can " +
|
|
||||||
"emit (chunk_size times the FastCDC size spread)")
|
|
||||||
errBadCompression = errors.New("compression_level must be between 1 and 19")
|
errBadCompression = errors.New("compression_level must be between 1 and 19")
|
||||||
errBadStorageScheme = errors.New(
|
errBadStorageScheme = errors.New(
|
||||||
"storage_url must start with s3://, file://, or rclone://")
|
"storage_url must start with s3://, file://, or rclone://")
|
||||||
@@ -135,26 +121,6 @@ func (c *Config) SnapshotNames() []string {
|
|||||||
return names
|
return names
|
||||||
}
|
}
|
||||||
|
|
||||||
// Names of the two places the age secret key can be configured, used by
|
|
||||||
// AgeSecretKeySourceName for error messages that must not echo the value.
|
|
||||||
//
|
|
||||||
//nolint:gosec // G101: these are the names of the config sources, not a key
|
|
||||||
const (
|
|
||||||
ageSecretKeySourceEnv = "VAULTIK_AGE_SECRET_KEY"
|
|
||||||
ageSecretKeySourceConfig = "age_secret_key"
|
|
||||||
)
|
|
||||||
|
|
||||||
// AgeSecretKeySourceName returns the human name of where AgeSecretKey was
|
|
||||||
// configured. A Config built directly (as in tests) has no recorded
|
|
||||||
// source, so it reports the config-file field name.
|
|
||||||
func (c *Config) AgeSecretKeySourceName() string {
|
|
||||||
if c.AgeSecretKeySource != "" {
|
|
||||||
return c.AgeSecretKeySource
|
|
||||||
}
|
|
||||||
|
|
||||||
return ageSecretKeySourceConfig
|
|
||||||
}
|
|
||||||
|
|
||||||
// Config represents the application configuration for Vaultik.
|
// Config represents the application configuration for Vaultik.
|
||||||
// It defines all settings for backup operations, including source directories,
|
// It defines all settings for backup operations, including source directories,
|
||||||
// encryption recipients, storage configuration, and performance tuning parameters.
|
// encryption recipients, storage configuration, and performance tuning parameters.
|
||||||
@@ -164,11 +130,6 @@ func (c *Config) AgeSecretKeySourceName() string {
|
|||||||
type Config struct {
|
type Config struct {
|
||||||
AgeRecipients []string `yaml:"age_recipients"`
|
AgeRecipients []string `yaml:"age_recipients"`
|
||||||
AgeSecretKey string `yaml:"age_secret_key"`
|
AgeSecretKey string `yaml:"age_secret_key"`
|
||||||
// AgeSecretKeySource names where AgeSecretKey was configured
|
|
||||||
// ("VAULTIK_AGE_SECRET_KEY" or "age_secret_key") so a later parse
|
|
||||||
// failure can name the source without echoing the secret value. It is
|
|
||||||
// set by Load and never read from or written to the config file.
|
|
||||||
AgeSecretKeySource string `yaml:"-"`
|
|
||||||
BlobSizeLimit Size `yaml:"blob_size_limit"`
|
BlobSizeLimit Size `yaml:"blob_size_limit"`
|
||||||
ChunkSize Size `yaml:"chunk_size"`
|
ChunkSize Size `yaml:"chunk_size"`
|
||||||
// Exclude holds global excludes applied to all snapshots.
|
// Exclude holds global excludes applied to all snapshots.
|
||||||
@@ -201,9 +162,7 @@ type S3Config struct {
|
|||||||
AccessKeyID string `yaml:"access_key_id"`
|
AccessKeyID string `yaml:"access_key_id"`
|
||||||
SecretAccessKey string `yaml:"secret_access_key"`
|
SecretAccessKey string `yaml:"secret_access_key"`
|
||||||
Region string `yaml:"region"`
|
Region string `yaml:"region"`
|
||||||
// UseSSL selects HTTPS for a scheme-less endpoint. Omitted (nil) means
|
UseSSL bool `yaml:"use_ssl"`
|
||||||
// the default, TLS; set it to false only to force plain HTTP.
|
|
||||||
UseSSL *bool `yaml:"use_ssl"`
|
|
||||||
PartSize Size `yaml:"part_size"`
|
PartSize Size `yaml:"part_size"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -279,7 +238,10 @@ func Load(path string) (*Config, error) {
|
|||||||
cfg.IndexPath = expandTilde(envIndexPath)
|
cfg.IndexPath = expandTilde(envIndexPath)
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg.setAgeSecretKey()
|
// Check for environment variable override for AgeSecretKey
|
||||||
|
if envAgeSecretKey := os.Getenv("VAULTIK_AGE_SECRET_KEY"); envAgeSecretKey != "" {
|
||||||
|
cfg.AgeSecretKey = extractAgeSecretKey(envAgeSecretKey)
|
||||||
|
}
|
||||||
|
|
||||||
// Get hostname if not set
|
// Get hostname if not set
|
||||||
if cfg.Hostname == "" {
|
if cfg.Hostname == "" {
|
||||||
@@ -323,30 +285,18 @@ func Load(path string) (*Config, error) {
|
|||||||
|
|
||||||
// Validate checks if the configuration is valid and complete.
|
// Validate checks if the configuration is valid and complete.
|
||||||
// It ensures all required fields are present and have valid values:
|
// It ensures all required fields are present and have valid values:
|
||||||
// - At least one age recipient must be specified, and every recipient must
|
// - At least one age recipient must be specified
|
||||||
// parse as an X25519 age1... public key (so a bad entry fails at load, not
|
|
||||||
// mid-backup); errors name the position, never the value
|
|
||||||
// - At least one snapshot must be configured with at least one path
|
// - At least one snapshot must be configured with at least one path
|
||||||
// - Storage must be configured (either storage_url or s3.* fields)
|
// - Storage must be configured (either storage_url or s3.* fields)
|
||||||
// - Chunk size must be at least 1MB
|
// - Chunk size must be at least 1MB
|
||||||
// - Blob size limit must be at least the largest chunk the chunker can emit
|
// - Blob size limit must be at least the chunk size
|
||||||
// (chunk_size times chunker.ChunkSizeSpread), so a single-chunk blob never
|
|
||||||
// exceeds the configured limit
|
|
||||||
// - Compression level must be between 1 and 19
|
// - Compression level must be between 1 and 19
|
||||||
//
|
|
||||||
// Returns an error describing the first validation failure encountered.
|
// Returns an error describing the first validation failure encountered.
|
||||||
func (c *Config) Validate() error {
|
func (c *Config) Validate() error {
|
||||||
if len(c.AgeRecipients) == 0 {
|
if len(c.AgeRecipients) == 0 {
|
||||||
return errNoAgeRecipients
|
return errNoAgeRecipients
|
||||||
}
|
}
|
||||||
|
|
||||||
for i, recipient := range c.AgeRecipients {
|
|
||||||
err := validateAgeRecipient(recipient)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("age_recipients[%d]: %w", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(c.Snapshots) == 0 {
|
if len(c.Snapshots) == 0 {
|
||||||
return errNoSnapshots
|
return errNoSnapshots
|
||||||
}
|
}
|
||||||
@@ -367,13 +317,8 @@ func (c *Config) Validate() error {
|
|||||||
return errChunkSizeTooSmall
|
return errChunkSizeTooSmall
|
||||||
}
|
}
|
||||||
|
|
||||||
// The chunker can emit chunks up to chunk_size * ChunkSizeSpread, and the
|
if c.BlobSizeLimit.Int64() < c.ChunkSize.Int64() {
|
||||||
// packer places a single such chunk into an otherwise empty blob. A limit
|
return errBlobSizeTooSmall
|
||||||
// below that bound would let a blob exceed it, so reject it.
|
|
||||||
largestChunk := c.ChunkSize.Int64() * chunker.ChunkSizeSpread
|
|
||||||
if c.BlobSizeLimit.Int64() < largestChunk {
|
|
||||||
return fmt.Errorf("%w: need at least %d bytes",
|
|
||||||
errBlobSizeTooSmall, largestChunk)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if c.CompressionLevel < minCompressionLevel ||
|
if c.CompressionLevel < minCompressionLevel ||
|
||||||
@@ -384,38 +329,6 @@ func (c *Config) Validate() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// validateAgeRecipient parses one age_recipients entry with the age library
|
|
||||||
// and returns a value-free error on failure. A recipient string can be
|
|
||||||
// sensitive (an operator may paste a secret key by mistake), so neither the
|
|
||||||
// entry nor age's own error (which quotes its input) is ever included.
|
|
||||||
func validateAgeRecipient(recipient string) error {
|
|
||||||
if strings.HasPrefix(strings.ToUpper(recipient), secretKeyPrefix) {
|
|
||||||
return errRecipientIsSecretKey
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := age.ParseX25519Recipient(recipient)
|
|
||||||
if err != nil {
|
|
||||||
return errRecipientNotX25519
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// setAgeSecretKey records the age secret key and where it came from. The
|
|
||||||
// value is stored raw and parsed only where decryption happens
|
|
||||||
// (internal/vaultik), so backup, list and prune keep working whatever the
|
|
||||||
// field holds. The environment variable overrides the config-file field.
|
|
||||||
func (c *Config) setAgeSecretKey() {
|
|
||||||
if c.AgeSecretKey != "" {
|
|
||||||
c.AgeSecretKeySource = ageSecretKeySourceConfig
|
|
||||||
}
|
|
||||||
|
|
||||||
if env := os.Getenv("VAULTIK_AGE_SECRET_KEY"); env != "" {
|
|
||||||
c.AgeSecretKey = env
|
|
||||||
c.AgeSecretKeySource = ageSecretKeySourceEnv
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// validateStorage validates storage configuration.
|
// validateStorage validates storage configuration.
|
||||||
// If StorageURL is set, it takes precedence. S3 URLs require credentials.
|
// If StorageURL is set, it takes precedence. S3 URLs require credentials.
|
||||||
// File URLs don't require any S3 configuration.
|
// File URLs don't require any S3 configuration.
|
||||||
@@ -472,6 +385,22 @@ func (c *Config) validateStorageURL() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// extractAgeSecretKey extracts the AGE-SECRET-KEY from the input using
|
||||||
|
// the age library's parser, which handles comments and whitespace.
|
||||||
|
func extractAgeSecretKey(input string) string {
|
||||||
|
identities, err := age.ParseIdentities(strings.NewReader(input))
|
||||||
|
if err != nil || len(identities) == 0 {
|
||||||
|
// Fall back to trimmed input if parsing fails
|
||||||
|
return strings.TrimSpace(input)
|
||||||
|
}
|
||||||
|
// Return the string representation of the first identity
|
||||||
|
if id, ok := identities[0].(*age.X25519Identity); ok {
|
||||||
|
return id.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.TrimSpace(input)
|
||||||
|
}
|
||||||
|
|
||||||
// Module exports the config module for fx dependency injection.
|
// Module exports the config module for fx dependency injection.
|
||||||
// It provides the Config type to other modules in the application.
|
// It provides the Config type to other modules in the application.
|
||||||
//
|
//
|
||||||
|
|||||||
+38
-212
@@ -1,13 +1,9 @@
|
|||||||
package config //nolint:testpackage // exercises unexported source constants
|
package config //nolint:testpackage // exercises unexported extractAgeSecretKey
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/chunker"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -87,48 +83,6 @@ func TestConfigLoad(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestExampleConfigIsScrubbedAndLoads checks that the shipped
|
|
||||||
// config.example.yml carries only neutral placeholders (no real credentials,
|
|
||||||
// private addresses, or internal host names) and still parses.
|
|
||||||
func TestExampleConfigIsScrubbedAndLoads(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
examplePath := filepath.Join("..", "..", "config.example.yml")
|
|
||||||
|
|
||||||
cfg, err := Load(examplePath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to load config.example.yml: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.StorageURL != "rclone://myremote/path/to/backups" {
|
|
||||||
t.Errorf("Expected neutral storage_url, got '%s'", cfg.StorageURL)
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:gosec // G304: examplePath is a fixed in-repo path, not user input
|
|
||||||
raw, err := os.ReadFile(examplePath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to read config.example.yml: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
text := string(raw)
|
|
||||||
|
|
||||||
wantSubstrings := []string{
|
|
||||||
"YOUR_ACCESS_KEY",
|
|
||||||
"YOUR_SECRET_KEY",
|
|
||||||
"endpoint: https://",
|
|
||||||
}
|
|
||||||
for _, want := range wantSubstrings {
|
|
||||||
if !strings.Contains(text, want) {
|
|
||||||
t.Errorf("Expected config.example.yml to contain %q", want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A raw "http://" scheme would mean a plaintext, likely private endpoint.
|
|
||||||
if strings.Contains(text, "http://") {
|
|
||||||
t.Error("config.example.yml should not contain an http:// endpoint")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestConfigFromEnv tests loading config path from environment variable
|
// TestConfigFromEnv tests loading config path from environment variable
|
||||||
func TestConfigFromEnv(t *testing.T) {
|
func TestConfigFromEnv(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
@@ -147,57 +101,53 @@ func TestConfigFromEnv(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestValidateBlobSizeLimit checks the blob_size_limit boundary: it must be at
|
// TestExtractAgeSecretKey tests extraction of AGE-SECRET-KEY from various inputs
|
||||||
// least the largest chunk the chunker can emit (chunk_size times
|
func TestExtractAgeSecretKey(t *testing.T) {
|
||||||
// chunker.ChunkSizeSpread), because the packer places a single such chunk into
|
|
||||||
// an otherwise empty blob. A limit between chunk_size and that bound is rejected.
|
|
||||||
func TestValidateBlobSizeLimit(t *testing.T) {
|
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const chunkSize = Size(10 * 1024 * 1024) // 10MB
|
|
||||||
|
|
||||||
largestChunk := chunkSize.Int64() * chunker.ChunkSizeSpread
|
|
||||||
|
|
||||||
newConfig := func(blobLimit Size) *Config {
|
|
||||||
return &Config{
|
|
||||||
AgeRecipients: []string{testSneakAgePublicKey},
|
|
||||||
Snapshots: map[string]SnapshotConfig{"test": {Paths: []string{"/tmp/src"}}},
|
|
||||||
StorageURL: "file:///tmp/vaultik-test-store",
|
|
||||||
ChunkSize: chunkSize,
|
|
||||||
BlobSizeLimit: blobLimit,
|
|
||||||
CompressionLevel: 3,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
blobLimit Size
|
input string
|
||||||
wantErr bool
|
expected string
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "at chunk_size but below largest chunk is rejected",
|
name: "plain key",
|
||||||
blobLimit: chunkSize,
|
input: testIntegrationAgePrivateKey,
|
||||||
wantErr: true,
|
expected: testIntegrationAgePrivateKey,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "between chunk_size and largest chunk is rejected",
|
name: "key with trailing newline",
|
||||||
blobLimit: Size(chunkSize.Int64() * 2),
|
input: testIntegrationAgePrivateKey + "\n",
|
||||||
wantErr: true,
|
expected: testIntegrationAgePrivateKey,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "one byte below largest chunk is rejected",
|
name: "full age-keygen output",
|
||||||
blobLimit: Size(largestChunk - 1),
|
input: "# created: 2025-01-14T12:00:00Z\n" +
|
||||||
wantErr: true,
|
"# public key: " + testIntegrationAgePublicKey + "\n" +
|
||||||
|
testIntegrationAgePrivateKey + "\n",
|
||||||
|
expected: testIntegrationAgePrivateKey,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "exactly at largest chunk is accepted",
|
name: "age-keygen output with extra blank lines",
|
||||||
blobLimit: Size(largestChunk),
|
input: "# created: 2025-01-14T12:00:00Z\n" +
|
||||||
wantErr: false,
|
"# public key: " + testIntegrationAgePublicKey + "\n\n" +
|
||||||
|
testIntegrationAgePrivateKey + "\n\n",
|
||||||
|
expected: testIntegrationAgePrivateKey,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "above largest chunk is accepted",
|
name: "key with leading whitespace",
|
||||||
blobLimit: Size(largestChunk * 100),
|
input: " " + testIntegrationAgePrivateKey + " ",
|
||||||
wantErr: false,
|
expected: testIntegrationAgePrivateKey,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "empty input",
|
||||||
|
input: "",
|
||||||
|
expected: "",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "only comments",
|
||||||
|
input: "# this is a comment\n# another comment",
|
||||||
|
expected: "# this is a comment\n# another comment",
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -205,134 +155,10 @@ func TestValidateBlobSizeLimit(t *testing.T) {
|
|||||||
t.Run(tt.name, func(t *testing.T) {
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
err := newConfig(tt.blobLimit).Validate()
|
result := extractAgeSecretKey(tt.input)
|
||||||
if tt.wantErr {
|
if result != tt.expected {
|
||||||
if !errors.Is(err, errBlobSizeTooSmall) {
|
t.Errorf("extractAgeSecretKey(%q) = %q, want %q",
|
||||||
t.Fatalf("Validate() error = %v, want errBlobSizeTooSmall", err)
|
tt.input, result, tt.expected)
|
||||||
}
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Validate() unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestValidateAgeRecipients checks that recipients are parsed at config load
|
|
||||||
// (a bad entry fails immediately, not mid-backup) and that no invalid entry —
|
|
||||||
// least of all a pasted secret key — is echoed in the error.
|
|
||||||
func TestValidateAgeRecipients(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
baseConfig := func(recipients []string) *Config {
|
|
||||||
return &Config{
|
|
||||||
AgeRecipients: recipients,
|
|
||||||
Snapshots: map[string]SnapshotConfig{"test": {Paths: []string{"/tmp/src"}}},
|
|
||||||
StorageURL: "file:///tmp/vaultik-test-store",
|
|
||||||
ChunkSize: Size(10 * 1024 * 1024),
|
|
||||||
BlobSizeLimit: Size(10 * 1024 * 1024 * 1024),
|
|
||||||
CompressionLevel: 3,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
recipients []string
|
|
||||||
wantErr bool
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "config init placeholder is rejected",
|
|
||||||
recipients: []string{"age1REPLACE_WITH_YOUR_PUBLIC_KEY"},
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "ssh-ed25519 recipient is rejected",
|
|
||||||
recipients: []string{"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIexamplekeydata"},
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "truncated age1 string is rejected",
|
|
||||||
recipients: []string{"age1short"},
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "secret key passed as recipient is rejected",
|
|
||||||
recipients: []string{testIntegrationAgePrivateKey},
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "two valid recipients are accepted",
|
|
||||||
recipients: []string{testSneakAgePublicKey, testIntegrationAgePublicKey},
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
err := baseConfig(tt.recipients).Validate()
|
|
||||||
if !tt.wantErr {
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Validate() unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("Validate() returned nil, want error")
|
|
||||||
}
|
|
||||||
|
|
||||||
// The entry itself must never appear in the error, since a
|
|
||||||
// recipient string can be a secret key.
|
|
||||||
for _, recipient := range tt.recipients {
|
|
||||||
if strings.Contains(err.Error(), recipient) {
|
|
||||||
t.Fatalf("Validate() error echoed the recipient value: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestAgeSecretKeySourceName checks the name reported for the configured
|
|
||||||
// age secret key: the recorded source when Load set one, and the
|
|
||||||
// config-file field name for a Config built directly (as in tests).
|
|
||||||
func TestAgeSecretKeySourceName(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
source string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "unset defaults to config field",
|
|
||||||
source: "",
|
|
||||||
want: ageSecretKeySourceConfig,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "environment source",
|
|
||||||
source: ageSecretKeySourceEnv,
|
|
||||||
want: ageSecretKeySourceEnv,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "config-file source",
|
|
||||||
source: ageSecretKeySourceConfig,
|
|
||||||
want: ageSecretKeySourceConfig,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cfg := &Config{AgeSecretKeySource: tt.source}
|
|
||||||
if got := cfg.AgeSecretKeySourceName(); got != tt.want {
|
|
||||||
t.Errorf("AgeSecretKeySourceName() = %q, want %q", got, tt.want)
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,224 @@
|
|||||||
|
// Package crypto provides thread-safe age encryption and decryption
|
||||||
|
// helpers used to protect blob and metadata content.
|
||||||
|
package crypto //nolint:revive,nolintlint // stdlib crypto unused; see #76
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"filippo.io/age"
|
||||||
|
"go.uber.org/fx"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNoRecipients is returned when an encryptor is created or updated
|
||||||
|
// without any recipient public keys.
|
||||||
|
var ErrNoRecipients = errors.New("at least one recipient is required")
|
||||||
|
|
||||||
|
// Encryptor provides thread-safe encryption using the age encryption library.
|
||||||
|
// It supports encrypting data for multiple recipients simultaneously, allowing
|
||||||
|
// any of the corresponding private keys to decrypt the data. This is useful
|
||||||
|
// for backup scenarios where multiple parties should be able to decrypt the data.
|
||||||
|
type Encryptor struct {
|
||||||
|
recipients []age.Recipient
|
||||||
|
mu sync.RWMutex
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewEncryptor creates a new encryptor with the given age public keys.
|
||||||
|
// Each public key should be a valid age X25519 recipient string (e.g., "age1...")
|
||||||
|
// At least one recipient must be provided. Returns an error if any of the
|
||||||
|
// public keys are invalid or if no recipients are specified.
|
||||||
|
func NewEncryptor(publicKeys []string) (*Encryptor, error) {
|
||||||
|
if len(publicKeys) == 0 {
|
||||||
|
return nil, ErrNoRecipients
|
||||||
|
}
|
||||||
|
|
||||||
|
recipients := make([]age.Recipient, 0, len(publicKeys))
|
||||||
|
for _, key := range publicKeys {
|
||||||
|
recipient, err := age.ParseX25519Recipient(key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("parsing age recipient %s: %w", key, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
recipients = append(recipients, recipient)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &Encryptor{
|
||||||
|
recipients: recipients,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt encrypts data using age encryption for all configured recipients.
|
||||||
|
// The encrypted data can be decrypted by any of the corresponding private keys.
|
||||||
|
// This method is suitable for small to medium amounts of data that fit in memory.
|
||||||
|
// For large data streams, use EncryptStream or EncryptWriter instead.
|
||||||
|
func (e *Encryptor) Encrypt(data []byte) ([]byte, error) {
|
||||||
|
e.mu.RLock()
|
||||||
|
recipients := e.recipients
|
||||||
|
e.mu.RUnlock()
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
// Create encrypted writer for all recipients
|
||||||
|
w, err := age.Encrypt(&buf, recipients...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("creating encrypted writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write data
|
||||||
|
_, err = w.Write(data)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("writing encrypted data: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close to flush
|
||||||
|
err = w.Close()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("closing encrypted writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return buf.Bytes(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncryptStream encrypts data from reader to writer using age encryption.
|
||||||
|
// This method is suitable for encrypting large files or streams as it processes
|
||||||
|
// data in a streaming fashion without loading everything into memory.
|
||||||
|
// The encrypted data is written directly to the destination writer.
|
||||||
|
func (e *Encryptor) EncryptStream(dst io.Writer, src io.Reader) error {
|
||||||
|
e.mu.RLock()
|
||||||
|
recipients := e.recipients
|
||||||
|
e.mu.RUnlock()
|
||||||
|
|
||||||
|
// Create encrypted writer for all recipients
|
||||||
|
w, err := age.Encrypt(dst, recipients...)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("creating encrypted writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Copy data
|
||||||
|
_, err = io.Copy(w, src)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("copying encrypted data: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close to flush
|
||||||
|
err = w.Close()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("closing encrypted writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncryptWriter creates a writer that encrypts data written to it.
|
||||||
|
// All data written to the returned WriteCloser will be encrypted and written
|
||||||
|
// to the destination writer. The caller must call Close() on the returned
|
||||||
|
// writer to ensure all encrypted data is properly flushed and finalized.
|
||||||
|
// This is useful for integrating encryption into existing writer-based pipelines.
|
||||||
|
func (e *Encryptor) EncryptWriter(dst io.Writer) (io.WriteCloser, error) {
|
||||||
|
e.mu.RLock()
|
||||||
|
recipients := e.recipients
|
||||||
|
e.mu.RUnlock()
|
||||||
|
|
||||||
|
// Create encrypted writer for all recipients
|
||||||
|
w, err := age.Encrypt(dst, recipients...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("creating encrypted writer: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return w, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateRecipients updates the recipients for future encryption operations.
|
||||||
|
// This method is thread-safe and can be called while other encryption operations
|
||||||
|
// are in progress. Existing encryption operations will continue with the old
|
||||||
|
// recipients. At least one recipient must be provided. Returns an error if any
|
||||||
|
// of the public keys are invalid or if no recipients are specified.
|
||||||
|
func (e *Encryptor) UpdateRecipients(publicKeys []string) error {
|
||||||
|
if len(publicKeys) == 0 {
|
||||||
|
return ErrNoRecipients
|
||||||
|
}
|
||||||
|
|
||||||
|
recipients := make([]age.Recipient, 0, len(publicKeys))
|
||||||
|
for _, key := range publicKeys {
|
||||||
|
recipient, err := age.ParseX25519Recipient(key)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("parsing age recipient %s: %w", key, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
recipients = append(recipients, recipient)
|
||||||
|
}
|
||||||
|
|
||||||
|
e.mu.Lock()
|
||||||
|
e.recipients = recipients
|
||||||
|
e.mu.Unlock()
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decryptor provides thread-safe decryption using the age encryption library.
|
||||||
|
// It uses a private key to decrypt data that was encrypted for the corresponding
|
||||||
|
// public key.
|
||||||
|
type Decryptor struct {
|
||||||
|
identity age.Identity
|
||||||
|
mu sync.RWMutex
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewDecryptor creates a new decryptor with the given age private key.
|
||||||
|
// The private key should be a valid age X25519 identity string.
|
||||||
|
// Returns an error if the private key is invalid.
|
||||||
|
func NewDecryptor(privateKey string) (*Decryptor, error) {
|
||||||
|
identity, err := age.ParseX25519Identity(privateKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("parsing age identity: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &Decryptor{
|
||||||
|
identity: identity,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt decrypts data using age decryption.
|
||||||
|
// This method is suitable for small to medium amounts of data that fit in memory.
|
||||||
|
// For large data streams, use DecryptStream instead.
|
||||||
|
func (d *Decryptor) Decrypt(data []byte) ([]byte, error) {
|
||||||
|
d.mu.RLock()
|
||||||
|
identity := d.identity
|
||||||
|
d.mu.RUnlock()
|
||||||
|
|
||||||
|
r, err := age.Decrypt(bytes.NewReader(data), identity)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("creating decrypted reader: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
decrypted, err := io.ReadAll(r)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("reading decrypted data: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return decrypted, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecryptStream returns a reader that decrypts data from the provided reader.
|
||||||
|
// This method is suitable for decrypting large files or streams as it processes
|
||||||
|
// data in a streaming fashion without loading everything into memory.
|
||||||
|
// The caller should close the input reader when done.
|
||||||
|
func (d *Decryptor) DecryptStream(src io.Reader) (io.Reader, error) {
|
||||||
|
d.mu.RLock()
|
||||||
|
identity := d.identity
|
||||||
|
d.mu.RUnlock()
|
||||||
|
|
||||||
|
r, err := age.Decrypt(src, identity)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("creating decrypted reader: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Module exports the crypto module for fx dependency injection.
|
||||||
|
//
|
||||||
|
//nolint:gochecknoglobals // fx module definitions are package globals
|
||||||
|
var Module = fx.Module("crypto")
|
||||||
@@ -0,0 +1,178 @@
|
|||||||
|
package crypto_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"filippo.io/age"
|
||||||
|
"sneak.berlin/go/vaultik/internal/crypto"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestEncryptor(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// Generate a test key pair
|
||||||
|
identity, err := age.GenerateX25519Identity()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to generate identity: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
publicKey := identity.Recipient().String()
|
||||||
|
|
||||||
|
// Create encryptor
|
||||||
|
enc, err := crypto.NewEncryptor([]string{publicKey})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to create encryptor: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test data
|
||||||
|
plaintext := []byte("Hello, World! This is a test message.")
|
||||||
|
|
||||||
|
// Encrypt
|
||||||
|
ciphertext, err := enc.Encrypt(plaintext)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to encrypt: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify it's actually encrypted (should be larger and different)
|
||||||
|
if bytes.Equal(plaintext, ciphertext) {
|
||||||
|
t.Error("ciphertext equals plaintext")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt to verify
|
||||||
|
r, err := age.Decrypt(bytes.NewReader(ciphertext), identity)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to decrypt: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var decrypted bytes.Buffer
|
||||||
|
|
||||||
|
_, err = decrypted.ReadFrom(r)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read decrypted data: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !bytes.Equal(plaintext, decrypted.Bytes()) {
|
||||||
|
t.Error("decrypted data doesn't match original")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEncryptorMultipleRecipients(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// Generate three test key pairs
|
||||||
|
identity1, err := age.GenerateX25519Identity()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to generate identity1: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
identity2, err := age.GenerateX25519Identity()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to generate identity2: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
identity3, err := age.GenerateX25519Identity()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to generate identity3: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
publicKeys := []string{
|
||||||
|
identity1.Recipient().String(),
|
||||||
|
identity2.Recipient().String(),
|
||||||
|
identity3.Recipient().String(),
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create encryptor with multiple recipients
|
||||||
|
enc, err := crypto.NewEncryptor(publicKeys)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to create encryptor: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test data
|
||||||
|
plaintext := []byte("Secret message for multiple recipients")
|
||||||
|
|
||||||
|
// Encrypt
|
||||||
|
ciphertext, err := enc.Encrypt(plaintext)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to encrypt: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify each recipient can decrypt
|
||||||
|
identities := []age.Identity{identity1, identity2, identity3}
|
||||||
|
for i, identity := range identities {
|
||||||
|
r, err := age.Decrypt(bytes.NewReader(ciphertext), identity)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("recipient %d failed to decrypt: %v", i+1, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var decrypted bytes.Buffer
|
||||||
|
|
||||||
|
_, err = decrypted.ReadFrom(r)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("recipient %d failed to read decrypted data: %v", i+1, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !bytes.Equal(plaintext, decrypted.Bytes()) {
|
||||||
|
t.Errorf("recipient %d: decrypted data doesn't match original", i+1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEncryptorUpdateRecipients(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// Generate two identities
|
||||||
|
identity1, _ := age.GenerateX25519Identity()
|
||||||
|
identity2, _ := age.GenerateX25519Identity()
|
||||||
|
|
||||||
|
publicKey1 := identity1.Recipient().String()
|
||||||
|
publicKey2 := identity2.Recipient().String()
|
||||||
|
|
||||||
|
// Create encryptor with first key
|
||||||
|
enc, err := crypto.NewEncryptor([]string{publicKey1})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to create encryptor: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt with first key
|
||||||
|
plaintext := []byte("test data")
|
||||||
|
|
||||||
|
ciphertext1, err := enc.Encrypt(plaintext)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to encrypt: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update to second key
|
||||||
|
err = enc.UpdateRecipients([]string{publicKey2})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to update recipients: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt with second key
|
||||||
|
ciphertext2, err := enc.Encrypt(plaintext)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to encrypt: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// First ciphertext should only decrypt with first identity
|
||||||
|
_, err = age.Decrypt(bytes.NewReader(ciphertext1), identity1)
|
||||||
|
if err != nil {
|
||||||
|
t.Error("failed to decrypt with identity1")
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = age.Decrypt(bytes.NewReader(ciphertext1), identity2)
|
||||||
|
if err == nil {
|
||||||
|
t.Error("should not decrypt with identity2")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Second ciphertext should only decrypt with second identity
|
||||||
|
_, err = age.Decrypt(bytes.NewReader(ciphertext2), identity2)
|
||||||
|
if err != nil {
|
||||||
|
t.Error("failed to decrypt with identity2")
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = age.Decrypt(bytes.NewReader(ciphertext2), identity1)
|
||||||
|
if err == nil {
|
||||||
|
t.Error("should not decrypt with identity1")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -208,30 +208,6 @@ func (r *BlobRepository) DeleteOrphaned(ctx context.Context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeleteUnuploaded deletes blob rows whose upload never completed
|
|
||||||
// (uploaded_ts IS NULL) and returns how many were removed. Their
|
|
||||||
// blob_chunks rows are removed by the ON DELETE CASCADE foreign key.
|
|
||||||
// A blob is only ever attached to a snapshot once its upload has been
|
|
||||||
// recorded, so an un-uploaded blob is never referenced by a completed
|
|
||||||
// snapshot: dropping it discards chunk rows that point at data which
|
|
||||||
// was never stored remotely, so the affected content is re-chunked and
|
|
||||||
// re-uploaded on the next run.
|
|
||||||
func (r *BlobRepository) DeleteUnuploaded(ctx context.Context) (int64, error) {
|
|
||||||
query := `DELETE FROM blobs WHERE uploaded_ts IS NULL`
|
|
||||||
|
|
||||||
result, err := r.db.ExecWithLog(ctx, query)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("deleting un-uploaded blobs: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
rowsAffected, _ := result.RowsAffected()
|
|
||||||
if rowsAffected > 0 {
|
|
||||||
log.Debug("Deleted un-uploaded blobs", "count", rowsAffected)
|
|
||||||
}
|
|
||||||
|
|
||||||
return rowsAffected, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// getOne fetches a single blob row matched on the given column, or
|
// getOne fetches a single blob row matched on the given column, or
|
||||||
// (nil, nil) when no row matches.
|
// (nil, nil) when no row matches.
|
||||||
func (r *BlobRepository) getOne(
|
func (r *BlobRepository) getOne(
|
||||||
|
|||||||
@@ -7,32 +7,12 @@ import (
|
|||||||
|
|
||||||
// List returns every chunk in the index, ordered by chunk hash.
|
// List returns every chunk in the index, ordered by chunk hash.
|
||||||
func (r *ChunkRepository) List(ctx context.Context) ([]*Chunk, error) {
|
func (r *ChunkRepository) List(ctx context.Context) ([]*Chunk, error) {
|
||||||
return r.list(ctx, `
|
query := `
|
||||||
SELECT chunk_hash, size
|
SELECT chunk_hash, size
|
||||||
FROM chunks
|
FROM chunks
|
||||||
ORDER BY chunk_hash
|
ORDER BY chunk_hash
|
||||||
`)
|
`
|
||||||
}
|
|
||||||
|
|
||||||
// ListInUploadedBlobs returns the chunks that are stored in a blob whose
|
|
||||||
// upload has completed (uploaded_ts set), ordered by chunk hash. These
|
|
||||||
// are the only chunks a backup may safely deduplicate against: a chunk
|
|
||||||
// recorded solely in a blob that was never uploaded refers to data that
|
|
||||||
// is not in remote storage, so trusting it would silently drop that data
|
|
||||||
// from later snapshots.
|
|
||||||
func (r *ChunkRepository) ListInUploadedBlobs(ctx context.Context) ([]*Chunk, error) {
|
|
||||||
return r.list(ctx, `
|
|
||||||
SELECT DISTINCT c.chunk_hash, c.size
|
|
||||||
FROM chunks c
|
|
||||||
JOIN blob_chunks bc ON c.chunk_hash = bc.chunk_hash
|
|
||||||
JOIN blobs b ON bc.blob_id = b.id
|
|
||||||
WHERE b.uploaded_ts IS NOT NULL
|
|
||||||
ORDER BY c.chunk_hash
|
|
||||||
`)
|
|
||||||
}
|
|
||||||
|
|
||||||
// list runs a chunk-selecting query and scans the (chunk_hash, size) rows.
|
|
||||||
func (r *ChunkRepository) list(ctx context.Context, query string) ([]*Chunk, error) {
|
|
||||||
rows, err := r.db.conn.QueryContext(ctx, query)
|
rows, err := r.db.conn.QueryContext(ctx, query)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("querying chunks: %w", err)
|
return nil, fmt.Errorf("querying chunks: %w", err)
|
||||||
|
|||||||
@@ -17,7 +17,6 @@ import (
|
|||||||
"embed"
|
"embed"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/url"
|
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"sort"
|
"sort"
|
||||||
@@ -220,135 +219,6 @@ func openWithRecovery(ctx context.Context, path string) (*DB, error) {
|
|||||||
return db, nil
|
return db, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// errUntrustedSnapshotSchema is returned when a downloaded snapshot
|
|
||||||
// database carries schema objects the real schema never defines, or is
|
|
||||||
// missing a table the restore and deep-verify queries read.
|
|
||||||
var errUntrustedSnapshotSchema = errors.New(
|
|
||||||
"downloaded snapshot database has an untrusted schema")
|
|
||||||
|
|
||||||
// snapshotReadOnlyDSN builds the driver DSN that opens a materialized
|
|
||||||
// snapshot database file read-only. mode=ro opens the file read-only at
|
|
||||||
// the OS level, query_only rejects any write the engine is asked to make,
|
|
||||||
// and trusted_schema=OFF refuses to run application code named in the
|
|
||||||
// schema. The file: URI form is required for the driver to honour the
|
|
||||||
// mode parameter.
|
|
||||||
func snapshotReadOnlyDSN(path string) string {
|
|
||||||
u := url.URL{
|
|
||||||
Scheme: "file",
|
|
||||||
Path: path,
|
|
||||||
RawQuery: "mode=ro&_pragma=query_only(true)&_pragma=trusted_schema(false)",
|
|
||||||
}
|
|
||||||
|
|
||||||
return u.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// OpenReadOnly opens an already-materialized SQLite file for read-only
|
|
||||||
// querying of a snapshot database downloaded from the store, used by
|
|
||||||
// restore and deep verify. Unlike New it never applies schema migrations
|
|
||||||
// and never writes: the connection is opened read-only with query_only
|
|
||||||
// and trusted_schema=OFF. It refuses any file whose schema carries a
|
|
||||||
// trigger, view or virtual table, or lacks an expected table, so a forged
|
|
||||||
// file cannot redefine what the restore queries return. The caller owns
|
|
||||||
// the file and must remove it.
|
|
||||||
func OpenReadOnly(ctx context.Context, path string) (*DB, error) {
|
|
||||||
conn, err := sql.Open("sqlite", snapshotReadOnlyDSN(path))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("opening read-only database: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
configureConnPool(conn)
|
|
||||||
|
|
||||||
err = conn.PingContext(ctx)
|
|
||||||
if err != nil {
|
|
||||||
_ = conn.Close()
|
|
||||||
|
|
||||||
return nil, fmt.Errorf("opening read-only database: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = verifySnapshotSchema(ctx, conn)
|
|
||||||
if err != nil {
|
|
||||||
_ = conn.Close()
|
|
||||||
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return &DB{conn: conn, path: path}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// verifySnapshotSchema rejects a downloaded database whose schema is not
|
|
||||||
// the plain table set the real schema defines. Any trigger, view or
|
|
||||||
// virtual table, or a missing expected table, fails the open.
|
|
||||||
func verifySnapshotSchema(ctx context.Context, conn *sql.DB) error {
|
|
||||||
// expectedSnapshotTables are the tables the restore and deep-verify
|
|
||||||
// queries read. A downloaded database missing any of them is not a
|
|
||||||
// genuine snapshot database and is refused.
|
|
||||||
expectedSnapshotTables := []string{
|
|
||||||
"blob_chunks",
|
|
||||||
"blobs",
|
|
||||||
"chunks",
|
|
||||||
"file_chunks",
|
|
||||||
"files",
|
|
||||||
}
|
|
||||||
|
|
||||||
rows, err := conn.QueryContext(
|
|
||||||
ctx, "SELECT type, name, sql FROM sqlite_master")
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("reading snapshot schema: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() { _ = rows.Close() }()
|
|
||||||
|
|
||||||
present := make(map[string]struct{})
|
|
||||||
|
|
||||||
for rows.Next() {
|
|
||||||
var objType, name string
|
|
||||||
|
|
||||||
var objSQL sql.NullString
|
|
||||||
|
|
||||||
err = rows.Scan(&objType, &name, &objSQL)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("reading snapshot schema: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
switch objType {
|
|
||||||
case "trigger", "view":
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: unexpected %s %q", errUntrustedSnapshotSchema, objType, name)
|
|
||||||
case "table":
|
|
||||||
if isVirtualTableSQL(objSQL.String) {
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: unexpected virtual table %q",
|
|
||||||
errUntrustedSnapshotSchema, name)
|
|
||||||
}
|
|
||||||
|
|
||||||
present[name] = struct{}{}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
err = rows.Err()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("reading snapshot schema: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, table := range expectedSnapshotTables {
|
|
||||||
if _, ok := present[table]; !ok {
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: missing table %q", errUntrustedSnapshotSchema, table)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// isVirtualTableSQL reports whether a sqlite_master row's SQL defines a
|
|
||||||
// virtual table. Virtual tables are recorded with type 'table' but a
|
|
||||||
// "CREATE VIRTUAL TABLE" definition and can run module code, so they are
|
|
||||||
// refused alongside triggers and views.
|
|
||||||
func isVirtualTableSQL(createSQL string) bool {
|
|
||||||
return strings.HasPrefix(
|
|
||||||
strings.ToUpper(strings.TrimSpace(createSQL)), "CREATE VIRTUAL TABLE")
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewTestDB creates an in-memory SQLite database for testing purposes.
|
// NewTestDB creates an in-memory SQLite database for testing purposes.
|
||||||
// The database is automatically initialized with the schema and is ready
|
// The database is automatically initialized with the schema and is ready
|
||||||
// for use. Each call creates a new independent database instance.
|
// for use. Each call creates a new independent database instance.
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package database
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -16,44 +15,6 @@ import (
|
|||||||
// the index describes the backed-up file tree and must stay private.
|
// the index describes the backed-up file tree and must stay private.
|
||||||
const indexDirPerm = 0o700
|
const indexDirPerm = 0o700
|
||||||
|
|
||||||
// indexFilePerm restricts the index file to the owning user; it lists every
|
|
||||||
// backed-up path and chunk hash and must stay private.
|
|
||||||
const indexFilePerm = 0o600
|
|
||||||
|
|
||||||
// ensureIndexFileMode makes the index file owner-only before the SQLite
|
|
||||||
// driver opens it: it creates the file 0600 if absent, or chmods an existing
|
|
||||||
// one to 0600. Doing this first matters because SQLite creates its -wal and
|
|
||||||
// -shm side files with the mode of the main database file, so a private main
|
|
||||||
// file yields private side files. The driver treats a zero-byte file as an
|
|
||||||
// empty database, so pre-creating it here is safe.
|
|
||||||
func ensureIndexFileMode(path string) error {
|
|
||||||
info, err := os.Stat(path)
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case err == nil:
|
|
||||||
if info.Mode().Perm() == indexFilePerm {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
err = os.Chmod(path, indexFilePerm)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("restricting index file permissions: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
case errors.Is(err, os.ErrNotExist):
|
|
||||||
//nolint:gosec // G304: the index path is operator-configured by design
|
|
||||||
f, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY, indexFilePerm)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("creating index file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.Close()
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("checking index file: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Module provides database dependencies
|
// Module provides database dependencies
|
||||||
//
|
//
|
||||||
//nolint:gochecknoglobals // fx module definitions are package globals by convention
|
//nolint:gochecknoglobals // fx module definitions are package globals by convention
|
||||||
@@ -73,11 +34,6 @@ func provideDatabase(lc fx.Lifecycle, cfg *config.Config) (*DB, error) {
|
|||||||
return nil, fmt.Errorf("creating index directory: %w", err)
|
return nil, fmt.Errorf("creating index directory: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = ensureIndexFileMode(cfg.IndexPath)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
db, err := New(context.Background(), cfg.IndexPath)
|
db, err := New(context.Background(), cfg.IndexPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("opening database: %w", err)
|
return nil, fmt.Errorf("opening database: %w", err)
|
||||||
|
|||||||
@@ -1,100 +0,0 @@
|
|||||||
package database
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"syscall"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"go.uber.org/fx/fxtest"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestProvideDatabaseFreshIndexMode verifies that provideDatabase creates a
|
|
||||||
// missing index file owner-only (0600), even under a lenient 022 umask that
|
|
||||||
// would otherwise leave a freshly created file world-readable.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // syscall.Umask is process-global; parallel tests would clash
|
|
||||||
func TestProvideDatabaseFreshIndexMode(t *testing.T) {
|
|
||||||
restore := syscall.Umask(0o022)
|
|
||||||
defer syscall.Umask(restore)
|
|
||||||
|
|
||||||
indexPath := filepath.Join(t.TempDir(), "index.sqlite")
|
|
||||||
|
|
||||||
openIndex(t, indexPath)
|
|
||||||
assertPerm(t, indexPath, 0o600)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestProvideDatabaseExistingIndexMode verifies that provideDatabase tightens
|
|
||||||
// an existing world-readable index (0644) in a group/other-readable directory
|
|
||||||
// down to owner-only (0600).
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // syscall.Umask is process-global; parallel tests would clash
|
|
||||||
func TestProvideDatabaseExistingIndexMode(t *testing.T) {
|
|
||||||
restore := syscall.Umask(0o022)
|
|
||||||
defer syscall.Umask(restore)
|
|
||||||
|
|
||||||
dir := filepath.Join(t.TempDir(), "data")
|
|
||||||
|
|
||||||
//nolint:gosec // G301: the test intentionally uses a 0755 directory
|
|
||||||
err := os.MkdirAll(dir, 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("creating index directory: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:gosec // G302: the test intentionally uses a 0755 directory
|
|
||||||
err = os.Chmod(dir, 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("relaxing index directory permissions: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
indexPath := filepath.Join(dir, "index.sqlite")
|
|
||||||
|
|
||||||
//nolint:gosec // G306: the test intentionally starts from a 0644 index
|
|
||||||
err = os.WriteFile(indexPath, nil, 0o644)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("creating pre-existing index: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:gosec // G302: the test intentionally starts from a 0644 index
|
|
||||||
err = os.Chmod(indexPath, 0o644)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("relaxing pre-existing index permissions: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
openIndex(t, indexPath)
|
|
||||||
assertPerm(t, indexPath, 0o600)
|
|
||||||
}
|
|
||||||
|
|
||||||
// openIndex runs provideDatabase against indexPath and closes the resulting
|
|
||||||
// database before returning.
|
|
||||||
func openIndex(t *testing.T, indexPath string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
cfg := &config.Config{IndexPath: indexPath}
|
|
||||||
|
|
||||||
db, err := provideDatabase(fxtest.NewLifecycle(t), cfg)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("provideDatabase: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = db.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("closing database: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertPerm fails the test unless path has exactly the given permission bits.
|
|
||||||
func assertPerm(t *testing.T, path string, want os.FileMode) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
info, err := os.Stat(path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stat %s: %v", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := info.Mode().Perm()
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("permissions of %s = %#o, want %#o", path, got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
//nolint:testpackage // exercises unexported read-only open internals
|
|
||||||
package database
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"database/sql"
|
|
||||||
"errors"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// genuineSnapshotDB writes a real snapshot database (the full schema
|
|
||||||
// applied) to a fresh file and returns its path.
|
|
||||||
func genuineSnapshotDB(t *testing.T) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
path := filepath.Join(t.TempDir(), "snapshot.db")
|
|
||||||
|
|
||||||
db, err := New(context.Background(), path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("creating snapshot database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = db.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("closing snapshot database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return path
|
|
||||||
}
|
|
||||||
|
|
||||||
// forgedDB creates an empty database file and runs the given statements
|
|
||||||
// against it read-write, so a test can plant schema objects the real
|
|
||||||
// schema never defines.
|
|
||||||
func forgedDB(t *testing.T, stmts ...string) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
path := filepath.Join(t.TempDir(), "forged.db")
|
|
||||||
|
|
||||||
db, err := sql.Open("sqlite", path)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("opening forged database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, stmt := range stmts {
|
|
||||||
_, err = db.ExecContext(context.Background(), stmt)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("executing %q: %v", stmt, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
err = db.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("closing forged database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return path
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestOpenReadOnlyAcceptsGenuineSnapshot(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db, err := OpenReadOnly(context.Background(), genuineSnapshotDB(t))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("OpenReadOnly refused a genuine snapshot database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestOpenReadOnlyRefusesWrites(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db, err := OpenReadOnly(context.Background(), genuineSnapshotDB(t))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("OpenReadOnly: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
// A schema write depends on no table columns, so the only reason it
|
|
||||||
// can fail is that the database is open read-only.
|
|
||||||
_, err = db.Conn().ExecContext(context.Background(),
|
|
||||||
"CREATE TABLE probe_readonly (x)")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected a write to a read-only snapshot database to fail")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestOpenReadOnlyRejectsView(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
path := forgedDB(t, "CREATE VIEW files AS SELECT 1 AS path")
|
|
||||||
|
|
||||||
_, err := OpenReadOnly(context.Background(), path)
|
|
||||||
if !errors.Is(err, errUntrustedSnapshotSchema) {
|
|
||||||
t.Fatalf("expected a view named files to be refused, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestOpenReadOnlyRejectsTrigger(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
path := forgedDB(t,
|
|
||||||
"CREATE TABLE files (path TEXT)",
|
|
||||||
"CREATE TRIGGER t AFTER INSERT ON files BEGIN SELECT 1; END")
|
|
||||||
|
|
||||||
_, err := OpenReadOnly(context.Background(), path)
|
|
||||||
if !errors.Is(err, errUntrustedSnapshotSchema) {
|
|
||||||
t.Fatalf("expected a trigger to be refused, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestOpenReadOnlyRejectsMissingTable(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// Only one of the expected tables is present.
|
|
||||||
path := forgedDB(t, "CREATE TABLE files (path TEXT)")
|
|
||||||
|
|
||||||
_, err := OpenReadOnly(context.Background(), path)
|
|
||||||
if !errors.Is(err, errUntrustedSnapshotSchema) {
|
|
||||||
t.Fatalf("expected a missing expected table to be refused, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsVirtualTableSQL(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
sql string
|
|
||||||
want bool
|
|
||||||
}{
|
|
||||||
{"CREATE VIRTUAL TABLE t USING fts5(x)", true},
|
|
||||||
{" create virtual table t using fts5(x)", true},
|
|
||||||
{"CREATE TABLE t (x)", false},
|
|
||||||
{"CREATE VIEW t AS SELECT 1", false},
|
|
||||||
{"", false},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, c := range cases {
|
|
||||||
if got := isVirtualTableSQL(c.sql); got != c.want {
|
|
||||||
t.Errorf("isVirtualTableSQL(%q) = %v, want %v", c.sql, got, c.want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -11,18 +11,6 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/types"
|
"sneak.berlin/go/vaultik/internal/types"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Sentinel errors for the single-snapshot invariant that an exported
|
|
||||||
// per-snapshot metadata database must satisfy.
|
|
||||||
var (
|
|
||||||
// ErrNoSnapshotInDatabase means the metadata database has no snapshot
|
|
||||||
// row at all.
|
|
||||||
ErrNoSnapshotInDatabase = errors.New("database contains no snapshot")
|
|
||||||
// ErrMultipleSnapshotsInDatabase means the metadata database holds
|
|
||||||
// more than the single snapshot an export is supposed to contain.
|
|
||||||
ErrMultipleSnapshotsInDatabase = errors.New(
|
|
||||||
"database contains more than one snapshot")
|
|
||||||
)
|
|
||||||
|
|
||||||
// SnapshotRepository provides access to the snapshots table and its
|
// SnapshotRepository provides access to the snapshots table and its
|
||||||
// snapshot_files / snapshot_blobs association tables.
|
// snapshot_files / snapshot_blobs association tables.
|
||||||
type SnapshotRepository struct {
|
type SnapshotRepository struct {
|
||||||
@@ -218,48 +206,6 @@ func (r *SnapshotRepository) GetByID(
|
|||||||
return &snapshot, nil
|
return &snapshot, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetOnlySnapshot returns the sole snapshot in an exported per-snapshot
|
|
||||||
// metadata database. The backup path writes each snapshot's database with
|
|
||||||
// exactly one snapshot row (see cleanSnapshotDB), so restore and deep
|
|
||||||
// verify expect exactly one. Zero rows return ErrNoSnapshotInDatabase and
|
|
||||||
// more than one returns ErrMultipleSnapshotsInDatabase; callers treat
|
|
||||||
// either as a failed identity check on the downloaded database.
|
|
||||||
func (r *SnapshotRepository) GetOnlySnapshot(ctx context.Context) (*Snapshot, error) {
|
|
||||||
query := `
|
|
||||||
SELECT id, hostname, vaultik_version, vaultik_git_revision,
|
|
||||||
started_at, completed_at, file_count, chunk_count, blob_count,
|
|
||||||
total_size, blob_size, compression_ratio
|
|
||||||
FROM snapshots
|
|
||||||
LIMIT 2
|
|
||||||
`
|
|
||||||
|
|
||||||
rows, err := r.db.conn.QueryContext(ctx, query)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("querying snapshots: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() {
|
|
||||||
err := rows.Close()
|
|
||||||
if err != nil {
|
|
||||||
Fatalf("failed to close rows: %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
snapshots, err := r.scanSnapshotRows(rows)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch len(snapshots) {
|
|
||||||
case 1:
|
|
||||||
return snapshots[0], nil
|
|
||||||
case 0:
|
|
||||||
return nil, ErrNoSnapshotInDatabase
|
|
||||||
default:
|
|
||||||
return nil, ErrMultipleSnapshotsInDatabase
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListRecent returns up to limit snapshots, most recently started first.
|
// ListRecent returns up to limit snapshots, most recently started first.
|
||||||
func (r *SnapshotRepository) ListRecent(
|
func (r *SnapshotRepository) ListRecent(
|
||||||
ctx context.Context, limit int,
|
ctx context.Context, limit int,
|
||||||
|
|||||||
+1
-15
@@ -14,18 +14,8 @@ var Module = fx.Module("log",
|
|||||||
)
|
)
|
||||||
|
|
||||||
// New creates a new logger configuration from provided options.
|
// New creates a new logger configuration from provided options.
|
||||||
//
|
|
||||||
// JSON is intentionally not carried into Config: a command emitting a
|
|
||||||
// JSON document on stdout must keep its stderr log level under
|
|
||||||
// --verbose/--debug, so --json must not lower it (issue #112). JSON
|
|
||||||
// silences the stdout UI in setupGlobals instead.
|
|
||||||
func New(opts Options) Config {
|
func New(opts Options) Config {
|
||||||
return Config{
|
return Config(opts)
|
||||||
Verbose: opts.Verbose,
|
|
||||||
Debug: opts.Debug,
|
|
||||||
Cron: opts.Cron,
|
|
||||||
Quiet: opts.Quiet,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Options are provided by the CLI.
|
// Options are provided by the CLI.
|
||||||
@@ -34,8 +24,4 @@ type Options struct {
|
|||||||
Debug bool
|
Debug bool
|
||||||
Cron bool
|
Cron bool
|
||||||
Quiet bool
|
Quiet bool
|
||||||
// JSON marks a command whose stdout carries a machine-readable
|
|
||||||
// document. It silences the human UI on stdout (see setupGlobals),
|
|
||||||
// but unlike Quiet it leaves the stderr log level alone.
|
|
||||||
JSON bool
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
package log_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"log/slog"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestTTYHandlerEscapesControlCharacters logs a message and an attribute
|
|
||||||
// value that each carry an ESC and a newline — the shape a crafted path or
|
|
||||||
// storage error from the destination would take — and checks neither raw
|
|
||||||
// byte reaches the output. The handler's own colour codes (ESC ... m) are
|
|
||||||
// stripped first; any ESC left after that came from the untrusted value.
|
|
||||||
func TestTTYHandlerEscapesControlCharacters(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
logger := slog.New(log.NewTTYHandler(&buf, debugHandlerOptions()))
|
|
||||||
logger.Info("start\x1b[31mZAP\nend", "target", "a\x1b[31mZAP\nb")
|
|
||||||
|
|
||||||
out := buf.String()
|
|
||||||
|
|
||||||
// The only newline is the line terminator; the injected ones were escaped.
|
|
||||||
require.Equal(t, 1, strings.Count(out, "\n"),
|
|
||||||
"a newline in the message or a value must be escaped, not emitted raw")
|
|
||||||
|
|
||||||
// After the handler's own colour codes are removed, no ESC survives.
|
|
||||||
stripped := ansiEscape.ReplaceAllString(out, "")
|
|
||||||
require.NotContains(t, stripped, "\x1b",
|
|
||||||
"a raw ESC from the message or a value must not reach the terminal")
|
|
||||||
|
|
||||||
// The escaped form is what appears instead.
|
|
||||||
require.Contains(t, out, `\x1b`)
|
|
||||||
}
|
|
||||||
@@ -5,11 +5,9 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"strconv"
|
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
"unicode"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// groupSeparator joins an open group path to an attribute key. This
|
// groupSeparator joins an open group path to an attribute key. This
|
||||||
@@ -118,14 +116,11 @@ func (h *TTYHandler) Handle(_ context.Context, r slog.Record) error {
|
|||||||
levelColor = colorReset
|
levelColor = colorReset
|
||||||
}
|
}
|
||||||
|
|
||||||
// Print main message. The message is escaped before the colour codes
|
// Print main message
|
||||||
// are written around it: it can carry text from an untrusted source
|
|
||||||
// (a storage error, for one), and a raw control character would
|
|
||||||
// otherwise reach the terminal.
|
|
||||||
_, _ = fmt.Fprintf(h.out, "%s%s%s %s%s%s %s%s%s",
|
_, _ = fmt.Fprintf(h.out, "%s%s%s %s%s%s %s%s%s",
|
||||||
colorGray, timestamp, colorReset,
|
colorGray, timestamp, colorReset,
|
||||||
levelColor, level, colorReset,
|
levelColor, level, colorReset,
|
||||||
colorBold, sanitize(r.Message), colorReset)
|
colorBold, r.Message, colorReset)
|
||||||
|
|
||||||
// Attributes carried by the handler come first, then the record's
|
// Attributes carried by the handler come first, then the record's
|
||||||
// own. Handler attributes were qualified when they were added; the
|
// own. Handler attributes were qualified when they were added; the
|
||||||
@@ -265,29 +260,9 @@ func (h *TTYHandler) writeAttr(a slog.Attr) {
|
|||||||
// Future kinds also use the plain string form.
|
// Future kinds also use the plain string form.
|
||||||
}
|
}
|
||||||
|
|
||||||
// Escape the key and value before the colour codes are written around
|
|
||||||
// them. Both can carry text from an untrusted source — a manifest
|
|
||||||
// timestamp, a storage error, a path or symlink target read back from
|
|
||||||
// the snapshot database — so a control character in one of them must
|
|
||||||
// be rendered as an escape sequence rather than reaching the terminal,
|
|
||||||
// where it could move the cursor or inject its own colours.
|
|
||||||
_, _ = fmt.Fprintf(h.out, " %s%s%s=%s%s%s",
|
_, _ = fmt.Fprintf(h.out, " %s%s%s=%s%s%s",
|
||||||
colorCyan, sanitize(a.Key), colorReset,
|
colorCyan, a.Key, colorReset,
|
||||||
colorBlue, sanitize(value), colorReset)
|
colorBlue, value, colorReset)
|
||||||
}
|
|
||||||
|
|
||||||
// sanitize returns s unchanged when every rune in it is printable, and a
|
|
||||||
// double-quoted, backslash-escaped form (\n, \x1b, …) otherwise. It is
|
|
||||||
// applied to untrusted text before any colour code is written, so a
|
|
||||||
// control character can never reach the terminal raw.
|
|
||||||
func sanitize(s string) string {
|
|
||||||
for _, r := range s {
|
|
||||||
if !unicode.IsPrint(r) {
|
|
||||||
return strconv.Quote(s)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return s
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// formatDuration formats a duration in a human-readable way
|
// formatDuration formats a duration in a human-readable way
|
||||||
|
|||||||
@@ -0,0 +1,67 @@
|
|||||||
|
// Package models defines shared value types describing files, chunks,
|
||||||
|
// blobs, and snapshots as they move through the backup pipeline.
|
||||||
|
package models
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// FileInfo represents a file in the backup system
|
||||||
|
type FileInfo struct {
|
||||||
|
Path string
|
||||||
|
MTime time.Time
|
||||||
|
Size int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChunkInfo represents a content-addressed chunk
|
||||||
|
type ChunkInfo struct {
|
||||||
|
Hash string // SHA256 hash
|
||||||
|
Size int64
|
||||||
|
Offset int64 // Offset within source file
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChunkRef represents a reference to a chunk in a blob or file
|
||||||
|
type ChunkRef struct {
|
||||||
|
ChunkHash string
|
||||||
|
Offset int64
|
||||||
|
Length int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// BlobInfo represents an encrypted blob containing multiple chunks
|
||||||
|
type BlobInfo struct {
|
||||||
|
Hash string // SHA256 hash of the blob content (content-addressable)
|
||||||
|
CreatedAt time.Time
|
||||||
|
Size int64
|
||||||
|
ChunkCount int
|
||||||
|
}
|
||||||
|
|
||||||
|
// Snapshot represents a backup snapshot
|
||||||
|
type Snapshot struct {
|
||||||
|
ID string // ISO8601 timestamp
|
||||||
|
Hostname string
|
||||||
|
Version string
|
||||||
|
CreatedAt time.Time
|
||||||
|
FileCount int64
|
||||||
|
ChunkCount int64
|
||||||
|
BlobCount int64
|
||||||
|
TotalSize int64
|
||||||
|
MetadataSize int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// SnapshotMetadata contains the full metadata for a snapshot
|
||||||
|
type SnapshotMetadata struct {
|
||||||
|
Snapshot *Snapshot
|
||||||
|
Files map[string]*FileInfo
|
||||||
|
Chunks map[string]*ChunkInfo
|
||||||
|
Blobs map[string]*BlobInfo
|
||||||
|
FileChunks map[string][]*ChunkRef // path -> chunks
|
||||||
|
BlobChunks map[string][]*ChunkRef // blob hash -> chunks
|
||||||
|
}
|
||||||
|
|
||||||
|
// Chunk represents a data chunk for processing
|
||||||
|
type Chunk struct {
|
||||||
|
Data []byte
|
||||||
|
Hash string
|
||||||
|
Offset int64
|
||||||
|
Length int64
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
package models_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/vaultik/internal/models"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestModelsCompilation ensures all model types can be instantiated
|
||||||
|
func TestModelsCompilation(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
// This test primarily serves as a compilation test
|
||||||
|
// to ensure all types are properly defined
|
||||||
|
|
||||||
|
// Test FileInfo
|
||||||
|
fi := &models.FileInfo{
|
||||||
|
Path: "/test/file.txt",
|
||||||
|
MTime: time.Now(),
|
||||||
|
Size: 1024,
|
||||||
|
}
|
||||||
|
if fi.Path != "/test/file.txt" {
|
||||||
|
t.Errorf("FileInfo.Path not set correctly")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test ChunkInfo
|
||||||
|
ci := &models.ChunkInfo{
|
||||||
|
Hash: "abc123",
|
||||||
|
Size: 512,
|
||||||
|
Offset: 0,
|
||||||
|
}
|
||||||
|
if ci.Hash != "abc123" {
|
||||||
|
t.Errorf("ChunkInfo.Hash not set correctly")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test BlobInfo
|
||||||
|
bi := &models.BlobInfo{
|
||||||
|
Hash: "blob123",
|
||||||
|
CreatedAt: time.Now(),
|
||||||
|
Size: 1024,
|
||||||
|
ChunkCount: 2,
|
||||||
|
}
|
||||||
|
if bi.Hash != "blob123" {
|
||||||
|
t.Errorf("BlobInfo.Hash not set correctly")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test Snapshot
|
||||||
|
s := &models.Snapshot{
|
||||||
|
ID: "2024-01-01T00:00:00Z",
|
||||||
|
Hostname: "test-host",
|
||||||
|
Version: "1.0.0",
|
||||||
|
CreatedAt: time.Now(),
|
||||||
|
}
|
||||||
|
if s.ID != "2024-01-01T00:00:00Z" {
|
||||||
|
t.Errorf("Snapshot.ID not set correctly")
|
||||||
|
}
|
||||||
|
}
|
||||||
+5
-13
@@ -219,7 +219,11 @@ func (c *Client) HeadObject(ctx context.Context, key string) (bool, error) {
|
|||||||
Key: aws.String(fullKey),
|
Key: aws.String(fullKey),
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if IsNotFound(err) {
|
var (
|
||||||
|
notFound *s3types.NotFound
|
||||||
|
noSuchKey *s3types.NoSuchKey
|
||||||
|
)
|
||||||
|
if errors.As(err, ¬Found) || errors.As(err, &noSuchKey) {
|
||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -229,18 +233,6 @@ func (c *Client) HeadObject(ctx context.Context, key string) (bool, error) {
|
|||||||
return true, nil
|
return true, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsNotFound reports whether err indicates that an object does not exist.
|
|
||||||
// Head and Get requests surface a missing object as different SDK types,
|
|
||||||
// so both are checked here.
|
|
||||||
func IsNotFound(err error) bool {
|
|
||||||
var (
|
|
||||||
notFound *s3types.NotFound
|
|
||||||
noSuchKey *s3types.NoSuchKey
|
|
||||||
)
|
|
||||||
|
|
||||||
return errors.As(err, ¬Found) || errors.As(err, &noSuchKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ObjectInfo contains information about an S3 object.
|
// ObjectInfo contains information about an S3 object.
|
||||||
// It is used by ListObjectsStream to return object metadata
|
// It is used by ListObjectsStream to return object metadata
|
||||||
// along with any errors encountered during listing.
|
// along with any errors encountered during listing.
|
||||||
|
|||||||
@@ -1,49 +0,0 @@
|
|||||||
//nolint:testpackage // exercises the unexported copyFile helper
|
|
||||||
package snapshot
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"syscall"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestCopyFileExportCopyMode verifies that the exported snapshot database
|
|
||||||
// copy is created owner-only (0600), even under a lenient 022 umask that
|
|
||||||
// would otherwise leave a fresh file world-readable.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // syscall.Umask is process-global; parallel tests would clash
|
|
||||||
func TestCopyFileExportCopyMode(t *testing.T) {
|
|
||||||
restore := syscall.Umask(0o022)
|
|
||||||
defer syscall.Umask(restore)
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
|
||||||
|
|
||||||
src := filepath.Join(dir, "index.sqlite")
|
|
||||||
|
|
||||||
err := os.WriteFile(src, []byte("index data"), 0o600)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("creating source index: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
dst := filepath.Join(dir, "snapshot.db")
|
|
||||||
|
|
||||||
sm := &SnapshotManager{fs: afero.NewOsFs()}
|
|
||||||
|
|
||||||
err = sm.copyFile(src, dst)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("copyFile: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
info, err := os.Stat(dst)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("stat export copy: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := info.Mode().Perm()
|
|
||||||
if got != 0o600 {
|
|
||||||
t.Fatalf("export copy permissions = %#o, want %#o", got, 0o600)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -7,19 +7,6 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
|
|
||||||
"github.com/klauspost/compress/zstd"
|
"github.com/klauspost/compress/zstd"
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Manifest size bounds. A manifest lists one small entry per blob, and
|
|
||||||
// blobs are large (the default target is 10 GB), so even a manifest for a
|
|
||||||
// petabyte-scale backup is a few megabytes. These caps are far above any
|
|
||||||
// manifest the writer can emit, yet stop a crafted, highly compressible
|
|
||||||
// manifest from expanding without limit when decoded: the manifest is
|
|
||||||
// fetched from the store, which is not trusted, and json.Decode buffers
|
|
||||||
// the whole value in memory.
|
|
||||||
const (
|
|
||||||
manifestMaxCompressed = 256 * 1024 * 1024 // 256 MiB
|
|
||||||
manifestMaxDecompressed = 1024 * 1024 * 1024 // 1 GiB
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Manifest represents the structure of a snapshot's blob manifest
|
// Manifest represents the structure of a snapshot's blob manifest
|
||||||
@@ -41,31 +28,19 @@ type BlobInfo struct {
|
|||||||
CompressedSize int64 `json:"compressed_size"`
|
CompressedSize int64 `json:"compressed_size"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// DecodeManifest decodes a manifest from a reader containing compressed
|
// DecodeManifest decodes a manifest from a reader containing compressed JSON
|
||||||
// JSON, reading through byte limits on both the compressed input and the
|
|
||||||
// decompressed output so an untrusted manifest cannot exhaust memory.
|
|
||||||
func DecodeManifest(r io.Reader) (*Manifest, error) {
|
func DecodeManifest(r io.Reader) (*Manifest, error) {
|
||||||
return decodeManifest(r, manifestMaxCompressed, manifestMaxDecompressed)
|
// Decompress using zstd
|
||||||
}
|
zr, err := zstd.NewReader(r)
|
||||||
|
|
||||||
// decodeManifest is DecodeManifest with explicit limits, so tests can drive
|
|
||||||
// the bounds with small inputs instead of gigabyte-scale ones.
|
|
||||||
func decodeManifest(
|
|
||||||
r io.Reader, maxCompressed, maxDecompressed int64,
|
|
||||||
) (*Manifest, error) {
|
|
||||||
// Decompress using zstd, bounding how many compressed bytes are read.
|
|
||||||
zr, err := zstd.NewReader(blobgen.LimitReader(r, maxCompressed))
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("creating zstd reader: %w", err)
|
return nil, fmt.Errorf("creating zstd reader: %w", err)
|
||||||
}
|
}
|
||||||
defer zr.Close()
|
defer zr.Close()
|
||||||
|
|
||||||
// Decode JSON manifest, bounding how far the compressed input may
|
// Decode JSON manifest
|
||||||
// expand: json.Decode buffers the whole value, so without this a
|
|
||||||
// small, highly compressible manifest could expand to gigabytes.
|
|
||||||
var manifest Manifest
|
var manifest Manifest
|
||||||
|
|
||||||
err = json.NewDecoder(blobgen.LimitReader(zr, maxDecompressed)).Decode(&manifest)
|
err = json.NewDecoder(zr).Decode(&manifest)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("decoding manifest: %w", err)
|
return nil, fmt.Errorf("decoding manifest: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,79 +0,0 @@
|
|||||||
//nolint:testpackage // exercises the unexported decodeManifest bounds
|
|
||||||
package snapshot
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
)
|
|
||||||
|
|
||||||
// testSnapshotID is a stand-in snapshot ID reused across the bound cases.
|
|
||||||
const testSnapshotID = "host_home_2026-01-01T00:00:00Z"
|
|
||||||
|
|
||||||
// TestDecodeManifestRoundTrip is the baseline: with generous bounds a
|
|
||||||
// manifest the writer produced decodes back unchanged.
|
|
||||||
func TestDecodeManifestRoundTrip(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
want := &Manifest{
|
|
||||||
SnapshotID: testSnapshotID,
|
|
||||||
Timestamp: "2026-01-01T00:00:00Z",
|
|
||||||
BlobCount: 2,
|
|
||||||
TotalCompressedSize: 42,
|
|
||||||
Blobs: []BlobInfo{
|
|
||||||
{Hash: "aa", CompressedSize: 21},
|
|
||||||
{Hash: "bb", CompressedSize: 21},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
compressed, err := EncodeManifest(want, 3)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
got, err := decodeManifest(
|
|
||||||
bytes.NewReader(compressed), manifestMaxCompressed, manifestMaxDecompressed)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Equal(t, want, got)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDecodeManifestBoundsDecompressedOutput feeds a valid but highly
|
|
||||||
// compressible manifest — one whose timestamp is a megabyte of the same
|
|
||||||
// character — through a small decompressed bound. The compressed form is
|
|
||||||
// tiny, so only the decompressed bound stops it; decoding must fail within
|
|
||||||
// that bound rather than expanding the value in memory.
|
|
||||||
func TestDecodeManifestBoundsDecompressedOutput(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
bomb := &Manifest{
|
|
||||||
SnapshotID: testSnapshotID,
|
|
||||||
Timestamp: strings.Repeat("a", 1<<20),
|
|
||||||
}
|
|
||||||
|
|
||||||
compressed, err := EncodeManifest(bomb, 3)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Less(t, len(compressed), 4096,
|
|
||||||
"the compressible manifest must be small compressed")
|
|
||||||
|
|
||||||
_, err = decodeManifest(bytes.NewReader(compressed), 1<<20, 4096)
|
|
||||||
require.ErrorIs(t, err, blobgen.ErrOutputTooLarge)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDecodeManifestBoundsCompressedInput checks the compressed-input
|
|
||||||
// bound fires independently: a valid manifest with a generous decompressed
|
|
||||||
// bound but a tiny compressed bound still fails.
|
|
||||||
func TestDecodeManifestBoundsCompressedInput(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
manifest := &Manifest{
|
|
||||||
SnapshotID: testSnapshotID,
|
|
||||||
Timestamp: strings.Repeat("a", 4096),
|
|
||||||
}
|
|
||||||
|
|
||||||
compressed, err := EncodeManifest(manifest, 3)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
_, err = decodeManifest(bytes.NewReader(compressed), 8, manifestMaxDecompressed)
|
|
||||||
require.Error(t, err)
|
|
||||||
}
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
//nolint:testpackage // exercises the unexported generateBlobManifest
|
|
||||||
package snapshot
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/types"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestGenerateBlobManifest_MissingBlobFails is the regression guard for
|
|
||||||
// issue #157: a blob the snapshot references but that is absent from the
|
|
||||||
// blobs table used to be logged and skipped, yielding a manifest with
|
|
||||||
// fewer blobs than the snapshot needs. Since prune trusts the manifest
|
|
||||||
// alone, that omitted blob would be deleted at the next prune. Manifest
|
|
||||||
// generation must fail instead.
|
|
||||||
func TestGenerateBlobManifest_MissingBlobFails(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
dbPath := filepath.Join(t.TempDir(), "snapshot.db")
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
// A real blob row satisfies the snapshot_blobs foreign key on
|
|
||||||
// blob_id; the snapshot then references a different, absent hash.
|
|
||||||
presentBlob := &database.Blob{
|
|
||||||
ID: types.NewBlobID(),
|
|
||||||
Hash: types.BlobHash("present-blob-hash"),
|
|
||||||
CreatedTS: time.Now().Truncate(time.Second),
|
|
||||||
}
|
|
||||||
require.NoError(t, repos.Blobs.Create(ctx, nil, presentBlob))
|
|
||||||
|
|
||||||
snap := &database.Snapshot{
|
|
||||||
ID: "testhost_home_2026-05-01T00:00:00Z",
|
|
||||||
Hostname: "testhost",
|
|
||||||
}
|
|
||||||
require.NoError(t, repos.Snapshots.Create(ctx, nil, snap))
|
|
||||||
require.NoError(t, repos.Snapshots.AddBlob(ctx, nil,
|
|
||||||
snap.ID.String(), presentBlob.ID, types.BlobHash("absent-blob-hash")))
|
|
||||||
|
|
||||||
require.NoError(t, db.Close())
|
|
||||||
|
|
||||||
sm := &SnapshotManager{
|
|
||||||
config: &config.Config{CompressionLevel: 3},
|
|
||||||
fs: afero.NewOsFs(),
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = sm.generateBlobManifest(ctx, dbPath, snap.ID.String())
|
|
||||||
require.Error(t, err, "manifest generation must fail on a missing blob")
|
|
||||||
assert.Contains(t, err.Error(), "absent-blob-hash")
|
|
||||||
}
|
|
||||||
@@ -22,9 +22,8 @@ const remoteKeyPrefix = "vaultik|"
|
|||||||
//
|
//
|
||||||
// - the "metadata/<remote-key>/..." subdirectory on the storage
|
// - the "metadata/<remote-key>/..." subdirectory on the storage
|
||||||
// backend so a directory listing of the bucket / file:// dest
|
// backend so a directory listing of the bucket / file:// dest
|
||||||
// doesn't reveal hostnames or configured snapshot names. (The
|
// doesn't reveal hostnames, configured snapshot names, or backup
|
||||||
// backup time is not hidden: the manifest.json.zst inside that
|
// timestamps;
|
||||||
// directory carries a plaintext RFC3339 timestamp.)
|
|
||||||
// - the `snapshot_id` field of the unencrypted manifest.json.zst
|
// - the `snapshot_id` field of the unencrypted manifest.json.zst
|
||||||
// for the same reason;
|
// for the same reason;
|
||||||
// - any code path that needs to translate a known local snapshot ID
|
// - any code path that needs to translate a known local snapshot ID
|
||||||
|
|||||||
@@ -63,9 +63,7 @@ type Scanner struct {
|
|||||||
exclude []string // Glob patterns for files/directories to exclude
|
exclude []string // Glob patterns for files/directories to exclude
|
||||||
compiledExclude []compiledPattern // Compiled glob patterns
|
compiledExclude []compiledPattern // Compiled glob patterns
|
||||||
progress *ProgressReporter
|
progress *ProgressReporter
|
||||||
// skipErrors skips files that cannot be opened or read (logged loudly);
|
skipErrors bool // Skip file read errors (log loudly but continue)
|
||||||
// packer, database, encryption, and upload errors still abort the run.
|
|
||||||
skipErrors bool
|
|
||||||
// ui is the user-facing output; never nil (defaults to a discarding writer).
|
// ui is the user-facing output; never nil (defaults to a discarding writer).
|
||||||
ui *ui.Writer
|
ui *ui.Writer
|
||||||
|
|
||||||
@@ -123,9 +121,7 @@ type ScannerConfig struct {
|
|||||||
EnableProgress bool // Enable the live progress reporter (ETAs, throughput)
|
EnableProgress bool // Enable the live progress reporter (ETAs, throughput)
|
||||||
UI *ui.Writer // Where user-facing scanner messages go; nil = discard
|
UI *ui.Writer // Where user-facing scanner messages go; nil = discard
|
||||||
Exclude []string // Glob patterns for files/directories to exclude
|
Exclude []string // Glob patterns for files/directories to exclude
|
||||||
// SkipErrors skips files that cannot be opened or read (log loudly but
|
SkipErrors bool // Skip file read errors (log loudly but continue)
|
||||||
// continue); packer, database, encryption, and upload errors still abort.
|
|
||||||
SkipErrors bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ScanResult contains the results of a scan operation
|
// ScanResult contains the results of a scan operation
|
||||||
@@ -224,14 +220,7 @@ func (s *Scanner) Scan(
|
|||||||
defer s.progress.Stop()
|
defer s.progress.Stop()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Phase 0: Repair any state left by an interrupted previous run, then
|
// Phase 0: Load known files and chunks from database into memory for fast lookup
|
||||||
// load known files and chunks from the database into memory for fast
|
|
||||||
// lookup.
|
|
||||||
err := s.repairInterruptedBlobs(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
knownFiles, err := s.loadDatabaseState(ctx, path)
|
knownFiles, err := s.loadDatabaseState(ctx, path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -328,38 +317,6 @@ func (s *Scanner) loadDatabaseState(
|
|||||||
return knownFiles, nil
|
return knownFiles, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// repairInterruptedBlobs discards blob rows left by a previous run whose
|
|
||||||
// upload never completed. Such a blob has its chunks, blob_chunks, and
|
|
||||||
// blobs rows committed to the local index before the upload is attempted,
|
|
||||||
// so a crash or dropped connection mid-upload leaves them behind while the
|
|
||||||
// data never reaches remote storage. Deduplicating against those chunks on
|
|
||||||
// a later run would produce a snapshot that reports success but cannot be
|
|
||||||
// restored. Dropping the un-uploaded blobs (their blob_chunks cascade) and
|
|
||||||
// then any chunks left unreferenced forces the affected data to be
|
|
||||||
// re-chunked and re-uploaded this run. A blob is attached to a snapshot
|
|
||||||
// only once its upload is recorded, so this never touches a completed
|
|
||||||
// snapshot's data.
|
|
||||||
func (s *Scanner) repairInterruptedBlobs(ctx context.Context) error {
|
|
||||||
removed, err := s.repos.Blobs.DeleteUnuploaded(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("removing un-uploaded blob records: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if removed == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Warn("Discarded blob records from an interrupted previous run; "+
|
|
||||||
"their data will be re-uploaded", "blobs", removed)
|
|
||||||
|
|
||||||
err = s.repos.Chunks.DeleteOrphaned(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("removing orphaned chunks: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// summarizeScanPhase calculates total size to process, updates progress tracking,
|
// summarizeScanPhase calculates total size to process, updates progress tracking,
|
||||||
// and prints the scan phase summary with file counts and sizes
|
// and prints the scan phase summary with file counts and sizes
|
||||||
func (s *Scanner) summarizeScanPhase(
|
func (s *Scanner) summarizeScanPhase(
|
||||||
@@ -435,14 +392,11 @@ func (s *Scanner) loadKnownFiles(
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// loadKnownChunks loads the chunk hashes safe to deduplicate against into
|
// loadKnownChunks loads all known chunk hashes from the database into a
|
||||||
// an in-memory map for fast lookup, avoiding per-chunk database queries
|
// map for fast lookup. This avoids per-chunk database queries during file
|
||||||
// during file processing. Only chunks held by a blob whose upload
|
// processing.
|
||||||
// completed are loaded: a chunk left behind by an interrupted upload
|
|
||||||
// refers to data that never reached remote storage, and deduplicating
|
|
||||||
// against it would silently produce an unrestorable snapshot.
|
|
||||||
func (s *Scanner) loadKnownChunks(ctx context.Context) error {
|
func (s *Scanner) loadKnownChunks(ctx context.Context) error {
|
||||||
chunks, err := s.repos.Chunks.ListInUploadedBlobs(ctx)
|
chunks, err := s.repos.Chunks.List(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("listing chunks: %w", err)
|
return fmt.Errorf("listing chunks: %w", err)
|
||||||
}
|
}
|
||||||
@@ -1340,15 +1294,6 @@ func (s *Scanner) processFileWithErrorHandling(
|
|||||||
) (bool, error) {
|
) (bool, error) {
|
||||||
err := s.processFileStreaming(ctx, fileToProcess, result)
|
err := s.processFileStreaming(ctx, fileToProcess, result)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// A packer/database/encryption/upload failure means the chunk's data
|
|
||||||
// may not have been stored. Skipping the file would let the snapshot
|
|
||||||
// record a file whose chunk is in no blob and cannot be restored, so
|
|
||||||
// abort the run even under --skip-errors. Only open and read errors
|
|
||||||
// are skipped below.
|
|
||||||
var pErr *packerError
|
|
||||||
if errors.As(err, &pErr) {
|
|
||||||
return false, fmt.Errorf("processing file %s: %w", fileToProcess.Path, err)
|
|
||||||
}
|
|
||||||
// Handle files that were deleted between scan and process phases
|
// Handle files that were deleted between scan and process phases
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
log.Warn("File was deleted during backup, skipping",
|
log.Warn("File was deleted during backup, skipping",
|
||||||
@@ -1358,7 +1303,7 @@ func (s *Scanner) processFileWithErrorHandling(
|
|||||||
|
|
||||||
return true, nil
|
return true, nil
|
||||||
}
|
}
|
||||||
// Skip open/read errors if --skip-errors is enabled
|
// Skip file read errors if --skip-errors is enabled
|
||||||
if s.skipErrors {
|
if s.skipErrors {
|
||||||
log.Error("Failed to process file (skipping due to --skip-errors)",
|
log.Error("Failed to process file (skipping due to --skip-errors)",
|
||||||
"path", fileToProcess.Path, "error", err)
|
"path", fileToProcess.Path, "error", err)
|
||||||
@@ -1456,17 +1401,7 @@ func (s *Scanner) finalizeProcessPhase(ctx context.Context, result *ScanResult)
|
|||||||
return fmt.Errorf("parsing blob ID: %w", err)
|
return fmt.Errorf("parsing blob ID: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// With no remote backend the blob's lifecycle ends here, so
|
|
||||||
// mark it uploaded in the same transaction that attaches it to
|
|
||||||
// the snapshot. This keeps the invariant that any blob a
|
|
||||||
// snapshot references has uploaded_ts set, so deduplication and
|
|
||||||
// interrupted-run repair treat these blobs as trustworthy.
|
|
||||||
err = s.repos.WithTx(ctx, func(ctx context.Context, tx *sql.Tx) error {
|
err = s.repos.WithTx(ctx, func(ctx context.Context, tx *sql.Tx) error {
|
||||||
err := s.repos.Blobs.UpdateUploaded(ctx, tx, b.ID)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("marking blob uploaded: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return s.repos.Snapshots.AddBlob(ctx, tx, s.snapshotID, blobID,
|
return s.repos.Snapshots.AddBlob(ctx, tx, s.snapshotID, blobID,
|
||||||
types.BlobHash(b.Hash))
|
types.BlobHash(b.Hash))
|
||||||
})
|
})
|
||||||
@@ -1725,20 +1660,6 @@ type streamingChunkInfo struct {
|
|||||||
size int64
|
size int64
|
||||||
}
|
}
|
||||||
|
|
||||||
// packerError marks an error that came from adding a chunk to the packer
|
|
||||||
// (packing, database, encryption, or upload). Such an error means the chunk's
|
|
||||||
// data may not have been stored, so the run must abort even under --skip-errors:
|
|
||||||
// skipping the file would leave the chunk recorded as backed up while it lives
|
|
||||||
// in no blob, and a later snapshot could record a file that cannot be restored.
|
|
||||||
// Only open and read errors are safe to skip.
|
|
||||||
type packerError struct {
|
|
||||||
err error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *packerError) Error() string { return e.err.Error() }
|
|
||||||
|
|
||||||
func (e *packerError) Unwrap() error { return e.err }
|
|
||||||
|
|
||||||
// processFileStreaming processes a file by streaming chunks directly to the packer
|
// processFileStreaming processes a file by streaming chunks directly to the packer
|
||||||
func (s *Scanner) processFileStreaming(
|
func (s *Scanner) processFileStreaming(
|
||||||
ctx context.Context, fileToProcess *FileToProcess, result *ScanResult,
|
ctx context.Context, fileToProcess *FileToProcess, result *ScanResult,
|
||||||
@@ -1789,11 +1710,7 @@ func (s *Scanner) processFileStreaming(
|
|||||||
if !chunkExists {
|
if !chunkExists {
|
||||||
err := s.addChunkToPacker(ctx, chunk)
|
err := s.addChunkToPacker(ctx, chunk)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Mark as a packer error so --skip-errors cannot swallow it:
|
return err
|
||||||
// the chunk was registered as pending before packing, so a
|
|
||||||
// skipped file here would be recorded as backed up while its
|
|
||||||
// data was never stored.
|
|
||||||
return &packerError{err: err}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,216 +0,0 @@
|
|||||||
package snapshot_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/snapshot"
|
|
||||||
)
|
|
||||||
|
|
||||||
// errSimTempFail is the one-time temp-file creation failure blobTempFailFs
|
|
||||||
// injects, mirroring a full temp filesystem.
|
|
||||||
var errSimTempFail = errors.New("simulated temp-file creation failure")
|
|
||||||
|
|
||||||
// errSimRead is the read failure readFailFile injects for a file that opens
|
|
||||||
// but cannot be read.
|
|
||||||
var errSimRead = errors.New("simulated read failure")
|
|
||||||
|
|
||||||
// blobTempFailFs fails the first temp-file creation for a packer blob, then
|
|
||||||
// behaves normally, simulating a one-time failure to start a new blob.
|
|
||||||
type blobTempFailFs struct {
|
|
||||||
afero.Fs
|
|
||||||
|
|
||||||
mu sync.Mutex
|
|
||||||
failed bool
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:ireturn // afero.Fs.OpenFile is defined to return the interface.
|
|
||||||
func (f *blobTempFailFs) OpenFile(
|
|
||||||
name string, flag int, perm os.FileMode,
|
|
||||||
) (afero.File, error) {
|
|
||||||
if strings.Contains(name, "vaultik-blob-") {
|
|
||||||
f.mu.Lock()
|
|
||||||
firstTime := !f.failed
|
|
||||||
f.failed = true
|
|
||||||
f.mu.Unlock()
|
|
||||||
|
|
||||||
if firstTime {
|
|
||||||
return nil, errSimTempFail
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.Fs.OpenFile(name, flag, perm)
|
|
||||||
}
|
|
||||||
|
|
||||||
// readFailFile wraps an afero.File whose Read always fails.
|
|
||||||
type readFailFile struct {
|
|
||||||
afero.File
|
|
||||||
}
|
|
||||||
|
|
||||||
func (readFailFile) Read([]byte) (int, error) {
|
|
||||||
return 0, errSimRead
|
|
||||||
}
|
|
||||||
|
|
||||||
// readFailFs fails reads of one target path after a successful open.
|
|
||||||
type readFailFs struct {
|
|
||||||
afero.Fs
|
|
||||||
|
|
||||||
target string
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:ireturn // afero.Fs.Open is defined to return the interface.
|
|
||||||
func (f *readFailFs) Open(name string) (afero.File, error) {
|
|
||||||
file, err := f.Fs.Open(name)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if name == f.target {
|
|
||||||
return readFailFile{File: file}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return file, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeSkipErrorTestFile writes one file into fs with a fixed mtime.
|
|
||||||
func writeSkipErrorTestFile(t *testing.T, fs afero.Fs, path, content string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
err := fs.MkdirAll(filepath.Dir(path), 0755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("mkdir: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = afero.WriteFile(fs, path, []byte(content), 0644)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("write %s: %v", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
when := time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC)
|
|
||||||
|
|
||||||
err = fs.Chtimes(path, when, when)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("chtimes %s: %v", path, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// runSkipErrorScan scans /source on fs with the given skip-errors setting and
|
|
||||||
// returns the repositories (for inspection) and the scan error.
|
|
||||||
func runSkipErrorScan(
|
|
||||||
t *testing.T, fs afero.Fs, skipErrors bool,
|
|
||||||
) (*database.Repositories, error) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
db, err := database.NewTestDB()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create test db: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
cerr := db.Close()
|
|
||||||
if cerr != nil {
|
|
||||||
t.Errorf("close db: %v", cerr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
scanner := snapshot.NewScanner(snapshot.ScannerConfig{
|
|
||||||
FS: fs,
|
|
||||||
ChunkSize: int64(1024 * 16),
|
|
||||||
Repositories: repos,
|
|
||||||
MaxBlobSize: int64(1024 * 1024),
|
|
||||||
CompressionLevel: 3,
|
|
||||||
AgeRecipients: []string{testAgePublicKey},
|
|
||||||
SkipErrors: skipErrors,
|
|
||||||
})
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
snapshotID := "test-snapshot-skip-errors"
|
|
||||||
createTestSnapshotRecord(ctx, t, repos, snapshotID)
|
|
||||||
|
|
||||||
_, err = scanner.Scan(ctx, "/source", snapshotID)
|
|
||||||
|
|
||||||
return repos, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestScannerPackingFailureAbortsUnderSkipErrors checks that a failure to start
|
|
||||||
// a new blob aborts the run even with --skip-errors. Otherwise the file would
|
|
||||||
// be skipped while its chunk had already been registered as pending, letting a
|
|
||||||
// later blob record that chunk in the chunks table with no blob to back it —
|
|
||||||
// a snapshot that completes with a file that cannot be restored.
|
|
||||||
func TestScannerPackingFailureAbortsUnderSkipErrors(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// Two files with distinct content so each yields a distinct chunk: the
|
|
||||||
// first fails to start a blob, and without the fix the second's blob would
|
|
||||||
// commit the first's orphaned chunk row.
|
|
||||||
fs := &blobTempFailFs{Fs: afero.NewMemMapFs()}
|
|
||||||
writeSkipErrorTestFile(t, fs, "/source/file1.txt", "first file content")
|
|
||||||
writeSkipErrorTestFile(t, fs, "/source/file2.txt", "second file content")
|
|
||||||
|
|
||||||
repos, err := runSkipErrorScan(t, fs, true)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected scan to abort on the packer error, got nil")
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListUnpacked returns chunks recorded with no blob_chunks row: exactly the
|
|
||||||
// unrestorable state this fix prevents.
|
|
||||||
unpacked, err := repos.Chunks.ListUnpacked(context.Background(), 10)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listing unpacked chunks: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(unpacked) != 0 {
|
|
||||||
t.Fatalf("expected no chunk recorded without a blob, got %d", len(unpacked))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestScannerReadErrorAbortsWithoutSkipErrors checks that a file read error
|
|
||||||
// aborts the run when --skip-errors is not set.
|
|
||||||
func TestScannerReadErrorAbortsWithoutSkipErrors(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const target = "/source/unreadable.txt"
|
|
||||||
|
|
||||||
fs := &readFailFs{Fs: afero.NewMemMapFs(), target: target}
|
|
||||||
writeSkipErrorTestFile(t, fs, target, "content that cannot be read")
|
|
||||||
|
|
||||||
_, err := runSkipErrorScan(t, fs, false)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected scan to fail on the read error, got nil")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestScannerReadErrorSkippedWithSkipErrors checks that a file read error is
|
|
||||||
// skipped and the run completes when --skip-errors is set.
|
|
||||||
func TestScannerReadErrorSkippedWithSkipErrors(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const target = "/source/unreadable.txt"
|
|
||||||
|
|
||||||
fs := &readFailFs{Fs: afero.NewMemMapFs(), target: target}
|
|
||||||
writeSkipErrorTestFile(t, fs, target, "content that cannot be read")
|
|
||||||
|
|
||||||
repos, err := runSkipErrorScan(t, fs, true)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected scan to complete with --skip-errors, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
chunks, err := repos.FileChunks.GetByFile(context.Background(), target)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("getting file chunks: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(chunks) != 0 {
|
|
||||||
t.Fatalf("expected unreadable file skipped, got %d chunks", len(chunks))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+115
-52
@@ -44,7 +44,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os/exec"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@@ -295,6 +295,68 @@ func (sm *SnapshotManager) ExportSnapshotMetadata(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// CleanupIncompleteSnapshots removes incomplete snapshots that don't have
|
||||||
|
// metadata in S3. This is critical for data safety: incomplete snapshots
|
||||||
|
// can cause deduplication to skip files that were never successfully
|
||||||
|
// backed up, resulting in data loss.
|
||||||
|
func (sm *SnapshotManager) CleanupIncompleteSnapshots(
|
||||||
|
ctx context.Context, hostname string,
|
||||||
|
) error {
|
||||||
|
log.Info("Checking for incomplete snapshots", "hostname", hostname)
|
||||||
|
|
||||||
|
// Get all incomplete snapshots for this hostname
|
||||||
|
incompleteSnapshots, err := sm.repos.Snapshots.GetIncompleteByHostname(ctx, hostname)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("getting incomplete snapshots: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(incompleteSnapshots) == 0 {
|
||||||
|
log.Debug("No incomplete snapshots found")
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Info("Found incomplete snapshots", "count", len(incompleteSnapshots))
|
||||||
|
|
||||||
|
// Check each incomplete snapshot for metadata in storage
|
||||||
|
for _, snapshot := range incompleteSnapshots {
|
||||||
|
// Check if metadata exists in storage (paths use the hashed
|
||||||
|
// remote key so we don't leak host info to the listing).
|
||||||
|
metadataKey := fmt.Sprintf("metadata/%s/db.zst",
|
||||||
|
RemoteSnapshotKey(snapshot.ID.String()))
|
||||||
|
|
||||||
|
_, err := sm.storage.Stat(ctx, metadataKey)
|
||||||
|
if err != nil {
|
||||||
|
// Metadata doesn't exist in S3 - this is an incomplete snapshot
|
||||||
|
log.Info("Cleaning up incomplete snapshot record",
|
||||||
|
"snapshot_id", snapshot.ID, "started_at", snapshot.StartedAt)
|
||||||
|
|
||||||
|
// Delete the snapshot and all its associations
|
||||||
|
err := sm.deleteSnapshot(ctx, snapshot.ID.String())
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("deleting incomplete snapshot %s: %w",
|
||||||
|
snapshot.ID, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Info("Deleted incomplete snapshot record and associated data",
|
||||||
|
"snapshot_id", snapshot.ID)
|
||||||
|
} else {
|
||||||
|
// Metadata exists - this snapshot was completed but database wasn't updated
|
||||||
|
// This shouldn't happen in normal operation, but mark it complete
|
||||||
|
log.Warn("Found snapshot with remote metadata but incomplete in database",
|
||||||
|
"snapshot_id", snapshot.ID)
|
||||||
|
|
||||||
|
err := sm.repos.Snapshots.MarkComplete(ctx, nil, snapshot.ID.String())
|
||||||
|
if err != nil {
|
||||||
|
log.Error("Failed to mark snapshot as complete in database",
|
||||||
|
"snapshot_id", snapshot.ID, "error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// CleanupOrphanedData removes files, chunks, and blobs that are no longer
|
// CleanupOrphanedData removes files, chunks, and blobs that are no longer
|
||||||
// referenced by any snapshot. This should be called periodically to clean
|
// referenced by any snapshot. This should be called periodically to clean
|
||||||
// up data from deleted or incomplete snapshots.
|
// up data from deleted or incomplete snapshots.
|
||||||
@@ -607,31 +669,14 @@ func (sm *SnapshotManager) collectCleanupStats(
|
|||||||
|
|
||||||
// vacuumDatabase runs VACUUM on the database to remove deleted data and compact
|
// vacuumDatabase runs VACUUM on the database to remove deleted data and compact
|
||||||
// This is critical for security - ensures no stale/deleted data pages are uploaded
|
// This is critical for security - ensures no stale/deleted data pages are uploaded
|
||||||
//
|
|
||||||
// VACUUM runs through the modernc.org/sqlite driver, on a freshly opened
|
|
||||||
// connection with no transaction in flight (VACUUM cannot run inside one).
|
|
||||||
// The database opens in WAL mode, so VACUUM's rewrite lands in the WAL; the
|
|
||||||
// checkpoint on Close flushes it into the main file, which is the file we
|
|
||||||
// then compress and upload.
|
|
||||||
func (sm *SnapshotManager) vacuumDatabase(ctx context.Context, dbPath string) error {
|
func (sm *SnapshotManager) vacuumDatabase(ctx context.Context, dbPath string) error {
|
||||||
log.Debug("Running VACUUM on database", "path", dbPath)
|
log.Debug("Running VACUUM on database", "path", dbPath)
|
||||||
|
//nolint:gosec // G204: fixed argv; dbPath is our own temp file path
|
||||||
|
cmd := exec.CommandContext(ctx, "sqlite3", dbPath, "VACUUM;")
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
output, err := cmd.CombinedOutput()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("opening database for VACUUM: %w", err)
|
return fmt.Errorf("running VACUUM: %w (output: %s)", err, string(output))
|
||||||
}
|
|
||||||
|
|
||||||
defer func() {
|
|
||||||
cerr := db.Close()
|
|
||||||
if cerr != nil {
|
|
||||||
log.Debug("Failed to close database after VACUUM",
|
|
||||||
"path", dbPath, "error", cerr)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
_, err = db.ExecWithLog(ctx, "VACUUM")
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("running VACUUM: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -697,18 +742,12 @@ func (sm *SnapshotManager) compressFile(inputPath, outputPath string) error {
|
|||||||
|
|
||||||
writerClosed = true
|
writerClosed = true
|
||||||
|
|
||||||
log.Debug("Compression complete", "hash", hex.EncodeToString(writer.ContentID()))
|
log.Debug("Compression complete", "hash", hex.EncodeToString(writer.Sum256()))
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// exportCopyPerm restricts the exported snapshot database copy to the owning
|
// copyFile copies a file from src to dst
|
||||||
// user; it holds the same private index data as the local index file.
|
|
||||||
const exportCopyPerm = 0o600
|
|
||||||
|
|
||||||
// copyFile copies a file from src to dst. The destination is the exported
|
|
||||||
// snapshot database, so it is created owner-only rather than with the
|
|
||||||
// umask-dependent default.
|
|
||||||
func (sm *SnapshotManager) copyFile(src, dst string) error {
|
func (sm *SnapshotManager) copyFile(src, dst string) error {
|
||||||
log.Debug("Opening source file for copy", "path", src)
|
log.Debug("Opening source file for copy", "path", src)
|
||||||
|
|
||||||
@@ -728,9 +767,7 @@ func (sm *SnapshotManager) copyFile(src, dst string) error {
|
|||||||
|
|
||||||
log.Debug("Creating destination file", "path", dst)
|
log.Debug("Creating destination file", "path", dst)
|
||||||
|
|
||||||
destFile, err := sm.fs.OpenFile(
|
destFile, err := sm.fs.Create(dst)
|
||||||
dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, exportCopyPerm,
|
|
||||||
)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -756,11 +793,6 @@ func (sm *SnapshotManager) copyFile(src, dst string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// errBlobMissingFromDatabase means a snapshot references a blob that is
|
|
||||||
// absent from the blobs table, so a complete manifest cannot be built.
|
|
||||||
var errBlobMissingFromDatabase = errors.New(
|
|
||||||
"blob referenced by snapshot is not in the database")
|
|
||||||
|
|
||||||
// generateBlobManifest creates a compressed JSON list of all blobs in the snapshot
|
// generateBlobManifest creates a compressed JSON list of all blobs in the snapshot
|
||||||
func (sm *SnapshotManager) generateBlobManifest(
|
func (sm *SnapshotManager) generateBlobManifest(
|
||||||
ctx context.Context, dbPath string, snapshotID string,
|
ctx context.Context, dbPath string, snapshotID string,
|
||||||
@@ -791,33 +823,25 @@ func (sm *SnapshotManager) generateBlobManifest(
|
|||||||
totalCompressedSize := int64(0)
|
totalCompressedSize := int64(0)
|
||||||
|
|
||||||
for _, hash := range blobHashes {
|
for _, hash := range blobHashes {
|
||||||
// Every blob the snapshot references must appear in the manifest.
|
|
||||||
// Prune consults only the manifest to decide what is still in use,
|
|
||||||
// so silently dropping a blob here would let a later prune delete
|
|
||||||
// it while this snapshot still needs it. A lookup failure or a
|
|
||||||
// missing blob row therefore fails manifest generation.
|
|
||||||
blob, err := repos.Blobs.GetByHash(ctx, hash)
|
blob, err := repos.Blobs.GetByHash(ctx, hash)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("getting blob details for %s: %w", hash, err)
|
log.Warn("Failed to get blob details", "hash", hash, "error", err)
|
||||||
}
|
|
||||||
|
|
||||||
if blob == nil {
|
continue
|
||||||
return nil, fmt.Errorf("%w: blob %s, snapshot %s",
|
|
||||||
errBlobMissingFromDatabase, hash, snapshotID)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if blob != nil {
|
||||||
blobs = append(blobs, BlobInfo{
|
blobs = append(blobs, BlobInfo{
|
||||||
Hash: hash,
|
Hash: hash,
|
||||||
CompressedSize: blob.CompressedSize,
|
CompressedSize: blob.CompressedSize,
|
||||||
})
|
})
|
||||||
totalCompressedSize += blob.CompressedSize
|
totalCompressedSize += blob.CompressedSize
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Create manifest. SnapshotID in the unencrypted manifest is the
|
// Create manifest. SnapshotID in the unencrypted manifest is the
|
||||||
// double-SHA256 remote key (see RemoteSnapshotKey), not the human ID,
|
// double-SHA256 remote key, not the human ID, so the public bytes
|
||||||
// so neither this field nor the directory name reveals the hostname or
|
// don't reveal hostname/snapshot-name/timestamp metadata.
|
||||||
// snapshot name. Timestamp below is written in the clear, so the backup
|
|
||||||
// time is observable to anyone who can read the manifest.
|
|
||||||
manifest := &Manifest{
|
manifest := &Manifest{
|
||||||
SnapshotID: RemoteSnapshotKey(snapshotID),
|
SnapshotID: RemoteSnapshotKey(snapshotID),
|
||||||
Timestamp: time.Now().UTC().Format(time.RFC3339),
|
Timestamp: time.Now().UTC().Format(time.RFC3339),
|
||||||
@@ -871,6 +895,45 @@ type ExtendedBackupStats struct {
|
|||||||
UploadDurationMs int64 // Total milliseconds spent uploading to S3
|
UploadDurationMs int64 // Total milliseconds spent uploading to S3
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// deleteSnapshot removes a snapshot and all its associations from the database
|
||||||
|
func (sm *SnapshotManager) deleteSnapshot(
|
||||||
|
ctx context.Context, snapshotID string,
|
||||||
|
) error {
|
||||||
|
// Delete snapshot_files entries
|
||||||
|
err := sm.repos.Snapshots.DeleteSnapshotFiles(ctx, snapshotID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("deleting snapshot files: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete snapshot_blobs entries
|
||||||
|
err = sm.repos.Snapshots.DeleteSnapshotBlobs(ctx, snapshotID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("deleting snapshot blobs: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete uploads entries (has foreign key to snapshots without CASCADE)
|
||||||
|
err = sm.repos.Snapshots.DeleteSnapshotUploads(ctx, snapshotID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("deleting snapshot uploads: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete the snapshot itself
|
||||||
|
err = sm.repos.Snapshots.Delete(ctx, snapshotID)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("deleting snapshot: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clean up orphaned data
|
||||||
|
log.Debug("Cleaning up orphaned records in main database")
|
||||||
|
|
||||||
|
err = sm.CleanupOrphanedData(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("cleaning up orphaned data: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// deleteOtherSnapshots deletes all snapshots except the current one
|
// deleteOtherSnapshots deletes all snapshots except the current one
|
||||||
func (sm *SnapshotManager) deleteOtherSnapshots(
|
func (sm *SnapshotManager) deleteOtherSnapshots(
|
||||||
ctx context.Context, tx *sql.Tx, currentSnapshotID string,
|
ctx context.Context, tx *sql.Tx, currentSnapshotID string,
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
package snapshot
|
package snapshot
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"context"
|
"context"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
"io"
|
"io"
|
||||||
@@ -97,97 +96,6 @@ func verifyCleanedDB(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestVacuumDatabaseRemovesDeletedData proves the export path uploads a
|
|
||||||
// compacted database: after rows carrying a recognizable marker are deleted
|
|
||||||
// and vacuumDatabase runs, no page holding that marker survives in the file
|
|
||||||
// on disk (the file compressFile later reads for upload).
|
|
||||||
func TestVacuumDatabaseRemovesDeletedData(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
dbPath := filepath.Join(tempDir, "snapshot.db")
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to create database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A marker distinctive enough that its presence in the raw file can only
|
|
||||||
// come from the rows inserted below.
|
|
||||||
marker := []byte("VACUUM_PROBE_DEADBEEF_DELETED_ROW")
|
|
||||||
payload := bytes.Repeat(marker, 128) // ~4 KiB per row
|
|
||||||
|
|
||||||
_, err = db.Conn().ExecContext(ctx,
|
|
||||||
"CREATE TABLE vacuum_probe (id INTEGER PRIMARY KEY, payload BLOB)")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to create probe table: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for range 512 {
|
|
||||||
_, err = db.Conn().ExecContext(ctx,
|
|
||||||
"INSERT INTO vacuum_probe (payload) VALUES (?)", payload)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to insert probe row: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = db.Conn().ExecContext(ctx, "DELETE FROM vacuum_probe")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to delete probe rows: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close so the deletes reach the main file, mirroring the state
|
|
||||||
// prepareExportDB hands to vacuumDatabase.
|
|
||||||
err = db.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to close database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
beforeInfo, err := fs.Stat(dbPath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to stat database before vacuum: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
beforeBytes, err := afero.ReadFile(fs, dbPath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to read database before vacuum: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !bytes.Contains(beforeBytes, marker) {
|
|
||||||
t.Fatalf("expected deleted-row data to linger before vacuum")
|
|
||||||
}
|
|
||||||
|
|
||||||
sm := &SnapshotManager{fs: fs}
|
|
||||||
|
|
||||||
err = sm.vacuumDatabase(ctx, dbPath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("vacuumDatabase failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
afterBytes, err := afero.ReadFile(fs, dbPath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to read database after vacuum: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if bytes.Contains(afterBytes, marker) {
|
|
||||||
t.Fatalf("deleted-row data survived vacuum in the uploaded file")
|
|
||||||
}
|
|
||||||
|
|
||||||
afterInfo, err := fs.Stat(dbPath)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("failed to stat database after vacuum: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if afterInfo.Size() >= beforeInfo.Size() {
|
|
||||||
t.Fatalf("expected vacuum to shrink the file: before=%d after=%d",
|
|
||||||
beforeInfo.Size(), afterInfo.Size())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCleanSnapshotDBEmptySnapshot(t *testing.T) {
|
func TestCleanSnapshotDBEmptySnapshot(t *testing.T) {
|
||||||
// Initialize logger
|
// Initialize logger
|
||||||
log.Initialize(log.Config{})
|
log.Initialize(log.Config{})
|
||||||
|
|||||||
@@ -1,198 +0,0 @@
|
|||||||
package storage_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"reflect"
|
|
||||||
"sort"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// runStorerConformance is the shared Storer contract. Every backend that
|
|
||||||
// can run in-process is expected to pass it: TestFileStorer runs it against
|
|
||||||
// file://, TestS3Storer against s3://. A new backend inherits this coverage
|
|
||||||
// by passing its own constructor, so the contract is defined once.
|
|
||||||
//
|
|
||||||
// It exercises the public Storer interface: round-trip, stat, list with
|
|
||||||
// prefix filtering, overwrite, delete, delete-of-missing, and not-found on
|
|
||||||
// Get and Stat. Each section takes its own fresh backend instance, so the
|
|
||||||
// order of sections never matters and no section sees another's objects.
|
|
||||||
func runStorerConformance(t *testing.T, newStorer func(*testing.T) storage.Storer) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
conformanceRoundTrip(t, newStorer(t))
|
|
||||||
conformanceOverwrite(t, newStorer(t))
|
|
||||||
conformanceList(t, newStorer(t))
|
|
||||||
conformanceDelete(t, newStorer(t))
|
|
||||||
conformanceNotFound(t, newStorer(t))
|
|
||||||
}
|
|
||||||
|
|
||||||
// conformanceRoundTrip stores a nested key, then reads it back and stats it.
|
|
||||||
func conformanceRoundTrip(t *testing.T, s storage.Storer) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
key := "blobs/aa/bb/object.bin"
|
|
||||||
want := []byte("round-trip payload")
|
|
||||||
|
|
||||||
err := s.Put(ctx, key, bytes.NewReader(want))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := getBytes(t, s, key)
|
|
||||||
if !bytes.Equal(got, want) {
|
|
||||||
t.Errorf("Get returned %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
|
|
||||||
info, err := s.Stat(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Stat: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if info.Key != key {
|
|
||||||
t.Errorf("Stat key = %q, want %q", info.Key, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
if info.Size != int64(len(want)) {
|
|
||||||
t.Errorf("Stat size = %d, want %d", info.Size, len(want))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// conformanceOverwrite checks that a second Put replaces the first.
|
|
||||||
func conformanceOverwrite(t *testing.T, s storage.Storer) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
key := "meta/snapshot.json"
|
|
||||||
|
|
||||||
err := s.Put(ctx, key, bytes.NewReader([]byte("first")))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("first Put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := []byte("second and longer payload")
|
|
||||||
|
|
||||||
err = s.Put(ctx, key, bytes.NewReader(want))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("second Put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got := getBytes(t, s, key)
|
|
||||||
if !bytes.Equal(got, want) {
|
|
||||||
t.Errorf("after overwrite Get returned %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// conformanceList checks prefix filtering and the empty result for a
|
|
||||||
// prefix that matches nothing.
|
|
||||||
func conformanceList(t *testing.T, s storage.Storer) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
keys := []string{"blobs/aa/one", "blobs/bb/two", "meta/three"}
|
|
||||||
|
|
||||||
for _, k := range keys {
|
|
||||||
err := s.Put(ctx, k, bytes.NewReader([]byte("data")))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Put %q: %v", k, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := listSorted(t, s, ""); !reflect.DeepEqual(got, keys) {
|
|
||||||
t.Errorf("List(\"\") = %v, want %v", got, keys)
|
|
||||||
}
|
|
||||||
|
|
||||||
wantBlobs := []string{"blobs/aa/one", "blobs/bb/two"}
|
|
||||||
if got := listSorted(t, s, "blobs/"); !reflect.DeepEqual(got, wantBlobs) {
|
|
||||||
t.Errorf("List(\"blobs/\") = %v, want %v", got, wantBlobs)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got := listSorted(t, s, "absent/"); len(got) != 0 {
|
|
||||||
t.Errorf("List(\"absent/\") = %v, want empty", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// conformanceDelete checks that Delete removes an object and that deleting
|
|
||||||
// a missing key is not an error.
|
|
||||||
func conformanceDelete(t *testing.T, s storage.Storer) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
key := "blobs/cc/gone.bin"
|
|
||||||
|
|
||||||
err := s.Put(ctx, key, bytes.NewReader([]byte("temporary")))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = s.Delete(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Delete: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = s.Get(ctx, key)
|
|
||||||
if !errors.Is(err, storage.ErrNotFound) {
|
|
||||||
t.Errorf("Get after Delete error = %v, want ErrNotFound", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = s.Delete(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("Delete of missing key = %v, want nil", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// conformanceNotFound checks Get and Stat on an absent key.
|
|
||||||
func conformanceNotFound(t *testing.T, s storage.Storer) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
key := "never/written"
|
|
||||||
|
|
||||||
_, err := s.Get(ctx, key)
|
|
||||||
if !errors.Is(err, storage.ErrNotFound) {
|
|
||||||
t.Errorf("Get error = %v, want ErrNotFound", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = s.Stat(ctx, key)
|
|
||||||
if !errors.Is(err, storage.ErrNotFound) {
|
|
||||||
t.Errorf("Stat error = %v, want ErrNotFound", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// getBytes reads a key fully and closes the reader.
|
|
||||||
func getBytes(t *testing.T, s storage.Storer, key string) []byte {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
rc, err := s.Get(context.Background(), key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Get %q: %v", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() { _ = rc.Close() }()
|
|
||||||
|
|
||||||
data, err := io.ReadAll(rc)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read %q: %v", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return data
|
|
||||||
}
|
|
||||||
|
|
||||||
// listSorted returns the keys under a prefix in a stable order.
|
|
||||||
func listSorted(t *testing.T, s storage.Storer, prefix string) []string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
keys, err := s.List(context.Background(), prefix)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("List %q: %v", prefix, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
sort.Strings(keys)
|
|
||||||
|
|
||||||
return keys
|
|
||||||
}
|
|
||||||
@@ -1,209 +0,0 @@
|
|||||||
// Package faultstore provides a storage.Storer wrapper that injects
|
|
||||||
// faults on demand, so tests can reproduce the failure modes a real
|
|
||||||
// backend exhibits: an upload that fails partway, a backend that reports
|
|
||||||
// success while storing nothing, and reads that return corrupt or
|
|
||||||
// truncated bytes. It is the seam called for by the fault-injection
|
|
||||||
// tests (sneak/vaultik issue 72) and is meant to be reused by future
|
|
||||||
// tests rather than re-implemented per case.
|
|
||||||
//
|
|
||||||
// The wrapper delegates every method to the inner Storer. Two hooks
|
|
||||||
// change that: OnPut decides the fate of each write, and OnGet decides
|
|
||||||
// how each read's bytes are returned. Both are keyed by the object key,
|
|
||||||
// so a test can fault only blobs, only metadata, or a single object.
|
|
||||||
package faultstore
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrInjectedUpload is returned by a Put the OnPut hook chose to fail.
|
|
||||||
var ErrInjectedUpload = errors.New("faultstore: injected upload failure")
|
|
||||||
|
|
||||||
// PutAction is the disposition OnPut assigns to a write.
|
|
||||||
type PutAction int
|
|
||||||
|
|
||||||
const (
|
|
||||||
// PutNormal writes through to the inner Storer.
|
|
||||||
PutNormal PutAction = iota
|
|
||||||
// PutFail reads part of the stream, then fails without storing the
|
|
||||||
// object — a network upload that dies partway through.
|
|
||||||
PutFail
|
|
||||||
// PutSwallow reports success but stores nothing — a backend that
|
|
||||||
// lies about durability.
|
|
||||||
PutSwallow
|
|
||||||
)
|
|
||||||
|
|
||||||
// GetFault is how OnGet chooses to damage a read.
|
|
||||||
type GetFault int
|
|
||||||
|
|
||||||
const (
|
|
||||||
// GetNormal returns the stored bytes unchanged.
|
|
||||||
GetNormal GetFault = iota
|
|
||||||
// GetCorrupt flips a byte so the returned object no longer matches
|
|
||||||
// what was stored.
|
|
||||||
GetCorrupt
|
|
||||||
// GetTruncate returns a short read: the object's bytes cut off
|
|
||||||
// before the end.
|
|
||||||
GetTruncate
|
|
||||||
)
|
|
||||||
|
|
||||||
// Storer wraps an inner storage.Storer with fault-injection hooks. A
|
|
||||||
// zero-valued hook means "no fault": construct with New and set only the
|
|
||||||
// hook a test needs.
|
|
||||||
type Storer struct {
|
|
||||||
inner storage.Storer
|
|
||||||
|
|
||||||
// OnPut, when set, is consulted before every Put and
|
|
||||||
// PutWithProgress with the object key.
|
|
||||||
OnPut func(key string) PutAction
|
|
||||||
|
|
||||||
// OnGet, when set, is consulted for every Get with the object key
|
|
||||||
// and damages the returned bytes accordingly.
|
|
||||||
OnGet func(key string) GetFault
|
|
||||||
}
|
|
||||||
|
|
||||||
// New wraps inner. inner must be non-nil.
|
|
||||||
func New(inner storage.Storer) *Storer {
|
|
||||||
return &Storer{inner: inner}
|
|
||||||
}
|
|
||||||
|
|
||||||
// midStreamBytes is how far a PutFail reads before failing, enough to be
|
|
||||||
// past the start of any real blob without depending on the blob's size.
|
|
||||||
const midStreamBytes = 512
|
|
||||||
|
|
||||||
// Put stores data unless OnPut faults the write.
|
|
||||||
func (f *Storer) Put(ctx context.Context, key string, data io.Reader) error {
|
|
||||||
handled, err := f.injectPut(key, data)
|
|
||||||
if handled {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.inner.Put(ctx, key, data)
|
|
||||||
}
|
|
||||||
|
|
||||||
// PutWithProgress stores data unless OnPut faults the write.
|
|
||||||
func (f *Storer) PutWithProgress(
|
|
||||||
ctx context.Context, key string, data io.Reader,
|
|
||||||
size int64, progress storage.ProgressCallback,
|
|
||||||
) error {
|
|
||||||
handled, err := f.injectPut(key, data)
|
|
||||||
if handled {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.inner.PutWithProgress(ctx, key, data, size, progress)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get retrieves data, damaging it if OnGet faults the read.
|
|
||||||
func (f *Storer) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
|
||||||
rc, err := f.inner.Get(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
fault := GetNormal
|
|
||||||
if f.OnGet != nil {
|
|
||||||
fault = f.OnGet(key)
|
|
||||||
}
|
|
||||||
|
|
||||||
if fault == GetNormal {
|
|
||||||
return rc, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
data, err := io.ReadAll(rc)
|
|
||||||
_ = rc.Close()
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return io.NopCloser(bytes.NewReader(damage(fault, data))), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// damage returns a faulted copy of the stored bytes. GetCorrupt flips a
|
|
||||||
// byte in the middle so decryption authentication fails; GetTruncate
|
|
||||||
// drops the final byte so the read ends short. Both are no-ops on empty
|
|
||||||
// input, which cannot be damaged into something distinguishable.
|
|
||||||
func damage(fault GetFault, data []byte) []byte {
|
|
||||||
out := make([]byte, len(data))
|
|
||||||
copy(out, data)
|
|
||||||
|
|
||||||
if len(out) == 0 {
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
switch fault {
|
|
||||||
case GetCorrupt:
|
|
||||||
out[len(out)/2] ^= 0xff
|
|
||||||
case GetTruncate:
|
|
||||||
out = out[:len(out)-1]
|
|
||||||
case GetNormal:
|
|
||||||
}
|
|
||||||
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stat delegates unchanged.
|
|
||||||
func (f *Storer) Stat(ctx context.Context, key string) (*storage.ObjectInfo, error) {
|
|
||||||
return f.inner.Stat(ctx, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Delete delegates unchanged.
|
|
||||||
func (f *Storer) Delete(ctx context.Context, key string) error {
|
|
||||||
return f.inner.Delete(ctx, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
// List delegates unchanged.
|
|
||||||
func (f *Storer) List(ctx context.Context, prefix string) ([]string, error) {
|
|
||||||
return f.inner.List(ctx, prefix)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListStream delegates unchanged.
|
|
||||||
func (f *Storer) ListStream(
|
|
||||||
ctx context.Context, prefix string,
|
|
||||||
) <-chan storage.ObjectInfo {
|
|
||||||
return f.inner.ListStream(ctx, prefix)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Info delegates unchanged.
|
|
||||||
func (f *Storer) Info() storage.Info {
|
|
||||||
return f.inner.Info()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *Storer) putAction(key string) PutAction {
|
|
||||||
if f.OnPut == nil {
|
|
||||||
return PutNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
return f.OnPut(key)
|
|
||||||
}
|
|
||||||
|
|
||||||
// injectPut handles the non-normal write dispositions. It reports
|
|
||||||
// whether it handled the write and, if so, with what error.
|
|
||||||
func (f *Storer) injectPut(key string, data io.Reader) (bool, error) {
|
|
||||||
switch f.putAction(key) {
|
|
||||||
case PutFail:
|
|
||||||
// Consume part of the stream so the failure lands mid-transfer,
|
|
||||||
// the way a dropped connection would, then error without
|
|
||||||
// storing anything.
|
|
||||||
_, _ = io.CopyN(io.Discard, data, midStreamBytes)
|
|
||||||
|
|
||||||
return true, fmt.Errorf("%w for %q", ErrInjectedUpload, key)
|
|
||||||
case PutSwallow:
|
|
||||||
// A lying backend still drains the request body, then keeps
|
|
||||||
// nothing.
|
|
||||||
_, _ = io.Copy(io.Discard, data)
|
|
||||||
|
|
||||||
return true, nil
|
|
||||||
case PutNormal:
|
|
||||||
return false, nil
|
|
||||||
default:
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+54
-79
@@ -46,18 +46,31 @@ func (f *FileStorer) SetFilesystem(fs afero.Fs) {
|
|||||||
// storage base path.
|
// storage base path.
|
||||||
const storageDirPerm = 0o755
|
const storageDirPerm = 0o755
|
||||||
|
|
||||||
// tempSuffix marks a partially written object. writeAtomic streams into a
|
|
||||||
// temp file carrying this suffix and only renames it onto the real key once
|
|
||||||
// the whole object is on disk, so an interrupted write can never leave a
|
|
||||||
// truncated object at the key a later run would Stat and trust as a complete
|
|
||||||
// blob. List and ListStream skip these files, so a leftover from an
|
|
||||||
// interrupted write is never listed or trusted as a blob; it is otherwise
|
|
||||||
// harmless and is overwritten when the same key is written again.
|
|
||||||
const tempSuffix = ".partial"
|
|
||||||
|
|
||||||
// Put stores data at the specified key.
|
// Put stores data at the specified key.
|
||||||
func (f *FileStorer) Put(_ context.Context, key string, data io.Reader) error {
|
func (f *FileStorer) Put(_ context.Context, key string, data io.Reader) error {
|
||||||
return f.writeAtomic(key, data, nil)
|
path := f.fullPath(key)
|
||||||
|
|
||||||
|
// Create parent directories
|
||||||
|
dir := filepath.Dir(path)
|
||||||
|
|
||||||
|
err := f.fs.MkdirAll(dir, storageDirPerm)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("creating directories: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
file, err := f.fs.Create(path)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("creating file: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = file.Close() }()
|
||||||
|
|
||||||
|
_, err = io.Copy(file, data)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("writing file: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// PutWithProgress stores data with progress reporting.
|
// PutWithProgress stores data with progress reporting.
|
||||||
@@ -65,7 +78,35 @@ func (f *FileStorer) PutWithProgress(
|
|||||||
_ context.Context, key string, data io.Reader,
|
_ context.Context, key string, data io.Reader,
|
||||||
_ int64, progress ProgressCallback,
|
_ int64, progress ProgressCallback,
|
||||||
) error {
|
) error {
|
||||||
return f.writeAtomic(key, data, progress)
|
path := f.fullPath(key)
|
||||||
|
|
||||||
|
// Create parent directories
|
||||||
|
dir := filepath.Dir(path)
|
||||||
|
|
||||||
|
err := f.fs.MkdirAll(dir, storageDirPerm)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("creating directories: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
file, err := f.fs.Create(path)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("creating file: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = file.Close() }()
|
||||||
|
|
||||||
|
// Wrap with progress tracking
|
||||||
|
pw := &progressWriter{
|
||||||
|
writer: file,
|
||||||
|
callback: progress,
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = io.Copy(pw, data)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("writing file: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get retrieves data from the specified key.
|
// Get retrieves data from the specified key.
|
||||||
@@ -147,7 +188,7 @@ func (f *FileStorer) List(ctx context.Context, prefix string) ([]string, error)
|
|||||||
default:
|
default:
|
||||||
}
|
}
|
||||||
|
|
||||||
if !info.IsDir() && !strings.HasSuffix(info.Name(), tempSuffix) {
|
if !info.IsDir() {
|
||||||
// Convert back to key (relative path from basePath)
|
// Convert back to key (relative path from basePath)
|
||||||
relPath, err := filepath.Rel(f.basePath, path)
|
relPath, err := filepath.Rel(f.basePath, path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -204,7 +245,7 @@ func (f *FileStorer) ListStream(ctx context.Context, prefix string) <-chan Objec
|
|||||||
return nil //nolint:nilerr // continue walking despite errors
|
return nil //nolint:nilerr // continue walking despite errors
|
||||||
}
|
}
|
||||||
|
|
||||||
if !info.IsDir() && !strings.HasSuffix(info.Name(), tempSuffix) {
|
if !info.IsDir() {
|
||||||
relPath, err := filepath.Rel(f.basePath, path)
|
relPath, err := filepath.Rel(f.basePath, path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
ch <- ObjectInfo{Err: fmt.Errorf("computing relative path: %w", err)}
|
ch <- ObjectInfo{Err: fmt.Errorf("computing relative path: %w", err)}
|
||||||
@@ -234,72 +275,6 @@ func (f *FileStorer) Info() Info {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// writeAtomic streams data into a temp file in the destination directory,
|
|
||||||
// fsyncs it, and renames it onto the final key. The key therefore appears
|
|
||||||
// only once the whole object has been durably written; a failure part-way
|
|
||||||
// leaves a temp file (removed here on the failing path) rather than a
|
|
||||||
// truncated object at the key.
|
|
||||||
func (f *FileStorer) writeAtomic(
|
|
||||||
key string, data io.Reader, progress ProgressCallback,
|
|
||||||
) error {
|
|
||||||
path := f.fullPath(key)
|
|
||||||
dir := filepath.Dir(path)
|
|
||||||
|
|
||||||
err := f.fs.MkdirAll(dir, storageDirPerm)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("creating directories: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tmp, err := afero.TempFile(f.fs, dir, filepath.Base(path)+"-*"+tempSuffix)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("creating temp file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tmpPath := tmp.Name()
|
|
||||||
|
|
||||||
// Remove the temp file unless the rename below claims it. On the success
|
|
||||||
// path renamed is true, so the deferred Close and Remove are harmless
|
|
||||||
// no-ops on a name that no longer exists.
|
|
||||||
renamed := false
|
|
||||||
|
|
||||||
defer func() {
|
|
||||||
_ = tmp.Close()
|
|
||||||
|
|
||||||
if !renamed {
|
|
||||||
_ = f.fs.Remove(tmpPath)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
var w io.Writer = tmp
|
|
||||||
if progress != nil {
|
|
||||||
w = &progressWriter{writer: tmp, callback: progress}
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = io.Copy(w, data)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("writing file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = tmp.Sync()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("syncing temp file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = tmp.Close()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("closing temp file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = f.fs.Rename(tmpPath, path)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("renaming temp file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
renamed = true
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// fullPath returns the full filesystem path for a key.
|
// fullPath returns the full filesystem path for a key.
|
||||||
func (f *FileStorer) fullPath(key string) string {
|
func (f *FileStorer) fullPath(key string) string {
|
||||||
return filepath.Join(f.basePath, key)
|
return filepath.Join(f.basePath, key)
|
||||||
|
|||||||
@@ -1,119 +0,0 @@
|
|||||||
package storage_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// errStreamInterrupted stands in for an upload cut off mid-stream.
|
|
||||||
var errStreamInterrupted = errors.New("connection reset mid-upload")
|
|
||||||
|
|
||||||
// failingReader yields its data once, then fails.
|
|
||||||
type failingReader struct {
|
|
||||||
data []byte
|
|
||||||
done bool
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *failingReader) Read(p []byte) (int, error) {
|
|
||||||
if r.done {
|
|
||||||
return 0, errStreamInterrupted
|
|
||||||
}
|
|
||||||
|
|
||||||
n := copy(p, r.data)
|
|
||||||
r.done = true
|
|
||||||
|
|
||||||
return n, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFileStorer_InterruptedWriteLeavesNoTrustedObject checks that a write
|
|
||||||
// cut off mid-stream leaves nothing at the destination key, so a later run
|
|
||||||
// cannot Stat a truncated object and trust it as a complete blob.
|
|
||||||
func TestFileStorer_InterruptedWriteLeavesNoTrustedObject(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
f, err := storage.NewFileStorer(t.TempDir())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewFileStorer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
key := "blobs/aa/bb/aabbccddeeff"
|
|
||||||
|
|
||||||
err = f.PutWithProgress(ctx, key, &failingReader{data: []byte("partial")}, 4096, nil)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected the interrupted write to fail, got nil")
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = f.Stat(ctx, key)
|
|
||||||
if !errors.Is(err, storage.ErrNotFound) {
|
|
||||||
t.Fatalf("expected key absent after interrupted write, got Stat err %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
keys, err := f.List(ctx, "blobs/")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("List: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(keys) != 0 {
|
|
||||||
t.Fatalf("expected no keys listed after interrupted write, got %v", keys)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFileStorer_ListSkipsPartialFiles checks that a leftover temp file (the
|
|
||||||
// storage layer names them with a ".partial" suffix) is never surfaced as a
|
|
||||||
// key by List or ListStream.
|
|
||||||
func TestFileStorer_ListSkipsPartialFiles(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
base := t.TempDir()
|
|
||||||
|
|
||||||
f, err := storage.NewFileStorer(base)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewFileStorer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
realKey := "blobs/aa/bb/aabbccddeeff"
|
|
||||||
|
|
||||||
err = f.Put(ctx, realKey, strings.NewReader("blob-bytes"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A stray temp file, as an interrupted write would leave behind.
|
|
||||||
leftover := filepath.Join(base, "blobs/aa/bb/aabbccddeeff-123456.partial")
|
|
||||||
|
|
||||||
err = os.WriteFile(leftover, []byte("half"), 0o600)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("writing leftover temp file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
keys, err := f.List(ctx, "blobs/")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("List: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(keys) != 1 || keys[0] != realKey {
|
|
||||||
t.Fatalf("List should return only the real key, got %v", keys)
|
|
||||||
}
|
|
||||||
|
|
||||||
var streamed []string
|
|
||||||
|
|
||||||
for obj := range f.ListStream(ctx, "blobs/") {
|
|
||||||
if obj.Err != nil {
|
|
||||||
t.Fatalf("ListStream: %v", obj.Err)
|
|
||||||
}
|
|
||||||
|
|
||||||
streamed = append(streamed, obj.Key)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(streamed) != 1 || streamed[0] != realKey {
|
|
||||||
t.Fatalf("ListStream should return only the real key, got %v", streamed)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
package storage_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// newFileStorer builds a file:// backend rooted at a fresh temp directory.
|
|
||||||
//
|
|
||||||
//nolint:ireturn // conformance runs against the Storer interface by design
|
|
||||||
func newFileStorer(t *testing.T) storage.Storer {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
s, err := storage.NewFileStorer(t.TempDir())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewFileStorer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return s
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFileStorer runs the shared Storer contract against the file:// backend.
|
|
||||||
func TestFileStorer(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
runStorerConformance(t, newFileStorer)
|
|
||||||
}
|
|
||||||
@@ -111,11 +111,10 @@ func storerFromParsedS3URL(parsed *URL, cfg *config.Config) (Storer, error) {
|
|||||||
func storerFromLegacyS3Config(cfg *config.Config) (Storer, error) {
|
func storerFromLegacyS3Config(cfg *config.Config) (Storer, error) {
|
||||||
endpoint := cfg.S3.Endpoint
|
endpoint := cfg.S3.Endpoint
|
||||||
|
|
||||||
// Ensure protocol is present. Absent an explicit use_ssl, default to TLS;
|
// Ensure protocol is present
|
||||||
// plain HTTP only when use_ssl is written as false.
|
|
||||||
if !strings.HasPrefix(endpoint, "http://") &&
|
if !strings.HasPrefix(endpoint, "http://") &&
|
||||||
!strings.HasPrefix(endpoint, "https://") {
|
!strings.HasPrefix(endpoint, "https://") {
|
||||||
if cfg.S3.UseSSL == nil || *cfg.S3.UseSSL {
|
if cfg.S3.UseSSL {
|
||||||
endpoint = "https://" + endpoint
|
endpoint = "https://" + endpoint
|
||||||
} else {
|
} else {
|
||||||
endpoint = "http://" + endpoint
|
endpoint = "http://" + endpoint
|
||||||
|
|||||||
@@ -1,61 +0,0 @@
|
|||||||
package storage_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// legacyS3Config returns a minimal s3.* (no storage_url) configuration with a
|
|
||||||
// scheme-less endpoint. useSSL mirrors the config file: nil means the key is
|
|
||||||
// omitted, a pointer means it was written explicitly.
|
|
||||||
func legacyS3Config(useSSL *bool) *config.Config {
|
|
||||||
return &config.Config{
|
|
||||||
S3: config.S3Config{
|
|
||||||
Endpoint: "s3.example.com",
|
|
||||||
Bucket: "bucket",
|
|
||||||
AccessKeyID: "key",
|
|
||||||
SecretAccessKey: "secret",
|
|
||||||
Region: "us-east-1",
|
|
||||||
UseSSL: useSSL,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// endpointScheme builds the storer from cfg and returns the scheme its
|
|
||||||
// resolved endpoint carries (Info().Location is "endpoint/bucket").
|
|
||||||
func endpointScheme(t *testing.T, cfg *config.Config) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
storer, err := storage.NewStorer(cfg)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewStorer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
location := storer.Info().Location
|
|
||||||
switch {
|
|
||||||
case strings.HasPrefix(location, "https://"):
|
|
||||||
return "https"
|
|
||||||
case strings.HasPrefix(location, "http://"):
|
|
||||||
return "http"
|
|
||||||
default:
|
|
||||||
t.Fatalf("endpoint has no http(s) scheme: %q", location)
|
|
||||||
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLegacyS3SchemelessEndpointDefaultsToTLS(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
if got := endpointScheme(t, legacyS3Config(nil)); got != "https" {
|
|
||||||
t.Errorf("use_ssl omitted: got %q scheme, want https", got)
|
|
||||||
}
|
|
||||||
|
|
||||||
no := false
|
|
||||||
if got := endpointScheme(t, legacyS3Config(&no)); got != "http" {
|
|
||||||
t.Errorf("use_ssl: false: got %q scheme, want http", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
package storage_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// The rclone backend is a thin adapter over the rclone library: it turns a
|
|
||||||
// (remote, path) pair into rclone's "remote:path" string, hands it to
|
|
||||||
// rclone, and maps rclone's own results back to the Storer interface. What
|
|
||||||
// can be tested in-process, without a configured remote or network, is that
|
|
||||||
// adapter layer — how the arguments are shaped and how construction errors
|
|
||||||
// are reported. The data-plane operations (Put/Get/List/Delete) are rclone's
|
|
||||||
// own, exercised against a real provider (drive, s3-via-rclone, ...), which
|
|
||||||
// needs a configured remote with credentials and network access and so is
|
|
||||||
// out of reach of a unit test. The shared Storer conformance suite therefore
|
|
||||||
// runs against the in-process file and s3 backends; the rclone backend
|
|
||||||
// inherits that contract once a remote is configured.
|
|
||||||
//
|
|
||||||
// These tests use rclone's ":local:" on-the-fly backend, which addresses the
|
|
||||||
// local filesystem directly without any configured remote, so construction
|
|
||||||
// runs entirely in-process.
|
|
||||||
|
|
||||||
// TestNewRcloneStorerConstruction checks that a valid remote constructs a
|
|
||||||
// backend and that Info() reports the shaped "remote:path" location.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // NewRcloneStorer installs the process-global rclone config
|
|
||||||
func TestNewRcloneStorerConstruction(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
|
|
||||||
s, err := storage.NewRcloneStorer(context.Background(), ":local", dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewRcloneStorer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Info().Location is the "remote:path" string the adapter builds from
|
|
||||||
// its two arguments, so asserting it confirms the argument shaping.
|
|
||||||
want := ":local:" + dir
|
|
||||||
if got := s.Info().Location; got != want {
|
|
||||||
t.Errorf("Info().Location = %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewRcloneStorerUnknownRemote checks that a remote that is not in the
|
|
||||||
// rclone config fails construction with the ErrRemoteNotFound sentinel,
|
|
||||||
// rather than silently returning a backend pointed nowhere.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // NewRcloneStorer installs the process-global rclone config
|
|
||||||
func TestNewRcloneStorerUnknownRemote(t *testing.T) {
|
|
||||||
_, err := storage.NewRcloneStorer(
|
|
||||||
context.Background(), "vaultik-no-such-remote", "path")
|
|
||||||
if !errors.Is(err, storage.ErrRemoteNotFound) {
|
|
||||||
t.Errorf("NewRcloneStorer error = %v, want ErrRemoteNotFound", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+1
-16
@@ -38,29 +38,14 @@ func (s *S3Storer) PutWithProgress(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Get retrieves data from the specified key.
|
// Get retrieves data from the specified key.
|
||||||
// Returns ErrNotFound if the object does not exist.
|
|
||||||
func (s *S3Storer) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
func (s *S3Storer) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
||||||
rc, err := s.client.GetObject(ctx, key)
|
return s.client.GetObject(ctx, key)
|
||||||
if err != nil {
|
|
||||||
if s3.IsNotFound(err) {
|
|
||||||
return nil, fmt.Errorf("get %q: %w", key, ErrNotFound)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return rc, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stat returns metadata about an object without retrieving its contents.
|
// Stat returns metadata about an object without retrieving its contents.
|
||||||
// Returns ErrNotFound if the object does not exist.
|
|
||||||
func (s *S3Storer) Stat(ctx context.Context, key string) (*ObjectInfo, error) {
|
func (s *S3Storer) Stat(ctx context.Context, key string) (*ObjectInfo, error) {
|
||||||
info, err := s.client.StatObject(ctx, key)
|
info, err := s.client.StatObject(ctx, key)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if s3.IsNotFound(err) {
|
|
||||||
return nil, fmt.Errorf("stat %q: %w", key, ErrNotFound)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,81 +0,0 @@
|
|||||||
package storage_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"net/http/httptest"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/johannesboyne/gofakes3"
|
|
||||||
"github.com/johannesboyne/gofakes3/backend/s3mem"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/s3"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// s3TestBucket is the bucket created for each in-process S3 server.
|
|
||||||
const s3TestBucket = "test-bucket"
|
|
||||||
|
|
||||||
// newS3Storer builds an s3:// backend backed by a fresh in-process
|
|
||||||
// S3 server. It reuses the same in-memory S3 harness (gofakes3 + s3mem
|
|
||||||
// over httptest) that internal/s3 and the not-found regression test use,
|
|
||||||
// so no new mock or dependency is introduced. Each call gets its own
|
|
||||||
// server, bucket, and client, so the conformance suite's per-section
|
|
||||||
// instances stay isolated.
|
|
||||||
//
|
|
||||||
//nolint:ireturn // conformance runs against the Storer interface by design
|
|
||||||
func newS3Storer(t *testing.T) storage.Storer {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
backend := s3mem.New()
|
|
||||||
|
|
||||||
err := backend.CreateBucket(s3TestBucket)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create bucket: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
srv := httptest.NewServer(gofakes3.New(backend).Server())
|
|
||||||
t.Cleanup(srv.Close)
|
|
||||||
|
|
||||||
client, err := s3.NewClient(context.Background(), s3.Config{
|
|
||||||
Endpoint: srv.URL,
|
|
||||||
Bucket: s3TestBucket,
|
|
||||||
AccessKeyID: "test",
|
|
||||||
SecretAccessKey: "test",
|
|
||||||
Region: "us-east-1",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("new client: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return storage.NewS3Storer(client)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestS3Storer runs the shared Storer contract against the s3:// backend,
|
|
||||||
// so it is held to the same round-trip, list, delete, and not-found
|
|
||||||
// behaviour as the file:// backend.
|
|
||||||
func TestS3Storer(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
runStorerConformance(t, newS3Storer)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestS3StorerMissingKeyMapsToErrNotFound pins the specific contract that a
|
|
||||||
// missing object surfaces as storage.ErrNotFound rather than the raw AWS SDK
|
|
||||||
// error. Without the mapping, errors.Is(err, storage.ErrNotFound) is false on
|
|
||||||
// s3 and callers would branch differently per backend.
|
|
||||||
func TestS3StorerMissingKeyMapsToErrNotFound(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
storer := newS3Storer(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
_, err := storer.Get(ctx, "does-not-exist")
|
|
||||||
if !errors.Is(err, storage.ErrNotFound) {
|
|
||||||
t.Errorf("Get on missing key: got %v, want ErrNotFound", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = storer.Stat(ctx, "does-not-exist")
|
|
||||||
if !errors.Is(err, storage.ErrNotFound) {
|
|
||||||
t.Errorf("Stat on missing key: got %v, want ErrNotFound", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+17
-72
@@ -4,7 +4,6 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/url"
|
"net/url"
|
||||||
"slices"
|
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -24,10 +23,6 @@ var (
|
|||||||
ErrUnsupportedScheme = errors.New(
|
ErrUnsupportedScheme = errors.New(
|
||||||
"unsupported URL scheme: must start with s3://, file://, or rclone://")
|
"unsupported URL scheme: must start with s3://, file://, or rclone://")
|
||||||
ErrUnsupportedStorage = errors.New("unsupported storage scheme")
|
ErrUnsupportedStorage = errors.New("unsupported storage scheme")
|
||||||
ErrURLCredentials = errors.New(
|
|
||||||
"storage URL must not carry credentials; " +
|
|
||||||
"set s3.access_key_id and s3.secret_access_key in the config instead")
|
|
||||||
ErrURLUnknownParam = errors.New("unknown query parameter in storage URL")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// URL represents a parsed storage URL.
|
// URL represents a parsed storage URL.
|
||||||
@@ -64,28 +59,11 @@ func ParseStorageURL(rawURL string) (*URL, error) {
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Handle s3:// URLs
|
||||||
if strings.HasPrefix(rawURL, "s3://") {
|
if strings.HasPrefix(rawURL, "s3://") {
|
||||||
return parseS3URL(rawURL)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.HasPrefix(rawURL, "rclone://") {
|
|
||||||
return parseRcloneURL(rawURL)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, ErrUnsupportedScheme
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseS3URL parses an s3://bucket/prefix URL. It rejects credentials in
|
|
||||||
// the userinfo and any query parameter other than endpoint, region and
|
|
||||||
// ssl, so a credential-bearing URL is never stored or echoed.
|
|
||||||
func parseS3URL(rawURL string) (*URL, error) {
|
|
||||||
u, err := url.Parse(rawURL)
|
u, err := url.Parse(rawURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, wrapParseError(err)
|
return nil, fmt.Errorf("invalid URL: %w", err)
|
||||||
}
|
|
||||||
|
|
||||||
if u.User != nil {
|
|
||||||
return nil, ErrURLCredentials
|
|
||||||
}
|
}
|
||||||
|
|
||||||
bucket := u.Host
|
bucket := u.Host
|
||||||
@@ -93,34 +71,30 @@ func parseS3URL(rawURL string) (*URL, error) {
|
|||||||
return nil, ErrMissingBucket
|
return nil, ErrMissingBucket
|
||||||
}
|
}
|
||||||
|
|
||||||
|
prefix := strings.TrimPrefix(u.Path, "/")
|
||||||
|
|
||||||
query := u.Query()
|
query := u.Query()
|
||||||
|
|
||||||
err = rejectUnknownParams(query, "endpoint", "region", "ssl")
|
useSSL := true
|
||||||
if err != nil {
|
if query.Get("ssl") == "false" {
|
||||||
return nil, err
|
useSSL = false
|
||||||
}
|
}
|
||||||
|
|
||||||
return &URL{
|
return &URL{
|
||||||
Scheme: schemeS3,
|
Scheme: schemeS3,
|
||||||
Bucket: bucket,
|
Bucket: bucket,
|
||||||
Prefix: strings.TrimPrefix(u.Path, "/"),
|
Prefix: prefix,
|
||||||
Endpoint: query.Get("endpoint"),
|
Endpoint: query.Get("endpoint"),
|
||||||
Region: query.Get("region"),
|
Region: query.Get("region"),
|
||||||
UseSSL: query.Get("ssl") != "false",
|
UseSSL: useSSL,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
|
||||||
|
|
||||||
// parseRcloneURL parses an rclone://remote/path URL. rclone:// takes no
|
|
||||||
// query parameters, so credentials in the userinfo and any parameter at
|
|
||||||
// all are rejected rather than silently ignored.
|
|
||||||
func parseRcloneURL(rawURL string) (*URL, error) {
|
|
||||||
u, err := url.Parse(rawURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, wrapParseError(err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if u.User != nil {
|
// Handle rclone:// URLs
|
||||||
return nil, ErrURLCredentials
|
if strings.HasPrefix(rawURL, "rclone://") {
|
||||||
|
u, err := url.Parse(rawURL)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("invalid URL: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
remote := u.Host
|
remote := u.Host
|
||||||
@@ -128,45 +102,16 @@ func parseRcloneURL(rawURL string) (*URL, error) {
|
|||||||
return nil, ErrMissingRemote
|
return nil, ErrMissingRemote
|
||||||
}
|
}
|
||||||
|
|
||||||
err = rejectUnknownParams(u.Query())
|
path := strings.TrimPrefix(u.Path, "/")
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return &URL{
|
return &URL{
|
||||||
Scheme: schemeRclone,
|
Scheme: schemeRclone,
|
||||||
Prefix: strings.TrimPrefix(u.Path, "/"),
|
Prefix: path,
|
||||||
RcloneRemote: remote,
|
RcloneRemote: remote,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
|
||||||
|
|
||||||
// rejectUnknownParams returns an error naming the first query parameter
|
|
||||||
// not in allowed. The parameter's name is included (so a misspelt
|
|
||||||
// endpoint= is caught), but never its value, which could be a secret,
|
|
||||||
// and never the whole URL.
|
|
||||||
func rejectUnknownParams(query url.Values, allowed ...string) error {
|
|
||||||
for name := range query {
|
|
||||||
if !slices.Contains(allowed, name) {
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: %q; put credentials in s3.access_key_id and "+
|
|
||||||
"s3.secret_access_key, not the URL",
|
|
||||||
ErrURLUnknownParam, name)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil, ErrUnsupportedScheme
|
||||||
}
|
|
||||||
|
|
||||||
// wrapParseError wraps only the inner cause of a url.Parse failure. The
|
|
||||||
// *url.Error that url.Parse returns embeds the raw URL in its message, so
|
|
||||||
// wrapping it directly would echo a credential-bearing URL into logs.
|
|
||||||
func wrapParseError(err error) error {
|
|
||||||
var uerr *url.Error
|
|
||||||
if errors.As(err, &uerr) {
|
|
||||||
return fmt.Errorf("invalid URL: %w", uerr.Err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Errorf("invalid URL: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// String returns a human-readable representation of the storage URL.
|
// String returns a human-readable representation of the storage URL.
|
||||||
|
|||||||
@@ -1,208 +0,0 @@
|
|||||||
package storage_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"reflect"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestParseStorageURLValid checks that each supported scheme parses into
|
|
||||||
// the expected fields, since those fields decide which backend is built.
|
|
||||||
func TestParseStorageURLValid(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const bucket = "mybucket"
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
raw string
|
|
||||||
want *storage.URL
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "file absolute path",
|
|
||||||
raw: "file:///var/backups/vaultik",
|
|
||||||
want: &storage.URL{Scheme: "file", Prefix: "/var/backups/vaultik"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "s3 bucket and prefix, ssl defaults on",
|
|
||||||
raw: "s3://mybucket/backups/host",
|
|
||||||
want: &storage.URL{
|
|
||||||
Scheme: "s3", Bucket: bucket,
|
|
||||||
Prefix: "backups/host", UseSSL: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "s3 bucket only",
|
|
||||||
raw: "s3://mybucket",
|
|
||||||
want: &storage.URL{Scheme: "s3", Bucket: bucket, UseSSL: true},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "s3 with endpoint, region, ssl off",
|
|
||||||
raw: "s3://mybucket?endpoint=minio.example.com®ion=us-west-2&ssl=false",
|
|
||||||
want: &storage.URL{
|
|
||||||
Scheme: "s3", Bucket: bucket,
|
|
||||||
Endpoint: "minio.example.com", Region: "us-west-2", UseSSL: false,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "rclone remote and path",
|
|
||||||
raw: "rclone://gdrive/backups/host",
|
|
||||||
want: &storage.URL{
|
|
||||||
Scheme: "rclone", RcloneRemote: "gdrive", Prefix: "backups/host",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "rclone remote only",
|
|
||||||
raw: "rclone://gdrive",
|
|
||||||
want: &storage.URL{Scheme: "rclone", RcloneRemote: "gdrive"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
got, err := storage.ParseStorageURL(tc.raw)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ParseStorageURL(%q) returned error: %v", tc.raw, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !reflect.DeepEqual(got, tc.want) {
|
|
||||||
t.Errorf("ParseStorageURL(%q) = %+v, want %+v", tc.raw, got, tc.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParseStorageURLErrors checks that empty, missing, and unknown-scheme
|
|
||||||
// inputs fail with the documented sentinel errors instead of parsing to a
|
|
||||||
// wrong destination.
|
|
||||||
func TestParseStorageURLErrors(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
raw string
|
|
||||||
wantErr error
|
|
||||||
}{
|
|
||||||
{"empty url", "", storage.ErrEmptyStorageURL},
|
|
||||||
{"file empty path", "file://", storage.ErrEmptyFilePath},
|
|
||||||
{"s3 missing bucket", "s3://", storage.ErrMissingBucket},
|
|
||||||
{"s3 missing bucket with path", "s3:///justprefix", storage.ErrMissingBucket},
|
|
||||||
{"rclone missing remote", "rclone://", storage.ErrMissingRemote},
|
|
||||||
{"unknown scheme", "gs://bucket/x", storage.ErrUnsupportedScheme},
|
|
||||||
{"no scheme", "/local/path", storage.ErrUnsupportedScheme},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(tc.raw)
|
|
||||||
if !errors.Is(err, tc.wantErr) {
|
|
||||||
t.Errorf("ParseStorageURL(%q) error = %v, want %v",
|
|
||||||
tc.raw, err, tc.wantErr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParseStorageURLRejectsCredentials checks that a URL carrying
|
|
||||||
// credentials in its userinfo or in an unknown query parameter is
|
|
||||||
// rejected, and that the error never echoes the secret-bearing URL back
|
|
||||||
// into logs or output.
|
|
||||||
func TestParseStorageURLRejectsCredentials(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// Split so the literals never form a "user:pass@" URL pattern that
|
|
||||||
// tooling would flag as a real hardcoded credential.
|
|
||||||
const (
|
|
||||||
key = "AKIAKEY"
|
|
||||||
secret = "topsecret"
|
|
||||||
)
|
|
||||||
|
|
||||||
cases := []struct {
|
|
||||||
name string
|
|
||||||
raw string
|
|
||||||
wantErr error
|
|
||||||
secrets []string // must not appear in the error message
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "s3 userinfo",
|
|
||||||
raw: "s3://" + key + ":" + secret + "@mybucket/prefix",
|
|
||||||
wantErr: storage.ErrURLCredentials,
|
|
||||||
secrets: []string{key, secret, "mybucket"},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "s3 unknown query param",
|
|
||||||
raw: "s3://mybucket?access_key=" + key + "&secret=" + secret,
|
|
||||||
wantErr: storage.ErrURLUnknownParam,
|
|
||||||
secrets: []string{key, secret},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "s3 misspelt endpoint",
|
|
||||||
raw: "s3://mybucket?endpiont=minio.example.com",
|
|
||||||
wantErr: storage.ErrURLUnknownParam,
|
|
||||||
secrets: nil,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "rclone userinfo",
|
|
||||||
raw: "rclone://user:" + secret + "@gdrive/backups",
|
|
||||||
wantErr: storage.ErrURLCredentials,
|
|
||||||
secrets: []string{secret},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "rclone query param",
|
|
||||||
raw: "rclone://gdrive/backups?token=" + secret,
|
|
||||||
wantErr: storage.ErrURLUnknownParam,
|
|
||||||
secrets: []string{secret},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range cases {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(tc.raw)
|
|
||||||
if !errors.Is(err, tc.wantErr) {
|
|
||||||
t.Fatalf("ParseStorageURL(%q) error = %v, want %v",
|
|
||||||
tc.raw, err, tc.wantErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The rejection must name the proper config keys so the
|
|
||||||
// operator knows where credentials belong.
|
|
||||||
for _, key := range []string{"s3.access_key_id", "s3.secret_access_key"} {
|
|
||||||
if !strings.Contains(err.Error(), key) {
|
|
||||||
t.Errorf("error %q does not name %q", err.Error(), key)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, secret := range tc.secrets {
|
|
||||||
if strings.Contains(err.Error(), secret) {
|
|
||||||
t.Errorf("error message leaked %q: %v", secret, err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParseStorageURLParseFailureHidesURL checks that when url.Parse
|
|
||||||
// itself fails, the wrapped error carries only the inner cause, not the
|
|
||||||
// *url.Error whose text embeds the raw (possibly credential-bearing) URL.
|
|
||||||
func TestParseStorageURLParseFailureHidesURL(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const raw = "s3://mybucket/%zz"
|
|
||||||
|
|
||||||
_, err := storage.ParseStorageURL(raw)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatalf("ParseStorageURL(%q) returned no error", raw)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Contains(err.Error(), "mybucket") {
|
|
||||||
t.Errorf("error message echoed the raw URL: %v", err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+48
-3
@@ -1,7 +1,7 @@
|
|||||||
// Package types provides custom types for better type safety across the
|
// Package types provides custom types for better type safety across the
|
||||||
// vaultik codebase. Using distinct types for IDs, hashes, and paths prevents
|
// vaultik codebase. Using distinct types for IDs, hashes, paths, and
|
||||||
// accidental mixing of semantically different values that happen to share the
|
// credentials prevents accidental mixing of semantically different values
|
||||||
// same underlying type.
|
// that happen to share the same underlying type.
|
||||||
package types //nolint:revive,nolintlint // rename decision tracked in #76
|
package types //nolint:revive,nolintlint // rename decision tracked in #76
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -157,6 +157,34 @@ type FilePath string
|
|||||||
// Used during restore to strip the source prefix from paths.
|
// Used during restore to strip the source prefix from paths.
|
||||||
type SourcePath string
|
type SourcePath string
|
||||||
|
|
||||||
|
// AgeRecipient is an age public key used for encryption.
|
||||||
|
// Format: age1... (Bech32-encoded X25519 public key)
|
||||||
|
type AgeRecipient string
|
||||||
|
|
||||||
|
// AgeSecretKey is an age private key used for decryption.
|
||||||
|
// Format: AGE-SECRET-KEY-... (Bech32-encoded X25519 private key)
|
||||||
|
// This type should never be logged or serialized in plaintext.
|
||||||
|
type AgeSecretKey string
|
||||||
|
|
||||||
|
// S3Endpoint is the URL of an S3-compatible storage endpoint.
|
||||||
|
type S3Endpoint string
|
||||||
|
|
||||||
|
// BucketName is the name of an S3 bucket.
|
||||||
|
type BucketName string
|
||||||
|
|
||||||
|
// S3Prefix is the path prefix within an S3 bucket.
|
||||||
|
type S3Prefix string
|
||||||
|
|
||||||
|
// AWSRegion is an AWS region identifier (e.g., "us-east-1").
|
||||||
|
type AWSRegion string
|
||||||
|
|
||||||
|
// AWSAccessKeyID is an AWS access key ID for authentication.
|
||||||
|
type AWSAccessKeyID string
|
||||||
|
|
||||||
|
// AWSSecretAccessKey is an AWS secret access key for authentication.
|
||||||
|
// This type should never be logged or serialized in plaintext.
|
||||||
|
type AWSSecretAccessKey string
|
||||||
|
|
||||||
// Hostname identifies a host machine.
|
// Hostname identifies a host machine.
|
||||||
type Hostname string
|
type Hostname string
|
||||||
|
|
||||||
@@ -178,7 +206,24 @@ func (h ChunkHash) String() string { return string(h) }
|
|||||||
func (h BlobHash) String() string { return string(h) }
|
func (h BlobHash) String() string { return string(h) }
|
||||||
func (p FilePath) String() string { return string(p) }
|
func (p FilePath) String() string { return string(p) }
|
||||||
func (p SourcePath) String() string { return string(p) }
|
func (p SourcePath) String() string { return string(p) }
|
||||||
|
func (r AgeRecipient) String() string { return string(r) }
|
||||||
|
func (e S3Endpoint) String() string { return string(e) }
|
||||||
|
func (b BucketName) String() string { return string(b) }
|
||||||
|
func (p S3Prefix) String() string { return string(p) }
|
||||||
|
func (r AWSRegion) String() string { return string(r) }
|
||||||
|
func (k AWSAccessKeyID) String() string { return string(k) }
|
||||||
func (h Hostname) String() string { return string(h) }
|
func (h Hostname) String() string { return string(h) }
|
||||||
func (v Version) String() string { return string(v) }
|
func (v Version) String() string { return string(v) }
|
||||||
func (r GitRevision) String() string { return string(r) }
|
func (r GitRevision) String() string { return string(r) }
|
||||||
func (p GlobPattern) String() string { return string(p) }
|
func (p GlobPattern) String() string { return string(p) }
|
||||||
|
|
||||||
|
// Redacted String methods for sensitive types - prevents accidental logging
|
||||||
|
|
||||||
|
func (k AgeSecretKey) String() string { return "[REDACTED]" }
|
||||||
|
func (k AWSSecretAccessKey) String() string { return "[REDACTED]" }
|
||||||
|
|
||||||
|
// Raw returns the actual value for sensitive types when explicitly needed.
|
||||||
|
func (k AgeSecretKey) Raw() string { return string(k) }
|
||||||
|
|
||||||
|
// Raw returns the actual value for sensitive types when explicitly needed.
|
||||||
|
func (k AWSSecretAccessKey) Raw() string { return string(k) }
|
||||||
|
|||||||
@@ -1,136 +0,0 @@
|
|||||||
package types_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql"
|
|
||||||
"database/sql/driver"
|
|
||||||
"fmt"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/types"
|
|
||||||
)
|
|
||||||
|
|
||||||
// scannableID is the shared behaviour of the UUID-backed id types. A pointer
|
|
||||||
// to FileID or BlobID satisfies it, so both are tested through one set of
|
|
||||||
// cases.
|
|
||||||
type scannableID interface {
|
|
||||||
driver.Valuer
|
|
||||||
sql.Scanner
|
|
||||||
fmt.Stringer
|
|
||||||
IsZero() bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// idKind adapts one id type to the generic tests below.
|
|
||||||
type idKind struct {
|
|
||||||
name string
|
|
||||||
newZero func() scannableID
|
|
||||||
newRandom func() scannableID
|
|
||||||
parse func(string) (scannableID, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
func idKinds() []idKind {
|
|
||||||
return []idKind{
|
|
||||||
{
|
|
||||||
name: "FileID",
|
|
||||||
newZero: func() scannableID { return &types.FileID{} },
|
|
||||||
newRandom: func() scannableID {
|
|
||||||
id := types.NewFileID()
|
|
||||||
|
|
||||||
return &id
|
|
||||||
},
|
|
||||||
parse: func(s string) (scannableID, error) {
|
|
||||||
id, err := types.ParseFileID(s)
|
|
||||||
|
|
||||||
return &id, err
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "BlobID",
|
|
||||||
newZero: func() scannableID { return &types.BlobID{} },
|
|
||||||
newRandom: func() scannableID {
|
|
||||||
id := types.NewBlobID()
|
|
||||||
|
|
||||||
return &id
|
|
||||||
},
|
|
||||||
parse: func(s string) (scannableID, error) {
|
|
||||||
id, err := types.ParseBlobID(s)
|
|
||||||
|
|
||||||
return &id, err
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestIDValueScan checks that Value then Scan round trips from both a string
|
|
||||||
// and a []byte, that a NULL scans to the zero id, and that a non-string type
|
|
||||||
// and malformed text are rejected.
|
|
||||||
func TestIDValueScan(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for _, k := range idKinds() {
|
|
||||||
t.Run(k.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
orig := k.newRandom()
|
|
||||||
v, err := orig.Value()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s, ok := v.(string)
|
|
||||||
require.True(t, ok, "Value must yield a string")
|
|
||||||
|
|
||||||
fromString := k.newZero()
|
|
||||||
require.NoError(t, fromString.Scan(s))
|
|
||||||
assert.Equal(t, orig.String(), fromString.String())
|
|
||||||
assert.False(t, fromString.IsZero())
|
|
||||||
|
|
||||||
fromBytes := k.newZero()
|
|
||||||
require.NoError(t, fromBytes.Scan([]byte(s)))
|
|
||||||
assert.Equal(t, orig.String(), fromBytes.String())
|
|
||||||
|
|
||||||
nulled := k.newRandom()
|
|
||||||
require.NoError(t, nulled.Scan(nil))
|
|
||||||
assert.True(t, nulled.IsZero(), "NULL scans to the zero id")
|
|
||||||
|
|
||||||
require.Error(t, k.newZero().Scan(42),
|
|
||||||
"a non-string type must be rejected")
|
|
||||||
assert.Error(t, k.newZero().Scan("not-a-uuid"),
|
|
||||||
"malformed text must be rejected")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestIDParse checks that the Parse function accepts a canonical id and
|
|
||||||
// rejects malformed text.
|
|
||||||
func TestIDParse(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for _, k := range idKinds() {
|
|
||||||
t.Run(k.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
canonical := k.newRandom().String()
|
|
||||||
|
|
||||||
parsed, err := k.parse(canonical)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, canonical, parsed.String())
|
|
||||||
|
|
||||||
_, err = k.parse("not-a-uuid")
|
|
||||||
assert.Error(t, err)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestIDIsZero checks IsZero on the zero and on a freshly generated id.
|
|
||||||
func TestIDIsZero(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for _, k := range idKinds() {
|
|
||||||
t.Run(k.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
assert.True(t, k.newZero().IsZero())
|
|
||||||
assert.False(t, k.newRandom().IsZero())
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+3
-22
@@ -23,9 +23,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"strconv"
|
|
||||||
"time"
|
"time"
|
||||||
"unicode"
|
|
||||||
|
|
||||||
"github.com/dustin/go-humanize"
|
"github.com/dustin/go-humanize"
|
||||||
"golang.org/x/term"
|
"golang.org/x/term"
|
||||||
@@ -227,17 +225,17 @@ func (w *Writer) Hex(s string) string {
|
|||||||
short = s[:hexAbbrevLen] + "..."
|
short = s[:hexAbbrevLen] + "..."
|
||||||
}
|
}
|
||||||
|
|
||||||
return w.paint(ansiCyan, sanitize(short))
|
return w.paint(ansiCyan, short)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Snapshot colorizes a snapshot ID (full, no abbreviation).
|
// Snapshot colorizes a snapshot ID (full, no abbreviation).
|
||||||
func (w *Writer) Snapshot(id string) string {
|
func (w *Writer) Snapshot(id string) string {
|
||||||
return w.paint(ansiCyan+ansiBold, sanitize(id))
|
return w.paint(ansiCyan+ansiBold, id)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Path colorizes a filesystem path.
|
// Path colorizes a filesystem path.
|
||||||
func (w *Writer) Path(p string) string {
|
func (w *Writer) Path(p string) string {
|
||||||
return w.paint(ansiBlue, sanitize(p))
|
return w.paint(ansiBlue, p)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Size colorizes a byte count using humanize.Bytes.
|
// Size colorizes a byte count using humanize.Bytes.
|
||||||
@@ -312,23 +310,6 @@ func (w *Writer) paint(color, s string) string {
|
|||||||
return color + s + ansiReset
|
return color + s + ansiReset
|
||||||
}
|
}
|
||||||
|
|
||||||
// sanitize returns s unchanged when every rune in it is printable, and a
|
|
||||||
// double-quoted, backslash-escaped form (\n, \x1b, …) otherwise. The
|
|
||||||
// string value formatters escape their argument through this before
|
|
||||||
// painting: identifiers, paths and symlink targets they render come from
|
|
||||||
// the snapshot database, which is not trusted, and escaping must happen
|
|
||||||
// before colour is applied — the painted result already contains the
|
|
||||||
// escape codes the raw text would otherwise be indistinguishable from.
|
|
||||||
func sanitize(s string) string {
|
|
||||||
for _, r := range s {
|
|
||||||
if !unicode.IsPrint(r) {
|
|
||||||
return strconv.Quote(s)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return s
|
|
||||||
}
|
|
||||||
|
|
||||||
// emit writes "<prefix> <body>\n" with the prefix painted in prefixColor
|
// emit writes "<prefix> <body>\n" with the prefix painted in prefixColor
|
||||||
// and the body optionally painted in bodyColor (empty = no body color).
|
// and the body optionally painted in bodyColor (empty = no body color).
|
||||||
func (w *Writer) emit(prefixColor, prefix, bodyColor, format string, args []any) {
|
func (w *Writer) emit(prefixColor, prefix, bodyColor, format string, args []any) {
|
||||||
|
|||||||
@@ -1,32 +0,0 @@
|
|||||||
package ui_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestValueFormattersEscapeControlCharacters checks that a path carrying an
|
|
||||||
// ESC and a newline — the shape a symlink target read back from the
|
|
||||||
// snapshot database could take — is escaped before it reaches the output.
|
|
||||||
// Colour is off here, so the only way a control byte could appear is from
|
|
||||||
// the value itself.
|
|
||||||
func TestValueFormattersEscapeControlCharacters(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
w, buf := newTestWriter(false)
|
|
||||||
w.Infof("restoring %s", w.Path("a\x1b[31mZAP\nb"))
|
|
||||||
|
|
||||||
out := buf.String()
|
|
||||||
|
|
||||||
if strings.ContainsRune(out, '\x1b') {
|
|
||||||
t.Fatalf("raw ESC from a value survived in output: %q", out)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Count(out, "\n") != 1 {
|
|
||||||
t.Fatalf("a newline in a value must be escaped, not emitted raw: %q", out)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(out, `\x1b`) {
|
|
||||||
t.Fatalf("expected the escaped form of ESC in output: %q", out)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -2,40 +2,35 @@ package vaultik
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/sha256"
|
||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"time"
|
||||||
|
|
||||||
"filippo.io/age"
|
"filippo.io/age"
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
"sneak.berlin/go/vaultik/internal/blobgen"
|
||||||
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
)
|
)
|
||||||
|
|
||||||
// errBlobHashMismatch is returned when a fetched blob's content hash does
|
// errBlobHashMismatch is returned when a fetched blob's content hash does
|
||||||
// not match the expected double-SHA-256 hash.
|
// not match the expected double-SHA-256 hash.
|
||||||
var errBlobHashMismatch = errors.New("blob hash mismatch")
|
var errBlobHashMismatch = errors.New("blob hash mismatch")
|
||||||
|
|
||||||
// errBlobNotFullyRead is returned when the verifying reader is closed
|
|
||||||
// before its plaintext reached EOF. The hash can only be checked once
|
|
||||||
// the whole stream has been read, so an early or short-read close must
|
|
||||||
// fail rather than silently skip verification.
|
|
||||||
var errBlobNotFullyRead = errors.New(
|
|
||||||
"blob closed before fully read; hash not verified")
|
|
||||||
|
|
||||||
// hashVerifyReader wraps a blobgen.Reader and verifies the double-SHA-256 hash
|
// hashVerifyReader wraps a blobgen.Reader and verifies the double-SHA-256 hash
|
||||||
// of decrypted plaintext when Close is called. It reuses the hash that
|
// of decrypted plaintext when Close is called. It reuses the hash that
|
||||||
// blobgen.Reader already computes internally via its TeeReader, avoiding
|
// blobgen.Reader already computes internally via its TeeReader, avoiding
|
||||||
// redundant SHA-256 computation.
|
// redundant SHA-256 computation.
|
||||||
type hashVerifyReader struct {
|
type hashVerifyReader struct {
|
||||||
reader *blobgen.Reader // underlying decrypted blob reader (has internal hasher)
|
reader *blobgen.Reader // underlying decrypted blob reader (has internal hasher)
|
||||||
limited io.Reader // reader bounded to the blob's recorded plaintext size
|
|
||||||
fetcher io.ReadCloser // raw fetched stream (closed on Close)
|
fetcher io.ReadCloser // raw fetched stream (closed on Close)
|
||||||
blobHash string // expected double-SHA-256 hex
|
blobHash string // expected double-SHA-256 hex
|
||||||
done bool // EOF reached
|
done bool // EOF reached
|
||||||
}
|
}
|
||||||
|
|
||||||
func (h *hashVerifyReader) Read(p []byte) (int, error) {
|
func (h *hashVerifyReader) Read(p []byte) (int, error) {
|
||||||
n, err := h.limited.Read(p)
|
n, err := h.reader.Read(p)
|
||||||
if errors.Is(err, io.EOF) {
|
if errors.Is(err, io.EOF) {
|
||||||
h.done = true
|
h.done = true
|
||||||
}
|
}
|
||||||
@@ -43,22 +38,21 @@ func (h *hashVerifyReader) Read(p []byte) (int, error) {
|
|||||||
return n, err
|
return n, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Close closes the underlying readers and verifies the blob hash. The
|
// Close verifies the hash (if the stream was fully read) and closes underlying readers.
|
||||||
// hash check cannot be skipped: closing before the plaintext reached
|
|
||||||
// EOF (a short read or an early close) is an error, so a caller can
|
|
||||||
// never obtain unverified blob bytes.
|
|
||||||
func (h *hashVerifyReader) Close() error {
|
func (h *hashVerifyReader) Close() error {
|
||||||
readerErr := h.reader.Close()
|
readerErr := h.reader.Close()
|
||||||
fetcherErr := h.fetcher.Close()
|
fetcherErr := h.fetcher.Close()
|
||||||
|
|
||||||
if !h.done {
|
if h.done {
|
||||||
return errBlobNotFullyRead
|
firstHash := h.reader.Sum256()
|
||||||
}
|
secondHasher := sha256.New()
|
||||||
|
secondHasher.Write(firstHash)
|
||||||
|
|
||||||
actualHashHex := hex.EncodeToString(blobgen.DoubleSHA256(h.reader.Sum256()))
|
actualHashHex := hex.EncodeToString(secondHasher.Sum(nil))
|
||||||
if actualHashHex != h.blobHash {
|
if actualHashHex != h.blobHash {
|
||||||
return fmt.Errorf("%w: expected %s, got %s",
|
return fmt.Errorf("%w: expected %s, got %s",
|
||||||
errBlobHashMismatch, shortHash(h.blobHash), shortHash(actualHashHex))
|
errBlobHashMismatch, h.blobHash[:16], actualHashHex[:16])
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if readerErr != nil {
|
if readerErr != nil {
|
||||||
@@ -72,22 +66,15 @@ func (h *hashVerifyReader) Close() error {
|
|||||||
// returns a streaming reader that computes the double-SHA-256 hash on the fly.
|
// returns a streaming reader that computes the double-SHA-256 hash on the fly.
|
||||||
// The hash is verified when the returned reader is closed (after fully reading).
|
// The hash is verified when the returned reader is closed (after fully reading).
|
||||||
// This avoids buffering the entire blob in memory.
|
// This avoids buffering the entire blob in memory.
|
||||||
//
|
|
||||||
// maxPlaintextSize is the blob's uncompressed_size as recorded in the
|
|
||||||
// snapshot database. Decompression stops with blobgen.ErrOutputTooLarge
|
|
||||||
// once the plaintext exceeds it, so a tampered blob cannot expand without
|
|
||||||
// limit — using the recorded size, not the restoring host's
|
|
||||||
// blob_size_limit, since that config may differ from the backup host's.
|
|
||||||
func (v *Vaultik) FetchAndDecryptBlob(
|
func (v *Vaultik) FetchAndDecryptBlob(
|
||||||
ctx context.Context, blobHash string, maxPlaintextSize int64,
|
ctx context.Context, blobHash string, expectedSize int64, identity age.Identity,
|
||||||
identities ...age.Identity,
|
|
||||||
) (io.ReadCloser, error) {
|
) (io.ReadCloser, error) {
|
||||||
rc, err := v.FetchBlob(ctx, blobHash)
|
rc, _, err := v.FetchBlob(ctx, blobHash, expectedSize)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
reader, err := blobgen.NewReader(rc, identities...)
|
reader, err := blobgen.NewReader(rc, identity)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = rc.Close()
|
_ = rc.Close()
|
||||||
|
|
||||||
@@ -96,29 +83,45 @@ func (v *Vaultik) FetchAndDecryptBlob(
|
|||||||
|
|
||||||
return &hashVerifyReader{
|
return &hashVerifyReader{
|
||||||
reader: reader,
|
reader: reader,
|
||||||
limited: blobgen.LimitReader(reader, maxPlaintextSize),
|
|
||||||
fetcher: rc,
|
fetcher: rc,
|
||||||
blobHash: blobHash,
|
blobHash: blobHash,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// FetchBlob downloads a blob and returns a reader for the encrypted data.
|
// FetchBlob downloads a blob and returns a reader for the encrypted data.
|
||||||
|
// Times the Storage.Get and Storage.Stat round-trips separately at
|
||||||
|
// debug level so we can see whether the size-only Stat (which is an
|
||||||
|
// extra request on every fetch) is hurting throughput.
|
||||||
func (v *Vaultik) FetchBlob(
|
func (v *Vaultik) FetchBlob(
|
||||||
ctx context.Context, blobHash string,
|
ctx context.Context, blobHash string, expectedSize int64,
|
||||||
) (io.ReadCloser, error) {
|
) (io.ReadCloser, int64, error) {
|
||||||
// blobHash reaches here from the snapshot database, which is not
|
|
||||||
// trusted. Reject a malformed hash before it is spliced into a storage
|
|
||||||
// path (blobHash[:2]/blobHash[2:4]) or a fetch is attempted.
|
|
||||||
if !isBlobHash(blobHash) {
|
|
||||||
return nil, fmt.Errorf("%w: %s", errInvalidBlobHash, shortHash(blobHash))
|
|
||||||
}
|
|
||||||
|
|
||||||
blobPath := fmt.Sprintf("blobs/%s/%s/%s", blobHash[:2], blobHash[2:4], blobHash)
|
blobPath := fmt.Sprintf("blobs/%s/%s/%s", blobHash[:2], blobHash[2:4], blobHash)
|
||||||
|
|
||||||
|
t0 := time.Now()
|
||||||
rc, err := v.Storage.Get(ctx, blobPath)
|
rc, err := v.Storage.Get(ctx, blobPath)
|
||||||
|
getDur := time.Since(t0)
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("downloading blob %s: %w", shortHash(blobHash), err)
|
return nil, 0, fmt.Errorf("downloading blob %s: %w", blobHash[:16], err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return rc, nil
|
t0 = time.Now()
|
||||||
|
info, err := v.Storage.Stat(ctx, blobPath)
|
||||||
|
statDur := time.Since(t0)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
_ = rc.Close()
|
||||||
|
|
||||||
|
return nil, 0, fmt.Errorf("stat blob %s: %w", blobHash[:16], err)
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Debug("FetchBlob round-trips",
|
||||||
|
"hash", blobHash[:16],
|
||||||
|
"ms_storage_get", getDur.Milliseconds(),
|
||||||
|
"ms_storage_stat", statDur.Milliseconds(),
|
||||||
|
"expected_size", expectedSize,
|
||||||
|
"stat_size", info.Size,
|
||||||
|
)
|
||||||
|
|
||||||
|
return rc, info.Size, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,50 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"io"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestFetchAndDecryptBlobBoundsPlaintext feeds a small, highly
|
|
||||||
// compressible blob (256 KiB of zeros) whose decompressed size far exceeds
|
|
||||||
// the plaintext bound passed to FetchAndDecryptBlob. Decompression must
|
|
||||||
// stop with blobgen.ErrOutputTooLarge within the bound rather than
|
|
||||||
// expanding the whole blob into the restore cache.
|
|
||||||
func TestFetchAndDecryptBlobBoundsPlaintext(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
identity, err := age.GenerateX25519Identity()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
plaintext := make([]byte, 256*1024)
|
|
||||||
encryptedData, correctHash := buildHashTestBlob(t, identity, plaintext)
|
|
||||||
|
|
||||||
mockStorage := NewMockStorer()
|
|
||||||
blobPath := "blobs/" + correctHash[:2] + "/" +
|
|
||||||
correctHash[2:4] + "/" + correctHash
|
|
||||||
|
|
||||||
mockStorage.mu.Lock()
|
|
||||||
mockStorage.data[blobPath] = encryptedData
|
|
||||||
mockStorage.mu.Unlock()
|
|
||||||
|
|
||||||
tv := vaultik.NewForTesting(mockStorage)
|
|
||||||
|
|
||||||
const maxPlaintext = 1024
|
|
||||||
|
|
||||||
rc, err := tv.FetchAndDecryptBlob(
|
|
||||||
context.Background(), correctHash, maxPlaintext, identity)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
n, copyErr := io.Copy(io.Discard, rc)
|
|
||||||
_ = rc.Close()
|
|
||||||
|
|
||||||
require.ErrorIs(t, copyErr, blobgen.ErrOutputTooLarge)
|
|
||||||
require.LessOrEqual(t, n, int64(maxPlaintext)+1,
|
|
||||||
"decompression must stop within the recorded plaintext bound")
|
|
||||||
}
|
|
||||||
@@ -40,13 +40,13 @@ func buildHashTestBlob(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Compute the double-SHA-256 hash of the plaintext (matches
|
// Compute the double-SHA-256 hash of the plaintext (matches
|
||||||
// blobgen.Writer.ContentID).
|
// blobgen.Writer.Sum256).
|
||||||
firstHash := sha256.Sum256(plaintext)
|
firstHash := sha256.Sum256(plaintext)
|
||||||
secondHash := sha256.Sum256(firstHash[:])
|
secondHash := sha256.Sum256(firstHash[:])
|
||||||
correctHash := hex.EncodeToString(secondHash[:])
|
correctHash := hex.EncodeToString(secondHash[:])
|
||||||
|
|
||||||
// Verify our hash matches what blobgen.Writer produces
|
// Verify our hash matches what blobgen.Writer produces
|
||||||
writerHash := hex.EncodeToString(writer.ContentID())
|
writerHash := hex.EncodeToString(writer.Sum256())
|
||||||
if correctHash != writerHash {
|
if correctHash != writerHash {
|
||||||
t.Fatalf("hash computation mismatch: manual=%s, writer=%s",
|
t.Fatalf("hash computation mismatch: manual=%s, writer=%s",
|
||||||
correctHash, writerHash)
|
correctHash, writerHash)
|
||||||
@@ -55,35 +55,6 @@ func buildHashTestBlob(
|
|||||||
return encBuf.Bytes(), correctHash
|
return encBuf.Bytes(), correctHash
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestFetchBlobRejectsMalformedHash verifies FetchBlob refuses a blob hash
|
|
||||||
// that is not 64 lowercase hex characters before it builds a storage path
|
|
||||||
// or issues any request. The hash reaches FetchBlob from the snapshot
|
|
||||||
// database, which is not trusted, so a value such as one containing "/.."
|
|
||||||
// must never reach the store.
|
|
||||||
func TestFetchBlobRejectsMalformedHash(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
mockStorage := NewMockStorer()
|
|
||||||
tv := vaultik.NewForTesting(mockStorage)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
for _, bad := range []string{
|
|
||||||
"aa/../../../home/u/.profile",
|
|
||||||
"abc",
|
|
||||||
strings.Repeat("A", 64), // uppercase hex is not accepted
|
|
||||||
strings.Repeat("g", 64), // not hex
|
|
||||||
} {
|
|
||||||
_, err := tv.FetchBlob(ctx, bad)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatalf("expected error for malformed hash %q, got nil", bad)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if calls := mockStorage.GetCalls(); len(calls) != 0 {
|
|
||||||
t.Fatalf("storage was accessed for a malformed hash: %v", calls)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestFetchAndDecryptBlobVerifiesHash verifies that FetchAndDecryptBlob checks
|
// TestFetchAndDecryptBlobVerifiesHash verifies that FetchAndDecryptBlob checks
|
||||||
// the double-SHA-256 hash of the decrypted plaintext against the expected blob hash.
|
// the double-SHA-256 hash of the decrypted plaintext against the expected blob hash.
|
||||||
func TestFetchAndDecryptBlobVerifiesHash(t *testing.T) {
|
func TestFetchAndDecryptBlobVerifiesHash(t *testing.T) {
|
||||||
@@ -113,7 +84,7 @@ func TestFetchAndDecryptBlobVerifiesHash(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
rc, err := tv.FetchAndDecryptBlob(
|
rc, err := tv.FetchAndDecryptBlob(
|
||||||
ctx, correctHash, int64(len(plaintext)), identity)
|
ctx, correctHash, int64(len(encryptedData)), identity)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("expected success, got error: %v", err)
|
t.Fatalf("expected success, got error: %v", err)
|
||||||
}
|
}
|
||||||
@@ -145,7 +116,7 @@ func TestFetchAndDecryptBlobVerifiesHash(t *testing.T) {
|
|||||||
mockStorage.mu.Unlock()
|
mockStorage.mu.Unlock()
|
||||||
|
|
||||||
rc, err := tv.FetchAndDecryptBlob(
|
rc, err := tv.FetchAndDecryptBlob(
|
||||||
ctx, fakeHash, int64(len(plaintext)), identity)
|
ctx, fakeHash, int64(len(encryptedData)), identity)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unexpected error opening stream: %v", err)
|
t.Fatalf("unexpected error opening stream: %v", err)
|
||||||
}
|
}
|
||||||
@@ -162,51 +133,3 @@ func TestFetchAndDecryptBlobVerifiesHash(t *testing.T) {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestFetchAndDecryptBlobCloseBeforeEOFFails verifies the hash check
|
|
||||||
// cannot be skipped: a caller that reads only part of the blob and then
|
|
||||||
// closes gets an error rather than silently unverified bytes.
|
|
||||||
func TestFetchAndDecryptBlobCloseBeforeEOFFails(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
identity, err := age.GenerateX25519Identity()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("generating identity: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
plaintext := []byte("hello world test data for blob hash verification")
|
|
||||||
encryptedData, correctHash := buildHashTestBlob(t, identity, plaintext)
|
|
||||||
|
|
||||||
mockStorage := NewMockStorer()
|
|
||||||
blobPath := "blobs/" + correctHash[:2] + "/" +
|
|
||||||
correctHash[2:4] + "/" + correctHash
|
|
||||||
|
|
||||||
mockStorage.mu.Lock()
|
|
||||||
mockStorage.data[blobPath] = encryptedData
|
|
||||||
mockStorage.mu.Unlock()
|
|
||||||
|
|
||||||
tv := vaultik.NewForTesting(mockStorage)
|
|
||||||
|
|
||||||
rc, err := tv.FetchAndDecryptBlob(
|
|
||||||
context.Background(), correctHash, int64(len(plaintext)), identity)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error opening stream: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read one byte, far short of the plaintext length, then close.
|
|
||||||
buf := make([]byte, 1)
|
|
||||||
|
|
||||||
_, err = rc.Read(buf)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("reading first byte: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = rc.Close()
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error closing before EOF, got nil")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(err.Error(), "hash not verified") {
|
|
||||||
t.Fatalf("expected not-verified error, got: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
|
||||||
"sync"
|
"sync"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -14,9 +13,6 @@ import (
|
|||||||
var (
|
var (
|
||||||
errCacheKeyMissing = errors.New("key not in cache")
|
errCacheKeyMissing = errors.New("key not in cache")
|
||||||
errCacheReadBeyondBlob = errors.New("read beyond blob size")
|
errCacheReadBeyondBlob = errors.New("read beyond blob size")
|
||||||
errCacheKeyHasSeparator = errors.New(
|
|
||||||
"cache key contains a path separator")
|
|
||||||
errCacheNegativeRead = errors.New("negative offset or length")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// blobCacheFileMode is the permission mode for cached blob files.
|
// blobCacheFileMode is the permission mode for cached blob files.
|
||||||
@@ -78,11 +74,6 @@ func newBlobDiskCache(maxBytes int64) (*blobDiskCache, error) {
|
|||||||
// Put writes blob data to disk cache. Entries larger than maxBytes are
|
// Put writes blob data to disk cache. Entries larger than maxBytes are
|
||||||
// silently skipped.
|
// silently skipped.
|
||||||
func (c *blobDiskCache) Put(key string, data []byte) error {
|
func (c *blobDiskCache) Put(key string, data []byte) error {
|
||||||
p, err := c.path(key)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
entrySize := int64(len(data))
|
entrySize := int64(len(data))
|
||||||
|
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
@@ -96,12 +87,11 @@ func (c *blobDiskCache) Put(key string, data []byte) error {
|
|||||||
if e, ok := c.items[key]; ok {
|
if e, ok := c.items[key]; ok {
|
||||||
c.unlink(e)
|
c.unlink(e)
|
||||||
c.curBytes -= e.size
|
c.curBytes -= e.size
|
||||||
_ = os.Remove(p)
|
_ = os.Remove(c.path(key))
|
||||||
|
|
||||||
delete(c.items, key)
|
delete(c.items, key)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = os.WriteFile(p, data, blobCacheFileMode)
|
err := os.WriteFile(c.path(key), data, blobCacheFileMode)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("writing blob to cache: %w", err)
|
return fmt.Errorf("writing blob to cache: %w", err)
|
||||||
}
|
}
|
||||||
@@ -129,26 +119,19 @@ func (c *blobDiskCache) Put(key string, data []byte) error {
|
|||||||
// disk without buffering its entire plaintext (which may be tens of GB)
|
// disk without buffering its entire plaintext (which may be tens of GB)
|
||||||
// in RAM.
|
// in RAM.
|
||||||
func (c *blobDiskCache) PutFromReader(key string, r io.Reader) (int64, error) {
|
func (c *blobDiskCache) PutFromReader(key string, r io.Reader) (int64, error) {
|
||||||
p, err := c.path(key)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
// Remove any prior entry first; we'll re-link after the file is
|
// Remove any prior entry first; we'll re-link after the file is
|
||||||
// written successfully.
|
// written successfully.
|
||||||
if e, ok := c.items[key]; ok {
|
if e, ok := c.items[key]; ok {
|
||||||
c.unlink(e)
|
c.unlink(e)
|
||||||
c.curBytes -= e.size
|
c.curBytes -= e.size
|
||||||
_ = os.Remove(p)
|
_ = os.Remove(c.path(key))
|
||||||
|
|
||||||
delete(c.items, key)
|
delete(c.items, key)
|
||||||
}
|
}
|
||||||
c.mu.Unlock()
|
c.mu.Unlock()
|
||||||
|
|
||||||
//nolint:gosec // G304: path() rejects keys with a separator
|
|
||||||
f, err := os.OpenFile(
|
f, err := os.OpenFile(
|
||||||
p, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, blobCacheFileMode)
|
c.path(key), os.O_CREATE|os.O_TRUNC|os.O_WRONLY, blobCacheFileMode)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return 0, fmt.Errorf("creating cache file: %w", err)
|
return 0, fmt.Errorf("creating cache file: %w", err)
|
||||||
}
|
}
|
||||||
@@ -157,13 +140,13 @@ func (c *blobDiskCache) PutFromReader(key string, r io.Reader) (int64, error) {
|
|||||||
closeErr := f.Close()
|
closeErr := f.Close()
|
||||||
|
|
||||||
if copyErr != nil {
|
if copyErr != nil {
|
||||||
_ = os.Remove(p)
|
_ = os.Remove(c.path(key))
|
||||||
|
|
||||||
return written, fmt.Errorf("streaming to cache file: %w", copyErr)
|
return written, fmt.Errorf("streaming to cache file: %w", copyErr)
|
||||||
}
|
}
|
||||||
|
|
||||||
if closeErr != nil {
|
if closeErr != nil {
|
||||||
_ = os.Remove(p)
|
_ = os.Remove(c.path(key))
|
||||||
|
|
||||||
return written, fmt.Errorf("closing cache file: %w", closeErr)
|
return written, fmt.Errorf("closing cache file: %w", closeErr)
|
||||||
}
|
}
|
||||||
@@ -175,7 +158,7 @@ func (c *blobDiskCache) PutFromReader(key string, r io.Reader) (int64, error) {
|
|||||||
// floor — but the restore path passes math.MaxInt64 as maxBytes
|
// floor — but the restore path passes math.MaxInt64 as maxBytes
|
||||||
// so this branch is effectively unreachable there.
|
// so this branch is effectively unreachable there.
|
||||||
if written > c.maxBytes {
|
if written > c.maxBytes {
|
||||||
_ = os.Remove(p)
|
_ = os.Remove(c.path(key))
|
||||||
|
|
||||||
return written, nil
|
return written, nil
|
||||||
}
|
}
|
||||||
@@ -198,11 +181,6 @@ func (c *blobDiskCache) PutFromReader(key string, r io.Reader) (int64, error) {
|
|||||||
|
|
||||||
// Get reads a cached blob from disk. Returns data and true on hit.
|
// Get reads a cached blob from disk. Returns data and true on hit.
|
||||||
func (c *blobDiskCache) Get(key string) ([]byte, bool) {
|
func (c *blobDiskCache) Get(key string) ([]byte, bool) {
|
||||||
p, err := c.path(key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
c.getCalls++
|
c.getCalls++
|
||||||
|
|
||||||
@@ -217,8 +195,7 @@ func (c *blobDiskCache) Get(key string) ([]byte, bool) {
|
|||||||
c.pushFront(e)
|
c.pushFront(e)
|
||||||
c.mu.Unlock()
|
c.mu.Unlock()
|
||||||
|
|
||||||
//nolint:gosec // G304: path() rejects keys with a separator
|
data, err := os.ReadFile(c.path(key))
|
||||||
data, err := os.ReadFile(p)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
if e2, ok2 := c.items[key]; ok2 && e2 == e {
|
if e2, ok2 := c.items[key]; ok2 && e2 == e {
|
||||||
@@ -236,20 +213,6 @@ func (c *blobDiskCache) Get(key string) ([]byte, bool) {
|
|||||||
|
|
||||||
// ReadAt reads a slice of a cached blob without loading the entire blob into memory.
|
// ReadAt reads a slice of a cached blob without loading the entire blob into memory.
|
||||||
func (c *blobDiskCache) ReadAt(key string, offset, length int64) ([]byte, error) {
|
func (c *blobDiskCache) ReadAt(key string, offset, length int64) ([]byte, error) {
|
||||||
p, err := c.path(key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// offset and length come from a blob_chunks row read back from the
|
|
||||||
// destination. A negative value must be rejected outright; the upper
|
|
||||||
// bound is checked as length > size-offset (a subtraction) so a huge
|
|
||||||
// offset+length cannot overflow int64 and slip past the check.
|
|
||||||
if offset < 0 || length < 0 {
|
|
||||||
return nil, fmt.Errorf("%w: offset=%d length=%d",
|
|
||||||
errCacheNegativeRead, offset, length)
|
|
||||||
}
|
|
||||||
|
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
c.readAtCalls++
|
c.readAtCalls++
|
||||||
|
|
||||||
@@ -260,7 +223,7 @@ func (c *blobDiskCache) ReadAt(key string, offset, length int64) ([]byte, error)
|
|||||||
return nil, fmt.Errorf("%w: %q", errCacheKeyMissing, key)
|
return nil, fmt.Errorf("%w: %q", errCacheKeyMissing, key)
|
||||||
}
|
}
|
||||||
|
|
||||||
if length > e.size-offset {
|
if offset+length > e.size {
|
||||||
c.mu.Unlock()
|
c.mu.Unlock()
|
||||||
|
|
||||||
return nil, fmt.Errorf("%w: offset=%d length=%d size=%d",
|
return nil, fmt.Errorf("%w: offset=%d length=%d size=%d",
|
||||||
@@ -271,7 +234,7 @@ func (c *blobDiskCache) ReadAt(key string, offset, length int64) ([]byte, error)
|
|||||||
c.pushFront(e)
|
c.pushFront(e)
|
||||||
c.mu.Unlock()
|
c.mu.Unlock()
|
||||||
|
|
||||||
f, err := os.Open(p) //nolint:gosec // G304: path() rejects keys with a separator
|
f, err := os.Open(c.path(key))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -313,13 +276,7 @@ func (c *blobDiskCache) Delete(key string) {
|
|||||||
c.unlink(e)
|
c.unlink(e)
|
||||||
delete(c.items, key)
|
delete(c.items, key)
|
||||||
c.curBytes -= e.size
|
c.curBytes -= e.size
|
||||||
|
_ = os.Remove(c.path(key))
|
||||||
// The key is already in the map, so it passed path() when it was
|
|
||||||
// inserted; the error cannot occur here.
|
|
||||||
p, err := c.path(key)
|
|
||||||
if err == nil {
|
|
||||||
_ = os.Remove(p)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Keys returns a snapshot of all cached keys. Safe for iteration without
|
// Keys returns a snapshot of all cached keys. Safe for iteration without
|
||||||
@@ -390,18 +347,8 @@ func (c *blobDiskCache) Close() error {
|
|||||||
return os.RemoveAll(c.dir)
|
return os.RemoveAll(c.dir)
|
||||||
}
|
}
|
||||||
|
|
||||||
// path returns the on-disk location of the cache file for key. The key is
|
func (c *blobDiskCache) path(key string) string {
|
||||||
// a blob hash read back from the destination and is not trusted: a value
|
return filepath.Join(c.dir, key)
|
||||||
// such as "aa/../../../home/u/.profile" would otherwise make filepath.Join
|
|
||||||
// escape the cache directory, so a key containing a path separator is
|
|
||||||
// refused rather than joined.
|
|
||||||
func (c *blobDiskCache) path(key string) (string, error) {
|
|
||||||
if strings.ContainsRune(key, '/') ||
|
|
||||||
strings.ContainsRune(key, filepath.Separator) {
|
|
||||||
return "", fmt.Errorf("%w: %q", errCacheKeyHasSeparator, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
return filepath.Join(c.dir, key), nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *blobDiskCache) unlink(e *blobDiskCacheEntry) {
|
func (c *blobDiskCache) unlink(e *blobDiskCacheEntry) {
|
||||||
@@ -444,10 +391,5 @@ func (c *blobDiskCache) evictLRU() {
|
|||||||
c.unlink(victim)
|
c.unlink(victim)
|
||||||
delete(c.items, victim.key)
|
delete(c.items, victim.key)
|
||||||
c.curBytes -= victim.size
|
c.curBytes -= victim.size
|
||||||
|
_ = os.Remove(c.path(victim.key))
|
||||||
// victim.key was validated by path() on insertion, so this cannot err.
|
|
||||||
p, err := c.path(victim.key)
|
|
||||||
if err == nil {
|
|
||||||
_ = os.Remove(p)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,52 +0,0 @@
|
|||||||
package vaultik
|
|
||||||
|
|
||||||
import "errors"
|
|
||||||
|
|
||||||
// blobHashHexLen is the length of a blob hash written as lowercase hex: a
|
|
||||||
// SHA-256 digest is 32 bytes, so 64 characters. Remote snapshot keys are
|
|
||||||
// SHA-256 hashes too and share this exact form.
|
|
||||||
const blobHashHexLen = 64
|
|
||||||
|
|
||||||
// shortHashLen is how many leading characters of a hash appear in log and
|
|
||||||
// error text.
|
|
||||||
const shortHashLen = 16
|
|
||||||
|
|
||||||
// errInvalidBlobHash reports a value used as a blob hash that is not
|
|
||||||
// exactly 64 lowercase hex characters. Restore, verify and prune read
|
|
||||||
// these values back from the destination, which is not trusted, so each
|
|
||||||
// one is checked before it is used to build a path or drive a read.
|
|
||||||
var errInvalidBlobHash = errors.New(
|
|
||||||
"blob hash is not 64 lowercase hex characters")
|
|
||||||
|
|
||||||
// isBlobHash reports whether s is exactly 64 lowercase hex characters.
|
|
||||||
// Every real blob hash and remote snapshot key has this form.
|
|
||||||
//
|
|
||||||
// The check is a plain function, not a method on types.BlobHash: the
|
|
||||||
// packer stores "temp-placeholder-{uuid}" as the hash of an unfinished
|
|
||||||
// blob in the local index, so the type itself must keep accepting values
|
|
||||||
// that are not hashes.
|
|
||||||
func isBlobHash(s string) bool {
|
|
||||||
if len(s) != blobHashHexLen {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, r := range s {
|
|
||||||
if (r < '0' || r > '9') && (r < 'a' || r > 'f') {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// shortHash returns the leading part of a hash for log and error text. It
|
|
||||||
// never panics: a string shorter than the prefix is returned whole. A hash
|
|
||||||
// read from the destination may be malformed, and formatting one for a
|
|
||||||
// message must not crash the command.
|
|
||||||
func shortHash(s string) string {
|
|
||||||
if len(s) <= shortHashLen {
|
|
||||||
return s
|
|
||||||
}
|
|
||||||
|
|
||||||
return s[:shortHashLen]
|
|
||||||
}
|
|
||||||
@@ -1,108 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestDeepVerifyAcceptsHealthyAndRejectsCorruptBlob backs up a real
|
|
||||||
// snapshot with the on-disk storage backend, runs deep verification on
|
|
||||||
// it, then flips a byte inside one stored blob and runs deep
|
|
||||||
// verification again. A healthy snapshot must pass; a corrupted blob
|
|
||||||
// must fail. The healthy case is the regression guard: deep
|
|
||||||
// verification used to hash the encrypted blob bytes and compare them
|
|
||||||
// to the blob's ID (the double SHA256 of the plaintext), so it reported
|
|
||||||
// every healthy blob as corrupt.
|
|
||||||
func TestDeepVerifyAcceptsHealthyAndRejectsCorruptBlob(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
|
|
||||||
dataDir := filepath.Join(tempDir, "source")
|
|
||||||
storeDir := filepath.Join(tempDir, "remote")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
chunkSize := int64(64 * 1024)
|
|
||||||
maxBlobSize := int64(512 * 1024)
|
|
||||||
|
|
||||||
// One file large enough to span several chunks within a single blob.
|
|
||||||
require.NoError(t, fs.MkdirAll(dataDir, 0o755))
|
|
||||||
require.NoError(t, afero.WriteFile(fs,
|
|
||||||
filepath.Join(dataDir, "data.bin"),
|
|
||||||
bytesPattern("deep-", int(chunkSize*3)), 0o644))
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
// runFileStorageBackup writes a real snapshot to storeDir and closes
|
|
||||||
// the source index, so verification runs from remote bytes only.
|
|
||||||
cfg, storer, snapshotID := runFileStorageBackup(
|
|
||||||
ctx, t, fs, dataDir, storeDir, dbPath, chunkSize, maxBlobSize)
|
|
||||||
|
|
||||||
newVerifier := func() *vaultik.Vaultik {
|
|
||||||
v := &vaultik.Vaultik{
|
|
||||||
Config: cfg,
|
|
||||||
Storage: storer,
|
|
||||||
Fs: fs,
|
|
||||||
Stdout: io.Discard,
|
|
||||||
Stderr: io.Discard,
|
|
||||||
UI: ui.NewWithColor(io.Discard, false),
|
|
||||||
}
|
|
||||||
v.SetContext(ctx)
|
|
||||||
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
|
|
||||||
require.NoError(t,
|
|
||||||
newVerifier().RunDeepVerify(snapshotID, &vaultik.VerifyOptions{Deep: true}),
|
|
||||||
"deep verify should pass on a healthy snapshot")
|
|
||||||
|
|
||||||
// Flip a byte inside one blob without changing its length, so the
|
|
||||||
// blob-existence and size checks still pass and verification reaches
|
|
||||||
// the blob-content stage.
|
|
||||||
corruptOneBlob(t, fs, filepath.Join(storeDir, "blobs"))
|
|
||||||
|
|
||||||
require.Error(t,
|
|
||||||
newVerifier().RunDeepVerify(snapshotID, &vaultik.VerifyOptions{Deep: true}),
|
|
||||||
"deep verify should fail on a corrupted blob")
|
|
||||||
}
|
|
||||||
|
|
||||||
// corruptOneBlob flips a middle byte of the first blob file found under
|
|
||||||
// blobsDir, leaving the file length unchanged.
|
|
||||||
func corruptOneBlob(t *testing.T, fs afero.Fs, blobsDir string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var blobPath string
|
|
||||||
|
|
||||||
err := afero.Walk(fs, blobsDir,
|
|
||||||
func(path string, info os.FileInfo, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if blobPath == "" && !info.IsDir() {
|
|
||||||
blobPath = path
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NotEmpty(t, blobPath, "expected at least one blob on disk")
|
|
||||||
|
|
||||||
data, err := afero.ReadFile(fs, blobPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NotEmpty(t, data)
|
|
||||||
|
|
||||||
data[len(data)/2] ^= 0xff
|
|
||||||
require.NoError(t, afero.WriteFile(fs, blobPath, data, 0o644))
|
|
||||||
}
|
|
||||||
@@ -1,262 +0,0 @@
|
|||||||
package vaultik //nolint:testpackage // drives unexported input validation
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/snapshot"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
"sneak.berlin/go/vaultik/internal/types"
|
|
||||||
)
|
|
||||||
|
|
||||||
// These tests treat every hash, offset and length read back from the
|
|
||||||
// destination as hostile. A blob hash comes from the downloaded snapshot
|
|
||||||
// database or the store listing, neither of which is authenticated (see
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/155), so each is validated
|
|
||||||
// before it is used to build a path or size an allocation.
|
|
||||||
|
|
||||||
// TestBlobCacheRejectsKeyWithSeparator proves the arbitrary-file-write
|
|
||||||
// hole is closed: a blob hash that climbs out of the cache directory is
|
|
||||||
// refused and nothing is written outside it. This is the exact write the
|
|
||||||
// restore path performs, keyed by the hash from the snapshot database.
|
|
||||||
func TestBlobCacheRejectsKeyWithSeparator(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, err := newBlobDiskCache(1 << 20)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = cache.Close() }()
|
|
||||||
|
|
||||||
target := filepath.Join(t.TempDir(), "pwned")
|
|
||||||
|
|
||||||
// A hash whose relative form escapes the cache directory to target.
|
|
||||||
key, err := filepath.Rel(cache.dir, target)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Contains(t, key, "..")
|
|
||||||
|
|
||||||
err = cache.Put(key, []byte("secret"))
|
|
||||||
require.ErrorIs(t, err, errCacheKeyHasSeparator)
|
|
||||||
|
|
||||||
_, err = cache.PutFromReader(key, strings.NewReader("secret"))
|
|
||||||
require.ErrorIs(t, err, errCacheKeyHasSeparator)
|
|
||||||
|
|
||||||
_, statErr := os.Stat(target)
|
|
||||||
require.Truef(t, os.IsNotExist(statErr),
|
|
||||||
"cache wrote outside its directory at %s", target)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestBuildBlobIndexesRejectsHostileHash proves restore refuses a snapshot
|
|
||||||
// database whose blob_hash escapes the cache directory. buildBlobIndexes is
|
|
||||||
// the first place restore reads these hashes back, and it fails there, before
|
|
||||||
// any blob is fetched or written, so a hash containing /../ cannot steer a
|
|
||||||
// later write outside the cache directory.
|
|
||||||
func TestBuildBlobIndexesRejectsHostileHash(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
db, err := database.New(ctx, filepath.Join(t.TempDir(), "index.sqlite"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = db.Close() }()
|
|
||||||
|
|
||||||
// A blob cache and a target file just outside it. The hostile hash is
|
|
||||||
// the relative path from the cache to that target, so an unguarded
|
|
||||||
// restore keyed by this hash would write there.
|
|
||||||
cache, err := newBlobDiskCache(1 << 20)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = cache.Close() }()
|
|
||||||
|
|
||||||
target := filepath.Join(t.TempDir(), "pwned")
|
|
||||||
hostile, err := filepath.Rel(cache.dir, target)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Contains(t, hostile, "..")
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
require.NoError(t, repos.Blobs.Create(ctx, nil, &database.Blob{
|
|
||||||
ID: types.NewBlobID(),
|
|
||||||
Hash: types.BlobHash(hostile),
|
|
||||||
CreatedTS: time.Now().UTC(),
|
|
||||||
}))
|
|
||||||
|
|
||||||
v := NewForTesting(nil)
|
|
||||||
v.SetContext(ctx)
|
|
||||||
|
|
||||||
_, _, err = v.buildBlobIndexes(repos)
|
|
||||||
require.ErrorIs(t, err, errInvalidBlobHash)
|
|
||||||
|
|
||||||
_, statErr := os.Stat(target)
|
|
||||||
require.Truef(t, os.IsNotExist(statErr),
|
|
||||||
"restore wrote outside the cache directory at %s", target)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestBlobCacheReadAtRejectsBadBounds proves a blob_chunks row cannot
|
|
||||||
// drive an out-of-range or negative read. offset/length reach ReadAt
|
|
||||||
// straight from the database.
|
|
||||||
func TestBlobCacheReadAtRejectsBadBounds(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cache, err := newBlobDiskCache(1 << 20)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = cache.Close() }()
|
|
||||||
|
|
||||||
require.NoError(t, cache.Put("blob", make([]byte, 100)))
|
|
||||||
|
|
||||||
_, err = cache.ReadAt("blob", -1, 10)
|
|
||||||
require.ErrorIs(t, err, errCacheNegativeRead)
|
|
||||||
|
|
||||||
_, err = cache.ReadAt("blob", 0, -1)
|
|
||||||
require.ErrorIs(t, err, errCacheNegativeRead)
|
|
||||||
|
|
||||||
// A length past the end is rejected via the subtraction bound, so a
|
|
||||||
// huge offset+length cannot overflow past the check.
|
|
||||||
_, err = cache.ReadAt("blob", 50, 60)
|
|
||||||
require.ErrorIs(t, err, errCacheReadBeyondBlob)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestListAllRemoteBlobsSkipsNonConformingName proves a bogus object name
|
|
||||||
// under blobs/ (here a three-character name) is skipped rather than
|
|
||||||
// entering the blob map, so prune's later hash[:2]/hash[2:4] path build
|
|
||||||
// cannot panic on it.
|
|
||||||
func TestListAllRemoteBlobsSkipsNonConformingName(t *testing.T) {
|
|
||||||
// Initialize the global logger before t.Parallel() so the write lands
|
|
||||||
// in the serial phase and cannot race other parallel tests reading it.
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
good := strings.Repeat("a", blobHashHexLen)
|
|
||||||
store := &stubLister{objects: []storage.ObjectInfo{
|
|
||||||
{Key: "blobs/" + good[:2] + "/" + good[2:4] + "/" + good, Size: 10},
|
|
||||||
{Key: "blobs/a/b/c", Size: 3},
|
|
||||||
}}
|
|
||||||
|
|
||||||
v := &Vaultik{Storage: store}
|
|
||||||
v.SetContext(context.Background())
|
|
||||||
|
|
||||||
blobs, err := v.listAllRemoteBlobs()
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.Contains(t, blobs, good)
|
|
||||||
require.NotContains(t, blobs, "c")
|
|
||||||
require.Len(t, blobs, 1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestVerifyManifestBlobsRejectsShortHash proves a manifest (which is not
|
|
||||||
// authenticated) with a short blob hash fails cleanly instead of panicking
|
|
||||||
// on blob.Hash[:2].
|
|
||||||
func TestVerifyManifestBlobsRejectsShortHash(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
v := &Vaultik{Stdout: io.Discard}
|
|
||||||
manifest := &snapshot.Manifest{
|
|
||||||
Blobs: []snapshot.BlobInfo{{Hash: "abc", CompressedSize: 1}},
|
|
||||||
}
|
|
||||||
|
|
||||||
verified, missing, mismatched, missingSize, err :=
|
|
||||||
v.verifyManifestBlobs(manifest, &VerifyOptions{JSON: true})
|
|
||||||
require.ErrorIs(t, err, errInvalidBlobHash)
|
|
||||||
require.Zero(t, verified)
|
|
||||||
require.Zero(t, missing)
|
|
||||||
require.Zero(t, mismatched)
|
|
||||||
require.Zero(t, missingSize)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestVerifyBlobChunksRejectsNegativeLength proves a blob_chunks row with a
|
|
||||||
// negative length returns an error rather than reaching make([]byte,
|
|
||||||
// length) or streaming an untrusted size.
|
|
||||||
func TestVerifyBlobChunksRejectsNegativeLength(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
db, err := database.New(ctx, filepath.Join(t.TempDir(), "index.sqlite"))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = db.Close() }()
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
blobHash := strings.Repeat("b", blobHashHexLen)
|
|
||||||
blob := &database.Blob{
|
|
||||||
ID: types.NewBlobID(),
|
|
||||||
Hash: types.BlobHash(blobHash),
|
|
||||||
CreatedTS: time.Now().UTC(),
|
|
||||||
}
|
|
||||||
require.NoError(t, repos.Blobs.Create(ctx, nil, blob))
|
|
||||||
|
|
||||||
chunkHash := strings.Repeat("c", blobHashHexLen)
|
|
||||||
require.NoError(t, repos.Chunks.Create(ctx, nil,
|
|
||||||
&database.Chunk{ChunkHash: types.ChunkHash(chunkHash), Size: 1024}))
|
|
||||||
require.NoError(t, repos.BlobChunks.Create(ctx, nil, &database.BlobChunk{
|
|
||||||
BlobID: blob.ID,
|
|
||||||
ChunkHash: types.ChunkHash(chunkHash),
|
|
||||||
Offset: 0,
|
|
||||||
Length: -1,
|
|
||||||
}))
|
|
||||||
|
|
||||||
v := NewForTesting(nil)
|
|
||||||
|
|
||||||
_, err = v.verifyBlobChunks(db.Conn(), blobHash, strings.NewReader(""))
|
|
||||||
require.ErrorIs(t, err, errNegativeChunkLength)
|
|
||||||
}
|
|
||||||
|
|
||||||
// errStubUnused marks a stubLister method a test never exercises.
|
|
||||||
var errStubUnused = errors.New("stubLister method not used in test")
|
|
||||||
|
|
||||||
// stubLister is a storage.Storer whose ListStream yields a fixed set of
|
|
||||||
// objects; every other method is unused by the tests here.
|
|
||||||
type stubLister struct {
|
|
||||||
objects []storage.ObjectInfo
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) ListStream(
|
|
||||||
_ context.Context, prefix string,
|
|
||||||
) <-chan storage.ObjectInfo {
|
|
||||||
ch := make(chan storage.ObjectInfo, len(s.objects))
|
|
||||||
for _, o := range s.objects {
|
|
||||||
if strings.HasPrefix(o.Key, prefix) {
|
|
||||||
ch <- o
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
close(ch)
|
|
||||||
|
|
||||||
return ch
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) Put(_ context.Context, _ string, _ io.Reader) error {
|
|
||||||
return errStubUnused
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) PutWithProgress(
|
|
||||||
_ context.Context, _ string, _ io.Reader, _ int64, _ storage.ProgressCallback,
|
|
||||||
) error {
|
|
||||||
return errStubUnused
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) Get(_ context.Context, _ string) (io.ReadCloser, error) {
|
|
||||||
return nil, errStubUnused
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) Stat(_ context.Context, _ string) (*storage.ObjectInfo, error) {
|
|
||||||
return nil, errStubUnused
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) Delete(_ context.Context, _ string) error {
|
|
||||||
return errStubUnused
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) List(_ context.Context, _ string) ([]string, error) {
|
|
||||||
return nil, errStubUnused
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *stubLister) Info() storage.Info {
|
|
||||||
return storage.Info{}
|
|
||||||
}
|
|
||||||
@@ -1,647 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/config"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
"sneak.berlin/go/vaultik/internal/snapshot"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage"
|
|
||||||
"sneak.berlin/go/vaultik/internal/storage/faultstore"
|
|
||||||
"sneak.berlin/go/vaultik/internal/ui"
|
|
||||||
"sneak.berlin/go/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// These tests cover the failure modes a backup tool must survive:
|
|
||||||
// interrupted uploads, an interrupted metadata export, corrupt and
|
|
||||||
// truncated reads, a full restore disk, and a backend that reports
|
|
||||||
// success while storing nothing. Faults are injected through the
|
|
||||||
// storage.Storer seam (internal/storage/faultstore), never by patching
|
|
||||||
// production code. Each test asserts on the observable end state — what
|
|
||||||
// is in the index, what is at the destination, what the user is told —
|
|
||||||
// not merely that an error was returned. See
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/72.
|
|
||||||
//
|
|
||||||
// Object-level write atomicity (no partial blob object left behind) is
|
|
||||||
// covered by the file:// backend's atomic-write work
|
|
||||||
// (https://git.eeqj.de/sneak/vaultik/issues/130) and is not re-tested
|
|
||||||
// here; these tests target the layers above the backend.
|
|
||||||
//
|
|
||||||
// The tests run serially, not with t.Parallel: each calls
|
|
||||||
// log.Initialize, which replaces the package-global logger, and a
|
|
||||||
// backup or restore running concurrently reads that same logger. Under
|
|
||||||
// -race the two collide. Running one at a time is the same choice
|
|
||||||
// prune_count_test.go already makes for the same reason.
|
|
||||||
|
|
||||||
const (
|
|
||||||
faultChunkSize = int64(64 * 1024)
|
|
||||||
faultMaxBlobSize = int64(256 * 1024)
|
|
||||||
)
|
|
||||||
|
|
||||||
// faultTestConfig returns the config shared by the fault-injection
|
|
||||||
// tests: a real recipient/secret keypair so blobs are genuinely
|
|
||||||
// encrypted, and a blob size limit the restore sweeper can divide.
|
|
||||||
func faultTestConfig() *config.Config {
|
|
||||||
return &config.Config{
|
|
||||||
AgeRecipients: []string{testAgePublicKey},
|
|
||||||
AgeSecretKey: testAgeSecretKey,
|
|
||||||
CompressionLevel: 3,
|
|
||||||
Hostname: testHostname,
|
|
||||||
BlobSizeLimit: config.Size(faultMaxBlobSize),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeFaultSourceTree writes a spread of file sizes that forces several
|
|
||||||
// chunks across more than one blob, so a fault landing on a single blob
|
|
||||||
// still leaves other data intact. Returns the expected content by path.
|
|
||||||
func writeFaultSourceTree(
|
|
||||||
t *testing.T, fs afero.Fs, dataDir string,
|
|
||||||
) map[string][]byte {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
files := map[string][]byte{
|
|
||||||
filepath.Join(dataDir, "small.txt"): []byte("hello vaultik"),
|
|
||||||
filepath.Join(dataDir, "a.bin"): bytesPattern("a-", int(faultChunkSize*3)),
|
|
||||||
filepath.Join(dataDir, "sub", "b.bin"): bytesPattern("b-", int(faultChunkSize*3)),
|
|
||||||
filepath.Join(dataDir, "sub", "c.bin"): bytesPattern("c-", int(faultChunkSize*2)),
|
|
||||||
}
|
|
||||||
|
|
||||||
for path, content := range files {
|
|
||||||
require.NoError(t, fs.MkdirAll(filepath.Dir(path), 0o755))
|
|
||||||
require.NoError(t, afero.WriteFile(fs, path, content, 0o644))
|
|
||||||
}
|
|
||||||
|
|
||||||
return files
|
|
||||||
}
|
|
||||||
|
|
||||||
// newFaultScanner builds a scanner writing through the given storer.
|
|
||||||
func newFaultScanner(
|
|
||||||
fs afero.Fs, storer storage.Storer,
|
|
||||||
cfg *config.Config, repos *database.Repositories,
|
|
||||||
) *snapshot.Scanner {
|
|
||||||
return snapshot.NewScanner(snapshot.ScannerConfig{
|
|
||||||
FS: fs,
|
|
||||||
Storage: storer,
|
|
||||||
ChunkSize: faultChunkSize,
|
|
||||||
MaxBlobSize: faultMaxBlobSize,
|
|
||||||
CompressionLevel: cfg.CompressionLevel,
|
|
||||||
AgeRecipients: cfg.AgeRecipients,
|
|
||||||
Repositories: repos,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// newFaultSnapshotManager builds a snapshot manager writing through the
|
|
||||||
// given storer.
|
|
||||||
func newFaultSnapshotManager(
|
|
||||||
fs afero.Fs, storer storage.Storer,
|
|
||||||
cfg *config.Config, repos *database.Repositories,
|
|
||||||
) *snapshot.SnapshotManager {
|
|
||||||
sm := snapshot.NewSnapshotManager(snapshot.SnapshotManagerParams{
|
|
||||||
Repos: repos,
|
|
||||||
Storage: storer,
|
|
||||||
Config: cfg,
|
|
||||||
})
|
|
||||||
sm.SetFilesystem(fs)
|
|
||||||
|
|
||||||
return sm
|
|
||||||
}
|
|
||||||
|
|
||||||
// fullFaultBackup runs a complete backup (create, scan, complete,
|
|
||||||
// export) through storer and returns the snapshot ID.
|
|
||||||
func fullFaultBackup(
|
|
||||||
ctx context.Context, t *testing.T, fs afero.Fs, storer storage.Storer,
|
|
||||||
cfg *config.Config, repos *database.Repositories,
|
|
||||||
dataDir, dbPath, name string,
|
|
||||||
) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
sm := newFaultSnapshotManager(fs, storer, cfg, repos)
|
|
||||||
scanner := newFaultScanner(fs, storer, cfg, repos)
|
|
||||||
|
|
||||||
id, err := sm.CreateSnapshotWithName(ctx, cfg.Hostname, name, "v", "g")
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
_, err = scanner.Scan(ctx, dataDir, id)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
require.NoError(t, sm.CompleteSnapshot(ctx, id))
|
|
||||||
require.NoError(t, sm.ExportSnapshotMetadata(ctx, dbPath, id))
|
|
||||||
|
|
||||||
return id
|
|
||||||
}
|
|
||||||
|
|
||||||
// newReaderVaultik builds a Vaultik that reads (restore/verify) through
|
|
||||||
// storer, with the given repositories (nil is fine for restore/verify,
|
|
||||||
// which read metadata from storage).
|
|
||||||
func newReaderVaultik(
|
|
||||||
ctx context.Context, cfg *config.Config, storer storage.Storer,
|
|
||||||
repos *database.Repositories, fs afero.Fs,
|
|
||||||
) *vaultik.Vaultik {
|
|
||||||
v := &vaultik.Vaultik{
|
|
||||||
Config: cfg,
|
|
||||||
Storage: storer,
|
|
||||||
Repositories: repos,
|
|
||||||
Fs: fs,
|
|
||||||
Stdout: io.Discard,
|
|
||||||
Stderr: io.Discard,
|
|
||||||
UI: ui.NewWithColor(io.Discard, false),
|
|
||||||
}
|
|
||||||
v.SetContext(ctx)
|
|
||||||
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scenario 3: a stored blob's bytes are flipped before restore reads
|
|
||||||
// them. Restore must fail loudly, and no file must be left on the
|
|
||||||
// restore target holding corrupt content.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestRestoreRejectsCorruptBlob(t *testing.T) {
|
|
||||||
assertRestoreRejectsDamagedBlob(t, faultstore.GetCorrupt, "corrupt")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scenario 4: a stored blob is truncated before restore reads it. Same
|
|
||||||
// contract as the corrupt case.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestRestoreRejectsTruncatedBlob(t *testing.T) {
|
|
||||||
assertRestoreRejectsDamagedBlob(t, faultstore.GetTruncate, "truncated")
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertRestoreRejectsDamagedBlob backs up the source tree, then restores
|
|
||||||
// through a store that damages every blob read with the given fault, and
|
|
||||||
// asserts restore fails naming a blob and leaves no file on the target
|
|
||||||
// holding wrong bytes. Metadata reads are returned intact so the failure
|
|
||||||
// is isolated to the blob.
|
|
||||||
func assertRestoreRejectsDamagedBlob(
|
|
||||||
t *testing.T, fault faultstore.GetFault, name string,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
dataDir := filepath.Join(tempDir, "src")
|
|
||||||
storeDir := filepath.Join(tempDir, "remote")
|
|
||||||
restoreDir := filepath.Join(tempDir, "restored")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
testFiles := writeFaultSourceTree(t, fs, dataDir)
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(storeDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
id := fullFaultBackup(ctx, t, fs, inner, cfg, repos, dataDir, dbPath, name)
|
|
||||||
require.NoError(t, db.Close())
|
|
||||||
|
|
||||||
faultStore := faultstore.New(inner)
|
|
||||||
faultStore.OnGet = func(key string) faultstore.GetFault {
|
|
||||||
if strings.HasPrefix(key, "blobs/") {
|
|
||||||
return fault
|
|
||||||
}
|
|
||||||
|
|
||||||
return faultstore.GetNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
v := newReaderVaultik(ctx, cfg, faultStore, nil, fs)
|
|
||||||
err = v.Restore(&vaultik.RestoreOptions{SnapshotID: id, TargetDir: restoreDir})
|
|
||||||
|
|
||||||
require.Error(t, err, "restore must fail on a damaged blob")
|
|
||||||
assert.Contains(t, err.Error(), "blob",
|
|
||||||
"error should name the blob that failed")
|
|
||||||
assertNoCorruptFiles(t, fs, restoreDir, testFiles)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scenario 6: the backend accepts blob uploads and reports success but
|
|
||||||
// stores nothing. verify --deep must catch it.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestDeepVerifyCatchesLyingBackend(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
dataDir := filepath.Join(tempDir, "src")
|
|
||||||
storeDir := filepath.Join(tempDir, "remote")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
|
|
||||||
writeFaultSourceTree(t, fs, dataDir)
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(storeDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Blob uploads are swallowed; metadata uploads land, so verify can
|
|
||||||
// download the manifest and database and then discover the blobs are
|
|
||||||
// absent.
|
|
||||||
lying := faultstore.New(inner)
|
|
||||||
lying.OnPut = func(key string) faultstore.PutAction {
|
|
||||||
if strings.HasPrefix(key, "blobs/") {
|
|
||||||
return faultstore.PutSwallow
|
|
||||||
}
|
|
||||||
|
|
||||||
return faultstore.PutNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
id := fullFaultBackup(ctx, t, fs, lying, cfg, repos, dataDir, dbPath, "lying")
|
|
||||||
require.NoError(t, db.Close())
|
|
||||||
|
|
||||||
// No blob objects were actually written.
|
|
||||||
blobKeys, err := inner.List(ctx, "blobs/")
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Empty(t, blobKeys, "lying backend should have stored no blobs")
|
|
||||||
|
|
||||||
// Read back through the honest underlying store.
|
|
||||||
v := newReaderVaultik(ctx, cfg, inner, nil, fs)
|
|
||||||
err = v.VerifySnapshotWithOptions(id, &vaultik.VerifyOptions{Deep: true})
|
|
||||||
require.Error(t, err, "deep verify must catch a backend that stored nothing")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scenario 1a: a blob upload fails partway through. The interrupted run
|
|
||||||
// must not record the blob as uploaded, must not reference it from the
|
|
||||||
// snapshot, and must leave no blob object at the destination.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestInterruptedBlobUploadRecordsNoUploadedBlob(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
dataDir := filepath.Join(tempDir, "src")
|
|
||||||
storeDir := filepath.Join(tempDir, "remote")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
|
|
||||||
writeFaultSourceTree(t, fs, dataDir)
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(storeDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
defer func() { _ = db.Close() }()
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
// Every blob upload fails partway through. The scan must surface it.
|
|
||||||
fault := faultstore.New(inner)
|
|
||||||
fault.OnPut = func(key string) faultstore.PutAction {
|
|
||||||
if strings.HasPrefix(key, "blobs/") {
|
|
||||||
return faultstore.PutFail
|
|
||||||
}
|
|
||||||
|
|
||||||
return faultstore.PutNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
sm := newFaultSnapshotManager(fs, fault, cfg, repos)
|
|
||||||
scanner := newFaultScanner(fs, fault, cfg, repos)
|
|
||||||
|
|
||||||
id, err := sm.CreateSnapshotWithName(ctx, cfg.Hostname, "interrupted", "v", "g")
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
_, err = scanner.Scan(ctx, dataDir, id)
|
|
||||||
require.Error(t, err, "scan must fail when a blob upload fails")
|
|
||||||
|
|
||||||
// No blob may claim to be uploaded.
|
|
||||||
blobs, err := repos.Blobs.GetAll(ctx)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
for _, b := range blobs {
|
|
||||||
assert.Nilf(t, b.UploadedTS,
|
|
||||||
"blob %s marked uploaded after a failed upload", b.Hash)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The snapshot may reference no blobs, and the destination holds none.
|
|
||||||
hashes, err := repos.Snapshots.GetBlobHashes(ctx, id)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Empty(t, hashes, "interrupted snapshot must reference no blobs")
|
|
||||||
|
|
||||||
blobKeys, err := inner.List(ctx, "blobs/")
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Empty(t, blobKeys, "no blob object may survive at the destination")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scenario 1b: after an interrupted upload, a retry on the same local
|
|
||||||
// index must produce a restorable snapshot. The interrupted run leaves
|
|
||||||
// the blob's chunk rows in the index; the fix for
|
|
||||||
// https://git.eeqj.de/sneak/vaultik/issues/148 discards those un-uploaded
|
|
||||||
// blob rows at the start of the next scan and deduplicates only against
|
|
||||||
// chunks in a blob that was actually uploaded, so the retry re-chunks and
|
|
||||||
// re-uploads the affected data instead of silently referencing data that
|
|
||||||
// never reached storage.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestBackupRetryAfterInterruptedUploadIsRestorable(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
dataDir := filepath.Join(tempDir, "src")
|
|
||||||
storeDir := filepath.Join(tempDir, "remote")
|
|
||||||
restoreDir := filepath.Join(tempDir, "restored")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
testFiles := writeFaultSourceTree(t, fs, dataDir)
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(storeDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
// Attempt 1: every blob upload fails.
|
|
||||||
fault := faultstore.New(inner)
|
|
||||||
fault.OnPut = func(key string) faultstore.PutAction {
|
|
||||||
if strings.HasPrefix(key, "blobs/") {
|
|
||||||
return faultstore.PutFail
|
|
||||||
}
|
|
||||||
|
|
||||||
return faultstore.PutNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
sm := newFaultSnapshotManager(fs, fault, cfg, repos)
|
|
||||||
scanner := newFaultScanner(fs, fault, cfg, repos)
|
|
||||||
|
|
||||||
id1, err := sm.CreateSnapshotWithName(ctx, cfg.Hostname, "interrupted", "v", "g")
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
_, err = scanner.Scan(ctx, dataDir, id1)
|
|
||||||
require.Error(t, err)
|
|
||||||
|
|
||||||
// Retry on the same local index with a working backend.
|
|
||||||
id2 := fullFaultBackup(ctx, t, fs, inner, cfg, repos, dataDir, dbPath, "retry")
|
|
||||||
require.NoError(t, db.Close())
|
|
||||||
|
|
||||||
v := newReaderVaultik(ctx, cfg, inner, nil, fs)
|
|
||||||
require.NoError(t, v.Restore(&vaultik.RestoreOptions{
|
|
||||||
SnapshotID: id2,
|
|
||||||
TargetDir: restoreDir,
|
|
||||||
Verify: true,
|
|
||||||
}), "retry after an interrupted upload must produce a restorable snapshot")
|
|
||||||
|
|
||||||
assertRestoredTree(t, fs, restoreDir, testFiles)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scenario 2: the process dies during the metadata export, after the
|
|
||||||
// database is uploaded but before the manifest. The destination is left
|
|
||||||
// with blobs and a database but no manifest. verify and snapshot list
|
|
||||||
// must report the damage honestly rather than crashing or passing.
|
|
||||||
// Automatic detection and repair of this partial state on the next run
|
|
||||||
// is tracked in https://git.eeqj.de/sneak/vaultik/issues/177 and is not
|
|
||||||
// asserted here.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestBackupSurvivesMetadataExportInterruption(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
fs := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
dataDir := filepath.Join(tempDir, "src")
|
|
||||||
storeDir := filepath.Join(tempDir, "remote")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
|
|
||||||
writeFaultSourceTree(t, fs, dataDir)
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(storeDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
// Back up and complete with a working backend.
|
|
||||||
sm := newFaultSnapshotManager(fs, inner, cfg, repos)
|
|
||||||
scanner := newFaultScanner(fs, inner, cfg, repos)
|
|
||||||
|
|
||||||
id, err := sm.CreateSnapshotWithName(ctx, cfg.Hostname, "export", "v", "g")
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
_, err = scanner.Scan(ctx, dataDir, id)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, sm.CompleteSnapshot(ctx, id))
|
|
||||||
|
|
||||||
// Export through a backend that fails only the manifest upload. The
|
|
||||||
// database uploads first and lands; the manifest does not.
|
|
||||||
fault := faultstore.New(inner)
|
|
||||||
fault.OnPut = func(key string) faultstore.PutAction {
|
|
||||||
if strings.HasSuffix(key, "manifest.json.zst") {
|
|
||||||
return faultstore.PutFail
|
|
||||||
}
|
|
||||||
|
|
||||||
return faultstore.PutNormal
|
|
||||||
}
|
|
||||||
|
|
||||||
smFault := newFaultSnapshotManager(fs, fault, cfg, repos)
|
|
||||||
|
|
||||||
err = smFault.ExportSnapshotMetadata(ctx, dbPath, id)
|
|
||||||
require.Error(t, err, "export must fail when the manifest upload fails")
|
|
||||||
|
|
||||||
// The destination is in the partial state the scenario describes.
|
|
||||||
key := snapshot.RemoteSnapshotKey(id)
|
|
||||||
|
|
||||||
_, err = inner.Stat(ctx, "metadata/"+key+"/db.zst.age")
|
|
||||||
require.NoError(t, err, "database should have been uploaded before the manifest")
|
|
||||||
|
|
||||||
_, err = inner.Stat(ctx, "metadata/"+key+"/manifest.json.zst")
|
|
||||||
require.ErrorIs(t, err, storage.ErrNotFound, "manifest upload should not have landed")
|
|
||||||
|
|
||||||
// verify must fail loudly for this snapshot, in both modes.
|
|
||||||
reader := newReaderVaultik(ctx, cfg, inner, repos, fs)
|
|
||||||
|
|
||||||
deepOpts := &vaultik.VerifyOptions{Deep: true}
|
|
||||||
require.Error(t, reader.VerifySnapshotWithOptions(id, deepOpts),
|
|
||||||
"deep verify must report the missing manifest")
|
|
||||||
|
|
||||||
shallowOpts := &vaultik.VerifyOptions{Deep: false}
|
|
||||||
require.Error(t, reader.VerifySnapshotWithOptions(id, shallowOpts),
|
|
||||||
"shallow verify must report the missing manifest")
|
|
||||||
|
|
||||||
// snapshot list must not crash on the partial snapshot.
|
|
||||||
require.NoError(t, reader.ListSnapshots(false),
|
|
||||||
"snapshot list must tolerate a partially-exported snapshot")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scenario 5: the restore target runs out of space mid-file. Restore
|
|
||||||
// must fail with an out-of-space error, and must not leave a truncated
|
|
||||||
// file at the target path presenting as a complete restore. Restore
|
|
||||||
// today writes each file straight to its final path and does not remove
|
|
||||||
// it when a write fails, so the truncated file survives; deleting it is
|
|
||||||
// tracked by https://git.eeqj.de/sneak/vaultik/issues/163. Skipped until
|
|
||||||
// that lands, so the destination assertion below is recorded rather than
|
|
||||||
// dropped.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestRestoreReportsDiskFull(t *testing.T) {
|
|
||||||
t.Skip("blocked on https://git.eeqj.de/sneak/vaultik/issues/163: " +
|
|
||||||
"a disk-full write leaves a truncated file at the target path " +
|
|
||||||
"instead of removing it")
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
osFS := afero.NewOsFs()
|
|
||||||
tempDir := t.TempDir()
|
|
||||||
dataDir := filepath.Join(tempDir, "src")
|
|
||||||
storeDir := filepath.Join(tempDir, "remote")
|
|
||||||
restoreDir := filepath.Join(tempDir, "restored")
|
|
||||||
dbPath := filepath.Join(tempDir, "index.sqlite")
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
cfg := faultTestConfig()
|
|
||||||
|
|
||||||
testFiles := writeFaultSourceTree(t, osFS, dataDir)
|
|
||||||
|
|
||||||
inner, err := storage.NewFileStorer(storeDir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
db, err := database.New(ctx, dbPath)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
repos := database.NewRepositories(db)
|
|
||||||
|
|
||||||
id := fullFaultBackup(ctx, t, osFS, inner, cfg, repos, dataDir, dbPath, "diskfull")
|
|
||||||
require.NoError(t, db.Close())
|
|
||||||
|
|
||||||
// Restore onto a filesystem that allows only a few bytes of file
|
|
||||||
// content: enough to create files, far too little to hold them.
|
|
||||||
budget := int64(8)
|
|
||||||
quota := "aFS{Fs: osFS, remaining: &budget}
|
|
||||||
|
|
||||||
v := newReaderVaultik(ctx, cfg, inner, nil, quota)
|
|
||||||
err = v.Restore(&vaultik.RestoreOptions{SnapshotID: id, TargetDir: restoreDir})
|
|
||||||
|
|
||||||
require.Error(t, err, "restore must fail when the target disk is full")
|
|
||||||
assert.Contains(t, err.Error(), errNoSpace.Error(),
|
|
||||||
"restore error should surface the out-of-space cause")
|
|
||||||
|
|
||||||
// The failure must not leave a truncated file behind presenting as a
|
|
||||||
// complete restore: any file at the target must hold the original
|
|
||||||
// bytes, or be absent.
|
|
||||||
assertNoCorruptFiles(t, osFS, restoreDir, testFiles)
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertRestoredTree byte-compares every restored file against the
|
|
||||||
// original.
|
|
||||||
func assertRestoredTree(
|
|
||||||
t *testing.T, fs afero.Fs, restoreDir string, testFiles map[string][]byte,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
for origPath, expected := range testFiles {
|
|
||||||
restoredPath := filepath.Join(restoreDir, origPath)
|
|
||||||
got, err := afero.ReadFile(fs, restoredPath)
|
|
||||||
require.NoErrorf(t, err, "restored file missing: %s", origPath)
|
|
||||||
require.Equalf(t, expected, got, "restored content mismatch for %s", origPath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// errNoSpace is the out-of-space error quotaFS returns once its byte
|
|
||||||
// budget is exhausted, mirroring a real ENOSPC.
|
|
||||||
var errNoSpace = errors.New("no space left on device")
|
|
||||||
|
|
||||||
// quotaFS is an afero.Fs whose files may write only a fixed total number
|
|
||||||
// of content bytes before failing, simulating a full restore target. It
|
|
||||||
// wraps the interface so every method except Create delegates to the
|
|
||||||
// real filesystem; only file writes are capped.
|
|
||||||
type quotaFS struct {
|
|
||||||
afero.Fs
|
|
||||||
|
|
||||||
remaining *int64
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:ireturn // afero.Fs.Create's signature requires returning afero.File.
|
|
||||||
func (q *quotaFS) Create(name string) (afero.File, error) {
|
|
||||||
f, err := q.Fs.Create(name)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return "aFile{File: f, remaining: q.remaining}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// quotaFile fails writes once the shared byte budget is exhausted.
|
|
||||||
type quotaFile struct {
|
|
||||||
afero.File
|
|
||||||
|
|
||||||
remaining *int64
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *quotaFile) Write(p []byte) (int, error) {
|
|
||||||
if *q.remaining <= 0 {
|
|
||||||
return 0, errNoSpace
|
|
||||||
}
|
|
||||||
|
|
||||||
allowed := min(int64(len(p)), *q.remaining)
|
|
||||||
|
|
||||||
n, err := q.File.Write(p[:allowed])
|
|
||||||
*q.remaining -= int64(n)
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if int64(n) < int64(len(p)) {
|
|
||||||
return n, errNoSpace
|
|
||||||
}
|
|
||||||
|
|
||||||
return n, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertNoCorruptFiles fails if any file that made it to the restore
|
|
||||||
// target holds content that differs from the original: a failed restore
|
|
||||||
// may leave a file absent, but must never leave wrong bytes presenting
|
|
||||||
// as the real file.
|
|
||||||
func assertNoCorruptFiles(
|
|
||||||
t *testing.T, fs afero.Fs, restoreDir string, testFiles map[string][]byte,
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
for origPath, expected := range testFiles {
|
|
||||||
restoredPath := filepath.Join(restoreDir, origPath)
|
|
||||||
|
|
||||||
got, err := afero.ReadFile(fs, restoredPath)
|
|
||||||
if err != nil {
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.Equalf(t, expected, got,
|
|
||||||
"restored file %s holds corrupt content", origPath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -35,7 +35,6 @@ var (
|
|||||||
"invalid snapshot ID format: expected hostname_snapshotname_timestamp")
|
"invalid snapshot ID format: expected hostname_snapshotname_timestamp")
|
||||||
errInvalidDuration = errors.New("invalid duration")
|
errInvalidDuration = errors.New("invalid duration")
|
||||||
errUnknownTimeUnit = errors.New("unknown time unit")
|
errUnknownTimeUnit = errors.New("unknown time unit")
|
||||||
errNegativeDuration = errors.New("negative durations are not supported")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Time-unit lengths used by parseDuration.
|
// Time-unit lengths used by parseDuration.
|
||||||
@@ -139,13 +138,8 @@ func parseSnapshotName(snapshotID string) string {
|
|||||||
|
|
||||||
// parseDuration parses a duration string with support for human-friendly units:
|
// parseDuration parses a duration string with support for human-friendly units:
|
||||||
// d/day/days, w/week/weeks, mo/month/months, y/year/years, plus standard Go
|
// d/day/days, w/week/weeks, mo/month/months, y/year/years, plus standard Go
|
||||||
// duration units. Following Go, m is minutes and mo is months. A bare number,
|
// duration units (h, m, s).
|
||||||
// an unknown unit, and a negative value are all rejected.
|
|
||||||
func parseDuration(s string) (time.Duration, error) {
|
func parseDuration(s string) (time.Duration, error) {
|
||||||
if strings.HasPrefix(strings.TrimSpace(s), "-") {
|
|
||||||
return 0, errNegativeDuration
|
|
||||||
}
|
|
||||||
|
|
||||||
d, err := time.ParseDuration(s)
|
d, err := time.ParseDuration(s)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
return d, nil
|
return d, nil
|
||||||
|
|||||||
@@ -51,32 +51,13 @@ func TestParseDuration(t *testing.T) {
|
|||||||
want time.Duration
|
want time.Duration
|
||||||
err bool
|
err bool
|
||||||
}{
|
}{
|
||||||
// Go units, including the m-is-minutes / mo-is-months distinction
|
|
||||||
// that this parser exists to keep straight.
|
|
||||||
{"10ns", 10 * time.Nanosecond, false},
|
|
||||||
{"10us", 10 * time.Microsecond, false},
|
|
||||||
{"500ms", 500 * time.Millisecond, false},
|
|
||||||
{"30s", 30 * time.Second, false},
|
|
||||||
{"6m", 6 * time.Minute, false},
|
|
||||||
{"1h", time.Hour, false},
|
|
||||||
// Extended calendar units.
|
|
||||||
{"30d", 30 * 24 * time.Hour, false},
|
{"30d", 30 * 24 * time.Hour, false},
|
||||||
{"3days", 3 * 24 * time.Hour, false},
|
|
||||||
{"4w", 4 * 7 * 24 * time.Hour, false},
|
{"4w", 4 * 7 * 24 * time.Hour, false},
|
||||||
{"2weeks", 2 * 7 * 24 * time.Hour, false},
|
{"6mo", 6 * 30 * 24 * time.Hour, false},
|
||||||
{"6mo", 180 * 24 * time.Hour, false},
|
|
||||||
{"1month", 30 * 24 * time.Hour, false},
|
|
||||||
{"1y", 365 * 24 * time.Hour, false},
|
{"1y", 365 * 24 * time.Hour, false},
|
||||||
{"2years", 2 * 365 * 24 * time.Hour, false},
|
|
||||||
// Combined units.
|
|
||||||
{"2w3d", 2*7*24*time.Hour + 3*24*time.Hour, false},
|
{"2w3d", 2*7*24*time.Hour + 3*24*time.Hour, false},
|
||||||
{"1y6mo", 365*24*time.Hour + 180*24*time.Hour, false},
|
{"1h", time.Hour, false},
|
||||||
// Rejected inputs.
|
{"30s", 30 * time.Second, false},
|
||||||
{"6", 0, true}, // bare number, no unit
|
|
||||||
{"5x", 0, true}, // unknown unit
|
|
||||||
{"-5d", 0, true}, // negative, extended unit
|
|
||||||
{"-5h", 0, true}, // negative, Go unit
|
|
||||||
{"", 0, true}, // empty
|
|
||||||
{"garbage", 0, true},
|
{"garbage", 0, true},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -167,12 +167,6 @@ func (v *Vaultik) PruneBlobs(opts *PruneOptions) error {
|
|||||||
|
|
||||||
// collectReferencedBlobs downloads all manifests and returns the set of
|
// collectReferencedBlobs downloads all manifests and returns the set of
|
||||||
// referenced blob hashes.
|
// referenced blob hashes.
|
||||||
//
|
|
||||||
// Every manifest must be read successfully. A manifest that cannot be
|
|
||||||
// downloaded or decoded means its snapshot's blobs are unknown, so
|
|
||||||
// treating them as unreferenced would let prune delete data a snapshot
|
|
||||||
// still needs. Rather than risk that silent loss, any failure returns an
|
|
||||||
// error naming the remote key and prune deletes nothing.
|
|
||||||
func (v *Vaultik) collectReferencedBlobs() (map[string]bool, error) {
|
func (v *Vaultik) collectReferencedBlobs() (map[string]bool, error) {
|
||||||
log.Info("Listing remote snapshots")
|
log.Info("Listing remote snapshots")
|
||||||
// IDs returned by listUniqueSnapshotIDs are remote keys (hashed
|
// IDs returned by listUniqueSnapshotIDs are remote keys (hashed
|
||||||
@@ -185,22 +179,27 @@ func (v *Vaultik) collectReferencedBlobs() (map[string]bool, error) {
|
|||||||
log.Info("Found manifests in remote storage", "count", len(remoteKeys))
|
log.Info("Found manifests in remote storage", "count", len(remoteKeys))
|
||||||
|
|
||||||
allBlobsReferenced := make(map[string]bool)
|
allBlobsReferenced := make(map[string]bool)
|
||||||
|
manifestCount := 0
|
||||||
|
|
||||||
for _, remoteKey := range remoteKeys {
|
for _, remoteKey := range remoteKeys {
|
||||||
log.Debug("Processing manifest", "remote_key", remoteKey)
|
log.Debug("Processing manifest", "remote_key", remoteKey)
|
||||||
|
|
||||||
manifest, err := v.downloadManifestByKey(remoteKey)
|
manifest, err := v.downloadManifestByKey(remoteKey)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("reading manifest %s: %w", remoteKey, err)
|
log.Error("Failed to download manifest", "remote_key", remoteKey, "error", err)
|
||||||
|
|
||||||
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, blob := range manifest.Blobs {
|
for _, blob := range manifest.Blobs {
|
||||||
allBlobsReferenced[blob.Hash] = true
|
allBlobsReferenced[blob.Hash] = true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
manifestCount++
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("Processed manifests",
|
log.Info("Processed manifests",
|
||||||
"count", len(remoteKeys), "unique_blobs_referenced", len(allBlobsReferenced))
|
"count", manifestCount, "unique_blobs_referenced", len(allBlobsReferenced))
|
||||||
|
|
||||||
return allBlobsReferenced, nil
|
return allBlobsReferenced, nil
|
||||||
}
|
}
|
||||||
@@ -247,23 +246,10 @@ func (v *Vaultik) listAllRemoteBlobs() (map[string]int64, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
parts := strings.Split(object.Key, "/")
|
parts := strings.Split(object.Key, "/")
|
||||||
if len(parts) != blobKeyParts || parts[0] != "blobs" {
|
if len(parts) == blobKeyParts && parts[0] == "blobs" {
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// The object name is read from the destination store and is not
|
|
||||||
// trusted. A name that is not a blob hash (e.g. a short or
|
|
||||||
// non-hex string) would panic the later hash[:2]/hash[2:4] path
|
|
||||||
// build, so skip it with a warning rather than delete it.
|
|
||||||
if !isBlobHash(parts[3]) {
|
|
||||||
log.Warn("Skipping non-conforming object under blobs/",
|
|
||||||
"key", object.Key)
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
allBlobs[parts[3]] = object.Size
|
allBlobs[parts[3]] = object.Size
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
log.Info("Found blobs in storage", "count", len(allBlobs))
|
log.Info("Found blobs in storage", "count", len(allBlobs))
|
||||||
|
|
||||||
|
|||||||
@@ -1,79 +0,0 @@
|
|||||||
package vaultik //nolint:testpackage // exercises unexported count helpers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestTableCountForReportSurfacesReadFailure is the regression guard for
|
|
||||||
// the discarded-error bug: getTableCount for a table its query cannot
|
|
||||||
// resolve must not silently become 0. A count that could not be read is
|
|
||||||
// reported as unknown, which a reader can tell apart from an empty table.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // installs the global logger via log.Initialize
|
|
||||||
func TestTableCountForReportSurfacesReadFailure(t *testing.T) {
|
|
||||||
log.Initialize(log.Config{})
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
db, err := database.New(ctx, ":memory:")
|
|
||||||
require.NoError(t, err)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
v := &Vaultik{DB: db}
|
|
||||||
v.SetContext(ctx)
|
|
||||||
|
|
||||||
// A table present in the schema reads as a real count.
|
|
||||||
blobs := v.tableCountForReport("blobs")
|
|
||||||
require.NotNil(t, blobs, "an existing table must read as a real count")
|
|
||||||
assert.Equal(t, int64(0), *blobs)
|
|
||||||
|
|
||||||
// A syntactically valid name the sanitizer accepts but whose table
|
|
||||||
// the query cannot resolve is the exact shape #96 describes: a
|
|
||||||
// would-be loud failure that used to be discarded into a 0.
|
|
||||||
_, err = v.getTableCount("snapshots_missing")
|
|
||||||
require.Error(t, err, "a query against a nonexistent table must fail")
|
|
||||||
|
|
||||||
missing := v.tableCountForReport("snapshots_missing")
|
|
||||||
assert.Nil(t, missing, "a failed read is unknown, not a count")
|
|
||||||
|
|
||||||
// The rendered count for a failed read must say unknown, never 0.
|
|
||||||
assert.Equal(t, countUnknown, countText(missing))
|
|
||||||
assert.NotEqual(t, "0", countText(missing))
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCountTextDistinguishesEmptyFromUnknown pins the distinction the
|
|
||||||
// output has to preserve: 0 means the table was empty, "unknown" means
|
|
||||||
// the count could not be read.
|
|
||||||
func TestCountTextDistinguishesEmptyFromUnknown(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
zero := int64(0)
|
|
||||||
seven := int64(7)
|
|
||||||
|
|
||||||
assert.Equal(t, "0", countText(&zero))
|
|
||||||
assert.Equal(t, "7", countText(&seven))
|
|
||||||
assert.Equal(t, countUnknown, countText(nil))
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCountDiffUnknownWhenEitherSideUnknown checks that a delta computed
|
|
||||||
// from an unreadable count is itself unknown rather than a plausible
|
|
||||||
// number.
|
|
||||||
func TestCountDiffUnknownWhenEitherSideUnknown(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
before := int64(10)
|
|
||||||
after := int64(3)
|
|
||||||
|
|
||||||
require.NotNil(t, countDiff(&before, &after))
|
|
||||||
assert.Equal(t, int64(7), *countDiff(&before, &after))
|
|
||||||
|
|
||||||
assert.Nil(t, countDiff(nil, &after), "unknown before yields unknown delta")
|
|
||||||
assert.Nil(t, countDiff(&before, nil), "unknown after yields unknown delta")
|
|
||||||
assert.Nil(t, countDiff(nil, nil))
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user