c7f9d185b0
* Update kv command to use a preflight check * Make the existing ui endpoint return the allowed mounts * Add kv subcommand tests * Enable `-field` in `vault kv get/put` (#4426) * Enable `-field` in `vault kv get/put` Fixes #4424 * Unify nil value handling * Use preflight helper * Update vkv plugin * Add all the mount info when authenticated * Add fix the error message on put * add metadata test * No need to sort the capabilities * Remove the kv client header * kv patch command (#4432) * Fix test * Fix tests * Use permission denied instead of entity disabled
145 lines
3 KiB
Go
145 lines
3 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/vault/api"
|
|
"github.com/mitchellh/cli"
|
|
"github.com/posener/complete"
|
|
)
|
|
|
|
var _ cli.Command = (*KVDeleteCommand)(nil)
|
|
var _ cli.CommandAutocomplete = (*KVDeleteCommand)(nil)
|
|
|
|
type KVDeleteCommand struct {
|
|
*BaseCommand
|
|
|
|
flagVersions []string
|
|
}
|
|
|
|
func (c *KVDeleteCommand) Synopsis() string {
|
|
return "Deletes versions in the KV store"
|
|
}
|
|
|
|
func (c *KVDeleteCommand) Help() string {
|
|
helpText := `
|
|
Usage: vault kv delete [options] PATH
|
|
|
|
Deletes the data for the provided version and path in the key-value store. The
|
|
versioned data will not be fully removed, but marked as deleted and will no
|
|
longer be returned in normal get requests.
|
|
|
|
To delete the latest version of the key "foo":
|
|
|
|
$ vault kv delete secret/foo
|
|
|
|
To delete version 3 of key foo:
|
|
|
|
$ vault kv delete -versions=3 secret/foo
|
|
|
|
To delete all versions and metadata, see the "vault kv metadata" subcommand.
|
|
|
|
Additional flags and more advanced use cases are detailed below.
|
|
|
|
` + c.Flags().Help()
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *KVDeleteCommand) Flags() *FlagSets {
|
|
set := c.flagSet(FlagSetHTTP)
|
|
// Common Options
|
|
f := set.NewFlagSet("Common Options")
|
|
|
|
f.StringSliceVar(&StringSliceVar{
|
|
Name: "versions",
|
|
Target: &c.flagVersions,
|
|
Default: nil,
|
|
Usage: `Specifies the version numbers to delete.`,
|
|
})
|
|
|
|
return set
|
|
}
|
|
|
|
func (c *KVDeleteCommand) AutocompleteArgs() complete.Predictor {
|
|
return c.PredictVaultFiles()
|
|
}
|
|
|
|
func (c *KVDeleteCommand) AutocompleteFlags() complete.Flags {
|
|
return c.Flags().Completions()
|
|
}
|
|
|
|
func (c *KVDeleteCommand) Run(args []string) int {
|
|
f := c.Flags()
|
|
|
|
if err := f.Parse(args); err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
args = f.Args()
|
|
switch {
|
|
case len(args) < 1:
|
|
c.UI.Error(fmt.Sprintf("Not enough arguments (expected 1, got %d)", len(args)))
|
|
return 1
|
|
case len(args) > 1:
|
|
c.UI.Error(fmt.Sprintf("Too many arguments (expected 1, got %d)", len(args)))
|
|
return 1
|
|
}
|
|
|
|
client, err := c.Client()
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 2
|
|
}
|
|
|
|
path := sanitizePath(args[0])
|
|
mountPath, v2, err := isKVv2(path, client)
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 2
|
|
}
|
|
|
|
if v2 {
|
|
err = c.deleteV2(path, mountPath, client)
|
|
} else {
|
|
_, err = client.Logical().Delete(path)
|
|
}
|
|
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error deleting %s: %s", path, err))
|
|
return 2
|
|
}
|
|
|
|
c.UI.Info(fmt.Sprintf("Success! Data deleted (if it existed) at: %s", path))
|
|
return 0
|
|
}
|
|
|
|
func (c *KVDeleteCommand) deleteV2(path, mountPath string, client *api.Client) error {
|
|
var err error
|
|
switch {
|
|
case len(c.flagVersions) > 0:
|
|
path = addPrefixToVKVPath(path, mountPath, "delete")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
data := map[string]interface{}{
|
|
"versions": kvParseVersionsFlags(c.flagVersions),
|
|
}
|
|
|
|
_, err = client.Logical().Write(path, data)
|
|
default:
|
|
|
|
path = addPrefixToVKVPath(path, mountPath, "data")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = client.Logical().Delete(path)
|
|
}
|
|
|
|
return err
|
|
}
|