package command import ( "encoding/json" "errors" "fmt" "os" "sort" "strings" "github.com/ghodss/yaml" "github.com/hashicorp/vault/api" "github.com/mitchellh/cli" "github.com/ryanuber/columnize" ) const ( // hopeDelim is the delimiter to use when splitting columns. We call it a // hopeDelim because we hope that it's never contained in a secret. hopeDelim = "♨" ) type FormatOptions struct { Format string } func OutputSecret(ui cli.Ui, secret *api.Secret) int { return outputWithFormat(ui, secret, secret) } func OutputList(ui cli.Ui, data interface{}) int { switch data.(type) { case *api.Secret: secret := data.(*api.Secret) return outputWithFormat(ui, secret, secret.Data["keys"]) default: return outputWithFormat(ui, nil, data) } } func OutputData(ui cli.Ui, data interface{}) int { return outputWithFormat(ui, nil, data) } func outputWithFormat(ui cli.Ui, secret *api.Secret, data interface{}) int { format := Format(ui) formatter, ok := Formatters[format] if !ok { ui.Error(fmt.Sprintf("Invalid output format: %s", format)) return 1 } if err := formatter.Output(ui, secret, data); err != nil { ui.Error(fmt.Sprintf("Could not parse output: %s", err.Error())) return 1 } return 0 } type Formatter interface { Output(ui cli.Ui, secret *api.Secret, data interface{}) error Format(data interface{}) ([]byte, error) } var Formatters = map[string]Formatter{ "json": JsonFormatter{}, "table": TableFormatter{}, "yaml": YamlFormatter{}, "yml": YamlFormatter{}, } func Format(ui cli.Ui) string { switch ui.(type) { case *VaultUI: return ui.(*VaultUI).format } format := os.Getenv(EnvVaultFormat) if format == "" { format = "table" } return format } // An output formatter for json output of an object type JsonFormatter struct{} func (j JsonFormatter) Format(data interface{}) ([]byte, error) { return json.MarshalIndent(data, "", " ") } func (j JsonFormatter) Output(ui cli.Ui, secret *api.Secret, data interface{}) error { b, err := j.Format(data) if err != nil { return err } ui.Output(string(b)) return nil } // An output formatter for yaml output format of an object type YamlFormatter struct{} func (y YamlFormatter) Format(data interface{}) ([]byte, error) { return yaml.Marshal(data) } func (y YamlFormatter) Output(ui cli.Ui, secret *api.Secret, data interface{}) error { b, err := y.Format(data) if err == nil { ui.Output(strings.TrimSpace(string(b))) } return err } // An output formatter for table output of an object type TableFormatter struct{} // We don't use this func (t TableFormatter) Format(data interface{}) ([]byte, error) { return nil, nil } func (t TableFormatter) Output(ui cli.Ui, secret *api.Secret, data interface{}) error { switch data.(type) { case *api.Secret: return t.OutputSecret(ui, secret) case []interface{}: return t.OutputList(ui, secret, data) case []string: return t.OutputList(ui, nil, data) case map[string]interface{}: return t.OutputMap(ui, data.(map[string]interface{})) default: return errors.New("cannot use the table formatter for this type") } } func (t TableFormatter) OutputList(ui cli.Ui, secret *api.Secret, data interface{}) error { t.printWarnings(ui, secret) switch data.(type) { case []interface{}: case []string: ui.Output(tableOutput(data.([]string), nil)) return nil default: return errors.New("error: table formatter cannot output list for this data type") } list := data.([]interface{}) if len(list) > 0 { keys := make([]string, len(list)) for i, v := range list { typed, ok := v.(string) if !ok { return fmt.Errorf("%v is not a string", v) } keys[i] = typed } sort.Strings(keys) // Prepend the header keys = append([]string{"Keys"}, keys...) ui.Output(tableOutput(keys, &columnize.Config{ Delim: hopeDelim, })) } return nil } // printWarnings prints any warnings in the secret. func (t TableFormatter) printWarnings(ui cli.Ui, secret *api.Secret) { if secret != nil && len(secret.Warnings) > 0 { ui.Warn("WARNING! The following warnings were returned from Vault:\n") for _, warning := range secret.Warnings { ui.Warn(wrapAtLengthWithPadding(fmt.Sprintf("* %s", warning), 2)) ui.Warn("") } } } func (t TableFormatter) OutputSecret(ui cli.Ui, secret *api.Secret) error { if secret == nil { return nil } t.printWarnings(ui, secret) out := make([]string, 0, 8) if secret.LeaseDuration > 0 { if secret.LeaseID != "" { out = append(out, fmt.Sprintf("lease_id %s %s", hopeDelim, secret.LeaseID)) out = append(out, fmt.Sprintf("lease_duration %s %v", hopeDelim, humanDurationInt(secret.LeaseDuration))) out = append(out, fmt.Sprintf("lease_renewable %s %t", hopeDelim, secret.Renewable)) } else { // This is probably the generic secret backend which has leases, but we // print them as refresh_interval to reduce confusion. out = append(out, fmt.Sprintf("refresh_interval %s %v", hopeDelim, humanDurationInt(secret.LeaseDuration))) } } if secret.Auth != nil { out = append(out, fmt.Sprintf("token %s %s", hopeDelim, secret.Auth.ClientToken)) out = append(out, fmt.Sprintf("token_accessor %s %s", hopeDelim, secret.Auth.Accessor)) // If the lease duration is 0, it's likely a root token, so output the // duration as "infinity" to clear things up. if secret.Auth.LeaseDuration == 0 { out = append(out, fmt.Sprintf("token_duration %s %s", hopeDelim, "∞")) } else { out = append(out, fmt.Sprintf("token_duration %s %v", hopeDelim, humanDurationInt(secret.Auth.LeaseDuration))) } out = append(out, fmt.Sprintf("token_renewable %s %t", hopeDelim, secret.Auth.Renewable)) out = append(out, fmt.Sprintf("token_policies %s %q", hopeDelim, secret.Auth.TokenPolicies)) out = append(out, fmt.Sprintf("identity_policies %s %q", hopeDelim, secret.Auth.IdentityPolicies)) out = append(out, fmt.Sprintf("policies %s %q", hopeDelim, secret.Auth.Policies)) for k, v := range secret.Auth.Metadata { out = append(out, fmt.Sprintf("token_meta_%s %s %v", k, hopeDelim, v)) } } if secret.WrapInfo != nil { out = append(out, fmt.Sprintf("wrapping_token: %s %s", hopeDelim, secret.WrapInfo.Token)) out = append(out, fmt.Sprintf("wrapping_accessor: %s %s", hopeDelim, secret.WrapInfo.Accessor)) out = append(out, fmt.Sprintf("wrapping_token_ttl: %s %v", hopeDelim, humanDurationInt(secret.WrapInfo.TTL))) out = append(out, fmt.Sprintf("wrapping_token_creation_time: %s %s", hopeDelim, secret.WrapInfo.CreationTime.String())) out = append(out, fmt.Sprintf("wrapping_token_creation_path: %s %s", hopeDelim, secret.WrapInfo.CreationPath)) if secret.WrapInfo.WrappedAccessor != "" { out = append(out, fmt.Sprintf("wrapped_accessor: %s %s", hopeDelim, secret.WrapInfo.WrappedAccessor)) } } if len(secret.Data) > 0 { keys := make([]string, 0, len(secret.Data)) for k := range secret.Data { keys = append(keys, k) } sort.Strings(keys) for _, k := range keys { v := secret.Data[k] // If the field "looks" like a TTL, print it as a time duration instead. if looksLikeDuration(k) { v = humanDurationInt(v) } out = append(out, fmt.Sprintf("%s %s %v", k, hopeDelim, v)) } } // If we got this far and still don't have any data, there's nothing to print, // sorry. if len(out) == 0 { return nil } // Prepend the header out = append([]string{"Key" + hopeDelim + "Value"}, out...) ui.Output(tableOutput(out, &columnize.Config{ Delim: hopeDelim, })) return nil } func (t TableFormatter) OutputMap(ui cli.Ui, data map[string]interface{}) error { out := make([]string, 0, len(data)+1) if len(data) > 0 { keys := make([]string, 0, len(data)) for k := range data { keys = append(keys, k) } sort.Strings(keys) for _, k := range keys { v := data[k] // If the field "looks" like a TTL, print it as a time duration instead. if looksLikeDuration(k) { v = humanDurationInt(v) } out = append(out, fmt.Sprintf("%s %s %v", k, hopeDelim, v)) } } // If we got this far and still don't have any data, there's nothing to print, // sorry. if len(out) == 0 { return nil } // Prepend the header out = append([]string{"Key" + hopeDelim + "Value"}, out...) ui.Output(tableOutput(out, &columnize.Config{ Delim: hopeDelim, })) return nil } // OutputSealStatus will print *api.SealStatusResponse in the CLI according to the format provided func OutputSealStatus(ui cli.Ui, client *api.Client, status *api.SealStatusResponse) int { switch Format(ui) { case "table": default: return OutputData(ui, status) } var sealPrefix string if status.RecoverySeal { sealPrefix = "Recovery " } out := []string{} out = append(out, "Key | Value") out = append(out, fmt.Sprintf("%sSeal Type | %s", sealPrefix, status.Type)) out = append(out, fmt.Sprintf("Initialized | %t", status.Initialized)) out = append(out, fmt.Sprintf("Sealed | %t", status.Sealed)) out = append(out, fmt.Sprintf("Total %sShares | %d", sealPrefix, status.N)) out = append(out, fmt.Sprintf("Threshold | %d", status.T)) if status.Sealed { out = append(out, fmt.Sprintf("Unseal Progress | %d/%d", status.Progress, status.T)) out = append(out, fmt.Sprintf("Unseal Nonce | %s", status.Nonce)) } if status.Migration { out = append(out, fmt.Sprintf("Seal Migration in Progress | %t", status.Migration)) } out = append(out, fmt.Sprintf("Version | %s", status.Version)) if status.ClusterName != "" && status.ClusterID != "" { out = append(out, fmt.Sprintf("Cluster Name | %s", status.ClusterName)) out = append(out, fmt.Sprintf("Cluster ID | %s", status.ClusterID)) } // Mask the 'Vault is sealed' error, since this means HA is enabled, but that // we cannot query for the leader since we are sealed. leaderStatus, err := client.Sys().Leader() if err != nil && strings.Contains(err.Error(), "Vault is sealed") { leaderStatus = &api.LeaderResponse{HAEnabled: true} err = nil } if err != nil { ui.Error(fmt.Sprintf("Error checking leader status: %s", err)) return 1 } // Output if HA is enabled out = append(out, fmt.Sprintf("HA Enabled | %t", leaderStatus.HAEnabled)) if leaderStatus.HAEnabled { mode := "sealed" if !status.Sealed { out = append(out, fmt.Sprintf("HA Cluster | %s", leaderStatus.LeaderClusterAddress)) mode = "standby" showLeaderAddr := false if leaderStatus.IsSelf { mode = "active" } else { if leaderStatus.LeaderAddress == "" { leaderStatus.LeaderAddress = "" } showLeaderAddr = true } out = append(out, fmt.Sprintf("HA Mode | %s", mode)) // This is down here just to keep ordering consistent if showLeaderAddr { out = append(out, fmt.Sprintf("Active Node Address | %s", leaderStatus.LeaderAddress)) } if leaderStatus.PerfStandby { out = append(out, fmt.Sprintf("Performance Standby Node | %t", leaderStatus.PerfStandby)) out = append(out, fmt.Sprintf("Performance Standby Last Remote WAL | %d", leaderStatus.PerfStandbyLastRemoteWAL)) } } } if leaderStatus.RaftCommittedIndex > 0 { out = append(out, fmt.Sprintf("Raft Committed Index | %d", leaderStatus.RaftCommittedIndex)) } if leaderStatus.RaftAppliedIndex > 0 { out = append(out, fmt.Sprintf("Raft Applied Index | %d", leaderStatus.RaftAppliedIndex)) } if leaderStatus.LastWAL != 0 { out = append(out, fmt.Sprintf("Last WAL | %d", leaderStatus.LastWAL)) } ui.Output(tableOutput(out, nil)) return 0 } // looksLikeDuration checks if the given key "k" looks like a duration value. // This is used to pretty-format duration values in responses, especially from // plugins. func looksLikeDuration(k string) bool { return k == "period" || strings.HasSuffix(k, "_period") || k == "ttl" || strings.HasSuffix(k, "_ttl") || k == "duration" || strings.HasSuffix(k, "_duration") || k == "lease_max" || k == "ttl_max" }