使用jasypt对SpringBoot配置文件进行加密全攻略

需求背景:对项目application.properties配置文件中的数据库密码信息进行加密。

考察后,考虑使用jasypt,它是一款用于对配置文件信息进行MD5加密的工具。
可以参考该网站的文档对jasypt进行进一步的了解。
http://www.jasypt.org/
github地址:
https://github.com/jasypt/jasypt

由于很多应用使用 配置文件 (eg:properties、yml) 来存储配置信息,配置中经常会涉及到许多敏感信息。
举几个小例子:
*普通应用密码信息,如:DB、Rabbit、Redis等;
*特殊密码信息,如:Spring Cloud Config需要配置Git等VCS密码信息;
*第三方通讯凭证信息,如:调用第三方接口发送短信的通讯凭证信息;
这些信息一般在配置文件中都是不应该明文展示的,所以可以用这款工具来进行加密。

前置条件:
jasypt能够非常友好地支持springboot框架,所以建议在springboot框架中使用。

首先在pom.xml引入依赖,推荐使用:

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

如果使用这个依赖,就可以不用在启动项中加入注解@EnableEncryptableProperties

接着,在application.properties文件中设置盐值,以properties为例:

# 使用jasypt加密所需的salt(盐值),这个值是可以自定义的,此处以example为例
jasypt.encryptor.password=example

# 默认加密方式PBEWithMD5AndDES,可以更改为PBEWithMD5AndTripleDES,可以不写
# jasypt.encryptor.algorithm=PBEWithMD5AndDES

盐值的概念:
我们使用 待加密字段,盐值,加密方式,三者作为参数进行加密。盐值是加密和解密时使用的关键参数,如果盐值泄露,会被反解出密码,所以目前这种把盐值参数存放在配置文件的做法是有漏洞的,后面会尝试给出解决方案。

第三步,生成密文:

//直接写一个方法
 public static void main(String[] args) {
        BasicTextEncryptor textEncryptor = new BasicTextEncryptor();
        //加密所需的salt(盐)
        textEncryptor.setPassword("example");
        //要加密的数据(数据库的用户名或密码)
        String username = textEncryptor.encrypt("userName");
        String password = textEncryptor.encrypt("passWord");
        System.out.println("username:"+username);
        System.out.println("password:"+password);
    }
输出结果:
    username:amLG2xGHIs2TKMjrmIkEwNWF5NfnG3/Z
    password:yo0W9gsDpVVrZ55LLALqqSjhelA93l+F

将生成的密文配置到application.properties中,格式如下:
前缀需要添加"ENC(",后缀需要添加")",均为英文大写,英文状态下的左右小括号;

spring.datasource.username=ENC(amLG2xGHIs2TKMjrmIkEwNWF5NfnG3/Z)
spring.datasource.password=ENC(yo0W9gsDpVVrZ55LLALqqSjhelA93l+F)

或者直接使用jar包来生成对应的密文:

java -cp jasypt-1.9.2.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI password=example algorithm=PBEWithMD5AndDES input=userName
使用jar包直接传参生成密文

观察传参
password:自定义的盐值
algorithm:加密方式
input:待加密字段

最后OUTPUT的内容即为生成的密文,我们可以观察到,即使使用相同的password和input内容,生成的密文也是不一样的。

那么,我们怎么能确定这个密文对应的就是我们的待加密字段呢?

//也是直接写一个解密方法,传参为盐值和密文
public static void main(String[] args) {
    String password = "example";
    StandardPBEStringEncryptor encryptor = new StandardPBEStringEncryptor();
    encryptor.setPassword(password);
    System.out.println(encryptor.decrypt("amLG2xGHIs2TKMjrmIkEwNWF5NfnG3/Z"));
}

结果如下:
使用盐值对密文进行解密

解密使用jar包生成的密文,也能得到同样的结果:
解密使用jar包生成的密文

于是我们可以在项目中正式应用数据加密了。

思考内容:可不可以直接不写盐值配置项呢?

答案是不可以。直接删除盐值配置项,项目启动报错:缺失配置项。
删除盐值配置项后启动报错

同样,如果写错了盐值配置项,同样会报错:解析失败,请确保盐值匹配:
使用错误盐值配置项的结果.jpg

回到之前的问题,如果我们把盐值写在配置文件里,其实并没有起到完全加密作用,根据盐值和密文是可以解密出原始密码的,所以盐值不能放在配置文件中。

尝试解决的思路:
1.在启动jar包时,直接将盐值配置信息作为参数注入:

--jasypt.encryptor.password=example

2.把盐值作为固定值,放在枚举类中,在启动时,先加载该盐值作为配置项:

public class DemoServiceApplication {
    public static void main(String[] args) {
        System.setProperty("jasypt.encryptor.password", ConstantsCode.JasyptPassword.getMessage());
        SpringApplication.run(DemoServiceApplication.class, args);
    }
}

3.在服务器配置环境变量:

打开/etc/profile文件
vim /etc/profile

文件末尾插入
export JASYPT_PASSWORD = example

编译 
source /etc/profile

运行 
java -jar -Djasypt.encryptor.password=${JASYPT_PASSWORD} xxx.jar

其中:ConstantsCode.JasyptPassword为配置的枚举常量。
当然,你可以继续对这个常量值进行加密,等于说把盐值藏起来。
比如使用String转ASCII码的方式对盐值进行一次加密,使用时,再通过ASCII转String的方法转换回来。

感谢:
使用jasypt加密Spring Boot应用中的敏感配置
https://blog.csdn.net/myle69/article/details/81052489
SpringBoot2+mybatis+jasypt实现数据库连接池加密的大坑
https://blog.csdn.net/knightyzl/article/details/82352381
Get史上最优雅加密方式!没有之一!
https://www.jianshu.com/p/64ceda636e81

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容