Skip to main content
Bytebase Dynamic Data Masking can mask sensitive data in the query result based on the context on the fly. It helps organizations to protect sensitive data from being exposed to unauthorized users. bb-masking-overview
This tutorial covers configuration via UI console. You can also codify the masking policies, check out this sample.

​
Prerequisites

  • Docker
  • Bytebase Enterprise plan, you can request a free trial here

​
Preparation

  1. Make sure your Docker is running, and start the Bytebase Docker container with command: 
    docker run --rm --init \
  --name bytebase \
  --publish 8080:8080 --pull always \
  --volume ~/.bytebase/data:/var/opt/bytebase \
  bytebase/bytebase:latest
  2. Having Bytebase successfully running in Docker, visit it via localhost:8080. Register an admin account and it will be granted the workspace admin role automatically.
  3. Acquire the Enterprise license. Enter Instances on the left. Select both instances to Assign License.

​
No Masking

Enter SQL Editor on top right. Without any worksheet open (no tab page open on top), click Connect to a database or Select a database to start. sql-editor-entry Choose database hr_prod under Prod Sample Instance within the Connection detail page. Run SELECT * FROM employee;, you’ll see the following result without any masking. prod-without-masking

​
Semantic Types

Semantic type is a way to classify data into different categories. You may apply them to columns to apply the same masking rule.
  1. Enter Data Access > Semantic Types, click Add.
  2. Fill in the name, description and specify the Masking Algorithm. Click the check mark.
bb-semantic-type There are two ways to apply the semantic type and its masking algorithm:
  1. Apply to a column directly.
  2. Apply according to a global masking rule.

​
Column Masking Rule

As a project owner, you may want to apply the semantic type to a column, usually it’s a column that you want to mask on production environment.
  1. Go into the project Sample Project, and click database hr_prod.
  2. Go into the employee table, and set the birth_date column to apply the birth_date semantic type. bb-column-semantic-type
  3. Go back to SQL Editor, run SELECT * FROM employee; within hr_prod. You’ll see the birth_date is masked based on the masking algorithm. bb-sql-editor-column-masking

​
Global Masking Rule

As a DBA, you may want to batch apply masking settings. Use Global Masking Rule to achieve this.
  1. Enter Data Access > Semantic Types, click Use Predefined Type.
  2. Add the predefined type Default.
  3. Enter Data Access > Global Masking Rule, click Add.
  4. Here define a global masking rule to mask all the birth_date columns in all tables on production environment with semantic type Default, and click Confirm. bb-global-masking-rule
  5. Go back to SQL Editor, run SELECT * FROM employee; within hr_prod. You’ll see the birth_date is masked. bb-sql-editor-column-masking
  6. You may also notice that the global masking rule take precedence over the column masking rule.

​
Export data with masked columns

Exported data is masked in the same way as query results.
  1. Stay on the SQL Editor after querying, and click Export. bb-sql-editor-export
  2. Fill in the export rows number, choose the format and click Confirm. The file will start downloading.
  3. Open the downloaded file, you’ll see the birth_date is masked. exported-data

​
Masking Exemptions

You can reveal masked data to a specific user by granting masking exemption.
  1. Go into the project Sample Project, and click Manage > Masking Exemptions.
  2. Grant exemption to the user and click Confirm. bb-masking-exemption
  3. Go back to SQL Editor, run SELECT * FROM employee; within database hr_prod. You’ll see the birth_date is unmasked. bb-sql-editor-exemption
  4. If you export the data, the birth_date is also unmasked. exported-data-exemption

​
Related content