diff --git a/secret-engines/bws/main.go b/secret-engines/bws/main.go index f997876..f1ab1a4 100644 --- a/secret-engines/bws/main.go +++ b/secret-engines/bws/main.go @@ -22,28 +22,49 @@ import ( secretenginev1 "github.com/samcharles93/archipelago/sdk/secretengine/v1" ) -const listTimeout = 30 * time.Second +const ( + listTimeout = 30 * time.Second + // cacheTTL bounds how long a rotated secret keeps its old value. + cacheTTL = 5 * time.Minute + // missRefresh bounds how often a key the cache lacks re-reads the list, so + // a secret added a moment ago resolves without hammering the API. + missRefresh = 30 * time.Second +) type engine struct { secretenginev1.UnimplementedSecretEngineServiceServer + list func(context.Context) (map[string]string, error) - once sync.Once + mu sync.Mutex secrets map[string]string - err error + fetched time.Time } func (*engine) Configure(context.Context, *secretenginev1.ConfigureRequest) (*secretenginev1.ConfigureResponse, error) { return &secretenginev1.ConfigureResponse{}, nil } +// Resolve serves a key from the cached list, re-reading the list when it is +// stale or lacks the key. A failed read is never cached: the next call tries +// again, and a stale value it already holds is served meanwhile. func (e *engine) Resolve(ctx context.Context, r *secretenginev1.ResolveRequest) (*secretenginev1.ResolveResponse, error) { - e.once.Do(func() { e.secrets, e.err = list(ctx) }) - if e.err != nil { - return nil, status.Error(codes.Unavailable, e.err.Error()) + e.mu.Lock() + defer e.mu.Unlock() + key := r.GetKey() + value, ok := e.secrets[key] + age := time.Since(e.fetched) + if e.secrets == nil || age > cacheTTL || (!ok && age > missRefresh) { + secrets, err := e.list(ctx) + switch { + case err == nil: + e.secrets, e.fetched = secrets, time.Now() + value, ok = secrets[key] + case !ok: + return nil, status.Error(codes.Unavailable, err.Error()) + } } - value, ok := e.secrets[r.GetKey()] if !ok { - return nil, status.Errorf(codes.NotFound, "bws secret %q not found", r.GetKey()) + return nil, status.Errorf(codes.NotFound, "bws secret %q not found", key) } return &secretenginev1.ResolveResponse{Value: value}, nil } @@ -88,4 +109,4 @@ func find() (string, error) { return "", errors.New("bws executable not found") } -func main() { secretengine.Serve(&engine{}) } +func main() { secretengine.Serve(&engine{list: list}) } diff --git a/secret-engines/bws/main_test.go b/secret-engines/bws/main_test.go new file mode 100644 index 0000000..79edff1 --- /dev/null +++ b/secret-engines/bws/main_test.go @@ -0,0 +1,43 @@ +package main + +import ( + "context" + "errors" + "testing" + "time" + + "google.golang.org/grpc/codes" + "google.golang.org/grpc/status" + + secretenginev1 "github.com/samcharles93/archipelago/sdk/secretengine/v1" +) + +// The engine used to cache its first list forever, so one failed read at +// startup made every later key unavailable until a restart. +func TestResolveRecovers(t *testing.T) { + reads := []error{errors.New("bws unreachable"), nil} + e := &engine{list: func(context.Context) (map[string]string, error) { + err := reads[0] + reads = reads[1:] + if err != nil { + return nil, err + } + return map[string]string{"token": "v1"}, nil + }} + resolve := func() (string, codes.Code) { + r, err := e.Resolve(t.Context(), &secretenginev1.ResolveRequest{Key: "token"}) + return r.GetValue(), status.Code(err) + } + if _, code := resolve(); code != codes.Unavailable { + t.Fatalf("first read failed: code = %v, want Unavailable", code) + } + if v, code := resolve(); code != codes.OK || v != "v1" { + t.Fatalf("after recovery: %q, %v; want v1, OK", v, code) + } + // A stale cache serves what it holds when a refresh fails. + e.fetched = time.Now().Add(-2 * cacheTTL) + e.list = func(context.Context) (map[string]string, error) { return nil, errors.New("down") } + if v, code := resolve(); code != codes.OK || v != "v1" { + t.Fatalf("stale during outage: %q, %v; want v1, OK", v, code) + } +} diff --git a/secret-engines/bws/package.yaml b/secret-engines/bws/package.yaml index 6014596..3a06b85 100644 --- a/secret-engines/bws/package.yaml +++ b/secret-engines/bws/package.yaml @@ -1,7 +1,7 @@ apiVersion: dev.archie.package.v1 displayName: Bitwarden Secrets Manager description: Resolve secret references from Bitwarden Secrets Manager through the bws CLI. -version: 1.0.0 +version: 1.1.0 contributes: extensions: - surface: secretengine