Spring Boot 配置项加密

Spring Boot内置的properties支持为我们读取properties带来了便利。Properties文件的属性主要包含两种:系统内置(包含各个starter)的属性和用户自定义的属性。系统内置的属性由项目启动之时自动加载,不需要我们编写相关加载方法,而自定义的属性需要编写载入操作。具体步骤大家可以参考Spring Boot读取配置文件自定义信息这篇博客。

工作中我们会遇到这样的需求:为了避免敏感信息暴露,配置文件中有些属性(比如密码)必须配置加密后的字符串。系统启动后自动根据我们自定义的解密方法解出明文。对于这样的需求,我们需要如何操作呢?

用户自定义属性的自动解密操作

假如我们有自定义属性:
application.properties

username=paul
password=$%&*(**( #加密过后的字符串

我们可以使用PostConstruct注解,在创建该bean的实例之时自动执行解密的方法。如下所示:

@Value("${password}")
private String password;

// 表示在创建该bean之时自动执行
@PostConstruct
public void init() {
    // 调用我们自己的解密方法
    password = PasswordUtil.decode(password);
}

系统内置属性的解密处理

比如有如下所示的属性:
application.properties

spring.datasource.username=rmproject
spring.datasource.password=MTJiN3JtcHJvamVjdA==

Spring数据源的密码是加密过的。但是这个属性是Spring Boot自己加载的,我们想干预它的加载过程,要比处理自己写的属性麻烦多了。

下面为大家介绍一个工具jasypt-spring-boot-starter。它可以做到在Spring Boot加载属性之前,对属性进行处理。

该项目GitHub的地址为:https://github.com/ulisesbocchio/jasypt-spring-boot

Jasypt-spring-boot-starter的使用方法

我们引入项目的dependency:
pom.xml

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

首先,我们需要定义一个标记,来告诉工具哪些属性是需要解密的。比方说,我们在加密的属性前增加{cipher}字样:
application.properties

spring.datasource.username=rmproject
spring.datasource.password={cipher}MTJiN3JtcHJvamVjdA==

为了支持自定义的加密属性前缀,需要提供自己实现的EncryptablePropertyDetector类

public class MyEncryptablePropertyDetector implements EncryptablePropertyDetector {

    public static final String ENCODED_PASSWORD_HINT = "{cipher}";

    // 如果属性的字符开头为"{cipher}",返回true,表明该属性是加密过的
    @Override
    public boolean isEncrypted(String s) {
        if (null != s) {
            return s.startsWith(ENCODED_PASSWORD_HINT);
        }
        return false;
    }
    // 该方法告诉工具,如何将自定义前缀去除
    @Override
    public String unwrapEncryptedValue(String s) {
        return s.substring(ENCODED_PASSWORD_HINT.length());
    }
}

有了自定义加密属性的检测方法,我们还需要告诉工具如何进行解密操作:

public class MyEncryptablePropertyResolver implements EncryptablePropertyResolver {
    //自定义解密方法
    @Override
    public String resolvePropertyValue(String s) {
        if (null != s && s.startsWith(MyEncryptablePropertyDetector.ENCODED_PASSWORD_HINT)) {
            return PasswordUtil.decode(s.substring(MyEncryptablePropertyDetector.ENCODED_PASSWORD_HINT.length()));
        }
        return s;
    }
}

最后,我们需要将他们注册为bean

// 入口类添加该注解,开启属性自动解密功能
@EnableEncryptableProperties
public class DemoSpringBootApplication {
    //  注册这两个bean
    @Bean(name = "encryptablePropertyDetector")
    public EncryptablePropertyDetector encryptablePropertyDetector() {
        return new MyEncryptablePropertyDetector();
    }

    @Bean(name = "encryptablePropertyResolver")
    public EncryptablePropertyResolver encryptablePropertyResolver() {
        return new MyEncryptablePropertyResolver();
    }
}

到此,大功告成,可以启动项目试试效果了。

本博客为作者原创,欢迎大家参与讨论和批评指正。如需转载请注明出处。

参考资料

Jasypt Spring Boot starter https://github.com/ulisesbocchio/jasypt-spring-boot
Spring Boot读取配置文件自定义信息 https://www.jianshu.com/p/4c7b38ac66f9

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

推荐阅读更多精彩内容