Compare commits
1
Commits
v1.0.0-rc4
...
b467b6822a
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b467b6822a |
@@ -150,6 +150,12 @@ Retrieves and outputs a secret value to stdout.
|
|||||||
|
|
||||||
Lists all secrets in the current vault. Optional filter for substring matching.
|
Lists all secrets in the current vault. Optional filter for substring matching.
|
||||||
|
|
||||||
|
The `LAST UPDATED` column, and `updated_at` in the `--json` output, give the
|
||||||
|
time the secret's `current` file was last written: every command that adds a
|
||||||
|
version replaces it, and so does `secret version promote`. `created_at` gives
|
||||||
|
the time the `value.age` of the secret's oldest version was written. Both are
|
||||||
|
the files' modification times, so listing asks for no passphrase.
|
||||||
|
|
||||||
#### `secret remove <secret-name> [--force]` / `secret rm` ⚠️ 🛑
|
#### `secret remove <secret-name> [--force]` / `secret rm` ⚠️ 🛑
|
||||||
|
|
||||||
**DANGER**: Permanently removes a secret and ALL its versions. It first asks for
|
**DANGER**: Permanently removes a secret and ALL its versions. It first asks for
|
||||||
|
|||||||
@@ -18,6 +18,15 @@ https://git.eeqj.de/sneak/secret/milestone/12
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-14: `secret list` gives each secret's own creation and last-update
|
||||||
|
times (https://git.eeqj.de/sneak/secret/issues/142). It gave the time of the
|
||||||
|
listing for both, which `Secret.LoadMetadata` set to the current time.
|
||||||
|
`LoadMetadata` now reads file modification times, so listing still needs no
|
||||||
|
passphrase: the last update is when the secret's `current` file was written,
|
||||||
|
and the creation is when its oldest version's `value.age` was written. That
|
||||||
|
version's directory would be wrong, because the next add rewrites the
|
||||||
|
version's `metadata.age` in it. `GetSecretObject`, which `secret get` also
|
||||||
|
uses, no longer loads the times; `secret list` loads them itself.
|
||||||
- 2026-10-14: Removing the current unlocker no longer leaves the vault unable to
|
- 2026-10-14: Removing the current unlocker no longer leaves the vault unable to
|
||||||
open through the unlockers it still has
|
open through the unlockers it still has
|
||||||
(https://git.eeqj.de/sneak/secret/issues/137). `current-unlocker` went on
|
(https://git.eeqj.de/sneak/secret/issues/137). `current-unlocker` went on
|
||||||
|
|||||||
@@ -0,0 +1,118 @@
|
|||||||
|
package cli_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/awnumar/memguard"
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"sneak.berlin/go/secret/internal/cli"
|
||||||
|
"sneak.berlin/go/secret/internal/secret"
|
||||||
|
"sneak.berlin/go/secret/internal/vault"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// listClockStep is how long TestListShowsWhenSecretWasWritten waits
|
||||||
|
// between its steps, so that a time read in one step cannot be the
|
||||||
|
// time read in the next.
|
||||||
|
listClockStep = 200 * time.Millisecond
|
||||||
|
|
||||||
|
// fileTimeSlack allows for the clock the kernel stamps files with,
|
||||||
|
// which advances only every few milliseconds: a file's modification
|
||||||
|
// time can be slightly earlier than a time.Now() read before the file
|
||||||
|
// was written.
|
||||||
|
fileTimeSlack = 100 * time.Millisecond
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestListShowsWhenSecretWasWritten is a regression test for
|
||||||
|
// https://git.eeqj.de/sneak/secret/issues/142, where `secret list` gave
|
||||||
|
// the time of the listing as every secret's creation and last-update time.
|
||||||
|
// Two listings with a clock step between must be the same, and give the
|
||||||
|
// time of the add; after a forced add, the creation time is unchanged and
|
||||||
|
// the last update is the time of that add. It runs on a real filesystem,
|
||||||
|
// where writing a file into a directory also changes the directory's time.
|
||||||
|
func TestListShowsWhenSecretWasWritten(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
fs := afero.NewOsFs()
|
||||||
|
stateDir := t.TempDir()
|
||||||
|
|
||||||
|
vlt, err := vault.CreateVault(fs, stateDir, "default", testMnemonicBuffer(t), nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
vlt.Mnemonic = testMnemonicBuffer(t)
|
||||||
|
c := cli.NewCLIInstanceWithStateDir(fs, stateDir)
|
||||||
|
|
||||||
|
beforeAdd := time.Now()
|
||||||
|
err = vlt.AddSecret("x", memguard.NewBufferFromBytes([]byte("one")), false)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
afterAdd := time.Now()
|
||||||
|
|
||||||
|
firstListing := listSecrets(t, c, true)
|
||||||
|
|
||||||
|
time.Sleep(listClockStep)
|
||||||
|
require.Equal(t, firstListing, listSecrets(t, c, true))
|
||||||
|
|
||||||
|
added := listedTimes(t, firstListing)
|
||||||
|
assert.WithinRange(t, added.CreatedAt, beforeAdd.Add(-fileTimeSlack), afterAdd)
|
||||||
|
assert.WithinRange(t, added.UpdatedAt, beforeAdd.Add(-fileTimeSlack), afterAdd)
|
||||||
|
|
||||||
|
time.Sleep(listClockStep)
|
||||||
|
|
||||||
|
beforeUpdate := time.Now()
|
||||||
|
err = vlt.AddSecret("x", memguard.NewBufferFromBytes([]byte("two")), true)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
afterUpdate := time.Now()
|
||||||
|
|
||||||
|
updated := listedTimes(t, listSecrets(t, c, true))
|
||||||
|
assert.True(t, added.CreatedAt.Equal(updated.CreatedAt),
|
||||||
|
"created %s, then %s", added.CreatedAt, updated.CreatedAt)
|
||||||
|
assert.WithinRange(t, updated.UpdatedAt,
|
||||||
|
beforeUpdate.Add(-fileTimeSlack), afterUpdate)
|
||||||
|
|
||||||
|
// The table's LAST UPDATED column gives the same time, to the minute
|
||||||
|
assert.Contains(t, listSecrets(t, c, false),
|
||||||
|
updated.UpdatedAt.Format("2006-01-02 15:04"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// listSecrets returns the output of `secret list`, or of
|
||||||
|
// `secret list --json` when jsonOutput is set.
|
||||||
|
func listSecrets(t *testing.T, c *cli.Instance, jsonOutput bool) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.SetOut(&out)
|
||||||
|
require.NoError(t, c.ListSecrets(cmd, jsonOutput, false, ""))
|
||||||
|
|
||||||
|
return out.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// listedTimes returns the times that the output of `secret list --json`
|
||||||
|
// gives for the one secret in the vault.
|
||||||
|
func listedTimes(t *testing.T, listing string) secret.Metadata {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var parsed struct {
|
||||||
|
Secrets []map[string]string `json:"secrets"`
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, json.Unmarshal([]byte(listing), &parsed))
|
||||||
|
require.Len(t, parsed.Secrets, 1)
|
||||||
|
|
||||||
|
createdAt, err := time.Parse(time.RFC3339Nano, parsed.Secrets[0]["created_at"])
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
updatedAt, err := time.Parse(time.RFC3339Nano, parsed.Secrets[0]["updated_at"])
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
return secret.Metadata{CreatedAt: createdAt, UpdatedAt: updatedAt}
|
||||||
|
}
|
||||||
@@ -541,8 +541,12 @@ func printSecretsJSON(
|
|||||||
"name": secretName,
|
"name": secretName,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Try to get metadata using GetSecretObject
|
// A secret whose times cannot be read is listed without them
|
||||||
secretObj, err := vlt.GetSecretObject(secretName)
|
secretObj, err := vlt.GetSecretObject(secretName)
|
||||||
|
if err == nil {
|
||||||
|
err = secretObj.LoadMetadata()
|
||||||
|
}
|
||||||
|
|
||||||
if err == nil {
|
if err == nil {
|
||||||
metadata := secretObj.GetMetadata()
|
metadata := secretObj.GetMetadata()
|
||||||
secretInfo["created_at"] = metadata.CreatedAt
|
secretInfo["created_at"] = metadata.CreatedAt
|
||||||
@@ -618,6 +622,10 @@ func printSecretsTable(
|
|||||||
lastUpdated := "unknown"
|
lastUpdated := "unknown"
|
||||||
|
|
||||||
secretObj, err := vlt.GetSecretObject(secretName)
|
secretObj, err := vlt.GetSecretObject(secretName)
|
||||||
|
if err == nil {
|
||||||
|
err = secretObj.LoadMetadata()
|
||||||
|
}
|
||||||
|
|
||||||
if err == nil {
|
if err == nil {
|
||||||
metadata := secretObj.GetMetadata()
|
metadata := secretObj.GetMetadata()
|
||||||
lastUpdated = metadata.UpdatedAt.Format("2006-01-02 15:04")
|
lastUpdated = metadata.UpdatedAt.Format("2006-01-02 15:04")
|
||||||
|
|||||||
+38
-15
@@ -2,10 +2,11 @@ package secret
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
|
||||||
|
|
||||||
"filippo.io/age"
|
"filippo.io/age"
|
||||||
"github.com/awnumar/memguard"
|
"github.com/awnumar/memguard"
|
||||||
@@ -66,31 +67,53 @@ func NewSecret(vault VaultInterface, name string) *Secret {
|
|||||||
Name: name,
|
Name: name,
|
||||||
Directory: secretDir,
|
Directory: secretDir,
|
||||||
vault: vault,
|
vault: vault,
|
||||||
Metadata: Metadata{
|
|
||||||
CreatedAt: time.Now(),
|
|
||||||
UpdatedAt: time.Now(),
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadMetadata is deprecated - metadata is now per-version and encrypted
|
// LoadMetadata sets the secret's times from the modification times of its
|
||||||
|
// files, which can be read without unlocking the vault. UpdatedAt is when
|
||||||
|
// the secret's current file was last written, by an add or a promote.
|
||||||
|
// CreatedAt is when its oldest version's value.age was written. That file
|
||||||
|
// is never rewritten; the version's directory is no use, as its time
|
||||||
|
// changes when the next add rewrites the version's metadata.age.
|
||||||
func (s *Secret) LoadMetadata() error {
|
func (s *Secret) LoadMetadata() error {
|
||||||
Debug("LoadMetadata called but is deprecated in versioned model",
|
fs := s.vault.GetFilesystem()
|
||||||
"secret_name", s.Name)
|
|
||||||
// For backward compatibility, we'll populate with basic info
|
current, err := fs.Stat(filepath.Join(s.Directory, "current"))
|
||||||
now := time.Now()
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to read when secret %s was updated: %w",
|
||||||
|
s.Name, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
versions, err := ListVersions(fs, s.Directory)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(versions) == 0 {
|
||||||
|
return fmt.Errorf("secret %s has no versions: %w", s.Name, os.ErrNotExist)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListVersions lists the newest version first
|
||||||
|
oldest := versions[len(versions)-1]
|
||||||
|
|
||||||
|
value, err := fs.Stat(
|
||||||
|
filepath.Join(s.Directory, "versions", oldest, "value.age"))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to read when secret %s was created: %w",
|
||||||
|
s.Name, err)
|
||||||
|
}
|
||||||
|
|
||||||
s.Metadata = Metadata{
|
s.Metadata = Metadata{
|
||||||
CreatedAt: now,
|
CreatedAt: value.ModTime(),
|
||||||
UpdatedAt: now,
|
UpdatedAt: current.ModTime(),
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetMetadata returns the secret metadata (deprecated)
|
// GetMetadata returns the times LoadMetadata read
|
||||||
func (s *Secret) GetMetadata() Metadata {
|
func (s *Secret) GetMetadata() Metadata {
|
||||||
Debug("GetMetadata called but is deprecated in versioned model", "secret_name", s.Name)
|
|
||||||
|
|
||||||
return s.Metadata
|
return s.Metadata
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -427,7 +427,8 @@ func (v *Vault) UnlockVault() (*age.X25519Identity, error) {
|
|||||||
return longTermIdentity, nil
|
return longTermIdentity, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetSecretObject retrieves a Secret object with metadata loaded from this vault
|
// GetSecretObject retrieves a Secret object from this vault. Its times are
|
||||||
|
// zero until its LoadMetadata reads them.
|
||||||
func (v *Vault) GetSecretObject(name string) (*secret.Secret, error) {
|
func (v *Vault) GetSecretObject(name string) (*secret.Secret, error) {
|
||||||
err := ValidateSecretName(name)
|
err := ValidateSecretName(name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -454,16 +455,7 @@ func (v *Vault) GetSecretObject(name string) (*secret.Secret, error) {
|
|||||||
return nil, fmt.Errorf("secret %s %w", name, ErrSecretNotFound)
|
return nil, fmt.Errorf("secret %s %w", name, ErrSecretNotFound)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a Secret object
|
return secret.NewSecret(v, name), nil
|
||||||
secretObj := secret.NewSecret(v, name)
|
|
||||||
|
|
||||||
// Load the metadata from disk
|
|
||||||
err = secretObj.LoadMetadata()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return secretObj, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// CopySecretVersion copies a single version from source into destSecretDir
|
// CopySecretVersion copies a single version from source into destSecretDir
|
||||||
|
|||||||
Reference in New Issue
Block a user