Spring Cloud Config配置文件使用对称加密的方法

关于Spring Cloud Config配置文件使用对称加密的方法的攻略如下：

1. 配置对称加密

首先我们需要在工程中添加对称加密的模块和配置文件。比如我们可以使用Jasypt来实现对称加密，只需要在pom.xml文件中引入对应的依赖即可：

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

然后需要在配置文件中指定加密的算法和密钥。比如我们可以在application.properties文件中添加：

# 指定加密算法
jasypt.encryptor.algorithm=PBEWithMD5AndDES
# 指定密钥
jasypt.encryptor.password=80804669

然后就可以在配置文件中使用加密的方式了。比如我们可以将数据库连接信息进行加密，如下所示：

spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.url= jdbc:mysql://localhost:3306/db_name
spring.datasource.username=ENC(PTlIqRjvAEo5zrHdteJKuw==)
spring.datasource.password=ENC(JJ/JK28bMWdljthy0VIx/XxK8t8gX+fF)

其中ENC()表示对后面的内容进行加密，可以保证敏感信息的安全性。

2. 解密配置文件

在工程中需要能够解密配置文件。这需要在程序中添加对应的解密组件。我们需要添加如下的代码：

import org.jasypt.encryption.StringEncryptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class Application {

    @Autowired
    private StringEncryptor encryptor;

    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }

    @Bean
    public StringEncryptor stringEncryptor() {
        return new JasyptStringEncryptor("80804669");
    }

    private class JasyptStringEncryptor implements StringEncryptor {

        private final Encryptor encryptor;

        public JasyptStringEncryptor(String password) {
            PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
            encryptor.setAlgorithm("PBEWithMD5AndDES");
            encryptor.setPassword(password);
            this.encryptor = encryptor;
        }

        @Override
        public String encrypt(String message) {
            return encryptor.encrypt(message);
        }

        @Override
        public String decrypt(String encryptedMessage) {
            return encryptor.decrypt(encryptedMessage);
        }
    }
}

其中JasyptStringEncryptor是对Jasypt的封装，解决了手动指定加密密钥的问题。我们还需要在配置文件中添加解密的密钥：

# 指定解密的密钥
jasypt.encryptor.password=80804669

这样在读取配置文件时会自动进行解密操作，但需要将@Value注解改成@Value("${password:}")，如下所示：

@Value("${spring.datasource.password:}")
private String password;

示例1

如何加密和解密配置文件中的字符串？

1. 配置对称加密需要添加的依赖和配置文件。

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

在application.properties文件中添加加密算法和密钥。

# 指定加密算法
jasypt.encryptor.algorithm=PBEWithMD5AndDES
# 指定密钥
jasypt.encryptor.password=80804669

1. 将需要加密的密码进行加密，并替换配置文件中的密码。

java
String password = "mysecretpassword";
StringEncryptor encryptor = new PooledPBEStringEncryptor();
encryptor.setAlgorithm("PBEWithMD5AndDES");
encryptor.setPassword("80804669");
String encryptedPassword = encryptor.encrypt(password);

将生成的加密密码放到配置文件中，并在对应的配置项前加上ENC()。

spring.datasource.password=ENC(JJ/JK28bMWdljthy0VIx/XxK8t8gX+fF)

1. 在程序中读取密码，系统会自动进行解密操作。

java
@Value("${spring.datasource.password:}")
private String password;

示例2

如何将加密的配置文件放到远程的Git仓库中，并使用Spring Cloud Config来自动管理配置文件和解密操作？

1. 在远程Git仓库中添加加密前的配置文件。

2. 在Spring Cloud Config Server中添加对称加密的配置。

encrypt:
key: mysecretkey

1. 在Spring Cloud Config Client中添加对称加密的配置以及基础配置。

spring:
cloud:
config:
uri: http://localhost:8888
username: user
password: password
failFast: true
retry:
enabled: false
application:
name: myapp

encrypt:
key: mysecretkey

1. 在程序中读取需要解密的密码。

java
@Value("${spring.datasource.password:}")
private String password;

这样就可以将加密的配置文件放到远程Git仓库中，使用Spring Cloud Config Server来管理，使用Spring Cloud Config Client来自动读取和解密。