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.

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

[ISSUE #9175] Support ldap filter config #9178

Merged
merged 2 commits into from
Sep 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions console/src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ nacos.core.auth.plugin.nacos.token.secret.key=SecretKey0123456789012345678901234
#nacos.core.auth.ldap.userDn=cn=admin,${nacos.core.auth.ldap.basedc}
#nacos.core.auth.ldap.password=admin
#nacos.core.auth.ldap.userdn=cn={0},dc=example,dc=org
#nacos.core.auth.ldap.filter.prefix=uid


#*************** Istio Related Configurations ***************#
Expand Down
1 change: 1 addition & 0 deletions distribution/conf/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ nacos.core.auth.plugin.nacos.token.secret.key=SecretKey0123456789012345678901234
#nacos.core.auth.ldap.userDn=cn=admin,${nacos.core.auth.ldap.basedc}
#nacos.core.auth.ldap.password=admin
#nacos.core.auth.ldap.userdn=cn={0},dc=example,dc=org
#nacos.core.auth.ldap.filter.prefix=uid
Copy link
Collaborator

Choose a reason for hiding this comment

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

application.properties.example 这个文件也添加一下

Copy link
Contributor Author

Choose a reason for hiding this comment

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

好的,没问题



#*************** Istio Related Configurations ***************#
Expand Down
1 change: 1 addition & 0 deletions distribution/conf/application.properties.example
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ nacos.core.auth.enabled=false
#nacos.core.auth.ldap.userDn=cn=admin,${nacos.core.auth.ldap.basedc}
#nacos.core.auth.ldap.password=admin
#nacos.core.auth.ldap.userdn=cn={0},dc=example,dc=org
#nacos.core.auth.ldap.filter.prefix=uid


### The token expiration in seconds:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ public class LdapAuthConfig {
@Value(("${" + AuthConstants.NACOS_CORE_AUTH_LDAP_PASSWORD + ":password}"))
private String password;

@Value(("${" + AuthConstants.NACOS_CORE_AUTH_LDAP_FILTER_PREFIX + ":uid}"))
private String filterPrefix;

@Bean
@Conditional(ConditionOnLdapAuth.class)
public LdapTemplate ldapTemplate() {
Expand All @@ -76,8 +79,8 @@ public LdapTemplate ldapTemplate() {
@Bean
@Conditional(ConditionOnLdapAuth.class)
public LdapAuthenticationProvider ldapAuthenticationProvider(LdapTemplate ldapTemplate,
NacosUserDetailsServiceImpl userDetailsService, NacosRoleServiceImpl nacosRoleService) {
return new LdapAuthenticationProvider(ldapTemplate, userDetailsService, nacosRoleService);
NacosUserDetailsServiceImpl userDetailsService, NacosRoleServiceImpl nacosRoleService, String filterPrefix) {
return new LdapAuthenticationProvider(ldapTemplate, userDetailsService, nacosRoleService, filterPrefix);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,14 @@ public class LdapAuthenticationProvider implements AuthenticationProvider {

private final LdapTemplate ldapTemplate;

private final String filterPrefix;

public LdapAuthenticationProvider(LdapTemplate ldapTemplate, NacosUserDetailsServiceImpl userDetailsService,
NacosRoleServiceImpl nacosRoleService) {
NacosRoleServiceImpl nacosRoleService, String filterPrefix) {
this.ldapTemplate = ldapTemplate;
this.nacosRoleService = nacosRoleService;
this.userDetailsService = userDetailsService;
this.filterPrefix = filterPrefix;
}

@Override
Expand Down Expand Up @@ -110,7 +113,7 @@ private boolean isAdmin(String username) {
}

private boolean ldapLogin(String username, String password) throws AuthenticationException {
return ldapTemplate.authenticate("", "(uid=" + username + ")", password);
return ldapTemplate.authenticate("", "(" + filterPrefix + "=" + username + ")", password);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,6 @@ public class AuthConstants {
public static final String NACOS_CORE_AUTH_LDAP_USERDN = "nacos.core.auth.ldap.userDn";

public static final String NACOS_CORE_AUTH_LDAP_PASSWORD = "nacos.core.auth.ldap.password";

public static final String NACOS_CORE_AUTH_LDAP_FILTER_PREFIX = "nacos.core.auth.ldap.filter.prefix";
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
/*
* Copyright 1999-2021 Alibaba Group Holding Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.alibaba.nacos.plugin.auth.impl;

import com.alibaba.nacos.plugin.auth.impl.constant.AuthConstants;
import com.alibaba.nacos.plugin.auth.impl.persistence.RoleInfo;
import com.alibaba.nacos.plugin.auth.impl.roles.NacosRoleServiceImpl;
import com.alibaba.nacos.plugin.auth.impl.users.NacosUserDetailsServiceImpl;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.junit.MockitoJUnitRunner;
import org.mockito.stubbing.Answer;
import org.springframework.ldap.core.LdapTemplate;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import static org.mockito.Mockito.when;

@RunWith(MockitoJUnitRunner.class)
public class LdapAuthenticationProviderTest {

@Mock
private NacosUserDetailsServiceImpl userDetailsService;

@Mock
private NacosRoleServiceImpl nacosRoleService;

@Mock
private LdapTemplate ldapTemplate;

private LdapAuthenticationProvider ldapAuthenticationProvider;

private List<RoleInfo> roleInfos = new ArrayList<>();

private final String adminUserName = "nacos";

private final String normalUserName = "normal";

private final String filterPrefix = "uid";

Method isAdmin;

Method ldapLogin;

private String defaultPassWord = "nacos";

@Before
public void setUp() throws NoSuchMethodException {
RoleInfo adminRole = new RoleInfo();
adminRole.setRole(AuthConstants.GLOBAL_ADMIN_ROLE);
adminRole.setUsername(adminUserName);
roleInfos.add(adminRole);
when(nacosRoleService.getRoles(adminUserName)).thenReturn(roleInfos);
when(nacosRoleService.getRoles(normalUserName)).thenReturn(new ArrayList<>());
when(ldapTemplate.authenticate("", "(" + filterPrefix + "=" + adminUserName + ")", defaultPassWord)).thenAnswer(
new Answer<Boolean>() {
@Override
public Boolean answer(InvocationOnMock invocation) throws Throwable {
Object[] args = invocation.getArguments();
String b = (String) args[1];
String c = (String) args[2];
if (defaultPassWord.equals(c)) {
return true;
}
return false;
}
});
this.ldapAuthenticationProvider = new LdapAuthenticationProvider(ldapTemplate, userDetailsService,
nacosRoleService, filterPrefix);
isAdmin = LdapAuthenticationProvider.class.getDeclaredMethod("isAdmin", String.class);
isAdmin.setAccessible(true);
ldapLogin = LdapAuthenticationProvider.class.getDeclaredMethod("ldapLogin", String.class, String.class);
ldapLogin.setAccessible(true);
}

@Test
public void testIsAdmin() {
try {
Boolean result = (Boolean) isAdmin.invoke(ldapAuthenticationProvider, adminUserName);
Assert.assertTrue(result);
} catch (IllegalAccessException e) {
Assert.fail();
} catch (InvocationTargetException e) {
Assert.fail();
}
try {
Boolean result = (Boolean) isAdmin.invoke(ldapAuthenticationProvider, normalUserName);
Assert.assertTrue(!result);
} catch (IllegalAccessException e) {
Assert.fail();
} catch (InvocationTargetException e) {
Assert.fail();
}

}

@Test
public void testldapLogin() {
try {
Boolean result = (Boolean) ldapLogin.invoke(ldapAuthenticationProvider, adminUserName, defaultPassWord);
Assert.assertTrue(result);
} catch (IllegalAccessException e) {
Assert.fail();
} catch (InvocationTargetException e) {
Assert.fail();
}
try {
Boolean result = (Boolean) ldapLogin.invoke(ldapAuthenticationProvider, adminUserName, "123");
Assert.assertTrue(!result);
} catch (IllegalAccessException e) {
Assert.fail();
} catch (InvocationTargetException e) {
Assert.fail();
}
}
}