在SpringBoot 应用程序中对Log4j 日志中的敏感数据进行脱敏,我们可以通过实现自定义日志的Appender结合正则表达式等来识别和屏蔽敏感信息。
第 1 步:创建自定义 Appender
创建一个Log4j 提供的AppenderSkeleton的类扩展类。自定义Appender将在日志消息写入日志之前拦截日志消息并处理敏感信息。
import org.apache.log4j.AppenderSkeleton;
import org.apache.log4j.spi.LoggingEvent;
public class MaskingAppender extends AppenderSkeleton {
@Override
protected void append(LoggingEvent loggingEvent) {
String message = loggingEvent.getMessage().toString();
String maskedMessage = maskSensitiveData(message);
loggingEvent.setMessage(maskedMessage);
super.append(loggingEvent);
}
@Override
public void close() {
// Cleanup resources, if any
}
@Override
public boolean requiresLayout() {
return false;
}
private String maskSensitiveData(String message) {
// Implement your logic to mask sensitive data using regular expressions
// For demonstration purposes, let's assume we want to mask credit card numbers
return message.replaceAll("\\d{4}-\\d{4}-\\d{4}-\\d{4}", "****-****-****-****");
}
}
Log4j 中的Appender负责将日志消息写入各种输出。通过扩展AppenderSkeleton类,我们创建了一个自定义Appender,可以在将日志消息写入日志之前对其进行修改。
在maskSensitiveData()方法中,我们使用正则表达式来识别和替换敏感数据。在示例中,我们使用该模式\\d{4}-\\d{4}-\\d{4}-\\d{4}来匹配格式为“xxxx-xxxx-xxxx-xxxx”的银行卡号,并将其替换为“---”。
append()方法
当日志消息准备好附加时,Log4j 会调用此方法。在类MaskingAppender中,我们重写append()方法来拦截日志消息,使用maskSensitiveData()方法对敏感数据进行脱敏。,然后将修改后的消息传递给append()方法。
第2步:配置Log4j
在 Spring Boot 应用程序的配置文件application.yml中,配置 Log4j 以使用自定义 Appender。还需要根据需求指定日志级别和其他设置。这是使用配置 log4j 的示例application.yml:
# Log4j configuration
log4j.rootLogger=INFO, maskedAppender
log4j.appender.maskedAppender=com.example.MaskingAppender
log4j.appender.maskedAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.maskedAppender.layout.ConversionPattern=%d [%t] %-5p %c - %m%n
第 3 步:添加 Log4j依赖
在pom.xml文件中添加 Log4j 依赖项:
<!-- log4j dependencies -->
<dependencies>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
</dependencies>
步骤 4:测试日志脱敏
现在,在 Spring Boot 应用程序中使用 Log4j 记录消息时,敏感数据将被自动脱敏。例如:
import org.apache.log4j.Logger;
public class SomeService {
private static final Logger logger = Logger.getLogger(SomeService.class);
public void processSensitiveData(String data) {
logger.info("Processing sensitive data: " + data); // Sensitive data will be masked in the logs
}
}
在上面的示例中,如果data参数包含类似“1234-5678-9012-3456”的银行卡号,它将在日志输出中被屏蔽为“处理敏感数据:---”
结论
通过这些步骤和方式,可以有效地对SpringBoot应用程序的Log4j 日志中的敏感数据进行脱敏。根据实际项目需求在maskSensitiveData()方法处理数据脱敏业务逻辑。