快捷導(dǎo)航

簡(jiǎn)單了解Java日志脫敏框架sensitive

更新時(shí)間：2019年11月21日 09:59:11 作者：葉止水

這篇文章主要介紹了簡(jiǎn)單了解Java日志脫敏框架sensitive,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

問(wèn)題

為了保證用戶的信息安全，敏感信息需要脫敏。

項(xiàng)目開發(fā)過(guò)程中，每次處理敏感信息的日志問(wèn)題感覺很麻煩，大部分都是用工具類單獨(dú)處理，不利于以后統(tǒng)一管理，很不優(yōu)雅。

于是，就寫了一個(gè)基于 java 注解的日志脫敏工具。

github sensitive

項(xiàng)目介紹

日志脫敏是常見的安全需求。普通的基于工具類方法的方式，對(duì)代碼的入侵性太強(qiáng)。編寫起來(lái)又特別麻煩。

本項(xiàng)目提供基于注解的方式，并且內(nèi)置了常見的脫敏方式，便于開發(fā)。

用戶也可以基于自己的實(shí)際需要，自定義注解。

日志脫敏

為了金融交易的安全性，國(guó)家強(qiáng)制規(guī)定對(duì)于以下信息是要日志脫敏的：

用戶名
手機(jī)號(hào)
郵箱
銀行卡號(hào)
密碼

持久化加密

存儲(chǔ)的時(shí)候上面的信息都需要加密，密碼為不可逆加密，其他為可逆加密。

類似的功能有很多。不在本系統(tǒng)的解決范圍內(nèi)。

特性

基于注解的日志脫敏
可以自定義策略實(shí)現(xiàn)，策略生效條件
常見的脫敏內(nèi)置方案
支持 jdk1.7+

快速開始

maven 導(dǎo)入

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

定義對(duì)象

User.java

我們對(duì) 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()
}

測(cè)試

  @Test
  public void UserSensitiveTest() {
    User user = buildUser();
    System.out.println("脫敏前原始： " + user);
    User sensitiveUser = SensitiveUtil.desCopy(user);
    System.out.println("脫敏對(duì)象： " + 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'}
脫敏對(duì)象： 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 去打印日志信息，而這個(gè)對(duì)象對(duì)于代碼其他流程不影響，我們依然可以使用原來(lái)的 user 對(duì)象。

自定義脫敏策略生效的場(chǎng)景

默認(rèn)情況下，我們指定的場(chǎng)景都是生效的。

但是你可能需要有些情況下不進(jìn)行脫敏，比如有些用戶密碼為 123456，你覺得這種用戶不脫敏也罷。

UserPasswordCondition.java

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

其他保持不變，我們指定了一個(gè) condition，實(shí)現(xiàn)如下：

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);
    }
  }
}

也就是只有當(dāng)密碼不是 123456 時(shí)密碼脫敏策略才會(huì)生效。

針對(duì)單個(gè)字段

上面的例子是基于注解式的編程，如果你只是單個(gè)字段。比如

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

待優(yōu)化的地方

全新對(duì)象創(chuàng)建

這種方式為了避免修改原始對(duì)象，創(chuàng)建了一個(gè)全新的對(duì)象，有點(diǎn)點(diǎn)浪費(fèi)，可以優(yōu)化。

其他方法

可以基于 log4j2/logback 等轉(zhuǎn)換器進(jìn)行敏感信息的脫敏，但是不具有不同的 log 框架的可移植性。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: