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
138 lines
3 KiB
Go
138 lines
3 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/mitchellh/cli"
|
|
"github.com/posener/complete"
|
|
)
|
|
|
|
var _ cli.Command = (*KVGetCommand)(nil)
|
|
var _ cli.CommandAutocomplete = (*KVGetCommand)(nil)
|
|
|
|
type KVGetCommand struct {
|
|
*BaseCommand
|
|
|
|
flagVersion int
|
|
}
|
|
|
|
func (c *KVGetCommand) Synopsis() string {
|
|
return "Retrieves data from the KV store"
|
|
}
|
|
|
|
func (c *KVGetCommand) Help() string {
|
|
helpText := `
|
|
Usage: vault kv get [options] KEY
|
|
|
|
Retrieves the value from Vault's key-value store at the given key name. If no
|
|
key exists with that name, an error is returned. If a key exists with that
|
|
name but has no data, nothing is returned.
|
|
|
|
$ vault kv get secret/foo
|
|
|
|
To view the given key name at a specific version in time, specify the "-version"
|
|
flag:
|
|
|
|
$ vault kv get -version=1 secret/foo
|
|
|
|
Additional flags and more advanced use cases are detailed below.
|
|
|
|
` + c.Flags().Help()
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *KVGetCommand) Flags() *FlagSets {
|
|
set := c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
|
|
|
|
// Common Options
|
|
f := set.NewFlagSet("Common Options")
|
|
|
|
f.IntVar(&IntVar{
|
|
Name: "version",
|
|
Target: &c.flagVersion,
|
|
Default: 0,
|
|
Usage: `If passed, the value at the version number will be returned.`,
|
|
})
|
|
|
|
return set
|
|
}
|
|
|
|
func (c *KVGetCommand) AutocompleteArgs() complete.Predictor {
|
|
return nil
|
|
}
|
|
|
|
func (c *KVGetCommand) AutocompleteFlags() complete.Flags {
|
|
return c.Flags().Completions()
|
|
}
|
|
|
|
func (c *KVGetCommand) 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])
|
|
path, err = addPrefixToVKVPath(path, "data")
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 2
|
|
}
|
|
|
|
var versionParam map[string]string
|
|
if c.flagVersion > 0 {
|
|
versionParam = map[string]string{
|
|
"version": fmt.Sprintf("%d", c.flagVersion),
|
|
}
|
|
}
|
|
|
|
secret, err := kvReadRequest(client, path, versionParam)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error reading %s: %s", path, err))
|
|
return 2
|
|
}
|
|
if secret == nil {
|
|
c.UI.Error(fmt.Sprintf("No value found at %s", path))
|
|
return 2
|
|
}
|
|
|
|
if c.flagField != "" {
|
|
return PrintRawField(c.UI, secret, c.flagField)
|
|
}
|
|
|
|
// If we have wrap info print the secret normally.
|
|
if secret.WrapInfo != nil || c.flagFormat != "table" {
|
|
return OutputSecret(c.UI, secret)
|
|
}
|
|
|
|
if metadata, ok := secret.Data["metadata"]; ok && metadata != nil {
|
|
c.UI.Info(getHeaderForMap("Metadata", metadata.(map[string]interface{})))
|
|
OutputData(c.UI, metadata)
|
|
c.UI.Info("")
|
|
}
|
|
if data, ok := secret.Data["data"]; ok && data != nil {
|
|
c.UI.Info(getHeaderForMap("Data", data.(map[string]interface{})))
|
|
OutputData(c.UI, data)
|
|
}
|
|
|
|
return 0
|
|
}
|