Skip to content

ldap getUserDN handle multiple users #151

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

Merged
merged 5 commits into from
Jan 6, 2025
Merged

ldap getUserDN handle multiple users #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
47af38c
ensure one result entry in getUserDN
helenfufu Jan 3, 2025
32d34d3
add failed-with-anon-bind-upn-domain-multiple-users-returned test cas…
helenfufu Jan 3, 2025
0d3267c
add unit tests for getUserDN
helenfufu Jan 4, 2025
966e135
add unit tests for getUserBindDN
helenfufu Jan 4, 2025
6fa6450
use single test directory with duplicated user instead of multiple te…
helenfufu Jan 6, 2025
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
5 changes: 3 additions & 2 deletions ldap/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,9 +736,10 @@ func (c *Client) getUserDN(bindDN, username string) (string, error) {
if err != nil {
return userDN, fmt.Errorf("%s: LDAP search failed for detecting user (baseDN: %q / filter: %q): %w", op, c.conf.UserDN, filter, err)
}
for _, e := range result.Entries {
userDN = e.DN
if len(result.Entries) != 1 {
return "", fmt.Errorf("%s: LDAP search for user 0 or not unique", op)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a potential breaking change for users. We should get guidance from the cap library owners on how to proceed. In the past we have added config fields to toggle on any new behavior that breaks backwards compatibility.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for raising, @fairclothjm! (And out of curiosity, any chance you have an example of this toggle pattern used in practice for previous breaking changes in this library?)

@johanbrandhorst @jimlambrt could we get some guidance on the preferred approach to introduce this potential breaking change?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will defer to Jim for the definite recommendation, but this seems to me only to be a breaking change in the case we actually care about - where the security issue exists. That seems enough to me to justify making this change without an option to turn it off.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @johanbrandhorst -- I don't think we should offer an option to opt-in or out.

}
userDN = result.Entries[0].DN
} else {
userDN = bindDN
}
Expand Down
26 changes: 26 additions & 0 deletions ldap/client_exported_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,15 @@ func TestClient_Authenticate(t *testing.T) {
testdirectory.WithDefaults(t, &testdirectory.Defaults{UPNDomain: "example.com"}),
testdirectory.WithMembersOf(t, "admin"))...,
)
// Set up a duplicated user to test the case where the search returns multiple users
users = append(
users,
testdirectory.NewUsers(
t,
[]string{"mallory", "mallory"},
testdirectory.WithDefaults(t, &testdirectory.Defaults{UPNDomain: "example.com"}),
)...,
)
// add some attributes that we always want to filter out of an AuthResult,
// so if we ever start seeing tests fail because of them; we know that we've
// messed up the default filtering
Expand All @@ -59,6 +68,7 @@ func TestClient_Authenticate(t *testing.T) {
td.SetUsers(users...)
td.SetGroups(groups...)
td.SetTokenGroups(tokenGroups)

tests := []struct {
name string
username string
Expand Down Expand Up @@ -509,6 +519,22 @@ func TestClient_Authenticate(t *testing.T) {
opts: []ldap.Option{ldap.WithGroups(), ldap.WithEmptyAnonymousGroupSearch()},
wantGroups: []string{groups[0].DN},
},
{
name: "failed-with-anon-bind-upn-domain-multiple-users-returned",
username: "mallory",
password: "password",
clientConfig: &ldap.ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
DiscoverDN: true,
UserDN: testdirectory.DefaultUserDN,
GroupDN: testdirectory.DefaultGroupDN,
UPNDomain: "example.com",
},
opts: []ldap.Option{ldap.WithGroups()},
wantErr: true,
wantErrContains: "LDAP search for binddn 0 or not unique",
},
Comment on lines +522 to +537
Copy link
Collaborator Author

@helenfufu helenfufu Jan 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test covers the failure path for multiple search results during the getUserBindDN call in Authenticate.

For context, I also tried adding another case that somehow could pass with a single search result in getUserBindDN then fail with multiple search results in getUserDN, but I wasn't able to find a test setup that would follow this path.

Since I wasn't able to get a test path to hit the multiple search results in getUserDN from Authenticate, opted to add unit tests directly at the getUserBindDN and getUserDN level in client_test.go, though it may be a bit redundant.

I'm pretty new to LDAP though (first time working with it as of this PR), so appreciate any guidance if there's a simpler way to test the change in getUserDN!

}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
Expand Down
310 changes: 310 additions & 0 deletions ldap/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,316 @@ func TestClient_connect(t *testing.T) {
})
}

func TestClient_getUserBindDN(t *testing.T) {
t.Parallel()
testCtx := context.Background()
logger := hclog.New(&hclog.LoggerOptions{
Name: "test-logger",
Level: hclog.Error,
})
td := testdirectory.Start(nil,
testdirectory.WithDefaults(nil, &testdirectory.Defaults{AllowAnonymousBind: true}),
testdirectory.WithLogger(t, logger),
)
users := testdirectory.NewUsers(t, []string{"alice", "bob"})
users = append(
users,
testdirectory.NewUsers(
t,
[]string{"eve"},
testdirectory.WithDefaults(t, &testdirectory.Defaults{UPNDomain: "example.com"}))...,
)
// Set up a duplicated user to test the case where the search returns multiple users
users = append(
users,
testdirectory.NewUsers(
t,
[]string{"mallory", "mallory"},
)...,
)
td.SetUsers(users...)

cases := map[string]struct {
conf *ClientConfig
username string

want string
wantErr bool
wantErrIs error
wantErrContains string
}{
"fail: missing username": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
},
username: "",

wantErr: true,
wantErrIs: ErrInvalidParameter,
wantErrContains: "missing username",
},
"fail: missing all of discoverdn, binddn, bindpass, upndomain, userdn": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
},
username: "alice",

wantErr: true,
wantErrIs: ErrInvalidParameter,
wantErrContains: "cannot derive UserBindDN based on config (see combination of: discoverdn, binddn, bindpass, upndomain, userdn)",
},
"fail: search fails to find user": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
DiscoverDN: true,
},
username: "nonexistent",

wantErr: true,
wantErrContains: "LDAP search for binddn failed",
},
"fail: search returns multiple users": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
DiscoverDN: true,
},
username: "mallory",

wantErr: true,
wantErrContains: "LDAP search for binddn 0 or not unique",
},
"fail: invalid search filter": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
DiscoverDN: true,
UserFilter: "({{.BadFilter}}={{.Username}})",
},
username: "alice",

wantErr: true,
wantErrContains: "search failed due to template parsing error",
},
"success: discoverdn": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
DiscoverDN: true,
},
username: "alice",

want: "cn=alice,ou=people,dc=example,dc=org",
},
"success: binddn and bindpass": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
BindDN: "cn=bob,ou=people,dc=example,dc=org",
BindPassword: "password",
},
username: "alice",

want: "cn=alice,ou=people,dc=example,dc=org",
},
"success: upndomain": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
UPNDomain: "example.com",
},
username: "eve",

want: "[email protected]",
},
"success: userdn": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
UserDN: testdirectory.DefaultUserDN,
},
username: "alice",

want: "cn=alice,ou=people,dc=example,dc=org",
},
}

for name, tc := range cases {
t.Run(name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
c, err := NewClient(testCtx, tc.conf)
require.NoError(err)
err = c.connect(testCtx)
require.NoError(err)
defer func() { c.Close(testCtx) }()
got, err := c.getUserBindDN(tc.username)
if tc.wantErr {
require.Error(err)
if tc.wantErrIs != nil {
assert.ErrorIs(err, tc.wantErrIs)
}
if tc.wantErrContains != "" {
assert.Contains(err.Error(), tc.wantErrContains)
}
return
}
require.NoError(err)
assert.Equal(tc.want, got)
})
}
}

func TestClient_getUserDN(t *testing.T) {
t.Parallel()
testCtx := context.Background()
logger := hclog.New(&hclog.LoggerOptions{
Name: "test-logger",
Level: hclog.Error,
})
td := testdirectory.Start(nil,
testdirectory.WithDefaults(nil, &testdirectory.Defaults{AllowAnonymousBind: true}),
testdirectory.WithLogger(t, logger),
)
users := testdirectory.NewUsers(t, []string{"alice", "bob"})
users = append(
users,
testdirectory.NewUsers(
t,
[]string{"eve"},
testdirectory.WithDefaults(t, &testdirectory.Defaults{UPNDomain: "example.com"}))...,
)
// Set up a duplicated user to test the case where the search returns multiple users
users = append(
users,
testdirectory.NewUsers(
t,
[]string{"mallory", "mallory"},
testdirectory.WithDefaults(t, &testdirectory.Defaults{UPNDomain: "example.com"}),
)...,
)
td.SetUsers(users...)

tests := map[string]struct {
conf *ClientConfig
bindDN string
username string

want string
wantErr bool
wantErrIs error
wantErrContains string
}{
"fail: missing bind dn": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
},
bindDN: "",
username: "alice",

wantErr: true,
wantErrIs: ErrInvalidParameter,
wantErrContains: "missing bind dn",
},
"fail: missing username": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
},
bindDN: fmt.Sprintf("%s=%s,%s", testdirectory.DefaultUserAttr, "bob", testdirectory.DefaultUserDN),
username: "",

wantErr: true,
wantErrIs: ErrInvalidParameter,
wantErrContains: "missing username",
},
"fail: upn domain search fails to find user": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
UPNDomain: "example.com",
},
bindDN: "[email protected],ou=people,dc=example,dc=org",
username: "nonexistent",

wantErr: true,
wantErrContains: "LDAP search failed for detecting user",
},
"fail: upn domain search returns multiple users": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
UPNDomain: "example.com",
},
bindDN: "[email protected],ou=people,dc=example,dc=org",
username: "mallory",

wantErr: true,
wantErrContains: "LDAP search for user 0 or not unique",
},
"success: no upn domain": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
},
bindDN: "cn=alice,ou=people,dc=example,dc=org",
username: "alice",

want: "cn=alice,ou=people,dc=example,dc=org",
},
"success: upn domain with samaccountname": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
UPNDomain: "example.com",
EnableSamaccountnameLogin: true,
},
bindDN: "[email protected],ou=people,dc=example,dc=org",
username: "eve",

want: "[email protected],ou=people,dc=example,dc=org",
},
"success: upn domain without samaccountname": {
conf: &ClientConfig{
URLs: []string{fmt.Sprintf("ldaps://127.0.0.1:%d", td.Port())},
Certificates: []string{td.Cert()},
UPNDomain: "example.com",
},
bindDN: "[email protected],ou=people,dc=example,dc=org",
username: "eve",

want: "[email protected],ou=people,dc=example,dc=org",
},
}

for name, tc := range tests {
t.Run(name, func(t *testing.T) {
assert, require := assert.New(t), require.New(t)
c, err := NewClient(testCtx, tc.conf)
require.NoError(err)
err = c.connect(testCtx)
require.NoError(err)
defer func() { c.Close(testCtx) }()
got, err := c.getUserDN(tc.bindDN, tc.username)
if tc.wantErr {
require.Error(err)
if tc.wantErrIs != nil {
assert.ErrorIs(err, tc.wantErrIs)
}
if tc.wantErrContains != "" {
assert.Contains(err.Error(), tc.wantErrContains)
}
return
}
require.NoError(err)
assert.Equal(tc.want, got)
})
}
}

func Test_sidBytesToString(t *testing.T) {
testcases := map[string][]byte{
"S-1-5-21-2127521184-1604012920-1887927527-72713": {0x01, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x05, 0x15, 0x00, 0x00, 0x00, 0xA0, 0x65, 0xCF, 0x7E, 0x78, 0x4B, 0x9B, 0x5F, 0xE7, 0x7C, 0x87, 0x70, 0x09, 0x1C, 0x01, 0x00},
Expand Down
Loading