Skip to content

Commit ab118d6

Browse files
committed
docs: update masking
1 parent 603245a commit ab118d6

File tree

8 files changed

+19
-37
lines changed

8 files changed

+19
-37
lines changed

content/docs/_layout.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ expand_section_list: ['Self-host']
99

1010
## [Use Cases](/introduction/use-cases)
1111

12-
## [POC Checklist 📝](/poc)
12+
## [POC Checklist 📝](/poc)Self-host
1313

1414
## [Best Practices 📘](/onboarding)
1515

@@ -179,16 +179,16 @@ expand_section_list: ['Self-host']
179179

180180
### [Semantic Types](/security/data-masking/semantic-types)
181181

182+
#### [Masking Algorithm](/security/data-masking/masking-algorithm)
183+
182184
### [Global Masking Rule](/security/data-masking/global-masking-rule)
183185

186+
#### [Data Classification](/security/data-masking/data-classification)
187+
184188
### [Column Masking](/security/data-masking/column-masking)
185189

186190
### [Masking Exemption](/security/data-masking/access-unmasked-data)
187191

188-
### [Masking Algorithm](/security/data-masking/masking-algorithm)
189-
190-
### [Data Classification](/security/data-masking/data-classification)
191-
192192
---
193193

194194
## Security Admin 🔐

content/docs/security/data-masking/data-classification.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
title: Data Classification
33
---
44

5-
Data classification allows you to classify columns and apply masking levels to the classified columns globally.
6-
This allows you to manage masking policy for many columns by controlling only a small number of classifications.
5+
Data classification allows you to classify columns and apply masking to those columns via the [Global Masking Rule](/docs/security/data-masking/global-masking-rule). This allows you to manage masking policy for many columns by controlling only a small number of classifications.
76

87
![overview](/content/docs/security/data-classification/classification-overview.webp)
98

content/docs/security/data-masking/global-masking-rule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Masking precedence: [Masking Exemption](/security/data-masking/access-unmasked-d
88

99
</HintBlock>
1010

11-
You may want to batch apply masking settings. e.g.
11+
Admins may want to batch apply masking settings globally. e.g.
1212

1313
- Mask all data in production
1414
- Mask all data for database under a specific project

content/docs/security/data-masking/overview.md

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,43 +16,26 @@ You can configure the masking policies from UI or via API. Check out [this GitOp
1616

1717
</HintBlock>
1818

19-
## How Dynamic Masking works
19+
## Configure Dynamic Data Masking
2020

21-
Bytebase dynamic masking transforms the original column data to the masked form in 2 steps:
21+
- Workspace-level admins configure the [Global Masking Rule](/docs/security/data-masking/global-masking-rule), [Semantic Types](/docs/security/data-masking/semantic-types), and [Masking Algorithm](/docs/security/data-masking/masking-algorithm).
2222

23-
1. [Determine the effective column masking level](#determine-the-effective-column-masking-level)
23+
- Project-level owners configure the [Column Masking](/docs/security/data-masking/column-masking) on the table column. This is only needed when the global masking rule is not applicable to a particular project.
2424

25-
1. [Determine the masking algorithm according to the masking level](#determine-the-masking-algorithm)
25+
- Workspace-level admins or project-level owners grant [Masking Exemption](/docs/security/data-masking/access-unmasked-data) to the users to access the unmasked data.
2626

27-
### Determine the effective column masking level
27+
## Determine whether to mask data
2828

29-
Bytebase defines 3 masking levels: `No Masking`, `Partial Masking`, `Full Masking`.
29+
![bb-masking-detail](/content/docs/security/data-masking/bb-masking-detail.webp)
3030

31-
![masking-level](/content/docs/security/data-masking/masking-level.webp)
31+
### Masking precedence
3232

33-
The effective column masking level is determined by the inherent column masking level and the user access grant.
33+
1. [Masking Exemption](/docs/security/data-masking/access-unmasked-data). If user has been granted exemption, the data will not be masked.
3434

35-
| Inherent Column Masking Level | User Access Grant | Effective Column Masking Level |
36-
| ----------------------------- | ----------------- | ------------------------------ |
37-
| No Masking | No Masking | No Masking |
38-
| | Partial Masking | No Masking |
39-
| Partial Masking | No Masking | No Masking |
40-
| | Partial Masking | Partial Masking |
41-
| Full Masking | No Masking | No Masking |
42-
| | Partial Masking | Partial Masking |
35+
1. [Global Masking Rule](/docs/security/data-masking/global-masking-rule). If no exemption is granted, the global masking rule will be applied.
4336

44-
### Determine the masking algorithm
37+
1. [Column Masking](/docs/security/data-masking/column-masking). If no global masking rule is configured, the column masking will be applied.
4538

46-
Once the masking level is determined, the next step is to determine the corresponding masking algorithm.
39+
### Masking algorithm
4740

48-
![masking-algorithm](/content/docs/security/data-masking/masking-algorithm.webp)
49-
50-
Bytebase provides the default masking algorithm for `Partial Masking` and `Full Masking`:
51-
52-
- **Partial Masking**. Use `*` to cover the start and end of the text.
53-
- **Full Masking**. Use `*` to cover all text.
54-
55-
You can also [customize the masking algorithm](../masking-algorithm) and specify it on the column.
56-
57-
Further, if you want to manage masking algorithms for different column categories, you can use
58-
[Semantic Types](../semantic-types).
41+
The global masking rule and column masking are both mapped to the [Semantic Types](/docs/security/data-masking/semantic-types). The semantic type determines the masking algorithm.
106 KB
Loading
-6.75 KB
Loading
-106 KB
Binary file not shown.
-182 KB
Binary file not shown.

0 commit comments

Comments
 (0)