mirror of https://github.com/status-im/consul.git
321 lines
10 KiB
Go
321 lines
10 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package roleupdate
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/mitchellh/cli"
|
|
|
|
"github.com/hashicorp/consul/api"
|
|
"github.com/hashicorp/consul/command/acl"
|
|
"github.com/hashicorp/consul/command/acl/role"
|
|
"github.com/hashicorp/consul/command/flags"
|
|
)
|
|
|
|
func New(ui cli.Ui) *cmd {
|
|
c := &cmd{UI: ui}
|
|
c.init()
|
|
return c
|
|
}
|
|
|
|
type cmd struct {
|
|
UI cli.Ui
|
|
flags *flag.FlagSet
|
|
http *flags.HTTPFlags
|
|
help string
|
|
|
|
roleID string
|
|
name string
|
|
description string
|
|
policyIDs []string
|
|
policyNames []string
|
|
serviceIdents []string
|
|
nodeIdents []string
|
|
appendTemplatedPolicy string
|
|
replaceTemplatedPolicy string
|
|
appendTemplatedPolicyFile string
|
|
replaceTemplatedPolicyFile string
|
|
templatedPolicyVariables []string
|
|
|
|
noMerge bool
|
|
showMeta bool
|
|
format string
|
|
}
|
|
|
|
func (c *cmd) init() {
|
|
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
|
|
c.flags.BoolVar(&c.showMeta, "meta", false, "Indicates that role metadata such "+
|
|
"as the content hash and raft indices should be shown for each entry")
|
|
c.flags.StringVar(&c.roleID, "id", "", "The ID of the role to update. "+
|
|
"It may be specified as a unique ID prefix but will error if the prefix "+
|
|
"matches multiple role IDs")
|
|
c.flags.StringVar(&c.name, "name", "", "The role name.")
|
|
c.flags.StringVar(&c.description, "description", "", "A description of the role")
|
|
c.flags.Var((*flags.AppendSliceValue)(&c.policyIDs), "policy-id", "ID of a "+
|
|
"policy to use for this role. May be specified multiple times")
|
|
c.flags.Var((*flags.AppendSliceValue)(&c.policyNames), "policy-name", "Name of a "+
|
|
"policy to use for this role. May be specified multiple times")
|
|
c.flags.Var((*flags.AppendSliceValue)(&c.serviceIdents), "service-identity", "Name of a "+
|
|
"service identity to use for this role. May be specified multiple times. Format is "+
|
|
"the SERVICENAME or SERVICENAME:DATACENTER1,DATACENTER2,...")
|
|
c.flags.Var((*flags.AppendSliceValue)(&c.nodeIdents), "node-identity", "Name of a "+
|
|
"node identity to use for this role. May be specified multiple times. Format is "+
|
|
"NODENAME:DATACENTER")
|
|
c.flags.BoolVar(&c.noMerge, "no-merge", false, "Do not merge the current role "+
|
|
"information with what is provided to the command. Instead overwrite all fields "+
|
|
"with the exception of the role ID which is immutable.")
|
|
c.flags.StringVar(
|
|
&c.format,
|
|
"format",
|
|
role.PrettyFormat,
|
|
fmt.Sprintf("Output format {%s}", strings.Join(role.GetSupportedFormats(), "|")),
|
|
)
|
|
c.flags.Var((*flags.AppendSliceValue)(&c.templatedPolicyVariables), "var", "Templated policy variables."+
|
|
" Must be used in combination with -append-templated-policy or -replace-templated-policy flags to specify required variables."+
|
|
" May be specified multiple times with different variables."+
|
|
" Format is VariableName:Value")
|
|
c.flags.StringVar(&c.appendTemplatedPolicy, "append-templated-policy", "", "The templated policy name to attach to the role's existing templated policies list. Use -var flag to specify variables when required."+
|
|
" The role retains existing templated policies.")
|
|
c.flags.StringVar(&c.replaceTemplatedPolicy, "replace-templated-policy", "", "The templated policy name to replace the existing templated policies list with. Use -var flag to specify variables when required."+
|
|
" Overwrites the role's existing templated policies.")
|
|
c.flags.StringVar(&c.appendTemplatedPolicyFile, "append-templated-policy-file", "", "Path to a file containing templated policies and variables. Works like `-append-templated-policy`. The role retains existing templated policies.")
|
|
c.flags.StringVar(&c.replaceTemplatedPolicyFile, "replace-templated-policy-file", "", "Path to a file containing templated policies and variables. Works like `-replace-templated-policy`. Overwrites the role's existing templated policies.")
|
|
|
|
c.http = &flags.HTTPFlags{}
|
|
flags.Merge(c.flags, c.http.ClientFlags())
|
|
flags.Merge(c.flags, c.http.ServerFlags())
|
|
flags.Merge(c.flags, c.http.MultiTenancyFlags())
|
|
c.help = flags.Usage(help, c.flags)
|
|
}
|
|
|
|
func (c *cmd) Run(args []string) int {
|
|
if err := c.flags.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
if c.roleID == "" {
|
|
c.UI.Error(fmt.Sprintf("Cannot update a role without specifying the -id parameter"))
|
|
return 1
|
|
}
|
|
|
|
client, err := c.http.APIClient()
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err))
|
|
return 1
|
|
}
|
|
|
|
roleID, err := acl.GetRoleIDFromPartial(client, c.roleID)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error determining role ID: %v", err))
|
|
return 1
|
|
}
|
|
|
|
parsedServiceIdents, err := acl.ExtractServiceIdentities(c.serviceIdents)
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
parsedNodeIdents, err := acl.ExtractNodeIdentities(c.nodeIdents)
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
hasAppendTemplatedPolicies := len(c.appendTemplatedPolicy) > 0 || len(c.appendTemplatedPolicyFile) > 0
|
|
hasReplaceTemplatedPolicies := len(c.replaceTemplatedPolicy) > 0 || len(c.replaceTemplatedPolicyFile) > 0
|
|
|
|
if hasReplaceTemplatedPolicies && hasAppendTemplatedPolicies {
|
|
c.UI.Error("Cannot combine the use of append-templated-policy flags with replace-templated-policy. " +
|
|
"To set or overwrite existing templated policies, use -replace-templated-policy or -replace-templated-policy-file. " +
|
|
"To append to existing templated policies, use -append-templated-policy or -append-templated-policy-file.")
|
|
return 1
|
|
}
|
|
parsedTemplatedPolicies, err := acl.ExtractTemplatedPolicies(c.replaceTemplatedPolicy, c.replaceTemplatedPolicyFile, c.templatedPolicyVariables)
|
|
if hasAppendTemplatedPolicies {
|
|
parsedTemplatedPolicies, err = acl.ExtractTemplatedPolicies(c.appendTemplatedPolicy, c.appendTemplatedPolicyFile, c.templatedPolicyVariables)
|
|
}
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
// Read the current role in both cases so we can fail better if not found.
|
|
currentRole, _, err := client.ACL().RoleRead(roleID, nil)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error when retrieving current role: %v", err))
|
|
return 1
|
|
} else if currentRole == nil {
|
|
c.UI.Error(fmt.Sprintf("Role not found with ID %q", roleID))
|
|
return 1
|
|
}
|
|
|
|
var r *api.ACLRole
|
|
if c.noMerge {
|
|
r = &api.ACLRole{
|
|
ID: c.roleID,
|
|
Name: c.name,
|
|
Description: c.description,
|
|
ServiceIdentities: parsedServiceIdents,
|
|
NodeIdentities: parsedNodeIdents,
|
|
TemplatedPolicies: parsedTemplatedPolicies,
|
|
}
|
|
|
|
for _, policyName := range c.policyNames {
|
|
// We could resolve names to IDs here but there isn't any reason
|
|
// why its would be better than allowing the agent to do it.
|
|
r.Policies = append(r.Policies, &api.ACLRolePolicyLink{Name: policyName})
|
|
}
|
|
|
|
for _, policyID := range c.policyIDs {
|
|
policyID, err := acl.GetPolicyIDFromPartial(client, policyID)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error resolving policy ID %s: %v", policyID, err))
|
|
return 1
|
|
}
|
|
r.Policies = append(r.Policies, &api.ACLRolePolicyLink{ID: policyID})
|
|
}
|
|
} else {
|
|
r = currentRole
|
|
|
|
if c.name != "" {
|
|
r.Name = c.name
|
|
}
|
|
if c.description != "" {
|
|
r.Description = c.description
|
|
}
|
|
|
|
for _, policyName := range c.policyNames {
|
|
found := false
|
|
for _, link := range r.Policies {
|
|
if link.Name == policyName {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
|
|
if !found {
|
|
// We could resolve names to IDs here but there isn't any
|
|
// reason why its would be better than allowing the agent to do
|
|
// it.
|
|
r.Policies = append(r.Policies, &api.ACLRolePolicyLink{Name: policyName})
|
|
}
|
|
}
|
|
|
|
for _, policyID := range c.policyIDs {
|
|
policyID, err := acl.GetPolicyIDFromPartial(client, policyID)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error resolving policy ID %s: %v", policyID, err))
|
|
return 1
|
|
}
|
|
found := false
|
|
|
|
for _, link := range r.Policies {
|
|
if link.ID == policyID {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
|
|
if !found {
|
|
r.Policies = append(r.Policies, &api.ACLRolePolicyLink{ID: policyID})
|
|
}
|
|
}
|
|
|
|
for _, svcid := range parsedServiceIdents {
|
|
found := -1
|
|
for i, link := range r.ServiceIdentities {
|
|
if link.ServiceName == svcid.ServiceName {
|
|
found = i
|
|
break
|
|
}
|
|
}
|
|
|
|
if found != -1 {
|
|
r.ServiceIdentities[found] = svcid
|
|
} else {
|
|
r.ServiceIdentities = append(r.ServiceIdentities, svcid)
|
|
}
|
|
}
|
|
|
|
for _, nodeid := range parsedNodeIdents {
|
|
found := false
|
|
for _, link := range r.NodeIdentities {
|
|
if link.NodeName == nodeid.NodeName && link.Datacenter != nodeid.Datacenter {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
|
|
if !found {
|
|
r.NodeIdentities = append(r.NodeIdentities, nodeid)
|
|
}
|
|
}
|
|
|
|
if hasReplaceTemplatedPolicies {
|
|
r.TemplatedPolicies = parsedTemplatedPolicies
|
|
} else {
|
|
r.TemplatedPolicies = append(r.TemplatedPolicies, parsedTemplatedPolicies...)
|
|
}
|
|
}
|
|
|
|
r, _, err = client.ACL().RoleUpdate(r, nil)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error updating role %q: %v", roleID, err))
|
|
return 1
|
|
}
|
|
|
|
formatter, err := role.NewFormatter(c.format, c.showMeta)
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
out, err := formatter.FormatRole(r)
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
if out != "" {
|
|
c.UI.Info(out)
|
|
}
|
|
|
|
return 0
|
|
}
|
|
|
|
func (c *cmd) Synopsis() string {
|
|
return synopsis
|
|
}
|
|
|
|
func (c *cmd) Help() string {
|
|
return flags.Usage(c.help, nil)
|
|
}
|
|
|
|
const (
|
|
synopsis = "Update an ACL role"
|
|
help = `
|
|
Usage: consul acl role update [options]
|
|
|
|
Updates a role. By default it will merge the role information with its
|
|
current state so that you do not have to provide all parameters. This
|
|
behavior can be disabled by passing -no-merge.
|
|
|
|
Rename the role:
|
|
|
|
$ consul acl role update -id abcd -name "better-name"
|
|
|
|
Update all editable fields of the role:
|
|
|
|
$ consul acl role update -id abcd \
|
|
-name "better-name" \
|
|
-description "replication" \
|
|
-policy-name "token-replication" \
|
|
-service-identity "web" \
|
|
-templated-policy "builtin/service" \
|
|
-var "name:api"
|
|
`
|
|
)
|