2023-03-15 19:00:52 +03:00
|
|
|
// Copyright (c) HashiCorp, Inc.
|
2024-01-02 21:36:20 +03:00
|
|
|
// SPDX-License-Identifier: BUSL-1.1
|
2023-03-15 19:00:52 +03:00
|
|
|
|
2015-05-28 20:16:33 +03:00
|
|
|
package command
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"strings"
|
2016-04-01 20:16:05 +03:00
|
|
|
|
2017-09-05 07:04:12 +03:00
|
|
|
"github.com/mitchellh/cli"
|
|
|
|
"github.com/posener/complete"
|
2015-05-28 20:16:33 +03:00
|
|
|
)
|
|
|
|
|
2021-04-08 19:43:39 +03:00
|
|
|
var (
|
|
|
|
_ cli.Command = (*OperatorRotateCommand)(nil)
|
|
|
|
_ cli.CommandAutocomplete = (*OperatorRotateCommand)(nil)
|
|
|
|
)
|
2017-09-05 07:04:12 +03:00
|
|
|
|
2017-09-08 05:03:12 +03:00
|
|
|
type OperatorRotateCommand struct {
|
2017-09-05 07:04:12 +03:00
|
|
|
*BaseCommand
|
|
|
|
}
|
|
|
|
|
2017-09-08 05:03:12 +03:00
|
|
|
func (c *OperatorRotateCommand) Synopsis() string {
|
2017-09-05 07:04:12 +03:00
|
|
|
return "Rotates the underlying encryption key"
|
|
|
|
}
|
|
|
|
|
2017-09-08 05:03:12 +03:00
|
|
|
func (c *OperatorRotateCommand) Help() string {
|
2017-09-05 07:04:12 +03:00
|
|
|
helpText := `
|
2018-06-07 07:11:21 +03:00
|
|
|
Usage: vault operator rotate [options]
|
2017-09-05 07:04:12 +03:00
|
|
|
|
|
|
|
Rotates the underlying encryption key which is used to secure data written
|
|
|
|
to the storage backend. This installs a new key in the key ring. This new
|
|
|
|
key is used to encrypted new data, while older keys in the ring are used to
|
|
|
|
decrypt older data.
|
|
|
|
|
|
|
|
This is an online operation and does not cause downtime. This command is run
|
2017-09-08 05:03:12 +03:00
|
|
|
per-cluster (not per-server), since Vault servers in HA mode share the same
|
|
|
|
storage backend.
|
2017-09-05 07:04:12 +03:00
|
|
|
|
|
|
|
Rotate Vault's encryption key:
|
|
|
|
|
2018-06-07 07:11:21 +03:00
|
|
|
$ vault operator rotate
|
2017-09-05 07:04:12 +03:00
|
|
|
|
|
|
|
For a full list of examples, please see the documentation.
|
|
|
|
|
|
|
|
` + c.Flags().Help()
|
|
|
|
|
|
|
|
return strings.TrimSpace(helpText)
|
|
|
|
}
|
|
|
|
|
2017-09-08 05:03:12 +03:00
|
|
|
func (c *OperatorRotateCommand) Flags() *FlagSets {
|
2018-02-13 02:12:16 +03:00
|
|
|
return c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
|
2017-09-05 07:04:12 +03:00
|
|
|
}
|
|
|
|
|
2017-09-08 05:03:12 +03:00
|
|
|
func (c *OperatorRotateCommand) AutocompleteArgs() complete.Predictor {
|
2017-09-05 07:04:12 +03:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2017-09-08 05:03:12 +03:00
|
|
|
func (c *OperatorRotateCommand) AutocompleteFlags() complete.Flags {
|
2017-09-05 07:04:12 +03:00
|
|
|
return c.Flags().Completions()
|
2015-05-28 20:16:33 +03:00
|
|
|
}
|
|
|
|
|
2017-09-08 05:03:12 +03:00
|
|
|
func (c *OperatorRotateCommand) Run(args []string) int {
|
2017-09-05 07:04:12 +03: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)))
|
2015-05-28 20:16:33 +03:00
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
|
|
|
client, err := c.Client()
|
|
|
|
if err != nil {
|
2017-09-05 07:04:12 +03:00
|
|
|
c.UI.Error(err.Error())
|
2015-05-28 20:16:33 +03:00
|
|
|
return 2
|
|
|
|
}
|
|
|
|
|
|
|
|
// Rotate the key
|
|
|
|
err = client.Sys().Rotate()
|
|
|
|
if err != nil {
|
2017-09-05 07:04:12 +03:00
|
|
|
c.UI.Error(fmt.Sprintf("Error rotating key: %s", err))
|
2015-05-28 20:16:33 +03:00
|
|
|
return 2
|
|
|
|
}
|
|
|
|
|
|
|
|
// Print the key status
|
|
|
|
status, err := client.Sys().KeyStatus()
|
|
|
|
if err != nil {
|
2017-09-05 07:04:12 +03:00
|
|
|
c.UI.Error(fmt.Sprintf("Error reading key status: %s", err))
|
2015-05-28 20:16:33 +03:00
|
|
|
return 2
|
|
|
|
}
|
|
|
|
|
2018-02-13 02:12:16 +03:00
|
|
|
switch Format(c.UI) {
|
|
|
|
case "table":
|
|
|
|
c.UI.Output("Success! Rotated key")
|
|
|
|
c.UI.Output("")
|
|
|
|
c.UI.Output(printKeyStatus(status))
|
|
|
|
return 0
|
|
|
|
default:
|
|
|
|
return OutputData(c.UI, status)
|
|
|
|
}
|
2015-05-28 20:16:33 +03:00
|
|
|
}
|