Spring Boot整合Jasypt 库实现配置文件和数据库字段敏感数据的加解密

2024-06-05 23:44
文章标签 java 实现 spring 数据库 整合 boot 配置文件 加解密 敏感数据 jasypt

本文主要是介绍Spring Boot整合Jasypt 库实现配置文件和数据库字段敏感数据的加解密，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

在这里插入图片描述

😄 19年之后由于某些原因断更了三年，23年重新扬帆起航，推出更多优质博文，希望大家多多支持～
🌷 古之立大事者，不惟有超世之才，亦必有坚忍不拔之志
🎐 个人CSND主页——Micro麦可乐的博客
🐥《Docker实操教程》专栏以最新的Centos版本为基础进行Docker实操教程，入门到实战
🌺《RabbitMQ》本专栏主要介绍使用JAVA开发RabbitMQ的系列教程，从基础知识到项目实战
🌸《设计模式》专栏以实际的生活场景为案例进行讲解，让大家对设计模式有一个更清晰的理解
💕《Jenkins实战》专栏主要介绍Jenkins+Docker+Git+Maven的实战教程，让你快速掌握项目CI/CD，是2024年最新的实战教程
如果文章能够给大家带来一定的帮助！欢迎关注、评论互动～

Spring Boot整合Jasypt 库实现配置文件和数据库字段敏感数据的加解密

  • 1、前言
  • 2、什么是Jasypt
  • 3、什么是Jasypt-Spring-Boot
  • 4、接入初体验
    • 4.1 yml配置方式
    • 4.2 自定义配置类方式
    • 4.3 开始测试
    • 4.4 修改mysql参数加密
  • 5、使用JVM启动参数设置密钥
  • 6、加密和解密数据库字段
  • 7、结语

1、前言

在我们日常开发中，很多时候为了保证数据的安全，在处理敏感数据、前后端数据传输、数据库敏感数据入库等，数据的加密和解密是不可忽视的重要环节，特别是一些政企项目这点就尤为重要，避免每一次安全审计后反复的调整，所以在系统设计之初我们就应当把数据安全的问题考虑进去！

今天博主就给大家详细介绍Jasypt-Spring-Boot的功能，并展示如何在Spring Boot项目中实现各种加解密操作

2、什么是Jasypt

Jasypt（Java Simplified Encryption）是一个用于加密和解密数据的Java库。它提供了简单易用的API，可以轻松地将加密功能集成到Java应用程序中。Jasypt支持多种加密算法，并且可以保护各种类型的数据，包括文本、配置文件和数据库字段等。

3、什么是Jasypt-Spring-Boot

Jasypt-Spring-Boot是一个用于在Spring Boot应用程序中集成Jasypt的Starter。通过使用Jasypt-Spring-Boot，我们可以轻松地在Spring Boot项目中配置和使用Jasypt的加解密功能。
目前该库已经有2.8K的Star，且目前最新版本是 3.0.5
在这里插入图片描述

GitHub地址：https://github.com/ulisesbocchio/jasypt-spring-boot

4、接入初体验

在开始接入前首先构建我们的 Spring Boot 项目, 引入相关依赖

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

4.1 yml配置方式

修改 Spring Boot 配置文件，增加密钥

jasypt:encryptor:password: 123456

在 Spring Boot 启动类上 或配置类Configuration类上追加 @EnableEncryptableProperties注解

具体参数说明可以查看以下表格

配置项必填默认值说明
jasypt.encryptor.password是设置密钥
jasypt.encryptor.algorithm否PBEWITHHMACSHA512ANDAES_256设置算法
jasypt.encryptor.key-obtention-iterations否1000设置密钥生成的迭代次数
jasypt.encryptor.pool-size否1设置加密池的大小
jasypt.encryptor.provider-name否SunJCE设置加密提供者名称
jasypt.encryptor.provider-class-name否null设置加密提供类名
jasypt.encryptor.salt-generator-classname否org.jasypt.salt.RandomSaltGenerator设置盐值生成器的类名
jasypt.encryptor.iv-generator-classname否org.jasypt.iv.RandomIvGenerator设置初始化向量生成器的类名
jasypt.encryptor.string-output-type否base64设置输出字符串的编码方式
jasypt.encryptor.proxy-property-sources否false
jasypt.encryptor.skip-property-sources否empty list

最后一个属性jasypt.encryptor.proxy-property-sources用于指示jasyp-spring-boot如何拦截属性值以进行解密

  • 默认值false使用PropertySource、EnumerablePropertySource和MapPropertySource的自定义包装器实现。
  • 当为该属性指定true时，拦截机制将在每个特定的PropertySource实现上使用CGLib代理。这在某些必须保留原始PropertySource类型的场景中可能很有用

4.2 自定义配置类方式

创建一个自定义配置类：Bean名称为： jasyptStringEncryptor

import com.ulisesbocchio.jasyptspringboot.annotation.EnableEncryptableProperties;
import org.jasypt.encryption.StringEncryptor;
import org.jasypt.encryption.pbe.PooledPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.SimpleStringPBEConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
@EnableEncryptableProperties
public class StringEncryptorConfig {@Bean("jasyptStringEncryptor")public StringEncryptor stringEncryptor() {PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();SimpleStringPBEConfig config = new SimpleStringPBEConfig();config.setPassword("password");config.setAlgorithm("PBEWITHHMACSHA512ANDAES_256");config.setKeyObtentionIterations("1000");config.setPoolSize("1");config.setProviderName("SunJCE");config.setSaltGeneratorClassName("org.jasypt.salt.RandomSaltGenerator");config.setIvGeneratorClassName("org.jasypt.iv.RandomIvGenerator");config.setStringOutputType("base64");encryptor.setConfig(config);return encryptor;}
}

温馨提示

  • 在自定义StringEncryptor的时候，会覆盖默认的加密器，且Bean名称固定为 jasyptStringEncryptor
  • 如果你需要自定义Bean名称，则需要在springboot配置文件追加
    jasypt.encryptor.bean = your encryptorBean Name

如下面自定义自定义Bean名称

    @Bean("encryptorBean")public StringEncryptor stringEncryptor() {//参考上面的配置参数...}

4.3 开始测试

我们现在来编写一个测试类，来体验加解密的效果

	@Resource(name = "jasyptStringEncryptor")private StringEncryptor stringEncryptor;@Testpublic void testJasypt() {String mysqlRoot = stringEncryptor.encrypt("root");String mysqlPassword = stringEncryptor.encrypt("123456");System.out.println("mysqlroot加密后："+mysqlRoot);System.out.println("mysqlPassword加密后："+mysqlPassword);System.out.println("===================");System.out.println("mysqlRoot解密后："+ stringEncryptor.decrypt(mysqlRoot));System.out.println("mysqlPassword解密后："+ stringEncryptor.decrypt(mysqlPassword));}

测试输出如下：
在这里插入图片描述

4.4 修改mysql参数加密

我们已经获得了mysql加密后的账号以及密码，现在我们来给mysql配置的明文账户密码改一下

加密格式：默认的前后缀是 ENC() 括号里是密文

# 数据源配置
spring:#数据源配置datasource:type: com.alibaba.druid.pool.DruidDataSourcedriverClassName: com.mysql.cj.jdbc.Driverdruid:url: jdbc:mysql://localhost:3306/docker_test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8# 未加密前#username: root#password: 123456# 加密后username: ENC(TBTl1fiJ7tilJ91sEdym6G8vEQG7Wn3QhIBU77mrfzCtqkHPMEMAihvpjokqUgMP)password: ENC(9galEBTwYzgGG6ER3oY+k45463tkvYSnt+epH8SE/hldbi13hg3+XL7CPKpgJAQp)

启动SpringBoot项目。观察控制台输出，数据库是否完成连接初始化，且项目启动成功！

在这里插入图片描述

特别说明
小伙伴发现了在mysql的配置中，我们使用 ENC() 来包裹我们的密文，这个前后缀是可以修改的，如MICRO()

修改配置文件方式

jasypt:encryptor:property:prefix: "MICRO["suffix: "]"

编码方式

我们可以通过创建一个名为 encryptablePropertyDetector 类型为 EncryptablePropertyDetector 的Bean来覆盖默认实现，如果你需要修改默认名称，需要覆盖属性 jasypt.encryptor.property.detector-bean 并指定您希望给予bean的名称

private static class MyEncryptablePropertyDetector implements EncryptablePropertyDetector {@Overridepublic boolean isEncrypted(String value) {if (value != null) {return value.startsWith("MICRO");}return false;}@Overridepublic String unwrapEncryptedValue(String value) {return value.substring("MICRO".length());}
}

@Bean(name = "encryptablePropertyDetector")public EncryptablePropertyDetector encryptablePropertyDetector() {return new MyEncryptablePropertyDetector();}

5、使用JVM启动参数设置密钥

在我们 YML 配置方式中, jasypt.encryptor.password=123456 是明文的，有小伙伴会问，哎呀这不也是暴露了加密密钥么？ 要解决这个问题，我们可以使用JVM启动参数设置

在IDEA项目里 ，点击 Edit Configurations ，添加 VM 启动参数 -Djasypt.encryptor.password=123456
在这里插入图片描述
在这里插入图片描述
在生产环境部署jar包的时候，可以使用如下命令启动：

java -jar your-project.jar --jasypt.encryptor.password=password

6、加密和解密数据库字段

在我们公司某些项目中，用户的敏感信息是不允许明文存储数据库的，比如手机号、身份证等，接下来我们来演示如何在实体类中使用Jasypt进行数据库字段实现加解密

注意引入JPA支持 spring-boot-starter-data-jpa

import javax.persistence.AttributeConverter;
import javax.persistence.Converter;
import org.jasypt.util.text.AES256TextEncryptor;@Component
@Converter
public class EncryptedStringConverter implements AttributeConverter<String, String> {@Resource(name = "jasyptStringEncryptor")private StringEncryptor stringEncryptor;@Overridepublic String convertToDatabaseColumn(String attribute) {return stringEncryptor.encrypt(attribute);}@Overridepublic String convertToEntityAttribute(String dbData) {return stringEncryptor.decrypt(dbData);}
}

然后在实体类中使用这个转换器

import javax.persistence.Column;
import javax.persistence.Convert;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;@Entity
public class User {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;@Convert(converter = EncryptedStringConverter.class)@Column(name = "password")private String password;// Getters and Setters
}

7、结语

Jasypt-Spring-Boot是一个强大且易于使用的工具，可以在Spring Boot应用程序中实现加密和解密操作。通过本文的介绍，我们了解了如何在Spring Boot项目中配置和使用Jasypt，并展示了各种加解密操作的实现方法。

下一篇我们将针对Jasypt整合升级一下，使用自定义注解和AOP实现敏感数据加解密，点点关注更新不迷路哦～

在这里插入图片描述

这篇关于Spring Boot整合Jasypt 库实现配置文件和数据库字段敏感数据的加解密的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1034504。

相关文章

Oracle查询优化之高效实现仅查询前10条记录的方法与实践

Oracle查询优化之高效实现仅查询前10条记录的方法与实践

《Oracle查询优化之高效实现仅查询前10条记录的方法与实践》：本文主要介绍Oracle查询优化之高效实现仅查询前10条记录的相关资料,包括使用ROWNUM、ROW_NUMBER()函数、FET... 目录1. 使用 ROWNUM 查询2. 使用 ROW_NUMBER() 函数3. 使用 FETCH FI
阅读更多...
Python脚本实现自动删除C盘临时文件夹

Python脚本实现自动删除C盘临时文件夹

《Python脚本实现自动删除C盘临时文件夹》在日常使用电脑的过程中,临时文件夹往往会积累大量的无用数据,占用宝贵的磁盘空间,下面我们就来看看Python如何通过脚本实现自动删除C盘临时文件夹吧... 目录一、准备工作二、python脚本编写三、脚本解析四、运行脚本五、案例演示六、注意事项七、总结在日常使用
阅读更多...
Java实现Excel与HTML互转

Java实现Excel与HTML互转

《Java实现Excel与HTML互转》Excel是一种电子表格格式,而HTM则是一种用于创建网页的标记语言,虽然两者在用途上存在差异,但有时我们需要将数据从一种格式转换为另一种格式,下面我们就来看看... Excel是一种电子表格格式，广泛用于数据处理和分析，而HTM则是一种用于创建网页的标记语言。虽然两
阅读更多...
java图像识别工具类(ImageRecognitionUtils)使用实例详解

java图像识别工具类(ImageRecognitionUtils)使用实例详解

《java图像识别工具类(ImageRecognitionUtils)使用实例详解》：本文主要介绍如何在Java中使用OpenCV进行图像识别,包括图像加载、预处理、分类、人脸检测和特征提取等步骤... 目录前言1. 图像识别的背景与作用2. 设计目标3. 项目依赖4. 设计与实现 ImageRecogni
阅读更多...
Java中Springboot集成Kafka实现消息发送和接收功能

Java中Springboot集成Kafka实现消息发送和接收功能

《Java中Springboot集成Kafka实现消息发送和接收功能》Kafka是一个高吞吐量的分布式发布-订阅消息系统,主要用于处理大规模数据流,它由生产者、消费者、主题、分区和代理等组件构成,Ka... 目录一、Kafka 简介二、Kafka 功能三、POM依赖四、配置文件五、生产者六、消费者一、Kaf
阅读更多...
Java访问修饰符public、private、protected及默认访问权限详解

Java访问修饰符public、private、protected及默认访问权限详解

《Java访问修饰符public、private、protected及默认访问权限详解》：本文主要介绍Java访问修饰符public、private、protected及默认访问权限的相关资料,每... 目录前言1. public 访问修饰符特点：示例：适用场景：2. private 访问修饰符特点：示例：
阅读更多...
数据库oracle用户密码过期查询及解决方案

数据库oracle用户密码过期查询及解决方案

《数据库oracle用户密码过期查询及解决方案》：本文主要介绍如何处理ORACLE数据库用户密码过期和修改密码期限的问题,包括创建用户、赋予权限、修改密码、解锁用户和设置密码期限,文中通过代码介绍... 目录前言一、创建用户、赋予权限、修改密码、解锁用户和设置期限二、查询用户密码期限和过期后的修改1.查询用
阅读更多...
详解Java如何向http/https接口发出请求

详解Java如何向http/https接口发出请求

《详解Java如何向http/https接口发出请求》这篇文章主要为大家详细介绍了Java如何实现向http/https接口发出请求,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 用Java发送web请求所用到的包都在java.net下，在具体使用时可以用如下代码，你可以把它封装成一
阅读更多...
mysql数据库分区的使用

mysql数据库分区的使用

《mysql数据库分区的使用》MySQL分区技术通过将大表分割成多个较小片段,提高查询性能、管理效率和数据存储效率,本文就来介绍一下mysql数据库分区的使用,感兴趣的可以了解一下... 目录【一】分区的基本概念【1】物理存储与逻辑分割【2】查询性能提升【3】数据管理与维护【4】扩展性与并行处理【二】分区的
阅读更多...
使用Python实现在Word中添加或删除超链接

使用Python实现在Word中添加或删除超链接

《使用Python实现在Word中添加或删除超链接》在Word文档中,超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能,本文将为大家介绍一下Python如何实现在Word中添加或... 在Word文档中，超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能。通过添加超
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2