Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue1198: error reading deleted secret #1260

Merged
merged 2 commits into from
Aug 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions dependency/dependency_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,15 @@ func (v *vaultServer) CreateSecret(path string, data map[string]interface{},
return err
}

// deleteSecret lets us delete keys as needed for tests
func (v *vaultServer) deleteSecret(path string) error {
_, err := testClients.Vault().Logical().Delete(v.secretsPath + "/" + path)
if err != nil {
fmt.Println(err)
}
return err
}

func TestCanShare(t *testing.T) {
t.Parallel()

Expand Down
17 changes: 14 additions & 3 deletions dependency/vault_read.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,8 @@ func (d *VaultReadQuery) readSecret(clients *ClientSet, opts *QueryOptions) (*ap
if d.isKVv2 == nil {
mountPath, isKVv2, err := isKVv2(vaultClient, d.rawPath)
if err != nil {
log.Printf("[WARN] %s: failed to check if %s is KVv2, assume not: %s", d, d.rawPath, err)
log.Printf("[WARN] %s: failed to check if %s is KVv2, "+
"assume not: %s", d, d.rawPath, err)
isKVv2 = false
d.secretPath = d.rawPath
} else if isKVv2 {
Expand All @@ -163,12 +164,22 @@ func (d *VaultReadQuery) readSecret(clients *ClientSet, opts *QueryOptions) (*ap
Path: "/v1/" + d.secretPath,
RawQuery: queryString,
})
vaultSecret, err := vaultClient.Logical().ReadWithData(d.secretPath, d.queryValues)
vaultSecret, err := vaultClient.Logical().ReadWithData(d.secretPath,
d.queryValues)

if err != nil {
return nil, errors.Wrap(err, d.String())
}
if vaultSecret == nil {
if vaultSecret == nil || deletedKVv2(vaultSecret) {
return nil, fmt.Errorf("no secret exists at %s", d.secretPath)
}
return vaultSecret, nil
}

func deletedKVv2(s *api.Secret) bool {
switch md := s.Data["metadata"].(type) {
case map[string]interface{}:
return md["deletion_time"] != ""
}
return false
}
32 changes: 32 additions & 0 deletions dependency/vault_read_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"time"

"github.com/hashicorp/vault/api"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
)

Expand Down Expand Up @@ -325,6 +326,37 @@ func TestVaultReadQuery_Fetch_KVv2(t *testing.T) {
})
}

t.Run("read_deleted", func(t *testing.T) {
// only needed for KVv2 as KVv1 doesn't have metadata
path := "data/foo/zed"
// create and delete a secret
err = vault.CreateSecret(path, map[string]interface{}{
"zip": "zop",
})
if err != nil {
t.Fatal(err)
}
err = vault.deleteSecret(path)
if err != nil {
t.Fatal(err)
}
// now look for entry with metadata but no data (deleted secret)
path = vault.secretsPath + "/" + path
d, err := NewVaultReadQuery(path)
if err != nil {
t.Fatal(err)
}
_, _, err = d.Fetch(clients, nil)
if err == nil {
t.Fatal("Nil received when error expected")
}
exp_err := fmt.Sprintf("no secret exists at %s", path)
if errors.Cause(err).Error() != exp_err {
t.Fatalf("Unexpected error received.\nexpected '%s'\ngot: '%s'",
exp_err, errors.Cause(err))
}
})

t.Run("stops", func(t *testing.T) {
d, err := NewVaultReadQuery(secretsPath + "/foo/bar")
if err != nil {
Expand Down