SpringBoot3使用Jasypt實(shí)現(xiàn)加密配置文件
一. 使用步驟
1. 添加依賴
<dependency> <groupId>com.github.ulisesbocchio</groupId> <artifactId>jasypt-spring-boot-starter</artifactId> <version>3.0.4</version> </dependency>
2.配置加密密碼
Jasypt需要一個(gè)密碼來進(jìn)行加密和解密操作??梢酝ㄟ^以下幾種方式配置這個(gè)密碼:
在配置文件中指定 :在你的application.properties
或application.yml
配置文件中,添加jasypt.encryptor.password
配置項(xiàng),并設(shè)置你的密碼。例如:
# application.properties jasypt.encryptor.password=your_encryption_password
或者,在application.yml
中:
jasypt: encryptor: password: your_encryption_password
然而,將密碼直接寫在配置文件中可能存在安全風(fēng)險(xiǎn)。因此,更推薦的做法是通過啟動參數(shù)或環(huán)境變量來傳遞這個(gè)密碼。
通過啟動參數(shù)指定:在啟動應(yīng)用程序時(shí),可以通過
-Djasypt.encryptor.password=your_encryption_password
參數(shù)來指定加密密碼。
使用環(huán)境變量:在某些情況下,使用環(huán)境變量來存儲敏感信息(如加密密碼)可能更為安全。具體方法取決于你的應(yīng)用程序部署環(huán)境。
3. 加密敏感信息
在配置加密密碼后,你可以使用Jasypt
提供的工具或API來加密你的敏感信息。加密后的信息將以密文形式存儲。
使用Jasypt CLI工具:Jasypt
提供了一個(gè)命令行界面(CLI
)工具,允許你在命令行中加密和解密字符串。你需要下載Jasypt
的jar
包,并在命令行中運(yùn)行相應(yīng)的命令。
Jasypt JAR 文件下載地址 :
生成密鑰
使用 Jasypt
提供的命令行工具生成密鑰。
java -cp jasypt-1.9.3.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="your-strong-password" password="your-secret-key" algorithm=PBEWithMD5AndTripleDES
input
:你要加密的字符串,例如數(shù)據(jù)庫連接字符串、用戶名、密碼等。
password
:用于加密的密鑰。
algorithm
:加密算法,推薦使用 PBEWITHHMACSHA512ANDAES_256
。
使用Jasypt API :在你的Java
應(yīng)用程序中,你可以通過注入StringEncryptor
接口的實(shí)現(xiàn)類來編程方式加密和解密字符串。這通常在你的Spring Boot
應(yīng)用程序中通過自動裝配完成。
/** * 加密控制器 * * @author 魯子狄 **/ @SaIgnore @RequiredArgsConstructor @RestController @RequestMapping("/jasypt") public class JasyptController { private final StringEncryptor stringEncryptor; /** * 加密 * * @param text 明文 * @return 密文 */ @RequestMapping("/encrypt") public String encrypt(String text) { return stringEncryptor.encrypt(text); } /** * 解密 * * @param text 密文 * @return 明文 */ @RequestMapping("/decrypt") public String decrypt(String text) { return stringEncryptor.decrypt(text); } }
4. 將加密信息存儲到配置文件中
密鑰格式如下:
ENC(your-encrypted-string)
加密敏感信息后,你需要將這些加密后的信息存儲到配置文件中。在Jasypt
中,加密后的信息通常以ENC(...)
的形式出現(xiàn),括號內(nèi)是加密后的密文。例如:
username: ENC(aHApYu/25KrMl/q6Mr7X+0jYRC8E52V62ciUqtzDelELeHUwUrgGDl1oQJVUeXCt) password: ENC(A0bDpXcWODFJ7JXiDNVKU5n49RSLM4Q3e5ZtS5T+fTY54S12zazVyxHhbV49OzY7)
5.應(yīng)用程序啟動時(shí)自動解密
當(dāng)你的Spring Boot
應(yīng)用程序啟動時(shí),Jasypt
會自動檢測配置文件中的ENC(...)
字符串,并使用你配置的加密密碼來解密這些字符串。解密后的明文將用于應(yīng)用程序的配置中。
注意: 如過用環(huán)境變量傳參,本地啟動時(shí)需要傳入環(huán)境變量,jar
包運(yùn)行也一樣
-Djasypt.encryptor.password=your-encryptor-password
本地
jar
包命令 :
java -Djasypt.encryptor.password=your-encryptor-password -jar your-jar
二. Jasypt配置項(xiàng)
配置參數(shù) | 描述 | 示例 |
---|---|---|
jaspyt.encryptor.password | 加密器的密碼,用于解密屬性 | jaspyt.encryptor.password=mySecretPassword |
jaspyt.encryptor.algorithm | 加密算法的名稱 | jaspyt.encryptor.algorithm=PBEWithMD5AndDES |
jaspyt.encryptor.keyObtentionIterations | 獲取密鑰時(shí)使用的迭代次數(shù) | jaspyt.encryptor.keyObtentionIterations=1000 |
jaspyt.encryptor.poolSize | 加密池的大?。ㄈ绻褂昧顺鼗用芷鳎?/td> | jaspyt.encryptor.poolSize=1 |
jaspyt.encryptor.providerName | 加密提供者的名稱(如JCE提供者) | jaspyt.encryptor.providerName=SunJCE |
jaspyt.encryptor.saltGeneratorClassName | 鹽生成器的類名 | jaspyt.encryptor.saltGeneratorClassName=org.jasypt.salt.RandomSaltGenerator |
jaspyt.encryptor.ivGeneratorClassName | 初始向量生成器的類名 | jaspyt.encryptor.ivGeneratorClassName=org.jasypt.iv.NoIvGenerator |
jaspyt.encryptor.stringOutputType | 加密字符串的輸出類型(如base64) | jaspyt.encryptor.stringOutputType=base64 |
jaspyt.encryptor.property.prefix | 加密屬性前綴,用于識別加密屬性 | jaspyt.encryptor.property.prefix=ENC( |
jaspyt.encryptor.property.suffix | 加密屬性后綴,用于識別加密屬性 | jaspyt.encryptor.property.suffix=) |
jaspyt.encryptor.proxyPropertySources | 是否通過代理截取屬性值以進(jìn)行解密 | jaspyt.encryptor.proxyPropertySources=true |
三. 支持的加密算法
Jasypt
支持多種加密算法以保護(hù)敏感數(shù)據(jù)。以下是Jasypt
支持的一些常見加密算法:
加密算法名稱 | 描述 |
---|---|
PBEWithMD5AndDES | 基于密碼的加密(PBE),使用MD5作為散列函數(shù)和DES作為加密算法。這是一種較舊的加密算法,但在某些舊系統(tǒng)中可能仍在使用 |
PBEWithMD5AndTripleDES | 與PBEWithMD5AndDES類似,但使用TripleDES作為加密算法,提供了更強(qiáng)的安全性。 |
PBEWithHMACSHA512ANDAES_256 | 使用HMAC-SHA-512散列函數(shù)和AES-256加密算法的組合,提供了非常高的安全性。這是Jasypt較新版本中推薦的加密算法之一(默認(rèn)值) |
AES | 高級加密標(biāo)準(zhǔn)(AES),是一種廣泛使用的對稱加密算法。Jasypt支持不同長度的AES密鑰,如AES-128、AES-192和AES-256 |
RSA | Rivest-Shamir-Adleman(RSA)算法,是一種非對稱加密算法。它使用一對密鑰:公鑰用于加密數(shù)據(jù),私鑰用于解密數(shù)據(jù) |
到此這篇關(guān)于SpringBoot3使用Jasypt實(shí)現(xiàn)加密配置文件的文章就介紹到這了,更多相關(guān)SpringBoot3 Jasypt加密配置文件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring Boot 與 kotlin 使用Thymeleaf模板引擎渲染web視圖的方法
這篇文章主要介紹了Spring Boot 與 kotlin 使用Thymeleaf模板引擎渲染web視圖的方法,本文給大家介紹的非常詳細(xì),具有參考借鑒價(jià)值,需要的朋友可以參考下2018-01-01Java日志框架打印應(yīng)用程序日志代碼的執(zhí)行情況分析
在配置INFO日志級別時(shí),日志器(logger)中debug級的日志代碼仍會被執(zhí)行,只是是否輸出取決于配置的日志級別,本文基于Java 1.8、SLF4J 1.7.25和Log4j 2.20.0進(jìn)行實(shí)驗(yàn),詳述了日志框架處理日志代碼的機(jī)制,感興趣的朋友一起看看吧2024-10-10SpringBoot快速構(gòu)建應(yīng)用程序方法介紹
這篇文章主要介紹了SpringBoot快速構(gòu)建應(yīng)用程序方法介紹,涉及SpringBoot默認(rèn)的錯(cuò)誤頁面,嵌入式Web容器層面的約定和定制等相關(guān)內(nèi)容,具有一定借鑒價(jià)值,需要的朋友可以參考下。2017-11-11Go反射底層原理及數(shù)據(jù)結(jié)構(gòu)解析
這篇文章主要介紹了Go反射底層原理及數(shù)據(jù)結(jié)構(gòu)解析,反射的實(shí)現(xiàn)和interface的組成很相似,都是由“類型”和“數(shù)據(jù)值”構(gòu)成,下面小編分享更多相關(guān)內(nèi)容需要的小伙伴可以參考一下2022-06-06如何使用IDEA創(chuàng)建MAPPER模板過程圖解
這篇文章主要介紹了如何使用IDEA創(chuàng)建MAPPER模板,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-05-05修改Maven settings.xml 后配置未生效的解決
這篇文章主要介紹了修改Maven settings.xml 后配置未生效的解決,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-10-10Java如何實(shí)現(xiàn)實(shí)體類轉(zhuǎn)Map、Map轉(zhuǎn)實(shí)體類
這篇文章主要介紹了Java 實(shí)現(xiàn)實(shí)體類轉(zhuǎn)Map、Map轉(zhuǎn)實(shí)體類的操作,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-08-08