Fix missing-key errors for restore and deep verify to name both key sources (closes #401)

The missing-key error for restore and deep verify is one value, errDecryptionKeyRequired, whose text names both places the key can be set: the VAULTIK_AGE_SECRET_KEY environment variable first, then the age_secret_key config file field.

Model: deepseek-v4-pro

README.md

@@ -32,8 +32,8 @@ mkdir /Volumes/usbstick/mybackup
 # (System Settings → Privacy & Security → Full Disk Access), otherwise
 # the backup will abort with a permission error on protected directories
 
-# run your first backup (the default config backs up ~, and /Applications
+# run your first backup (the default config backs up ~ and /Applications
-# on macOS only, with sensible excludes)
+# with sensible excludes)
 vaultik snapshot create
 
 # see what you have

TODO.md

@@ -24,17 +24,6 @@ owner's; a `v*` tag runs the release build in
 
 # Completed Steps
 
-- 2026-11-10: Printed the status and progress lines of `remote info`
-  and `snapshot verify` through `internal/ui`, with its marker and
-  color, as the README describes
-  ([issue #410](https://git.eeqj.de/sneak/vaultik/issues/410)). Their
-  reports stay plain.
-
-- 2026-11-10: Made `config init` write the `apps` snapshot, which backs
-  up `/Applications`, only on macOS
-  ([issue #408](https://git.eeqj.de/sneak/vaultik/issues/408)). On
-  Linux the first `snapshot create` stopped on the missing directory.
-
 - 2026-10-15: Stopped `snapshot create --prune` pruning after a backup
   in which a volume mounted below a configured path in an earlier
   snapshot of the same name was not mounted

internal/cli/config.go

@@ -8,7 +8,6 @@ import (
 	"os/exec"
 	"path/filepath"
 	"reflect"
-	"runtime"
 	"slices"
 	"strconv"
 	"strings"
@@ -31,7 +30,7 @@ const configSetArgs = 2
 // parent config dirs (e.g. ~/.config) are conventionally traversable.
 const configDirMode = 0o755
 
-// configYAMLIndent matches the 2-space indentation of the default config,
+// 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
@@ -51,22 +50,7 @@ var (
 			"so the file was not changed")
 )
 
-// macOS is the value of runtime.GOOS on macOS.
+const defaultConfigTemplate = `# vaultik configuration
-const macOS = "darwin"
-
-// defaultConfigText returns the file `config init` writes on the operating
-// system goos, named as runtime.GOOS names it. Only macOS gets the apps
-// snapshot, since /Applications exists nowhere else.
-func defaultConfigText(goos string) string {
-	if goos == macOS {
-		return defaultConfigHead + appsSnapshotConfig + defaultConfigTail
-	}
-
-	return defaultConfigHead + defaultConfigTail
-}
-
-// defaultConfigHead is the default config up to the end of the home snapshot.
-const defaultConfigHead = `# vaultik configuration
 # Documentation: https://sneak.berlin/go/vaultik
 
 # ─── REQUIRED ────────────────────────────────────────────────────────────────
@@ -184,10 +168,7 @@ snapshots:
       - "/Movies/ProxyMedia"
       - "/Music/iTunes/Album Artwork"
       - "/Pictures/iPod Photo Cache"
-`
 
-// appsSnapshotConfig is the apps snapshot of the default config.
-const appsSnapshotConfig = `
   # Third-party applications. OS-provided apps live in /System/Applications
   # on modern macOS and are never in /Applications, but Apple-installed
   # App Store apps (Safari, GarageBand, iWork, iMovie) are excluded since
@@ -208,10 +189,7 @@ const appsSnapshotConfig = `
       - "/Steam.app"
       - "/VirtualBox.app"
       - "/Utilities/Adobe Installers"
-`
 
-// defaultConfigTail is the default config after the snapshots.
-const defaultConfigTail = `
 # Storage backend (pick ONE of the three forms below).
 #
 # S3-compatible:
@@ -333,8 +311,7 @@ on macOS, ~/.config/ on Linux, /etc/vaultik/ as root).`,
 				return fmt.Errorf("creating config directory %s: %w", dir, err)
 			}
 
-			err = os.WriteFile(path, []byte(defaultConfigText(runtime.GOOS)),
+			err = os.WriteFile(path, []byte(defaultConfigTemplate), configFileMode)
-				configFileMode)
 			if err != nil {
 				return fmt.Errorf("writing config file: %w", err)
 			}
@@ -583,7 +560,7 @@ func yamlPathOnly(root *yaml.Node, keys []string) (*yaml.Node, error) {
 }
 
 // marshalConfigYAML renders a config document tree with 2-space indentation,
-// matching the default config. yaml.Marshal defaults to 4 spaces, which
+// 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) {

internal/cli/config_test.go

@@ -13,15 +13,14 @@ import (
 	"sneak.berlin/go/vaultik/internal/ui"
 )
 
-// TestDefaultConfigParsesOnMacOS ensures the config `config init` writes on
+// TestDefaultConfigTemplateParses ensures the init template is valid YAML
-// macOS is valid YAML that unmarshals into the Config struct with the
+// that unmarshals into the Config struct with the expected snapshots.
-// expected snapshots.
+func TestDefaultConfigTemplateParses(t *testing.T) {
-func TestDefaultConfigParsesOnMacOS(t *testing.T) {
 	t.Parallel()
 
 	var cfg config.Config
 
-	err := yaml.Unmarshal([]byte(defaultConfigText("darwin")), &cfg)
+	err := yaml.Unmarshal([]byte(defaultConfigTemplate), &cfg)
 	if err != nil {
 		t.Fatalf("default config template is not valid YAML: %v", err)
 	}
@@ -59,39 +58,6 @@ func TestDefaultConfigParsesOnMacOS(t *testing.T) {
 	}
 }
 
-// TestDefaultConfigOnLinux checks that the config `config init` writes on
-// Linux loads with its home snapshot and without the apps snapshot, whose
-// /Applications exists only on macOS.
-func TestDefaultConfigOnLinux(t *testing.T) {
-	t.Parallel()
-
-	path := filepath.Join(t.TempDir(), "config.yml")
-
-	err := os.WriteFile(path, []byte(defaultConfigText("linux")), configFileMode)
-	if err != nil {
-		t.Fatalf("write config: %v", err)
-	}
-
-	err = writeConfigSet(ui.NewWithColor(&bytes.Buffer{}, false),
-		path, "storage_url", "file:///mnt/backups")
-	if err != nil {
-		t.Fatalf("config set storage_url: %v", err)
-	}
-
-	cfg, err := config.Load(path)
-	if err != nil {
-		t.Fatalf("config.Load: %v", err)
-	}
-
-	if _, ok := cfg.Snapshots["home"]; !ok {
-		t.Error("expected 'home' snapshot in the Linux default config")
-	}
-
-	if _, ok := cfg.Snapshots["apps"]; ok {
-		t.Error("the Linux default config should have no 'apps' snapshot")
-	}
-}
-
 // testRecipient is a valid age public key.
 const testRecipient = "age1278m9q7dp3chsh2dcy82qk27v047zywyvtxwnj4cvt0z65jw6a7q5dqhfj"
 
@@ -105,7 +71,7 @@ func TestConfigSetRecipientOnFreshConfig(t *testing.T) {
 
 	path := filepath.Join(t.TempDir(), "config.yml")
 
-	err := os.WriteFile(path, []byte(defaultConfigText(macOS)), configFileMode)
+	err := os.WriteFile(path, []byte(defaultConfigTemplate), configFileMode)
 	if err != nil {
 		t.Fatalf("write config: %v", err)
 	}
@@ -254,7 +220,7 @@ func TestConfigSetKeepsFileThatWouldNotLoad(t *testing.T) {
 		{levelReference, "blob_size_limit", "1MB",
 			"blob_size_limit must be at least"},
 		// The type check on a config that does not load yet.
-		{defaultConfigText(macOS), "snapshots.apps.paths", "/srv",
+		{defaultConfigTemplate, "snapshots.apps.paths", "/srv",
 			"into []string"},
 		// The type check on a config that cannot be read here.
 		{configWithUnsetReference, "snapshots.home.paths", "/x",
@@ -414,7 +380,7 @@ func loadAfterConfigSet(t *testing.T, key, value string) *config.Config {
 
 	path := filepath.Join(t.TempDir(), "config.yml")
 
-	err := os.WriteFile(path, []byte(defaultConfigText(macOS)), configFileMode)
+	err := os.WriteFile(path, []byte(defaultConfigTemplate), configFileMode)
 	if err != nil {
 		t.Fatalf("write config: %v", err)
 	}

internal/snapshot/snapshot.go

@@ -271,18 +271,16 @@ func (sm *SnapshotManager) CompleteSnapshot(
 	return sm.MarkSnapshotComplete(ctx, snapshotID)
 }
 
-// ExportSnapshotMetadata exports snapshot metadata to the backup destination store
+// ExportSnapshotMetadata exports snapshot metadata to S3
 //
 // This method executes the complete snapshot metadata export process:
 // 1. Creates a temporary directory for working files
 // 2. Copies the main database to preserve its state
 // 3. Cleans the copy to contain only current snapshot data
-// 4. Vacuums the copy to remove the deleted data
+// 4. Dumps the cleaned database to SQL
-// 5. Compresses the copy with zstd
+// 5. Compresses the SQL dump with zstd
-// 6. Encrypts the compressed copy with age (always; recipients are required)
+// 6. Encrypts the compressed data with age (always; recipients are required)
-// 7. Builds the blob manifest from the copy, compressed but not encrypted
+// 7. Uploads to S3 at: snapshots/{snapshot-id}.sql.zst[.age]
-// 8. Uploads the database to metadata/{remote-key}/db.zst.age
-// 9. Uploads the manifest to metadata/{remote-key}/manifest.json.zst
 //
 // The only caller (finalizeSnapshotMetadata) does not close the main database
 // before calling this method: the index is copied at dbPath while it is still

internal/vaultik/info.go

@@ -246,7 +246,7 @@ func (v *Vaultik) RemoteInfo(jsonOutput bool) error {
 		v.stdoutf("Type:     %s\n", storageInfo.Type)
 		v.stdoutf("Location: %s\n", storageInfo.Location)
 		v.printlnStdout()
-		v.UI.Beginf("Scanning snapshot metadata...")
+		v.stdoutf("Scanning snapshot metadata...\n")
 	}
 
 	snapshotMetadata, snapshotIDs, skippedManifestCount, err := v.collectSnapshotMetadata()
@@ -265,7 +265,7 @@ func (v *Vaultik) RemoteInfo(jsonOutput bool) error {
 			}
 		}
 
-		v.UI.Beginf("Downloading %d manifest(s)...", manifestCount)
+		v.stdoutf("Downloading %d manifest(s)...\n", manifestCount)
 	}
 
 	referencedBlobs, unreadableManifests := v.collectReferencedBlobsFromManifests(
@@ -447,7 +447,7 @@ func (v *Vaultik) scanRemoteBlobStorage(
 	result *RemoteInfoResult, referencedBlobs map[string]int64, showText bool,
 ) error {
 	if showText {
-		v.UI.Beginf("Scanning blobs...")
+		v.stdoutf("Scanning blobs...\n")
 	}
 
 	// Use prune's listing, so a file under blobs/ that prune would never

internal/vaultik/remote_info_test.go

@@ -12,7 +12,6 @@ import (
 	"github.com/stretchr/testify/require"
 	"sneak.berlin/go/vaultik/internal/log"
 	"sneak.berlin/go/vaultik/internal/snapshot"
-	"sneak.berlin/go/vaultik/internal/ui"
 )
 
 // testBlobHashB is a blob that the manifest written by addRemote does
@@ -260,24 +259,3 @@ func TestRemoteInfo_DirectoryWithoutManifestLeavesOrphansKnown(t *testing.T) {
 	assert.NotContains(t, doc, "unreadable_manifests")
 	assert.NotContains(t, doc, "skipped_manifest_count")
 }
-
-// TestRemoteInfo_StatusLineUsesUIMarker checks that the remote info
-// status lines go through internal/ui: marker-prefixed, and silenced by
-// --quiet.
-func TestRemoteInfo_StatusLineUsesUIMarker(t *testing.T) {
-	log.Initialize(log.Config{})
-	t.Parallel()
-
-	env := newListEnv(t)
-	env.addRemote(t, listRemoteID, time.Date(2026, 3, 2, 0, 0, 0, 0, time.UTC))
-
-	const statusLine = ui.Marker + " Scanning snapshot metadata...\n"
-
-	require.NoError(t, env.v.RemoteInfo(false))
-	assert.Contains(t, env.stdout.String(), statusLine)
-
-	env.stdout.Reset()
-	env.v.UI.SetQuiet(true)
-	require.NoError(t, env.v.RemoteInfo(false))
-	assert.NotContains(t, env.stdout.String(), "Scanning snapshot metadata")
-}

internal/vaultik/restore.go

@@ -31,10 +31,9 @@ var (
 	errPathsNotInSnapshot    = errors.New("requested path(s) not in the snapshot")
 	errFilesFailedVerify     = errors.New("files failed verification")
 	errDecryptionKeyRequired = errors.New(
-		"decryption key required for restore\n\n" +
+		"age secret key is missing; set it in the " +
-			"Set the VAULTIK_AGE_SECRET_KEY environment variable to your " +
+			"VAULTIK_AGE_SECRET_KEY environment variable or the " +
-			"age private key file:\n" +
+			"age_secret_key config file field")
-			"  export VAULTIK_AGE_SECRET_KEY=\"$(cat vaultik_backup_private_key.txt)\"")
 	// errInvalidAgeSecretKey is returned when the configured key does not
 	// parse as any age identity. It names the source but never the value,
 	// which is secret, so the message is safe to print and log.

internal/vaultik/restore_identity_test.go

@@ -106,3 +106,23 @@ func TestRestoreIdentitiesMissingKey(t *testing.T) {
 	_, err := v.restoreIdentities()
 	require.ErrorIs(t, err, errDecryptionKeyRequired)
 }
+
+// TestMissingKeyErrorsNameBothSources asserts restore and deep verify
+// return the same missing-key error, whose text names both places the key
+// can be set: the VAULTIK_AGE_SECRET_KEY environment variable first since
+// it is preferred, then the age_secret_key config file field.
+func TestMissingKeyErrorsNameBothSources(t *testing.T) {
+	t.Parallel()
+
+	const want = "age secret key is missing; set it in " +
+		"the VAULTIK_AGE_SECRET_KEY environment variable or the " +
+		"age_secret_key config file field"
+
+	v := &Vaultik{Config: &config.Config{}}
+
+	_, err := v.restoreIdentities()
+	require.EqualError(t, err, want)
+
+	err = v.RunDeepVerify("any-snapshot", &VerifyOptions{})
+	require.EqualError(t, err, want)
+}

internal/vaultik/snapshot.go

@@ -1019,7 +1019,7 @@ func (v *Vaultik) VerifySnapshotWithOptions(
 		v.printlnStdout()
 
 		// Check each blob is present with the size the manifest records.
-		v.UI.Beginf("Checking blob presence and sizes...")
+		v.stdoutf("Checking blob presence and sizes...\n")
 	}
 
 	v.checkSnapshotDatabase(remoteKey, result)

internal/vaultik/storage_bind.go

@@ -30,7 +30,7 @@ var errStorageBindingMismatch = errors.New(
 //     nothing and return nil.
 //   - When the two differ, refuse with an error that tells the user
 //     how to recover (revert the config, or run `vaultik database
-//     delete` to discard the local index and rebuild against the new
+//     purge` to discard the local index and rebuild against the new
 //     destination on the next backup).
 //
 // Read-only inspection commands (remote info, snapshot list, etc.)

internal/vaultik/vaultik.go

@@ -162,11 +162,6 @@ func (v *Vaultik) StartOperation(fn func()) func(context.Context) bool {
 	}
 }
 
-// CanDecrypt returns true if this Vaultik instance has decryption capabilities
-func (v *Vaultik) CanDecrypt() bool {
-	return v.Config.AgeSecretKey != ""
-}
-
 // GetFilesystem returns the filesystem instance used by Vaultik
 //
 //nolint:ireturn // afero.Fs is the filesystem abstraction by design

internal/vaultik/verify.go

@@ -22,9 +22,7 @@ import (
 
 // Sentinel errors for snapshot verification failures.
 var (
-	errVerificationFailed = errors.New("verification failed")
+	errVerificationFailed  = errors.New("verification failed")
-	errSecretKeyRequired  = errors.New(
-		"VAULTIK_AGE_SECRET_KEY not set; required for deep verification")
 	errChunksOutOfOrder    = errors.New("chunks out of order")
 	errChunkHashMismatch   = errors.New("chunk hash mismatch")
 	errNegativeChunkLength = errors.New("chunk length is negative")
@@ -106,13 +104,9 @@ func (v *Vaultik) RunDeepVerify(snapshotID string, opts *VerifyOptions) error {
 		Mode:       "deep",
 	}
 
-	if !v.CanDecrypt() {
-		return v.deepVerifyFailure(result, opts,
-			errSecretKeyRequired.Error(), errSecretKeyRequired)
-	}
-
 	// Parse the age secret key once, the same way restore does, and reuse
-	// the identities for the database and every blob.
+	// the identities for the database and every blob. A missing key fails
+	// here, before anything is downloaded.
 	identities, err := v.restoreIdentities()
 	if err != nil {
 		return v.deepVerifyFailure(result, opts, err.Error(), err)
@@ -190,7 +184,7 @@ func (v *Vaultik) loadVerificationData(
 	log.Info("Downloading manifest", "remote_key", remoteKey)
 
 	if !opts.JSON && !v.UI.Quiet() {
-		v.UI.Beginf("Downloading manifest...")
+		v.stdoutf("Downloading manifest...\n")
 	}
 
 	manifest, err := v.downloadManifestByKey(remoteKey)
@@ -205,9 +199,9 @@ func (v *Vaultik) loadVerificationData(
 		"manifest_total_size", ubytes(manifest.TotalCompressedSize))
 
 	if !opts.JSON && !v.UI.Quiet() {
-		v.UI.Completef("Manifest loaded: %d blobs (%s)",
+		v.stdoutf("Manifest loaded: %d blobs (%s)\n",
 			manifest.BlobCount, ubytes(manifest.TotalCompressedSize))
-		v.UI.Beginf("Downloading and decrypting database...")
+		v.stdoutf("Downloading and decrypting database...\n")
 	}
 
 	tdb, err := v.downloadVerifiedSnapshotDB(
@@ -235,7 +229,7 @@ func (v *Vaultik) loadVerificationData(
 		"db_total_size", ubytes(dbTotalSize))
 
 	if !opts.JSON && !v.UI.Quiet() {
-		v.UI.Completef("Database loaded: %d blobs (%s)",
+		v.stdoutf("Database loaded: %d blobs (%s)\n",
 			len(dbBlobs), ubytes(dbTotalSize))
 	}
 
@@ -295,7 +289,7 @@ func (v *Vaultik) runVerificationSteps(
 	identities []age.Identity,
 ) error {
 	if !opts.JSON && !v.UI.Quiet() {
-		v.UI.Beginf("Verifying manifest against database...")
+		v.stdoutf("Verifying manifest against database...\n")
 	}
 
 	err := v.verifyManifestAgainstDatabase(manifest, dbBlobs)
@@ -304,8 +298,8 @@ func (v *Vaultik) runVerificationSteps(
 	}
 
 	if !opts.JSON && !v.UI.Quiet() {
-		v.UI.Completef("Manifest verified.")
+		v.stdoutf("Manifest verified.\n")
-		v.UI.Beginf("Checking blob existence in remote storage...")
+		v.stdoutf("Checking blob existence in remote storage...\n")
 	}
 
 	err = v.verifyBlobExistenceFromDB(dbBlobs, result)
@@ -314,8 +308,8 @@ func (v *Vaultik) runVerificationSteps(
 	}
 
 	if !opts.JSON && !v.UI.Quiet() {
-		v.UI.Completef("All blobs exist.")
+		v.stdoutf("All blobs exist.\n")
-		v.UI.Beginf("Downloading and verifying blob contents (%d blobs, %s)...",
+		v.stdoutf("Downloading and verifying blob contents (%d blobs, %s)...\n",
 			len(dbBlobs), ubytes(totalSize))
 	}
 
@@ -790,7 +784,7 @@ func (v *Vaultik) performDeepVerificationFromDB(
 		)
 
 		if !opts.JSON && !v.UI.Quiet() {
-			v.UI.Progressf("Verified %d/%d blobs (%d remaining) - %s/%s - elapsed %s, eta %s",
+			v.stdoutf("  Verified %d/%d blobs (%d remaining) - %s/%s - elapsed %s, eta %s\n",
 				i+1, len(blobs), remaining,
 				ubytes(bytesProcessed),
 				ubytes(totalBytesExpected),

internal/vaultik/verify_quiet_test.go

@@ -100,51 +100,3 @@ func TestVerify_QuietSuppressesReport(t *testing.T) {
 	require.Empty(t, stdout.String(),
 		"a failed verify must write no report under --quiet")
 }
-
-// TestVerify_DeepStatusLineUsesUIMarker checks that the deep verify
-// status lines go through internal/ui: marker-prefixed, and silenced by
-// --quiet.
-func TestVerify_DeepStatusLineUsesUIMarker(t *testing.T) {
-	log.Initialize(log.Config{})
-	t.Parallel()
-
-	fs := afero.NewOsFs()
-	tempDir := t.TempDir()
-
-	dataDir := filepath.Join(tempDir, "source")
-	storeDir := t.TempDir()
-	dbPath := filepath.Join(tempDir, "index.sqlite")
-
-	require.NoError(t, fs.MkdirAll(dataDir, 0o755))
-	require.NoError(t, afero.WriteFile(fs,
-		filepath.Join(dataDir, "data.bin"),
-		bytesPattern("marker-", 64*1024), 0o644))
-
-	ctx := context.Background()
-
-	cfg, storer, snapshotID := runFileStorageBackup(
-		ctx, t, fs, dataDir, storeDir, dbPath, 32*1024, 128*1024)
-
-	var stdout bytes.Buffer
-
-	v := &vaultik.Vaultik{
-		Config:  cfg,
-		Storage: storer,
-		Fs:      fs,
-		Stdout:  &stdout,
-		Stderr:  io.Discard,
-		UI:      ui.NewWithColor(&stdout, false),
-	}
-	v.SetContext(ctx)
-
-	opts := &vaultik.VerifyOptions{Deep: true}
-
-	require.NoError(t, v.VerifySnapshotWithOptions(snapshotID, opts))
-	require.Contains(t, stdout.String(),
-		"\n"+ui.Marker+" Downloading manifest...\n")
-
-	stdout.Reset()
-	v.UI.SetQuiet(true)
-	require.NoError(t, v.VerifySnapshotWithOptions(snapshotID, opts))
-	require.NotContains(t, stdout.String(), "Downloading manifest")
-}