LDAP

Not supported in ClickHouse Cloud

备注

此页面与 ClickHouse Cloud 不相关。此处文档中记载的功能在 ClickHouse Cloud 服务中不可用。 有关更多信息，请参阅 ClickHouse 云兼容性 指南。

可以使用 LDAP 服务器来验证 ClickHouse 用户。有两种不同的方法来实现这一点：

• 使用 LDAP 作为现有用户的外部身份验证者，这些用户在 users.xml 或本地访问控制路径中定义。
• 将 LDAP 作为外部用户目录，并允许在 LDAP 服务器上存在的未在本地定义的用户进行身份验证。

对于这两种方法，必须在 ClickHouse 配置中定义一个内部命名的 LDAP 服务器，以便配置的其他部分可以引用它。

LDAP 服务器定义

要定义 LDAP 服务器，必须在 config.xml 中添加 ldap_servers 部分。

示例

<clickhouse>
    <!- ... -->
    <ldap_servers>
        <!- Typical LDAP server. -->
        <my_ldap_server>
            <host>localhost</host>
            <port>636</port>
            <bind_dn>uid={user_name},ou=users,dc=example,dc=com</bind_dn>
            <verification_cooldown>300</verification_cooldown>
            <enable_tls>yes</enable_tls>
            <tls_minimum_protocol_version>tls1.2</tls_minimum_protocol_version>
            <tls_require_cert>demand</tls_require_cert>
            <tls_cert_file>/path/to/tls_cert_file</tls_cert_file>
            <tls_key_file>/path/to/tls_key_file</tls_key_file>
            <tls_ca_cert_file>/path/to/tls_ca_cert_file</tls_ca_cert_file>
            <tls_ca_cert_dir>/path/to/tls_ca_cert_dir</tls_ca_cert_dir>
            <tls_cipher_suite>ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:AES256-GCM-SHA384</tls_cipher_suite>
        </my_ldap_server>

        <!- Typical Active Directory with configured user DN detection for further role mapping. -->
        <my_ad_server>
            <host>localhost</host>
            <port>389</port>
            <bind_dn>EXAMPLE\{user_name}</bind_dn>
            <user_dn_detection>
                <base_dn>CN=Users,DC=example,DC=com</base_dn>
                <search_filter>(&amp;(objectClass=user)(sAMAccountName={user_name}))</search_filter>
            </user_dn_detection>
            <enable_tls>no</enable_tls>
        </my_ad_server>
    </ldap_servers>
</clickhouse>

请注意，可以在 ldap_servers 部分内使用不同的名称定义多个 LDAP 服务器。

参数

• host — LDAP 服务器主机名或 IP，此参数是必需的，不能留空。
• port — LDAP 服务器端口，如果 enable_tls 设置为 true，默认为 636，否则为 389。
• bind_dn — 用于构造绑定的 DN 的模板。
  • 在每次身份验证尝试中，结果的 DN 将通过用实际用户名替换模板中的所有 {user_name} 子字符串来构造。
• user_dn_detection — 带有 LDAP 搜索参数的部分，用于检测已绑定用户的实际用户 DN。
  • 这主要用于在服务器为 Active Directory 时进行进一步的角色映射的搜索过滤器。结果用户 DN 将在允许替换 {user_dn} 子字符串时使用。默认情况下，用户 DN 设置为等于绑定 DN，但一旦执行搜索，它将被更新为实际检测到的用户 DN 值。
    • base_dn — 用于构造 LDAP 搜索的基础 DN 的模板。
      • 结果的 DN 将通过用实际用户名和绑定 DN 替换模板中的所有 {user_name} 和 {bind_dn} 子字符串来构造。
    • scope — LDAP 搜索的范围。
      • 可接受的值有：base、one_level、children、subtree（默认）。
    • search_filter — 用于构造 LDAP 搜索的搜索过滤器的模板。
      • 结果过滤器将通过用实际用户名、绑定 DN 和基础 DN 替换模板中的所有 {user_name}、{bind_dn} 和 {base_dn} 子字符串来构造。
      • 请注意，特殊字符必须在 XML 中正确转义。
• verification_cooldown — 在成功的绑定尝试后，假定用户在不联系 LDAP 服务器的情况下对所有连续请求成功身份验证的时间段，以秒为单位。
  • 指定 0（默认）来禁用缓存，并强制在每个身份验证请求中联系 LDAP 服务器。
• enable_tls — 一个触发使用安全连接到 LDAP 服务器的标志。
  • 对于明文 ldap:// 协议，请指定 no（不推荐）。
  • 对于 SSL/TLS ldaps:// 协议，请指定 yes（推荐，默认）。
  • 对于遗留 StartTLS 协议（明文 ldap:// 协议，升级到 TLS），请指定 starttls。
• tls_minimum_protocol_version — SSL/TLS 的最低协议版本。
  • 可接受的值有：ssl2、ssl3、tls1.0、tls1.1、tls1.2（默认）。
• tls_require_cert — SSL/TLS 对等证书验证行为。
  • 可接受的值有：never、allow、try、demand（默认）。
• tls_cert_file — 证书文件路径。
• tls_key_file — 证书密钥文件路径。
• tls_ca_cert_file — CA 证书文件路径。
• tls_ca_cert_dir — 包含 CA 证书的目录路径。
• tls_cipher_suite — 允许的密码套件（以 OpenSSL 记法）。

LDAP 外部身份验证器

可以使用远程 LDAP 服务器作为验证本地定义用户（在 users.xml 或本地访问控制路径中定义的用户）密码的一种方法。为此，请在用户定义中指定先前定义的 LDAP 服务器名称，而不是 password 或类似部分。

在每次登录尝试中，ClickHouse 试图使用提供的凭据“绑定”到由 bind_dn 参数在 LDAP 服务器定义 中定义的指定 DN，如果成功，则考虑该用户已验证。这通常被称为“简单绑定”方法。

示例

<clickhouse>
    <!- ... -->
    <users>
        <!- ... -->
        <my_user>
            <!- ... -->
            <ldap>
                <server>my_ldap_server</server>
            </ldap>
        </my_user>
    </users>
</clickhouse>

请注意，用户 my_user 指的是 my_ldap_server。此 LDAP 服务器必须如前所述在主 config.xml 文件中配置。

当启用 SQL 驱动的 访问控制和账户管理 时，可以使用 CREATE USER 语句创建由 LDAP 服务器验证的用户。

查询：

CREATE USER my_user IDENTIFIED WITH ldap SERVER 'my_ldap_server';

LDAP 外部用户目录

除了本地定义的用户外，远程 LDAP 服务器还可以用作用户定义的来源。为此，请在 config.xml 文件的 users_directories 部分内的 ldap 部分中指定先前定义的 LDAP 服务器名称（见 LDAP 服务器定义）。

在每次登录尝试中，ClickHouse 试图在本地查找用户定义并按常规进行身份验证。如果未定义该用户，ClickHouse 将假设该定义存在于外部 LDAP 目录中，并将尝试使用提供的凭据“绑定”到 LDAP 服务器上的指定 DN。如果成功，该用户将被视为存在并已验证。将从 roles 部分指定的列表中为该用户分配角色。此外，可以执行 LDAP “搜索”，并将结果转换并视为角色名称，然后分配给用户，如果 role_mapping 部分也已配置。这都意味着启用了 SQL 驱动的 访问控制和账户管理，并且使用 CREATE ROLE 语句创建角色。

示例

进入 config.xml。

<clickhouse>
    <!- ... -->
    <user_directories>
        <!- Typical LDAP server. -->
        <ldap>
            <server>my_ldap_server</server>
            <roles>
                <my_local_role1 />
                <my_local_role2 />
            </roles>
            <role_mapping>
                <base_dn>ou=groups,dc=example,dc=com</base_dn>
                <scope>subtree</scope>
                <search_filter>(&amp;(objectClass=groupOfNames)(member={bind_dn}))</search_filter>
                <attribute>cn</attribute>
                <prefix>clickhouse_</prefix>
            </role_mapping>
        </ldap>

        <!- Typical Active Directory with role mapping that relies on the detected user DN. -->
        <ldap>
            <server>my_ad_server</server>
            <role_mapping>
                <base_dn>CN=Users,DC=example,DC=com</base_dn>
                <attribute>CN</attribute>
                <scope>subtree</scope>
                <search_filter>(&amp;(objectClass=group)(member={user_dn}))</search_filter>
                <prefix>clickhouse_</prefix>
            </role_mapping>
        </ldap>
    </user_directories>
</clickhouse>

请注意，user_directories 部分中的 ldap 部分引用的 my_ldap_server 必须是之前定义的在 config.xml 中配置的 LDAP 服务器（见 LDAP 服务器定义）。

参数

• server — 上述 ldap_servers 配置部分中定义的 LDAP 服务器名称之一。此参数是必需的，不能留空。
• roles — 包含将分配给从 LDAP 服务器检索的每个用户的本地定义角色列表的部分。
  • 如果在这里未指定角色或在角色映射期间未分配角色（如下），用户在身份验证后将无法执行任何操作。
• role_mapping — 带有 LDAP 搜索参数和映射规则的部分。
  • 当用户进行身份验证时，仍然绑定到 LDAP，将使用 search_filter 和登录用户的名称执行 LDAP 搜索。在搜索过程中找到的每个条目的指定属性的值将被提取。对于每个具有指定前缀的属性值，前缀将被移除，其余的值将成为在 ClickHouse 中定义的本地角色的名称，该角色预计在之前由 CREATE ROLE 语句创建。
  • 可以在同一 ldap 部分中定义多个 role_mapping 部分。所有这些将被应用。
    • base_dn — 用于构造 LDAP 搜索的基础 DN 的模板。
      • 结果的 DN 将通过用实际用户名、绑定 DN 和用户 DN 替换模板中的所有 {user_name}、{bind_dn} 和 {user_dn} 子字符串来构造。
    • scope — LDAP 搜索的范围。
      • 可接受的值有：base、one_level、children、subtree（默认）。
    • search_filter — 用于构造 LDAP 搜索的搜索过滤器的模板。
      • 结果过滤器将通过用实际用户名、绑定 DN、用户 DN 和基础 DN 替换模板中的所有 {user_name}、{bind_dn}、{user_dn} 和 {base_dn} 子字符串来构造。
      • 请注意，特殊字符必须在 XML 中正确转义。
    • attribute — LDAP 搜索将返回的属性名称。默认是 cn。
    • prefix — 预期出现在 LDAP 搜索返回的字符串原始列表中每个字符串前面的前缀。前缀将从原始字符串中移除，结果字符串将视为本地角色名称。默认是空。