LDAP 命名空间选项
LDAP 实现广泛使用 Spring LDAP,因此熟悉该项目的 API 可能会有所帮助。
使用以下方法定义 LDAP 服务器
<ldap-server>
元素 此元素为其他 LDAP bean 设置 Spring LDAP ContextSource
,定义 LDAP 服务器的位置和其他信息(例如用户名和密码,如果它不允许匿名访问),以便连接到它。它也可以用于创建嵌入式服务器以进行测试。两种选项的语法细节在 LDAP 章 中介绍。实际的 ContextSource
实现是 DefaultSpringSecurityContextSource
,它扩展了 Spring LDAP 的 LdapContextSource
类。manager-dn
和 manager-password
属性分别映射到后者的 userDn
和 password
属性。
如果您在应用程序上下文中只定义了一个服务器,其他 LDAP 命名空间定义的 bean 将自动使用它。否则,您可以为元素提供一个“id”属性,并使用 server-ref
属性从其他命名空间 bean 中引用它。这实际上是 ContextSource
实例的 bean id
,如果您想在其他传统的 Spring bean 中使用它。
<ldap-server> 属性
-
mode 明确指定应使用哪个嵌入式 ldap 服务器。值是
apacheds
和unboundid
。默认情况下,它将取决于库是否在类路径中可用。
-
id 一个 bean 标识符,用于在上下文的其他地方引用 bean。
-
ldif 明确指定要加载到嵌入式 LDAP 服务器中的 ldif 文件资源。ldif 应该是一个 Spring 资源模式(即 classpath:init.ldif)。默认值为 classpath*:*.ldif
-
manager-dn 将用于对(非嵌入式)LDAP 服务器进行身份验证的“manager”用户身份的用户名(DN)。如果省略,将使用匿名访问。
-
manager-password 管理员 DN 的密码。如果指定了 manager-dn,则需要此密码。
-
port 指定 IP 端口号。例如,用于配置嵌入式 LDAP 服务器。默认值为 33389。
-
root 嵌入式 LDAP 服务器的可选根后缀。默认值为“dc=springframework,dc=org”
-
url 在不使用嵌入式 LDAP 服务器时指定 ldap 服务器 URL。
<ldap-authentication-provider>
此元素是创建 LdapAuthenticationProvider
实例的简写。默认情况下,它将使用 BindAuthenticator
实例和 DefaultAuthoritiesPopulator
进行配置。与所有命名空间身份验证提供程序一样,它必须作为 authentication-provider
元素的子元素包含。
<ldap-authentication-provider> 属性
-
group-role-attribute 包含将在 Spring Security 中使用的角色名称的 LDAP 属性名称。映射到
DefaultLdapAuthoritiesPopulator
的groupRoleAttribute
属性。默认为 "cn"。
-
group-search-base 组成员资格搜索的搜索基础。映射到
DefaultLdapAuthoritiesPopulator
的groupSearchBase
构造函数参数。默认为 ""(从根目录搜索)。
-
group-search-filter 组搜索过滤器。映射到
DefaultLdapAuthoritiesPopulator
的groupSearchFilter
属性。默认为(uniqueMember={0})
。替换的参数是用户的 DN。
-
role-prefix 将添加到从持久存储加载的角色字符串的非空字符串前缀。映射到
DefaultLdapAuthoritiesPopulator
的rolePrefix
属性。默认为 "ROLE_"。在默认值非空的情况下,使用值 "none" 表示没有前缀。
-
server-ref 要使用的可选服务器。如果省略,并且注册了默认 LDAP 服务器(使用 <ldap-server> 且没有 Id),则将使用该服务器。
-
user-context-mapper-ref 通过指定一个 UserDetailsContextMapper bean 来允许对加载的用户对象进行显式自定义,该 bean 将使用来自用户目录条目的上下文信息进行调用
-
user-details-class 允许指定用户条目的 objectClass。如果设置,框架将尝试将定义的类中的标准属性加载到返回的 UserDetails 对象中
-
user-dn-pattern 如果您的用户位于目录中的固定位置(即,您可以直接从用户名计算出 DN,而无需进行目录搜索),则可以使用此属性直接映射到 DN。它直接映射到
AbstractLdapAuthenticator
的userDnPatterns
属性。该值是用于构建用户 DN 的特定模式,例如uid={0},ou=people
。键{0}
必须存在,并将被用户名替换。
-
user-search-base 用户搜索的搜索基础。默认为 ""。仅与 'user-search-filter' 一起使用。
如果您需要执行搜索以在目录中找到用户,那么您可以设置这些属性来控制搜索。
BindAuthenticator
将使用FilterBasedLdapUserSearch
进行配置,并且属性值直接映射到该 bean 构造函数的前两个参数。如果这些属性未设置,并且未提供user-dn-pattern
作为替代方案,则将使用默认搜索值user-search-filter="(uid={0})"
和user-search-base=""
。
-
user-search-filter 用于搜索用户的 LDAP 过滤器(可选)。例如
(uid={0})
。替换的参数是用户的登录名。如果您需要执行搜索以在目录中找到用户,那么您可以设置这些属性来控制搜索。
BindAuthenticator
将使用FilterBasedLdapUserSearch
进行配置,并且属性值直接映射到该 bean 构造函数的前两个参数。如果这些属性未设置,并且未提供user-dn-pattern
作为替代方案,则将使用默认搜索值user-search-filter="(uid={0})"
和user-search-base=""
。
<password-compare>
<ldap-user-service>
此元素配置一个 LDAP UserDetailsService
。使用的类是 LdapUserDetailsService
,它是 FilterBasedLdapUserSearch
和 DefaultLdapAuthoritiesPopulator
的组合。它支持的属性与 <ldap-provider>
中的用法相同。
<ldap-user-service> 属性
-
cache-ref 定义对缓存的引用,用于与 UserDetailsService 一起使用。
-
group-role-attribute LDAP 属性名称,其中包含将在 Spring Security 中使用的角色名称。默认为 "cn"。
-
group-search-base 组成员资格搜索的搜索基础。默认为 ""(从根目录搜索)。
-
group-search-filter 组搜索过滤器。默认为
(uniqueMember={0})
。替换的参数是用户的 DN。
-
id 一个 bean 标识符,用于在上下文的其他地方引用 bean。
-
role-prefix 一个非空的字符串前缀,将添加到从持久存储加载的角色字符串中(例如 "ROLE_")。在默认值非空的情况下,使用值 "none" 表示没有前缀。
-
server-ref 要使用的可选服务器。如果省略,并且注册了默认 LDAP 服务器(使用 <ldap-server> 且没有 Id),则将使用该服务器。
-
user-context-mapper-ref 通过指定一个 UserDetailsContextMapper bean 来允许对加载的用户对象进行显式自定义,该 bean 将使用来自用户目录条目的上下文信息进行调用
-
user-details-class 允许指定用户条目的 objectClass。如果设置,框架将尝试将定义的类中的标准属性加载到返回的 UserDetails 对象中
-
user-search-base 用户搜索的搜索基础。默认为 ""。仅与 'user-search-filter' 一起使用。
-
user-search-filter 用于搜索用户的 LDAP 过滤器(可选)。例如
(uid={0})
。替换的参数是用户的登录名。