Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ae07981902 | ||
|
|
d88ed64489 | ||
|
|
bd9656dbd4 |
@@ -74,11 +74,16 @@ Requirements that no existing tool meets:
|
|||||||
# verify a snapshot (shallow: checks all blobs are present with the listed size)
|
# verify a snapshot (shallow: checks all blobs are present with the listed size)
|
||||||
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_AGE_SECRET_KEY='AGE-SECRET-KEY-...' vaultik snapshot verify --deep <snapshot-id>
|
vaultik snapshot verify --deep <snapshot-id>
|
||||||
|
|
||||||
# restore (requires the private key)
|
# restore (requires the private key)
|
||||||
VAULTIK_AGE_SECRET_KEY='AGE-SECRET-KEY-...' vaultik snapshot restore <snapshot-id> /tmp/restored
|
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
|
||||||
@@ -119,14 +124,16 @@ Use that remote key — the hex printed inside `<remote only:...>`, or the
|
|||||||
full `remote_key` from `snapshot list --json` — to restore and verify:
|
full `remote_key` from `snapshot list --json` — to restore and verify:
|
||||||
|
|
||||||
```sh
|
```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
|
# restore everything to /tmp/restored, then check every restored file's
|
||||||
# chunk hashes
|
# chunk hashes
|
||||||
VAULTIK_AGE_SECRET_KEY='AGE-SECRET-KEY-...' \
|
|
||||||
vaultik snapshot restore --verify <remote-key> /tmp/restored
|
vaultik snapshot restore --verify <remote-key> /tmp/restored
|
||||||
|
|
||||||
# optionally, deep-verify the snapshot against the store (downloads and
|
# optionally, deep-verify the snapshot against the store (downloads and
|
||||||
# cryptographically checks every blob)
|
# cryptographically checks every blob)
|
||||||
VAULTIK_AGE_SECRET_KEY='AGE-SECRET-KEY-...' \
|
|
||||||
vaultik snapshot verify --deep <remote-key>
|
vaultik snapshot verify --deep <remote-key>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -217,7 +224,7 @@ 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`)
|
* `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_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_CPUPROFILE`: Write a CPU profile to this path for the duration of the run (development/debugging)
|
||||||
|
|||||||
@@ -20,10 +20,12 @@ type Reader struct {
|
|||||||
bytesRead int64
|
bytesRead int64
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewReader creates a new Reader that decrypts, decompresses, and verifies data
|
// NewReader creates a new Reader that decrypts, decompresses, and verifies
|
||||||
func NewReader(r io.Reader, identity age.Identity) (*Reader, error) {
|
// data. Every supplied identity is offered to age.Decrypt, so a blob
|
||||||
|
// 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, identity)
|
decReader, err := age.Decrypt(r, identities...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("creating decryption reader: %w", err)
|
return nil, fmt.Errorf("creating decryption reader: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -35,8 +35,12 @@ The snapshot may be named by its ID or, when restoring on a host with no
|
|||||||
local index, by the remote key that 'snapshot list' prints for a
|
local index, by the remote key that 'snapshot list' prints for a
|
||||||
remote-only snapshot (an unambiguous leading part is enough).
|
remote-only snapshot (an unambiguous leading part is enough).
|
||||||
|
|
||||||
Requires the VAULTIK_AGE_SECRET_KEY environment variable to be set with
|
Requires the age private key in the VAULTIK_AGE_SECRET_KEY environment
|
||||||
the age private key.
|
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
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
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 ...)")
|
||||||
|
}
|
||||||
|
}
|
||||||
+41
-20
@@ -135,6 +135,26 @@ 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.
|
||||||
@@ -144,6 +164,11 @@ func (c *Config) SnapshotNames() []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.
|
||||||
@@ -254,10 +279,7 @@ func Load(path string) (*Config, error) {
|
|||||||
cfg.IndexPath = expandTilde(envIndexPath)
|
cfg.IndexPath = expandTilde(envIndexPath)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check for environment variable override for AgeSecretKey
|
cfg.setAgeSecretKey()
|
||||||
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 == "" {
|
||||||
@@ -379,6 +401,21 @@ func validateAgeRecipient(recipient string) error {
|
|||||||
return nil
|
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.
|
||||||
@@ -435,22 +472,6 @@ 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.
|
||||||
//
|
//
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
package config //nolint:testpackage // exercises unexported extractAgeSecretKey
|
package config //nolint:testpackage // exercises unexported source constants
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
@@ -298,53 +298,31 @@ func TestValidateAgeRecipients(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestExtractAgeSecretKey tests extraction of AGE-SECRET-KEY from various inputs
|
// TestAgeSecretKeySourceName checks the name reported for the configured
|
||||||
func TestExtractAgeSecretKey(t *testing.T) {
|
// 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()
|
t.Parallel()
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
input string
|
source string
|
||||||
expected string
|
want string
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "plain key",
|
name: "unset defaults to config field",
|
||||||
input: testIntegrationAgePrivateKey,
|
source: "",
|
||||||
expected: testIntegrationAgePrivateKey,
|
want: ageSecretKeySourceConfig,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "key with trailing newline",
|
name: "environment source",
|
||||||
input: testIntegrationAgePrivateKey + "\n",
|
source: ageSecretKeySourceEnv,
|
||||||
expected: testIntegrationAgePrivateKey,
|
want: ageSecretKeySourceEnv,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "full age-keygen output",
|
name: "config-file source",
|
||||||
input: "# created: 2025-01-14T12:00:00Z\n" +
|
source: ageSecretKeySourceConfig,
|
||||||
"# public key: " + testIntegrationAgePublicKey + "\n" +
|
want: ageSecretKeySourceConfig,
|
||||||
testIntegrationAgePrivateKey + "\n",
|
|
||||||
expected: testIntegrationAgePrivateKey,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "age-keygen output with extra blank lines",
|
|
||||||
input: "# created: 2025-01-14T12:00:00Z\n" +
|
|
||||||
"# public key: " + testIntegrationAgePublicKey + "\n\n" +
|
|
||||||
testIntegrationAgePrivateKey + "\n\n",
|
|
||||||
expected: testIntegrationAgePrivateKey,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "key with leading whitespace",
|
|
||||||
input: " " + testIntegrationAgePrivateKey + " ",
|
|
||||||
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",
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -352,10 +330,9 @@ func TestExtractAgeSecretKey(t *testing.T) {
|
|||||||
t.Run(tt.name, func(t *testing.T) {
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
result := extractAgeSecretKey(tt.input)
|
cfg := &Config{AgeSecretKeySource: tt.source}
|
||||||
if result != tt.expected {
|
if got := cfg.AgeSecretKeySourceName(); got != tt.want {
|
||||||
t.Errorf("extractAgeSecretKey(%q) = %q, want %q",
|
t.Errorf("AgeSecretKeySourceName() = %q, want %q", got, tt.want)
|
||||||
tt.input, result, tt.expected)
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,6 +11,18 @@ 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 {
|
||||||
@@ -206,6 +218,48 @@ 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,
|
||||||
|
|||||||
@@ -74,14 +74,15 @@ func (h *hashVerifyReader) Close() error {
|
|||||||
// 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.
|
||||||
func (v *Vaultik) FetchAndDecryptBlob(
|
func (v *Vaultik) FetchAndDecryptBlob(
|
||||||
ctx context.Context, blobHash string, expectedSize int64, identity age.Identity,
|
ctx context.Context, blobHash string, expectedSize int64,
|
||||||
|
identities ...age.Identity,
|
||||||
) (io.ReadCloser, error) {
|
) (io.ReadCloser, error) {
|
||||||
rc, _, err := v.FetchBlob(ctx, blobHash, expectedSize)
|
rc, _, err := v.FetchBlob(ctx, blobHash, expectedSize)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
reader, err := blobgen.NewReader(rc, identity)
|
reader, err := blobgen.NewReader(rc, identities...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = rc.Close()
|
_ = rc.Close()
|
||||||
|
|
||||||
|
|||||||
@@ -54,6 +54,51 @@ func TestBlobCacheRejectsKeyWithSeparator(t *testing.T) {
|
|||||||
"cache wrote outside its directory at %s", target)
|
"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
|
// TestBlobCacheReadAtRejectsBadBounds proves a blob_chunks row cannot
|
||||||
// drive an out-of-range or negative read. offset/length reach ReadAt
|
// drive an out-of-range or negative read. offset/length reach ReadAt
|
||||||
// straight from the database.
|
// straight from the database.
|
||||||
|
|||||||
+93
-22
@@ -19,6 +19,7 @@ import (
|
|||||||
"sneak.berlin/go/vaultik/internal/blobgen"
|
"sneak.berlin/go/vaultik/internal/blobgen"
|
||||||
"sneak.berlin/go/vaultik/internal/database"
|
"sneak.berlin/go/vaultik/internal/database"
|
||||||
"sneak.berlin/go/vaultik/internal/log"
|
"sneak.berlin/go/vaultik/internal/log"
|
||||||
|
"sneak.berlin/go/vaultik/internal/snapshot"
|
||||||
"sneak.berlin/go/vaultik/internal/types"
|
"sneak.berlin/go/vaultik/internal/types"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -29,8 +30,13 @@ var (
|
|||||||
errDecryptionKeyRequired = errors.New(
|
errDecryptionKeyRequired = errors.New(
|
||||||
"decryption key required for restore\n\n" +
|
"decryption key required for restore\n\n" +
|
||||||
"Set the VAULTIK_AGE_SECRET_KEY environment variable to your " +
|
"Set the VAULTIK_AGE_SECRET_KEY environment variable to your " +
|
||||||
"age private key:\n" +
|
"age private key file:\n" +
|
||||||
" export VAULTIK_AGE_SECRET_KEY='AGE-SECRET-KEY-...'")
|
" 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.
|
||||||
|
errInvalidAgeSecretKey = errors.New(
|
||||||
|
"configured age secret key holds no usable age identity")
|
||||||
errBlobMissingFromIndex = errors.New("blob hash missing from blob index")
|
errBlobMissingFromIndex = errors.New("blob hash missing from blob index")
|
||||||
errChunkNotInAnyBlob = errors.New("chunk not found in any blob")
|
errChunkNotInAnyBlob = errors.New("chunk not found in any blob")
|
||||||
errBlobIDNotInHashIndex = errors.New("blob id missing from hash index")
|
errBlobIDNotInHashIndex = errors.New("blob id missing from hash index")
|
||||||
@@ -41,6 +47,8 @@ var (
|
|||||||
"restored file has trailing data after its last chunk")
|
"restored file has trailing data after its last chunk")
|
||||||
errRestoreIncomplete = errors.New(
|
errRestoreIncomplete = errors.New(
|
||||||
"restore loop ended with files still pending")
|
"restore loop ended with files still pending")
|
||||||
|
errSnapshotDBMismatch = errors.New(
|
||||||
|
"decrypted database is not the requested snapshot")
|
||||||
)
|
)
|
||||||
|
|
||||||
// snapshotDBFilename is the name the decrypted snapshot database is
|
// snapshotDBFilename is the name the decrypted snapshot database is
|
||||||
@@ -94,7 +102,7 @@ type RestoreResult struct {
|
|||||||
func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
||||||
startTime := time.Now()
|
startTime := time.Now()
|
||||||
|
|
||||||
identity, err := v.prepareRestoreIdentity()
|
identities, err := v.restoreIdentities()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -108,7 +116,7 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
// Step 1: Download and decrypt the snapshot metadata database
|
// Step 1: Download and decrypt the snapshot metadata database
|
||||||
log.Info("Downloading snapshot metadata...")
|
log.Info("Downloading snapshot metadata...")
|
||||||
|
|
||||||
tempDB, tempDir, err := v.downloadSnapshotDB(opts.SnapshotID, identity)
|
tempDB, tempDir, err := v.downloadSnapshotDB(opts.SnapshotID, identities)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("downloading snapshot database: %w", err)
|
return fmt.Errorf("downloading snapshot database: %w", err)
|
||||||
}
|
}
|
||||||
@@ -157,7 +165,7 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Step 5: Restore files
|
// Step 5: Restore files
|
||||||
result, err := v.restoreAllFiles(files, repos, opts, identity, chunkToBlobMap)
|
result, err := v.restoreAllFiles(files, repos, opts, identities, chunkToBlobMap)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -218,21 +226,28 @@ func (v *Vaultik) finishRestore(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// prepareRestoreIdentity validates that an age secret key is configured
|
// restoreIdentities parses the configured age secret key once into every
|
||||||
// and parses it.
|
// identity it contains. The value may be a single key line or a whole
|
||||||
//
|
// age-keygen file with several identities; all of them are returned so
|
||||||
//nolint:ireturn // age.Identity is the decryption abstraction by design
|
// blobgen (via age.Decrypt) can read a blob encrypted to any of their
|
||||||
func (v *Vaultik) prepareRestoreIdentity() (age.Identity, error) {
|
// recipients. This is the first step of both restore and deep verify, so
|
||||||
|
// a missing or unparseable key fails before anything is downloaded. The
|
||||||
|
// error names the configuration source but never the key value.
|
||||||
|
func (v *Vaultik) restoreIdentities() ([]age.Identity, error) {
|
||||||
if v.Config.AgeSecretKey == "" {
|
if v.Config.AgeSecretKey == "" {
|
||||||
return nil, errDecryptionKeyRequired
|
return nil, errDecryptionKeyRequired
|
||||||
}
|
}
|
||||||
|
|
||||||
identity, err := age.ParseX25519Identity(v.Config.AgeSecretKey)
|
// age.ParseIdentities skips comment and blank lines and rejects a
|
||||||
|
// malformed key. Its error can quote the offending line, so it is not
|
||||||
|
// wrapped here — that would leak the secret into the message.
|
||||||
|
identities, err := age.ParseIdentities(strings.NewReader(v.Config.AgeSecretKey))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("parsing age secret key: %w", err)
|
return nil, fmt.Errorf("%w (source: %s)",
|
||||||
|
errInvalidAgeSecretKey, v.Config.AgeSecretKeySourceName())
|
||||||
}
|
}
|
||||||
|
|
||||||
return identity, nil
|
return identities, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// restoreAllFiles processes files in blob-locality order: drain every
|
// restoreAllFiles processes files in blob-locality order: drain every
|
||||||
@@ -245,7 +260,7 @@ func (v *Vaultik) restoreAllFiles(
|
|||||||
files []*database.File,
|
files []*database.File,
|
||||||
repos *database.Repositories,
|
repos *database.Repositories,
|
||||||
opts *RestoreOptions,
|
opts *RestoreOptions,
|
||||||
identity age.Identity,
|
identities []age.Identity,
|
||||||
chunkToBlobMap map[string]*database.BlobChunk,
|
chunkToBlobMap map[string]*database.BlobChunk,
|
||||||
) (*RestoreResult, error) {
|
) (*RestoreResult, error) {
|
||||||
result := &RestoreResult{}
|
result := &RestoreResult{}
|
||||||
@@ -299,7 +314,7 @@ func (v *Vaultik) restoreAllFiles(
|
|||||||
ctx: v.ctx,
|
ctx: v.ctx,
|
||||||
repos: repos,
|
repos: repos,
|
||||||
opts: opts,
|
opts: opts,
|
||||||
identity: identity,
|
identities: identities,
|
||||||
chunkToBlobMap: chunkToBlobMap,
|
chunkToBlobMap: chunkToBlobMap,
|
||||||
blobByHash: blobByHash,
|
blobByHash: blobByHash,
|
||||||
blobIDToHash: blobIDToHash,
|
blobIDToHash: blobIDToHash,
|
||||||
@@ -410,12 +425,12 @@ func (s *restoreSession) downloadNextBlobSet(plan *restorePlan) (bool, error) {
|
|||||||
|
|
||||||
blob, ok := s.blobByHash[hash]
|
blob, ok := s.blobByHash[hash]
|
||||||
if !ok {
|
if !ok {
|
||||||
return false, fmt.Errorf("%w: %s", errBlobMissingFromIndex, hash[:16])
|
return false, fmt.Errorf("%w: %s", errBlobMissingFromIndex, shortHash(hash))
|
||||||
}
|
}
|
||||||
|
|
||||||
err := s.downloadBlobToCache(hash, blob.CompressedSize)
|
err := s.downloadBlobToCache(hash, blob.CompressedSize)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, fmt.Errorf("downloading blob %s: %w", hash[:16], err)
|
return false, fmt.Errorf("downloading blob %s: %w", shortHash(hash), err)
|
||||||
}
|
}
|
||||||
|
|
||||||
s.result.BlobsDownloaded++
|
s.result.BlobsDownloaded++
|
||||||
@@ -459,6 +474,16 @@ func (v *Vaultik) buildBlobIndexes(
|
|||||||
blobByHash := make(map[string]*database.Blob, len(blobsByID))
|
blobByHash := make(map[string]*database.Blob, len(blobsByID))
|
||||||
for id, blob := range blobsByID {
|
for id, blob := range blobsByID {
|
||||||
hash := blob.Hash.String()
|
hash := blob.Hash.String()
|
||||||
|
|
||||||
|
// The snapshot database is untrusted. A hash that is not 64
|
||||||
|
// lowercase hex characters could steer a later fetch to a path
|
||||||
|
// outside the cache directory, so reject it here, before any
|
||||||
|
// blob is downloaded.
|
||||||
|
if !isBlobHash(hash) {
|
||||||
|
return nil, nil, fmt.Errorf(
|
||||||
|
"%w: %s", errInvalidBlobHash, shortHash(hash))
|
||||||
|
}
|
||||||
|
|
||||||
blobIDToHash[id] = hash
|
blobIDToHash[id] = hash
|
||||||
blobByHash[hash] = blob
|
blobByHash[hash] = blob
|
||||||
}
|
}
|
||||||
@@ -613,7 +638,7 @@ func (v *Vaultik) handleRestoreVerification(
|
|||||||
// for a remote-only snapshot) is used as-is, so a host with no local
|
// for a remote-only snapshot) is used as-is, so a host with no local
|
||||||
// index can restore the snapshots it can only see on the store.
|
// index can restore the snapshots it can only see on the store.
|
||||||
func (v *Vaultik) downloadSnapshotDB(
|
func (v *Vaultik) downloadSnapshotDB(
|
||||||
snapshotID string, identity age.Identity,
|
snapshotID string, identities []age.Identity,
|
||||||
) (*database.DB, string, error) {
|
) (*database.DB, string, error) {
|
||||||
remoteKey, err := v.resolveSnapshotRemoteKey(snapshotID)
|
remoteKey, err := v.resolveSnapshotRemoteKey(snapshotID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -640,7 +665,7 @@ func (v *Vaultik) downloadSnapshotDB(
|
|||||||
"size", ubytes(int64(len(encryptedData))))
|
"size", ubytes(int64(len(encryptedData))))
|
||||||
|
|
||||||
// Decrypt and decompress using blobgen.Reader
|
// Decrypt and decompress using blobgen.Reader
|
||||||
blobReader, err := blobgen.NewReader(bytes.NewReader(encryptedData), identity)
|
blobReader, err := blobgen.NewReader(bytes.NewReader(encryptedData), identities...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, "", fmt.Errorf("creating decryption reader: %w", err)
|
return nil, "", fmt.Errorf("creating decryption reader: %w", err)
|
||||||
}
|
}
|
||||||
@@ -655,7 +680,53 @@ func (v *Vaultik) downloadSnapshotDB(
|
|||||||
|
|
||||||
log.Debug("Decrypted database", "size", ubytes(int64(len(dbData))))
|
log.Debug("Decrypted database", "size", ubytes(int64(len(dbData))))
|
||||||
|
|
||||||
return v.materializeSnapshotDB(dbData)
|
db, tempDir, err := v.materializeSnapshotDB(dbData)
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Confirm the decrypted database really is the snapshot named by
|
||||||
|
// remoteKey before any files are read from it. On mismatch, close the
|
||||||
|
// database and remove its private directory so nothing is left behind.
|
||||||
|
err = v.verifySnapshotDBIdentity(db, snapshotID, remoteKey)
|
||||||
|
if err != nil {
|
||||||
|
_ = db.Close()
|
||||||
|
_ = v.Fs.RemoveAll(tempDir)
|
||||||
|
|
||||||
|
return nil, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return db, tempDir, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// verifySnapshotDBIdentity confirms the decrypted metadata database really
|
||||||
|
// is the snapshot named by remoteKey. age decryption proves the database
|
||||||
|
// is readable, not that the object served at
|
||||||
|
// metadata/<remoteKey>/db.zst.age is the snapshot that was requested: an
|
||||||
|
// attacker who swaps in another valid db.zst.age (which needs no key
|
||||||
|
// material) would otherwise redirect restore and deep verify to a
|
||||||
|
// different snapshot's contents. The exported per-snapshot database holds
|
||||||
|
// exactly one snapshot row, and a snapshot's remote key is derived from
|
||||||
|
// that row's ID, so the database is the requested one exactly when its
|
||||||
|
// sole snapshot hashes back to remoteKey. Comparing the requested
|
||||||
|
// identifier directly would not do: it may be a remote-key prefix a
|
||||||
|
// recovery host uses in place of a human snapshot ID it cannot know.
|
||||||
|
func (v *Vaultik) verifySnapshotDBIdentity(
|
||||||
|
db *database.DB, requested, remoteKey string,
|
||||||
|
) error {
|
||||||
|
repos := database.NewRepositories(db)
|
||||||
|
|
||||||
|
snap, err := repos.Snapshots.GetOnlySnapshot(v.ctx)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("checking identity of database for %s: %w", requested, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if snapshot.RemoteSnapshotKey(snap.ID.String()) != remoteKey {
|
||||||
|
return fmt.Errorf("%w: requested %s but the database is snapshot %s",
|
||||||
|
errSnapshotDBMismatch, requested, snap.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// materializeSnapshotDB writes the decrypted snapshot database bytes into
|
// materializeSnapshotDB writes the decrypted snapshot database bytes into
|
||||||
@@ -784,7 +855,7 @@ type restoreSession struct {
|
|||||||
ctx context.Context //nolint:containedctx // per-restore state by design
|
ctx context.Context //nolint:containedctx // per-restore state by design
|
||||||
repos *database.Repositories
|
repos *database.Repositories
|
||||||
opts *RestoreOptions
|
opts *RestoreOptions
|
||||||
identity age.Identity
|
identities []age.Identity
|
||||||
chunkToBlobMap map[string]*database.BlobChunk
|
chunkToBlobMap map[string]*database.BlobChunk
|
||||||
blobByHash map[string]*database.Blob
|
blobByHash map[string]*database.Blob
|
||||||
blobIDToHash map[string]string
|
blobIDToHash map[string]string
|
||||||
@@ -1146,7 +1217,7 @@ func (s *restoreSession) downloadBlobToCache(
|
|||||||
start := time.Now()
|
start := time.Now()
|
||||||
|
|
||||||
t0 := time.Now()
|
t0 := time.Now()
|
||||||
rc, err := s.v.FetchAndDecryptBlob(s.ctx, blobHash, expectedSize, s.identity)
|
rc, err := s.v.FetchAndDecryptBlob(s.ctx, blobHash, expectedSize, s.identities...)
|
||||||
fetchSetupDur := time.Since(t0)
|
fetchSetupDur := time.Since(t0)
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -0,0 +1,108 @@
|
|||||||
|
package vaultik //nolint:testpackage // exercises unexported restoreIdentities
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"io"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"filippo.io/age"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/vaultik/internal/blobgen"
|
||||||
|
"sneak.berlin/go/vaultik/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// encryptBlobTo returns a blobgen blob of plaintext encrypted to exactly
|
||||||
|
// one recipient, so a decryptor succeeds only if it holds that recipient's
|
||||||
|
// identity.
|
||||||
|
func encryptBlobTo(t *testing.T, recipient string, plaintext []byte) []byte {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
|
||||||
|
writer, err := blobgen.NewWriter(&buf, 1, []string{recipient})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
_, err = writer.Write(plaintext)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, writer.Close())
|
||||||
|
|
||||||
|
return buf.Bytes()
|
||||||
|
}
|
||||||
|
|
||||||
|
// decryptBlobWith reads a blob back through the identities and returns its
|
||||||
|
// plaintext.
|
||||||
|
func decryptBlobWith(t *testing.T, blob []byte, identities []age.Identity) []byte {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
reader, err := blobgen.NewReader(bytes.NewReader(blob), identities...)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
plaintext, err := io.ReadAll(reader)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, reader.Close())
|
||||||
|
|
||||||
|
return plaintext
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRestoreIdentitiesAcceptsEveryIdentity proves a key file holding two
|
||||||
|
// identities yields both, so a blob encrypted only to the second
|
||||||
|
// recipient — the one the previous single-identity parse dropped — still
|
||||||
|
// decrypts.
|
||||||
|
func TestRestoreIdentitiesAcceptsEveryIdentity(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
first, err := age.GenerateX25519Identity()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
second, err := age.GenerateX25519Identity()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// A whole age-keygen-style file: comment lines plus two identity lines.
|
||||||
|
keyFile := "# public key: " + first.Recipient().String() + "\n" +
|
||||||
|
first.String() + "\n" +
|
||||||
|
"# public key: " + second.Recipient().String() + "\n" +
|
||||||
|
second.String() + "\n"
|
||||||
|
|
||||||
|
v := &Vaultik{Config: &config.Config{AgeSecretKey: keyFile}}
|
||||||
|
|
||||||
|
identities, err := v.restoreIdentities()
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Len(t, identities, 2)
|
||||||
|
|
||||||
|
plaintext := []byte("payload encrypted only to the second identity")
|
||||||
|
blob := encryptBlobTo(t, second.Recipient().String(), plaintext)
|
||||||
|
|
||||||
|
require.Equal(t, plaintext, decryptBlobWith(t, blob, identities))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRestoreIdentitiesAcceptsTrailingNewline mirrors a YAML
|
||||||
|
// age_secret_key value that carries a trailing newline: it must still
|
||||||
|
// parse to its one identity and decrypt a blob encrypted to it.
|
||||||
|
func TestRestoreIdentitiesAcceptsTrailingNewline(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
id, err := age.GenerateX25519Identity()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
v := &Vaultik{Config: &config.Config{AgeSecretKey: id.String() + "\n"}}
|
||||||
|
|
||||||
|
identities, err := v.restoreIdentities()
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Len(t, identities, 1)
|
||||||
|
|
||||||
|
plaintext := []byte("value with a trailing newline")
|
||||||
|
blob := encryptBlobTo(t, id.Recipient().String(), plaintext)
|
||||||
|
|
||||||
|
require.Equal(t, plaintext, decryptBlobWith(t, blob, identities))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRestoreIdentitiesMissingKey reports the dedicated missing-key error
|
||||||
|
// rather than a parse failure, so the user is told to set the key.
|
||||||
|
func TestRestoreIdentitiesMissingKey(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
v := &Vaultik{Config: &config.Config{}}
|
||||||
|
|
||||||
|
_, err := v.restoreIdentities()
|
||||||
|
require.ErrorIs(t, err, errDecryptionKeyRequired)
|
||||||
|
}
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
package vaultik_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/vaultik/internal/config"
|
||||||
|
"sneak.berlin/go/vaultik/internal/ui"
|
||||||
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestRestoreRejectsMalformedKeyBeforeDownload verifies that a malformed
|
||||||
|
// age secret key stops restore at the parse step: nothing is fetched from
|
||||||
|
// the store, and the error does not echo the key value (which is secret).
|
||||||
|
func TestRestoreRejectsMalformedKeyBeforeDownload(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const malformed = "this-is-not-a-valid-age-key"
|
||||||
|
|
||||||
|
mock := NewMockStorer()
|
||||||
|
|
||||||
|
v := &vaultik.Vaultik{
|
||||||
|
Config: &config.Config{AgeSecretKey: malformed},
|
||||||
|
Storage: mock,
|
||||||
|
Stdout: io.Discard,
|
||||||
|
Stderr: io.Discard,
|
||||||
|
UI: ui.NewWithColor(io.Discard, false),
|
||||||
|
}
|
||||||
|
v.SetContext(context.Background())
|
||||||
|
|
||||||
|
err := v.Restore(&vaultik.RestoreOptions{
|
||||||
|
SnapshotID: "any-snapshot",
|
||||||
|
TargetDir: t.TempDir(),
|
||||||
|
})
|
||||||
|
require.Error(t, err)
|
||||||
|
require.NotContains(t, err.Error(), malformed,
|
||||||
|
"error must not echo the key value")
|
||||||
|
require.Contains(t, err.Error(), "age_secret_key",
|
||||||
|
"error should name the configuration source")
|
||||||
|
require.Empty(t, mock.GetCalls(),
|
||||||
|
"a malformed key must fail before anything is fetched")
|
||||||
|
}
|
||||||
@@ -0,0 +1,251 @@
|
|||||||
|
package vaultik_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"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/ui"
|
||||||
|
"sneak.berlin/go/vaultik/internal/vaultik"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestRestoreAndDeepVerifyRejectSwappedDatabase proves that swapping two
|
||||||
|
// snapshots' encrypted databases on the store is caught. age decryption
|
||||||
|
// alone proves only that a database is readable; without an identity check
|
||||||
|
// restore would happily write the wrong snapshot's files and deep verify
|
||||||
|
// would report success. After the swap, restore and deep verify of A both
|
||||||
|
// fail, and the error names the snapshot the database actually holds (B).
|
||||||
|
func TestRestoreAndDeepVerifyRejectSwappedDatabase(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
storeDir := filepath.Join(tempDir, "remote")
|
||||||
|
|
||||||
|
chunkSize := int64(64 * 1024)
|
||||||
|
|
||||||
|
storer, err := storage.NewFileStorer(storeDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
// Two snapshots with different content, backed up into one shared
|
||||||
|
// store. Different names give them different remote keys, so their
|
||||||
|
// metadata directories are distinct and can be tampered with alone.
|
||||||
|
dataA := filepath.Join(tempDir, "srcA")
|
||||||
|
require.NoError(t, fs.MkdirAll(dataA, 0o755))
|
||||||
|
require.NoError(t, afero.WriteFile(fs, filepath.Join(dataA, "a.bin"),
|
||||||
|
bytesPattern("alpha-", int(chunkSize*2)), 0o644))
|
||||||
|
|
||||||
|
dataB := filepath.Join(tempDir, "srcB")
|
||||||
|
require.NoError(t, fs.MkdirAll(dataB, 0o755))
|
||||||
|
require.NoError(t, afero.WriteFile(fs, filepath.Join(dataB, "b.bin"),
|
||||||
|
bytesPattern("beta-", int(chunkSize*2)), 0o644))
|
||||||
|
|
||||||
|
idA := backupNamedSnapshotToStore(ctx, t, fs, dataA, storer,
|
||||||
|
filepath.Join(tempDir, "idxA.sqlite"), "alpha")
|
||||||
|
idB := backupNamedSnapshotToStore(ctx, t, fs, dataB, storer,
|
||||||
|
filepath.Join(tempDir, "idxB.sqlite"), "beta")
|
||||||
|
require.NotEqual(t, idA, idB)
|
||||||
|
|
||||||
|
keyA := snapshot.RemoteSnapshotKey(idA)
|
||||||
|
keyB := snapshot.RemoteSnapshotKey(idB)
|
||||||
|
require.NotEqual(t, keyA, keyB)
|
||||||
|
|
||||||
|
// Baseline: each snapshot verifies against its own intact metadata.
|
||||||
|
require.NoError(t, newStoreClient(ctx, t, fs, storer).RunDeepVerify(
|
||||||
|
idA, &vaultik.VerifyOptions{Deep: true}))
|
||||||
|
require.NoError(t, newStoreClient(ctx, t, fs, storer).RunDeepVerify(
|
||||||
|
idB, &vaultik.VerifyOptions{Deep: true}))
|
||||||
|
|
||||||
|
// Swap the two snapshots' encrypted databases on the store.
|
||||||
|
swapStoreFiles(t, fs,
|
||||||
|
filepath.Join(storeDir, "metadata", keyA, "db.zst.age"),
|
||||||
|
filepath.Join(storeDir, "metadata", keyB, "db.zst.age"))
|
||||||
|
|
||||||
|
// Restore of A now decrypts B's database; the identity check must
|
||||||
|
// reject it and name the snapshot it actually found.
|
||||||
|
restoreErr := newStoreClient(ctx, t, fs, storer).Restore(&vaultik.RestoreOptions{
|
||||||
|
SnapshotID: idA,
|
||||||
|
TargetDir: filepath.Join(tempDir, "restoreA"),
|
||||||
|
})
|
||||||
|
require.Error(t, restoreErr)
|
||||||
|
require.ErrorContains(t, restoreErr, idB)
|
||||||
|
|
||||||
|
// Deep verify of A must reject the swapped database for the same reason.
|
||||||
|
verifyErr := newStoreClient(ctx, t, fs, storer).RunDeepVerify(
|
||||||
|
idA, &vaultik.VerifyOptions{Deep: true})
|
||||||
|
require.Error(t, verifyErr)
|
||||||
|
require.ErrorContains(t, verifyErr, idB)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDeepVerifyRejectsSwappedDatabaseWithEmptyManifest covers the case the
|
||||||
|
// issue calls out: swapping in a database whose blob set is empty and
|
||||||
|
// pairing it with an equally empty manifest. The manifest then agrees with
|
||||||
|
// the database, so every blob-level check passes and deep verify used to
|
||||||
|
// report success with zero blobs verified. The identity check rejects it
|
||||||
|
// before any blob check runs.
|
||||||
|
func TestDeepVerifyRejectsSwappedDatabaseWithEmptyManifest(t *testing.T) {
|
||||||
|
log.Initialize(log.Config{})
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
storeDir := filepath.Join(tempDir, "remote")
|
||||||
|
|
||||||
|
chunkSize := int64(64 * 1024)
|
||||||
|
|
||||||
|
storer, err := storage.NewFileStorer(storeDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
// Snapshot A: real content, so its manifest lists blobs.
|
||||||
|
dataA := filepath.Join(tempDir, "srcA")
|
||||||
|
require.NoError(t, fs.MkdirAll(dataA, 0o755))
|
||||||
|
require.NoError(t, afero.WriteFile(fs, filepath.Join(dataA, "a.bin"),
|
||||||
|
bytesPattern("alpha-", int(chunkSize*2)), 0o644))
|
||||||
|
idA := backupNamedSnapshotToStore(ctx, t, fs, dataA, storer,
|
||||||
|
filepath.Join(tempDir, "idxA.sqlite"), "alpha")
|
||||||
|
|
||||||
|
// Snapshot C: a single empty file, so it references no blobs and its
|
||||||
|
// manifest is empty. This is the database/manifest pair an attacker
|
||||||
|
// would swap in to make the blob checks vacuously pass.
|
||||||
|
dataC := filepath.Join(tempDir, "srcC")
|
||||||
|
require.NoError(t, fs.MkdirAll(dataC, 0o755))
|
||||||
|
require.NoError(t, afero.WriteFile(fs,
|
||||||
|
filepath.Join(dataC, "empty.bin"), []byte{}, 0o644))
|
||||||
|
idC := backupNamedSnapshotToStore(ctx, t, fs, dataC, storer,
|
||||||
|
filepath.Join(tempDir, "idxC.sqlite"), "charlie")
|
||||||
|
|
||||||
|
keyA := snapshot.RemoteSnapshotKey(idA)
|
||||||
|
keyC := snapshot.RemoteSnapshotKey(idC)
|
||||||
|
|
||||||
|
// Replace A's database and manifest with C's empty pair.
|
||||||
|
copyStoreFile(t, fs,
|
||||||
|
filepath.Join(storeDir, "metadata", keyC, "db.zst.age"),
|
||||||
|
filepath.Join(storeDir, "metadata", keyA, "db.zst.age"))
|
||||||
|
copyStoreFile(t, fs,
|
||||||
|
filepath.Join(storeDir, "metadata", keyC, "manifest.json.zst"),
|
||||||
|
filepath.Join(storeDir, "metadata", keyA, "manifest.json.zst"))
|
||||||
|
|
||||||
|
verifyErr := newStoreClient(ctx, t, fs, storer).RunDeepVerify(
|
||||||
|
idA, &vaultik.VerifyOptions{Deep: true})
|
||||||
|
require.Error(t, verifyErr)
|
||||||
|
require.ErrorContains(t, verifyErr, idC)
|
||||||
|
}
|
||||||
|
|
||||||
|
// backupNamedSnapshotToStore backs up dataDir into the shared storer under
|
||||||
|
// the given snapshot name and returns the human snapshot ID. Two snapshots
|
||||||
|
// backed up under different names get different remote keys, so their
|
||||||
|
// metadata directories on the store are distinct.
|
||||||
|
func backupNamedSnapshotToStore(
|
||||||
|
ctx context.Context, t *testing.T, fs afero.Fs,
|
||||||
|
dataDir string, storer storage.Storer, dbPath, name string,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
const (
|
||||||
|
chunkSize = int64(64 * 1024)
|
||||||
|
maxBlobSize = int64(512 * 1024)
|
||||||
|
)
|
||||||
|
|
||||||
|
cfg := &config.Config{
|
||||||
|
AgeRecipients: []string{testAgePublicKey},
|
||||||
|
AgeSecretKey: testAgeSecretKey,
|
||||||
|
CompressionLevel: 3,
|
||||||
|
Hostname: testHostname,
|
||||||
|
}
|
||||||
|
|
||||||
|
db, err := database.New(ctx, dbPath)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
repos := database.NewRepositories(db)
|
||||||
|
|
||||||
|
sm := snapshot.NewSnapshotManager(snapshot.SnapshotManagerParams{
|
||||||
|
Repos: repos,
|
||||||
|
Storage: storer,
|
||||||
|
Config: cfg,
|
||||||
|
})
|
||||||
|
sm.SetFilesystem(fs)
|
||||||
|
|
||||||
|
scanner := snapshot.NewScanner(snapshot.ScannerConfig{
|
||||||
|
FS: fs,
|
||||||
|
Storage: storer,
|
||||||
|
ChunkSize: chunkSize,
|
||||||
|
MaxBlobSize: maxBlobSize,
|
||||||
|
CompressionLevel: cfg.CompressionLevel,
|
||||||
|
AgeRecipients: cfg.AgeRecipients,
|
||||||
|
Repositories: repos,
|
||||||
|
})
|
||||||
|
|
||||||
|
snapshotID, err := sm.CreateSnapshotWithName(
|
||||||
|
ctx, cfg.Hostname, name, "test-version", "test-git")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
_, err = scanner.Scan(ctx, dataDir, snapshotID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(t, sm.CompleteSnapshot(ctx, snapshotID))
|
||||||
|
require.NoError(t, sm.ExportSnapshotMetadata(ctx, dbPath, snapshotID))
|
||||||
|
require.NoError(t, db.Close())
|
||||||
|
|
||||||
|
return snapshotID
|
||||||
|
}
|
||||||
|
|
||||||
|
// newStoreClient builds a Vaultik that reads only from the store: the
|
||||||
|
// secret key, the storer, and a filesystem, with no local index. This is
|
||||||
|
// what restore and deep verify need.
|
||||||
|
func newStoreClient(
|
||||||
|
ctx context.Context, t *testing.T, fs afero.Fs, storer storage.Storer,
|
||||||
|
) *vaultik.Vaultik {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
v := &vaultik.Vaultik{
|
||||||
|
Config: &config.Config{
|
||||||
|
AgeSecretKey: testAgeSecretKey,
|
||||||
|
Hostname: testHostname,
|
||||||
|
},
|
||||||
|
Storage: storer,
|
||||||
|
Fs: fs,
|
||||||
|
Stdout: io.Discard,
|
||||||
|
Stderr: io.Discard,
|
||||||
|
UI: ui.NewWithColor(io.Discard, false),
|
||||||
|
}
|
||||||
|
v.SetContext(ctx)
|
||||||
|
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// swapStoreFiles exchanges the contents of two files on the store.
|
||||||
|
func swapStoreFiles(t *testing.T, fs afero.Fs, a, b string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
dataA, err := afero.ReadFile(fs, a)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
dataB, err := afero.ReadFile(fs, b)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(t, afero.WriteFile(fs, a, dataB, 0o644))
|
||||||
|
require.NoError(t, afero.WriteFile(fs, b, dataA, 0o644))
|
||||||
|
}
|
||||||
|
|
||||||
|
// copyStoreFile overwrites dst with the contents of src on the store.
|
||||||
|
func copyStoreFile(t *testing.T, fs afero.Fs, src, dst string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
data, err := afero.ReadFile(fs, src)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.NoError(t, afero.WriteFile(fs, dst, data, 0o644))
|
||||||
|
}
|
||||||
+56
-32
@@ -95,11 +95,10 @@ func (v *Vaultik) RunDeepVerify(snapshotID string, opts *VerifyOptions) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Parse the age secret key once, the same way restore does, and reuse
|
// Parse the age secret key once, the same way restore does, and reuse
|
||||||
// the identity for the database and every blob.
|
// the identities for the database and every blob.
|
||||||
identity, err := v.prepareRestoreIdentity()
|
identities, err := v.restoreIdentities()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return v.deepVerifyFailure(result, opts,
|
return v.deepVerifyFailure(result, opts, err.Error(), err)
|
||||||
fmt.Sprintf("parsing age secret key: %v", err), err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("Starting snapshot verification", "snapshot_id", snapshotID, "mode", "deep")
|
log.Info("Starting snapshot verification", "snapshot_id", snapshotID, "mode", "deep")
|
||||||
@@ -109,7 +108,7 @@ func (v *Vaultik) RunDeepVerify(snapshotID string, opts *VerifyOptions) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
manifest, tempDB, dbBlobs, err := v.loadVerificationData(
|
manifest, tempDB, dbBlobs, err := v.loadVerificationData(
|
||||||
snapshotID, opts, result, identity)
|
snapshotID, opts, result, identities)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -130,7 +129,7 @@ func (v *Vaultik) RunDeepVerify(snapshotID string, opts *VerifyOptions) error {
|
|||||||
result.TotalSize = totalSize
|
result.TotalSize = totalSize
|
||||||
|
|
||||||
err = v.runVerificationSteps(
|
err = v.runVerificationSteps(
|
||||||
manifest, dbBlobs, tempDB, opts, result, totalSize, identity)
|
manifest, dbBlobs, tempDB, opts, result, totalSize, identities)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -155,7 +154,7 @@ func (v *Vaultik) RunDeepVerify(snapshotID string, opts *VerifyOptions) error {
|
|||||||
// loadVerificationData downloads manifest, database, and blob list for verification
|
// loadVerificationData downloads manifest, database, and blob list for verification
|
||||||
func (v *Vaultik) loadVerificationData(
|
func (v *Vaultik) loadVerificationData(
|
||||||
snapshotID string, opts *VerifyOptions, result *VerifyResult,
|
snapshotID string, opts *VerifyOptions, result *VerifyResult,
|
||||||
identity age.Identity,
|
identities []age.Identity,
|
||||||
) (*snapshot.Manifest, *tempDB, []snapshot.BlobInfo, error) {
|
) (*snapshot.Manifest, *tempDB, []snapshot.BlobInfo, error) {
|
||||||
// Resolve the identifier to the snapshot's remote key. A human ID is
|
// Resolve the identifier to the snapshot's remote key. A human ID is
|
||||||
// hashed; a remote key (or its abbreviation, as printed for a
|
// hashed; a remote key (or its abbreviation, as printed for a
|
||||||
@@ -192,24 +191,10 @@ func (v *Vaultik) loadVerificationData(
|
|||||||
v.stdoutf("Downloading and decrypting database...\n")
|
v.stdoutf("Downloading and decrypting database...\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Download and decrypt database
|
tdb, err := v.downloadVerifiedSnapshotDB(
|
||||||
dbPath := fmt.Sprintf("metadata/%s/db.zst.age", remoteKey)
|
snapshotID, remoteKey, opts, result, identities)
|
||||||
log.Info("Downloading encrypted database", "path", dbPath)
|
|
||||||
|
|
||||||
dbReader, err := v.Storage.Get(v.ctx, dbPath)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, nil, nil, v.deepVerifyFailure(result, opts,
|
return nil, nil, nil, err
|
||||||
fmt.Sprintf("failed to download database: %v", err),
|
|
||||||
fmt.Errorf("failed to download database: %w", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
defer func() { _ = dbReader.Close() }()
|
|
||||||
|
|
||||||
tdb, err := v.decryptAndLoadDatabase(dbReader, identity)
|
|
||||||
if err != nil {
|
|
||||||
return nil, nil, nil, v.deepVerifyFailure(result, opts,
|
|
||||||
fmt.Sprintf("failed to decrypt database: %v", err),
|
|
||||||
fmt.Errorf("failed to decrypt database: %w", err))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
dbBlobs, err := v.getBlobsFromDatabase(tdb.db.Conn())
|
dbBlobs, err := v.getBlobsFromDatabase(tdb.db.Conn())
|
||||||
@@ -238,6 +223,45 @@ func (v *Vaultik) loadVerificationData(
|
|||||||
return manifest, tdb, dbBlobs, nil
|
return manifest, tdb, dbBlobs, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// downloadVerifiedSnapshotDB downloads and decrypts the snapshot metadata
|
||||||
|
// database and confirms it really is the snapshot named by remoteKey
|
||||||
|
// before any of its rows are trusted (see verifySnapshotDBIdentity). On
|
||||||
|
// any failure it records the failure in result and returns the error the
|
||||||
|
// caller should propagate; the temp database is closed on a rejected
|
||||||
|
// identity so nothing is left on disk.
|
||||||
|
func (v *Vaultik) downloadVerifiedSnapshotDB(
|
||||||
|
snapshotID, remoteKey string, opts *VerifyOptions, result *VerifyResult,
|
||||||
|
identities []age.Identity,
|
||||||
|
) (*tempDB, error) {
|
||||||
|
dbPath := fmt.Sprintf("metadata/%s/db.zst.age", remoteKey)
|
||||||
|
log.Info("Downloading encrypted database", "path", dbPath)
|
||||||
|
|
||||||
|
dbReader, err := v.Storage.Get(v.ctx, dbPath)
|
||||||
|
if err != nil {
|
||||||
|
return nil, v.deepVerifyFailure(result, opts,
|
||||||
|
fmt.Sprintf("failed to download database: %v", err),
|
||||||
|
fmt.Errorf("failed to download database: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = dbReader.Close() }()
|
||||||
|
|
||||||
|
tdb, err := v.decryptAndLoadDatabase(dbReader, identities)
|
||||||
|
if err != nil {
|
||||||
|
return nil, v.deepVerifyFailure(result, opts,
|
||||||
|
fmt.Sprintf("failed to decrypt database: %v", err),
|
||||||
|
fmt.Errorf("failed to decrypt database: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
err = v.verifySnapshotDBIdentity(tdb.db, snapshotID, remoteKey)
|
||||||
|
if err != nil {
|
||||||
|
_ = tdb.Close()
|
||||||
|
|
||||||
|
return nil, v.deepVerifyFailure(result, opts, err.Error(), err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return tdb, nil
|
||||||
|
}
|
||||||
|
|
||||||
// runVerificationSteps executes manifest verification, blob existence
|
// runVerificationSteps executes manifest verification, blob existence
|
||||||
// check, and deep content verification.
|
// check, and deep content verification.
|
||||||
func (v *Vaultik) runVerificationSteps(
|
func (v *Vaultik) runVerificationSteps(
|
||||||
@@ -247,7 +271,7 @@ func (v *Vaultik) runVerificationSteps(
|
|||||||
opts *VerifyOptions,
|
opts *VerifyOptions,
|
||||||
result *VerifyResult,
|
result *VerifyResult,
|
||||||
totalSize int64,
|
totalSize int64,
|
||||||
identity age.Identity,
|
identities []age.Identity,
|
||||||
) error {
|
) error {
|
||||||
if !opts.JSON {
|
if !opts.JSON {
|
||||||
v.stdoutf("Verifying manifest against database...\n")
|
v.stdoutf("Verifying manifest against database...\n")
|
||||||
@@ -274,7 +298,7 @@ func (v *Vaultik) runVerificationSteps(
|
|||||||
len(dbBlobs), ubytes(totalSize))
|
len(dbBlobs), ubytes(totalSize))
|
||||||
}
|
}
|
||||||
|
|
||||||
err = v.performDeepVerificationFromDB(dbBlobs, tdb.db.Conn(), opts, identity)
|
err = v.performDeepVerificationFromDB(dbBlobs, tdb.db.Conn(), opts, identities)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return v.deepVerifyFailure(result, opts, err.Error(), err)
|
return v.deepVerifyFailure(result, opts, err.Error(), err)
|
||||||
}
|
}
|
||||||
@@ -302,10 +326,10 @@ func (t *tempDB) Close() error {
|
|||||||
// from the encrypted stream. It reads through the same blobgen reader restore
|
// from the encrypted stream. It reads through the same blobgen reader restore
|
||||||
// uses, streaming the decrypted, decompressed database to a temp file.
|
// uses, streaming the decrypted, decompressed database to a temp file.
|
||||||
func (v *Vaultik) decryptAndLoadDatabase(
|
func (v *Vaultik) decryptAndLoadDatabase(
|
||||||
reader io.ReadCloser, identity age.Identity,
|
reader io.ReadCloser, identities []age.Identity,
|
||||||
) (*tempDB, error) {
|
) (*tempDB, error) {
|
||||||
// Decrypt and decompress through the shared blobgen reader.
|
// Decrypt and decompress through the shared blobgen reader.
|
||||||
blobReader, err := blobgen.NewReader(reader, identity)
|
blobReader, err := blobgen.NewReader(reader, identities...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to create decryption reader: %w", err)
|
return nil, fmt.Errorf("failed to create decryption reader: %w", err)
|
||||||
}
|
}
|
||||||
@@ -366,7 +390,7 @@ func (v *Vaultik) decryptAndLoadDatabase(
|
|||||||
|
|
||||||
// verifyBlob downloads and verifies a single blob
|
// verifyBlob downloads and verifies a single blob
|
||||||
func (v *Vaultik) verifyBlob(
|
func (v *Vaultik) verifyBlob(
|
||||||
blobInfo snapshot.BlobInfo, db *sql.DB, identity age.Identity,
|
blobInfo snapshot.BlobInfo, db *sql.DB, identities []age.Identity,
|
||||||
) error {
|
) error {
|
||||||
// Download blob using shared fetch method
|
// Download blob using shared fetch method
|
||||||
reader, _, err := v.FetchBlob(v.ctx, blobInfo.Hash, blobInfo.CompressedSize)
|
reader, _, err := v.FetchBlob(v.ctx, blobInfo.Hash, blobInfo.CompressedSize)
|
||||||
@@ -380,7 +404,7 @@ func (v *Vaultik) verifyBlob(
|
|||||||
// the plaintext as it is read. A blob's hash — its remote name — is the
|
// the plaintext as it is read. A blob's hash — its remote name — is the
|
||||||
// double SHA-256 of that plaintext (see blobgen.DoubleSHA256), not of the
|
// double SHA-256 of that plaintext (see blobgen.DoubleSHA256), not of the
|
||||||
// encrypted bytes.
|
// encrypted bytes.
|
||||||
blobReader, err := blobgen.NewReader(reader, identity)
|
blobReader, err := blobgen.NewReader(reader, identities...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to create blob reader: %w", err)
|
return fmt.Errorf("failed to create blob reader: %w", err)
|
||||||
}
|
}
|
||||||
@@ -673,7 +697,7 @@ func (v *Vaultik) verifyBlobExistenceFromDB(blobs []snapshot.BlobInfo) error {
|
|||||||
// each blob using the database as source.
|
// each blob using the database as source.
|
||||||
func (v *Vaultik) performDeepVerificationFromDB(
|
func (v *Vaultik) performDeepVerificationFromDB(
|
||||||
blobs []snapshot.BlobInfo, db *sql.DB, opts *VerifyOptions,
|
blobs []snapshot.BlobInfo, db *sql.DB, opts *VerifyOptions,
|
||||||
identity age.Identity,
|
identities []age.Identity,
|
||||||
) error {
|
) error {
|
||||||
// Calculate total bytes for ETA
|
// Calculate total bytes for ETA
|
||||||
var totalBytesExpected int64
|
var totalBytesExpected int64
|
||||||
@@ -691,7 +715,7 @@ func (v *Vaultik) performDeepVerificationFromDB(
|
|||||||
|
|
||||||
for i, blobInfo := range blobs {
|
for i, blobInfo := range blobs {
|
||||||
// Verify individual blob
|
// Verify individual blob
|
||||||
err := v.verifyBlob(blobInfo, db, identity)
|
err := v.verifyBlob(blobInfo, db, identities)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("blob %s verification failed: %w", blobInfo.Hash, err)
|
return fmt.Errorf("blob %s verification failed: %w", blobInfo.Hash, err)
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user