Compare commits
3 Commits
22efd90f8c
...
fix/ctime-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
25860c03a9 | ||
| c24e7e6360 | |||
| 7a5943958d |
8
.dockerignore
Normal file
8
.dockerignore
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
.git
|
||||||
|
.gitea
|
||||||
|
*.md
|
||||||
|
LICENSE
|
||||||
|
vaultik
|
||||||
|
coverage.out
|
||||||
|
coverage.html
|
||||||
|
.DS_Store
|
||||||
14
.gitea/workflows/check.yml
Normal file
14
.gitea/workflows/check.yml
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
name: check
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
jobs:
|
||||||
|
check:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
# actions/checkout v4, 2024-09-16
|
||||||
|
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5
|
||||||
|
- name: Build and check
|
||||||
|
run: docker build .
|
||||||
61
Dockerfile
Normal file
61
Dockerfile
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
# Lint stage
|
||||||
|
# golangci/golangci-lint:v2.11.3-alpine, 2026-03-17
|
||||||
|
FROM golangci/golangci-lint:v2.11.3-alpine@sha256:b1c3de5862ad0a95b4e45a993b0f00415835d687e4f12c845c7493b86c13414e AS lint
|
||||||
|
|
||||||
|
RUN apk add --no-cache make build-base
|
||||||
|
|
||||||
|
WORKDIR /src
|
||||||
|
|
||||||
|
# Copy go mod files first for better layer caching
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
|
||||||
|
# Copy source code
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Run formatting check and linter
|
||||||
|
RUN make fmt-check
|
||||||
|
RUN make lint
|
||||||
|
|
||||||
|
# Build stage
|
||||||
|
# golang:1.26.1-alpine, 2026-03-17
|
||||||
|
FROM golang:1.26.1-alpine@sha256:2389ebfa5b7f43eeafbd6be0c3700cc46690ef842ad962f6c5bd6be49ed82039 AS builder
|
||||||
|
|
||||||
|
# Depend on lint stage passing
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
|
||||||
|
ARG VERSION=dev
|
||||||
|
|
||||||
|
# Install build dependencies for CGO (mattn/go-sqlite3) and sqlite3 CLI (tests)
|
||||||
|
RUN apk add --no-cache make build-base sqlite
|
||||||
|
|
||||||
|
WORKDIR /src
|
||||||
|
|
||||||
|
# Copy go mod files first for better layer caching
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
|
||||||
|
# Copy source code
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Run tests
|
||||||
|
RUN make test
|
||||||
|
|
||||||
|
# Build with CGO enabled (required for mattn/go-sqlite3)
|
||||||
|
RUN CGO_ENABLED=1 go build -ldflags "-X 'git.eeqj.de/sneak/vaultik/internal/globals.Version=${VERSION}' -X 'git.eeqj.de/sneak/vaultik/internal/globals.Commit=$(git rev-parse HEAD 2>/dev/null || echo unknown)'" -o /vaultik ./cmd/vaultik
|
||||||
|
|
||||||
|
# Runtime stage
|
||||||
|
# alpine:3.21, 2026-02-25
|
||||||
|
FROM alpine:3.21@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
||||||
|
|
||||||
|
RUN apk add --no-cache ca-certificates sqlite
|
||||||
|
|
||||||
|
# Copy binary from builder
|
||||||
|
COPY --from=builder /vaultik /usr/local/bin/vaultik
|
||||||
|
|
||||||
|
# Create non-root user
|
||||||
|
RUN adduser -D -H -s /sbin/nologin vaultik
|
||||||
|
|
||||||
|
USER vaultik
|
||||||
|
|
||||||
|
ENTRYPOINT ["/usr/local/bin/vaultik"]
|
||||||
40
Makefile
40
Makefile
@@ -1,4 +1,4 @@
|
|||||||
.PHONY: test fmt lint build clean all
|
.PHONY: test fmt lint fmt-check check build clean all docker hooks
|
||||||
|
|
||||||
# Version number
|
# Version number
|
||||||
VERSION := 0.0.1
|
VERSION := 0.0.1
|
||||||
@@ -14,21 +14,12 @@ LDFLAGS := -X 'git.eeqj.de/sneak/vaultik/internal/globals.Version=$(VERSION)' \
|
|||||||
all: vaultik
|
all: vaultik
|
||||||
|
|
||||||
# Run tests
|
# Run tests
|
||||||
test: lint fmt-check
|
test:
|
||||||
@echo "Running tests..."
|
go test -race -timeout 30s ./...
|
||||||
@if ! go test -v -timeout 10s ./... 2>&1; then \
|
|
||||||
echo ""; \
|
|
||||||
echo "TEST FAILURES DETECTED"; \
|
|
||||||
echo "Run 'go test -v ./internal/database' to see database test details"; \
|
|
||||||
exit 1; \
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check if code is formatted
|
# Check if code is formatted (read-only)
|
||||||
fmt-check:
|
fmt-check:
|
||||||
@if [ -n "$$(go fmt ./...)" ]; then \
|
@test -z "$$(gofmt -l .)" || (echo "Files not formatted:" && gofmt -l . && exit 1)
|
||||||
echo "Error: Code is not formatted. Run 'make fmt' to fix."; \
|
|
||||||
exit 1; \
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Format code
|
# Format code
|
||||||
fmt:
|
fmt:
|
||||||
@@ -36,7 +27,7 @@ fmt:
|
|||||||
|
|
||||||
# Run linter
|
# Run linter
|
||||||
lint:
|
lint:
|
||||||
golangci-lint run
|
golangci-lint run ./...
|
||||||
|
|
||||||
# Build binary
|
# Build binary
|
||||||
vaultik: internal/*/*.go cmd/vaultik/*.go
|
vaultik: internal/*/*.go cmd/vaultik/*.go
|
||||||
@@ -47,11 +38,6 @@ clean:
|
|||||||
rm -f vaultik
|
rm -f vaultik
|
||||||
go clean
|
go clean
|
||||||
|
|
||||||
# Install dependencies
|
|
||||||
deps:
|
|
||||||
go mod download
|
|
||||||
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
|
|
||||||
|
|
||||||
# Run tests with coverage
|
# Run tests with coverage
|
||||||
test-coverage:
|
test-coverage:
|
||||||
go test -v -coverprofile=coverage.out ./...
|
go test -v -coverprofile=coverage.out ./...
|
||||||
@@ -67,3 +53,17 @@ local:
|
|||||||
|
|
||||||
install: vaultik
|
install: vaultik
|
||||||
cp ./vaultik $(HOME)/bin/
|
cp ./vaultik $(HOME)/bin/
|
||||||
|
|
||||||
|
# Run all checks (formatting, linting, tests) without modifying files
|
||||||
|
check: fmt-check lint test
|
||||||
|
|
||||||
|
# Build Docker image
|
||||||
|
docker:
|
||||||
|
docker build -t vaultik .
|
||||||
|
|
||||||
|
# Install pre-commit hook
|
||||||
|
hooks:
|
||||||
|
@printf '#!/bin/sh\nset -e\n' > .git/hooks/pre-commit
|
||||||
|
@printf 'go mod tidy\ngo fmt ./...\ngit diff --exit-code -- go.mod go.sum || { echo "go mod tidy changed files; please stage and retry"; exit 1; }\n' >> .git/hooks/pre-commit
|
||||||
|
@printf 'make check\n' >> .git/hooks/pre-commit
|
||||||
|
@chmod +x .git/hooks/pre-commit
|
||||||
|
|||||||
28
README.md
28
README.md
@@ -194,8 +194,9 @@ vaultik [--config <path>] store info
|
|||||||
* Requires `VAULTIK_AGE_SECRET_KEY` environment variable with age private key
|
* Requires `VAULTIK_AGE_SECRET_KEY` environment variable with age private key
|
||||||
* Optional path arguments to restore specific files/directories (default: all)
|
* Optional path arguments to restore specific files/directories (default: all)
|
||||||
* Downloads and decrypts metadata, fetches required blobs, reconstructs files
|
* Downloads and decrypts metadata, fetches required blobs, reconstructs files
|
||||||
* Preserves file permissions, timestamps, and ownership (ownership requires root)
|
* Preserves file permissions, mtime, and ownership (ownership requires root)
|
||||||
* Handles symlinks and directories
|
* Handles symlinks and directories
|
||||||
|
* Note: ctime cannot be restored (see [platform notes](#platform-specific-ctime-semantics))
|
||||||
|
|
||||||
**prune**: Remove unreferenced blobs from remote storage
|
**prune**: Remove unreferenced blobs from remote storage
|
||||||
* Scans all snapshots for referenced blobs
|
* Scans all snapshots for referenced blobs
|
||||||
@@ -247,11 +248,14 @@ Snapshot IDs follow the format `<hostname>_<snapshot-name>_<timestamp>` (e.g., `
|
|||||||
CREATE TABLE files (
|
CREATE TABLE files (
|
||||||
id TEXT PRIMARY KEY,
|
id TEXT PRIMARY KEY,
|
||||||
path TEXT NOT NULL UNIQUE,
|
path TEXT NOT NULL UNIQUE,
|
||||||
|
source_path TEXT NOT NULL DEFAULT '',
|
||||||
mtime INTEGER NOT NULL,
|
mtime INTEGER NOT NULL,
|
||||||
|
ctime INTEGER NOT NULL,
|
||||||
size INTEGER NOT NULL,
|
size INTEGER NOT NULL,
|
||||||
mode INTEGER NOT NULL,
|
mode INTEGER NOT NULL,
|
||||||
uid INTEGER NOT NULL,
|
uid INTEGER NOT NULL,
|
||||||
gid INTEGER NOT NULL
|
gid INTEGER NOT NULL,
|
||||||
|
link_target TEXT
|
||||||
);
|
);
|
||||||
|
|
||||||
CREATE TABLE file_chunks (
|
CREATE TABLE file_chunks (
|
||||||
@@ -339,7 +343,25 @@ CREATE TABLE snapshot_blobs (
|
|||||||
1. For each file, get ordered chunk list from file_chunks
|
1. For each file, get ordered chunk list from file_chunks
|
||||||
1. Download required blobs, decrypt, decompress
|
1. Download required blobs, decrypt, decompress
|
||||||
1. Extract chunks and reconstruct files
|
1. Extract chunks and reconstruct files
|
||||||
1. Restore permissions, mtime, uid/gid
|
1. Restore permissions, mtime, uid/gid (ctime cannot be restored — see platform notes above)
|
||||||
|
|
||||||
|
### platform-specific ctime semantics
|
||||||
|
|
||||||
|
The `ctime` field in the files table stores a platform-dependent timestamp:
|
||||||
|
|
||||||
|
* **macOS (Darwin)**: `ctime` is the file's **birth time** — when the file was
|
||||||
|
first created on disk. This value never changes after file creation, even if
|
||||||
|
the file's content or metadata is modified.
|
||||||
|
|
||||||
|
* **Linux**: `ctime` is the **inode change time** — the last time the file's
|
||||||
|
metadata (permissions, ownership, link count, etc.) was modified. This is NOT
|
||||||
|
the file creation time. Linux did not expose birth time (via `statx(2)`) until
|
||||||
|
kernel 4.11, and Go's `syscall` package does not yet surface it.
|
||||||
|
|
||||||
|
**Restore limitation**: `ctime` cannot be restored on either platform. On Linux,
|
||||||
|
the kernel manages the inode change time and userspace cannot set it. On macOS,
|
||||||
|
there is no standard POSIX API to set birth time. The `ctime` value is preserved
|
||||||
|
in the snapshot database for informational/forensic purposes only.
|
||||||
|
|
||||||
#### prune
|
#### prune
|
||||||
|
|
||||||
|
|||||||
2
go.mod
2
go.mod
@@ -1,6 +1,6 @@
|
|||||||
module git.eeqj.de/sneak/vaultik
|
module git.eeqj.de/sneak/vaultik
|
||||||
|
|
||||||
go 1.24.4
|
go 1.26.1
|
||||||
|
|
||||||
require (
|
require (
|
||||||
filippo.io/age v1.2.1
|
filippo.io/age v1.2.1
|
||||||
|
|||||||
@@ -16,8 +16,8 @@ type File struct {
|
|||||||
ID types.FileID // UUID primary key
|
ID types.FileID // UUID primary key
|
||||||
Path types.FilePath // Absolute path of the file
|
Path types.FilePath // Absolute path of the file
|
||||||
SourcePath types.SourcePath // The source directory this file came from (for restore path stripping)
|
SourcePath types.SourcePath // The source directory this file came from (for restore path stripping)
|
||||||
MTime time.Time
|
MTime time.Time // Last modification time
|
||||||
CTime time.Time
|
CTime time.Time // Creation/change time (platform-specific: birth time on macOS, inode change time on Linux)
|
||||||
Size int64
|
Size int64
|
||||||
Mode uint32
|
Mode uint32
|
||||||
UID uint32
|
UID uint32
|
||||||
|
|||||||
@@ -345,7 +345,7 @@ func (b *BackupEngine) Backup(ctx context.Context, fsys fs.FS, root string) (str
|
|||||||
Size: info.Size(),
|
Size: info.Size(),
|
||||||
Mode: uint32(info.Mode()),
|
Mode: uint32(info.Mode()),
|
||||||
MTime: info.ModTime(),
|
MTime: info.ModTime(),
|
||||||
CTime: info.ModTime(), // Use mtime as ctime for test
|
CTime: fileCTime(info), // platform-specific: birth time on macOS, inode change time on Linux
|
||||||
UID: 1000, // Default UID for test
|
UID: 1000, // Default UID for test
|
||||||
GID: 1000, // Default GID for test
|
GID: 1000, // Default GID for test
|
||||||
}
|
}
|
||||||
|
|||||||
26
internal/snapshot/ctime_darwin.go
Normal file
26
internal/snapshot/ctime_darwin.go
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
package snapshot
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fileCTime returns the file creation time (birth time) on macOS.
|
||||||
|
//
|
||||||
|
// On macOS/Darwin, "ctime" refers to the file's birth time (when the file
|
||||||
|
// was first created on disk). This is stored in the Birthtimespec field of
|
||||||
|
// the syscall.Stat_t structure.
|
||||||
|
//
|
||||||
|
// This differs from Linux where "ctime" means inode change time (the last
|
||||||
|
// time file metadata was modified). See ctime_linux.go for details.
|
||||||
|
//
|
||||||
|
// If the underlying stat information is unavailable (e.g. when using a
|
||||||
|
// virtual filesystem like afero.MemMapFs), this falls back to mtime.
|
||||||
|
func fileCTime(info os.FileInfo) time.Time {
|
||||||
|
stat, ok := info.Sys().(*syscall.Stat_t)
|
||||||
|
if !ok {
|
||||||
|
return info.ModTime()
|
||||||
|
}
|
||||||
|
return time.Unix(stat.Birthtimespec.Sec, stat.Birthtimespec.Nsec).UTC()
|
||||||
|
}
|
||||||
28
internal/snapshot/ctime_linux.go
Normal file
28
internal/snapshot/ctime_linux.go
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
package snapshot
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fileCTime returns the inode change time on Linux.
|
||||||
|
//
|
||||||
|
// On Linux, "ctime" refers to the inode change time — the last time the
|
||||||
|
// file's metadata (permissions, ownership, link count, etc.) was modified.
|
||||||
|
// This is NOT the file creation time; Linux did not expose birth time until
|
||||||
|
// the statx(2) syscall was added in kernel 4.11, and Go's syscall package
|
||||||
|
// does not yet surface it.
|
||||||
|
//
|
||||||
|
// This differs from macOS/Darwin where "ctime" means birth time (file
|
||||||
|
// creation time). See ctime_darwin.go for details.
|
||||||
|
//
|
||||||
|
// If the underlying stat information is unavailable (e.g. when using a
|
||||||
|
// virtual filesystem like afero.MemMapFs), this falls back to mtime.
|
||||||
|
func fileCTime(info os.FileInfo) time.Time {
|
||||||
|
stat, ok := info.Sys().(*syscall.Stat_t)
|
||||||
|
if !ok {
|
||||||
|
return info.ModTime()
|
||||||
|
}
|
||||||
|
return time.Unix(stat.Ctim.Sec, stat.Ctim.Nsec).UTC()
|
||||||
|
}
|
||||||
133
internal/snapshot/ctime_test.go
Normal file
133
internal/snapshot/ctime_test.go
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
package snapshot
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFileCTime_RealFile(t *testing.T) {
|
||||||
|
// Create a temporary file
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "testfile.txt")
|
||||||
|
|
||||||
|
if err := os.WriteFile(path, []byte("hello"), 0644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
info, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
ctime := fileCTime(info)
|
||||||
|
|
||||||
|
// ctime should be a valid time (not zero)
|
||||||
|
if ctime.IsZero() {
|
||||||
|
t.Fatal("fileCTime returned zero time")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ctime should be close to now (within a few seconds)
|
||||||
|
diff := time.Since(ctime)
|
||||||
|
if diff < 0 || diff > 5*time.Second {
|
||||||
|
t.Fatalf("fileCTime returned unexpected time: %v (diff from now: %v)", ctime, diff)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ctime should not equal mtime exactly in all cases, but for a freshly
|
||||||
|
// created file they should be very close
|
||||||
|
mtime := info.ModTime()
|
||||||
|
ctimeMtimeDiff := ctime.Sub(mtime)
|
||||||
|
if ctimeMtimeDiff < 0 {
|
||||||
|
ctimeMtimeDiff = -ctimeMtimeDiff
|
||||||
|
}
|
||||||
|
// For a freshly created file, ctime and mtime should be within 1 second
|
||||||
|
if ctimeMtimeDiff > time.Second {
|
||||||
|
t.Fatalf("ctime and mtime differ by too much for a new file: ctime=%v, mtime=%v, diff=%v",
|
||||||
|
ctime, mtime, ctimeMtimeDiff)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFileCTime_AfterMtimeChange(t *testing.T) {
|
||||||
|
// Create a temporary file
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "testfile.txt")
|
||||||
|
|
||||||
|
if err := os.WriteFile(path, []byte("hello"), 0644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get initial ctime
|
||||||
|
info1, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctime1 := fileCTime(info1)
|
||||||
|
|
||||||
|
// Change mtime to a time in the past
|
||||||
|
pastTime := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC)
|
||||||
|
if err := os.Chtimes(path, pastTime, pastTime); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get new stats
|
||||||
|
info2, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctime2 := fileCTime(info2)
|
||||||
|
mtime2 := info2.ModTime()
|
||||||
|
|
||||||
|
// mtime should now be in the past
|
||||||
|
if mtime2.Year() != 2020 {
|
||||||
|
t.Fatalf("mtime not set correctly: %v", mtime2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// On macOS: ctime (birth time) should remain unchanged since birth time
|
||||||
|
// doesn't change when mtime is updated.
|
||||||
|
// On Linux: ctime (inode change time) will be updated to ~now because
|
||||||
|
// changing mtime is a metadata change.
|
||||||
|
// Either way, ctime should NOT equal the past mtime we just set.
|
||||||
|
if ctime2.Equal(pastTime) {
|
||||||
|
t.Fatal("ctime should not equal the artificially set past mtime")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ctime should still be a recent time (the original creation time or
|
||||||
|
// the metadata change time, depending on platform)
|
||||||
|
_ = ctime1 // used for reference; both platforms will have a recent ctime2
|
||||||
|
if time.Since(ctime2) > 10*time.Second {
|
||||||
|
t.Fatalf("ctime is unexpectedly old: %v", ctime2)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestFileCTime_NonSyscallFileInfo verifies the fallback to mtime when
|
||||||
|
// the FileInfo doesn't have a *syscall.Stat_t (e.g. afero.MemMapFs).
|
||||||
|
type mockFileInfo struct {
|
||||||
|
name string
|
||||||
|
size int64
|
||||||
|
mode os.FileMode
|
||||||
|
modTime time.Time
|
||||||
|
isDir bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *mockFileInfo) Name() string { return m.name }
|
||||||
|
func (m *mockFileInfo) Size() int64 { return m.size }
|
||||||
|
func (m *mockFileInfo) Mode() os.FileMode { return m.mode }
|
||||||
|
func (m *mockFileInfo) ModTime() time.Time { return m.modTime }
|
||||||
|
func (m *mockFileInfo) IsDir() bool { return m.isDir }
|
||||||
|
func (m *mockFileInfo) Sys() interface{} { return nil } // No syscall.Stat_t
|
||||||
|
|
||||||
|
func TestFileCTime_FallbackToMtime(t *testing.T) {
|
||||||
|
now := time.Now().UTC().Truncate(time.Second)
|
||||||
|
info := &mockFileInfo{
|
||||||
|
name: "test.txt",
|
||||||
|
size: 100,
|
||||||
|
mode: 0644,
|
||||||
|
modTime: now,
|
||||||
|
}
|
||||||
|
|
||||||
|
ctime := fileCTime(info)
|
||||||
|
if !ctime.Equal(now) {
|
||||||
|
t.Fatalf("expected fallback to mtime %v, got %v", now, ctime)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -728,7 +728,7 @@ func (s *Scanner) checkFileInMemory(path string, info os.FileInfo, knownFiles ma
|
|||||||
Path: types.FilePath(path),
|
Path: types.FilePath(path),
|
||||||
SourcePath: types.SourcePath(s.currentSourcePath), // Store source directory for restore path stripping
|
SourcePath: types.SourcePath(s.currentSourcePath), // Store source directory for restore path stripping
|
||||||
MTime: info.ModTime(),
|
MTime: info.ModTime(),
|
||||||
CTime: info.ModTime(), // afero doesn't provide ctime
|
CTime: fileCTime(info), // platform-specific: birth time on macOS, inode change time on Linux
|
||||||
Size: info.Size(),
|
Size: info.Size(),
|
||||||
Mode: uint32(info.Mode()),
|
Mode: uint32(info.Mode()),
|
||||||
UID: uid,
|
UID: uid,
|
||||||
|
|||||||
@@ -1,100 +0,0 @@
|
|||||||
package vaultik_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
|
||||||
"git.eeqj.de/sneak/vaultik/internal/blobgen"
|
|
||||||
"git.eeqj.de/sneak/vaultik/internal/vaultik"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestFetchAndDecryptBlobVerifiesHash verifies that FetchAndDecryptBlob checks
|
|
||||||
// the double-SHA-256 hash of the decrypted plaintext against the expected blob hash.
|
|
||||||
func TestFetchAndDecryptBlobVerifiesHash(t *testing.T) {
|
|
||||||
identity, err := age.GenerateX25519Identity()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("generating identity: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create test data and encrypt it using blobgen.Writer
|
|
||||||
plaintext := []byte("hello world test data for blob hash verification")
|
|
||||||
var encBuf bytes.Buffer
|
|
||||||
writer, err := blobgen.NewWriter(&encBuf, 1, []string{identity.Recipient().String()})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("creating blobgen writer: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := writer.Write(plaintext); err != nil {
|
|
||||||
t.Fatalf("writing plaintext: %v", err)
|
|
||||||
}
|
|
||||||
if err := writer.Close(); err != nil {
|
|
||||||
t.Fatalf("closing writer: %v", err)
|
|
||||||
}
|
|
||||||
encryptedData := encBuf.Bytes()
|
|
||||||
|
|
||||||
// Compute correct double-SHA-256 hash of the plaintext (matches blobgen.Writer.Sum256)
|
|
||||||
firstHash := sha256.Sum256(plaintext)
|
|
||||||
secondHash := sha256.Sum256(firstHash[:])
|
|
||||||
correctHash := hex.EncodeToString(secondHash[:])
|
|
||||||
|
|
||||||
// Verify our hash matches what blobgen.Writer produces
|
|
||||||
writerHash := hex.EncodeToString(writer.Sum256())
|
|
||||||
if correctHash != writerHash {
|
|
||||||
t.Fatalf("hash computation mismatch: manual=%s, writer=%s", correctHash, writerHash)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set up mock storage with the blob at the correct path
|
|
||||||
mockStorage := NewMockStorer()
|
|
||||||
blobPath := "blobs/" + correctHash[:2] + "/" + correctHash[2:4] + "/" + correctHash
|
|
||||||
mockStorage.mu.Lock()
|
|
||||||
mockStorage.data[blobPath] = encryptedData
|
|
||||||
mockStorage.mu.Unlock()
|
|
||||||
|
|
||||||
tv := vaultik.NewForTesting(mockStorage)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
t.Run("correct hash succeeds", func(t *testing.T) {
|
|
||||||
rc, err := tv.FetchAndDecryptBlob(ctx, correctHash, int64(len(encryptedData)), identity)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected success, got error: %v", err)
|
|
||||||
}
|
|
||||||
data, err := io.ReadAll(rc)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("reading stream: %v", err)
|
|
||||||
}
|
|
||||||
if err := rc.Close(); err != nil {
|
|
||||||
t.Fatalf("close (hash verification) failed: %v", err)
|
|
||||||
}
|
|
||||||
if !bytes.Equal(data, plaintext) {
|
|
||||||
t.Fatalf("decrypted data mismatch: got %q, want %q", data, plaintext)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("wrong hash fails", func(t *testing.T) {
|
|
||||||
// Use a fake hash that doesn't match the actual plaintext
|
|
||||||
fakeHash := strings.Repeat("ab", 32) // 64 hex chars
|
|
||||||
fakePath := "blobs/" + fakeHash[:2] + "/" + fakeHash[2:4] + "/" + fakeHash
|
|
||||||
mockStorage.mu.Lock()
|
|
||||||
mockStorage.data[fakePath] = encryptedData
|
|
||||||
mockStorage.mu.Unlock()
|
|
||||||
|
|
||||||
rc, err := tv.FetchAndDecryptBlob(ctx, fakeHash, int64(len(encryptedData)), identity)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error opening stream: %v", err)
|
|
||||||
}
|
|
||||||
// Read all data — hash is verified on Close
|
|
||||||
_, _ = io.ReadAll(rc)
|
|
||||||
err = rc.Close()
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for mismatched hash, got nil")
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), "hash mismatch") {
|
|
||||||
t.Fatalf("expected hash mismatch error, got: %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -2,82 +2,38 @@ package vaultik
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"hash"
|
|
||||||
"io"
|
"io"
|
||||||
|
|
||||||
"filippo.io/age"
|
"filippo.io/age"
|
||||||
"git.eeqj.de/sneak/vaultik/internal/blobgen"
|
"git.eeqj.de/sneak/vaultik/internal/blobgen"
|
||||||
)
|
)
|
||||||
|
|
||||||
// hashVerifyReader wraps a reader and computes a double-SHA-256 hash of all
|
// FetchAndDecryptBlobResult holds the result of fetching and decrypting a blob.
|
||||||
// data read through it. The hash is verified against the expected blob hash
|
type FetchAndDecryptBlobResult struct {
|
||||||
// when Close is called. This allows streaming blob verification without
|
Data []byte
|
||||||
// buffering the entire blob in memory.
|
|
||||||
type hashVerifyReader struct {
|
|
||||||
reader io.ReadCloser // underlying decrypted blob reader
|
|
||||||
fetcher io.ReadCloser // raw fetched stream (closed on Close)
|
|
||||||
hasher hash.Hash // running SHA-256 of plaintext
|
|
||||||
blobHash string // expected double-SHA-256 hex
|
|
||||||
done bool // EOF reached
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (h *hashVerifyReader) Read(p []byte) (int, error) {
|
// FetchAndDecryptBlob downloads a blob, decrypts it, and returns the plaintext data.
|
||||||
n, err := h.reader.Read(p)
|
func (v *Vaultik) FetchAndDecryptBlob(ctx context.Context, blobHash string, expectedSize int64, identity age.Identity) (*FetchAndDecryptBlobResult, error) {
|
||||||
if n > 0 {
|
|
||||||
h.hasher.Write(p[:n])
|
|
||||||
}
|
|
||||||
if err == io.EOF {
|
|
||||||
h.done = true
|
|
||||||
}
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close verifies the hash (if the stream was fully read) and closes underlying readers.
|
|
||||||
func (h *hashVerifyReader) Close() error {
|
|
||||||
readerErr := h.reader.Close()
|
|
||||||
fetcherErr := h.fetcher.Close()
|
|
||||||
|
|
||||||
if h.done {
|
|
||||||
firstHash := h.hasher.Sum(nil)
|
|
||||||
secondHasher := sha256.New()
|
|
||||||
secondHasher.Write(firstHash)
|
|
||||||
actualHashHex := hex.EncodeToString(secondHasher.Sum(nil))
|
|
||||||
if actualHashHex != h.blobHash {
|
|
||||||
return fmt.Errorf("blob hash mismatch: expected %s, got %s", h.blobHash[:16], actualHashHex[:16])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if readerErr != nil {
|
|
||||||
return readerErr
|
|
||||||
}
|
|
||||||
return fetcherErr
|
|
||||||
}
|
|
||||||
|
|
||||||
// FetchAndDecryptBlob downloads a blob, decrypts and decompresses it, and
|
|
||||||
// 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).
|
|
||||||
// This avoids buffering the entire blob in memory.
|
|
||||||
func (v *Vaultik) FetchAndDecryptBlob(ctx context.Context, blobHash string, expectedSize int64, identity age.Identity) (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
|
||||||
}
|
}
|
||||||
|
defer func() { _ = rc.Close() }()
|
||||||
|
|
||||||
reader, err := blobgen.NewReader(rc, identity)
|
reader, err := blobgen.NewReader(rc, identity)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = rc.Close()
|
|
||||||
return nil, fmt.Errorf("creating blob reader: %w", err)
|
return nil, fmt.Errorf("creating blob reader: %w", err)
|
||||||
}
|
}
|
||||||
|
defer func() { _ = reader.Close() }()
|
||||||
|
|
||||||
return &hashVerifyReader{
|
data, err := io.ReadAll(reader)
|
||||||
reader: reader,
|
if err != nil {
|
||||||
fetcher: rc,
|
return nil, fmt.Errorf("reading blob data: %w", err)
|
||||||
hasher: sha256.New(),
|
}
|
||||||
blobHash: blobHash,
|
|
||||||
}, nil
|
return &FetchAndDecryptBlobResult{Data: data}, 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.
|
||||||
|
|||||||
@@ -22,6 +22,13 @@ import (
|
|||||||
"golang.org/x/term"
|
"golang.org/x/term"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// progressBarWidth is the character width of the progress bar display.
|
||||||
|
progressBarWidth = 40
|
||||||
|
// progressBarThrottle is the minimum interval between progress bar redraws.
|
||||||
|
progressBarThrottle = 100 * time.Millisecond
|
||||||
|
)
|
||||||
|
|
||||||
// RestoreOptions contains options for the restore operation
|
// RestoreOptions contains options for the restore operation
|
||||||
type RestoreOptions struct {
|
type RestoreOptions struct {
|
||||||
SnapshotID string
|
SnapshotID string
|
||||||
@@ -115,6 +122,15 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
defer func() { _ = blobCache.Close() }()
|
defer func() { _ = blobCache.Close() }()
|
||||||
|
|
||||||
|
// Calculate total bytes for progress bar
|
||||||
|
var totalBytesExpected int64
|
||||||
|
for _, file := range files {
|
||||||
|
totalBytesExpected += file.Size
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create progress bar if output is a terminal
|
||||||
|
bar := v.newProgressBar("Restoring", totalBytesExpected)
|
||||||
|
|
||||||
for i, file := range files {
|
for i, file := range files {
|
||||||
if v.ctx.Err() != nil {
|
if v.ctx.Err() != nil {
|
||||||
return v.ctx.Err()
|
return v.ctx.Err()
|
||||||
@@ -124,11 +140,19 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
||||||
result.FilesFailed++
|
result.FilesFailed++
|
||||||
result.FailedFiles = append(result.FailedFiles, file.Path.String())
|
result.FailedFiles = append(result.FailedFiles, file.Path.String())
|
||||||
// Continue with other files
|
// Update progress bar even on failure
|
||||||
|
if bar != nil {
|
||||||
|
_ = bar.Add64(file.Size)
|
||||||
|
}
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// Progress logging
|
// Update progress bar
|
||||||
|
if bar != nil {
|
||||||
|
_ = bar.Add64(file.Size)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Progress logging (for non-terminal or structured logs)
|
||||||
if (i+1)%100 == 0 || i+1 == len(files) {
|
if (i+1)%100 == 0 || i+1 == len(files) {
|
||||||
log.Info("Restore progress",
|
log.Info("Restore progress",
|
||||||
"files", fmt.Sprintf("%d/%d", i+1, len(files)),
|
"files", fmt.Sprintf("%d/%d", i+1, len(files)),
|
||||||
@@ -137,6 +161,10 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if bar != nil {
|
||||||
|
_ = bar.Finish()
|
||||||
|
}
|
||||||
|
|
||||||
result.Duration = time.Since(startTime)
|
result.Duration = time.Since(startTime)
|
||||||
|
|
||||||
log.Info("Restore complete",
|
log.Info("Restore complete",
|
||||||
@@ -383,7 +411,11 @@ func (v *Vaultik) restoreDirectory(file *database.File, targetPath string, resul
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set mtime
|
// Set mtime (atime is set to mtime as a reasonable default).
|
||||||
|
// Note: ctime cannot be restored. On Linux, ctime (inode change time) is
|
||||||
|
// managed by the kernel and cannot be set by userspace. On macOS, birth
|
||||||
|
// time cannot be set via standard POSIX APIs. The ctime value is preserved
|
||||||
|
// in the snapshot database for informational purposes.
|
||||||
if err := v.Fs.Chtimes(targetPath, file.MTime, file.MTime); err != nil {
|
if err := v.Fs.Chtimes(targetPath, file.MTime, file.MTime); err != nil {
|
||||||
log.Debug("Failed to set directory mtime", "path", targetPath, "error", err)
|
log.Debug("Failed to set directory mtime", "path", targetPath, "error", err)
|
||||||
}
|
}
|
||||||
@@ -480,7 +512,11 @@ func (v *Vaultik) restoreRegularFile(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set mtime
|
// Set mtime (atime is set to mtime as a reasonable default).
|
||||||
|
// Note: ctime cannot be restored. On Linux, ctime (inode change time) is
|
||||||
|
// managed by the kernel and cannot be set by userspace. On macOS, birth
|
||||||
|
// time cannot be set via standard POSIX APIs. The ctime value is preserved
|
||||||
|
// in the snapshot database for informational purposes.
|
||||||
if err := v.Fs.Chtimes(targetPath, file.MTime, file.MTime); err != nil {
|
if err := v.Fs.Chtimes(targetPath, file.MTime, file.MTime); err != nil {
|
||||||
log.Debug("Failed to set file mtime", "path", targetPath, "error", err)
|
log.Debug("Failed to set file mtime", "path", targetPath, "error", err)
|
||||||
}
|
}
|
||||||
@@ -494,23 +530,11 @@ func (v *Vaultik) restoreRegularFile(
|
|||||||
|
|
||||||
// downloadBlob downloads and decrypts a blob
|
// downloadBlob downloads and decrypts a blob
|
||||||
func (v *Vaultik) downloadBlob(ctx context.Context, blobHash string, expectedSize int64, identity age.Identity) ([]byte, error) {
|
func (v *Vaultik) downloadBlob(ctx context.Context, blobHash string, expectedSize int64, identity age.Identity) ([]byte, error) {
|
||||||
rc, err := v.FetchAndDecryptBlob(ctx, blobHash, expectedSize, identity)
|
result, err := v.FetchAndDecryptBlob(ctx, blobHash, expectedSize, identity)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
return result.Data, nil
|
||||||
data, err := io.ReadAll(rc)
|
|
||||||
if err != nil {
|
|
||||||
_ = rc.Close()
|
|
||||||
return nil, fmt.Errorf("reading blob data: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close triggers hash verification
|
|
||||||
if err := rc.Close(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return data, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// verifyRestoredFiles verifies that all restored files match their expected chunk hashes
|
// verifyRestoredFiles verifies that all restored files match their expected chunk hashes
|
||||||
@@ -548,22 +572,7 @@ func (v *Vaultik) verifyRestoredFiles(
|
|||||||
)
|
)
|
||||||
|
|
||||||
// Create progress bar if output is a terminal
|
// Create progress bar if output is a terminal
|
||||||
var bar *progressbar.ProgressBar
|
bar := v.newProgressBar("Verifying", totalBytes)
|
||||||
if isTerminal() {
|
|
||||||
bar = progressbar.NewOptions64(
|
|
||||||
totalBytes,
|
|
||||||
progressbar.OptionSetDescription("Verifying"),
|
|
||||||
progressbar.OptionSetWriter(v.Stderr),
|
|
||||||
progressbar.OptionShowBytes(true),
|
|
||||||
progressbar.OptionShowCount(),
|
|
||||||
progressbar.OptionSetWidth(40),
|
|
||||||
progressbar.OptionThrottle(100*time.Millisecond),
|
|
||||||
progressbar.OptionOnCompletion(func() {
|
|
||||||
v.printfStderr("\n")
|
|
||||||
}),
|
|
||||||
progressbar.OptionSetRenderBlankState(true),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Verify each file
|
// Verify each file
|
||||||
for _, file := range regularFiles {
|
for _, file := range regularFiles {
|
||||||
@@ -657,7 +666,37 @@ func (v *Vaultik) verifyFile(
|
|||||||
return bytesVerified, nil
|
return bytesVerified, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// isTerminal returns true if stdout is a terminal
|
// newProgressBar creates a terminal-aware progress bar with standard options.
|
||||||
func isTerminal() bool {
|
// It returns nil if stdout is not a terminal.
|
||||||
return term.IsTerminal(int(os.Stdout.Fd()))
|
func (v *Vaultik) newProgressBar(description string, total int64) *progressbar.ProgressBar {
|
||||||
|
if !v.isTerminal() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return progressbar.NewOptions64(
|
||||||
|
total,
|
||||||
|
progressbar.OptionSetDescription(description),
|
||||||
|
progressbar.OptionSetWriter(v.Stderr),
|
||||||
|
progressbar.OptionShowBytes(true),
|
||||||
|
progressbar.OptionShowCount(),
|
||||||
|
progressbar.OptionSetWidth(progressBarWidth),
|
||||||
|
progressbar.OptionThrottle(progressBarThrottle),
|
||||||
|
progressbar.OptionOnCompletion(func() {
|
||||||
|
v.printfStderr("\n")
|
||||||
|
}),
|
||||||
|
progressbar.OptionSetRenderBlankState(true),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// isTerminal returns true if stdout is a terminal.
|
||||||
|
// It checks whether v.Stdout implements Fd() (i.e. is an *os.File),
|
||||||
|
// and falls back to false for non-file writers (e.g. in tests).
|
||||||
|
func (v *Vaultik) isTerminal() bool {
|
||||||
|
type fder interface {
|
||||||
|
Fd() uintptr
|
||||||
|
}
|
||||||
|
f, ok := v.Stdout.(fder)
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return term.IsTerminal(int(f.Fd()))
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user