用户和角色设置

users.xml 配置文件中的 users 部分包含用户配置。

注意

ClickHouse 也支持用于管理用户的基于 SQL 的工作流，我们建议优先采用这种方式。

users 部分的结构：

<users>
    <!-- 如果未指定用户名，则会使用名为 'default' 的用户。 -->
    <user_name>
        <password></password>
        <!-- 或者 -->
        <password_sha256_hex></password_sha256_hex>

        <ssh_keys>
            <ssh_key>
                <type>ssh-ed25519</type>
                <base64_key>AAAAC3NzaC1lZDI1NTE5AAAAIDNf0r6vRl24Ix3tv2IgPmNPO2ATa2krvt80DdcTatLj</base64_key>
            </ssh_key>
            <ssh_key>
                <type>ecdsa-sha2-nistp256</type>
                <base64_key>AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBNxeV2uN5UY6CUbCzTA1rXfYimKQA5ivNIqxdax4bcMXz4D0nSk2l5E1TkR5mG8EBWtmExSPbcEPJ8V7lyWWbA8=</base64_key>
            </ssh_key>
            <ssh_key>
                <type>ssh-rsa</type>
                <base64_key>AAAAB3NzaC1yc2EAAAADAQABAAABgQCpgqL1SHhPVBOTFlOm0pu+cYBbADzC2jL41sPMawYCJHDyHuq7t+htaVVh2fRgpAPmSEnLEC2d4BEIKMtPK3bfR8plJqVXlLt6Q8t4b1oUlnjb3VPA9P6iGcW7CV1FBkZQEVx8ckOfJ3F+kI5VsrRlEDgiecm/C1VPl0/9M2llW/mPUMaD65cM9nlZgM/hUeBrfxOEqM11gDYxEZm1aRSbZoY4dfdm3vzvpSQ6lrCrkjn3X2aSmaCLcOWJhfBWMovNDB8uiPuw54g3ioZ++qEQMlfxVsqXDGYhXCrsArOVuW/5RbReO79BvXqdssiYShfwo+GhQ0+aLWMIW/jgBkkqx/n7uKLzCMX7b2F+aebRYFh+/QXEj7SnihdVfr9ud6NN3MWzZ1ltfIczlEcFLrLJ1Yq57wW6wXtviWh59WvTWFiPejGjeSjjJyqqB49tKdFVFuBnIU5u/bch2DXVgiAEdQwUrIp1ACoYPq22HFFAYUJrL32y7RxX3PGzuAv3LOc=</base64_key>
            </ssh_key>
        </ssh_keys>

        <access_management>0|1</access_management>

        <networks incl="networks" replace="replace">
        </networks>

        <profile>profile_name</profile>

        <quota>default</quota>
        <default_database>default</default_database>
        <databases>
            <database_name>
                <table_name>
                    <filter>过滤表达式</filter>
                </table_name>
            </database_name>
        </databases>
        
        <grants>
            <query>GRANT SELECT ON system.*</query>
        </grants>
    </user_name>
    <!-- 其他用户的设置 -->
</users>

user_name/password

密码可以以明文形式或 SHA256 哈希值（十六进制格式）指定。

要以明文形式设置密码（不推荐），请将其放在 password 元素中。

例如，<password>qwerty</password>。密码可以留空。

要使用密码的 SHA256 哈希值来设置密码，请将其放在 password_sha256_hex 元素中。

例如，<password_sha256_hex>65e84be33532fb784c48129675f9eff3a682b27168c0ea744b2cf58ee02337c5</password_sha256_hex>。

在 shell 中生成密码的示例：

PASSWORD=$(base64 < /dev/urandom | head -c8); echo "$PASSWORD"; echo -n "$PASSWORD" | sha256sum | tr -d '-'

结果的第一行是密码。第二行是对应的 SHA256 哈希值。

为了与 MySQL 客户端兼容，可以以双重 SHA1 哈希的形式指定密码。将其放在 password_double_sha1_hex 元素中。

例如：<password_double_sha1_hex>08b4a0f1de6ad37da17359e592c8d74788a83eb0</password_double_sha1_hex>。

从 shell 生成密码的示例：
```
PASSWORD=$(base64 < /dev/urandom | head -c8); echo "$PASSWORD"; echo -n "$PASSWORD" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'
```
结果的第一行是密码。第二行是对应的双重 SHA1 哈希值。

username/ssh-key

此设置允许使用 SSH 密钥进行身份验证。

给定一个 SSH 密钥（由 ssh-keygen 生成），例如

ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDNf0r6vRl24Ix3tv2IgPmNPO2ATa2krvt80DdcTatLj [email protected]

ssh_key 元素应为

<ssh_key>
     <type>ssh-ed25519</type>
     <base64_key>AAAAC3NzaC1lZDI1NTE5AAAAIDNf0r6vRl24Ix3tv2IgPmNPO2ATa2krvt80DdcTatLj</base64_key>
 </ssh_key>

将 ssh-ed25519 替换为 ssh-rsa 或 ecdsa-sha2-nistp256，以使用其他受支持的算法。

access_management

此设置用于启用或禁用对该用户使用 SQL 驱动的访问控制和账户管理。

可能的取值：

0 — 禁用。
1 — 启用。

默认值：0。

grants

此设置允许为选定的用户授予任意权限。列表中的每个元素都应为未指定任何被授权者的 GRANT 语句。

示例：

<user1>
    <grants>
        <query>GRANT SHOW ON *.*</query>
        <query>GRANT CREATE ON *.* WITH GRANT OPTION</query>
        <query>GRANT SELECT ON system.*</query>
    </grants>
</user1>

此设置不能与 dictionaries、access_management、named_collection_control、show_named_collections_secrets 和 allow_databases 设置同时指定。

user_name/networks

用于指定用户可以从哪些网络连接到 ClickHouse 服务器的列表。

列表中的每个元素可以具有以下形式之一：

<ip> — IP 地址或网络掩码。

示例：213.180.204.3、10.0.0.1/8、10.0.0.1/255.255.255.0、2a02:6b8::3、2a02:6b8::3/64、2a02:6b8::3/ffff:ffff:ffff:ffff::。
<host> — 主机名。

示例：example01.host.ru。

为检查访问权限，会执行 DNS 查询，并将所有返回的 IP 地址与对端地址进行比较。
<host_regexp> — 主机名的正则表达式。

示例：^example\d\d-\d\d-\d\.host\.ru$

为了检查访问权限，系统会针对对端地址执行一次 DNS PTR 查询，然后应用指定的正则表达式。接着，会对 PTR 查询结果再次执行 DNS 查询，并将收到的所有地址与对端地址进行比较。我们强烈建议正则表达式以 $ 结尾。

所有 DNS 请求的结果都会被缓存，直到服务器重启。

示例

若要为来自任意网络的用户开放访问权限，请指定：

<ip>::/0</ip>

注意

除非已正确配置防火墙，或服务器未直接连接到互联网，否则对任意网络开放访问是不安全的。

若只允许从 localhost 访问，请指定：

<ip>::1</ip>
<ip>127.0.0.1</ip>

user_name/profile

您可以为用户分配一个设置配置文件。设置配置文件在 users.xml 文件的单独部分中进行配置。有关更多信息，请参阅设置配置文件。

user_name/quota

配额允许您在一段时间内跟踪或限制资源使用。配额在 users.xml 配置文件的 quotas 部分中进行配置。

您可以为用户分配一组配额。有关配额配置的详细说明，请参阅配额。

user_name/databases

在此部分中，您可以限制当前用户执行 SELECT 查询时 ClickHouse 返回的行，从而实现基本的行级安全。

示例

以下配置会使用户 user1 在执行 SELECT 查询时，仅能看到 table1 中 id 字段值为 1000 的那些行。

<user1>
    <databases>
        <database_name>
            <table1>
                <filter>id = 1000</filter>
            </table1>
        </database_name>
    </databases>
</user1>

filter 可以是任意返回 UInt8 类型值的表达式。它通常包含比较和逻辑运算符。对于该用户，database_name.table1 中 filter 结果为 0 的行将不会返回。该过滤机制与 PREWHERE 操作不兼容，并会禁用 WHERE→PREWHERE 优化。

角色

可以在 user.xml 配置文件的 roles 部分中创建任意预定义角色。

roles 部分的结构：

<roles>
    <test_role>
        <grants>
            <query>GRANT SHOW ON *.*</query>
            <query>REVOKE SHOW ON system.*</query>
            <query>GRANT CREATE ON *.* WITH GRANT OPTION</query>
        </grants>
    </test_role>
</roles>

也可以在 users 部分为用户授予这些角色：

<users>
    <user_name>
        ...
        <grants>
            <query>GRANT test_role</query>
        </grants>
    </user_name>
<users>

user_name/password​

username/ssh-key​

access_management​

grants​

user_name/networks​

user_name/profile​

user_name/quota​

user_name/databases​

角色​