springboot脱敏控件再升级（支持日志脱敏）

数据脱敏指指对某些敏感信息通过脱敏规则进行数据的变形，实现敏感隐私数据的可靠保护，如我们日常可以看到的手机号“156**8888”等。

专注安全问题，解决脱敏需求，避免大家重复造轮子，secure-ext-spring-boot-starter控件已提供返回值脱敏的策略及使用方法。但是在实际开发中我们总是习惯性忽略“日志”这一个重要内容，虽然有爆出“Github密码重置功能出现漏洞日志中以明文形式记录了用户密码”的问题，但是由于日志脱敏对于一个公司（特别是小公司）来说，投入产出比显得有点低。因此secure-ext-spring-boot-starter控件旨在降低开发成本，提供易集成、低侵入（基本无侵入）的工具给大家使用。

最新版本

最新发布版已更新到mave中央仓库：[Maven Central][2.0.0-release]

1 引入依赖

代码语言：javascript复制

<dependency>
  <groupId>io.gitee.chemors</groupId>
  <artifactId>secure-ext-spring-boot-starter</artifactId>
  <version>Lastest Version</version>
</dependency>

2 开启脱敏注解

代码语言：javascript复制

sensitive:
  log-info:
    enable: true
    categories:
      - keywords: name,chineseName
        pre-length: 1
        suf-length: 1
      - keywords: mail,email
        pre-length: 3
        suf-length: 3
      - keywords: mobile,phone
        pre-length: 3
        suf-length: 4
      - keywords: address,addr
        pre-length: 3
        suf-length: 4

3 修改logback.xml

很简单，在logback.xml最前面添加一行（重写原%msg规则的实现）

代码语言：javascript复制

 <conversionRule conversionWord="msg" converterClass="io.gitee.chemors.secure.ext.log.core.LogBackCoreConverter"/>

4 语法示例

4.1 基于json对象的脱敏

无侵入，继续使用logback语法即可，已有代码无需改造

代码语言：javascript复制

JSONObject jsonObject = new JSONObject();
jsonObject.putOpt("name",name);
jsonObject.putOpt("mobile",mobile);

log.info("基于json的脱敏---》jsonObject is jsonObject {} ",jsonObject);

4.2 基于简单对象的脱敏

无侵入，继续使用logback语法即可，已有代码无需改造。注意：考虑到性能以及实用性的问题，复杂的嵌套对象暂未解析，即只解析对象的第一层属性。(示例中的address不会被解析)

代码语言：javascript复制

 SensitiveEntity sensitiveEntity = new SensitiveEntity();
 sensitiveEntity.setName(name);
 sensitiveEntity.setMobile(mobile);

  SensitiveSubEntity sensitiveSubEntity = new SensitiveSubEntity();
  sensitiveSubEntity.setAddress("中国 河南 郑州");
  sensitiveEntity.setSubEntities(Arrays.asList(sensitiveSubEntity));
  SensitiveEntity sensitiveEntity2 = new SensitiveEntity();
  sensitiveEntity2.setName(name   "222");
  sensitiveEntity2.setMobile(mobile   "333");
  log.info("基于实体类的脱敏---》sensitiveEntity1 is {} and sensitiveEntity2 is {}",sensitiveEntity,sensitiveEntity2);

4.3 基于字符串的脱敏（语法有调整）

由于脱敏是基于key-value模式，因此需要指定key，才可以解析出脱敏规则，因此语法需稍微调整为：空格 key^{} 空格 ;

代码语言：javascript复制

 log.info("基于字符串的脱敏---》name is name^{} , and mobile is mobile^{}",name, mobile);

5 脱敏结果

6开源项目

欢迎大家star，您的star就是我坚持开源的动力。另外，有问题欢迎提issue。

脱敏控件（含demo）
开发脚手架eboot

编程算法 spring xml 开源

0 人点赞