JAVA-12732: move spring-ldap into spring-security-ldap

2022-07-06 15:25:12 +05:30
parent acb9cc97cd
commit 6ae4a1aaf7
21 changed files with 31 additions and 206 deletions
@@ -0,0 +1,83 @@
+package com.baeldung.ldap.client;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.env.Environment;
+import org.springframework.ldap.core.*;
+import org.springframework.ldap.support.LdapNameBuilder;
+
+import javax.naming.Name;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.Base64;
+import java.util.List;
+
+public class LdapClient {
+
+    @Autowired
+    private Environment env;
+
+    @Autowired
+    private ContextSource contextSource;
+
+    @Autowired
+    private LdapTemplate ldapTemplate;
+
+    public void authenticate(final String username, final String password) {
+        contextSource.getContext("cn=" + username + ",ou=users," + env.getRequiredProperty("ldap.partitionSuffix"), password);
+    }
+
+    public List<String> search(final String username) {
+        return ldapTemplate.search(
+          "ou=users",
+          "cn=" + username,
+          (AttributesMapper<String>) attrs -> (String) attrs
+          .get("cn")
+          .get());
+    }
+
+    public void create(final String username, final String password) {
+        Name dn = LdapNameBuilder
+          .newInstance()
+          .add("ou", "users")
+          .add("cn", username)
+          .build();
+        DirContextAdapter context = new DirContextAdapter(dn);
+
+        context.setAttributeValues("objectclass", new String[] { "top", "person", "organizationalPerson", "inetOrgPerson" });
+        context.setAttributeValue("cn", username);
+        context.setAttributeValue("sn", username);
+        context.setAttributeValue("userPassword", digestSHA(password));
+
+        ldapTemplate.bind(context);
+    }
+
+    public void modify(final String username, final String password) {
+        Name dn = LdapNameBuilder
+          .newInstance()
+          .add("ou", "users")
+          .add("cn", username)
+          .build();
+        DirContextOperations context = ldapTemplate.lookupContext(dn);
+
+        context.setAttributeValues("objectclass", new String[] { "top", "person", "organizationalPerson", "inetOrgPerson" });
+        context.setAttributeValue("cn", username);
+        context.setAttributeValue("sn", username);
+        context.setAttributeValue("userPassword", digestSHA(password));
+
+        ldapTemplate.modifyAttributes(context);
+    }
+
+    private String digestSHA(final String password) {
+        String base64;
+        try {
+            MessageDigest digest = MessageDigest.getInstance("SHA");
+            digest.update(password.getBytes());
+            base64 = Base64
+              .getEncoder()
+              .encodeToString(digest.digest());
+        } catch (NoSuchAlgorithmException e) {
+            throw new RuntimeException(e);
+        }
+        return "{SHA}" + base64;
+    }
+}
@@ -0,0 +1,55 @@
+package com.baeldung.ldap.data.repository;
+
+import javax.naming.Name;
+
+import org.springframework.ldap.odm.annotations.Attribute;
+import org.springframework.ldap.odm.annotations.Entry;
+import org.springframework.ldap.odm.annotations.Id;
+
+@Entry(base = "ou=users", objectClasses = { "person", "inetOrgPerson", "top" })
+public class User  {
+        
+    @Id
+    private Name id;
+    
+    private @Attribute(name = "cn") String username;
+    private @Attribute(name = "sn") String password;
+
+    public User() {
+    }
+
+    public User(String username, String password) {
+        this.username = username;
+        this.password = password;
+    }
+
+    public Name getId() {
+        return id;
+    }
+
+    public void setId(Name id) {
+        this.id = id;
+    }
+
+    public String getUsername() {
+        return username;
+    }
+
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    public String getPassword() {
+        return password;
+    }
+
+    public void setPassword(String password) {
+        this.password = password;
+    }
+
+    @Override
+    public String toString() {
+        return username;
+    }
+
+}
@@ -0,0 +1,17 @@
+package com.baeldung.ldap.data.repository;
+
+import java.util.List;
+
+import org.springframework.data.ldap.repository.LdapRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface UserRepository extends LdapRepository<User> {
+
+    User findByUsername(String username);
+
+    User findByUsernameAndPassword(String username, String password);
+
+    List<User> findByUsernameLikeIgnoreCase(String username);
+
+}
@@ -0,0 +1,87 @@
+package com.baeldung.ldap.data.service;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.env.Environment;
+import org.springframework.ldap.core.AttributesMapper;
+import org.springframework.ldap.core.ContextSource;
+import org.springframework.ldap.core.DirContextAdapter;
+import org.springframework.ldap.core.DirContextOperations;
+import org.springframework.ldap.core.LdapTemplate;
+import org.springframework.ldap.support.LdapNameBuilder;
+
+import javax.naming.Name;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.Base64;
+import java.util.List;
+
+public class LdapClient {
+
+    @Autowired
+    private Environment env;
+
+    @Autowired
+    private ContextSource contextSource;
+
+    @Autowired
+    private LdapTemplate ldapTemplate;
+
+    public void authenticate(final String username, final String password) {
+        contextSource.getContext("cn=" + username + ",ou=users," + env.getRequiredProperty("ldap.partitionSuffix"), password);
+    }
+
+    public List<String> search(final String username) {
+        return ldapTemplate.search(
+          "ou=users",
+          "cn=" + username,
+          (AttributesMapper<String>) attrs -> (String) attrs
+            .get("cn")
+            .get());
+    }
+
+    public void create(final String username, final String password) {
+        Name dn = LdapNameBuilder
+          .newInstance()
+          .add("ou", "users")
+          .add("cn", username)
+          .build();
+        DirContextAdapter context = new DirContextAdapter(dn);
+
+        context.setAttributeValues("objectclass", new String[]{"top", "person", "organizationalPerson", "inetOrgPerson"});
+        context.setAttributeValue("cn", username);
+        context.setAttributeValue("sn", username);
+        context.setAttributeValue("userPassword", digestSHA(password));
+
+        ldapTemplate.bind(context);
+    }
+
+    public void modify(final String username, final String password) {
+        Name dn = LdapNameBuilder
+          .newInstance()
+          .add("ou", "users")
+          .add("cn", username)
+          .build();
+        DirContextOperations context = ldapTemplate.lookupContext(dn);
+
+        context.setAttributeValues("objectclass", new String[]{"top", "person", "organizationalPerson", "inetOrgPerson"});
+        context.setAttributeValue("cn", username);
+        context.setAttributeValue("sn", username);
+        context.setAttributeValue("userPassword", digestSHA(password));
+
+        ldapTemplate.modifyAttributes(context);
+    }
+
+    private String digestSHA(final String password) {
+        String base64;
+        try {
+            MessageDigest digest = MessageDigest.getInstance("SHA");
+            digest.update(password.getBytes());
+            base64 = Base64
+              .getEncoder()
+              .encodeToString(digest.digest());
+        } catch (NoSuchAlgorithmException e) {
+            throw new RuntimeException(e);
+        }
+        return "{SHA}" + base64;
+    }
+}
@@ -0,0 +1,63 @@
+package com.baeldung.ldap.data.service;
+
+import com.baeldung.ldap.data.repository.User;
+import com.baeldung.ldap.data.repository.UserRepository;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.ldap.support.LdapUtils;
+import org.springframework.stereotype.Service;
+
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.Base64;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+@Service
+public class UserService {
+
+    @Autowired
+    private UserRepository userRepository;
+
+    public Boolean authenticate(final String username, final String password) {
+        User user = userRepository.findByUsernameAndPassword(username, password);
+        return user != null;
+    }
+
+    public List<String> search(final String username) {
+        List<User> userList = userRepository.findByUsernameLikeIgnoreCase(username);
+        if (userList == null) {
+            return Collections.emptyList();
+        }
+
+        return userList.stream()
+          .map(User::getUsername)
+          .collect(Collectors.toList());
+    }
+
+    public void create(final String username, final String password) {
+        User newUser = new User(username,digestSHA(password));
+        newUser.setId(LdapUtils.emptyLdapName());
+        userRepository.save(newUser);
+
+    }
+
+    public void modify(final String username, final String password) {
+        User user = userRepository.findByUsername(username);
+        user.setPassword(password);
+        userRepository.save(user);
+    }
+
+    private String digestSHA(final String password) {
+        String base64;
+        try {
+            MessageDigest digest = MessageDigest.getInstance("SHA");
+            digest.update(password.getBytes());
+            base64 = Base64.getEncoder()
+                .encodeToString(digest.digest());
+        } catch (NoSuchAlgorithmException e) {
+            throw new RuntimeException(e);
+        }
+        return "{SHA}" + base64;
+    }
+}
@@ -0,0 +1,45 @@
+package com.baeldung.ldap.javaconfig;
+
+import com.baeldung.ldap.client.LdapClient;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
+import org.springframework.context.annotation.PropertySource;
+import org.springframework.core.env.Environment;
+import org.springframework.data.ldap.repository.config.EnableLdapRepositories;
+import org.springframework.ldap.core.LdapTemplate;
+import org.springframework.ldap.core.support.LdapContextSource;
+
+@Configuration
+@PropertySource("classpath:application.properties")
+@ComponentScan(basePackages = {"com.baeldung.ldap.*"})
+@Profile("default")
+@EnableLdapRepositories(basePackages = "com.baeldung.ldap.**")
+public class AppConfig {
+
+    @Autowired
+    private Environment env;
+
+    @Bean
+    public LdapContextSource contextSource() {
+        LdapContextSource contextSource = new LdapContextSource();
+        contextSource.setUrl(env.getRequiredProperty("ldap.url"));
+        contextSource.setBase(env.getRequiredProperty("ldap.partitionSuffix"));
+        contextSource.setUserDn(env.getRequiredProperty("ldap.principal"));
+        contextSource.setPassword(env.getRequiredProperty("ldap.password"));
+        return contextSource;
+    }
+
+    @Bean
+    public LdapTemplate ldapTemplate() {
+        return new LdapTemplate(contextSource());
+    }
+
+    @Bean
+    public LdapClient ldapClient() {
+        return new LdapClient();
+    }
+
+}
@@ -1 +1,8 @@
-management.health.ldap.enabled=false
+management.health.ldap.enabled=false
+
+ldap.partitionSuffix=dc=example,dc=com
+ldap.partition=example
+ldap.principal=uid=admin,ou=system
+ldap.password=secret
+ldap.port=18889
+ldap.url=ldap://localhost:18889
@@ -0,0 +1,62 @@
+package com.baeldung.ldap.client;
+
+import com.baeldung.ldap.javaconfig.TestConfig;
+import org.hamcrest.Matchers;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.ldap.AuthenticationException;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.support.AnnotationConfigContextLoader;
+
+import java.util.List;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ActiveProfiles("testlive")
+@ContextConfiguration(classes = {TestConfig.class}, loader = AnnotationConfigContextLoader.class)
+public class LdapClientLiveTest {
+
+    private static final String USER2 = "TEST02";
+    private static final String USER3 = "TEST03";
+    private static final String USER4 = "TEST04";
+
+    private static final String USER2_PWD = "TEST02";
+    private static final String USER3_PWD = "TEST03";
+    private static final String USER4_PWD = "TEST04";
+
+    private static final String SEARCH_STRING = "TEST*";
+
+    @Autowired
+    private LdapClient ldapClient;
+
+    @Test
+    public void givenLdapClient_whenCorrectCredentials_thenSuccessfulLogin() {
+        ldapClient.authenticate(USER3, USER3_PWD);
+    }
+
+    @Test(expected = AuthenticationException.class)
+    public void givenLdapClient_whenIncorrectCredentials_thenFailedLogin() {
+        ldapClient.authenticate(USER3, USER2_PWD);
+    }
+
+    @Test
+    public void givenLdapClient_whenCorrectSearchFilter_thenEntriesReturned() {
+        List<String> users = ldapClient.search(SEARCH_STRING);
+        Assert.assertThat(users, Matchers.containsInAnyOrder(USER2, USER3));
+    }
+
+    @Test
+    public void givenLdapClientNotExists_whenDataProvided_thenNewUserCreated() {
+        ldapClient.create(USER4, USER4_PWD);
+        ldapClient.authenticate(USER4, USER4_PWD);
+    }
+
+    @Test
+    public void givenLdapClientExists_whenDataProvided_thenExistingUserModified() {
+        ldapClient.modify(USER2, USER3_PWD);
+        ldapClient.authenticate(USER2, USER3_PWD);
+    }
+}
@@ -0,0 +1,67 @@
+package com.baeldung.ldap.client;
+
+import com.baeldung.ldap.data.service.UserService;
+import com.baeldung.ldap.javaconfig.TestConfig;
+import org.hamcrest.Matchers;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.support.AnnotationConfigContextLoader;
+
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ActiveProfiles("testlive")
+@ContextConfiguration(classes = {TestConfig.class}, loader = AnnotationConfigContextLoader.class)
+public class LdapDataRepositoryIntegrationTest {
+
+    private static final String USER2 = "TEST02";
+    private static final String USER3 = "TEST03";
+    private static final String USER4 = "TEST04";
+
+    private static final String USER2_PWD = "TEST02";
+    private static final String USER3_PWD = "TEST03";
+    private static final String USER4_PWD = "TEST04";
+
+    private static final String SEARCH_STRING = "TEST*";
+
+    @Autowired
+    private UserService userService;
+
+    @Test
+    public void givenLdapClient_whenCorrectCredentials_thenSuccessfulLogin() {
+        Boolean isValid = userService.authenticate(USER3, USER3_PWD);
+        assertEquals(true, isValid);
+    }
+
+    @Test
+    public void givenLdapClient_whenIncorrectCredentials_thenFailedLogin() {
+        Boolean isValid = userService.authenticate(USER3, USER2_PWD);
+        assertEquals(false, isValid);
+    }
+
+    @Test
+    public void givenLdapClient_whenCorrectSearchFilter_thenEntriesReturned() {
+        List<String> userList = userService.search(SEARCH_STRING);
+        assertThat(userList, Matchers.containsInAnyOrder(USER2, USER3));
+    }
+
+    @Test
+    public void givenLdapClientNotExists_whenDataProvided_thenNewUserCreated() {
+        userService.create(USER4, USER4_PWD);
+        userService.authenticate(USER4, USER4_PWD);
+    }
+
+    @Test
+    public void givenLdapClientExists_whenDataProvided_thenExistingUserModified() {
+        userService.modify(USER2, USER3_PWD);
+        userService.authenticate(USER2, USER3_PWD);
+    }
+
+}
@@ -0,0 +1,60 @@
+package com.baeldung.ldap.javaconfig;
+
+import com.baeldung.ldap.client.LdapClient;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
+import org.springframework.context.annotation.PropertySource;
+import org.springframework.core.env.Environment;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.data.ldap.repository.config.EnableLdapRepositories;
+import org.springframework.ldap.core.LdapTemplate;
+import org.springframework.ldap.core.support.LdapContextSource;
+import org.springframework.ldap.test.TestContextSourceFactoryBean;
+
+@Configuration
+@PropertySource("classpath:test_application.properties")
+@ComponentScan(basePackages = {"com.baeldung.ldap.*"})
+@EnableLdapRepositories(basePackages = "com.baeldung.ldap.**")
+@Profile("testlive")
+public class TestConfig {
+    @Autowired
+    private Environment env;
+
+    @Autowired
+    private ResourceLoader resourceLoader;
+
+    @Bean
+    public TestContextSourceFactoryBean testContextSource() {
+        TestContextSourceFactoryBean contextSource = new TestContextSourceFactoryBean();
+        contextSource.setDefaultPartitionName(env.getRequiredProperty("ldap.partition"));
+        contextSource.setDefaultPartitionSuffix(env.getRequiredProperty("ldap.partitionSuffix"));
+        contextSource.setPrincipal(env.getRequiredProperty("ldap.principal"));
+        contextSource.setPassword(env.getRequiredProperty("ldap.password"));
+        contextSource.setLdifFile(resourceLoader.getResource(env.getRequiredProperty("ldap.ldiffile")));
+        contextSource.setPort(Integer.valueOf(env.getRequiredProperty("ldap.port")));
+        return contextSource;
+    }
+
+    @Bean
+    public LdapContextSource contextSource() {
+        LdapContextSource contextSource = new LdapContextSource();
+        contextSource.setUrl(env.getRequiredProperty("ldap.url"));
+        contextSource.setBase(env.getRequiredProperty("ldap.partitionSuffix"));
+        contextSource.setUserDn(env.getRequiredProperty("ldap.principal"));
+        contextSource.setPassword(env.getRequiredProperty("ldap.password"));
+        return contextSource;
+    }
+
+    @Bean
+    public LdapTemplate ldapTemplate() {
+        return new LdapTemplate(contextSource());
+    }
+
+    @Bean
+    public LdapClient ldapClient() {
+        return new LdapClient();
+    }
+}
@@ -0,0 +1,24 @@
+version: 1
+dn: ou=users,dc=example,dc=com
+objectClass: organizationalUnit
+objectClass: top
+ou: users
+
+dn: cn=TEST03,ou=users,dc=example,dc=com
+objectClass: inetOrgPerson
+objectClass: organizationalPerson
+objectClass: person
+objectClass: top
+cn: TEST03
+sn: TEST03
+userPassword:: e1NIQX1JbktFOFY2enBpWWdMY0RYQTYzdXZVNjRGZXc9
+
+dn: cn=TEST02,ou=users,dc=example,dc=com
+objectClass: inetOrgPerson
+objectClass: organizationalPerson
+objectClass: person
+objectClass: top
+cn: TEST02
+sn: TEST02
+userPassword:: e1NIQX1uZERKdWNNYnl5a3hWdEkyQzgyRUFlalN1WTQ9
+
@@ -0,0 +1,7 @@
+ldap.partitionSuffix=dc=example,dc=com
+ldap.partition=example
+ldap.principal=uid=admin,ou=system
+ldap.password=secret
+ldap.ldiffile=classpath:/test.ldif
+ldap.port=18888
+ldap.url=ldap://localhost:18888