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/monkey-api-encrypt
示例代碼：https://github.com/yinjihuan/monkey-api-encrypt/tree/master/encrypt-springboot-example
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）
API數據加密框架monkey-api-encrypt