数据脱敏

使用限制

• 出于安全考虑，Hologres暂不支持从设置了脱敏规则的表和列向未设置脱敏规则的表和列导入数据，相关报错信息如下。

  错误原因：ERROR: The insert table has not set SECURITY LABEL

• 暂不支持针对设置了脱敏规则的表进行UNION和DISTINCT查询，相关报错信息如下。

  错误原因:ERROR: UNION is not support on security item

• 数据脱敏会一定程度的影响查询性能，影响程度和脱敏方式、数据量都有关，性能有10%~20%的下降，极端场景可能存在数倍性能下降。

使用数据脱敏

Hologres支持对目标列或目标用户设置数据脱敏。使用数据脱敏前，您需登录目标数据库开启脱敏功能。完成后可配置对应的脱敏规则，针对某一列或某个用户设置脱敏。具体操作步骤如下。

1. 为目标数据库开启数据脱敏。

   数据脱敏功能默认不开启，需要Superuser登录至目标数据库开启该功能，开启命令及相关参数说明如下。

   • 命令：

     CREATE EXTENSION IF NOT EXISTS hg_anon; --创建hg_anon扩展函数。
     ALTER DATABASE <db_name> SET hg_anon_enable = on; --为指定数据库开启数据脱敏功能，默认为off。

   • 示例：

     CREATE EXTENSION IF NOT EXISTS hg_anon;--创建hg_anon扩展函数。
     ALTER DATABASE test SET hg_anon_enable = on;--为数据库test开启数据脱敏功能。

   • 参数说明：

     参数	参数的相关描述
     hg_anon	hg_anon是Hologres内部封装的扩展函数，您需要调用该扩展函数才能开启数据脱敏功能。
     <db_name>	需要开启数据脱敏功能的数据库名称。使用时需要替换<db_name>为实际数据库名称。
     hg_anon_enable	选择开启或关闭数据脱敏功能，取值如下： on，开启数据脱敏。 off，关闭数据脱敏。 默认该参数设置为off。

2. 设置脱敏列。

   可由Superuser或表Owner对目标列进行脱敏，具体命令、示例、参数说明如下。

   • 命令：

     说明

     对多列数据进行脱敏时，需要多次执行该语句。

     SECURITY LABEL FOR hg_anon ON COLUMN <tablename>.<col_name> IS <label_name>;

   • 示例：对holotest表的ID列按照名称脱敏。

     SECURITY LABEL FOR hg_anon ON COLUMN holotest.id IS 'name';

   • 参数说明：

     参数	描述
     hg_anon	hg_anon是Hologres内部封装的扩展函数，您需要调用该扩展函数才能开启数据脱敏功能。
     <tablename>	需要脱敏的列所在的表名称。使用时需要替换<tablename>为实际表名称。
     <col_name>	需要脱敏的列名称。使用时需要替换<col_name>为实际列名称。
     label_name	系统预设的脱敏函数，您可以使用show hg_anon_labels;SQL查看当前数据库设置的label_name。

     从HologresV1.1版本开始，默认的label_name如下。

     lable_name	说明	示例
     name	姓名脱敏。	脱敏前：李华；脱敏后：*华。 脱敏前：王小强；脱敏后：**强。
     email	邮箱地址脱敏。	脱敏前：lihuang@alibaba.com；脱敏后：lih***@alibaba.com
     ip	IP地址脱敏。	脱敏前：192.0.2.1；脱敏后：192.*.*.*。
     id	身份证号码脱敏。	脱敏前：110345188812011234；脱敏后：1****************4
     phone	电话号码脱敏。	脱敏前：13900001234；脱敏后：*********34。
     bank_id	银行卡、信用卡账号脱敏。	脱敏前：2349867902834701928；脱敏后：***************1928。
     hash	使用MD5算法进行脱敏。	脱敏前：浙江省杭州市文一西路；脱敏后：dbf894b409d4a2ef17dfd9c7fdcafcd8。
     first_mask	定义了一个first_mask的规则，只显示第一个字符。	脱敏前：123456789；脱敏后：1********。

   • 脱敏结果示例：

   • 其他相关命令

     • 删除已经设置的脱敏

       SECURITY LABEL FOR hg_anon ON COLUMN test_hg_anon_demo.name is NULL;

     • 查看设置的脱敏列

       SELECT c.relname, a.attname, provider, label
       FROM pg_seclabel s 
           INNER JOIN pg_catalog.pg_class c ON s.classoid = c.tableoid AND s.objoid = c.oid
           INNER JOIN pg_catalog.pg_attribute a ON s.objoid = a.attrelid
       WHERE a.attnum = objsubid;

高级技巧

• 对不同用户设置脱敏

  默认情况下所有用户都会脱敏，可以单独设置某些用户不脱敏。

  • 命令格式如下

     SECURITY LABEL FOR hg_anon ON ROLE user_name IS '[label_name|all]:[masked|unmasked]';

    参数	说明
    user_name	账号ID。请通过用户信息页面获取。
    label_name	系统预设的脱敏函数，您可以使用show hg_anon_labels;SQL查看当前数据库设置的label_name。
    masked	使用数据脱敏。
    unmasked	不使用数据脱敏。

  • 使用示例

    • 对账号ID为1365xxxxxxxxxxxx的用户不脱敏的语句如下。

      SECURITY LABEL FOR hg_anon ON ROLE "1365xxxxxxxxxxxx" IS 'all:unmasked';

    • 对账号ID为1365xxxxxxxxxxxx的用户针对phone标签的列设置为不脱敏的语句如下。

      SECURITY LABEL FOR hg_anon ON ROLE "1365xxxxxxxxxxxx" IS 'phone:unmasked';

  • 相关命令

    • 查看对用户设置的脱敏情况

      SELECT usename, label FROM pg_shseclabel s INNER JOIN pg_catalog.pg_user u ON s.objoid = u.usesysid;

    • 删除对用户设置的脱敏

      SECURITY LABEL FOR hg_anon ON ROLE "1365xxxxxxxxxxxx" IS NULL;

• 自定义脱敏规则

  如果默认的label_name无法满足需求，您可以通过修改GUC的hg_anon_labels参数自定义脱敏规则。

  • 命令

    ALTER DATABASE <db_name> SET hg_anon_labels = '[
      {"label": <label_name1>, "method", <method1>},
      {"label": <label_name2>, "method", <method2>},
      ... 
    ]'; --label_name是您自定义的名称，method是Hologres内置的一些方法。

    说明

    执行ALTER DATABASE命令后，当前链接会不生效，需要重开一个连接。您可使用如下命令查看设置是否生效。

    SHOW hg_anon_enable;

  • 示例

    ALTER DATABASE test_db SET hg_anon_labels = '[
    {"label":"ip", "method":{"desensType":"mask", "type":"ip"}},
    {"label":"email", "method":{"desensType":"mask", "type":"email"}},
    {"label":"name", "method":{"desensType":"mask", "type":"name"}},
    {"label":"first_mask", "method":{"desensType":"mask", "type":"user_define", "before":1, "after":0}},
    {"label":"hash", "method":{"desensType":"hash", "type":"md5", "salt":""}}]';

  • 参数说明：

    脱敏项	脱敏内容描述	脱敏结果示例
    {"desensType":"mask", "type":"ip"}	IP地址脱敏。	192.*.*.*
    {"desensType":"mask", "type":"email"}	邮箱地址脱敏。	abc***@example.net
    {"desensType":"mask", "type":"name"}	名称脱敏。	*五
    {"desensType":"hash", "type":"md5", "salt":""}	Hash脱敏。	e086aa137fa19f67d27b39d0eca186103228f322c9c98a125554a24f875f0f7e
    {"label":"first_mask", "method":{"desensType":"mask", "type":"user_define", "before":1, "after":0}}{"label":"last_mask", "method":{"desensType":"mask", "type":"user_define", "before":0, "after":1}}	自定义内容脱敏。	无

使用示例

使用Hologres数据脱敏功能完整的使用示例如下。

1. 创建数据库

   使用如下命令语句创建数据库。

   CREATE DATABASE hg_anon_demo;

2. 创建样例数据表

   切换到创建的数据库，使用如下命令语句创建样例数据表。

   DROP TABLE IF EXISTS personal_basic_information;
   
   CREATE TABLE personal_basic_information
   (
       name TEXT
       ,email TEXT
       ,ip TEXT
       ,id TEXT
       ,phone TEXT
       ,bank_id TEXT
   )
   ;

3. 插入样例数据

   使用如下命令语句，在personal_basic_information表中插入样例数据。

   INSERT INTO personal_basic_information(name,email,ip,id,phone,bank_id) VALUES
   ('Zhang San','zhangsan@alibaba.com','127.0.0.1','142732199102290022','13900001234','4514610803067088'),
   ('Li Si','lisi@alibaba.com','127.0.0.1','510622198402308000','13900001111','6252470010027800'),
   ('Li Xiaoyao','lixiaoyao@alibaba.com','172.21.4.234','511025188812271696','13900002222','6252470010027800');

4. 查看数据

   查看数据脱敏前的数据。

   SELECT * FROM personal_basic_information;

5. 设置脱敏规则

   使用如下命令语句为数据设置脱敏规则。

   --创建hg_anon扩展函数。
   CREATE EXTENSION IF NOT EXISTS hg_anon;
   
   --为数据库hg_anon_demo开启数据脱敏功能。
   ALTER DATABASE hg_anon_demo SET hg_anon_enable = on;
   
   --设置每一列的脱敏规则
   SECURITY LABEL FOR hg_anon ON COLUMN personal_basic_information.name IS 'name';
   SECURITY LABEL FOR hg_anon ON COLUMN personal_basic_information.id IS 'id';
   SECURITY LABEL FOR hg_anon ON COLUMN personal_basic_information.phone IS 'phone';
   SECURITY LABEL FOR hg_anon ON COLUMN personal_basic_information.email IS 'email';
   SECURITY LABEL FOR hg_anon ON COLUMN personal_basic_information.bank_id IS 'bank_id';
   SECURITY LABEL FOR hg_anon ON COLUMN personal_basic_information.ip IS 'ip';

6. 查看数据

   请断开数据库，重新登录数据库使用如下命令查看数据脱敏后的数据。

   SELECT * FROM personal_basic_information;

   脱敏后的数据如下所示。

   • 如果对账号ID为1365xxxxxxxxxxxx的用户设置不脱敏，SQL如下。

     SECURITY LABEL FOR hg_anon ON ROLE "1365xxxxxxxxxxxx" IS 'all:unmasked';

     查询数据结果如下。

   • 若对账号ID为1365xxxxxxxxxxxx的用户设置对于phone的标签不脱敏，SQL如下。

     SECURITY LABEL FOR hg_anon ON ROLE "1365xxxxxxxxxxxx" IS 'phone:unmasked';

     查询结果如下。

使用数据保护伞进行数据脱敏

您不仅可以手工设置脱敏规则，也可以使用数据保护伞进行数据脱敏。

• 使用限制。

  • 仅Hologres V1.1及以上版本支持使用数据保护伞进行数据脱敏，如果您的实例是V1.1以下版本，请您使用自助升级或加入Hologres钉钉交流群反馈，详情请参见如何获取更多的在线支持？。

  • 为了能够检测出敏感数据，保护伞对于主账号设置不脱敏的规则。

  • 目前每天9:00:00，保护伞会抽样数据，识别敏感数据，并对设置的敏感数据列设置脱敏规则。

  • 目前Hologres支持使用数据保护伞进行数据脱敏的地域有：华北2（北京）、华北3（张家口）、华东2（上海）、华东1（杭州）、华南1（深圳）、中国（香港）、新加坡、德国（法兰克福）、马来西亚（吉隆坡）、印度尼西亚（雅加达）、美国（硅谷）。

• 使用方法。

  • 开启脱敏功能。

    数据脱敏功能默认不开启，需要拥有Superuser权限的用户在对应的数据库中执行如下命令开启该功能。

    --安装数据脱敏EXTENSION
    CREATE EXTENSION IF NOT EXISTS hg_anon;
    --对指定的数据库开启数据脱敏功能，默认为关闭状态 
    ALTER DATABASE <db_name> SET hg_anon_enable = on;  

    db_name为需要开启数据脱敏功能的数据库。

    重要

    • hg_anon_enable是一个GUC，运行ALTER DATABASE命令后当前连接不生效。

    • 您可以使用如下SQL查看设置是否生效。

      SHOW hg_anon_enable;

  • 设置脱敏数据库。

    1. 登录数据保护伞控制台，详情请参见进入数据保护伞。

    2. 在左侧导航栏，单击规则配置 > 数据识别规则，进入数据识别规则页面。

    3. 在敏感数据识别页面创建一条数据识别规则，详情请参见数据识别规则。

    4. 在左侧导航栏，单击数据脱敏管理，进入数据脱敏管理页面。

    5. 在脱敏场景下拉列表中，选择Hologres展示脱敏（hologres_display_desense_code），并单击右侧选择脱敏database。

    6. 在授权账号脱敏对话框，从未脱敏database列表选择需要脱敏的数据库显示在脱敏database列表中，单击我同意授权数据保护伞对该database脱敏，单击确定。

    7. 在数据脱敏管理页面，单击右上方的新建脱敏规则，详情请参见数据脱敏管理，之后系统会对您设置的数据库进行脱敏。

常见问题