check / check (push) Successful in 43s
Bumps golangci-lint from v2.1.6 (digest-only pin in the `Dockerfile` lint stage) to v2.12.2, pinned by tag and digest (Debian-based image). Replaces `.golangci.yml` with the canonical strict config: all linters enabled except the standard disable list (`exhaustruct`, `depguard`, `godot`, `wsl`, `wrapcheck`, `varnamelen`), `lll` at 88, `funlen` 80/50, `cyclop` 15, `dupl` 100, and test files are now linted (the old config had `tests: false`, an enable-only list of ~20 linters, `lll` 120, and a blanket exclusion of `internal/macse`). The stricter config surfaced ~1550 findings, all fixed: - `wsl_v5` (439) / `nlreturn` (24): blank-line insertions - `lll` (309): line wrapping at 88 columns; long literals split with `+` concatenation, values unchanged - `noinlineerr` (130): `if err := ...` split into assignment plus check - `paralleltest` (116): `t.Parallel()` added to tests without shared state; reasoned `//nolint` where `t.Setenv` or shared fixtures forbid it - `err113` (97): package-level sentinel errors (new `internal/vault/errors.go`), `%w` wrapping, `errors.Is` - `perfsprint` (74) / `modernize` (39) / `intrange`: `strconv`, `errors.New`, `slices.Contains`, `any`, `SplitSeq` - `goconst` (40) / `dupword` (41) / `testifylint` (42) / `thelper` (33): constants, assertion fixes, `t.Helper()` - `noctx` (22): `exec.CommandContext` for gpg/CLI invocations - `testpackage` (18): black-box tests moved to `_test` packages where they use only exported identifiers; white-box files carry a reasoned `//nolint` - `funlen`/`cyclop`/`gocognit`/`nestif`/`dupl`: behavior-preserving helper extraction - assorted singletons: `gosec`, `gosmopolitan`, `funcorder`, `nonamedreturns`, `makezero`, `prealloc`, `godox`, `nolintlint`, `ireturn`, `nilnil`, `gochecknoinits` ## User-visible strings **None changed.** Every error message this branch composes is byte-identical to the one `main` composes. The `err113` sentinels are shaped so `fmt.Errorf` reassembles the original text around them: the sentinel carries the fixed words and the caller supplies the interpolated value in the position it has always occupied. Where the value sits mid-sentence the sentinel holds only a fragment (e.g. `vault.ErrVaultNotFound` is `"does not exist"`, composed by its caller as `vault <name> does not exist`); each such sentinel documents the message it participates in. Verified mechanically, not by inspection: every `fmt.Errorf` and `errors.New` call site in both trees is parsed, the `Error()` text of any sentinel passed to `%w` is substituted in, and the resulting sets of composed message templates are compared. All 350 templates `main` produces are still produced, character for character. The set of lost or altered messages is empty. ## `unlocker list` `findUnlockerIDByMetadata` returns `(string, error)` rather than signalling failure with an empty ID, so an unreadable `unlockers.d` is no longer indistinguishable from "no matching entry". `UnlockersList` skips such an entry with a warning naming the directory — its behavior before the scan was extracted into a helper — instead of emitting a row under a synthesized fallback ID that no `unlocker remove` or `unlocker select` can match and that suppresses the current-unlocker marker. The duplicate-check and shell-completion callers skip on the same condition, matching their pre-extraction behavior. Covered by `internal/cli/unlockers_list_test.go`. `TODO.md` records the change plus follow-ups (version-completion TODOs formerly in code comments, darwin-gated files exceeding 88 columns that Linux CI does not lint). `make check` is green and the pinned v2.12.2 image reports `0 issues.` Note the test suite needs the memlock ulimit from `script/cibuild` for the 10MB memguard test; that requirement is pre-existing. Not changed: `script/bootstrap` installs golangci-lint via the system package manager (no version pin to bump), and `script/lint` invokes whatever `golangci-lint` is on PATH. golangci-lint v2.12 deprecates `gomodguard` in favor of `gomodguard_v2` (warning only); the canonical config owns that decision. Co-authored-by: sneak <sneak@sneak.berlin> Reviewed-on: #29 Co-authored-by: clawbot <clawbot@noreply.example.org> Co-committed-by: clawbot <clawbot@noreply.example.org>
186 lines
5.6 KiB
Go
186 lines
5.6 KiB
Go
package secret
|
|
|
|
import (
|
|
"fmt"
|
|
"log/slog"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"filippo.io/age"
|
|
"github.com/awnumar/memguard"
|
|
"github.com/spf13/afero"
|
|
)
|
|
|
|
// PassphraseUnlocker represents a passphrase-protected unlocker
|
|
type PassphraseUnlocker struct {
|
|
Directory string
|
|
Metadata UnlockerMetadata
|
|
fs afero.Fs
|
|
Passphrase *memguard.LockedBuffer // Secure buffer for passphrase
|
|
}
|
|
|
|
// NewPassphraseUnlocker creates a new PassphraseUnlocker instance
|
|
func NewPassphraseUnlocker(
|
|
fs afero.Fs, directory string, metadata UnlockerMetadata,
|
|
) *PassphraseUnlocker {
|
|
return &PassphraseUnlocker{
|
|
Directory: directory,
|
|
Metadata: metadata,
|
|
fs: fs,
|
|
}
|
|
}
|
|
|
|
// GetIdentity implements Unlocker interface for passphrase-based unlockers
|
|
func (p *PassphraseUnlocker) GetIdentity() (*age.X25519Identity, error) {
|
|
DebugWith("Getting passphrase unlocker identity",
|
|
slog.String("unlocker_id", p.GetID()),
|
|
slog.String("unlocker_type", p.GetType()),
|
|
)
|
|
|
|
passphraseBuffer, err := p.getPassphrase()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer passphraseBuffer.Destroy()
|
|
|
|
// Read encrypted private key of unlocker
|
|
unlockerPrivPath := filepath.Join(p.Directory, "priv.age")
|
|
Debug("Reading encrypted passphrase unlocker", "path", unlockerPrivPath)
|
|
|
|
encryptedPrivKeyData, err := afero.ReadFile(p.fs, unlockerPrivPath)
|
|
if err != nil {
|
|
Debug("Failed to read passphrase unlocker private key",
|
|
"error", err, "path", unlockerPrivPath)
|
|
|
|
return nil, fmt.Errorf("failed to read unlocker private key: %w", err)
|
|
}
|
|
|
|
DebugWith("Read encrypted passphrase unlocker",
|
|
slog.String("unlocker_id", p.GetID()),
|
|
slog.Int("encrypted_length", len(encryptedPrivKeyData)),
|
|
)
|
|
|
|
Debug("Decrypting unlocker private key with passphrase", "unlocker_id", p.GetID())
|
|
|
|
// Decrypt the unlocker private key with passphrase
|
|
privKeyBuffer, err := DecryptWithPassphrase(encryptedPrivKeyData, passphraseBuffer)
|
|
if err != nil {
|
|
Debug("Failed to decrypt unlocker private key",
|
|
"error", err, "unlocker_id", p.GetID())
|
|
|
|
return nil, fmt.Errorf("failed to decrypt unlocker private key: %w", err)
|
|
}
|
|
defer privKeyBuffer.Destroy()
|
|
|
|
DebugWith("Successfully decrypted unlocker private key",
|
|
slog.String("unlocker_id", p.GetID()),
|
|
slog.Int("decrypted_length", privKeyBuffer.Size()),
|
|
)
|
|
|
|
// Parse the decrypted private key
|
|
Debug("Parsing decrypted unlocker identity", "unlocker_id", p.GetID())
|
|
|
|
identity, err := age.ParseX25519Identity(privKeyBuffer.String())
|
|
if err != nil {
|
|
Debug("Failed to parse unlocker private key", "error", err, "unlocker_id", p.GetID())
|
|
|
|
return nil, fmt.Errorf("failed to parse unlocker private key: %w", err)
|
|
}
|
|
|
|
DebugWith("Successfully parsed passphrase unlocker identity",
|
|
slog.String("unlocker_id", p.GetID()),
|
|
slog.String("public_key", identity.Recipient().String()),
|
|
)
|
|
|
|
return identity, nil
|
|
}
|
|
|
|
// GetType implements Unlocker interface
|
|
func (p *PassphraseUnlocker) GetType() string {
|
|
return "passphrase"
|
|
}
|
|
|
|
// GetMetadata implements Unlocker interface
|
|
func (p *PassphraseUnlocker) GetMetadata() UnlockerMetadata {
|
|
return p.Metadata
|
|
}
|
|
|
|
// GetDirectory implements Unlocker interface
|
|
func (p *PassphraseUnlocker) GetDirectory() string {
|
|
return p.Directory
|
|
}
|
|
|
|
// GetID implements Unlocker interface - generates ID from creation timestamp
|
|
func (p *PassphraseUnlocker) GetID() string {
|
|
// Generate ID using creation timestamp: YYYY-MM-DD.HH.mm-passphrase
|
|
createdAt := p.Metadata.CreatedAt
|
|
|
|
return createdAt.Format("2006-01-02.15.04") + "-passphrase"
|
|
}
|
|
|
|
// Remove implements Unlocker interface - removes the passphrase unlocker
|
|
func (p *PassphraseUnlocker) Remove() error {
|
|
// Clean up the passphrase from memory if it exists
|
|
if p.Passphrase != nil && p.Passphrase.IsAlive() {
|
|
p.Passphrase.Destroy()
|
|
}
|
|
|
|
// For passphrase unlockers, we just need to remove the directory
|
|
// No external resources (like keychain items) to clean up
|
|
err := p.fs.RemoveAll(p.Directory)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to remove passphrase unlocker directory: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// getPassphrase retrieves the passphrase from memory, environment, or
|
|
// user input. Returns a LockedBuffer for secure memory handling
|
|
func (p *PassphraseUnlocker) getPassphrase() (*memguard.LockedBuffer, error) {
|
|
// First check if we already have the passphrase
|
|
if p.Passphrase != nil && p.Passphrase.IsAlive() {
|
|
Debug("Using in-memory passphrase", "unlocker_id", p.GetID())
|
|
// Return a copy of the passphrase buffer
|
|
return memguard.NewBufferFromBytes(p.Passphrase.Bytes()), nil
|
|
}
|
|
|
|
Debug("No passphrase in memory, checking environment")
|
|
// Check environment variable for passphrase
|
|
passphraseStr := os.Getenv(EnvUnlockPassphrase)
|
|
if passphraseStr != "" {
|
|
Debug("Using passphrase from environment", "unlocker_id", p.GetID())
|
|
// Convert to secure buffer
|
|
secureBuffer := memguard.NewBufferFromBytes([]byte(passphraseStr))
|
|
|
|
return secureBuffer, nil
|
|
}
|
|
|
|
Debug("No passphrase in environment, prompting user")
|
|
// Prompt for passphrase
|
|
secureBuffer, err := ReadPassphrase("Enter unlock passphrase: ")
|
|
if err != nil {
|
|
Debug("Failed to read passphrase", "error", err, "unlocker_id", p.GetID())
|
|
|
|
return nil, fmt.Errorf("failed to read passphrase: %w", err)
|
|
}
|
|
|
|
return secureBuffer, nil
|
|
}
|
|
|
|
// CreatePassphraseUnlocker creates a new passphrase-protected unlocker
|
|
// The passphrase must be provided as a LockedBuffer for security
|
|
func CreatePassphraseUnlocker(
|
|
fs afero.Fs,
|
|
stateDir string,
|
|
passphrase *memguard.LockedBuffer,
|
|
) (*PassphraseUnlocker, error) {
|
|
// Get current vault
|
|
currentVault, err := GetCurrentVault(fs, stateDir)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to get current vault: %w", err)
|
|
}
|
|
|
|
return currentVault.CreatePassphraseUnlocker(passphrase)
|
|
}
|