基于湖库一体架构,统一管理结构化、半结构化与非结构化等多模态数据,一个系统承载事务处理、实时分析与 AI 工作负载。
创建列加密规则
更新时间:2026-11-16 20:22:57
本文档将详细介绍创建列加密规则的语法、参数及限制说明,并为你提供实用的示例,帮助你快速掌握列加密规则的配置方法。
准备工作
在使用敏感规则之前,需要开启 TDE 加密功能,并创建主密钥:
-- 设置透明表空间加密的方式,取值参见 tde_method(如 internal、obcloud、ocp 等)
ALTER SYSTEM SET tde_method = '<encryption_method>';
ALTER INSTANCE ROTATE INNODB MASTER KEY; -- 首次执行需要等待约 20 秒使秘钥生效
tde_method 参数具体说明请参见 tde_method。
语法
在开始创建列加密规则之前,需先了解相关的语法结构。OceanBase 提供了完整的 DDL 语句来管理列加密规则,包括创建、删除和修改操作。
创建列加密规则
CREATE SENSITIVE RULE <rule_name>
ON <sensitive_field_list>
USING ENCRYPTION [ = <encryption_method>];
详细说明请参见 CREATE SENSITIVE RULE。
删除列加密规则
当您需要移除某个列加密规则时,可以使用以下语法:
DROP SENSITIVE RULE <rule_name>;
详细说明请参见 DROP SENSITIVE RULE。
修改列加密规则
在实际使用过程中,您可能需要根据业务需求调整列加密规则。OceanBase 提供了灵活的修改语法来满足这些需求:
-- 新增敏感列
ALTER SENSITIVE RULE <rule_name> ADD COLUMN <sensitive_field_list>;
-- 删除敏感列
ALTER SENSITIVE RULE <rule_name> DROP COLUMN <sensitive_field_list>;
-- 启用规则
ALTER SENSITIVE RULE <rule_name> ENABLE;
-- 禁用规则
ALTER SENSITIVE RULE <rule_name> DISABLE;
-- 修改加密算法
ALTER SENSITIVE RULE <rule_name> USING ENCRYPTION [= <encryption_method>];
详细说明请参见 ALTER SENSITIVE RULE。
示例
通过以下具体示例可以加深对列加密规则操作的理解。这些示例涵盖了创建、删除和修改规则的单场景示例,和完整的操作示例。
创建
-- 创建敏感规则 r1, 保护 tbl1(a), tbl2(b, c), db2.tbl3(e,f);
-- 不加参数时使用默认加密算法 AES-256-ECB,等价于 USING ENCRYPTION = 'aes-256'
CREATE SENSITIVE RULE r1 on tbl1(a), tbl2(b, c), db2.tbl3(e,f)
USING ENCRYPTION;
-- 创建敏感规则 r2, 保护 tbl4(x, y), tbl5(z);
-- 使用 SM4-CBC 加密算法
CREATE SENSITIVE RULE r2 on tbl4(x, y), tbl5(z)
USING ENCRYPTION = 'sm4-cbc';
删除
DROP SENSITIVE RULE r1;
修改
-- 向敏感规则 r1 中增加 tbl2(c), db2.tbl3(x);
ALTER SENSITIVE RULE r1 ADD COLUMN tbl2(c), db2.tbl3(x);
-- 从敏感规则 r1 中删除 tbl2(c)
ALTER SENSITIVE RULE r1 DROP COLUMN tbl2(c);
-- 启用敏感规则 r1
ALTER SENSITIVE RULE r1 ENABLE;
-- 禁用敏感规则 r1
ALTER SENSITIVE RULE r1 DISABLE;
-- 修改敏感规则 r1 的加密算法为默认算法
ALTER SENSITIVE RULE r1 USING ENCRYPTION;
-- 修改敏感规则 r1 的加密算法为 sm4-cbc
ALTER SENSITIVE RULE r1 USING ENCRYPTION = 'sm4-cbc';
完整示例
为方便用户直接上手操作,本小节给出一个端到端的完整功能示例,包含准备工作部分。
-- 注意!仅尚无主密钥的新测试租户需要以下初始化;已有活跃主密钥时跳过此代码块内容。
-- 管理员:root@mysql。
ALTER SYSTEM SET tde_method = 'internal';
-- 等待约 20s,tde_method 生效后执行以下命令轮转主密钥。
ALTER INSTANCE ROTATE INNODB MASTER KEY;
以下步骤使用两个连接:会话 A 为管理员 root@mysql,会话 B 为普通用户 sr_demo@mysql(用户密码为 ******)。请替换为实际租户名及连接地址,并按步骤切换会话。
启动 OBClient 客户端时添加 --binary-as-hex,可将密文显示为以 0x 开头的十六进制字符串。以下密文仅作示意,0x... 表示省略的密文,实际值随租户主密钥变化。
会话 A:准备数据并授予规则管理权限。
CREATE DATABASE sr_demo; CREATE USER sr_demo IDENTIFIED BY '******'; CREATE TABLE sr_demo.customer ( id INT PRIMARY KEY, phone VARCHAR(20), email VARCHAR(40) ); INSERT INTO sr_demo.customer VALUES (1, '13800000000', 'alice@example.com'); -- 规则管理权限及创建规则所需的目标列访问权限。 GRANT CREATE SENSITIVE RULE ON *.* TO sr_demo; GRANT SELECT, INSERT, UPDATE, REFERENCES ON sr_demo.customer TO sr_demo;会话 B:创建规则。规则创建后默认启用。
CREATE SENSITIVE RULE sr_demo_rule ON sr_demo.customer(phone) USING ENCRYPTION = 'aes-256';创建者仍需单独获得
PLAINACCESS权限,当前查询中的phone返回密文。SELECT id, phone, email FROM sr_demo.customer ORDER BY id;ID | PHONE | EMAIL 1 | 0x8B22B347127C399C8909760000F43EA4 | alice@example.com过滤条件使用明文。
SELECT id FROM sr_demo.customer WHERE phone = '13800000000';ID 1会话 A:查看规则并授予该规则的明文访问权限。
SHOW SENSITIVE RULES FROM sr_demo.customer;RULE_NAME | PROTECTION_POLICY | METHOD | ENABLED | PROTECTED_COLUMNS sr_demo_rule | ENCRYPTION | aes-256 | YES | sr_demo.customer(phone)GRANT PLAINACCESS ON SENSITIVE RULE sr_demo_rule TO sr_demo; SELECT RULE_NAME, USER_NAME, USER_TYPE FROM oceanbase.DBA_OB_SENSITIVE_RULE_PLAINACCESS_USERS WHERE RULE_NAME = 'sr_demo_rule';RULE_NAME | USER_NAME | USER_TYPE sr_demo_rule | sr_demo | USER会话 B:执行同一查询,确认返回明文。
SELECT id, phone, email FROM sr_demo.customer ORDER BY id;ID | PHONE | EMAIL 1 | 13800000000 | alice@example.com会话 A:撤销明文访问权限。
REVOKE PLAINACCESS ON SENSITIVE RULE sr_demo_rule FROM sr_demo;会话 B:执行同一查询,确认
phone恢复为密文。SELECT id, phone, email FROM sr_demo.customer ORDER BY id;ID | PHONE | EMAIL 1 | 0x... | alice@example.com会话 B:将
email加入同一规则,并确认两列均返回密文。ALTER SENSITIVE RULE sr_demo_rule ADD COLUMN sr_demo.customer(email); SELECT id, phone, email FROM sr_demo.customer ORDER BY id;ID | PHONE | EMAIL 1 | 0x... | 0x...会话 B:停用规则。即使没有
PLAINACCESS权限,也返回明文。ALTER SENSITIVE RULE sr_demo_rule DISABLE; SELECT id, phone, email FROM sr_demo.customer ORDER BY id;ID | PHONE | EMAIL 1 | 13800000000 | alice@example.com会话 B:启用规则,并移除
email的保护。表中的email列仍保留。ALTER SENSITIVE RULE sr_demo_rule ENABLE; ALTER SENSITIVE RULE sr_demo_rule DROP COLUMN sr_demo.customer(email); SELECT id, phone, email FROM sr_demo.customer ORDER BY id;ID | PHONE | EMAIL 1 | 0x... | alice@example.com会话 B:删除规则,随后关闭会话 B。
DROP SENSITIVE RULE sr_demo_rule;会话 A:清理示例用户及数据。
DROP USER sr_demo; DROP DATABASE sr_demo;
相关文档
- 列加密功能概述
- 列加密权限管理
- 查看敏感级规则的定义及其属性,请参见DBA/CDB_OB_SENSITIVE_RULES