open-vault/command/operator_key_status.go

85 lines
1.7 KiB
Go
Raw Normal View History

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package command
import (
"fmt"
"strings"
2016-04-01 17:16:05 +00:00
2017-09-05 04:02:09 +00:00
"github.com/mitchellh/cli"
"github.com/posener/complete"
)
var (
_ cli.Command = (*OperatorKeyStatusCommand)(nil)
_ cli.CommandAutocomplete = (*OperatorKeyStatusCommand)(nil)
)
2017-09-05 04:02:09 +00:00
2017-09-08 02:03:12 +00:00
type OperatorKeyStatusCommand struct {
2017-09-05 04:02:09 +00:00
*BaseCommand
}
2017-09-08 02:03:12 +00:00
func (c *OperatorKeyStatusCommand) Synopsis() string {
2017-09-05 04:02:09 +00:00
return "Provides information about the active encryption key"
}
2017-09-08 02:03:12 +00:00
func (c *OperatorKeyStatusCommand) Help() string {
2017-09-05 04:02:09 +00:00
helpText := `
2017-09-08 02:03:12 +00:00
Usage: vault operator key-status [options]
2017-09-05 04:02:09 +00:00
Provides information about the active encryption key. Specifically,
the current key term and the key installation time.
` + c.Flags().Help()
return strings.TrimSpace(helpText)
}
2017-09-08 02:03:12 +00:00
func (c *OperatorKeyStatusCommand) Flags() *FlagSets {
CLI Enhancements (#3897) * Use Colored UI if stdout is a tty * Add format options to operator unseal * Add format test on operator unseal * Add -no-color output flag, and use BasicUi if no-color flag is provided * Move seal status formatting logic to OutputSealStatus * Apply no-color to warnings from DeprecatedCommands as well * Add OutputWithFormat to support arbitrary data, add format option to auth list * Add ability to output arbitrary list data on TableFormatter * Clear up switch logic on format * Add format option for list-related commands * Add format option to rest of commands that returns a client API response * Remove initOutputYAML and initOutputJSON, and use OutputWithFormat instead * Remove outputAsYAML and outputAsJSON, and use OutputWithFormat instead * Remove -no-color flag, use env var exclusively to toggle colored output * Fix compile * Remove -no-color flag in main.go * Add missing FlagSetOutputFormat * Fix generate-root/decode test * Migrate init functions to main.go * Add no-color flag back as hidden * Handle non-supported data types for TableFormatter.OutputList * Pull formatting much further up to remove the need to use c.flagFormat (#3950) * Pull formatting much further up to remove the need to use c.flagFormat Also remove OutputWithFormat as the logic can cause issues. * Use const for env var * Minor updates * Remove unnecessary check * Fix SSH output and some tests * Fix tests * Make race detector not run on generate root since it kills Travis these days * Update docs * Update docs * Address review feedback * Handle --format as well as -format
2018-02-12 23:12:16 +00:00
return c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
2017-09-05 04:02:09 +00:00
}
2017-09-08 02:03:12 +00:00
func (c *OperatorKeyStatusCommand) AutocompleteArgs() complete.Predictor {
2017-09-05 04:02:09 +00:00
return nil
}
2017-09-08 02:03:12 +00:00
func (c *OperatorKeyStatusCommand) AutocompleteFlags() complete.Flags {
2017-09-05 04:02:09 +00:00
return c.Flags().Completions()
}
2017-09-08 02:03:12 +00:00
func (c *OperatorKeyStatusCommand) Run(args []string) int {
2017-09-05 04:02:09 +00:00
f := c.Flags()
if err := f.Parse(args); err != nil {
c.UI.Error(err.Error())
return 1
}
args = f.Args()
if len(args) > 0 {
c.UI.Error(fmt.Sprintf("Too many arguments (expected 0, got %d)", len(args)))
return 1
}
client, err := c.Client()
if err != nil {
2017-09-05 04:02:09 +00:00
c.UI.Error(err.Error())
return 2
}
status, err := client.Sys().KeyStatus()
if err != nil {
2017-09-05 04:02:09 +00:00
c.UI.Error(fmt.Sprintf("Error reading key status: %s", err))
return 2
}
CLI Enhancements (#3897) * Use Colored UI if stdout is a tty * Add format options to operator unseal * Add format test on operator unseal * Add -no-color output flag, and use BasicUi if no-color flag is provided * Move seal status formatting logic to OutputSealStatus * Apply no-color to warnings from DeprecatedCommands as well * Add OutputWithFormat to support arbitrary data, add format option to auth list * Add ability to output arbitrary list data on TableFormatter * Clear up switch logic on format * Add format option for list-related commands * Add format option to rest of commands that returns a client API response * Remove initOutputYAML and initOutputJSON, and use OutputWithFormat instead * Remove outputAsYAML and outputAsJSON, and use OutputWithFormat instead * Remove -no-color flag, use env var exclusively to toggle colored output * Fix compile * Remove -no-color flag in main.go * Add missing FlagSetOutputFormat * Fix generate-root/decode test * Migrate init functions to main.go * Add no-color flag back as hidden * Handle non-supported data types for TableFormatter.OutputList * Pull formatting much further up to remove the need to use c.flagFormat (#3950) * Pull formatting much further up to remove the need to use c.flagFormat Also remove OutputWithFormat as the logic can cause issues. * Use const for env var * Minor updates * Remove unnecessary check * Fix SSH output and some tests * Fix tests * Make race detector not run on generate root since it kills Travis these days * Update docs * Update docs * Address review feedback * Handle --format as well as -format
2018-02-12 23:12:16 +00:00
switch Format(c.UI) {
case "table":
c.UI.Output(printKeyStatus(status))
return 0
default:
return OutputData(c.UI, status)
}
}