Skip to content

state: do not treat short hex node names as UUID prefixes #23865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShravanthReddy wants to merge 1 commit into
base: main
Choose a base branch
from
+38 −6
Open

state: do not treat short hex node names as UUID prefixes #23865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/23865.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
state: do not treat short hex node names as UUID prefixes
```
14 changes: 8 additions & 6 deletions agent/consul/state/catalog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,11 @@ const (
)

const (
// minUUIDLookupLen is used as a minimum length of a node name required before
// we test to see if the name is actually a UUID and perform an ID-based node
// lookup.
minUUIDLookupLen = 2
// minUUIDLookupLen is the minimum UUID prefix length after
// resizeNodeLookupKey before we do an ID-based node lookup.
// A floor of 2 let odd-length names like "ba1" shrink to "ba"
// and match unrelated node IDs.
minUUIDLookupLen = 8
)

var (
Expand Down Expand Up @@ -1882,14 +1883,15 @@ func (s *Store) nodeServices(ws memdb.WatchSet, nodeNameOrID string, entMeta *ac
if n != nil {
ws.Add(watchCh)
} else {
if len(nodeNameOrID) < minUUIDLookupLen {
uuidPrefix := resizeNodeLookupKey(nodeNameOrID)
if len(uuidPrefix) < minUUIDLookupLen {
ws.Add(watchCh)
return true, 0, nil, nil, nil
}

// Attempt to lookup the node by its node ID
iter, err := tx.Get(tableNodes, indexUUID+"_prefix", Query{
Value: resizeNodeLookupKey(nodeNameOrID),
Value: uuidPrefix,
EnterpriseMeta: *entMeta,
PeerName: peerName,
})
Expand Down
27 changes: 27 additions & 0 deletions agent/consul/state/catalog_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1746,6 +1746,33 @@ func TestStateStore_NodeServices(t *testing.T) {
require.NotNil(t, ns)
require.Equal(t, "node2", ns.Node.Node)
})

// Missing "ba1" must not match a node whose ID starts with ba… (GH-23724).
t.Run("Missing short hex name does not match UUID prefix", func(t *testing.T) {
req := &structs.RegisterRequest{
ID: types.NodeID("ba1e4a74-2192-161a-0510-cccccccccccc"),
Node: "other-host",
Address: "9.10.11.12",
}
require.NoError(t, s.EnsureRegistration(3, req))

{
_, ns, err := s.NodeServices(nil, "other-host", nil, "")
require.NoError(t, err)
require.NotNil(t, ns)
require.Equal(t, "other-host", ns.Node.Node)
}
{
_, ns, err := s.NodeServices(nil, "ba1e4a74-2192-161a-0510-cccccccccccc", nil, "")
require.NoError(t, err)
require.NotNil(t, ns)
require.Equal(t, "other-host", ns.Node.Node)
}

_, ns, err := s.NodeServices(nil, "ba1", nil, "")
require.NoError(t, err)
require.Nil(t, ns)
})
}

func TestStateStore_DeleteNode(t *testing.T) {
Expand Down
Loading