跳到主要内容
跳到主要内容

在 ClickHouse 中创建用户和角色

ClickHouse 支持基于 RBAC 方法的访问控制管理。

ClickHouse 访问实体包括:

您可以使用以下方式配置访问实体:

  • 基于 SQL 的工作流程。

    您需要 启用 此功能。

  • 服务器的 配置文件 users.xmlconfig.xml

我们建议使用基于 SQL 的工作流程。两种配置方法可以同时使用,因此如果您使用服务器配置文件来管理账户和访问权限,您可以顺利切换到基于 SQL 的工作流程。

备注

您不能通过两种配置方法同时管理相同的访问实体。

备注

如果您正在寻找管理 ClickHouse Cloud 控制台用户的信息,请参考此 页面

要查看所有用户、角色、配置文件等及其所有授权,请使用 SHOW ACCESS 语句。

概述

默认情况下,ClickHouse 服务器提供 default 用户账户,该账户不允许使用基于 SQL 的访问控制和账户管理,但拥有所有权利和权限。当用户名未定义时,例如,在客户端登录或在分布式查询中,使用默认用户账户。如果服务器或集群的配置未指定 用户和密码 属性,则在分布式查询处理时使用默认用户账户。

如果您刚开始使用 ClickHouse,请考虑以下场景:

  1. 启用 default 用户的基于 SQL 的访问控制和账户管理。
  2. 登录到 default 用户账户并创建所有所需用户。别忘了创建一个管理员账户(GRANT ALL ON *.* TO admin_user_account WITH GRANT OPTION)。
  3. 限制权限 对于 default 用户并禁用其基于 SQL 的访问控制和账户管理。

当前解决方案的属性

  • 您可以为不存在的数据库和表授予权限。
  • 如果表被删除,与该表对应的所有权限不会被撤销。这意味着即使您稍后创建一个同名的新表,所有权限仍然有效。要撤销对应于已删除表的权限,您需要执行,例如,REVOKE ALL PRIVILEGES ON db.table FROM ALL 查询。
  • 权限没有寿命设置。

用户账户

用户账户是一个访问实体,允许在 ClickHouse 中授权某人。用户账户包含:

  • 身份信息。
  • 权限,定义用户可以执行的查询范围。
  • 允许连接到 ClickHouse 服务器的主机。
  • 分配的和默认的角色。
  • 用户登录时应用的设置及其约束。
  • 分配的设置配置文件。

可以通过 GRANT 查询或通过分配 角色 来授予用户账户权限。要从用户中撤销权限,ClickHouse 提供 REVOKE 查询。要列出用户的权限,请使用 SHOW GRANTS 语句。

管理查询:

设置应用

设置可以以不同方式配置:对于用户账户、其授予的角色和设置配置文件。在用户登录时,如果为不同的访问实体配置了设置,则该设置的值和约束按以下优先级应用(从高到低):

  1. 用户账户设置。
  2. 用户账户的默认角色设置。如果某些角色中配置了设置,则设置应用的顺序是未定义的。
  3. 分配给用户或其默认角色的设置配置文件中的设置。如果在某些配置文件中配置了设置,则设置应用的顺序是未定义的。
  4. 默认情况下或从 默认配置文件 应用到整个服务器的设置。

角色

角色是可以授予用户账户的访问实体的容器。

角色包含:

  • 权限
  • 设置和约束
  • 分配角色的列表

管理查询:

可以通过 GRANT 查询授予角色权限。要从角色中撤销权限,ClickHouse 提供 REVOKE 查询。

行策略

行策略是一个过滤器,定义哪些行可以被用户或角色访问。行策略包含一个特定表的过滤器,以及应使用该行策略的角色和/或用户列表。

备注

行政策仅对具有只读访问权限的用户有意义。如果用户可以修改表或在表之间复制分区,则这会破坏行政策的限制。

管理查询:

设置配置文件

设置配置文件是一组 设置。设置配置文件包含设置和约束,以及适用该配置文件的角色和/或用户列表。

管理查询:

配额

配额限制资源使用。请参阅 配额

配额包含某些时段的一组限制,以及应使用该配额的角色和/或用户列表。

管理查询:

启用基于 SQL 的访问控制和账户管理

  • 设置配置存储目录。

    ClickHouse 将访问实体的配置存储在 access_control_path 服务器配置参数所设置的文件夹中。

  • 为至少一个用户账户启用基于 SQL 的访问控制和账户管理。

    默认情况下,对所有用户禁用基于 SQL 的访问控制和账户管理。您需要在 users.xml 配置文件中配置至少一个用户,并将 access_managementnamed_collection_controlshow_named_collectionsshow_named_collections_secrets 的值设置为 1。

定义 SQL 用户和角色

提示

如果您在 ClickHouse Cloud 中工作,请查看 Cloud access management

本文介绍了定义 SQL 用户和角色的基本知识,以及如何将这些权限和权限应用于数据库、表、行和列。

启用 SQL 用户模式

  1. <default> 用户下的 users.xml 文件中启用 SQL 用户模式:
<access_management>1</access_management>
<named_collection_control>1</named_collection_control>
<show_named_collections>1</show_named_collections>
<show_named_collections_secrets>1</show_named_collections_secrets>
备注

default 用户是唯一在新安装时创建的用户,也是默认用于节点间通信的账户。

在生产环境中,建议在使用 SQL 管理用户配置节点间通信后禁用该用户,并将节点间通信配置为 <secret>、集群凭据和/或节点间 HTTP 和传输协议凭据,因为 default 账户用于节点间通信。

  1. 重启节点以应用更改。

  2. 启动 ClickHouse 客户端:

clickhouse-client --user default --password <password>

定义用户

  1. 创建一个 SQL 管理员账户:
CREATE USER clickhouse_admin IDENTIFIED BY 'password';
  1. 授予新用户完全的管理权限
GRANT ALL ON *.* TO clickhouse_admin WITH GRANT OPTION;

修改权限

本文旨在帮助您更好地理解如何定义权限,以及在使用 ALTER 语句为特权用户时权限如何工作。

ALTER 语句分为几个类别,其中一些是分层的,而另一些则不是,必须明确定义。

示例数据库、表和用户配置

  1. 以管理员用户身份创建一个示例用户
CREATE USER my_user IDENTIFIED BY 'password';
  1. 创建示例数据库
CREATE DATABASE my_db;
  1. 创建示例表
CREATE TABLE my_db.my_table (id UInt64, column1 String) ENGINE = MergeTree() ORDER BY id;
  1. 创建示例管理员用户以授予/撤销权限
CREATE USER my_alter_admin IDENTIFIED BY 'password';
备注

要授予或撤销权限,管理员用户必须具有 WITH GRANT OPTION 权限。 例如:

GRANT ALTER ON my_db.* WITH GRANT OPTION

GRANTREVOKE 权限,用户必须首先自己拥有这些权限。

授予或撤销权限

ALTER 层次结构:

├── ALTER (only for table and view)/
│   ├── ALTER TABLE/
│   │   ├── ALTER UPDATE
│   │   ├── ALTER DELETE
│   │   ├── ALTER COLUMN/
│   │   │   ├── ALTER ADD COLUMN
│   │   │   ├── ALTER DROP COLUMN
│   │   │   ├── ALTER MODIFY COLUMN
│   │   │   ├── ALTER COMMENT COLUMN
│   │   │   ├── ALTER CLEAR COLUMN
│   │   │   └── ALTER RENAME COLUMN
│   │   ├── ALTER INDEX/
│   │   │   ├── ALTER ORDER BY
│   │   │   ├── ALTER SAMPLE BY
│   │   │   ├── ALTER ADD INDEX
│   │   │   ├── ALTER DROP INDEX
│   │   │   ├── ALTER MATERIALIZE INDEX
│   │   │   └── ALTER CLEAR INDEX
│   │   ├── ALTER CONSTRAINT/
│   │   │   ├── ALTER ADD CONSTRAINT
│   │   │   └── ALTER DROP CONSTRAINT
│   │   ├── ALTER TTL/
│   │   │   └── ALTER MATERIALIZE TTL
│   │   ├── ALTER SETTINGS
│   │   ├── ALTER MOVE PARTITION
│   │   ├── ALTER FETCH PARTITION
│   │   └── ALTER FREEZE PARTITION
│   └── ALTER LIVE VIEW/
│       ├── ALTER LIVE VIEW REFRESH
│       └── ALTER LIVE VIEW MODIFY QUERY
├── ALTER DATABASE
├── ALTER USER
├── ALTER ROLE
├── ALTER QUOTA
├── ALTER [ROW] POLICY
└── ALTER [SETTINGS] PROFILE
  1. 授予用户或角色 ALTER 权限

使用 GRANT ALTER on *.* TO my_user 只会影响顶层的 ALTER TABLEALTER VIEW,其他 ALTER 语句必须单独授予或撤销。

例如,授予基本 ALTER 权限:

GRANT ALTER ON my_db.my_table TO my_user;

由此得到的权限集:

SHOW GRANTS FOR  my_user;
SHOW GRANTS FOR my_user

Query id: 706befbc-525e-4ec1-a1a2-ba2508cc09e3

┌─GRANTS FOR my_user───────────────────────────────────────────┐
│ GRANT ALTER TABLE, ALTER VIEW ON my_db.my_table TO my_user   │
└──────────────────────────────────────────────────────────────┘

这将授予来自上例中的 ALTER TABLEALTER VIEW 下的所有权限,然而,它不会授予其他某些 ALTER 权限,例如 ALTER ROW POLICY(返回查看层次结构,您会看到 ALTER ROW POLICY 不是 ALTER TABLEALTER VIEW 的子项)。那些必须显式授予或撤销。

如果只需要 ALTER 权限的一个子集,则可以单独授予每个权限,如果该权限有子权限,则这些子权限也会自动授予。

例如:

GRANT ALTER COLUMN ON my_db.my_table TO my_user;

授予将被设置为:

SHOW GRANTS FOR my_user;
SHOW GRANTS FOR my_user

Query id: 47b3d03f-46ac-4385-91ec-41119010e4e2

┌─GRANTS FOR my_user────────────────────────────────┐
│ GRANT ALTER COLUMN ON default.my_table TO my_user │
└───────────────────────────────────────────────────┘

1 row in set. Elapsed: 0.004 sec.

这还赋予以下子权限:

ALTER ADD COLUMN
ALTER DROP COLUMN
ALTER MODIFY COLUMN
ALTER COMMENT COLUMN
ALTER CLEAR COLUMN
ALTER RENAME COLUMN
  1. 从用户和角色撤销 ALTER 权限

REVOKE 语句与 GRANT 语句的工作方式类似。

如果用户/角色被授予了子权限,您可以直接撤销该子权限,或撤销更高层的权限。

例如,如果用户被授予了 ALTER ADD COLUMN

GRANT ALTER ADD COLUMN ON my_db.my_table TO my_user;
GRANT ALTER ADD COLUMN ON my_db.my_table TO my_user

Query id: 61fe0fdc-1442-4cd6-b2f3-e8f2a853c739

Ok.

0 rows in set. Elapsed: 0.002 sec.
SHOW GRANTS FOR my_user;
SHOW GRANTS FOR my_user

Query id: 27791226-a18f-46c8-b2b4-a9e64baeb683

┌─GRANTS FOR my_user──────────────────────────────────┐
│ GRANT ALTER ADD COLUMN ON my_db.my_table TO my_user │
└─────────────────────────────────────────────────────┘

权限可以单独被撤销:

REVOKE ALTER ADD COLUMN ON my_db.my_table FROM my_user;

或可以从任何上层撤销(撤销所有的 COLUMN 子权限):

REVOKE ALTER COLUMN ON my_db.my_table FROM my_user;
REVOKE ALTER COLUMN ON my_db.my_table FROM my_user

Query id: b882ba1b-90fb-45b9-b10f-3cda251e2ccc

Ok.

0 rows in set. Elapsed: 0.002 sec.
SHOW GRANTS FOR my_user;
SHOW GRANTS FOR my_user

Query id: e7d341de-de65-490b-852c-fa8bb8991174

Ok.

0 rows in set. Elapsed: 0.003 sec.

补充

权限必须由不仅具有 WITH GRANT OPTION 权限,同时也拥有权限的用户授予。

  1. 要授予管理员用户权限,并允许他们管理一组权限 以下是一个示例:
GRANT SELECT, ALTER COLUMN ON my_db.my_table TO my_alter_admin WITH GRANT OPTION;

现在该用户可以授予或撤销 ALTER COLUMN 和所有子权限。

测试

  1. 添加 SELECT 权限
GRANT SELECT ON my_db.my_table TO my_user;
  1. 向用户添加添加列权限
GRANT ADD COLUMN ON my_db.my_table TO my_user;
  1. 使用受限用户登录
clickhouse-client --user my_user --password password --port 9000 --host <your_clickhouse_host>
  1. 测试添加列
ALTER TABLE my_db.my_table ADD COLUMN column2 String;
ALTER TABLE my_db.my_table
    ADD COLUMN `column2` String

Query id: d5d6bfa1-b80c-4d9f-8dcd-d13e7bd401a5

Ok.

0 rows in set. Elapsed: 0.010 sec.
DESCRIBE my_db.my_table;
DESCRIBE TABLE my_db.my_table

Query id: ab9cb2d0-5b1a-42e1-bc9c-c7ff351cb272

┌─name────┬─type───┬─default_type─┬─default_expression─┬─comment─┬─codec_expression─┬─ttl_expression─┐
│ id      │ UInt64 │              │                    │         │                  │                │
│ column1 │ String │              │                    │         │                  │                │
│ column2 │ String │              │                    │         │                  │                │
└─────────┴────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┘
  1. 测试删除列
ALTER TABLE my_db.my_table DROP COLUMN column2;
ALTER TABLE my_db.my_table
    DROP COLUMN column2

Query id: 50ad5f6b-f64b-4c96-8f5f-ace87cea6c47

0 rows in set. Elapsed: 0.004 sec.

Received exception from server (version 22.5.1):
Code: 497. DB::Exception: Received from chnode1.marsnet.local:9440. DB::Exception: my_user: Not enough privileges. To execute this query it's necessary to have grant ALTER DROP COLUMN(column2) ON my_db.my_table. (ACCESS_DENIED)
  1. 通过授予权限测试修改管理员
GRANT SELECT, ALTER COLUMN ON my_db.my_table TO my_alter_admin WITH GRANT OPTION;
  1. 使用修改管理员用户登录
clickhouse-client --user my_alter_admin --password password --port 9000 --host <my_clickhouse_host>
  1. 授予子权限
GRANT ALTER ADD COLUMN ON my_db.my_table TO my_user;
GRANT ALTER ADD COLUMN ON my_db.my_table TO my_user

Query id: 1c7622fa-9df1-4c54-9fc3-f984c716aeba

Ok.
  1. 测试授予的权限是否为修改管理员用户不具备的,而不是管理员用户授权的子权限。
GRANT ALTER UPDATE ON my_db.my_table TO my_user;
GRANT ALTER UPDATE ON my_db.my_table TO my_user

Query id: 191690dc-55a6-4625-8fee-abc3d14a5545

0 rows in set. Elapsed: 0.004 sec.

Received exception from server (version 22.5.1):
Code: 497. DB::Exception: Received from chnode1.marsnet.local:9440. DB::Exception: my_alter_admin: Not enough privileges. To execute this query it's necessary to have grant ALTER UPDATE ON my_db.my_table WITH GRANT OPTION. (ACCESS_DENIED)

总结 ALTER 权限对于 ALTER 表和视图是分层的,但对于其他 ALTER 语句则不是。权限可以以粒度级别设置或通过权限组进行设置,并且可以以类似的方式进行撤销。授予或撤销的用户必须具有 WITH GRANT OPTION 来设置用户权限,包括正在操作的用户自身,并且必须已经拥有该权限。如果正在操作的用户没有授予权限,不能撤销自己的权限。