当前位置: 首页 > news >正文

做了个springboot接口参数解密的工具,我给它命名为万能钥匙(已上传maven中央仓库,附详细使用说明)

前言:之前工作中做过两个功能,就是之前写的这两篇博客,最近几天有个想法,给它做成一个springboot的start启动器,直接引入依赖,写好配置就能用了

springboot使用自定义注解实现接口参数解密,普通字段,json,集合

使用反射实现@RequestBody的参数校验功能

 现在,它来了。

项目地址:

gitee:https://gitee.com/vhukze/master-key 

github:https://github.com/vhukze/master-key

目录

介绍

软件架构

配置教程 

1.引入依赖

2.配置

3.注意事项

使用说明

不同传参方式示例

不同参数类型示例

 validation模块注解校验

最后


介绍

用来实现接口参数解密的工具,只需引入依赖,在配置文件写明加密的配置,在接口上使用指定注解即可实现该接口的参数解密。并支持使用validation模块的注解进行参数校验,支持分组校验功能

支持的对称加密方式:SM4,AES,DES,DESede 支持的非对称加密方式:RSA,SM2

软件架构

使用java8,springboot2.x.x,一个简单的springboot starter 启动器,功能中用到的工具类是hutool

配置教程 

1.引入依赖

        <dependency><groupId>io.github.vhukze</groupId><artifactId>master-key-spring-boot-starter</artifactId><version>目前最新版本</version></dependency>

2.配置

注册参数解析器

import com.vhukze.masterkey.master.DecodeResolver;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;import javax.annotation.Resource;
import java.util.List;/*** webmvc配置*/
@Configuration
public class MasterKeyConfig implements WebMvcConfigurer {@Resourceprivate DecodeResolver decodeResolver;/*** 注册自定义HandlerMethodArgumentResolver  接口参数解密*/@Overridepublic void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {resolvers.add(decodeResolver);}
}

对称加密配置示例(配置到application.yml中)

master-key:# 加密方式encode: SM4# 使用json格式参数时,解密之前json的key 不配置此参数则代表使用text格式参数,只传递加密后的字符串json-key: str# 加密模式mode: CBC# 填充方式padding: ISO10126Padding# 秘钥key: 1234123412ABCDEF# 盐值salt: ABCDEF1234123412

对称加密配置项的可配置值

加密方式(encode)加密模式(mode)填充方式(padding)
SM4NONENoPadding
AESCBCZeroPadding
DESCFBISO10126Padding
DESedeCTROAEPPadding
CTSPKCS1Padding
ECBPKCS5Padding
OFBSSL3Padding
PCBC

非对称加密配置示例 

master-key:# 加密方式encode: SM2# 使用json格式参数时,解密之前json的key 不配置此参数则代表使用text格式参数,只传递加密后的字符串json-key:# 公钥public-key: MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEDRhJQbkA5SKceAaJmtdOBiRzCqwei4WRzAkBrZ9SkBZhZ1zC4nteRLVi754MsI/8vsiNK2lV518E8RaNw+mnLA==# 私钥private-key: MIGTAgEAMBMGByqGSM49AgEGCCqBHM9VAYItBHkwdwIBAQ

3.注意事项

使用SM4和SM2国密加密算法时,需要引入国密加密的依赖 如下

        <dependency><groupId>org.bouncycastle</groupId><artifactId>bcprov-jdk15to18</artifactId><version>1.69</version></dependency>

使用说明

支持自定义实体类、基础数据类型及其包装类、集合类型、map类型。加密前参数格式跟正常请求接口时相同

不同传参方式示例

例如当前接口所需参数为:{"id":1,"count":4}

加密后为:c7dc378bf0c4da001466818765813a506b1a6b37e960b7ca

1.json格式传参

在配置文件配置好json-key,并使用配置的json-key构建json字符串,比如配置的json-key为str,json字符串如下

{"str":"c7dc378bf0c4da001466818765813a506b1a6b37e960b7ca"
}

 实际请求如下图

2.text格式传参

不配置json-key即为使用text格式传参

实际请求如下图

不同参数类型示例

使用text传参方式演示

接口使用@ParamsDecode注解,标明此接口需要参数解密,如下

@ParamsDecode
@PostMapping("decode")
public String decode(Stock stock){return "";
}

1.自定义实体类

接口参数的实体类

@Data
public class Stock {private Integer id;private Integer count;
}

加密前的请求参数: {"id":1,"count":4}

实际请求

 接口接收到的参数

2.基础数据类型或其包装类

接口参数为一个int类型

加密前的请求参数:5

实际请求

接口接收到的参数

3.集合类型

接口参数为List<Integer>集合

加密前的请求参数:[1,2,3]

实际请求

接口接收到的参数

 validation模块注解校验

实现了一些常用的注解,并支持分组校验功能,目前实现的注解有以下这些

数据类型注解
Integer、Long、Short@NotNull、@Max、@Min、@Null
String@NotNull、@NotBlank、@Size、@Null、@Pattern
集合类型@NotNull、@NotEmpty、@Size、@Null

具体使用方式跟正常使用一样,下面有个示例

@Data
public class Stock {@Max(3)@NotNull(groups = Edit.class)private Integer id;@NotBlank(groups = {Add.class, Edit.class})private String name;@Min(3)private Integer count;public interface Add {}public interface Edit {}
}
@ParamsDecode
@PostMapping("decode")
public String decode(@Validated(value = Add.class) Stock stock) {return "";
}

最后

目前就有这些功能,后面如果有需要的话,准备加入接口返回数据加密功能、Map类型参数的解密、不同接口使用不同解密方式等功能

http://www.lryc.cn/news/37087.html

相关文章:

  • 【Flutter从入门到入坑】Flutter 知识体系
  • 顺序表的基本操作
  • 设计模式——创建型模型——单列模式(8种实现)
  • 【软考中级】软件设计师笔记
  • 包教包会的ES6
  • python学习——【第四弹】
  • Web3中文|无聊猿Otherside元宇宙启动第二次旅行
  • SpringCloud-7_OpenFeign服务调用
  • 解决docker容器之间网络互通
  • 测试微服务:快速入门指南
  • MySQL Show Profile分析
  • 基于Docker快速搭建蜜罐Dionaea(30)
  • WP_Query 的所有参数及其讲解和实用案例
  • 100个网络运维工作者必须知道的小知识!(上)
  • Python如何获取大量电影影评,做可视化演示
  • 【C语言】详讲qsort库函数
  • SEO技术风口来了|SEO能否抓住全球约93%的网络用户?
  • mxnet版本与numpy,requests等都不兼容问题
  • 逆向分析——壳
  • 为 Argo CD 应用程序指定多个来源
  • verilog specify语法
  • CMake编译学习笔记
  • Day913.反向代理和网关是什么关系 -SpringBoot与K8s云原生微服务实践
  • IT行业就业趋势显示:二季度平均月薪超8千
  • 【毕业设计】基于Java的五子棋游戏的设计(源代码+论文)
  • C#:Krypton控件使用方法详解(第十四讲) ——kryptonSeparator
  • Java的jar包打包成exe应用
  • Latex学习笔记
  • 【c++复习】C++的基础知识(常用关键字、缺省参数、函数重载、引用)
  • Docker入门建议收藏 第二部分