logback 使用regex匹配进行日志脱敏

已于 2022-04-28 14:19:34 修改
阅读量785 收藏
点赞数 4
文章标签： logback java
于 2022-04-28 12:01:32 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_33025651/article/details/124470568
版权

正则表达式 敏感数据 日志过滤 性能优化 信息安全
关键词由CSDN通过智能技术生成

我们使用正则表达式替换敏感数据，正则表达式中有5个组，例如：

/*
 * {phoneNumber=(+358)0393289092389},
 * then:
 *       (Group #1)          (Group #2)          (Group #3)          (Group #4)          (Group #5)
 *       {                   phoneNumber=        (+358)0393289092389                     }
 *
 *              Group #1                                                                                                                     Group #5
 *     ┌────────────────────────┐                                                                                                    ┌────────────────────────┐
 *     │    ┏━━━━━┓             │                                                                                                    │    ┏━━━━━┓             │
 *     │  ╭─┃ `[` ┃──────────╮  │                                                                                                    │  ╭─┃ `[` ┃──────────╮  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━┓          │  │                                                                                                    │  │ ┏━━━━━┓          │  │
 *     │  ├─┃ `]` ┃──────────┤  │                                                                                                    │  ├─┃ `]` ┃──────────┤  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━┓          │  │                                                                                                    │  │ ┏━━━━━┓          │  │
 *     │  ├─┃ `}` ┃──────────┤  │                                                                                                    │  ├─┃ `}` ┃──────────┤  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━┓          │  │                                                                                                    │  │ ┏━━━━━┓          │  │
 *     │  ├─┃ `{` ┃──────────┤  │                                                                                                    │  ├─┃ `{` ┃──────────┤  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━━━━━━━━━━┓ │  │                                                                                                    │  │ ┏━━━━━━━━━━━━━━┓ │  │
 *     │  ├─┃ `Begin with` ┃─┤  │                                                                                                    │  ├─┃ `Begin with` ┃─┤  │
 *     │  │ ┗━━━━━━━━━━━━━━┛ │  │                           Group #2                                    Group #3          Group #4   │  │ ┗━━━━━━━━━━━━━━┛ │  │
 *     │  │ ┏━━━━━━━━━━━━┓   │  │  ┌──────────────────────────────────────────────────────────┐  ┌───────────────────┐  ┌─────────┐  │  │ ┏━━━━━━━━━━━━┓   │  │
 *     │  ├─┃ `End with` ┃───┤  │  │                               One of                     │  │      One of       │  │         │  │  ├─┃ `End with` ┃───┤  │
 *     │  │ ┗━━━━━━━━━━━━┛   │  │  │ ┏━━━━━━━┓  ┏━━━━━┓  ┏━━━━━┓  ┏━━━━━━━┓  ┏━━━━━┓  ┏━━━━━┓ │  │ ┏━━━━━━━━━━━━━━━┓ │  │ ┏━━━━━┓ │  │  │ ┗━━━━━━━━━━━━┛   │  │
 * ◯───┼──┤ ┏━━━━━━┓         ├──┼──┼─┃ `Key` ┃──┃ `"` ┃──┃ ` ` ┃──┃ `:|=` ┃──┃ ` ` ┃──┃ `"` ┃─┼──┼─┃ `_%\w@ .+)(-` ┃─┼──┼─┃ `"` ┃─┼──┼──┤ ┏━━━━━━┓         ├──┼───◯
 *     │  ├─┃ `, ` ┃─────────┤  │  │ ┗━━━━━━━┛  ┗━━━━━┛  ┗━━━━━┛  ┗━━━━━━━┛  ┗━━━━━┛  ┗━━━━━┛ │  │ ┗━━━━━━━━━━━━━━━┛ │  │ ┗━━━━━┛ │  │  ├─┃ `, ` ┃─────────┤  │
 *     │  │ ┗━━━━━━┛         │  │  │             (0-1)    (0-2)               (0-2)    (0-1)  │  │      (1-∞)        │  │  (0-1)  │  │  │ ┗━━━━━━┛         │  │
 *     │  │ ┏━━━━━┓          │  │  └──────────────────────────────────────────────────────────┘  └───────────────────┘  └─────────┘  │  │ ┏━━━━━┓          │  │
 *     │  ├─┃ `,` ┃──────────┤  │                                                                                                    │  ├─┃ `,` ┃──────────┤  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━┓          │  │                                                                                                    │  │ ┏━━━━━┓          │  │
 *     │  ├─┃ ` ` ┃──────────┤  │                                                                                                    │  ├─┃ ` ` ┃──────────┤  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━┓          │  │                                                                                                    │  │ ┏━━━━━┓          │  │
 *     │  ├─┃ `;` ┃──────────┤  │                                                                                                    │  ├─┃ `;` ┃──────────┤  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━┓          │  │                                                                                                    │  │ ┏━━━━━┓          │  │
 *     │  ├─┃ `"` ┃──────────┤  │                                                                                                    │  ├─┃ `"` ┃──────────┤  │
 *     │  │ ┗━━━━━┛          │  │                                                                                                    │  │ ┗━━━━━┛          │  │
 *     │  │ ┏━━━━━┓          │  │                                                                                                    │  │ ┏━━━━━┓          │  │
 *     │  ╰─┃ `.` ┃──────────╯  │                                                                                                    │  ╰─┃ `.` ┃──────────╯  │
 *     │    ┗━━━━━┛             │                                                                                                    │    ┗━━━━━┛             │
 *     └────────────────────────┘                                                                                                    └────────────────────────┘
 *
 */

首先还是继承logback的MessageConverter类，重写convert方法

public class SensitiveDataConverter extends MessageConverter

给一些参数做成了可配置的
 

private final static String SENSITIVE_DEFAULT_DATA_KEYS       = "fullName,firstName,lastName,middleName,address,ipAddress,nationalIdNumber,email,phoneNumber,mobile,birthDate,city,bankCard";
    private final static String SENSITIVE_DATA_MASKING_ENABLED    = "true";
    private final static String SENSITIVE_DEFAULT_DATA_EXCLUSIONS = "INPUT_OUTPUT_MICROGAMING";
    private final static String SENSITIVE_DEFAULT_DATA_DELIMITERS = "(\\[|\\]|\\}|\\{|^|$|, |,| |;|\"|\\.)";

    private final static boolean      maskEnabled;
    private final static List<String> sensitiveDataKeys;
    private final static List<String> sensitiveDataExclusionsKeys;
    private final static List<String> regexList;

    static {
        String maskEnabledConfig                 = StringUtil.isEmptyString(System.getenv("SENSITIVE_DATA_MASKING_ENABLED")) ? SENSITIVE_DATA_MASKING_ENABLED : System.getenv("SENSITIVE_DATA_MASKING_ENABLED");
        String sensitiveDataKeysConfig           = StringUtil.isEmptyString(System.getenv("SENSITIVE_DATA_KEYS")) ? SENSITIVE_DEFAULT_DATA_KEYS : System.getenv("SENSITIVE_DATA_KEYS");
        String sensitiveDataExclusionsKeysConfig = StringUtil.isEmptyString(System.getenv("SENSITIVE_DATA_EXCLUSIONS")) ? SENSITIVE_DEFAULT_DATA_EXCLUSIONS : System.getenv("SENSITIVE_DATA_EXCLUSIONS");
        String Delimiters                        = StringUtil.isEmptyString(System.getenv("SENSITIVE_DATA_DELIMITERS")) ? SENSITIVE_DEFAULT_DATA_DELIMITERS : System.getenv("SENSITIVE_DATA_DELIMITERS");

        maskEnabled = "true".equals(maskEnabledConfig);
        sensitiveDataKeys = Arrays.asList(sensitiveDataKeysConfig.split(","));
        sensitiveDataExclusionsKeys = Arrays.asList(sensitiveDataExclusionsKeysConfig.split(","));
        regexList = sensitiveDataKeys.stream().map(key -> Delimiters + "(" + key + " {0,2}\"?[:|=]\"? {0,2})((?!null)[\\\\_%\\w@.+)(-]+)(\"?)" + Delimiters).collect(Collectors.toList());
    }
@Override
    public String convert(ILoggingEvent event) {
        String logText = event.getFormattedMessage();
        return filterSensitiveInformation(logText);
    }

    public static String filterSensitiveInformation(String logText) {
        if (!maskEnabled || hasExclusion(logText)) {
            return logText;
        }

        AtomicReference<String> maskedText = new AtomicReference<>(logText);
        regexList.forEach(regex -> {
            maskedText.set(maskedText.get().replaceAll(regex, "$1$2****$4$5"));
        });

        return maskedText.get();
    }

    private static boolean hasExclusion(String logText) {
        return sensitiveDataExclusionsKeys.stream().anyMatch(logText::contains);
    }

优点：对于短的log匹配很方便很快
缺点：对于特别长的log，regex匹配性能呈指数下降，非常影响服务器性能，建议斟酌使用。
 

下期来细细讲解一下regex的匹配机制

Xmange233
关注
logback - 自定义日志脱敏组件，一种不错的脱敏方案
2301_78588786的博客
06-20 971
patterns:# 手机号custom:# 手机号的正则# 脱敏范围customRegex：正则表达式，如果符合该表达式，则使用其对应的脱敏规则(position)比如说，username字段的值可以是手机号、也可以是邮箱，这个值动态改变的，前面几种方式都没办法解决，可以使用该方式。patterns:custom:# 手机号 - 11位# 邮箱 - @# 身份证 - 15/18位# 自定义正则# 都匹配不到时，按照这种规则来注意：上面示例中匹配规则里的 双引号和括号 都不能省略。
logback 日志脱敏
GoodIdea
03-05 7279
最近在研究如何使用logback实现日志脱敏的工作，网上各种查，各种找，终于找到了解决的办法。其实原理知道，就是想找一个最简便的方法而已。那今天咱们就来聊聊如何用Logback创建自定义格式转换符来实现日志脱敏** 脱敏类文件 配置文件 脱敏类文件 数据脱敏是指对某些敏感信息通过脱敏规则进行数据的变形，实现敏感隐私数据的可靠保护。 —— [ 百度百科 ] 本文使用最简单的脱敏方式进行数据脱敏打...
logback日志脱敏
weixin_38871390的博客
05-04 765
其中 msg是原始地要打印的日志信息 buildSensitiveMsg()方法是逐一根据配置好的脱敏规则进行匹配和替换敏感数据. 此处多个脱敏规则是可以叠加处理的，就是一个规则处理后的结果可以作为另外一个规则的处理起始数据。5. 执行 MyLogbackPatternLayoutEncoder类的 start方法。4. 将封装好的脱敏正则加入 replace集合中。1. 占位符填充以及脱敏处理。2. 设置脱敏正则表达式。6. 转化编码为UTF-8。
logback实现日志脱敏
嘻上槑梢的博客
05-27 8240
许多系统为了安全需要对敏感信息（如手机号、邮箱、姓名、身份证号、密码、卡号、住址等）的日志打印要求脱敏后才能输出，本文将结合个人经历及总结分享一种logback日志脱敏方式，log4j实现日志脱敏请移步 准备工作 定义脱敏转换相关的类 定义RegexReplacement package my.logback; import java.util.regex.Pattern; public class RegexReplacement { /** * 脱敏匹配正则 */.
springmvc log4j2 logback 注解 jackson 日志脱敏实现源码
12-30
本资源包含的是关于`SpringMVC`、`Log4j2`、`Logback`以及`Jackson`的日志脱敏实现源码，提供了多种实现方式，旨在帮助开发者在保障信息安全的同时，充分利用日志进行系统分析。 1. **基于正则表达式的日志脱敏实现...
Logback+Slf4j，基于SpringBoot实现日志脱敏.zip
最新发布
04-08
《基于SpringBoot的日志脱敏：Logback与Slf4j的实战应用》 在现代的软件开发中，日志系统是不可或缺的一部分，它为开发者提供了系统运行时的详细信息，帮助排查问题，优化性能。SpringBoot框架以其简洁的配置和强大...
logback打印日志字段脱敏加密
Breaking_xu的博客
09-27 2431
logback自定义转换器，不需要修改原来代码，是在日志打印时对其参数进行加密处理，拓展性强。创建自定义转换类MySampleConverter, 继承MessageConverter类,并实现convert方法。}}让我们来看一下event里面是什么这个时候长得帅的小伙伴们都反应过来了，介不就是格式化后的日志吗！长得不那么帅的小伙伴就会问了，接下来呐！怎么办啊！当然是为所欲为了
terse-logback：使用Logback进行结构化的日志记录，跟踪和可观察性
02-03
简短的登录 Terse Logback是扩展的集合，扩展显示了如何有效地将用于，，和 。... 仅使用日志和功能标志破解了最巧妙的小解决方案： : —慈善专业（@mipsytipsy） 文献资料 可从获得文档。 展示柜 在有一个展示项目。
Springboot异常日志输出
dxdxdx11的博客
10-26 2688
一 lombok插件使用： 引入依赖,在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写 ↓ <!--lombok用来简化实体类--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.20&lt
使用logback对系统产生的日志文件进行脱敏处理
qq_42077566的博客
09-08 4167
业务场景 开发中，对于打印出来的日志文件，涉及到敏感信息，类似银行卡，姓名，身份证等等，通常会根据需求进行关键词的隐藏，比如姓名：万旭会处理后在日志中显示：姓名：万*。这样的过程叫做日志关键词脱敏。 如下使用logback进行脱敏操作和配置。 配置枚举类 用来管理需要脱敏的关键词 public enum KeywordTypeEnum { /** * 真实姓名 */ TRUE_NAME("trueName","真实姓名"), /** * 身份证号码
logback实现日志信息脱敏
lh87270202的博客
11-12 6999
文章目录一、一些敏感信息比如 手机号、身份证号，不在明文在日志中打印，自定义logback转换器，将这些字段脱敏后输出1、定义一个ESensitiveDataConverter 类如下：2、logback.xml中添加如下配置： 一、一些敏感信息比如 手机号、身份证号，不在明文在日志中打印，自定义logback转换器，将这些字段脱敏后输出 1、定义一个ESensitiveDataConverter 类如下： import ch.qos.logback.classic.pattern.MessageConve
logback日志脱敏处理
qq_39284377的博客
06-18 2677
logback.xml配置文件修改 <springProperty scope="context" name="log.consolePattern" source="hcf.log.console-pattern" defaultValue="%red(%d{yyyy-MM-dd HH:mm:ss.SSS})|%highlight(%level)|%green(%thread)|%X{clientIp}|%X{traceId}|%X{rpcId}|%boldMagenta(%c.%M[%L])|
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值