API數據加密框架monkey-api-encrypt

以前有寫過一篇加密的文章《先後端API交互如何保證數據安全性》。主要是在Spring Boot中如何對接口的數據進行自動加解密操做，經過註解的方式來指定是否須要加解密。

原理也很簡單，經過Spring提供的RequestBodyAdvice和ResponseBodyAdvice就能夠對請求響應作處理。

原本也是打算更新一下的，由於在Spring Cloud Zuul中也須要加解密，個人那個封裝就用不了。

恰巧上週肥朝大佬跟我聊了下，提供了一些很是有用的建議，因而週六花了一天時間重構了一下加密的框架，再也不以Spring Boot Starter的方式提供服務，直接是一個jar包，基於Servlet層面來對數據進行加解密處理。

相比以前的變化：

• 內置AES加密算法，能夠配置不一樣的加密key
• 再也不綁定Spring Boot，經過配置Filter便可使用加解密
• Spring Cloud Zuul框架也能夠支持
• 支持用戶自定義加密算法

GitHub地址：https://github.com/yinjihuan/...

示例代碼：https://github.com/yinjihuan/...

monkey-api-encrypt沒有發佈到Maven中央倉庫，只發布到jitpack這個倉庫，你們也能夠自行下載源碼打包傳到本身公司的私服上。

自動加解密的好處

傳統作法以下：

// 客戶端傳來的數據就是加密好的字符串
public String add(String data) {
   // 1. 經過工具類將數據解密，而後序列化成對象使用
   // 2. 處理業務邏輯，數據返回的時候用工具類將數據加密返回給客戶端
}

缺點是在每一個業務方法中都要手動的去處理加解密的邏輯。

經過使用monkey-api-encrypt的話可讓開發人員不須要關注加解密的邏輯，好比：

@PostMapping("/save")
public UserResult add(@RequestBody User data) {
    UserResult  result = new UserResult ();
    result.setXXX....
    return result;
}

上面的代碼跟日常寫的如出一轍，沒有加解密的邏輯，須要對數據作加解密邏輯的時候，只須要配置一個過濾器，而後指定哪些URI須要加解密便可。下面來學習下如何使用monkey-api-encrypt。

快速使用

下面以jitpack倉庫示列

第一步：pom.xml中增長倉庫地址

<repositories>
  <repository>
     <id>jitpack.io</id>
     <url>https://jitpack.io</url>
  </repository>
</repositories>

第二步：增長項目依賴

<dependency>
    <groupId>com.github.yinjihuan</groupId>
    <artifactId>monkey-api-encrypt</artifactId>
    <version>1.1.1</version>
</dependency>

第三步：配置加解密過濾器(Spring Boot中配置方式)

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<EncryptionFilter> filterRegistration() {
        EncryptionConfig config = new EncryptionConfig();
        config.setKey("abcdef0123456789");
        config.setRequestDecyptUriList(Arrays.asList("/save", "/decryptEntityXml"));
        config.setResponseEncryptUriList(Arrays.asList("/encryptStr", "/encryptEntity", "/save", "/encryptEntityXml", "/decryptEntityXml"));
        FilterRegistrationBean<EncryptionFilter> registration = new FilterRegistrationBean<EncryptionFilter>();
        registration.setFilter(new EncryptionFilter(config));
        registration.addUrlPatterns("/*");
        registration.setName("EncryptionFilter");
        registration.setOrder(1);
        return registration;
    }

}

• EncryptionConfig

EncryptionConfig是加解密的配置類，配置項目定義以下：

public class EncryptionConfig {

    /**
     * AES加密Key，長度必須16
     */
    private String key = "d7b85f6e214abcda";
    
    /**
     * 須要對響應內容進行加密的接口URI<br>
     * 好比：/user/list<br>
     * 不支持@PathVariable格式的URI
     */
    private List<String> responseEncryptUriList = new ArrayList<String>();
    
    /**
     * 須要對請求內容進行解密的接口URI<br>
     * 好比：/user/list<br>
     * 不支持@PathVariable格式的URI
     */
    private List<String> requestDecyptUriList = new ArrayList<String>();

    /**
     * 響應數據編碼
     */
    private String responseCharset = "UTF-8";
    
    /**
     * 開啓調試模式，調試模式下不進行加解密操做，用於像Swagger這種在線API測試場景
     */
    private boolean debug = false;
}

自定義加密算法

內置了AES加密算法對數據進行加解密操做，同時用戶能夠自定義算法來代替內置的算法。

自定義算法須要實現EncryptAlgorithm接口：

/**
 * 自定義RSA算法
 * 
 * @author yinjihuan
 * 
 * @date 2019-01-12
 * 
 * @about http://cxytiandi.com/about
 *
 */
public class RsaEncryptAlgorithm implements EncryptAlgorithm {

    public String encrypt(String content, String encryptKey) throws Exception {
        return RSAUtils.encryptByPublicKey(content);
    }

    public String decrypt(String encryptStr, String decryptKey) throws Exception {
        return RSAUtils.decryptByPrivateKey(encryptStr);
    }

}

註冊Filter的時候指定算法：

EncryptionConfig config = new EncryptionConfig();
registration.setFilter(new EncryptionFilter(config, new RsaEncryptAlgorithm()));

常見問題

1. Spring Cloud Zuul中如何使用？

使用方式和Spring Boot中同樣，沒區別。

2. 若是須要全部請求都作加解密處理怎麼辦？

默認不配置RequestDecyptUriList和ResponseEncryptUriList的狀況下，就會對全部請求進行處理（攔截器指定範圍內的請求）

3. Swagger測試接口的時候怎麼處理？

能夠開啓調試模式，就不對請求作加解密處理，經過配置debug=true

4. RequestDecyptUriList和ResponseEncryptUriList可否支持/user/*模式匹配？

過濾器自己就有這個功能了，因此框架中是徹底匹配相等才能夠，能夠經過過濾器的 registration.addUrlPatterns("/user/","/order/");來指定須要處理的接口地址。

歡迎加入個人知識星球，一塊兒交流技術，免費學習猿天地的課程（http://cxytiandi.com/course）