针对LDAP服务器进行身份认证

3.4 版本

维护中的版本

4.2 master 2.8 LTS

难易度：偏难

Symfony提供了不同的方法来配合LDAP服务器使用。

Security组件提供：

ldap user provider，使用的是 LdapUserProvider 类。同所有其他user provider一样，它可以同任何authentication provider一起使用。
form_login_ldap authentication provider，用于针对一台使用了表单登录的LDAP服务器。同所有其他user provider一样，它可以同任何authentication provider一起使用。
http_basic_ldap authentication provider，用于针对一台使用了HTTP Basic的LDAP服务器。同所有其他user provider一样，它可以同任何authentication provider一起使用。

这意味着在以下场合是可以工作的：

利用一台LDAP服务器来比对用户密码并取出用户信息。这可以使用LDAP user provider，以及LDAP form login或LDAP HTTP basic两个authentication provider中的一种来完成。
利用一台LDAP服务器来比对用户密码，但从另一个资源处取得用户信息（比如，一个使用了FOSUserBundle的数据库）。
从一台LDAP服务器取出用户信息，同时使用另一种用户验证策略（比如，基于token的预验证）。

LDAP配置参考 ¶

完整的LDAP配置参考 (form_login_ldap, http_basic_ldap, ldap) 请见 SecurityBundle Configuration ("security")。其中一些更有意思的选项在此进行解释。

配置LDAP客户端 ¶

所有架构都需要LDAP客户端被预先配置好。providers被配置为使用一个名为 ldap 的服务，但你也可以在security组件的配置信息中覆写此项设置。

使用下列配置，一个LDAP客户端可以被简单地配置：

# app/config/services.yml
services:
    ldap:
        class: Symfony\Component\Ldap\LdapClient
        arguments:
            - my-server   # host
            - 389         # port
            - 3           # version
            - false       # SSL
            - true        # TLS

<!-- app/config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
    <services>
        <service id="ldap" class="Symfony\Component\Ldap\LdapClient">
            <argument>my-server</argument>
            <argument>389</argument>
            <argument>3</argument>
            <argument>false</argument>
            <argument>true</argument>
        </service>
    </services>
</container>

// app/config/services.php
use Symfony\Component\Ldap\LdapClient;
use Symfony\Component\DependencyInjection\Definition;
 
$container
    ->setDefinition('ldap', new Definition(LdapClient::class, array(
        'my-server',
        389,
        3,
        false,
        true,
 
    ));

利用LDAP User Provider取出用户 ¶

如果你想从一台LDAP服务器中取出用户信息，你就需要使用 ldap user provider了：

# app/config/security.yml
security:
    # ...

    providers:
        my_ldap:
            ldap:
                service: ldap
                base_dn: dc=example,dc=com
                search_dn: "cn=read-only-admin,dc=example,dc=com"
                search_password: password
                default_roles: ROLE_USER
                uid_key: uid

<!-- app/config/security.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:srv="http://symfony.com/schema/dic/services"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd">
 
    <config>
        <provider name="my_ldap">
            <ldap
                    service="ldap"
                    base-dn="dc=example,dc=com"
                    search-dn="cn=read-only-admin,dc=example,dc=com"
                    search-password="password"
                    default-roles="ROLE_USER"
                    uid-key="uid"
            />
        </provider>
    </config>
</srv:container>

$container->loadFromExtension('security', array(
    'providers' => array(
        'ldap_users' => array(
            'ldap' => array(
                'service' => 'ldap',
                'base_dn' => 'dc=example,dc=com',
                'search_dn' => 'cn=read-only-admin,dc=example,dc=com',
                'search_password' => 'password',
                'default_roles' => 'ROLE_USER',
                'uid_key' => 'uid',
            ),
        ),
    ),
);

ldap user provider支持多种不同的配置选项:

service ¶

值类型: string 默认值: ldap

这是你所配置的LDAP客户端的名字。你可以随便选择名称，但必须是程序中的唯一，并且不允许以数字或空格开头。

base_dn ¶

值类型: string 默认值: null

这是目录的base DN。

search_dn ¶

值类型: string 默认值: null

这是你的只读用户的DN，用于对LDAP服务器进行认证，以便取出用户信息。

search_password ¶

值类型: string 默认值: null

这是你的只读用户的密码，用于对LDAP服务器进行认证，以便取出用户信息。

default_roles ¶

值类型: array 默认值: []

这是你希望分配给“从LDAP服务器取出的用户”之默认role。如果你不配置此键，用户不会有任何role，并不被当作“完全认证”（fully authenticated）的用户。

uid_key ¶

值类型: string 默认值: sAMAccountName

这是入口点（entry）的key，用作其uid。取决于你的LDAP服务器之具体落实（implementation）。常用值是：

sAMAccountName
userPrincipalName
uid

filter ¶

值类型: string 默认值: ({uid_key}={username})

这个键让你配置哪个LDAP查询将被使用。{uid_key} 字符串将被 uid_key 配置值所替换 (默认时， sAMAccountName) 和 {username} 字符串将被你“正在尝试加载的用户名”给替换。

例如，带有一个 uid 值的 uid_key，如果你尝试加载 fabpot 用户，最终的字符串将会是: (uid=fabpot)。

当然，用户名会被转义，为的是防止 LDAP injection。

filter 选项键的语法被 RFC4515 所定义。