Skip to content
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

Jump to bottom

Implement customization of rolePrefix in LdapUserDetailsManager #14574

Merged
merged 1 commit into from
Feb 28, 2024
Merged

Implement customization of rolePrefix in LdapUserDetailsManager #14574

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
36 changes: 35 additions & 1 deletion ...-test/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManagerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
* Copyright 2004-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -49,6 +49,7 @@
/**
* @author Luke Taylor
* @author Eddú Meléndez
* @author Roman Zabaluev
*/
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = ApacheDsContainerConfig.class)
Expand All @@ -60,6 +61,8 @@ public class LdapUserDetailsManagerTests {
private static final List<GrantedAuthority> TEST_AUTHORITIES = AuthorityUtils.createAuthorityList("ROLE_CLOWNS",
"ROLE_ACROBATS");

private static final String DEFAULT_ROLE_PREFIX = "ROLE_";

private LdapUserDetailsManager mgr;

private SpringSecurityLdapTemplate template;
Expand Down Expand Up @@ -248,4 +251,35 @@ public void testPasswordChangeWithWrongOldPasswordFails() {
.isThrownBy(() -> this.mgr.changePassword("wrongpassword", "yossariansnewpassword"));
}

@Test
public void testRoleNamesStartWithDefaultRolePrefix() {
this.mgr.setUsernameMapper(new DefaultLdapUsernameToDnMapper("ou=people", "uid"));
this.mgr.setGroupSearchBase("ou=groups");
LdapUserDetails bob = (LdapUserDetails) this.mgr.loadUserByUsername("bob");

assertThat(bob.getAuthorities()).isNotEmpty();

bob.getAuthorities()
.stream()
.map(GrantedAuthority::getAuthority)
.forEach((authority) -> assertThat(authority).startsWith(DEFAULT_ROLE_PREFIX));
}

@Test
public void testRoleNamesStartWithCustomRolePrefix() {
var customPrefix = "GROUP_";
this.mgr.setRolePrefix(customPrefix);

this.mgr.setUsernameMapper(new DefaultLdapUsernameToDnMapper("ou=people", "uid"));
this.mgr.setGroupSearchBase("ou=groups");
LdapUserDetails bob = (LdapUserDetails) this.mgr.loadUserByUsername("bob");

assertThat(bob.getAuthorities()).isNotEmpty();

bob.getAuthorities()
.stream()
.map(GrantedAuthority::getAuthority)
.forEach((authority) -> assertThat(authority).startsWith(customPrefix));
}

}
14 changes: 12 additions & 2 deletions ldap/src/main/java/org/springframework/security/ldap/userdetails/LdapUserDetailsManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -104,7 +104,7 @@ public class LdapUserDetailsManager implements UserDetailsManager {
/** The attribute which contains members of a group */
private String groupMemberAttributeName = "uniquemember";

private final String rolePrefix = "ROLE_";
private String rolePrefix = "ROLE_";

/** The pattern to be used for the user search. {0} is the user's DN */
private String groupSearchFilter = "(uniquemember={0})";
Expand Down Expand Up @@ -403,6 +403,16 @@ public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy secur
this.securityContextHolderStrategy = securityContextHolderStrategy;
}

/**
* Sets the role prefix used when converting authorities. The default value is "ROLE_"
* @param rolePrefix role prefix
* @since 6.3
*/
public void setRolePrefix(String rolePrefix) {
Haarolean marked this conversation as resolved.
Show resolved Hide resolved
Assert.notNull(rolePrefix, "A rolePrefix must be supplied");
this.rolePrefix = rolePrefix;
}

private void changePasswordUsingAttributeModification(DistinguishedName userDn, String oldPassword,
String newPassword) {
ModificationItem[] passwordChange = new ModificationItem[] { new ModificationItem(DirContext.REPLACE_ATTRIBUTE,
Expand Down
Loading