Spring Boot 配置文件密码加密两种方案

Spring Boot 配置文件密码加密两种方案 jasypt 加解密

jasypt 是一个简单易用的加解密Java库，可以快速集成到 Spring 项目中。可以快速集成到 Spring Boot 项目中，并提供了自动配置，使用非常简单。
jasypt 库已上传到 Maven 中央仓库, 在 GitHub 上有更详细的使用说明。
jasypt 的实现原理是实现了 ApplicationContextInitializer 接口，重写了获取环境变量的方法，在容器初始化时对配置文件中的属性进行判断，若包含前后缀(ENC(的))表示是加密属性值，则进行解密并返回。

你的配置文件是不是还在使用下面这种落后的配置暴露一些密码：

jdbc.url=jdbc:mysql://127.0.0.1:3305/afei
jdbc.username=afei
jdbc.password=123456

如果是，那么继续往下看。笔者今天介绍史上最优雅加密接入方式：jasypt。

使用方式

用法一

先看用法有多简单，以springboot为例：

Application.java上增加注解@EnableEncryptableProperties(jasypt-spring-boot-starter包不需要该配置)；

增加配置文件jasypt.encryptor.password = Afei@2018，这是加密的秘钥；

所有明文密码替换为ENC(加密字符串)，例如ENC(XW2daxuaTftQ+F2iYPQu0g==)；

引入一个MAVEN依赖；

maven坐标如下：

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

简答的4步就搞定啦，是不是超简单？完全不需要修改任何业务代码。    其中第三步的加密字符串的生成方式为：
java -cp jasypt-1.9.2.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input="123456" password=Afei@2018 algorithm=PBEWithMD5AndDES

其中：

input的值就是原密码。

password的值就是参数jasypt.encryptor.password指定的值，即秘钥。

用法二

其实还有另一种更简单的姿势：

增加配置文件jasypt.encryptor.password = Afei@2018，这是加密的秘钥；

所有明文密码替换为ENC(加密字符串)，例如ENC(XW2daxuaTftQ+F2iYPQu0g==)；

引入一个MAVEN依赖；

maven坐标如下：

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

相比第一种用法，maven坐标有所变化。但是不需要显示增加注解@EnableEncryptableProperties；

github地址

github：https://github.com/ulisesbocchio/jasypt-spring-boot
它github首页有详细的用法说明，以及一些自定义特性，例如使用自定义的前缀和后缀取代ENC()：

jasypt.encryptor.property.prefix=ENC@[
jasypt.encryptor.property.suffix=]
原理解密

既然是springboot方式集成，那么首先看jasypt-spring-boot的spring.factories的申明：

org.springframework.context.ApplicationListener=\
com.ulisesbocchio.jasyptspringboot.configuration.EnableEncryptablePropertiesBeanFactoryPostProcessor

这个类的部分核心源码如下：

public class EnableEncryptablePropertiesBeanFactoryPostProcessor implements BeanFactoryPostProcessor, ApplicationListener<ApplicationEvent>, Ordered {
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 得到加密字符串的处理类（已经加密的密码通过它来解密）
        EncryptablePropertyResolver propertyResolver = beanFactory.getBean(RESOLVER_BEAN_NAME, EncryptablePropertyResolver.class);
        // springboot下的Environment里包含了所有我们定义的属性, 也就包含了application.properties中所有的属性
        MutablePropertySources propSources = environment.getPropertySources();
        // 核心，PropertySource的getProperty(String)方法委托给EncryptablePropertySourceWrapper
        convertPropertySources(interceptionMode, propertyResolver, propSources);
    }

    @Override
    public int getOrder() {
        // 让这个jasypt定义的BeanFactoryPostProcessor的初始化顺序最低，即最后初始化
        return Ordered.LOWEST_PRECEDENCE;
    }
}