Spring Security LDAP 简介

2023-12-02

1、概览

本文将带你了解如何设置 Spring Security LDAP。

LDAP、即 Lightweight Directory Access Protocol（轻量级目录访问协议）的缩写，是一种开放的、厂商中立的协议，用于通过 Web 访问目录服务。

2、Maven 依赖

所需 Maven 依赖如下：

<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-ldap</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.directory.server</groupId>
    <artifactId>apacheds-server-jndi</artifactId>
    <version>1.5.5</version>
</dependency>

注：使用 ApacheDS 作为 LDAP 服务器，这是一个可扩展、可嵌入的目录服务器。

3、Java 配置

Spring Security Java 配置：

public class SecurityConfig {

    @Bean
    ApacheDSContainer ldapContainer() throws Exception {
        return new ApacheDSContainer("dc=baeldung,dc=com", "classpath:users.ldif");
    }

    @Bean
    LdapAuthoritiesPopulator authorities(BaseLdapPathContextSource contextSource) {
        String groupSearchBase = "ou=groups";
        DefaultLdapAuthoritiesPopulator authorities = new DefaultLdapAuthoritiesPopulator
           (contextSource, groupSearchBase);
        authorities.setGroupSearchFilter("(member={0})");
        return authorities;
    }

    @Bean
    AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSource, 
        LdapAuthoritiesPopulator authorities) {
        LdapBindAuthenticationManagerFactory factory = new LdapBindAuthenticationManagerFactory
           (contextSource);
        factory.setUserSearchBase("ou=people");
        factory.setUserSearchFilter("(uid={0})");
        return factory.createAuthenticationManager();
    }
 }

当然，这只是配置中与 LDAP 相关的部分，完整的 Java 配置可在此处找到。

4、XML 配置

相应的 XML 配置：

<authentication-manager>
    <ldap-authentication-provider
      user-search-base="ou=people"
      user-search-filter="(uid={0})"
      group-search-base="ou=groups"
      group-search-filter="(member={0})">
    </ldap-authentication-provider>
</authentication-manager>
   
<ldap-server root="dc=baeldung,dc=com" ldif="users.ldif"/>

同样，这只是配置的一部分 - 与 LDAP 相关的部分，完整的 XML 配置可在此处找到。

5、LDAP 数据交换格式

LDAP 数据可以使用 LDAP 数据交换格式（LDIF）表示，下面是用户数据示例：

dn: ou=groups,dc=baeldung,dc=com
objectclass: top
objectclass: organizationalUnit
ou: groups

dn: ou=people,dc=baeldung,dc=com
objectclass: top
objectclass: organizationalUnit
ou: people

dn: uid=baeldung,ou=people,dc=baeldung,dc=com
objectclass: top
objectclass: person
objectclass: organizationalPerson
objectclass: inetOrgPerson
cn: Jim Beam
sn: Beam
uid: baeldung
userPassword: password

dn: cn=admin,ou=groups,dc=baeldung,dc=com
objectclass: top
objectclass: groupOfNames
cn: admin
member: uid=baeldung,ou=people,dc=baeldung,dc=com

dn: cn=user,ou=groups,dc=baeldung,dc=com
objectclass: top
objectclass: groupOfNames
cn: user
member: uid=baeldung,ou=people,dc=baeldung,dc=com

6、使用 Spring Boot

在 Spring Boot 中，还可以使用 Spring Boot Starter Data Ldap 依赖，它会自动配置 LdapContextSource 和 LdapTemplate。

要启用自动配置，需要在 pom.xml 中添加 spring-boot-starter-data-ldap Starter 或 spring-ldap-core 依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-ldap</artifactId>
</dependency>

要连接到 LDAP，需要在 application.properties 中提供连接设置：

spring.ldap.url=ldap://localhost:18889
spring.ldap.base=dc=example,dc=com
spring.ldap.username=uid=admin,ou=system
spring.ldap.password=secret

有关 Spring Data LDAP 自动配置的更多详情，请参阅官方文档。Spring Boot 引入了 LdapAutoConfiguration，它负责实例化 LdapTemplate，然后将其注入到所需的服务类中：

@Autowired
private LdapTemplate ldapTemplate;

7、示例应用

示例应用如下：

@Controller
public class MyController {

    @RequestMapping("/secure")
    public String secure(Map<String, Object> model, Principal principal) {
        model.put("title", "SECURE AREA");
        model.put("message", "Only Authorized Users Can See This Page");
        return "home";
    }
}

8、总结

本文介绍了如何使用 LDIF 配置系统的安全设置。

Ref：https://www.baeldung.com/spring-security-ldap