Springboot 配置檔案、隱私資料脫敏的最佳實踐（原理+源碼）

2021-08-05 12:22:52

這幾天公司在排查內部資料賬號洩漏，原因是發現某些實習生小可愛居然連帶著賬號、密碼將源碼私傳到GitHub上，導致核心資料外漏，孩子還是沒捱過社會毒打，這種事的後果可大可小。

說起這個我是比較有感觸的，之前我TM被刪庫的經歷，到現在想起來心裡還難受，我也是把資料庫賬號明文密碼誤提交到GitHub，然後被哪個大寶貝給我測試庫刪了，後邊我長記性了把配置檔案內容都加密了，資料安全問題真的不容小覷，不管工作匯還是生活，敏感資料一定要做脫敏處理。

如果對脫敏概念不熟悉，可以看一下我之前寫過的一篇大廠也在用的6種資料脫敏方案，裡邊對脫敏做了簡單的描述，接下來分享工作中兩個比較常見的脫敏場景。

配置脫敏

實現配置的脫敏我使用了Java的一個加解密工具Jasypt，它提供了單金鑰對稱加密和非對稱加密兩種脫敏方式。

單金鑰對稱加密：一個金鑰加鹽，可以同時用作內容的加密和解密依據；

非對稱加密：使用公鑰和私鑰兩個金鑰，才可以對內容加密和解密；

以上兩種加密方式使用都非常簡單，咱們以springboot整合單金鑰對稱加密方式做示例。

首先引入jasypt-spring-boot-starter jar

配置檔案加入金鑰配置項jasypt.encryptor.password，並將需要脫敏的value值替換成預先經過加密的內容ENC(mVTvp4IddqdaYGqPl9lCQbzM3H/b0B6l)。

這個格式我們是可以隨意定義的，比如想要abc[mVTvp4IddqdaYGqPl9lCQbzM3H/b0B6l]格式，只要配置字首和字尾即可。

ENC(XXX）格式主要為了便於識別該值是否需要解密，如不按照該格式配置，在載入配置項的時候jasypt將保持原值，不進行解密。

金鑰是個安全性要求比較高的屬性，所以一般不建議直接放在項目內，可以通過啟動時-D參數注入，或者放在配置中心，避免洩露。

java -jar -Djasypt.encryptor.password=1123 springboot-jasypt-2.3.3.RELEASE.jar

預先生成的加密值，可以通過程式碼內呼叫API生成

或者通過如下Java命令生成，幾個參數D:maven_liborgjasyptjasypt1.9.3jasypt-1.9.3.jar為jasypt核心jar包，input待加密文字，password祕鑰，algorithm為使用的加密演算法。

java -cp D:maven_liborgjasyptjasypt1.9.3jasypt-1.9.3.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="root" password=xiaofu algorithm=PBEWithMD5AndDES

一頓操作後如果還能正常啟動，說明配置檔案脫敏就沒問題了。

敏感欄位脫敏

生產環境使用者的隱私資料，比如手機號、身份證或者一些賬號配置等資訊，入庫時都要進行不落地脫敏，也就是在進入我們系統時就要實時的脫敏處理。

使用者資料進入系統，脫敏處理後持久化到資料庫，使用者查詢資料時還要進行反向解密。這種場景一般需要全局處理，那麼用AOP切面來實現在適合不過了。

首先自定義兩個註解@EncryptField、@EncryptMethod分別用在欄位屬性和方法上，實現思路很簡單，只要方法上應用到@EncryptMethod註解，則檢查入參欄位是否標註@EncryptField註解，有則將對應欄位內容加密。

切面的實現也比較簡單，對入參加密，返回結果解密。為了方便閱讀這裡就只貼出部分程式碼，完整案例Github地址：https://github.com/chengxy-nds/Springboot-Notebook/tree/master/springboot-jasypt

緊接著測試一下切面註解的效果，我們對欄位mobile、address加上註解@EncryptField做脫敏處理。

請求這個介面，看到參數被成功加密，而返回給使用者的資料依然是脫敏前的資料，符合我們的預期，那到這簡單的脫敏實現就完事了。

知其然知其所以然

Jasypt工具雖然簡單好用，但作為程式設計師我們不能僅滿足於熟練使用，底層實現原理還是有必要了解下的，這對後續偵錯bug、二次開發擴展功能很重要。

個人認為Jasypt配置檔案脫敏的原理很簡單，無非就是在具體使用配置資訊之前，先攔截獲取配置的操作，將對應的加密配置解密後再使用。

具體是不是如此我們簡單看下源碼的實現，既然是以springboot方式整合，那麼就先從jasypt-spring-boot-starter源碼開始入手。

starter程式碼很少，主要的工作就是通過SPI機制註冊服務和@Import註解來注入需前置處理的類JasyptSpringBootAutoConfiguration。

在前置載入類EnableEncryptablePropertiesConfiguration中註冊了一個核心處理類EnableEncryptablePropertiesBeanFactoryPostProcessor。

它的構造器有兩個參數，ConfigurableEnvironment用來獲取所有配屬資訊，EncryptablePropertySourceConverter對配置資訊做解析處理。

順藤摸瓜發現具體負責解密的處理類EncryptablePropertySourceWrapper，它通過對Spring屬性管理類PropertySource<T>做拓展，重寫了getProperty(String name)方法，在獲取配置時，凡是指定格式如ENC(x) 包裹的值全部解密處理。

既然知道了原理那麼後續我們二次開發，比如：切換加密演算法或者實現自己的脫敏工具就容易的多了。

案例Github地址：https://github.com/chengxy-nds/Springboot-Notebook/tree/master/springboot-jasypt

PBE演算法

再來聊一下Jasypt中用的加密演算法，其實它是在JDK的JCE.jar包基礎上做了封裝，本質上還是用的JDK提供的演算法，預設使用的是PBE演算法PBEWITHMD5ANDDES，看到這個演算法命名很有意思，段個句看看，PBE、WITH、MD5、AND、DES 好像有點故事，繼續看。