Compare commits
6 Commits
fix/sql-in
...
32d22b9b57
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
32d22b9b57 | ||
|
|
4c23398243 | ||
|
|
c465312412 | ||
|
|
6b5ab5488f | ||
| afb993c3d7 | |||
| afc0b5205b |
@@ -1,64 +0,0 @@
|
|||||||
package blobgen
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"crypto/rand"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// testRecipient is a static age recipient for tests.
|
|
||||||
const testRecipient = "age1cplgrwj77ta54dnmydvvmzn64ltk83ankxl5sww04mrtmu62kv3s89gmvv"
|
|
||||||
|
|
||||||
// TestCompressStreamNoDoubleClose is a regression test for issue #28.
|
|
||||||
// It verifies that CompressStream does not panic or return an error due to
|
|
||||||
// double-closing the underlying blobgen.Writer. Before the fix in PR #33,
|
|
||||||
// the explicit Close() on the happy path combined with defer Close() would
|
|
||||||
// cause a double close.
|
|
||||||
func TestCompressStreamNoDoubleClose(t *testing.T) {
|
|
||||||
input := []byte("regression test data for issue #28 double-close fix")
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
written, hash, err := CompressStream(&buf, bytes.NewReader(input), 3, []string{testRecipient})
|
|
||||||
require.NoError(t, err, "CompressStream should not return an error")
|
|
||||||
assert.True(t, written > 0, "expected bytes written > 0")
|
|
||||||
assert.NotEmpty(t, hash, "expected non-empty hash")
|
|
||||||
assert.True(t, buf.Len() > 0, "expected non-empty output")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCompressStreamLargeInput exercises CompressStream with a larger payload
|
|
||||||
// to ensure no double-close issues surface under heavier I/O.
|
|
||||||
func TestCompressStreamLargeInput(t *testing.T) {
|
|
||||||
data := make([]byte, 512*1024) // 512 KB
|
|
||||||
_, err := rand.Read(data)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
written, hash, err := CompressStream(&buf, bytes.NewReader(data), 3, []string{testRecipient})
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.True(t, written > 0)
|
|
||||||
assert.NotEmpty(t, hash)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCompressStreamEmptyInput verifies CompressStream handles empty input
|
|
||||||
// without double-close issues.
|
|
||||||
func TestCompressStreamEmptyInput(t *testing.T) {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
_, hash, err := CompressStream(&buf, strings.NewReader(""), 3, []string{testRecipient})
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.NotEmpty(t, hash)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCompressDataNoDoubleClose mirrors the stream test for CompressData,
|
|
||||||
// ensuring the explicit Close + error-path Close pattern is also safe.
|
|
||||||
func TestCompressDataNoDoubleClose(t *testing.T) {
|
|
||||||
input := []byte("CompressData regression test for double-close")
|
|
||||||
result, err := CompressData(input, 3, []string{testRecipient})
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.True(t, result.CompressedSize > 0)
|
|
||||||
assert.True(t, result.UncompressedSize == int64(len(input)))
|
|
||||||
assert.NotEmpty(t, result.SHA256)
|
|
||||||
}
|
|
||||||
@@ -1,12 +1,15 @@
|
|||||||
package vaultik
|
package vaultik
|
||||||
|
|
||||||
|
// TODO: These are stub implementations for methods referenced but not yet
|
||||||
|
// implemented. They allow the package to compile for testing.
|
||||||
|
// Remove once the real implementations land.
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
|
||||||
"filippo.io/age"
|
"filippo.io/age"
|
||||||
"git.eeqj.de/sneak/vaultik/internal/blobgen"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// FetchAndDecryptBlobResult holds the result of fetching and decrypting a blob.
|
// FetchAndDecryptBlobResult holds the result of fetching and decrypting a blob.
|
||||||
@@ -16,40 +19,10 @@ type FetchAndDecryptBlobResult struct {
|
|||||||
|
|
||||||
// FetchAndDecryptBlob downloads a blob, decrypts it, and returns the plaintext data.
|
// FetchAndDecryptBlob downloads a blob, decrypts it, and returns the plaintext data.
|
||||||
func (v *Vaultik) FetchAndDecryptBlob(ctx context.Context, blobHash string, expectedSize int64, identity age.Identity) (*FetchAndDecryptBlobResult, error) {
|
func (v *Vaultik) FetchAndDecryptBlob(ctx context.Context, blobHash string, expectedSize int64, identity age.Identity) (*FetchAndDecryptBlobResult, error) {
|
||||||
rc, _, err := v.FetchBlob(ctx, blobHash, expectedSize)
|
return nil, fmt.Errorf("FetchAndDecryptBlob not yet implemented")
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer func() { _ = rc.Close() }()
|
|
||||||
|
|
||||||
reader, err := blobgen.NewReader(rc, identity)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("creating blob reader: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = reader.Close() }()
|
|
||||||
|
|
||||||
data, err := io.ReadAll(reader)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("reading blob data: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
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.
|
||||||
func (v *Vaultik) FetchBlob(ctx context.Context, blobHash string, expectedSize int64) (io.ReadCloser, int64, error) {
|
func (v *Vaultik) FetchBlob(ctx context.Context, blobHash string, expectedSize int64) (io.ReadCloser, int64, error) {
|
||||||
blobPath := fmt.Sprintf("blobs/%s/%s/%s", blobHash[:2], blobHash[2:4], blobHash)
|
return nil, 0, fmt.Errorf("FetchBlob not yet implemented")
|
||||||
|
|
||||||
rc, err := v.Storage.Get(ctx, blobPath)
|
|
||||||
if err != nil {
|
|
||||||
return nil, 0, fmt.Errorf("downloading blob %s: %w", blobHash[:16], err)
|
|
||||||
}
|
|
||||||
|
|
||||||
info, err := v.Storage.Stat(ctx, blobPath)
|
|
||||||
if err != nil {
|
|
||||||
_ = rc.Close()
|
|
||||||
return nil, 0, fmt.Errorf("stat blob %s: %w", blobHash[:16], err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return rc, info.Size, nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// defaultMaxBlobCacheBytes is the default maximum size of the disk blob cache (10 GB).
|
||||||
|
const defaultMaxBlobCacheBytes = 10 << 30 // 10 GiB
|
||||||
|
|
||||||
// blobDiskCacheEntry tracks a cached blob on disk.
|
// blobDiskCacheEntry tracks a cached blob on disk.
|
||||||
type blobDiskCacheEntry struct {
|
type blobDiskCacheEntry struct {
|
||||||
key string
|
key string
|
||||||
|
|||||||
@@ -109,32 +109,83 @@ func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|||||||
|
|
||||||
// Step 5: Restore files
|
// Step 5: Restore files
|
||||||
result := &RestoreResult{}
|
result := &RestoreResult{}
|
||||||
blobCache, err := newBlobDiskCache(4 * v.Config.BlobSizeLimit.Int64())
|
blobCache, err := newBlobDiskCache(defaultMaxBlobCacheBytes)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("creating blob cache: %w", err)
|
return fmt.Errorf("creating blob cache: %w", err)
|
||||||
}
|
}
|
||||||
defer func() { _ = blobCache.Close() }()
|
defer func() { _ = blobCache.Close() }()
|
||||||
|
|
||||||
for i, file := range files {
|
// Calculate total bytes for progress bar
|
||||||
|
var totalBytes int64
|
||||||
|
for _, file := range files {
|
||||||
|
totalBytes += file.Size
|
||||||
|
}
|
||||||
|
|
||||||
|
_, _ = fmt.Fprintf(v.Stdout, "Restoring %d files (%s)...\n",
|
||||||
|
len(files),
|
||||||
|
humanize.Bytes(uint64(totalBytes)),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Create progress bar if stderr is a terminal
|
||||||
|
isTTY := isTerminal(v.Stderr)
|
||||||
|
var bar *progressbar.ProgressBar
|
||||||
|
if isTTY {
|
||||||
|
bar = progressbar.NewOptions64(
|
||||||
|
totalBytes,
|
||||||
|
progressbar.OptionSetDescription("Restoring"),
|
||||||
|
progressbar.OptionSetWriter(v.Stderr),
|
||||||
|
progressbar.OptionShowBytes(true),
|
||||||
|
progressbar.OptionShowCount(),
|
||||||
|
progressbar.OptionSetWidth(40),
|
||||||
|
progressbar.OptionThrottle(100*time.Millisecond),
|
||||||
|
progressbar.OptionOnCompletion(func() {
|
||||||
|
_, _ = fmt.Fprint(v.Stderr, "\n")
|
||||||
|
}),
|
||||||
|
progressbar.OptionSetRenderBlankState(true),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
filesProcessed := 0
|
||||||
|
for _, file := range files {
|
||||||
if v.ctx.Err() != nil {
|
if v.ctx.Err() != nil {
|
||||||
return v.ctx.Err()
|
return v.ctx.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := v.restoreFile(v.ctx, repos, file, opts.TargetDir, identity, chunkToBlobMap, blobCache, result); err != nil {
|
if err := v.restoreFile(v.ctx, repos, file, opts.TargetDir, identity, chunkToBlobMap, blobCache, result); err != nil {
|
||||||
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
||||||
// Continue with other files
|
filesProcessed++
|
||||||
|
// Update progress bar even on failure
|
||||||
|
if bar != nil {
|
||||||
|
_ = bar.Add64(file.Size)
|
||||||
|
}
|
||||||
|
// Periodic structured log for non-terminal contexts (headless/CI)
|
||||||
|
if !isTTY && filesProcessed%100 == 0 {
|
||||||
|
log.Info("Restore progress",
|
||||||
|
"files", fmt.Sprintf("%d/%d", filesProcessed, len(files)),
|
||||||
|
"bytes_restored", humanize.Bytes(uint64(result.BytesRestored)),
|
||||||
|
)
|
||||||
|
}
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// Progress logging
|
filesProcessed++
|
||||||
if (i+1)%100 == 0 || i+1 == len(files) {
|
// Update progress bar
|
||||||
|
if bar != nil {
|
||||||
|
_ = bar.Add64(file.Size)
|
||||||
|
}
|
||||||
|
// Periodic structured log for non-terminal contexts (headless/CI)
|
||||||
|
if !isTTY && (filesProcessed%100 == 0 || filesProcessed == len(files)) {
|
||||||
log.Info("Restore progress",
|
log.Info("Restore progress",
|
||||||
"files", fmt.Sprintf("%d/%d", i+1, len(files)),
|
"files", fmt.Sprintf("%d/%d", filesProcessed, len(files)),
|
||||||
"bytes", humanize.Bytes(uint64(result.BytesRestored)),
|
"bytes_restored", humanize.Bytes(uint64(result.BytesRestored)),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if bar != nil {
|
||||||
|
_ = bar.Finish()
|
||||||
|
}
|
||||||
|
|
||||||
result.Duration = time.Since(startTime)
|
result.Duration = time.Since(startTime)
|
||||||
|
|
||||||
log.Info("Restore complete",
|
log.Info("Restore complete",
|
||||||
@@ -427,9 +478,7 @@ func (v *Vaultik) restoreRegularFile(
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("downloading blob %s: %w", blobHashStr[:16], err)
|
return fmt.Errorf("downloading blob %s: %w", blobHashStr[:16], err)
|
||||||
}
|
}
|
||||||
if putErr := blobCache.Put(blobHashStr, blobData); putErr != nil {
|
if putErr := blobCache.Put(blobHashStr, blobData); putErr != nil { log.Debug("Failed to cache blob on disk", "hash", blobHashStr[:16], "error", putErr) }
|
||||||
log.Debug("Failed to cache blob on disk", "hash", blobHashStr[:16], "error", putErr)
|
|
||||||
}
|
|
||||||
result.BlobsDownloaded++
|
result.BlobsDownloaded++
|
||||||
result.BytesDownloaded += blob.CompressedSize
|
result.BytesDownloaded += blob.CompressedSize
|
||||||
}
|
}
|
||||||
@@ -524,7 +573,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
|
var bar *progressbar.ProgressBar
|
||||||
if isTerminal() {
|
if isTerminal(v.Stderr) {
|
||||||
bar = progressbar.NewOptions64(
|
bar = progressbar.NewOptions64(
|
||||||
totalBytes,
|
totalBytes,
|
||||||
progressbar.OptionSetDescription("Verifying"),
|
progressbar.OptionSetDescription("Verifying"),
|
||||||
@@ -632,7 +681,11 @@ func (v *Vaultik) verifyFile(
|
|||||||
return bytesVerified, nil
|
return bytesVerified, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// isTerminal returns true if stdout is a terminal
|
// isTerminal returns true if the given writer is connected to a terminal.
|
||||||
func isTerminal() bool {
|
// Returns false if the writer does not expose a file descriptor (e.g. in tests).
|
||||||
return term.IsTerminal(int(os.Stdout.Fd()))
|
func isTerminal(w io.Writer) bool {
|
||||||
|
if f, ok := w.(*os.File); ok {
|
||||||
|
return term.IsTerminal(int(f.Fd()))
|
||||||
|
}
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
"regexp"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -1126,27 +1127,20 @@ func (v *Vaultik) PruneDatabase() (*PruneResult, error) {
|
|||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// allowedTableNames is the exhaustive whitelist of table names that may be
|
// validTableNameRe matches table names containing only lowercase alphanumeric characters and underscores.
|
||||||
// passed to getTableCount. Any name not in this set is rejected, preventing
|
var validTableNameRe = regexp.MustCompile(`^[a-z0-9_]+$`)
|
||||||
// SQL injection even if caller-controlled input is accidentally supplied.
|
|
||||||
var allowedTableNames = map[string]struct{}{
|
|
||||||
"files": {},
|
|
||||||
"chunks": {},
|
|
||||||
"blobs": {},
|
|
||||||
}
|
|
||||||
|
|
||||||
// getTableCount returns the number of rows in the given table.
|
// getTableCount returns the count of rows in a table.
|
||||||
// tableName must appear in the allowedTableNames whitelist; all other values
|
// The tableName is sanitized to only allow [a-z0-9_] characters to prevent SQL injection.
|
||||||
// are rejected with an error, preventing SQL injection.
|
|
||||||
func (v *Vaultik) getTableCount(tableName string) (int64, error) {
|
func (v *Vaultik) getTableCount(tableName string) (int64, error) {
|
||||||
if _, ok := allowedTableNames[tableName]; !ok {
|
|
||||||
return 0, fmt.Errorf("table name not allowed: %q", tableName)
|
|
||||||
}
|
|
||||||
|
|
||||||
if v.DB == nil {
|
if v.DB == nil {
|
||||||
return 0, nil
|
return 0, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if !validTableNameRe.MatchString(tableName) {
|
||||||
|
return 0, fmt.Errorf("invalid table name: %q", tableName)
|
||||||
|
}
|
||||||
|
|
||||||
var count int64
|
var count int64
|
||||||
query := fmt.Sprintf("SELECT COUNT(*) FROM %s", tableName)
|
query := fmt.Sprintf("SELECT COUNT(*) FROM %s", tableName)
|
||||||
err := v.DB.Conn().QueryRowContext(v.ctx, query).Scan(&count)
|
err := v.DB.Conn().QueryRowContext(v.ctx, query).Scan(&count)
|
||||||
|
|||||||
@@ -1,51 +0,0 @@
|
|||||||
package vaultik
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestAllowedTableNames(t *testing.T) {
|
|
||||||
// Verify the whitelist contains exactly the expected tables
|
|
||||||
expected := []string{"files", "chunks", "blobs"}
|
|
||||||
assert.Len(t, allowedTableNames, len(expected))
|
|
||||||
for _, name := range expected {
|
|
||||||
_, ok := allowedTableNames[name]
|
|
||||||
assert.True(t, ok, "expected %q in allowedTableNames", name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestGetTableCount_RejectsInvalidNames(t *testing.T) {
|
|
||||||
v := &Vaultik{} // DB is nil, but rejection happens before DB access
|
|
||||||
v.DB = nil // explicit
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
tableName string
|
|
||||||
wantErr bool
|
|
||||||
}{
|
|
||||||
{"allowed files", "files", false},
|
|
||||||
{"allowed chunks", "chunks", false},
|
|
||||||
{"allowed blobs", "blobs", false},
|
|
||||||
{"sql injection attempt", "files; DROP TABLE files--", true},
|
|
||||||
{"unknown table", "users", true},
|
|
||||||
{"empty string", "", true},
|
|
||||||
{"uppercase", "FILES", true},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
count, err := v.getTableCount(tt.tableName)
|
|
||||||
if tt.wantErr {
|
|
||||||
assert.Error(t, err)
|
|
||||||
assert.Contains(t, err.Error(), "not allowed")
|
|
||||||
assert.Equal(t, int64(0), count)
|
|
||||||
} else {
|
|
||||||
// DB is nil so returns 0, nil for allowed names
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, int64(0), count)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -129,7 +129,7 @@ func (v *Vaultik) GetFilesystem() afero.Fs {
|
|||||||
return v.Fs
|
return v.Fs
|
||||||
}
|
}
|
||||||
|
|
||||||
// printfStdout writes formatted output to stdout.
|
// printfStdout writes formatted output to stdout for user-facing messages.
|
||||||
func (v *Vaultik) printfStdout(format string, args ...any) {
|
func (v *Vaultik) printfStdout(format string, args ...any) {
|
||||||
_, _ = fmt.Fprintf(v.Stdout, format, args...)
|
_, _ = fmt.Fprintf(v.Stdout, format, args...)
|
||||||
}
|
}
|
||||||
@@ -148,7 +148,6 @@ func (v *Vaultik) printfStderr(format string, args ...any) {
|
|||||||
func (v *Vaultik) scanStdin(a ...any) (int, error) {
|
func (v *Vaultik) scanStdin(a ...any) (int, error) {
|
||||||
return fmt.Fscanln(v.Stdin, a...)
|
return fmt.Fscanln(v.Stdin, a...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestVaultik wraps a Vaultik with captured stdout/stderr for testing
|
// TestVaultik wraps a Vaultik with captured stdout/stderr for testing
|
||||||
type TestVaultik struct {
|
type TestVaultik struct {
|
||||||
*Vaultik
|
*Vaultik
|
||||||
|
|||||||
Reference in New Issue
Block a user