springboot脱敏控件再升级(支持日志脱敏)

我正在参加「掘金·启航计划」

数据脱敏指指对某些敏感信息通过脱敏规则进行数据的变形,实现敏感隐私数据的可靠保护。如我们日常可以看到的手机号“156****8888”等,专注安全问题,解决脱敏需求,避免大家重复造轮子,secure-ext-spring-boot-starter控件已提供返回值脱敏的策略及使用方法。但是在实际开发中我们总是习惯性忽略“日志”这一个重要内容,虽然有爆出“Github密码重置功能出现漏洞 日志中以明文形式记录了用户密码”的问题,但是由于日志脱敏对于一个公司(特别是小公司)来说,投入产出比显得有点低。因此secure-ext-spring-boot-starter控件旨在降低开发成本,提供易集成、低侵入(基本无侵入)的工具给大家使用。

最新版本

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

1 引入依赖

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

2 开启脱敏注解

sensitive:
  log-info:
    enable: true # 开启日志脱敏
    categories: # 分类参数--可以自己自由添加
      - keywords: name,chineseName # 分类关键词
        pre-length: 1 # 字符串前半部分留几位明文
        suf-length: 1 # 字符串后半部分留几位明文
      - keywords: mail,email # 分类关键词
        pre-length: 3 # 字符串前半部分留几位明文
        suf-length: 3 # 字符串后半部分留几位明文

3 修改logback.xml

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

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

4 语法示例

4.1 基于json对象的脱敏

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

        JSONObject jsonObject = new JSONObject();
        jsonObject.putOpt("name",name);
        jsonObject.putOpt("mobile",mobile);
        log.info("基于json的脱敏---》jsonObject is jsonObject {} ",jsonObject);

4.2 基于简单对象的脱敏

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

        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^{}+空格 ;

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

5 脱敏结果

日志脱敏结果.jpg

6开源项目

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,319评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,801评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,567评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,156评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,019评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,090评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,500评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,192评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,474评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,566评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,338评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,212评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,572评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,890评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,169评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,478评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,661评论 2 335

推荐阅读更多精彩内容