5c84c36915
* Add more cli subcommands * Add metadata commands * Add more subcommands * Update cli * Move archive commands to delete * Add helpers for making http calls to the kv backend * rename cli header * Format the various maps from kv * Add list command * Update help text * Add a command to enable versioning on a backend * Rename enable-versions command * Some review feedback * Fix listing of top level keys * Fix issue when metadata is nil * Add test for lising top level keys * Fix some typos * Add a note about deleting all versions
105 lines
2.2 KiB
Go
105 lines
2.2 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/mitchellh/cli"
|
|
"github.com/posener/complete"
|
|
)
|
|
|
|
var _ cli.Command = (*KVListCommand)(nil)
|
|
var _ cli.CommandAutocomplete = (*KVListCommand)(nil)
|
|
|
|
type KVListCommand struct {
|
|
*BaseCommand
|
|
}
|
|
|
|
func (c *KVListCommand) Synopsis() string {
|
|
return "List data or secrets"
|
|
}
|
|
|
|
func (c *KVListCommand) Help() string {
|
|
helpText := `
|
|
|
|
Usage: vault kv list [options] PATH
|
|
|
|
Lists data from Vault's key-value store at the given path.
|
|
|
|
List values under the "my-app" folder of the key-value store:
|
|
|
|
$ vault kv list secret/my-app/
|
|
|
|
Additional flags and more advanced use cases are detailed below.
|
|
|
|
` + c.Flags().Help()
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *KVListCommand) Flags() *FlagSets {
|
|
return c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
|
|
}
|
|
|
|
func (c *KVListCommand) AutocompleteArgs() complete.Predictor {
|
|
return c.PredictVaultFolders()
|
|
}
|
|
|
|
func (c *KVListCommand) AutocompleteFlags() complete.Flags {
|
|
return c.Flags().Completions()
|
|
}
|
|
|
|
func (c *KVListCommand) 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 := ensureTrailingSlash(sanitizePath(args[0]))
|
|
path, err = addPrefixToVKVPath(path, "metadata")
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 2
|
|
}
|
|
|
|
secret, err := kvListRequest(client, path)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error listing %s: %s", path, err))
|
|
return 2
|
|
}
|
|
if secret == nil || secret.Data == nil {
|
|
c.UI.Error(fmt.Sprintf("No value found at %s", path))
|
|
return 2
|
|
}
|
|
|
|
// If the secret is wrapped, return the wrapped response.
|
|
if secret.WrapInfo != nil && secret.WrapInfo.TTL != 0 {
|
|
return OutputSecret(c.UI, secret)
|
|
}
|
|
|
|
if _, ok := extractListData(secret); !ok {
|
|
c.UI.Error(fmt.Sprintf("No entries found at %s", path))
|
|
return 2
|
|
}
|
|
|
|
return OutputList(c.UI, secret)
|
|
}
|