backend

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package backend defines where ciphertext lives. The Backend interface is the seam between client-side-crypto and provider-holds-plaintext storage models: RcloneStorage is the only MVP implementation. A future KeyVaultBackend can implement the same interface and simply ignore the crypto layer.

Index

Constants

This section is empty.

Variables

View Source
var ErrNotFound = errors.New("namespace not found")

ErrNotFound is returned by Get when no blob exists for the namespace.

View Source
var ErrRcloneMissing = errors.New("rclone not found in PATH")

ErrRcloneMissing is returned when no rclone binary is on PATH.

Functions

func CreateRemote

func CreateRemote(ctx context.Context, name, kind string, params map[string]string) error

CreateRemote drives `rclone config create` into the user's global rclone config. Params pass via argv: briefly visible in /proc, but with no shell nothing lands in history. This is acceptable because storage credentials only ever guard ciphertext. Revisit if rclone grows a stdin-based config path.

func ListRemotes

func ListRemotes(ctx context.Context) ([]string, error)

ListRemotes returns the names of the user's configured rclone remotes.

func RcloneInstalled

func RcloneInstalled() bool

RcloneInstalled reports whether an rclone binary is available.

func RemoteType

func RemoteType(ctx context.Context, name string) (string, error)

RemoteType returns a remote's backend type (for example "b2" or "s3"). Reads the local rclone config only, no network.

Types

type Backend

type Backend interface {
	// Get returns the stored ciphertext for a namespace (or ErrNotFound).
	Get(ctx context.Context, namespace string) ([]byte, error)
	// Put stores ciphertext. Implementations SHOULD retain prior versions.
	Put(ctx context.Context, namespace string, ciphertext []byte) error
	// List returns known namespaces.
	List(ctx context.Context) ([]string, error)
}

type HeaderStore

type HeaderStore interface {
	// GetHeader returns the raw header object (or ErrNotFound).
	GetHeader(ctx context.Context) ([]byte, error)
	// PutHeader stores the raw header object.
	PutHeader(ctx context.Context, raw []byte) error
	// BackupHeader preserves the current header before an overwrite, so a
	// clobbered header doesn't lock the user out of every blob. It is a no-op
	// when the remote keeps native object versions (the versions ARE the
	// backup) or when no header exists yet; otherwise it copies the header to
	// a sibling backup object. The safe-write protocol calls it before
	// PutHeader and refuses to proceed if it errors.
	BackupHeader(ctx context.Context) error
	// RestoreHeaderBackup copies the sibling backup object back over the
	// header, the recovery counterpart to BackupHeader. It returns
	// ErrNotFound when no backup exists. On versioned remotes there is no
	// ".prev" backup (restore a prior object version with rclone instead), so
	// implementations there return ErrNotFound.
	RestoreHeaderBackup(ctx context.Context) error
}

HeaderStore is implemented by client-side-crypto backends, which keep the key-slot header next to the namespace blobs (see internal/crypto: LUKS2-style wrapped master key). Backends where the provider holds plaintext have no key material and won't implement it.

type RcloneStorage

type RcloneStorage struct {
	Remote string // rclone remote name, e.g. "b2"
	Base   string // path within the remote, e.g. "my-bucket/notenv"
	// Versioned: the remote retains old versions on overwrite (B2 does
	// natively), so the .prev backup copy (~3s server-side on B2) is
	// redundant and skipped.
	Versioned bool
}

RcloneStorage implements Backend by shelling out to a system rclone. This keeps the binary small and the dependency explicit; embedding the library is a possible later optimization.

func (*RcloneStorage) BackupHeader added in v0.2.0

func (s *RcloneStorage) BackupHeader(ctx context.Context) error

BackupHeader copies the current header to its ".prev" sibling so a bad overwrite is recoverable. It is a no-op when the remote keeps native object versions (those versions are the backup) and when no header exists yet (nothing to preserve). Any other copy failure is returned so the caller can refuse to overwrite a header it couldn't back up.

func (*RcloneStorage) Get

func (s *RcloneStorage) Get(ctx context.Context, namespace string) ([]byte, error)

func (*RcloneStorage) GetHeader

func (s *RcloneStorage) GetHeader(ctx context.Context) ([]byte, error)

func (*RcloneStorage) List

func (s *RcloneStorage) List(ctx context.Context) ([]string, error)

func (*RcloneStorage) Preflight

func (s *RcloneStorage) Preflight(ctx context.Context) error

Preflight verifies rclone is installed and the remote exists.

func (*RcloneStorage) Probe

func (s *RcloneStorage) Probe(ctx context.Context) error

Probe round-trips a marker object through the configured base path so a bad credential or bucket fails here, with context, not at the first real `set` days later.

func (*RcloneStorage) Put

func (s *RcloneStorage) Put(ctx context.Context, namespace string, ciphertext []byte) error

func (*RcloneStorage) PutHeader

func (s *RcloneStorage) PutHeader(ctx context.Context, raw []byte) error

PutHeader writes the header object. It does NOT back up first: the safe-write protocol (internal/keymgmt) calls BackupHeader before this, because a clobbered header locks the user out of every blob under it. Creation on virgin storage calls PutHeader directly (nothing to back up yet).

func (*RcloneStorage) RestoreHeaderBackup added in v0.2.0

func (s *RcloneStorage) RestoreHeaderBackup(ctx context.Context) error

RestoreHeaderBackup copies the ".prev" backup back over the header. Returns ErrNotFound when there is no backup to restore, including on versioned remotes, which keep no ".prev" (use rclone's version listing to recover a prior object version there).

Directories

Path Synopsis
Package backendtest holds the shared conformance suite for backend.HeaderStore implementations.
Package backendtest holds the shared conformance suite for backend.HeaderStore implementations.
Package memstore is an in-memory backend.HeaderStore (and backend.Backend) for tests.
Package memstore is an in-memory backend.HeaderStore (and backend.Backend) for tests.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL