日志脱敏功能

2024-06-03 16:04
文章标签 日志 功能 脱敏

本文主要是介绍日志脱敏功能,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

数据安全尤为重要,最为简单的防线就是防止重要信息(身份证、手机号、姓名等)明文显示,对此需要在数据库层、日志层等做好数据加解密。

思路

1、编写需加密的正则模板、加密字段
2、重写ch.qos.logback.classic.pattern.MessageConverter
3、编写日志框架,确认转换模板(本篇采用logback.xml)

看不明白的直接无脑复制代码,在logback-sensitive-rule.properties文件中加上你需要的脱敏的字段即可

实战

正则模板及加密字段

在resource目录下建立两个properties文件,logback-sensitive-def-rule 和 logback-sensitive-rule。前者logback-sensitive-def-rule 主要指定正则表达式和默认加密字段,可作为公共二方包供所有项目使用,logback-sensitive-rule主要用于定制化项目,对特别项目需要加密字段的做定制化。

logback-sensitive-def-rule

#mobile  \"mobile\"|\"telphone\"
# ??json
def_rule1=(KEYWORD)(\\s{0,})(:)(\\s{0,})(\\\\"|\")(\\w{3})(\\w{4})(\\w{4})*(\\\\"|\")&$1$2$3$4$5$6****$8$9&mobile
# ??toString
def_rule_sec11=(KEYWORD)(\\s{0,})(:|=)(\\s{0,})(\"|\'|)(\\w{3})(\\w{4})(\\w{4})*(\"|\'|)&$1$2$3$4$5$6****$8$9&mobile
def_rule_sec12=(KEYWORD)(\\\\{0,}\\\"\\s{0,})(:)(\\s{0,})(\\\\{0,}\\\")(\\w{3})(\\w{4})(\\w{4})*(\\\\{0,}\\\")&$1$2$3$4$5$6****$8$9&mobile
def_field_rule_mobile=mobile|telphone#idcard,bankcard
def_rule2=(KEYWORD)(\\s{0,})(:)(\\s{0,})(\\\\"|\")(\\w{3})(\\w{1,})(\\w{4})(\\\\"|\")&$1$2$3$4$5$6*********$8$9&idcard
def_rule_sec21=(KEYWORD)(\\s{0,})(:|=)(\\s{0,})(\"|\'|)(\\w{3})(\\w{1,})(\\w{4})(\"|\'|)&$1$2$3$4$5$6*********$8$9&idcard
def_rule_sec22=(KEYWORD)(\\\\{0,}\\\"\\s{0,})(:)(\\\\{0,}\\s{0,})(\")(\\w{3})(\\w{1,})(\\w{4})(\\\\{0,}\\s{0,})(\")&$1$2$3$4$5$6******$8$9$10&idcard
def_field_rule_idcard=idcard|bankcard|idNo#pwd ("pwd")(\s{0,})(:|=)(\s{0,})(\\"|")(.*?)(\\"|")
def_rule3=(KEYWORD)(\\s{0,})(:)(\\s{0,})(\\\\"|\")(.*?)(\\\\"|\")&$1$2$3$4$5*****$7&pwd
def_rule_sec31=(KEYWORD)(\\s{0,})(:|=)(\\s{0,})(\"|)(.*?)(\"|,|\\)|])&$1$2$3$4$5*****$7&pwd
# def_rule_sec32=(KEYWORD)(,)(.*?)&$1$2*****&pwd
def_field_rule_pwd=password|pwd#username
# ??json
def_rule4=(KEYWORD)(\\s{0,})(:)(\\s{0,})(\\\\"|\")([\u4E00-\u9FA5]{1})[\u4E00-\u9FA5]{1,}(\\\\"|\")&$1$2$3$4$5$6**$7&name
# ??toString
def_rule_sec41=(KEYWORD)(\\s{0,})(:|=)(\\s{0,})(\"|\'|)([\u4E00-\u9FA5]{1})([\u4E00-\u9FA5]{1,})(\"|\'|)&$1$2$3$4$5$6**$8&name
# ????json???
def_rule_sec42=(KEYWORD)(\\\\{0,}\\\"\\s{0,})(:)(\\\\{0,}\\s{0,})(\\\")([\u4E00-\u9FA5]{1})([\u4E00-\u9FA5]{1,})(\\\\{0,}\\\")&$1$2$3$4$5$6**$8&name
def_field_rule_name=customerName|userName|name|custName#email
def_rule5=(KEYWORD)(\\s{0,})(:)(\\s{0,})(\\\\"|\")([A-Za-z0-9\u4e00-\u9fa5|_-]{1,2})([A-Za-z0-9\u4e00-\u9fa5|_-]{1,})@([a-z0-9A-Z_-]{2,})+(\\.[a-zA-Z0-9_-]{1,})(\\\\"|\")&$1$2$3$4$5$6***@$8$9$10&email
def_rule_sec51=(KEYWORD)(\\s{0,})(:|=)(\\s{0,})(\"|\'|)([A-Za-z0-9\u4e00-\u9fa5|_-]{1,2})([A-Za-z0-9\u4e00-\u9fa5|_-]{1,})@([a-z0-9A-Z_-]{2,})+(\\.[a-zA-Z0-9_-]{1,})(\"|\'|)&$1$2$3$4$5$6***@$8$9&email
def_field_rule_email=email#address
def_rule6=
# 未知长度,且未知数据格式
def_rule_sec61=(KEYWORD)(\\s{0,})(:|=)(\\s{0,})(\"|\')([\\u4E00-\\u9FA5]{0,}?\\S{0,}?)(\\S{0,10})(\"|\')&$1$2$3$4$5$6*****$8&address
def_rule_sec62=(KEYWORD)(\\\\{0,}\\\"\\s{0,})(:)(\\\\{0,}\\s{0,})(\\\")([\\u4E00-\\u9FA5]{0,}?\\S{0,}?)(\\S{0,10})(\\\\{0,}\\\")&$1$2$3$4$5$6*****$8&address
def_field_rule_address=address|idAddress

logback-sensitive-rule

# 定制化字段 分别代表 电话、姓名、证件号、地址
sen_field_rule_mobile=mobile|custMobileNo|bankPhone|mobileNo|reserveMobileNo|phone|contactPhone|accountPhone|custMobile|bankMobile
sen_field_rule_name=custName|acctName|openCustName|OCRname|name|accountName|dbAcctName|bankAcctName
sen_field_rule_idcard=idNo|acct|bankCardNo|ocrPrcid|certNo|dbAcct|id|originValue|idCardNo
sen_field_rule_address=custAddress|address|idAddress|entAddress|certAddress|ocrIdAddress
LogBackSensitiveConverter

重新ch.qos.logback.classic.pattern.MessageConverter的convert方法,主要实现思路是约定号规则字段(如sen_field_rule_、def_field_rule_),从properties文件中读取配置。

LogBackSensitiveConverter


import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.pattern.MessageConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.regex.Pattern;/*** 敏感信息脱敏处理**/
public class LogBackSensitiveConverter extends MessageConverter {private static Logger log = LoggerFactory.getLogger(LogBackSensitiveConverter.class);private static final String SEN_RULE = "sen_rule_";private static final String SEN_RULE_FIELD = "sen_field_rule_";private static final String DEFAULT_RULE = "def_rule";private static final String DEFAULT_RULE_FIELD = "def_field_rule_";/** 脱敏规则 */private static volatile List<RuleConfig> configList;/** 是否脱敏开关 */private static volatile boolean sensitiveOpen;/** 是否初始化配置 */private static volatile boolean initFlag;@Overridepublic String convert(ILoggingEvent event) {init();return doConvert(event);}private void init() {try {if (!initFlag) {initFlag = true;Map<String, String> propertyMap = ((LoggerContext) LoggerFactory.getILoggerFactory()).getCopyOfPropertyMap();sensitiveOpen = Boolean.valueOf(propertyMap.get("sensitiveOpen"));if (sensitiveOpen) {initRuleConfig(propertyMap);}}} catch (Exception e) {configList = null;log.error("error,{}", e);}}private String doConvert(ILoggingEvent event) {try {//本工具打日志不做转换if (LogBackSensitiveConverter.class.getName().equals(event.getLoggerName())) {return event.getFormattedMessage();}String result = event.getFormattedMessage();if (configList != null && configList.size() > 0) {for (RuleConfig ruleConfig : configList) {result = ruleConfig.apply(result);}if (StringUtils.isEmpty(result)) {result = event.getFormattedMessage();}} else {result = super.convert(event);}return result;} catch (Exception e) {log.error("error,{}", e);return event.getFormattedMessage();}}private void initRuleConfig(Map<String, String> propertyMap) {if (configList == null) {synchronized (LogBackSensitiveConverter.class) {if (configList == null) {// read propertiesPropertiesUtil propertiesUtil = new PropertiesUtil("logback-sensitive-def-rule.properties");Properties properties = propertiesUtil.get();configList = new ArrayList<>();//添加默认表达式addDefaultRule(propertyMap, properties);//添加自定义正则表达式addCustomRule(propertyMap);//                    this.addInfo("logback sensitive rule init end ! ");log.info("logback_sensitive_rule_init_end !");}}}}private void addCustomRule(Map<String, String> propertyMap) {for (String s : propertyMap.keySet()) {if (s.startsWith(SEN_RULE)) {String[] array = propertyMap.get(s).split("&");if (ArrayUtils.isNotEmpty(array) && array.length == 2) {configList.add(new RuleConfig(array[0], array[1]));}}}}private void addDefaultRule(Map<String, String> propertyMap, Properties properties) {for (String key : properties.stringPropertyNames()) {if (!key.startsWith(DEFAULT_RULE)) {continue;}String[] array = properties.getProperty(key).split("&");if (ArrayUtils.isNotEmpty(array) && array.length == 3) {//读默认字段String defFields = String.valueOf(properties.get(DEFAULT_RULE_FIELD + array[2]));//读自定义字段String senFields = propertyMap.get(SEN_RULE_FIELD + array[2]);String keyword = StringUtils.EMPTY;if (key.indexOf("sec") != -1) {senFields = StringUtils.isEmpty(senFields) ? "" : "|" + senFields;keyword = defFields + senFields;} else {keyword = "\"" + defFields.replace("|", "\"|\"") + "\"";if (!StringUtils.isEmpty(senFields)) {keyword += "|" + "\"" + senFields.replace("|", "\"|\"") + "\"";}keyword += "|\\\\\"" + defFields.replace("|", "\\\\\"|\\\\\"") + "\\\\\"";if (!StringUtils.isEmpty(senFields)) {keyword += "|\\\\\"" + senFields.replace("|", "\\\\\"|\\\\\"") + "\\\\\"";}}if (StringUtils.isEmpty(keyword)) {continue;}configList.add(new RuleConfig(array[0].replace("KEYWORD", keyword), array[1]));}}}private class RuleConfig {private String reg;private String replacement;private Pattern pattern;RuleConfig(String reg, String replacement) {this.reg = reg;this.replacement = replacement;this.pattern = Pattern.compile(reg);}public String getReg() {return reg;}public void setReg(String reg) {this.reg = reg;}public String getReplacement() {return replacement;}public void setReplacement(String replacement) {this.replacement = replacement;}public Pattern getPattern() {return pattern;}public void setPattern(Pattern pattern) {this.pattern = pattern;}String apply(String message) {if (StringUtils.isEmpty(message)) {return message;}return this.pattern.matcher(message).replaceAll(replacement);}}
}

PropertiesUtil


import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;import java.io.IOException;
import java.io.InputStreamReader;
import java.util.Properties;/*** Created by rayfoo@qq.com Luna on 2020/4/15 18:38* Description : 读取配置文件工具类*/
public class PropertiesUtil {private static Logger log = LoggerFactory.getLogger(PropertiesUtil.class);private Properties properties;public PropertiesUtil(String fileName) {if (StringUtils.isBlank(fileName)) {return;}properties = new Properties();try {properties.load(new InputStreamReader(PropertiesUtil.class.getClassLoader().getResourceAsStream(fileName)));} catch (IOException e) {log.error("PropertiesUtil load data error :{}", e);return;}}public Properties get() {return this.properties;}public String getProperty(String key) {String value = properties.getProperty(key.trim());if (StringUtils.isBlank(value)) {return null;}return value.trim();}public String getProperty(String key, String defaultValue) {String value = properties.getProperty(key);if (StringUtils.isBlank(value)) {return defaultValue;}return value;}}
配置logback,xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration><!--     脱敏开启开关 必须配置--><property scope="context" name="sensitiveOpen" value="true"/><!--    自定义属性配置文件:可自定义字段名和匹配正则表达式  可选配置--><property scope="context" resource="logback-sensitive-rule.properties"/><!--    转换配置 必选配置--><conversionRule conversionWord="msg" converterClass="com.xxx.xxx.xx.LogBackSensitiveConverter"> </conversionRule>
</configuration>

这篇关于日志脱敏功能的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1027458

相关文章

SpringBoot日志级别与日志分组详解

《SpringBoot日志级别与日志分组详解》文章介绍了日志级别(ALL至OFF)及其作用,说明SpringBoot默认日志级别为INFO,可通过application.properties调整全局或... 目录日志级别1、级别内容2、调整日志级别调整默认日志级别调整指定类的日志级别项目开发过程中,利用日志

Debian 13升级后网络转发等功能异常怎么办? 并非错误而是管理机制变更

《Debian13升级后网络转发等功能异常怎么办?并非错误而是管理机制变更》很多朋友反馈,更新到Debian13后网络转发等功能异常,这并非BUG而是Debian13Trixie调整... 日前 Debian 13 Trixie 发布后已经有众多网友升级到新版本,只不过升级后发现某些功能存在异常,例如网络转

深度剖析SpringBoot日志性能提升的原因与解决

《深度剖析SpringBoot日志性能提升的原因与解决》日志记录本该是辅助工具,却为何成了性能瓶颈,SpringBoot如何用代码彻底破解日志导致的高延迟问题,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言第一章:日志性能陷阱的底层原理1.1 日志级别的“双刃剑”效应1.2 同步日志的“吞吐量杀手”

基于Java和FFmpeg实现视频压缩和剪辑功能

《基于Java和FFmpeg实现视频压缩和剪辑功能》在视频处理开发中,压缩和剪辑是常见的需求,本文将介绍如何使用Java结合FFmpeg实现视频压缩和剪辑功能,同时去除数据库操作,仅专注于视频处理,需... 目录引言1. 环境准备1.1 项目依赖1.2 安装 FFmpeg2. 视频压缩功能实现2.1 主要功

使用Python实现无损放大图片功能

《使用Python实现无损放大图片功能》本文介绍了如何使用Python的Pillow库进行无损图片放大,区分了JPEG和PNG格式在放大过程中的特点,并给出了示例代码,JPEG格式可能受压缩影响,需先... 目录一、什么是无损放大?二、实现方法步骤1:读取图片步骤2:无损放大图片步骤3:保存图片三、示php

深度解析Python yfinance的核心功能和高级用法

《深度解析Pythonyfinance的核心功能和高级用法》yfinance是一个功能强大且易于使用的Python库,用于从YahooFinance获取金融数据,本教程将深入探讨yfinance的核... 目录yfinance 深度解析教程 (python)1. 简介与安装1.1 什么是 yfinance?

Python脚本轻松实现检测麦克风功能

《Python脚本轻松实现检测麦克风功能》在进行音频处理或开发需要使用麦克风的应用程序时,确保麦克风功能正常是非常重要的,本文将介绍一个简单的Python脚本,能够帮助我们检测本地麦克风的功能,需要的... 目录轻松检测麦克风功能脚本介绍一、python环境准备二、代码解析三、使用方法四、知识扩展轻松检测麦

Java实现TXT文件导入功能的详细步骤

《Java实现TXT文件导入功能的详细步骤》在实际开发中,很多应用场景需要将用户上传的TXT文件进行解析,并将文件中的数据导入到数据库或其他存储系统中,本文将演示如何用Java实现一个基本的TXT文件... 目录前言1. 项目需求分析2. 示例文件格式3. 实现步骤3.1. 准备数据库(假设使用 mysql

java -jar example.jar 产生的日志输出到指定文件的方法

《java-jarexample.jar产生的日志输出到指定文件的方法》这篇文章给大家介绍java-jarexample.jar产生的日志输出到指定文件的方法,本文给大家介绍的非常详细,对大家的... 目录怎么让 Java -jar example.jar 产生的日志输出到指定文件一、方法1:使用重定向1、

MySQL数据脱敏的实现方法

《MySQL数据脱敏的实现方法》本文主要介绍了MySQL数据脱敏的实现方法,包括字符替换、加密等方法,通过工具类和数据库服务整合,确保敏感信息在查询结果中被掩码处理,感兴趣的可以了解一下... 目录一. 数据脱敏的方法二. 字符替换脱敏1. 创建数据脱敏工具类三. 整合到数据库操作1. 创建服务类进行数据库