Skip to content

Commit

Permalink
Backport of Fix policy lookup to allow for slashes into release/1.16.x (
Browse files Browse the repository at this point in the history
#18372)

* backport of commit 1a9cded

* backport of commit cfec746

* backport of commit 8a9db4c

* backport of commit ac13bf1

---------

Co-authored-by: Jeremy Jacobson <jeremy.jacobson@hashicorp.com>
  • Loading branch information
hc-github-team-consul-core and jjacobson93 committed Aug 3, 2023
1 parent a014854 commit 53355c8
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 2 deletions.
7 changes: 7 additions & 0 deletions agent/acl_endpoint.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package agent
import (
"fmt"
"net/http"
"net/url"
"strings"

"github.com/hashicorp/consul/acl"
Expand Down Expand Up @@ -145,6 +146,12 @@ func (s *HTTPHandlers) ACLPolicyCRUD(resp http.ResponseWriter, req *http.Request
}

func (s *HTTPHandlers) ACLPolicyRead(resp http.ResponseWriter, req *http.Request, policyID, policyName string) (interface{}, error) {
// policy name needs to be unescaped in case there were `/` characters
policyName, err := url.QueryUnescape(policyName)
if err != nil {
return nil, err
}

args := structs.ACLPolicyGetRequest{
Datacenter: s.agent.config.Datacenter,
PolicyID: policyID,
Expand Down
12 changes: 10 additions & 2 deletions command/acl/acl_helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,17 @@ func GetTokenAccessorIDFromPartial(client *api.Client, partialAccessorID string)
}

func GetPolicyIDFromPartial(client *api.Client, partialID string) (string, error) {
if partialID == "global-management" {
return structs.ACLPolicyGlobalManagementID, nil
// try the builtin policies (by name) first
for _, policy := range structs.ACLBuiltinPolicies {
if partialID == policy.Name {
return policy.ID, nil
}
}

if policy, ok := structs.ACLBuiltinPolicies[partialID]; ok {
return policy.ID, nil
}

// The full UUID string was given
if len(partialID) == 36 {
return partialID, nil
Expand Down
83 changes: 83 additions & 0 deletions command/acl/acl_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package acl

import (
"fmt"
"io"
"testing"

"github.com/hashicorp/consul/agent"
"github.com/hashicorp/consul/agent/structs"
"github.com/hashicorp/consul/testrpc"
"github.com/stretchr/testify/require"
)

func Test_GetPolicyIDByName_Builtins(t *testing.T) {
t.Parallel()

a := agent.StartTestAgent(t,
agent.TestAgent{
LogOutput: io.Discard,
HCL: `
primary_datacenter = "dc1"
acl {
enabled = true
tokens {
initial_management = "root"
}
}
`,
},
)

defer a.Shutdown()
testrpc.WaitForTestAgent(t, a.RPC, "dc1", testrpc.WithToken("root"))

client := a.Client()
client.AddHeader("X-Consul-Token", "root")

for _, policy := range structs.ACLBuiltinPolicies {
name := fmt.Sprintf("%s policy", policy.Name)
t.Run(name, func(t *testing.T) {
id, err := GetPolicyIDByName(client, policy.Name)
require.NoError(t, err)
require.Equal(t, policy.ID, id)
})
}
}

func Test_GetPolicyIDFromPartial_Builtins(t *testing.T) {
t.Parallel()

a := agent.StartTestAgent(t,
agent.TestAgent{
LogOutput: io.Discard,
HCL: `
primary_datacenter = "dc1"
acl {
enabled = true
tokens {
initial_management = "root"
}
}
`,
},
)

defer a.Shutdown()
testrpc.WaitForTestAgent(t, a.RPC, "dc1", testrpc.WithToken("root"))

client := a.Client()
client.AddHeader("X-Consul-Token", "root")

for _, policy := range structs.ACLBuiltinPolicies {
name := fmt.Sprintf("%s policy", policy.Name)
t.Run(name, func(t *testing.T) {
id, err := GetPolicyIDFromPartial(client, policy.Name)
require.NoError(t, err)
require.Equal(t, policy.ID, id)
})
}
}

0 comments on commit 53355c8

Please sign in to comment.