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

Issue1252: vault write broken #1257

Merged
merged 2 commits into from
Aug 13, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 5 additions & 8 deletions dependency/vault_read_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -232,21 +232,17 @@ func TestVaultReadQuery_Fetch_KVv2(t *testing.T) {

// Write an initial value to the secret path
err := vault.CreateSecret("data/foo/bar", map[string]interface{}{
"data": map[string]interface{}{
"ttl": "100ms", // explicitly make this a short duration for testing
"zip": "zap",
},
"ttl": "100ms", // explicitly make this a short duration for testing
"zip": "zap",
})
if err != nil {
t.Fatal(err)
}

// Write a new value to increment the version
err = vault.CreateSecret("data/foo/bar", map[string]interface{}{
"data": map[string]interface{}{
"ttl": "100ms", // explicitly make this a short duration for testing
"zip": "zop",
},
"ttl": "100ms", // explicitly make this a short duration for testing
"zip": "zop",
})
if err != nil {
t.Fatal(err)
Expand Down Expand Up @@ -437,6 +433,7 @@ func TestVaultReadQuery_Fetch_PKI_Anonymous(t *testing.T) {
})
_, err = anonClient.vault.client.Auth().Token().LookupSelf()
if err == nil || !strings.Contains(err.Error(), "missing client token") {
// check environment for VAULT_TOKEN
t.Fatalf("expected a missing client token error but found: %v", err)
}

Expand Down
30 changes: 19 additions & 11 deletions dependency/vault_write.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,14 @@ func (d *VaultWriteQuery) Fetch(clients *ClientSet, opts *QueryOptions) (interfa
return nil, nil, errors.Wrap(err, d.String())
}

// Print any warnings
printVaultWarnings(d, vaultSecret.Warnings)

// Create the cloned secret which will be exposed to the template.
d.vaultSecret = vaultSecret
d.secret = transformSecret(vaultSecret)
// vaultSecret == nil when writing to KVv1 engines
if vaultSecret != nil {
// Print any warnings
printVaultWarnings(d, vaultSecret.Warnings)
// Create the cloned secret which will be exposed to the template.
d.vaultSecret = vaultSecret
d.secret = transformSecret(vaultSecret)
}

return respWithMetadata(d.secret)
}
Expand Down Expand Up @@ -168,14 +170,20 @@ func (d *VaultWriteQuery) writeSecret(clients *ClientSet, opts *QueryOptions) (*
RawQuery: opts.String(),
})

vaultSecret, err := clients.Vault().Logical().Write(d.path, d.data)
data := d.data

_, isv2, _ := isKVv2(clients.Vault(), d.path)
if isv2 {
data = map[string]interface{}{"data": d.data}
}

vaultSecret, err := clients.Vault().Logical().Write(d.path, data)
if err != nil {
return nil, errors.Wrap(err, d.String())
}
if vaultSecret == nil {
if _, isv2, _ := isKVv2(clients.Vault(), d.path); isv2 {
return nil, fmt.Errorf("no secret exists at %s", d.path)
}
// vaultSecret is always nil when KVv1 engine (isv2==false)
if isv2 && vaultSecret == nil {
return nil, fmt.Errorf("no secret exists at %s", d.path)
}

return vaultSecret, nil
Expand Down
71 changes: 71 additions & 0 deletions dependency/vault_write_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,77 @@ func TestNewVaultWriteQuery(t *testing.T) {
}
}

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

// previously triggered a nil-pointer-deref panic in wq.Fetch() with KVv1
// due to writeSecret() returning nil for vaultSecret
// see GH-1252
t.Run("write_secret_v1", func(t *testing.T) {
clients, vault := testVaultServer(t, "write_secret_v1", "1")
secretsPath := vault.secretsPath

path := secretsPath + "/foo"
exp := map[string]interface{}{
"bar": "zed",
}

wq, err := NewVaultWriteQuery(path, exp)
if err != nil {
t.Fatal(err)
}

_, _, err = wq.Fetch(clients, &QueryOptions{})
if err != nil {
fmt.Println(err)
}

rq, err := NewVaultReadQuery(path)
eikenb marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
t.Fatal(err)
}
act, err := rq.readSecret(clients, nil)
if err != nil {
t.Fatal(err)
}
assert.Equal(t, exp, act.Data)
})

// previously triggered vault returning "no data provided" with KVv2 as the
// data structure passed in didn't have additional wrapping map with the
// "data" key as used in KVv2
// see GH-1252
t.Run("write_secret_v2", func(t *testing.T) {
clients, vault := testVaultServer(t, "write_secret_v2", "2")
secretsPath := vault.secretsPath

path := secretsPath + "/data/foo"
exp := map[string]interface{}{
"bar": "zed",
}

wq, err := NewVaultWriteQuery(path, exp)
if err != nil {
t.Fatal(err)
}

_, _, err = wq.Fetch(clients, &QueryOptions{})
if err != nil {
fmt.Println(err)
}

rq, err := NewVaultReadQuery(path)
eikenb marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
t.Fatal(err)
}
act, err := rq.readSecret(clients, nil)
if err != nil {
t.Fatal(err)
}
assert.Equal(t, exp, act.Data["data"])
})
}

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

Expand Down