使用正则表达式在java中使用logstash logback屏蔽日志-java教程-PHP中文网

在当今数据驱动的世界中，数据安全最为重要。日志框架在应用程序监控和调试中发挥着至关重要的作用，但它们可能会无意中暴露不应该暴露的敏感信息。日志屏蔽是一种有效混淆日志消息中敏感数据、保护机密信息的技术。

了解日志回溯

Logback 是 Java 应用程序中功能强大且最常用的日志框架。它提供灵活的配置选项，包括将日志事件格式化为 JSON 对象的能力。它是 Log4j 框架的继承者，由于其功能和易用性而迅速流行起来。它由 Logger、Encoders、Layout、Appender、Encoder 组成。

Logger： Logger 是日志消息的上下文。应用程序将与此类交互以创建日志消息。

编码器： 编码器是在 logback 0.9.91 中引入的，负责将事件转换为字节数组以及将该字节数组写入 OutputStream。作为布局引入的编码器只能将事件转换为字符串，这将其范围限制为非二进制输出。

布局： 布局负责根据用户的意愿格式化日志请求，而附加程序负责将格式化的输出发送到其目的地。

Appenders： 在 logback 中，输出目标称为 Appender。这会将日志消息放置在其最终目的地中。一个 Logger 可以有多个 Appender。目前，控制台、文件、远程套接字服务器、MySQL、PostgreSQL、Oracle 和其他数据库、JMS 和远程 UNIX Syslog 守护进程都存在附加程序。

关于 Logstash Logback 编码器

logstash-logback-encoder 库是增强 Spring Boot 应用程序日志记录功能的宝贵工具。它提供了一种以结构化 JSON 格式格式化日志消息的便捷方法，使日志聚合和分析工具（例如 Logstash）可以轻松使用它们。 JSON 格式提供了一种结构化且机器可读的方式来记录信息，使其成为高级日志分析和安全措施的理想选择。 Logstash 的好处

JSON 自定义 Logstash 允许您自定义 JSON 输出以包含特定字段和元数据。
动态字段它还允许根据应用程序上下文动态添加字段来记录事件。
提高了可读性 JSON 格式为日志事件提供了清晰且易于阅读的结构。
增强的搜索和分析日志聚合工具可以轻松解析和查询 JSON 日志。
机器解析 JSON 日志非常适合自动分析和警报系统。

屏蔽日志数据的解决方案

这里的主要目标是提供一种解决方案来屏蔽可在运行时定制和配置的数据。

这是我们的简单要求

在日志中完全屏蔽密码。
屏蔽电话号码和登录名，日志中最后 5 位除外。

第 1 步
创建 Spring Boot 应用程序。该解决方案将适用于任何基于 Java 的应用程序，只需很少的定制。

第 2 步
配置所有正则表达式以屏蔽数据。请记住，正则表达式在资源利用率方面的成本很高。确保您正在调整正则表达式。正则表达式组将允许我们从字符串中选择所需的子字符串。

mask logs with logstash logback in java using regex

第三步
创建一个类并实现 MessageJsonProvider。该接口来自logstash，允许我们在打印到附加程序之前自定义消息。每个日志消息都会调用此接口中的 writeTo 方法。

在start()方法中读取所有正则表达式并准备包含所有MaskingRule的LogMasker。该方法来自 AbstractJsonProvider，只是将进程启动标记为 true。
MaskingRule 将保存正则表达式模式和一个函数。此函数替换日志中识别的字符串。

@Data
public class MaskingMessagingProvider extends MessageJsonProvider {

    public static final String DEFAULT_RULES_DELIMITER = ",";
    private LogMasker logMasker;
    private String rules;

    public MaskingMessagingProvider() {
        super();
    }

    @Override
    public void start() {
        super.start();
        this.logMasker = LogMasker.create(StringUtils.tokenizeToStringArray(rules, DEFAULT_RULES_DELIMITER));
    }

    @Override
    public void writeTo(JsonGenerator generator, ILoggingEvent event) throws IOException {

        if (isStarted()) {
            JsonWritingUtils.writeStringField(generator, getFieldName(), logMasker.mask(event.getFormattedMessage()));
        }
    }
}

class LogMasker {

    private MaskingRule[] masks;

    public LogMasker(MaskingRule[] masks) {
        super();
        this.masks = masks.clone();
    }

    public static LogMasker create(String[] rules) {

        return new LogMasker(Arrays.stream(rules).map(rule -> MaskingRule.create(rule)).toArray(MaskingRule[]::new));
    }

    public String mask(String input) {
        String transformed = input;
        for (MaskingRule m : masks) {
            transformed = m.mask(transformed);
        }
        return transformed;
    }
}

class MaskingRule {
    public static final int REG_EX_DEFAULT_GROUP_SELECTOR = 2;
    public static final String DEFAULT_REPLACEMENT = "*";

    private Pattern pattern;
    private UnaryOperator<String> replacement;

    public MaskingRule(Pattern maskPattern, UnaryOperator<String> replacement) {
        super();
        this.pattern = maskPattern;
        this.replacement = replacement;
    }

    public static MaskingRule create(String rule) {
        return new MaskingRule(Pattern.compile(rule), (in) -> MaskingRule.maskDataWithReplacement(in, DEFAULT_REPLACEMENT));
    }

    public String mask(String transformed) {
        Matcher matcher = pattern.matcher(transformed);
        StringBuffer sb = new StringBuffer();
        while (matcher.find()) {
            matcher.appendReplacement(sb, replacement.apply(getDataToBeMasked(matcher)));
        }
        matcher.appendTail(sb);
        return sb.toString();
    }

    private static String maskDataWithReplacement(String input, String replacement) {
        int repetition = !StringUtils.hasLength(input) ? 0 : input.length();
        return String.join("", Collections.nCopies(repetition, replacement));
    }

    private static String getDataToBeMasked(Matcher matcher) {
        if (matcher.groupCount() > 1) {
            return matcher.group(REG_EX_DEFAULT_GROUP_SELECTOR);
        }
        return matcher.groupCount() > 0 ? matcher.group(1) : "";
    }
}

登录后复制

步骤 4
在 logback-spring.xml 文件中配置类。

<configuration>
    <springProperty scope="context" name="rules" source="app.logging.masking.rules"
                    defaultValue=""/>
    <appender name="CONSOLE">



<p><strong>Steps 5</strong><br>
Run the application. For simplicity, i have taken a string which is holding data and printing it at application start up.<br>
</p>

<pre class="brush:php;toolbar:false">@SpringBootApplication
@Slf4j
public class LogDataMaskingApplication {

    public static void main(String[] args) {
        SpringApplication.run(LogDataMaskingApplication.class, args);
        LogDataMaskingApplication.maskingTest();
    }

    public static void maskingTest() {
        String data = "{\"loginName\":\"maskingtest\",\"phoneNumber\":\"9898981212\",\"password\":\"Masking@123\"}";
        log.info(data);
    }

}

登录后复制

mask logs with logstash logback in java using regex