一、Jasypt簡介
Jasypt是一個Java簡易加密庫,用于加密配置文件中的敏感信息,如數據庫密碼。jasypt庫與springboot集成,在實際開發(fā)中非常方便。
1、Jasypt Spring Boot 為 spring boot 應用程序中的屬性源提供加密支持,出于安全考慮,Spring boot 配置文件中的敏感信息通常需要對它進行加密/脫敏處理,盡量不使用明文,要實現這一點,辦法有很多,自己手動對敏感信息進行加解密也是可以的。
2、在程序界有需求就有人奉獻,Jasypt 開源安全框架就是專門用于處理 Spring boot 屬性加密的,在配置文件中使用特定格式直接配置密文,然后應用啟動的時候,Jasypt 會自動將密碼解密成明文供程序使用。
1)Jasypt 加密屬性配置格式:secret.property=ENC(nrmZtkF7T0kjG/VodDvBw93Ct8EgjCA+),ENC() 就是它的標識,程序啟動的時候,會自動解密其中的內容,如果解密失敗,則會報錯。
2)所以獲取這些屬性值和平時沒有區(qū)別,直接使用如 @Value(“${secret.property}”) 獲取即可,取值并不需要特殊處理。
3、jasypt 同一個密鑰(secretKey)對同一個內容執(zhí)行加密,每次生成的密文都是不一樣的,但是根據根據這些密文解密成原內容都是可以的.
4、Jasypt 官方使用文檔:http://www.jasypt.org/
GitHub地址:https://github.com/ulisesbocchio/jasypt-spring-boot。
二、集成方法
官網上推薦的集成到SpringBoot項目中,有3種方法分別是:
- 如果使用@SpringBootApplication或@EnableAutoConfiguration,則僅需要添加jasypt-spring-boot-starter啟動器jar到您的類路徑中即可,它自動會在整個 Spring 環(huán)境中啟用可加密屬性。
- 添加jasypt-spring-boot到您的類路徑并添加@EnableEncryptableProperties到您的主配置類以在整個 Spring 環(huán)境中啟用可加密屬性。
- 添加jasypt-spring-boot到您的類路徑并使用@EncrytablePropertySource注解聲明單獨的可加密屬性源。
2.1 方式一
在Springboot應用程序中,如果使用了@SpringBootApplication or @EnableAutoConfiguration注解,則可以直接在pom文件中添加jasypt-spring-boot依賴,然后就可以在整個Spring環(huán)境中使用jasypt對屬性進行加解密操作(屬性包括:系統(tǒng)屬性、環(huán)境屬性、命令行參數、application.properties、application-*.properties、yml屬性以及任何其他屬性源)。
<dependency>
<groupId>com.github.ulisesbocchio</groupId>
<artifactId>jasypt-spring-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
2.2 方式二
如果項目中沒有使用到@SpringBootApplication or @EnableAutoConfiguration 自動配置注解,則可以通過以下兩個步驟完成對Jasypt的集成。
步驟一:pom文件引入jasypt依賴
<dependency>
<groupId>com.github.ulisesbocchio</groupId>
<artifactId>jasypt-spring-boot</artifactId>
<version>3.0.5</version>
</dependency>
步驟二:在配置類中,添加@EnableEncryptableProperties注解,示例如下:
@Configuration
@EnableEncryptableProperties
public class MyApplication {
...
}
通過這種方式,你的項目一樣可以集成Jasypt,并且可加密屬性也可以在整個Spring環(huán)境中啟用屬性包括:系統(tǒng)屬性、環(huán)境屬性、命令行參數、application.properties、application-*.properties、yml屬性以及任何其他屬性源)。
2.3 方式三
如果項目中沒有使用到@SpringBootApplication or @EnableAutoConfiguration 自動配置注解,又不想在整個Spring環(huán)境中啟用加密的屬性,則可以使用該種方式,具體步驟如下:
步驟一:pom文件引入jasypt依賴
<dependency>
<groupId>com.github.ulisesbocchio</groupId>
<artifactId>jasypt-spring-boot</artifactId>
<version>3.0.5</version>
</dependency>
步驟二、在配置類中,使用@EncryptablePropertySource注解添加任意數量想要生效加密屬性的配置文件路徑,與Spring中@PropertySource注解的使用類似,示例如下:
@Configuration
@EncryptablePropertySource(name = "EncryptedProperties", value = "classpath:encrypted.properties")
public class MyApplication {
...
}
同時,還可以使用@EncryptablePropertySources 注解對@EncryptablePropertySource配置進行分組,示例如下:
@Configuration
@EncryptablePropertySources({@EncryptablePropertySource("classpath:encrypted.properties"),
@EncryptablePropertySource("classpath:encrypted2.properties")})
public class MyApplication {
...
}
說明:從Jasypt 1.8版本開始,@EncryptablePropertySource注解支持配置YAML文件。
三、Springboot整合Jasypt實戰(zhàn)
3.1 引入依賴
說明,本項目使用技術棧是 spring-boot+jasypt,故使用上面介紹的第一種方式來在項目中集成Jasypt,文章中只截取部分核心代碼。
3.2 編寫配置類,配置相關信息
@Configuration
@EableEncryptableProperties
public class JasyptConfiguration() {
@Bean("jasyptStringEncryptor")
public StringEncryptor stringEncryptor() {
PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
SimpleStringPBEConfig config = new SimpleStringPBEConfig();
config.setPassword("password");
config.setAlgorithm("PBEWITHHMACSHA512ANDAES_256");
config.setKeyObtentionIterations("1000");
config.setPoolSize("1");
config.setProviderName("SunJCE");
config.setSaltGeneratorClassName("org.jasypt.salt.RandomSaltGenerator");
config.setIvGeneratorClassName("org.jasypt.iv.RandomIvGenerator");
config.setStringOutputType("base64");
encryptor.setConfig(config);
return encryptor;
}
}
3.3 使用Jasypt對數據庫密碼加密,并替換明文
注意:每次運行都會生成不同的密文,所以你運行之后的結果肯定會跟我運行的結果不同。
3.4 查看執(zhí)行結果
四、拓展
4.1 關于加解密秘鑰如何存儲
如果秘鑰寫在代碼或者配置文件,一旦代碼泄露,那別人就可以使用秘鑰解密我們的密文,這樣對敏感信息加密的作用就不存在了,因此,秘鑰不能以明文形式存儲在代碼或者配置文件中,下面就介紹一些安全的存儲秘鑰的形式。
方式1、把秘鑰當做程序啟動時環(huán)境變量(推薦),示例如下:
java -Djasypt.encryptor.password=秘鑰 -jar xxx.jar
方式2、把秘鑰當做程序啟動時的命令行參數(推薦),示例如下:
java -jar xxx.jar --jasypt.encryptor.password=秘鑰
方式3、自定義加密、解密器邏輯
這里不再展開,有需要可自行編寫自定義加密和解密器的邏輯代碼。
4.2 使用jasypt3.0啟動時報
使用jasypt3.0啟動時報:Failed to bind properties under ‘xxx.xxx.xxx’ to java.lang.String
官方描述,3.0后默認支持的算法為PBEWITHHMACSHA512ANDAES_256 ,該種加密方式由sha512 加 AES 高級加密組成,需要JDK1.9以上支持或者添加JCE(Java Cryptography Extension無限強度權限策略文件)支持,否則運行會出現錯誤。
4.2.1 解決方案1,降低版本
降低jasypt的版本 - 使用2.x的版本
4.2.2 解決方案2,修改算法
將加密算法替換成PBEWithMD5AndDES 算法,并配置iv-generator-classname: 為org.jasypt.iv.NoIvGenerator值文章來源:http://www.zghlxwxcb.cn/news/detail-437022.html
本文完結!文章來源地址http://www.zghlxwxcb.cn/news/detail-437022.html
到了這里,關于【Jasypt】Spring Boot 配置文件加解密 Jasypt 配置文件加密的文章就介紹完了。如果您還想了解更多內容,請在右上角搜索TOY模板網以前的文章或繼續(xù)瀏覽下面的相關文章,希望大家以后多多支持TOY模板網!