open-consul/command/keyring.go

234 lines
6.3 KiB
Go
Raw Normal View History

package command
import (
"flag"
"fmt"
"strings"
"github.com/hashicorp/consul/command/agent"
"github.com/mitchellh/cli"
)
// KeyringCommand is a Command implementation that handles querying, installing,
// and removing gossip encryption keys from a keyring.
type KeyringCommand struct {
Ui cli.Ui
}
func (c *KeyringCommand) Run(args []string) int {
2015-07-07 16:30:34 +00:00
var installKey, useKey, removeKey, token string
var listKeys bool
var relay int
cmdFlags := flag.NewFlagSet("keys", flag.ContinueOnError)
cmdFlags.Usage = func() { c.Ui.Output(c.Help()) }
cmdFlags.StringVar(&installKey, "install", "", "install key")
cmdFlags.StringVar(&useKey, "use", "", "use key")
cmdFlags.StringVar(&removeKey, "remove", "", "remove key")
cmdFlags.BoolVar(&listKeys, "list", false, "list keys")
2015-07-07 16:30:34 +00:00
cmdFlags.StringVar(&token, "token", "", "acl token")
cmdFlags.IntVar(&relay, "relay-factor", 0, "relay factor")
rpcAddr := RPCAddrFlag(cmdFlags)
if err := cmdFlags.Parse(args); err != nil {
return 1
}
c.Ui = &cli.PrefixedUi{
OutputPrefix: "",
InfoPrefix: "==> ",
ErrorPrefix: "",
Ui: c.Ui,
}
// Only accept a single argument
found := listKeys
for _, arg := range []string{installKey, useKey, removeKey} {
if found && len(arg) > 0 {
c.Ui.Error("Only a single action is allowed")
return 1
}
found = found || len(arg) > 0
}
// Fail fast if no actionable args were passed
if !found {
c.Ui.Error(c.Help())
return 1
}
// Validate the relay factor
relayFactor, err := agent.ParseRelayFactor(relay)
if err != nil {
c.Ui.Error(fmt.Sprintf("Error parsing relay factor: %s", err))
return 1
}
// All other operations will require a client connection
client, err := RPCClient(*rpcAddr)
if err != nil {
c.Ui.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err))
return 1
}
defer client.Close()
if listKeys {
c.Ui.Info("Gathering installed encryption keys...")
r, err := client.ListKeys(token, relayFactor)
2014-09-28 20:33:37 +00:00
if err != nil {
c.Ui.Error(fmt.Sprintf("error: %s", err))
return 1
}
2014-09-30 22:31:07 +00:00
if rval := c.handleResponse(r.Info, r.Messages); rval != 0 {
2014-09-28 20:33:37 +00:00
return rval
}
2014-09-30 22:31:07 +00:00
c.handleList(r.Info, r.Keys)
2014-09-28 20:33:37 +00:00
return 0
}
if installKey != "" {
c.Ui.Info("Installing new gossip encryption key...")
r, err := client.InstallKey(installKey, token, relayFactor)
2014-09-28 19:35:51 +00:00
if err != nil {
c.Ui.Error(fmt.Sprintf("error: %s", err))
return 1
2014-09-09 06:25:38 +00:00
}
2014-09-30 22:31:07 +00:00
return c.handleResponse(r.Info, r.Messages)
}
if useKey != "" {
c.Ui.Info("Changing primary gossip encryption key...")
r, err := client.UseKey(useKey, token, relayFactor)
2014-09-28 19:35:51 +00:00
if err != nil {
c.Ui.Error(fmt.Sprintf("error: %s", err))
return 1
}
2014-09-30 22:31:07 +00:00
return c.handleResponse(r.Info, r.Messages)
}
if removeKey != "" {
c.Ui.Info("Removing gossip encryption key...")
r, err := client.RemoveKey(removeKey, token, relayFactor)
2014-09-28 19:35:51 +00:00
if err != nil {
c.Ui.Error(fmt.Sprintf("error: %s", err))
return 1
}
2014-09-30 22:31:07 +00:00
return c.handleResponse(r.Info, r.Messages)
}
// Should never make it here
return 0
}
2014-09-28 19:35:51 +00:00
func (c *KeyringCommand) handleResponse(
info []agent.KeyringInfo,
2014-09-30 22:31:07 +00:00
messages []agent.KeyringMessage) int {
2014-09-28 19:35:51 +00:00
var rval int
2014-09-28 19:35:51 +00:00
for _, i := range info {
if i.Error != "" {
pool := i.Pool
if pool != "WAN" {
pool = i.Datacenter + " (LAN)"
}
2014-09-28 19:35:51 +00:00
c.Ui.Error("")
c.Ui.Error(fmt.Sprintf("%s error: %s", pool, i.Error))
for _, msg := range messages {
if msg.Datacenter != i.Datacenter || msg.Pool != i.Pool {
continue
}
c.Ui.Error(fmt.Sprintf(" %s: %s", msg.Node, msg.Message))
}
2014-09-28 19:35:51 +00:00
rval = 1
}
}
2014-09-28 20:33:37 +00:00
if rval == 0 {
c.Ui.Info("Done!")
}
2014-09-28 19:35:51 +00:00
return rval
}
2014-09-28 20:33:37 +00:00
func (c *KeyringCommand) handleList(
info []agent.KeyringInfo,
keys []agent.KeyringEntry) {
installed := make(map[string]map[string][]int)
for _, key := range keys {
var nodes int
for _, i := range info {
if i.Datacenter == key.Datacenter && i.Pool == key.Pool {
nodes = i.NumNodes
}
}
2014-09-28 19:35:51 +00:00
2014-09-28 20:33:37 +00:00
pool := key.Pool
if pool != "WAN" {
pool = key.Datacenter + " (LAN)"
2014-09-28 19:35:51 +00:00
}
2014-09-28 20:33:37 +00:00
if _, ok := installed[pool]; !ok {
installed[pool] = map[string][]int{key.Key: []int{key.Count, nodes}}
} else {
installed[pool][key.Key] = []int{key.Count, nodes}
2014-09-28 19:35:51 +00:00
}
}
2014-09-28 20:33:37 +00:00
for pool, keys := range installed {
c.Ui.Output("")
c.Ui.Output(pool + ":")
for key, num := range keys {
c.Ui.Output(fmt.Sprintf(" %s [%d/%d]", key, num[0], num[1]))
2014-09-28 19:35:51 +00:00
}
}
}
func (c *KeyringCommand) Help() string {
helpText := `
Usage: consul keyring [options]
Manages encryption keys used for gossip messages. Gossip encryption is
optional. When enabled, this command may be used to examine active encryption
keys in the cluster, add new keys, and remove old ones. When combined, this
functionality provides the ability to perform key rotation cluster-wide,
without disrupting the cluster.
2014-10-05 20:43:56 +00:00
All operations performed by this command can only be run against server nodes,
and affect both the LAN and WAN keyrings in lock-step.
All variations of the keyring command return 0 if all nodes reply and there
are no errors. If any node fails to reply or reports failure, the exit code
will be 1.
Options:
-install=<key> Install a new encryption key. This will broadcast
the new key to all members in the cluster.
2015-07-07 16:30:34 +00:00
-list List all keys currently in use within the cluster.
-remove=<key> Remove the given key from the cluster. This
operation may only be performed on keys which are
not currently the primary key.
2015-07-07 16:30:34 +00:00
-token="" ACL token to use during requests. Defaults to that
of the agent.
-relay-factor Added in Consul 0.7.4, setting this to a non-zero
value will cause nodes to relay their response to
the operation through this many randomly-chosen
other nodes in the cluster. The maximum allowed
value is 5.
2015-07-07 16:30:34 +00:00
-use=<key> Change the primary encryption key, which is used to
encrypt messages. The key must already be installed
before this operation can succeed.
-rpc-addr=127.0.0.1:8400 RPC address of the Consul agent.
`
return strings.TrimSpace(helpText)
}
func (c *KeyringCommand) Synopsis() string {
return "Manages gossip layer encryption keys"
}