一. 使用步驟

1. 添加依賴

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.4</version>
</dependency>

2.配置加密密碼

Jasypt需要一個密碼來進行加密和解密操作?？梢酝ㄟ^以下幾種方式配置這個密碼：

在配置文件中指定 ：在你的application.properties或application.yml配置文件中，添加jasypt.encryptor.password配置項，并設置你的密碼。例如：

# application.properties
jasypt.encryptor.password=your_encryption_password

或者，在application.yml中：

jasypt:
  encryptor:
    password: your_encryption_password

然而，將密碼直接寫在配置文件中可能存在安全風險。因此，更推薦的做法是通過啟動參數(shù)或環(huán)境變量來傳遞這個密碼。

通過啟動參數(shù)指定：在啟動應用程序時，可以通過

-Djasypt.encryptor.password=your_encryption_password參數(shù)來指定加密密碼。

使用環(huán)境變量：在某些情況下，使用環(huán)境變量來存儲敏感信息（如加密密碼）可能更為安全。具體方法取決于你的應用程序部署環(huán)境。

3. 加密敏感信息

在配置加密密碼后，你可以使用Jasypt提供的工具或API來加密你的敏感信息。加密后的信息將以密文形式存儲。

使用Jasypt CLI工具：Jasypt提供了一個命令行界面（CLI）工具，允許你在命令行中加密和解密字符串。你需要下載Jasypt的jar包，并在命令行中運行相應的命令。

Jasypt JAR 文件下載地址 :

jasypt-1.9.3.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應用程序中，你可以通過注入StringEncryptor接口的實現(xiàn)類來編程方式加密和解密字符串。這通常在你的Spring Boot應用程序中通過自動裝配完成。

/**
 * 加密控制器
 *
 * @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)，括號內是加密后的密文。例如：

username: ENC(aHApYu/25KrMl/q6Mr7X+0jYRC8E52V62ciUqtzDelELeHUwUrgGDl1oQJVUeXCt)
password: ENC(A0bDpXcWODFJ7JXiDNVKU5n49RSLM4Q3e5ZtS5T+fTY54S12zazVyxHhbV49OzY7)

5.應用程序啟動時自動解密

當你的Spring Boot應用程序啟動時，Jasypt會自動檢測配置文件中的ENC(...)字符串，并使用你配置的加密密碼來解密這些字符串。解密后的明文將用于應用程序的配置中。

注意: 如過用環(huán)境變量傳參,本地啟動時需要傳入環(huán)境變量,jar包運行也一樣

-Djasypt.encryptor.password=your-encryptor-password

本地

jar包命令 :

java -Djasypt.encryptor.password=your-encryptor-password -jar your-jar

二. Jasypt配置項

三. 支持的加密算法

Jasypt支持多種加密算法以保護敏感數(shù)據(jù)。以下是Jasypt支持的一些常見加密算法：

到此這篇關于SpringBoot3使用Jasypt實現(xiàn)加密配置文件的文章就介紹到這了,更多相關SpringBoot3 Jasypt加密配置文件內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論