复古 护眼 海天 深邃 暗黑 默认

脱敏算法

背景信息

脱敏算法是 Apache ShardingSphere 的脱敏功能使用的算法，ShardingSphere 内置了多种算法，可以让用户方便使用。

参数解释

哈希脱敏算法

MD5 脱敏算法

类型：MD5

可配置属性：

名称 数据类型 说明
salt String 盐值（可选）

遮盖脱敏算法

保留前 N 后 M 脱敏算法

类型：KEEP_FIRST_N_LAST_M

可配置属性：

名称 数据类型 说明
first-n int 前 n 位
last-m int 后 n 位
replace-char String 替换字符

保留自 X 至 Y 脱敏算法

类型：KEEP_FROM_X_TO_Y

可配置属性：

名称 数据类型 说明
from-x int 起始位置（从 0 开始）
to-y int 结束位置（从 0 开始）
replace-char String 替换字符

遮盖前 N 后 M 脱敏算法

类型：MASK_FIRST_N_LAST_M

可配置属性：

名称 数据类型 说明
first-n int 前 n 位
last-m int 后 n 位
replace-char String 替换字符

遮盖自 X 至 Y 脱敏算法

类型：MASK_FROM_X_TO_Y

可配置属性：

名称 数据类型 说明
from-x int 起始位置（从 0 开始）
to-y int 结束位置（从 0 开始）
replace-char String 替换字符

特殊字符前遮盖脱敏算法

类型：MASK_BEFORE_SPECIAL_CHARS

可配置属性：

名称 数据类型 说明
special-chars String 特殊字符（首次出现）
replace-char String 替换字符

特殊字符后遮盖脱敏算法

类型：MASK_AFTER_SPECIAL_CHARS

可配置属性：

名称 数据类型 说明
special-chars String 特殊字符（首次出现）
replace-char String 替换字符

替换脱敏算法

身份证随机替换脱敏算法

类型：PERSONAL_IDENTITY_NUMBER_RANDOM_REPLACE

可配置属性：

名称 数据类型 说明
alpha-two-country-area-code String 两位字母国家/地区编码（可选，默认：CN）

军官证随机替换脱敏算法

类型：MILITARY_IDENTITY_NUMBER_RANDOM_REPLACE

可配置属性：

名称 数据类型 说明
type-codes String 军官证种类编码（以英文逗号分隔，例如：军,人,士,文,职）

手机号随机替换脱敏算法

类型：TELEPHONE_RANDOM_REPLACE

可配置属性：

名称 数据类型 说明
network-numbers String ⽹号（以英文逗号分隔，默认值：130,131,132,133,134,135,136,137,138,139,150,151,152,153,155,156,157,158,159,166,170,176,177,178,180,181,182,183,184,185,186,187,188,189,191,198,199）

座机号码随机替换

类型：LANDLINE_NUMBER_RANDOM_REPLACE

可配置属性：

名称 数据类型 说明
landline-numbers String 座机号码（以英文逗号分隔）

通⽤表格随机替换

类型：GENERIC_TABLE_RANDOM_REPLACE

可配置属性：

名称 数据类型 说明
uppercase-letter-codes String 大写字母码表（以英文逗号分隔，默认值：A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z）
lowercase-letter-codes String 小写字母码表（以英文逗号分隔，默认值：a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z）
digital-codes String 数字码表（以英文逗号分隔，默认值：0,1,2,3,4,5,6,7,8,9）
special-codes String 特殊字符码表（以英文逗号分隔，默认值：~,!,@,#,$,%,^,&,*,:,<,>,¦）

统⼀信⽤码随机替换

类型：UNIFIED_CREDIT_CODE_RANDOM_REPLACE

可配置属性：

名称 数据类型 说明
registration-department-codes String 登记管理部门代码（以英文逗号分隔）
category-codes String 机构类别代码（以英文逗号分隔）
administrative-division-codes String 行政区划随机码表（以英文逗号分隔）

操作步骤

  1. 在脱敏规则中配置脱敏算法；
  2. 为脱敏算法指定脱敏算法类型。

配置示例

rules:
- !MASK
  tables:
    t_user:
      columns:
        password:
          maskAlgorithm: md5_mask
        email:
          maskAlgorithm: mask_before_special_chars_mask
        telephone:
          maskAlgorithm: keep_first_n_last_m_mask

  maskAlgorithms:
    md5_mask:
      type: MD5
    mask_before_special_chars_mask:
      type: MASK_BEFORE_SPECIAL_CHARS
      props:
        special-chars: '@'
        replace-char: '*'
    keep_first_n_last_m_mask:
      type: KEEP_FIRST_N_LAST_M
      props:
        first-n: 3
        last-m: 4
        replace-char: '*'

相关参考