CREATE MASKING POLICY

Function

CREATE MASKING POLICY creates a masking policy.

Precautions

Only users with the poladmin or sysadmin permission, or the initial user can perform this operation.

The masking policy takes effect only after the security policy is enabled, that is, enable_security_policy is set to on.

For details about the execution effect and supported data types of preset masking functions, see “Database Security > Dynamic Data Masking” in Feature Description.

Syntax

CREATE MASKING POLICY policy_name masking_clause[, ...]* policy_filter [ENABLE | DISABLE];

• masking_clause

  masking_function ON LABEL(label_name[, ...]*)
  

• masking_function

  maskall is not a preset function. It is hard-coded and cannot be displayed by running \df.

  The masking methods during presetting are as follows:

  maskall | randommasking | creditcardmasking | basicemailmasking | fullemailmasking | shufflemasking | alldigitsmasking | regexpmasking
  

• policy_filter:

  FILTER ON FILTER_TYPE(filter_value [,...]*)[,...]*
  

• FILTER_TYPE:

  IP | APP | ROLES
  

Parameter Description

• policy_name

  Specifies the audit policy name, which must be unique.

  Value range: a string. It must comply with the naming convention.

• label_name

  Specifies the resource label name.

• masking_clause

  Specifies the masking function to be used to anonymize database resources labeled by label_name. schema.function can be used to specify the masking function.

• policy_filter

  Specifies the users for which the masking policy takes effect. If this parameter is left empty, the masking policy takes effect for all users.

• FILTER_TYPE

  Specifies the types of information to be filtered by the policy, including IP, APP, and ROLES.

• filter_value

  Indicates the detailed information to be filtered, such as the IP address, app name, and username.

• ENABLE|DISABLE

  Enables or disables the masking policy. If ENABLE|DISABLE is not specified, ENABLE is used by default.

Examples

-- Create users dev_mask and bob_mask.
openGauss=# CREATE USER dev_mask PASSWORD 'dev@1234';
openGauss=# CREATE USER bob_mask PASSWORD 'bob@1234';

-- Create table tb_for_masking.
openGauss=# CREATE TABLE tb_for_masking(col1 text, col2 text, col3 text);

-- Create a resource label for label sensitive column col1.
openGauss=# CREATE RESOURCE LABEL mask_lb1 ADD COLUMN(tb_for_masking.col1);

-- Create a resource label for label sensitive column col2.
openGauss=# CREATE RESOURCE LABEL mask_lb2 ADD COLUMN(tb_for_masking.col2);

-- Create a masking policy for the operation of accessing sensitive column col1.
openGauss=# CREATE MASKING POLICY maskpol1 maskall ON LABEL(mask_lb1);

-- Create a masking policy that takes effect only for scenarios where users are dev_mask and bob_mask, client tools are psql and gsql, and IP addresses are 10.20.30.40, and 127.0.0.0/24.
openGauss=# CREATE MASKING POLICY maskpol2 randommasking ON LABEL(mask_lb2) FILTER ON ROLES(dev_mask, bob_mask), APP(psql, gsql), IP('10.20.30.40', '127.0.0.0/24');

Helpful Links

ALTER MASKING POLICY and DROP MASKING POLICY