spring boot 接口参数解密和返回值加密

已于 2024-07-22 15:56:23 修改
阅读量781 收藏 26
点赞数 20
分类专栏： Java 文章标签： spring boot java 密码学
于 2024-07-05 15:43:46 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_48922459/article/details/140206596
版权

spring boot 接口参数解密和返回值加密

开发背景

  • 虽然使用 HTTPS 已经可以基本保证传输数据的安全性，但是很多国企、医疗、股票项目等仍然要求对接口数据进行自行加密，作者最近就遇到了，是支付宝对接国家医保的接口时，医保接口要求进行接口加密。

  • 所以鉴于这个需求的存在，作者也找过现在的一些接口加密组件，发现都是3.4年前就已经停止更新了，并且不接受 pr 也不回复 issue 了，用起来也是功能简陋配置复杂，所以就开发了一套全新的组件。

  • 作者对接口加密的各种需求了解的并不是很多，如果在使用中有功能缺失，欢迎来 Github 提 issue 或者 pr ❤️。

简介

  • SecureApi 是一款接口参数和返回值加解密工具，高性能、轻量化，无任何外部依赖；

  • spring boot 场景启动器设计（支持spring boot2和3），完全自动化，支持 param、body 参数（暂不支持 path 参数），用户无需关心加密解密和密钥匹配过程；

  • 配置灵活，配置文件支持 yml 和 bean 方式，支持注解、url 正则进行接口匹配，支持 AES、SM4、RSA 等多种加密方式，支持 DH 前后端密钥协商方式。

用户增量趋势

此组件发布已经一两年了，发现有那么多用户，才重新整理了命名、仓库和文档

在这里插入图片描述

本篇只是先体验功能，使用请看官方文档： https://doc.xuyijie.icu/secure-api-doc/

Github地址： https://github.com/BubblingXuYijie/secure-api-spring-boot

Gitee地址(非主要，issue还是集中在Github比较好，大家都可以看到) https://gitee.com/BubblingXuYijie/secure-api-spring-boot

一些问题你们会在文档中或者Github的 issue 里找到答案，如果你不知道前端如何配合，那么文档里有你想要的东西

安装

环境要求：

  • jdk8+（spring boot 3 请使用 jdk17+）
  • Maven/Gradle
  • spring boot 2+（spring boot 3 请引入 SecureApi 的 3.0.0+ 版本）

Maven

<!-- https://mvnrepository.com/artifact/icu.xuyijie/secure-api-spring-boot-starter -->
<dependency>
    <groupId>icu.xuyijie</groupId>
    <artifactId>secure-api-spring-boot-starter</artifactId>
    <!--spring boot 3 请引入 3.0.6 版本-->
    <version>2.1.3</version>
</dependency>

Gradle

// spring boot 3 请引入 3.0.6 版本
implementation 'icu.xuyijie:secure-api-spring-boot-starter:2.1.3'

配置

有两种配置方法， yml 和 Bean 方式，看你喜欢哪一个，如果是对安全性要求较高，建议使用 Bean 方式动态设置密钥，而不是写在 yml 里。

yml 方式

下面是 yml 的完整配置，有些配置项是可选的，在注解中均已解释

secure-api:
  # 开启SecureApi功能，如果为false则其余配置项均不生效
  enabled: true
  # 生成的key和密文等是否是符合url规范的，默认开启，开启后与前端配合时前端要自行处理密文的 url safe 转换，在 "JS示例" 篇有代码示例
  url-safe: true
  # 开启加解密日志打印，会打印出接口名、加密模式、算法、明文和密文等信息
  show-log: true
  # 加密模式，common和session_key可选，session_key是会话密钥模式，用于每次请求都使用不同的密钥，需要前端配合
  mode: common
  # 加密算法
  cipher-algorithm: rsa_ecb_sha256
  # session_key模式配置项，与前端协商的会话密钥类型，common模式下此配置不生效
  session-key-cipher-algorithm: aes_ecb_pkcs5
  # 对称算法用于加解密的密钥，Base64格式，cipher-algorithm选择对称加密算法时配置，也可为空，组件会随机生成一个
  key:
  # 对称算法用于加解密的偏移量，Base64格式，cipher-algorithm选择对称加密算法时配置，也可为空，组件会随机生成一个
  iv:
  # 非对称算法用于加密的公钥，Base64格式，cipher-algorithm选择非对称加密算法时配置，也可为空，组件会随机生成一对
  public-key:
  # 非对称算法用于解密的私钥，Base64格式，cipher-algorithm选择非对称加密算法时配置，也可为空，组件会随机生成一对
  private-key:
  # 需要加密的接口路径匹配，遵循spring boot拦截器的正则规则，留空或者不配置代表不使用url匹配，只对注解的接口进行解密
  encrypt-url:
    # 配置了此项，接口有无注解都将进行返回值加密
    include-urls: /**
    # 即使配置了排除，注解的优先级也高于此项
    exclude-urls:
  # 需要解密的接口路径匹配，遵循spring boot拦截器的正则规则，留空或者不配置代表不使用url匹配，只对注解的接口、参数、字段进行解密
  decrypt-url:
    # 配置了此项，接口、参数、字段有无注解都将进行解密
    include-urls: /**
    # 即使配置了排除，注解的优先级也高于此项
    exclude-urls:

Bean 方式

注意，一旦使用了 Bean 方式来配置，yml 里的配置项都将失效

import icu.xuyijie.secureapi.cipher.CipherAlgorithmEnum;
import icu.xuyijie.secureapi.cipher.CipherUtils;
import icu.xuyijie.secureapi.cipher.RsaKeyPair;
import icu.xuyijie.secureapi.model.SecureApiProperties;
import icu.xuyijie.secureapi.model.SecureApiPropertiesConfig;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.context.annotation.Bean;

import java.util.ArrayList;
import java.util.Arrays;

@SpringBootConfiguration
public class SecureApiConfig {
    /**
     * 这里的配置了Bean会导致yml配置的数据失效
     * @return SecureApiPropertiesConfig
     */
    @Bean
    public SecureApiPropertiesConfig secureApiPropertiesConfig() {
        SecureApiPropertiesConfig secureApiPropertiesConfig = new SecureApiPropertiesConfig();
        secureApiPropertiesConfig.setEnabled(true);
        // 生成的key和密文是符合url规范的，默认开启，开启后与前端配合时前端要自行处理密文的 url safe 转换，在 "JS示例" 篇有代码示例
        secureApiPropertiesConfig.setUrlSafe(true);
        secureApiPropertiesConfig.setShowLog(true);
        secureApiPropertiesConfig.setMode(SecureApiProperties.Mode.COMMON);
        secureApiPropertiesConfig.setCipherAlgorithmEnum(CipherAlgorithmEnum.RSA_ECB_SHA256);
        
        // 密钥可以不设置，组件会自动生成一个，并打印在控制台，如果需要手动生成，只需要使用组件提供的CipherUtils
        CipherUtils cipherUtils = new CipherUtils(CipherAlgorithmEnum.RSA_ECB_SHA256);
        // 因为我们选择的是非对称加密RSA，所以生成一个密钥对，getRandomRsaKeyPair("1")可传入seed参数，在测试时可用于控制每次生成的密钥相同
        RsaKeyPair randomRsaKeyPair = cipherUtils.getRandomRsaKeyPair();
        // 把生成的密钥对设置到secureApiPropertiesConfig
        secureApiPropertiesConfig.setPublicKey(randomRsaKeyPair.getPublicKey());
        secureApiPropertiesConfig.setPrivateKey(randomRsaKeyPair.getPrivateKey());
        
        // 不需要使用url匹配功能可以删除掉下面两行，或者传入空数组
        // secureApiPropertiesConfig.setEncryptUrl(new SecureApiProperties.UrlPattern(Arrays.asList("/**"), new ArrayList<>()));
        // secureApiPropertiesConfig.setDecryptUrl(new SecureApiProperties.UrlPattern(Arrays.asList("/**"), Arrays.asList("/secureApiTest/testForm")));
        return secureApiPropertiesConfig;
    }
}

试一下

好了各位大佬们，到了这里，配置以及完成，接下来可以进行效果体验了，后面有时间会提供前后端的 demo。

本篇只是先体验功能，请务必和我的代码相同，不然也许你会遇到一些问题，代码里使用的注解等看文档会介绍，可以解决你的疑惑。

启动项目

SecureApi的 enable 设置为 true 时，控制台会打印以下信息，代表开启接口加解密功能，我这里没有指定 key ，所以组件为我自动生成了，然后你可以把密钥设置到前端或者和前端进行密钥协商以追求更安全的传输。

建议测试的时候使用 CipherUtils 手动设置密钥，可以指定 seed 保证每次生成的密钥相同，更加方便。

在这里插入图片描述

返回值加密

前面我们没有配置url匹配，需要在接口上或者接口所在类上添加 @EncryptApi 注解，即可实现返回值加密

在这里插入图片描述

可以看到由于我开启了日志打印功能，控制台打印出一些信息

在这里插入图片描述

接口返回的是一个 json 字符串，然后前端使用对应密钥解密这个字符串（注意这是个json字符串，前端处理时应该去除前后两端引号）就可以拿到 {"code":200,"message":"哈哈哈","data":null} 这样的对象了

在这里插入图片描述

参数解密

body 参数解密

组件可以对json参数体进行解密，这次我们传入上一步中加密的返回值，看一看解密结果，接口需要添加 @DecryptApi 注解，这样这个接口既会解密参数，也会加密返回值

在这里插入图片描述

使用 Postman 发送密文body参数

在这里插入图片描述

可以看到密文参数正常解密为 {"code":200,"message":"哈哈哈","data":null},返回值也成功加密了

在这里插入图片描述

param和form-data参数解密

这一次我们整复杂一点，各种类型的参数都整上，没有开启url匹配，我们要给字段加上 @DecryptParam 注解，注意 @DecryptParam 不能和 @RequestParam 同时使用，@DecryptParam 已经替代了后者功能。

在这里插入图片描述

实体类本身不需要加注解，要加在里面的字段上，注意，没有加注解的字段不会解密（配置了url匹配的话，加不加注解全部字段都会解密）

在这里插入图片描述

发送请求，请求中这些密文都是我提前用代码生成好的（注意，param里的密文要是url safe的），这些参数放在 param 里或者放在 form-data 里发送都是可以的

在这里插入图片描述

成功解密加了注解的参数，没有加注解和为null的参数不解密

在这里插入图片描述

总结

本篇只是先体验功能，使用请看官方文档： https://doc.xuyijie.icu/secure-api-doc/

Github地址： https://github.com/BubblingXuYijie/secure-api-spring-boot

Gitee地址(非主要，issue还是集中在Github比较好，大家都可以看到) https://gitee.com/BubblingXuYijie/secure-api-spring-boot

一些问题你们会在文档中或者Github的 issue 里找到答案，如果你不知道前端如何配合，那么文档里有你想要的东西

繁华尽头满是殇
关注
  • 20
    点赞
  • 踩
  • 26
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
SpringBoot控制器统一的响应体加密与请求体解密的注解处理方式
08-08
SpringBoot控制器统一的响应体加密与请求体解密的注解处理方式，支持MD5/SHA/AES/DES/RSA
SpringBoot实现接口数据的加解密功能
08-25
主要介绍了SpringBoot实现接口数据的加解密功能,对接口的加密解密操作主要有两种实现方式，文中给大家详细介绍，需要的朋友可以参考下
SpringBoot请求参数加密、响应参数解密
爱笑的boy的博客
01-08 2303
SpringBoot请求参数加密、响应参数解密
一个注解实现SpringBoot接口请求数据和返回数据加密，提高系统安全性！
最新发布
陆漫漫的博客
05-09 1024
起因是公司给人开发的内网系统登录接口采用明文传输，本来用着没啥问题(其实不太好！)，毕竟只是内网使用。后面需要外网访问，需要提高安全等级，禁止密码明文传输。于是就有了这篇文章。本文采用：对称加密
SpringBoot参数加解密
闲余知道
03-11 1949
有时候，为了接口安全，防止接口数据被拦截抓取，我们需要对请求，响应参数进行加密。接口org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdvice能对请求参数进行前置处理，而org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice对响应结果数据进行后置处理。因此这两个接口能很好的植入我们的加解密代码段，统一进行全局操作，避免重复编码
Spring Boot 在request里解密参数返回
如漩涡的博客
11-29 1253
Spring Boot 在request里解密返回参数到控制器 前言 有个业务需求，一个请求来源web，一个请求来源APP，web需求验证签名，APP的参数是经过加密，所以出现了两个Controller，除了解密获取参数方式不一样，其他内容一模一样，这样不太合理，所以我决定重构。 思路：既然只是解密不一样，获取到的参数是一样的，那可以写一个过滤器，在里面就把参数解密好，然后返回 Spring Bo...
【技术】SpringBoot 接口怎么加密解密
hymuuuu的博客
01-23 1382
在我们日常的Java开发中，免不了和其他系统的业务交互，或者微服务之间的接口调用如果我们想保证数据传输的安全，对接口出参加密，入参解密。但是不想写重复代码，我们可以提供一个通用starter，提供通用加密解密功能自定义starter步骤创建工厂，编写功能代码声明自动配置类，把需要对外提供的对象创建好，通过配置类统一向外暴露在resource目录下准备一个名为的文件，以为key，自动配置类为value列表，进行注册。
spring boot 下对JSON返回值去除null和空字段操作
10-14
本篇将详细介绍如何在Spring Boot中去除JSON返回值中的`null`和空字段。 首先，Spring Boot默认使用的JSON库是Jackson，它提供了强大的JSON序列化和反序列化功能。为了去除JSON中的`null`值和空字符串，我们可以...
Spring Boot 捕捉全局异常 统一返回值的问题
08-19
Spring Boot 捕捉全局异常统一返回值 在 Spring Boot 框架中，捕捉全局异常并统一返回值是一个非常重要的概念。本文将通过实例代码详细介绍如何在 Spring Boot 中捕捉全局异常，并统一返回值，从而使开发者能够更好...
Spring Boot实现通用的接口参数校验
08-27
本文介绍了基于 Spring Boot 和 JDK8 编写的一个 AOP，以实现通用的接口参数校验。通过自定义注解实现了参数校验，解决了实体类上添加注解的限制，实现了方法级别的参数校验。 知识点： 1. Spring Boot 实现 AOP ...
SpringBoot接口加密解密统一处理
08-25
主要为大家详细介绍了SpringBoot接口加密解密统一处理，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Spring MVC请求参数与响应结果全局加密和解密详解
08-27
在本文中，我们将详细介绍Spring MVC请求参数与响应结果全局加密和解密的相关知识点，包括请求参数的加密和解密、响应结果的加密和解密、ContentType的处理等。 首先，让我们了解一下请求参数的加密和解密。为了...
SpringBoot 实现接口参数加密解密功能
迪曼奥特迦-博客
03-09 2477
加密解密本身并不是难事，问题是在何时去处理？定义一个过滤器，将请求和响应分别拦截下来进行处理也是一个办法，这种方式虽然粗暴，但是灵活，因为可以拿到一手的请求参数和响应数据。不过 SpringMVC 中给我们提供了 ResponseBodyAdvice 和 RequestBodyAdvice，利用这两个工具可以对请求和响应进行预处理，非常方便。 所以今天这篇文章有两个目的： 分享参数/响应加解密的思路。 分享 ResponseBodyAdvice 和 RequestBodyAdvice 的用
接口返回数据加密的情况下，如何解密
Superxpang的博客
01-03 702
接口返回数据加密，看到数据的方法： ①网络中找到对应接口CopyascURL(bash) ②将copy内容中的x-aes-key删除掉 ③打开GitBash将内容粘贴运行就会显示解密的接口数据
Java实现http接口参数和返回值加密
站在墙头上的博客
12-05 9640
Java实现接口参数和返回值加解密
springboot使用自定义注解实现接口返回结果加密
qq_42558564的博客
06-29 1119
1、编写自定义注解 2、 AES加密工具类 3、 实现ResponseBodyAdvice接口 4、 测试 1、在类上或者方法上添加@Encrypt注解 2、使用测试工具进行测试 result就是经过加密的结果
接口入参与返回数据AES加解密
一个有信仰的技术人
04-07 1515
前言 出于项目安全方面的考虑，对接口的入参和返回数据进行加解密，综合考虑效率和安全性总重采用AES的对称加密方式（前后台数据传输时采用base64编码否则会出现乱码现象）废话不多说 直接上代码 请求的拦截器类 注意这里面的AesRequestWrapper类，这个类重写获取流的方法 因为request中的流只能被读取一次，在解密的时候被你读取的话再往应用层传就会报错 import org.springframework.stereotype.Component; import javax.ser.
springboot处理数据解密
shanliang
04-01 2728
spring数据加解密方法问题描述解决方案通过注解实现思路demo 实现定义注解定义请求 model定义controller定义 Aspect请求测试缺陷无age参数请求全参请求通过过滤器和拦截器实现前置条件思路demo 实现filter定义interceptor定义request wrapper解密配置测试传全参少传age字段结论参考心得 问题描述 原有前端数据传输是通过明文传输的，现处于安全性考虑，需要对敏感信息加密(将加密后的数据存储到一个新的加密字段，后端通过解密这个字段获取数据) 解决方案 通过注
java spring boot jasypt 加密 解密
05-19
Java Spring Boot可以使用Jasypt库进行加密和解密。Jasypt是一个Java库，它提供了基于密码学的加密和解密功能，可用于保护敏感数据，如数据库密码、API密钥等。 以下是使用Jasypt进行加密和解密的步骤： 1. 添加Jasypt依赖 在pom.xml文件中添加以下依赖： ``` <dependency> <groupId>com.github.ulisesbocchio</groupId> <artifactId>jasypt-spring-boot-starter</artifactId> <version>3.0.3</version> </dependency> ``` 2. 配置加密密钥 在application.properties或application.yml文件中添加以下配置： ``` jasypt.encryptor.password=your_secret_key ``` your_secret_key是你的加密密钥，它将用于加密和解密数据。 3. 加密数据 使用Jasypt的Encryptor类可以加密数据。可以在代码中注入Encryptor类或使用jasypt.encryptor.bean属性自动装配它。以下是一个示例： ``` @Autowired private Encryptor encryptor; public String encrypt(String data) { return encryptor.encrypt(data); } ``` encrypt()方法将接受要加密的数据并返回加密后的结果。 4. 解密数据 同样，使用Jasypt的Decryptor类可以解密数据。以下是一个示例： ``` @Autowired private Decryptor decryptor; public String decrypt(String encryptedData) { return decryptor.decrypt(encryptedData); } ``` decrypt()方法将接受要解密的数据并返回解密后的结果。 注意：加密和解密的密钥必须相同。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

繁华尽头满是殇

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值