java 日志脱敏框架 sensitive，优雅的打印脱敏日志

问题

为了保证用户的信息安全，敏感信息须要脱敏。
项目开发过程当中，每次处理敏感信息的日志问题感受很麻烦，大部分都是用工具类单独处理，不利于之后统一管理，很不优雅。
因而，就写了一个基于 java 注解的日志脱敏工具。

github sensitive

项目介绍

日志脱敏是常见的安全需求。普通的基于工具类方法的方式，对代码的***性太强。编写起来又特别麻烦。

本项目提供基于注解的方式，而且内置了常见的脱敏方式，便于开发。

用户也能够基于本身的实际须要，自定义注解。

变动日志

日志脱敏

为了金融交易的安全性，国家强制规定对于如下信息是要日志脱敏的：

1. 用户名

2. 手机号

3. 邮箱

4. 银行卡号

5. 密码

持久化加密

存储的时候上面的信息都须要加密，密码为不可逆加密，其余为可逆加密。

相似的功能有不少。不在本系统的解决范围内。

特性

1. 基于注解的日志脱敏

2. 能够自定义策略实现，策略生效条件

3. 常见的脱敏内置方案

快速开始

maven 导入

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>sensitive-core</artifactId>
    <version>0.0.1</version>
</dependency>

定义对象

• User.java

咱们对 password 使用脱敏，指定脱敏策略为 StrategyPassword。(直接返回 null)

public class User {

    @Sensitive(strategy = StrategyChineseName.class)
    private String username;

    @Sensitive(strategy = StrategyCardId.class)
    private String idCard;

    @Sensitive(strategy = StrategyPassword.class)
    private String password;

    @Sensitive(strategy = StrategyEmail.class)
    private String email;

    @Sensitive(strategy = StrategyPhone.class)
    private String phone;

    //Getter & Setter
    //toString()
}

• 测试

@Test
    public void UserSensitiveTest() {
        User user = buildUser();
        System.out.println("脱敏前原始： " + user);
        User sensitiveUser = SensitiveUtil.desCopy(user);
        System.out.println("脱敏对象： " + sensitiveUser);
        System.out.println("脱敏后原始： " + user);
    }

    private User buildUser() {
        User user = new User();
        user.setUsername("脱敏君");
        user.setPassword("123456");
        user.setEmail("12345@qq.com");
        user.setIdCard("123456190001011234");
        user.setPhone("18888888888");
        return user;
    }

• 输出信息以下

脱敏前原始： User{username='脱敏君', idCard='123456190001011234', password='1234567', email='12345@qq.com', phone='18888888888'}
脱敏对象： User{username='脱*君', idCard='123456**********34', password='null', email='123**@qq.com', phone='188****8888'}
脱敏后原始： User{username='脱敏君', idCard='123456190001011234', password='1234567', email='12345@qq.com', phone='18888888888'}

咱们能够直接利用 sensitiveUser 去打印日志信息，而这个对象对于代码其余流程不影响，咱们依然能够使用原来的 user 对象。

自定义脱敏策略生效的场景

默认状况下，咱们指定的场景都是生效的。

可是你可能须要有些状况下不进行脱敏，好比有些用户密码为 123456，你以为这种用户不脱敏也罢。

• UserPasswordCondition.java

@Sensitive(condition = ConditionFooPassword.class, strategy = StrategyPassword.class)
private String password;

其余保持不变，咱们指定了一个 condition，实现以下：

• ConditionFooPassword.java

public class ConditionFooPassword implements ICondition {
    @Override
    public boolean valid(IContext context) {
        try {
            Field field = context.getCurrentField();
            final Object currentObj = context.getCurrentObject();
            final String password = (String) field.get(currentObj);
            return !password.equals("123456");
        } catch (IllegalAccessException e) {
            throw new RuntimeException(e);
        }
    }
}

也就是只有当密码不是 123456 时密码脱敏策略才会生效。

针对单个字段

上面的例子是基于注解式的编程，若是你只是单个字段。好比

• singleSensitiveTest

@Test
public void singleSensitiveTest() {
    final String email = "123456@qq.com";
    IStrategy strategy = new StrategyEmail();
    final String emailSensitive = (String) strategy.des(email, null);
    System.out.println("脱敏后的邮箱：" + emailSensitive);
}

• 日志信息

脱敏后的邮箱：123***@qq.com

待优化的地方

全新对象建立

这种方式为了不修改原始对象，建立了一个全新的对象，有点点浪费，能够优化。

其余方法

能够基于 log4j2/logback 等转换器进行敏感信息的脱敏，可是不具备不一样的 log 框架的可移植性。