前言

項目中的配置文件會有密碼的存在，例如數據庫的密碼、郵箱的密碼、FTP的密碼等。

配置的密碼以明文的方式暴露，并不是一種安全的方式，特別是大型項目的生產環境中，因為配置文件經手的（運維）人員可能很多，也可能是多方的（甲方、乙方甚至第三方）。本文講述基于 SpringBoot 項目對配置文件中的密碼進行加密。

本文實例中密碼加密主要用到的是 Jasypt，一個JAVA的加解密庫。

加密步驟

1、在項目中引入以下依賴。

        <dependency>
            <groupId>com.github.ulisesbocchio</groupId>
            <artifactId>jasypt-spring-boot</artifactId>
            <version>1.18</version>
        </dependency>
        <dependency>
            <groupId>org.jasypt</groupId>
            <artifactId>jasypt</artifactId>
            <version>1.9.2</version>
        </dependency>

2、在Application.yml文件中添加以下配置信息。

# 配置文件密碼加密配置
jasypt:
  encryptor:
    password: EbfYkitulv73I2p0mXI50JMXoaxZTKJ7 # 秘鑰
    algorithm: PBEWithMD5AndDES # 加密算法
    iv-generator-classname: org.jasypt.iv.NoIvGenerator

（1）從3.0.0jasypt-spring-boot 版本開始，默認的加密/解密算法已更改為PBEWITHHmacSHA512ANDAES_256；3.0.0以下版本默認為 PBEWithMD5AndDES;

（2）上述algorithm 不配置的話，其默認的秘鑰也是 PBEWithMD5AndDES；

（3）以上的 jasypt.encryptor.password 并不是很多人理解的 salt(鹽)，這是加密密鑰。代碼中的salt是隨機生成的，長度默認為8位，生成類默認是 org.jasypt.salt.RandomSaltGenerator，可以通過配置 jasypt.encryptor.salt-generator-classname來修改。

3、通過命令獲取密文。

java -cp /Users/shiyanfei/zlb/repository/repository-zlb/org/jasypt/jasypt/1.9.2/jasypt-1.9.2.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="MySQL@1234" password=idss@2021 algorithm=PBEWithMD5AndDES

終端執行上述命令會生成密文，其中：

/Users/shiyanfei/zlb/repository/repository-zlb/org/jasypt/jasypt/1.9.2/ 是 jasypt-1.9.2.jar 的路徑（linux環境中應該是在/lib包下面），根據需求修改；
input 是明文密碼，每一個密碼都需要執行一次；
password 是秘鑰。

4、修改原來的密碼配置

原來的明文密碼值，改為 ENC(xxx) ,其中xxx是密文。

例如：

1）MySQL

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/ueba?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&&useSSL=false
    driver-class-name: com.mysql.jdbc.Driver
    username: root
    password: ENC(2RP1Vdsa+2wdSOgu2biAJkTCU9fnkUGD)

2）redis

spring:
  redis:
    database: 0
    host: 10.20.24.48
    port: 6379
    password: ENC(JjPTg5GOsjV9ZBIQ2CaHr+96UgMKBgIT)

5、添加注解

啟動類上添加@EnableEncryptableProperties。

思考：以上的步驟中，根據 Jasypt 的用法，基本上完成了對配置文件中密碼的加密。但是，請思考一下，這樣處理是否真的安全合理？

優化

如果按照嚴格的要求來，這樣處理并不是完善的。因為秘鑰和密文都暴露出來，依然是不安全的。那么，要如何處理呢？以下是我其中的一個思路，并已在項目中實踐。

1、首先，秘鑰通過另一個小工具生成，該小工具與項目無關；

小工具是一個獨立的完整程序，有打包腳本和啟停腳本。篇幅所限，已將源碼上傳至 GitHub。

2、其次，秘鑰不暴露在配置文件中，而寫入代碼中（正常情況下，秘鑰基本不會變動）；

/************************ CHANGE REPORT HISTORY ******************************
 ** Product VERSION,UPDATED BY,UPDATE DATE                                     *
 *   DESCRIPTION OF CHANGE: modify(M),add(+),del(-)                            *
 *-----------------------------------------------------------------------------*
 * V3.0.12,shiyanfei,2021-09-14
 * create 
 *
 *************************** END OF CHANGE REPORT HISTORY ********************/
package com.idss.radar.common.ums.bean;

import org.jasypt.encryption.StringEncryptor;
import org.jasypt.encryption.pbe.PooledPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.SimpleStringPBEConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author : shiyanfei
 * @description : <p>自動配置加密信息</p>
 * @see : com.idss.radar.common.ums.bean
 * @since : 2021-09-14
 */
@Configuration
public class EncryptorConfig {
    @Bean("jasyptStringEncryptor")
    public StringEncryptor jasyptStringEncryptor() {
        PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
        SimpleStringPBEConfig config = new SimpleStringPBEConfig();
        config.setPassword("EbfYkitulv73I2p0mXI50JMXoaxZTKJ7");
      	// 注釋部分為配置默認
        config.setAlgorithm("PBEWithMD5AndDES");
//        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、刪除配置文件中的信息

# 配置文件密碼加密配置
jasypt:
  encryptor:
    password: EbfYkitulv73I2p0mXI50JMXoaxZTKJ7 # 秘鑰
    algorithm: PBEWithMD5AndDES # 加密算法
    iv-generator-classname: org.jasypt.iv.NoIvGenerator

4、以上處理還有一個好處，就是優化后的項目，既支持明文，也支持密文，密文只要加函數 ENC(xxxx)。