117 lines
2.6 KiB
Go
117 lines
2.6 KiB
Go
package command
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"reflect"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/vault/api"
|
|
)
|
|
|
|
// ReadCommand is a Command that reads data from the Vault.
|
|
type ReadCommand struct {
|
|
Meta
|
|
}
|
|
|
|
func (c *ReadCommand) Run(args []string) int {
|
|
var format string
|
|
var field string
|
|
var err error
|
|
var secret *api.Secret
|
|
var flags *flag.FlagSet
|
|
flags = c.Meta.FlagSet("read", FlagSetDefault)
|
|
flags.StringVar(&format, "format", "table", "")
|
|
flags.StringVar(&field, "field", "", "")
|
|
flags.Usage = func() { c.Ui.Error(c.Help()) }
|
|
if err := flags.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
args = flags.Args()
|
|
if len(args) != 1 || len(args[0]) == 0 {
|
|
c.Ui.Error("read expects one argument")
|
|
flags.Usage()
|
|
return 1
|
|
}
|
|
|
|
path := args[0]
|
|
if path[0] == '/' {
|
|
path = path[1:]
|
|
}
|
|
|
|
client, err := c.Client()
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf(
|
|
"Error initializing client: %s", err))
|
|
return 2
|
|
}
|
|
|
|
secret, err = client.Logical().Read(path)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf(
|
|
"Error reading %s: %s", path, err))
|
|
return 1
|
|
}
|
|
if secret == nil {
|
|
c.Ui.Error(fmt.Sprintf(
|
|
"No value found at %s", path))
|
|
return 1
|
|
}
|
|
|
|
// Handle single field output
|
|
if field != "" {
|
|
if val, ok := secret.Data[field]; ok {
|
|
// c.Ui.Output() prints a CR character which in this case is
|
|
// not desired. Since Vault CLI currently only uses BasicUi,
|
|
// which writes to standard output, os.Stdout is used here to
|
|
// directly print the message. If mitchellh/cli exposes method
|
|
// to print without CR, this check needs to be removed.
|
|
if reflect.TypeOf(c.Ui).String() == "*cli.BasicUi" {
|
|
fmt.Fprintf(os.Stdout, val.(string))
|
|
} else {
|
|
c.Ui.Output(val.(string))
|
|
}
|
|
return 0
|
|
} else {
|
|
c.Ui.Error(fmt.Sprintf(
|
|
"Field %s not present in secret", field))
|
|
return 1
|
|
}
|
|
}
|
|
|
|
return OutputSecret(c.Ui, format, secret)
|
|
}
|
|
|
|
func (c *ReadCommand) Synopsis() string {
|
|
return "Read data or secrets from Vault"
|
|
}
|
|
|
|
func (c *ReadCommand) Help() string {
|
|
helpText := `
|
|
Usage: vault read [options] path
|
|
|
|
Read data from Vault.
|
|
|
|
Reads data at the given path from Vault. This can be used to read
|
|
secrets and configuration as well as generate dynamic values from
|
|
materialized backends. Please reference the documentation for the
|
|
backends in use to determine key structure.
|
|
|
|
General Options:
|
|
|
|
` + generalOptionsUsage() + `
|
|
|
|
Read Options:
|
|
|
|
-format=table The format for output. By default it is a whitespace-
|
|
delimited table. This can also be json or yaml.
|
|
|
|
-field=field If included, the raw value of the specified field
|
|
will be output raw to stdout.
|
|
|
|
`
|
|
return strings.TrimSpace(helpText)
|
|
}
|