log4j2配置日志中敏感字符掩码输出

最新推荐文章于 2024-06-20 09:45:44 发布

lackdaylad

最新推荐文章于 2024-06-20 09:45:44 发布

阅读量1.8k

点赞数

分类专栏： java 文章标签： java log4j2 正则表达式

本文链接：https://blog.youkuaiyun.com/lackdaylad/article/details/120036496

版权

java 专栏收录该内容

3 篇文章

订阅专栏

背景

最近项目中需要对日志输出的敏感信息做掩码处理, 由于需要处理的地方太多而且比较麻烦, 所以就研究了下, 看看log4j2有没有提供某种可以统一处理方式

方案1(正则匹配)

看了官方文档后发现有个简单快捷的方式就是使用正则可以直接匹配替换相关信息

我们的日志输出使用的<PatternLayout>

Log4j – Log4j 2 Layouts

按照文档中写的将相应处理的正则写到具体需要替换的地方就可以了, 一般都是%msg

我这边写的就是处理(手机号/身份证号/银行卡号), 网上看到微信处理9~29位数字都算银行卡号

因为我们日志中一般输出这些信息都是json形式, 所以这边就简单粗暴, 直接匹配双引号括住的串, 直接一个正则匹配所有, 默认只要是数字达到相应长度就处理

<Property name="regex">%replace{%msg}{"([1-9][0-9]{2})([0-9]{6})([0-9]+|[0-9]+X)"}{"$1***$3"}</Property>
<Property name="pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%22t] %-5level %c{1.} %M-${regex}%xEx%n</Property>

下面就是具体的日志输出

另外一种方式就是写了多个正则匹配, 不过比较麻烦, 而且没法按照上面那样输出$1$3, 所有就没采用, 不过也贴出来, 供大家参考

([1][3-9][0-9]{9})|([1-9][0-9]{16}([0-9]|X))|([1-9][0-9]{9,29})

方案2(重写PatternLayout)

上面的方案1处理太过简单, 而且只能使用一个正则, 没法用于相对比较复杂的情况, 这时候可以重写PatternLayout。

不过重写Layout相对麻烦点, 对于当下我的需求来说没必要, 所以也仅仅是了解了下, 大概思想就是按照PatternLayout重写一个自己的Layout, 然后按照自己的需求处理msg, 有兴趣的同学可以自行研究

log4j2 日志脱敏/特殊处理_Saytime-优快云博客_log4j2日志脱敏

之前的方案1只支持一种正则, 由于我们目前需求要处理多个信息, 所以之前的方式不满足了, 又翻了翻, 按照上面这个文章里的方案, 应该都可以满足

我个人在实现过程中感觉用起来比较麻烦, 最后决定重写MessagePatternConverter

直接复制MessagePatternConverter代码, 改为个类名就可以, 自定义ConverterKeys以及Plugin中的name, 然后在format(LogEvent event, StringBuilder toAppendTo)方法中处理msg就可以, 相对比较简单, 基本上不需要自己写啥, 自己实现多规则正则匹配替换就行