SpringBoot+ENC实现密钥加密的使用示例

 更新时间:2024年07月29日 09:40:39   作者:一恍过去  
本文主要介绍了SpringBoot+ENC实现密钥加密的使用示例,主要是为了将配置信息从应用程序代码中分离出来,以提高安全性和可维护性,感兴趣的可以了解一下

前言

Spring Boot中使用ENC(Environment-Neutral Configuration)主要是为了将配置信息从应用程序代码中分离出来,以提高安全性和可维护性。ENC的主要优点包括:

  • 安全性增强: 敏感信息(如数据库密码、API密钥等)不应硬编码在代码中,而是应该使用加密的方式存储在配置文件中,然后通过ENC进行解密和使用,从而减少泄露风险。
  • 可维护性: 将配置信息与代码分离,使得配置可以独立地修改和管理,而不需要重新编译和部署应用程序。这样可以降低维护成本,并使应用程序更易于管理。
  • 灵活性: 使用ENC可以根据不同的环境(开发、测试、生产等)提供不同的配置,而不需要修改应用程序代码,从而提高了部署的灵活性和可移植性。

1、整合SpringBoot

1.1、POM

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

1.2、加密盐值配置

整合SpringBoot时,盐值的配置最好式写到配置中心的文件中,盐值写到本地文件,泄露后也容易被进行解密

jasypt:
  encryptor:
  	# password值任意,最好随机字符
    password: hhX4FzbwcT

1.3、工具类使用

使用工具类对需要处理的明文数据进行加密处理,再将加密结果写入到配置文件中

注意:工具类使用完成后,应该删除加密盐

import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;

public class JasyptTest {

    /**
     * 加密盐值,使用完成后进行删除,或者不能提交到`生产环境`,比如:
     */
    private final static String PASSWORD = "hhX4FzbwcT";


    public static void main(String[] args) {

        PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();

        SimpleStringPBEConfig config = new SimpleStringPBEConfig();
        // 用于设置加密密钥。密钥是用于加密和解密字符串的关键信息。
        config.setPassword(PASSWORD);
        // 加密算法的名称,jasypt-3.0.5版本后默认的加密方式
        config.setAlgorithm("PBEWITHHMACSHA512ANDAES_256");
        // 用于设置加密时迭代次数的数量,增加迭代次数可以使攻击者更难进行密码破解。
        config.setKeyObtentionIterations("1000");
        // 加密器池的大小。池是一组加密器实例,可确保加密操作的并发性。
        config.setPoolSize("1");
        // 用于设置JCE(Java Cryptography Extension)提供程序的名称。
        config.setProviderName("SunJCE");
        // 用于设置生成盐的类名称。在此配置中,我们使用了org.jasypt.salt.RandomSaltGenerator,表示使用随机生成的盐。
        config.setSaltGeneratorClassName("org.jasypt.salt.RandomSaltGenerator");
        // 用于设置Jasypt使用的初始化向量(IV)生成器的类名。初始化向量是在加密过程中使用的一个固定长度的随机数,用于加密数据块,使每个数据块的加密结果都是唯一的。在此配置中,我们使用了org.jasypt.iv.RandomIvGenerator类,该类是一个随机生成器,用于生成实时随机IV的实例。这样可以确保每次加密的IV都是唯一的,从而增加加密强度。
        config.setIvGeneratorClassName("org.jasypt.iv.RandomIvGenerator");
        // 指定加密输出类型。在此配置中,我们选择了base64输出类型。
        config.setStringOutputType("base64");
        encryptor.setConfig(config);

        // 明文1
        String name_encrypt = "root";
        // 明文2
        String password_encrypt = "123456";

        // 明文加密
        String encrypt1 = encryptor.encrypt(name_encrypt);
        String encrypt2 = encryptor.encrypt(password_encrypt);
        System.out.println("明文加密1:" + encrypt1);
        System.out.println("明文加密2:" + encrypt2);

        // 密文解密
        String decrypt1 = encryptor.decrypt(encrypt1);
        String decrypt2 = encryptor.decrypt(encrypt2);
        System.out.println("密文解密1:" + decrypt1);
        System.out.println("密文解密2:" + decrypt2);
    }
}

在这里插入图片描述

1.4、加密配置使用

YAML:

sys:
 name: ENC(Yt36hceu3xGXEzrz2jCPjvalaXQ5yIHE04SVT6lIkcktrxqtBZrlivkAkA9/9oZ2)
 password: ENC(0Ci6irPOko9IG+hBZJAGoguIuE52gF/XiigCV4DwLm6NfkoyvV4Etgc9FzKK3MYl)

1.5、测试

项目成功启动,Yaml中设置密文文本,Controller正常打印明文信息,就表示ENC配置成功了

@RestController
public class TestController {

    @Value("${sys.name}")
    private String name;

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

    @GetMapping("/test")
    public void test() {
        System.out.println("name = " + name);
        System.out.println("password = " + password);
    }
}

2、ENC加载原理

1、在jasypt-spring-boot-starter包的自动配置类JasyptSpringBootAutoConfiguration中通过@Import注解引入了EnableEncryptablePropertiesConfiguration配置类,该类中environment参数储存了yaml文件元数据;

2、在postProcessBeanFactory方法中,调用environment.getPropertySources()方法获取yaml配置项目;

在这里插入图片描述

3、通过convertPropertySources进行数据转换,修改yaml中配置项值,具体实现为调用instantiatePropertySource()方法,在该方法中,匹配propertySource instanceof MapPropertySource,转化为EncryptableMapPropertySourceWrapper对象;

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

4、EncryptableMapPropertySourceWapper类中,通过getProperty(name)方法进行匹配,匹配成功后调用resolver.resolvePropertyValue进行ENC配置的解密并且替换原有的propertySource值;

在这里插入图片描述

到此这篇关于SpringBoot+ENC实现密钥加密的使用示例的文章就介绍到这了,更多相关SpringBoot ENC密钥加密内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot实现图形验证码的示例代码

    SpringBoot实现图形验证码的示例代码

    验证码的实现方式有很多,可以由前端实现,也可以由后端进行实现,也有很多的插件和工具包可以使用,在这里,我们使用 Hutool 提供的小工具实现,本文介绍SpringBoot实现图形验证码的实例,感兴趣的朋友跟随小编一起看看吧
    2025-12-12
  • 流式图表拒绝增删改查之kafka核心消费逻辑上篇

    流式图表拒绝增删改查之kafka核心消费逻辑上篇

    这篇文章主要为大家介绍了流式图表拒绝增删改查之kafka核心消费逻辑详解的上篇,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-04-04
  • SpringBoot统一返回格式的方法详解

    SpringBoot统一返回格式的方法详解

    今天小编主要是和大家分享一个让代码变得更简洁的小技巧:统一返回格式,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2022-08-08
  • idea不使用maven如何将项目打包

    idea不使用maven如何将项目打包

    使用IDEA 2021版本,不借助Maven进行打WAR包的步骤是:首先点击Project Structure,然后点击Artifacts,接着选择需要的打包类型,设置好包的名称,最后进行打包,这种方法适用于不使用Maven进行项目管理的情况
    2024-09-09
  • Java 调用Restful API接口的几种方式(HTTPS)

    Java 调用Restful API接口的几种方式(HTTPS)

    这篇文章主要介绍了Java 调用Restful API接口的几种方式(HTTPS),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • SpringBoot3实现优雅停机的完整流程

    SpringBoot3实现优雅停机的完整流程

    在现代微服务架构中,优雅停机(Graceful Shutdown)是一项重要功能,可以确保服务在关闭时处理完所有当前请求,避免突然终止连接或丢失数据,Spring Boot 3 提供了对优雅停机的内置支持,本文给大家介绍了SpringBoot3怎样优雅停机,需要的朋友可以参考下
    2024-10-10
  • 修改Maven settings.xml 后配置未生效的解决

    修改Maven settings.xml 后配置未生效的解决

    这篇文章主要介绍了修改Maven settings.xml 后配置未生效的解决,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • Java实现数组反转翻转的方法实例

    Java实现数组反转翻转的方法实例

    本篇文章主要介绍了Java实现数组反转翻转的方法实例,详细的介绍了3种实现方法,有兴趣的可以了解一下。
    2017-04-04
  • Java中把一个文件夹下的所有文件复制到另一个文件夹的完整实现方案

    Java中把一个文件夹下的所有文件复制到另一个文件夹的完整实现方案

    这篇文章主要介绍了如何使用Java原生API实现文件夹复制,支持多级目录、空文件夹和文件覆盖等场景,并提供了基于File和FileChannel的实现方案,此外,还介绍了使用Java 7的Files工具类进行简化实现,需要的朋友可以参考下
    2026-01-01
  • JavaWeb中的Filter过滤器解读

    JavaWeb中的Filter过滤器解读

    这篇文章主要介绍了JavaWeb中的Filter过滤器解读,Filter过滤器是JavaWeb的三大组件之一,Filter过滤器是JavaEE的规范也就是接口,Filter的作用是拦截请求,过滤响应,需要的朋友可以参考下
    2023-10-10

最新评论