mirror of
				https://github.com/optim-enterprises-bv/vault.git
				synced 2025-11-03 20:17:59 +00:00 
			
		
		
		
	* Full secret path in table output of get and put * Add path output to KV patch and metadata get * Add changelog * Don't print secret path for kv-v1 * Make more readable * Switch around logic to not swallow error * Add test for secret path * Fix metadata test * Add unit test for padequalsigns * Remove wonky kv get tests
		
			
				
	
	
		
			145 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			145 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
package command
 | 
						|
 | 
						|
import (
 | 
						|
	"fmt"
 | 
						|
	"sort"
 | 
						|
	"strconv"
 | 
						|
	"strings"
 | 
						|
 | 
						|
	"github.com/mitchellh/cli"
 | 
						|
	"github.com/posener/complete"
 | 
						|
)
 | 
						|
 | 
						|
var (
 | 
						|
	_ cli.Command             = (*KVMetadataGetCommand)(nil)
 | 
						|
	_ cli.CommandAutocomplete = (*KVMetadataGetCommand)(nil)
 | 
						|
)
 | 
						|
 | 
						|
type KVMetadataGetCommand struct {
 | 
						|
	*BaseCommand
 | 
						|
}
 | 
						|
 | 
						|
func (c *KVMetadataGetCommand) Synopsis() string {
 | 
						|
	return "Retrieves key metadata from the KV store"
 | 
						|
}
 | 
						|
 | 
						|
func (c *KVMetadataGetCommand) Help() string {
 | 
						|
	helpText := `
 | 
						|
Usage: vault kv metadata get [options] KEY
 | 
						|
 | 
						|
  Retrieves the metadata from Vault's key-value store at the given key name. If no
 | 
						|
  key exists with that name, an error is returned.
 | 
						|
 | 
						|
      $ vault kv metadata get secret/foo
 | 
						|
 | 
						|
  Additional flags and more advanced use cases are detailed below.
 | 
						|
 | 
						|
` + c.Flags().Help()
 | 
						|
	return strings.TrimSpace(helpText)
 | 
						|
}
 | 
						|
 | 
						|
func (c *KVMetadataGetCommand) Flags() *FlagSets {
 | 
						|
	set := c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
 | 
						|
 | 
						|
	return set
 | 
						|
}
 | 
						|
 | 
						|
func (c *KVMetadataGetCommand) AutocompleteArgs() complete.Predictor {
 | 
						|
	return nil
 | 
						|
}
 | 
						|
 | 
						|
func (c *KVMetadataGetCommand) AutocompleteFlags() complete.Flags {
 | 
						|
	return c.Flags().Completions()
 | 
						|
}
 | 
						|
 | 
						|
func (c *KVMetadataGetCommand) 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 {
 | 
						|
		c.UI.Error("Metadata not supported on KV Version 1")
 | 
						|
		return 1
 | 
						|
	}
 | 
						|
 | 
						|
	path = addPrefixToKVPath(path, mountPath, "metadata")
 | 
						|
	secret, err := client.Logical().Read(path)
 | 
						|
	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)
 | 
						|
	}
 | 
						|
 | 
						|
	versionsRaw, ok := secret.Data["versions"]
 | 
						|
	if !ok || versionsRaw == nil {
 | 
						|
		c.UI.Error(fmt.Sprintf("No value found at %s", path))
 | 
						|
		OutputSecret(c.UI, secret)
 | 
						|
		return 2
 | 
						|
	}
 | 
						|
	versions := versionsRaw.(map[string]interface{})
 | 
						|
 | 
						|
	delete(secret.Data, "versions")
 | 
						|
 | 
						|
	outputPath(c.UI, path, "Metadata Path")
 | 
						|
 | 
						|
	c.UI.Info(getHeaderForMap("Metadata", secret.Data))
 | 
						|
	OutputSecret(c.UI, secret)
 | 
						|
 | 
						|
	versionKeys := []int{}
 | 
						|
	for k := range versions {
 | 
						|
		i, err := strconv.Atoi(k)
 | 
						|
		if err != nil {
 | 
						|
			c.UI.Error(fmt.Sprintf("Error parsing version %s", k))
 | 
						|
			return 2
 | 
						|
		}
 | 
						|
 | 
						|
		versionKeys = append(versionKeys, i)
 | 
						|
	}
 | 
						|
 | 
						|
	sort.Ints(versionKeys)
 | 
						|
 | 
						|
	for _, v := range versionKeys {
 | 
						|
		c.UI.Info("\n" + getHeaderForMap(fmt.Sprintf("Version %d", v), versions[strconv.Itoa(v)].(map[string]interface{})))
 | 
						|
		OutputData(c.UI, versions[strconv.Itoa(v)])
 | 
						|
	}
 | 
						|
 | 
						|
	return 0
 | 
						|
}
 |