如何用魔方网表做门户网站,网站子域名什么意思,小型网站用typescript,wordpress数据库填写spring boot 接口参数解密和返回值加密 开发背景简介安装配置yml 方式Bean 方式 试一下启动项目返回值加密参数解密body 参数解密param和form-data参数解密 总结 开发背景 虽然使用 HTTPS 已经可以基本保证传输数据的安全性#xff0c;但是很多国企、医疗、股票项目等仍然要求… spring boot 接口参数解密和返回值加密 开发背景简介安装配置yml 方式Bean 方式 试一下启动项目返回值加密参数解密body 参数解密param和form-data参数解密 总结 开发背景 虽然使用 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里找到答案如果你不知道前端如何配合那么文档里有你想要的东西 安装 环境要求 jdk8spring boot 3 请使用 jdk17Maven/Gradlespring boot 2spring boot 3 请引入 SecureApi 的 3.0.0 版本 Maven
!-- https://mvnrepository.com/artifact/icu.xuyijie/secure-api-spring-boot-starter --
dependencygroupIdicu.xuyijie/groupIdartifactIdsecure-api-spring-boot-starter/artifactId!--spring boot 3 请引入 3.0.2 版本--version2.0.9/version
/dependencyGradle
// spring boot 3 请引入 3.0.2 版本
implementation icu.xuyijie:secure-api-spring-boot-starter:2.0.9配置 有两种配置方法 yml 和 Bean 方式看你喜欢哪一个如果是对安全性要求较高建议使用 Bean 方式动态设置密钥而不是写在 yml 里。 yml 方式 下面是 yml 的完整配置有些配置项是可选的在注解中均已解释 secure-api:# 开启SecureApi功能如果为false则其余配置项均不生效enabled: true# 生成的key和密文等是否是符合url规范的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# 对称算法用于加解密的密钥cipher-algorithm选择对称加密算法时配置也可为空组件会随机生成一个key:# 对称算法用于加解密的偏移量cipher-algorithm选择对称加密算法时配置也可为空组件会随机生成一个iv:# 非对称算法用于加密的公钥cipher-algorithm选择非对称加密算法时配置也可为空组件会随机生成一对public-key:# 非对称算法用于解密的私钥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*/Beanpublic SecureApiPropertiesConfig secureApiPropertiesConfig() {SecureApiPropertiesConfig secureApiPropertiesConfig new SecureApiPropertiesConfig();secureApiPropertiesConfig.setEnabled(true);secureApiPropertiesConfig.setUrlSafe(true);secureApiPropertiesConfig.setShowLog(true);secureApiPropertiesConfig.setMode(SecureApiProperties.Mode.COMMON);secureApiPropertiesConfig.setCipherAlgorithmEnum(CipherAlgorithmEnum.RSA_ECB_SHA256);// 密钥可以不设置组件会自动生成一个并打印在控制台如果需要手动生成只需要使用组件提供的CipherUtilsCipherUtils cipherUtils new CipherUtils(CipherAlgorithmEnum.RSA_ECB_SHA256);// 因为我们选择的是非对称加密RSA所以生成一个密钥对getRandomRsaKeyPair(1)可传入seed参数在测试时可用于控制每次生成的密钥相同RsaKeyPair randomRsaKeyPair cipherUtils.getRandomRsaKeyPair();// 把生成的密钥对设置到secureApiPropertiesConfigsecureApiPropertiesConfig.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里找到答案如果你不知道前端如何配合那么文档里有你想要的东西
