SpringBoot实现配置文件加密的方案分享

 更新时间:2023年11月23日 16:15:02   作者:Rise同志  
项目的数据库密码、redis 密码等明文展示在配置文件中会有潜在的风险,因此采用合适的安全防护措施是有必要的,下面小编就为大家介绍一下SpringBoot中配置文件加密的方法,希望对大家有所帮助

1.为什么要对配置文件关键信息进行加密

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/test?useSSL=false
    username: root
    password: root
  redis:
    host: 127.0.0.1
    port: 6379
    password: 123456

项目的数据库密码、redis 密码等明文展示在配置文件中会有潜在的风险,比如源码泄露,或者配置文件暴露,会导致相关密码泄露,造成安全风险,因此采用合适的安全防护措施是有必要的。

2.配置文件加密方案

方案1:jasypt

jasypt 是一个开源的工具类,可以方便的对 SpringBoot 配置文件中的配置项进行对称加密

集成步骤

1.1 引入Jar包

在maven中引入如下依赖

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

1.2 对敏感数据生成加密字符串

有以下三种加密方式,请根据自己需求和项目情况自行选择:

方式1: 通过加密工具类生成(以下为代码实例,可以直接使用)

import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.EnvironmentStringPBEConfig;

/**
 * 使用Jasypt对配置文件进行加密
 */
public class JasyptUtil {

    /**
     * 加密算法 加密解密保证同一种算法
     * jasypt3.0后,默认支持的算法为 PBEWITHHMACSHA512ANDAES_256,这种算法安全性更高,但是需要 Java JDK 1.9+或添加JCE(Java Cryptography Extension 无限强度权限策略文件)
     * 使用PBEWithMD5AndDES算法即可
     */
    private static final String algorithm ="PBEWithMD5AndDES";
    //密钥,对称加密使用同一个密钥进行加解密,密钥自己定义,注意保管
    private static final String key ="test";

    public static void main(String[] args) {
        //加密方法示例
        String encryptInfo = encrypt("root");
        System.out.println(encryptInfo);
        //解密方法示例
        String decryptInfo = decrypt(encryptInfo);
        System.out.println(decryptInfo);
    }

    /**
     * 加密
     *
     * @param value 明文
     * @return
     */
    public static String encrypt(String value) {
        StandardPBEStringEncryptor encryptor = new StandardPBEStringEncryptor();
        EnvironmentStringPBEConfig config = new EnvironmentStringPBEConfig();
        // 指定算法
        config.setAlgorithm(algorithm);
        // 指定秘钥
        config.setPassword(key);
        encryptor.setConfig(config);
        // 加密数据
        return encryptor.encrypt(value);
    }

    /**
     * 解密
     *
     * @param value 密文
     * @return
     */
    public static String decrypt(String value) {
        StandardPBEStringEncryptor encryptor = new StandardPBEStringEncryptor();
        EnvironmentStringPBEConfig config = new EnvironmentStringPBEConfig();
        config.setAlgorithm(algorithm);
        config.setPassword(key);
        encryptor.setConfig(config);
        // 解密数据
        return encryptor.decrypt(value);
    }
}

方式2: 执行 jar包,通过命令行的模式获取(不推荐,操作起来不够方便)

java -cp ./jasypt-1.9.3.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI password="test" algorithm=PBEWithMD5AndDES input=root

输出结果:

Runtime: Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.161-b12

----ARGUMENTS-------------------

input: root
algorithm: PBEWithMD5AndDES
password: ADUMDFUOV7834*

----OUTPUT----------------------

dXTlEeOApsY5oCeCQEo4Gg==

注:

  • password:用来加密的密钥
  • algorithm:加密算法 PBEWithMD5AndDES/PBEWITHHMACSHA512ANDAES_256。使用PBEWithMD5AndDES即可
  • input:后接的属性为需要加密的参数
  • OUTPUT输出的值即为加密后的值

方式三: 使用Maven插件(推荐,使用起来比较快捷)

Maven中引入jasypt插件

<plugin>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-maven-plugin</artifactId>
    <version>3.0.3</version>
    <configuration>
        <path>file:src/main/resources/application.yml</path>
    </configuration>
</plugin>

注:

path标签中的路径请根据自己配置文件路径配置

修改配置文件

server:
  port: 8030
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test?useSSL=false
    driver-class-name: com.mysql.jdbc.Driver
    username: DEC(root)
    password: DEC(root)
jasypt:
   encryptor:
     password: test
  • 需要加密的数据使用DEC()包起来
  • password为密钥自定义

Maven加密命令

mvn jasypt:encrypt -Djasypt.encryptor.password=test

执行完该命令之后,DEC中的内容会自动被替换为ENC(加密内容)

Maven解密命令

mvn jasypt:decrypt -Djasypt.encryptor.password=test

1.3 使用

配置文件中按下图添加密钥和需要加密的属性之后,启动时会自动对敏感数据进行解密

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test?useSSL=false
    driver-class-name: com.mysql.jdbc.Driver
    username: ENC(加密之后的属性)
    password: ENC(加密之后的属性)
jasypt:
   encryptor:
     password: 自定义的密钥

1.4 安全事项

由于该方案采用的是对称加密,一旦泄露密钥,相关密码将暴露,将密钥配置在配置文件中,非常不安全,推荐将密钥添加到启动命令中,降低暴露风险

java -jar demo.jar --Djasypt.encryptor.password=test

以上就是SpringBoot实现配置文件加密的方案分享的详细内容,更多关于SpringBoot配置文件加密的资料请关注脚本之家其它相关文章!

相关文章

  • java中实现map与对象相互转换的几种实现

    java中实现map与对象相互转换的几种实现

    这篇文章主要介绍了java中实现map与对象相互转换的几种实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • idea中使用git合并分支实践

    idea中使用git合并分支实践

    这篇文章主要介绍了idea中使用git合并分支实践,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 《阿里巴巴 Java开发手册》读后感小结

    《阿里巴巴 Java开发手册》读后感小结

    这篇文章主要介绍了《阿里巴巴 Java开发手册》读后感小结,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • RestTemplate报错I/O error on POST request for的解决办法

    RestTemplate报错I/O error on POST request for的解决办法

    这篇文章主要给大家介绍了关于RestTemplate报错I/O error on POST request for的解决办法,文中通过代码实例将解决的办法介绍的非常详细,需要的朋友可以参考下
    2023-08-08
  • Mybatis实战教程之入门到精通(经典)

    Mybatis实战教程之入门到精通(经典)

    MyBatis是支持普通SQL查询,存储过程和高级映射的优秀持久层框架,通过本文给大家介绍Mybatis实战教程之入门到精通,对mybatis实战教程相关知识感兴趣的朋友一起学习吧
    2016-01-01
  • Map 使用 Lambda 的 forEach 实现跳出循环操作

    Map 使用 Lambda 的 forEach 实现跳出循环操作

    这篇文章主要介绍了Map 使用 Lambda 的 forEach 实现跳出循环操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • MyBatis绑定错误提示BindingException:Invalid bound statement (not found)的解决方法

    MyBatis绑定错误提示BindingException:Invalid bound statement (not f

    这篇文章主要介绍了MyBatis绑定错误提示BindingException:Invalid bound statement (not found)的解决办法,非常不错,具有参考借鉴价值,需要的的朋友参考下吧
    2017-01-01
  • SpringBoot基于Redis的分布式锁实现过程记录

    SpringBoot基于Redis的分布式锁实现过程记录

    Redis是一套 key-value 高性能数据库,使用它可以大大提高我们的开发效率,在SpringBoot中,自动配置也帮我们节约了大量的配置,下面这篇文章主要给大家介绍了关于SpringBoot基于Redis的分布式锁实现的相关资料,需要的朋友可以参考下
    2022-01-01
  • pageHelper一对多分页解决方案示例

    pageHelper一对多分页解决方案示例

    这篇文章主要为大家介绍了pageHelper一对多分页解决方案示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-04-04
  • 使用IDEA创建Java Web项目并部署访问的图文教程

    使用IDEA创建Java Web项目并部署访问的图文教程

    本文通过图文并茂的形式给大家介绍了使用IDEA创建Java Web项目并部署访问的教程,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-08-08

最新评论