io.github.opensabre.boot.sensitive.log.desensitizer.RegxLogBackDesensitizer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensabre-starter-boot Show documentation
The newest version!
package io.github.opensabre.boot.sensitive.log.desensitizer;

import ch.qos.logback.classic.spi.ILoggingEvent;
import io.github.opensabre.boot.sensitive.rule.DefaultSensitiveRule;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Value;

import jakarta.annotation.PostConstruct;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicReference;
import java.util.regex.Matcher;
import java.util.stream.Collectors;

/**
 * 正则脱敏器
 * 包含常用的敏感日志正则，如身份证、银行卡、手机号、姓名
 *
 * @author zhoutaoo
 */
@Slf4j
public class RegxLogBackDesensitizer extends AbstractLogBackDesensitizer {

    @Value("${opensabre.sensitive.log.rules}")
    private String sensitiveRuleConfig;

    public Set sensitiveRules;

    @PostConstruct
    private void init() {
        Map sensitiveRuleMap = Arrays.stream(DefaultSensitiveRule.values())
                .filter(rule -> StringUtils.contains(sensitiveRuleConfig, rule.category()))
                .collect(Collectors.toMap(DefaultSensitiveRule::category, rule -> rule));
        // sensitiveRules Set按sensitiveRuleConfig顺序放置，越前优先级越高，越早匹配
        this.sensitiveRules = Arrays.stream(StringUtils.split(sensitiveRuleConfig, ","))
                .map(sensitiveRuleMap::get)
                .collect(Collectors.toCollection(LinkedHashSet::new));
    }

    @Override
    public boolean support(ILoggingEvent event) {
        // 任意匹配即需要脱敏
        return sensitiveRules.stream()
                .anyMatch(sensitiveRule -> sensitiveRule.pattern().matcher(event.getFormattedMessage()).find());
    }

    @Override
    public String desensitizing(ILoggingEvent event, String originStr) {
        AtomicReference message = new AtomicReference<>(originStr);
        sensitiveRules.forEach(sensitiveRule -> {
            Matcher matcher = sensitiveRule.pattern().matcher(originStr);
            while (matcher.find()) {
                String matchStr = matcher.group();
                message.set(message.get().replaceAll(matchStr, sensitiveRule.replace(matchStr)));
            }
        });
        return message.get();
    }
}