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>
251 lines
7.0 KiB
Go
251 lines
7.0 KiB
Go
package secret_test
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
"filippo.io/age"
|
|
"git.eeqj.de/sneak/secret/internal/secret"
|
|
"git.eeqj.de/sneak/secret/pkg/agehd"
|
|
"github.com/awnumar/memguard"
|
|
"github.com/spf13/afero"
|
|
)
|
|
|
|
// testMnemonic is the standard BIP39 test vector mnemonic.
|
|
//
|
|
//nolint:dupword // BIP39 test mnemonic repeats words by design
|
|
const testMnemonic = "abandon abandon abandon abandon abandon abandon " +
|
|
"abandon abandon abandon abandon abandon about"
|
|
|
|
// writeTestPublicKey writes the unlocker public key and verifies it exists.
|
|
func writeTestPublicKey(
|
|
t *testing.T, fs afero.Fs, unlockerDir string, agePublicKey string,
|
|
) {
|
|
t.Helper()
|
|
|
|
pubKeyPath := filepath.Join(unlockerDir, "pub.age")
|
|
|
|
err := afero.WriteFile(fs, pubKeyPath, []byte(agePublicKey), secret.FilePerms)
|
|
if err != nil {
|
|
t.Fatalf("Failed to write public key: %v", err)
|
|
}
|
|
|
|
// Verify the file exists
|
|
exists, err := afero.Exists(fs, pubKeyPath)
|
|
if err != nil {
|
|
t.Fatalf("Failed to check if public key exists: %v", err)
|
|
}
|
|
|
|
if !exists {
|
|
t.Errorf("Public key file should exist at %s", pubKeyPath)
|
|
}
|
|
}
|
|
|
|
// writeTestPrivateKey encrypts the private key with the passphrase,
|
|
// writes it, and verifies it exists.
|
|
func writeTestPrivateKey(
|
|
t *testing.T,
|
|
fs afero.Fs,
|
|
unlockerDir string,
|
|
agePrivateKey string,
|
|
testPassphrase string,
|
|
) {
|
|
t.Helper()
|
|
|
|
privKeyBuffer := memguard.NewBufferFromBytes([]byte(agePrivateKey))
|
|
defer privKeyBuffer.Destroy()
|
|
|
|
passphraseBuffer := memguard.NewBufferFromBytes([]byte(testPassphrase))
|
|
defer passphraseBuffer.Destroy()
|
|
|
|
encryptedPrivKey, err := secret.EncryptWithPassphrase(
|
|
privKeyBuffer, passphraseBuffer)
|
|
if err != nil {
|
|
t.Fatalf("Failed to encrypt private key: %v", err)
|
|
}
|
|
|
|
privKeyPath := filepath.Join(unlockerDir, "priv.age")
|
|
|
|
err = afero.WriteFile(fs, privKeyPath, encryptedPrivKey, secret.FilePerms)
|
|
if err != nil {
|
|
t.Fatalf("Failed to write encrypted private key: %v", err)
|
|
}
|
|
|
|
// Verify the file exists
|
|
exists, err := afero.Exists(fs, privKeyPath)
|
|
if err != nil {
|
|
t.Fatalf("Failed to check if private key exists: %v", err)
|
|
}
|
|
|
|
if !exists {
|
|
t.Errorf("Encrypted private key file should exist at %s", privKeyPath)
|
|
}
|
|
}
|
|
|
|
// writeTestLongTermKey encrypts the derived long-term key to the
|
|
// unlocker's recipient, writes it, and verifies it exists.
|
|
func writeTestLongTermKey(
|
|
t *testing.T, fs afero.Fs, unlockerDir string, agePublicKey string,
|
|
) {
|
|
t.Helper()
|
|
|
|
// Derive a long-term identity from the test mnemonic
|
|
ltIdentity, err := agehd.DeriveIdentity(testMnemonic, 0)
|
|
if err != nil {
|
|
t.Fatalf("Failed to derive long-term identity: %v", err)
|
|
}
|
|
|
|
// Encrypt long-term private key to the unlocker's recipient
|
|
recipient, err := age.ParseX25519Recipient(agePublicKey)
|
|
if err != nil {
|
|
t.Fatalf("Failed to parse recipient: %v", err)
|
|
}
|
|
|
|
ltPrivKeyBuffer := memguard.NewBufferFromBytes([]byte(ltIdentity.String()))
|
|
defer ltPrivKeyBuffer.Destroy()
|
|
|
|
encryptedLtPrivKey, err := secret.EncryptToRecipient(ltPrivKeyBuffer, recipient)
|
|
if err != nil {
|
|
t.Fatalf("Failed to encrypt long-term private key: %v", err)
|
|
}
|
|
|
|
ltPrivKeyPath := filepath.Join(unlockerDir, "longterm.age")
|
|
|
|
err = afero.WriteFile(fs, ltPrivKeyPath, encryptedLtPrivKey, secret.FilePerms)
|
|
if err != nil {
|
|
t.Fatalf("Failed to write encrypted long-term private key: %v", err)
|
|
}
|
|
|
|
// Verify the file exists
|
|
exists, err := afero.Exists(fs, ltPrivKeyPath)
|
|
if err != nil {
|
|
t.Fatalf("Failed to check if long-term key exists: %v", err)
|
|
}
|
|
|
|
if !exists {
|
|
t.Errorf("Encrypted long-term key file should exist at %s", ltPrivKeyPath)
|
|
}
|
|
}
|
|
|
|
// newTestPassphraseUnlocker creates a temp unlocker directory and a
|
|
// passphrase unlocker with a fresh age identity for testing.
|
|
func newTestPassphraseUnlocker(
|
|
t *testing.T, fs afero.Fs,
|
|
) (*secret.PassphraseUnlocker, *age.X25519Identity, string) {
|
|
t.Helper()
|
|
|
|
// Create the directory structure in a temp dir
|
|
unlockerDir := filepath.Join(t.TempDir(), "unlocker")
|
|
|
|
err := os.MkdirAll(unlockerDir, secret.DirPerms)
|
|
if err != nil {
|
|
t.Fatalf("Failed to create unlocker directory: %v", err)
|
|
}
|
|
|
|
// Set up test metadata
|
|
metadata := secret.UnlockerMetadata{
|
|
Type: "passphrase",
|
|
CreatedAt: time.Now(),
|
|
Flags: []string{},
|
|
}
|
|
|
|
// Create passphrase unlocker
|
|
unlocker := secret.NewPassphraseUnlocker(fs, unlockerDir, metadata)
|
|
|
|
// Generate a test age identity
|
|
ageIdentity, err := age.GenerateX25519Identity()
|
|
if err != nil {
|
|
t.Fatalf("Failed to generate age identity: %v", err)
|
|
}
|
|
|
|
return unlocker, ageIdentity, unlockerDir
|
|
}
|
|
|
|
//nolint:paralleltest // subtests share real-FS state and t.Setenv, order matters
|
|
func TestPassphraseUnlockerWithRealFS(t *testing.T) {
|
|
// This test uses real filesystem
|
|
if os.Getenv("CI") == "true" {
|
|
t.Log("Running in CI environment with real filesystem")
|
|
}
|
|
|
|
// Use the real filesystem
|
|
fs := afero.NewOsFs()
|
|
|
|
// Test data
|
|
testPassphrase := "test-passphrase-123"
|
|
|
|
unlocker, ageIdentity, unlockerDir := newTestPassphraseUnlocker(t, fs)
|
|
agePrivateKey := ageIdentity.String()
|
|
agePublicKey := ageIdentity.Recipient().String()
|
|
|
|
// Test writing public key
|
|
t.Run("WritePublicKey", func(t *testing.T) {
|
|
writeTestPublicKey(t, fs, unlockerDir, agePublicKey)
|
|
})
|
|
|
|
// Test encrypting private key with passphrase
|
|
t.Run("EncryptPrivateKey", func(t *testing.T) {
|
|
writeTestPrivateKey(t, fs, unlockerDir, agePrivateKey, testPassphrase)
|
|
})
|
|
|
|
// Test writing long-term key
|
|
t.Run("WriteLongTermKey", func(t *testing.T) {
|
|
writeTestLongTermKey(t, fs, unlockerDir, agePublicKey)
|
|
})
|
|
|
|
// Set test environment variable (cleaned up automatically)
|
|
t.Setenv(secret.EnvUnlockPassphrase, testPassphrase)
|
|
|
|
// Test getting identity from environment variable
|
|
t.Run("GetIdentityFromEnv", func(t *testing.T) {
|
|
identity, err := unlocker.GetIdentity()
|
|
if err != nil {
|
|
t.Fatalf("Failed to get identity from env: %v", err)
|
|
}
|
|
|
|
// Verify the identity matches what we expect
|
|
expectedPubKey := ageIdentity.Recipient().String()
|
|
|
|
actualPubKey := identity.Recipient().String()
|
|
if actualPubKey != expectedPubKey {
|
|
t.Errorf("Public key mismatch. Expected %s, got %s",
|
|
expectedPubKey, actualPubKey)
|
|
}
|
|
})
|
|
|
|
// Unset the environment variable to test interactive prompt
|
|
_ = os.Unsetenv(secret.EnvUnlockPassphrase)
|
|
|
|
// Test getting identity from prompt (this would require mocking the
|
|
// prompt). For real integration tests, we'd need a way to mock the
|
|
// passphrase input. Here we just verify the error is what we expect
|
|
// when no passphrase is available.
|
|
t.Run("GetIdentityWithoutEnv", func(t *testing.T) {
|
|
// This should fail since we're not in an interactive terminal
|
|
_, err := unlocker.GetIdentity()
|
|
if err == nil {
|
|
t.Errorf("Should have failed to get identity without passphrase env var")
|
|
}
|
|
})
|
|
|
|
// Test removing the unlocker
|
|
t.Run("RemoveUnlocker", func(t *testing.T) {
|
|
err := unlocker.Remove()
|
|
if err != nil {
|
|
t.Fatalf("Failed to remove unlocker: %v", err)
|
|
}
|
|
|
|
// Verify the directory is gone
|
|
exists, err := afero.DirExists(fs, unlockerDir)
|
|
if err != nil {
|
|
t.Fatalf("Failed to check if unlocker directory exists: %v", err)
|
|
}
|
|
|
|
if exists {
|
|
t.Errorf("Unlocker directory should not exist after removal")
|
|
}
|
|
})
|
|
}
|