mirror of
https://gitee.com/dromara/RuoYi-Vue-Plus.git
synced 2026-09-20 18:15:56 +08:00
add 新增注解 @ApiEncrypt 用于校验接口加解密 ;
update 更新 ApiDecryptProperties 简化参数, 去掉开关 ; update 更新 DecryptRequestBodyWrapper 简化参数 ; refactor 重构 CryptoFilter#doFilter 增加注解相关逻辑 ;
This commit is contained in:
parent
00710e0d24
commit
bcdb83ebe4
@ -16,6 +16,7 @@ import org.dromara.common.core.domain.model.LoginBody;
|
|||||||
import org.dromara.common.core.domain.model.RegisterBody;
|
import org.dromara.common.core.domain.model.RegisterBody;
|
||||||
import org.dromara.common.core.domain.model.SocialLoginBody;
|
import org.dromara.common.core.domain.model.SocialLoginBody;
|
||||||
import org.dromara.common.core.utils.*;
|
import org.dromara.common.core.utils.*;
|
||||||
|
import org.dromara.common.encrypt.annotation.ApiEncrypt;
|
||||||
import org.dromara.common.json.utils.JsonUtils;
|
import org.dromara.common.json.utils.JsonUtils;
|
||||||
import org.dromara.common.satoken.utils.LoginHelper;
|
import org.dromara.common.satoken.utils.LoginHelper;
|
||||||
import org.dromara.common.social.config.properties.SocialLoginConfigProperties;
|
import org.dromara.common.social.config.properties.SocialLoginConfigProperties;
|
||||||
@ -73,6 +74,7 @@ public class AuthController {
|
|||||||
* @param body 登录信息
|
* @param body 登录信息
|
||||||
* @return 结果
|
* @return 结果
|
||||||
*/
|
*/
|
||||||
|
@ApiEncrypt(response = false)
|
||||||
@PostMapping("/login")
|
@PostMapping("/login")
|
||||||
public R<LoginVo> login(@Validated @RequestBody String body) {
|
public R<LoginVo> login(@Validated @RequestBody String body) {
|
||||||
LoginBody loginBody = JsonUtils.parseObject(body, LoginBody.class);
|
LoginBody loginBody = JsonUtils.parseObject(body, LoginBody.class);
|
||||||
|
|||||||
@ -167,18 +167,14 @@ mybatis-encryptor:
|
|||||||
|
|
||||||
# api接口加密
|
# api接口加密
|
||||||
api-decrypt:
|
api-decrypt:
|
||||||
# 是否开启全局接口加密
|
|
||||||
enabled: true
|
|
||||||
# 是否开启响应加密 注:响应加密会有性能影响,默认关闭
|
|
||||||
responseEnabled: false
|
|
||||||
# AES 加密头标识
|
# AES 加密头标识
|
||||||
headerFlag: encrypt-key
|
headerFlag: encrypt-key
|
||||||
# 请求加密公私钥 非对称算法的公私钥 如:SM2,RSA 使用者请自行更换
|
# 响应加密公钥 非对称算法的公私钥 如:SM2,RSA 使用者请自行更换
|
||||||
publicKey: MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAKoR8mX0rGKLqzcWmOzbfj64K8ZIgOdHnzkXSOVOZbFu/TJhZ7rFAN+eaGkl3C4buccQd/EjEsj9ir7ijT7h96MCAwEAAQ==
|
# 对应前端解密私钥 MIIBVAIBADANBgkqhkiG9w0BAQEFAASCAT4wggE6AgEAAkEAmc3CuPiGL/LcIIm7zryCEIbl1SPzBkr75E2VMtxegyZ1lYRD+7TZGAPkvIsBcaMs6Nsy0L78n2qh+lIZMpLH8wIDAQABAkEAk82Mhz0tlv6IVCyIcw/s3f0E+WLmtPFyR9/WtV3Y5aaejUkU60JpX4m5xNR2VaqOLTZAYjW8Wy0aXr3zYIhhQQIhAMfqR9oFdYw1J9SsNc+CrhugAvKTi0+BF6VoL6psWhvbAiEAxPPNTmrkmrXwdm/pQQu3UOQmc2vCZ5tiKpW10CgJi8kCIFGkL6utxw93Ncj4exE/gPLvKcT+1Emnoox+O9kRXss5AiAMtYLJDaLEzPrAWcZeeSgSIzbL+ecokmFKSDDcRske6QIgSMkHedwND1olF8vlKsJUGK3BcdtM8w4Xq7BpSBwsloE=
|
||||||
|
publicKey: MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJnNwrj4hi/y3CCJu868ghCG5dUj8wZK++RNlTLcXoMmdZWEQ/u02RgD5LyLAXGjLOjbMtC+/J9qofpSGTKSx/MCAwEAAQ==
|
||||||
|
# 请求解密私钥 非对称算法的公私钥 如:SM2,RSA 使用者请自行更换
|
||||||
|
# 对应前端加密公钥 MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAKoR8mX0rGKLqzcWmOzbfj64K8ZIgOdHnzkXSOVOZbFu/TJhZ7rFAN+eaGkl3C4buccQd/EjEsj9ir7ijT7h96MCAwEAAQ==
|
||||||
privateKey: MIIBVAIBADANBgkqhkiG9w0BAQEFAASCAT4wggE6AgEAAkEAqhHyZfSsYourNxaY7Nt+PrgrxkiA50efORdI5U5lsW79MmFnusUA355oaSXcLhu5xxB38SMSyP2KvuKNPuH3owIDAQABAkAfoiLyL+Z4lf4Myxk6xUDgLaWGximj20CUf+5BKKnlrK+Ed8gAkM0HqoTt2UZwA5E2MzS4EI2gjfQhz5X28uqxAiEA3wNFxfrCZlSZHb0gn2zDpWowcSxQAgiCstxGUoOqlW8CIQDDOerGKH5OmCJ4Z21v+F25WaHYPxCFMvwxpcw99EcvDQIgIdhDTIqD2jfYjPTY8Jj3EDGPbH2HHuffvflECt3Ek60CIQCFRlCkHpi7hthhYhovyloRYsM+IS9h/0BzlEAuO0ktMQIgSPT3aFAgJYwKpqRYKlLDVcflZFCKY7u3UP8iWi1Qw0Y=
|
privateKey: MIIBVAIBADANBgkqhkiG9w0BAQEFAASCAT4wggE6AgEAAkEAqhHyZfSsYourNxaY7Nt+PrgrxkiA50efORdI5U5lsW79MmFnusUA355oaSXcLhu5xxB38SMSyP2KvuKNPuH3owIDAQABAkAfoiLyL+Z4lf4Myxk6xUDgLaWGximj20CUf+5BKKnlrK+Ed8gAkM0HqoTt2UZwA5E2MzS4EI2gjfQhz5X28uqxAiEA3wNFxfrCZlSZHb0gn2zDpWowcSxQAgiCstxGUoOqlW8CIQDDOerGKH5OmCJ4Z21v+F25WaHYPxCFMvwxpcw99EcvDQIgIdhDTIqD2jfYjPTY8Jj3EDGPbH2HHuffvflECt3Ek60CIQCFRlCkHpi7hthhYhovyloRYsM+IS9h/0BzlEAuO0ktMQIgSPT3aFAgJYwKpqRYKlLDVcflZFCKY7u3UP8iWi1Qw0Y=
|
||||||
# 响应加密公私钥 非对称算法的公私钥 如:SM2,RSA 使用者请自行更换
|
|
||||||
responsePublicKey: MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJnNwrj4hi/y3CCJu868ghCG5dUj8wZK++RNlTLcXoMmdZWEQ/u02RgD5LyLAXGjLOjbMtC+/J9qofpSGTKSx/MCAwEAAQ==
|
|
||||||
responsePrivateKey: MIIBVAIBADANBgkqhkiG9w0BAQEFAASCAT4wggE6AgEAAkEAmc3CuPiGL/LcIIm7zryCEIbl1SPzBkr75E2VMtxegyZ1lYRD+7TZGAPkvIsBcaMs6Nsy0L78n2qh+lIZMpLH8wIDAQABAkEAk82Mhz0tlv6IVCyIcw/s3f0E+WLmtPFyR9/WtV3Y5aaejUkU60JpX4m5xNR2VaqOLTZAYjW8Wy0aXr3zYIhhQQIhAMfqR9oFdYw1J9SsNc+CrhugAvKTi0+BF6VoL6psWhvbAiEAxPPNTmrkmrXwdm/pQQu3UOQmc2vCZ5tiKpW10CgJi8kCIFGkL6utxw93Ncj4exE/gPLvKcT+1Emnoox+O9kRXss5AiAMtYLJDaLEzPrAWcZeeSgSIzbL+ecokmFKSDDcRske6QIgSMkHedwND1olF8vlKsJUGK3BcdtM8w4Xq7BpSBwsloE=
|
|
||||||
|
|
||||||
springdoc:
|
springdoc:
|
||||||
api-docs:
|
api-docs:
|
||||||
|
|||||||
@ -0,0 +1,20 @@
|
|||||||
|
package org.dromara.common.encrypt.annotation;
|
||||||
|
|
||||||
|
import java.lang.annotation.*;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 强制加密注解
|
||||||
|
*
|
||||||
|
* @author Michelle.Chung
|
||||||
|
*/
|
||||||
|
@Documented
|
||||||
|
@Target({ElementType.METHOD})
|
||||||
|
@Retention(RetentionPolicy.RUNTIME)
|
||||||
|
public @interface ApiEncrypt {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 响应加密忽略,默认加密,为 false 时不加密
|
||||||
|
*/
|
||||||
|
boolean response() default true;
|
||||||
|
|
||||||
|
}
|
||||||
@ -16,7 +16,6 @@ import org.springframework.context.annotation.Bean;
|
|||||||
*/
|
*/
|
||||||
@AutoConfiguration
|
@AutoConfiguration
|
||||||
@EnableConfigurationProperties(ApiDecryptProperties.class)
|
@EnableConfigurationProperties(ApiDecryptProperties.class)
|
||||||
@ConditionalOnProperty(value = "api-decrypt.enabled", havingValue = "true")
|
|
||||||
public class ApiDecryptAutoConfiguration {
|
public class ApiDecryptAutoConfiguration {
|
||||||
|
|
||||||
@Bean
|
@Bean
|
||||||
|
|||||||
@ -4,10 +4,18 @@ import cn.hutool.core.util.ObjectUtil;
|
|||||||
import jakarta.servlet.*;
|
import jakarta.servlet.*;
|
||||||
import jakarta.servlet.http.HttpServletRequest;
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
import jakarta.servlet.http.HttpServletResponse;
|
import jakarta.servlet.http.HttpServletResponse;
|
||||||
|
import org.dromara.common.core.constant.HttpStatus;
|
||||||
|
import org.dromara.common.core.exception.ServiceException;
|
||||||
|
import org.dromara.common.core.utils.SpringUtils;
|
||||||
import org.dromara.common.core.utils.StringUtils;
|
import org.dromara.common.core.utils.StringUtils;
|
||||||
|
import org.dromara.common.encrypt.annotation.ApiEncrypt;
|
||||||
import org.dromara.common.encrypt.properties.ApiDecryptProperties;
|
import org.dromara.common.encrypt.properties.ApiDecryptProperties;
|
||||||
import org.springframework.http.HttpMethod;
|
import org.springframework.http.HttpMethod;
|
||||||
import org.springframework.http.MediaType;
|
import org.springframework.http.MediaType;
|
||||||
|
import org.springframework.web.method.HandlerMethod;
|
||||||
|
import org.springframework.web.servlet.HandlerExceptionResolver;
|
||||||
|
import org.springframework.web.servlet.HandlerExecutionChain;
|
||||||
|
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
|
||||||
@ -26,20 +34,33 @@ public class CryptoFilter implements Filter {
|
|||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
|
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
|
||||||
boolean encryptFlag = properties.getResponseEnabled();
|
HttpServletRequest servletRequest = (HttpServletRequest) request;
|
||||||
|
HttpServletResponse servletResponse = (HttpServletResponse) response;
|
||||||
|
|
||||||
|
boolean encryptFlag = false;
|
||||||
ServletRequest requestWrapper = null;
|
ServletRequest requestWrapper = null;
|
||||||
ServletResponse responseWrapper = null;
|
ServletResponse responseWrapper = null;
|
||||||
EncryptResponseBodyWrapper responseBodyWrapper = null;
|
EncryptResponseBodyWrapper responseBodyWrapper = null;
|
||||||
HttpServletRequest servletRequest = (HttpServletRequest) request;
|
|
||||||
HttpServletResponse servletResponse = (HttpServletResponse) response;
|
|
||||||
// 是否为 json 请求
|
// 是否为 json 请求
|
||||||
if (StringUtils.startsWithIgnoreCase(request.getContentType(), MediaType.APPLICATION_JSON_VALUE)) {
|
if (StringUtils.startsWithIgnoreCase(request.getContentType(), MediaType.APPLICATION_JSON_VALUE)) {
|
||||||
// 是否为 put 或者 post 请求
|
// 是否为 put 或者 post 请求
|
||||||
if (HttpMethod.PUT.matches(servletRequest.getMethod()) || HttpMethod.POST.matches(servletRequest.getMethod())) {
|
if (HttpMethod.PUT.matches(servletRequest.getMethod()) || HttpMethod.POST.matches(servletRequest.getMethod())) {
|
||||||
|
// 获取加密注解
|
||||||
|
ApiEncrypt apiEncrypt = this.getApiEncryptAnnotation(servletRequest);
|
||||||
|
encryptFlag = apiEncrypt.response();
|
||||||
// 是否存在加密标头
|
// 是否存在加密标头
|
||||||
String headerValue = servletRequest.getHeader(properties.getHeaderFlag());
|
String headerValue = servletRequest.getHeader(properties.getHeaderFlag());
|
||||||
if (StringUtils.isNotBlank(headerValue)) {
|
if (StringUtils.isNotBlank(headerValue)) {
|
||||||
requestWrapper = new DecryptRequestBodyWrapper(servletRequest, properties.getPublicKey(), properties.getPrivateKey(), properties.getHeaderFlag());
|
requestWrapper = new DecryptRequestBodyWrapper(servletRequest, properties.getPrivateKey(), properties.getHeaderFlag());
|
||||||
|
} else {
|
||||||
|
// 是否有注解,有就报错,没有放行
|
||||||
|
if (ObjectUtil.isNotNull(apiEncrypt)) {
|
||||||
|
HandlerExceptionResolver exceptionResolver = SpringUtils.getBean("handlerExceptionResolver");
|
||||||
|
exceptionResolver.resolveException(
|
||||||
|
servletRequest, servletResponse, null,
|
||||||
|
new ServiceException("没有访问权限,请联系管理员授权", HttpStatus.FORBIDDEN));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
// 判断是否响应加密
|
// 判断是否响应加密
|
||||||
if (encryptFlag) {
|
if (encryptFlag) {
|
||||||
@ -57,12 +78,36 @@ public class CryptoFilter implements Filter {
|
|||||||
servletResponse.reset();
|
servletResponse.reset();
|
||||||
// 对原始内容加密
|
// 对原始内容加密
|
||||||
String encryptContent = responseBodyWrapper.getEncryptContent(
|
String encryptContent = responseBodyWrapper.getEncryptContent(
|
||||||
servletResponse, properties.getResponsePublicKey(), properties.getHeaderFlag());
|
servletResponse, properties.getPublicKey(), properties.getHeaderFlag());
|
||||||
// 对加密后的内容写出
|
// 对加密后的内容写出
|
||||||
servletResponse.getWriter().write(encryptContent);
|
servletResponse.getWriter().write(encryptContent);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取 ApiEncrypt 注解
|
||||||
|
*/
|
||||||
|
private ApiEncrypt getApiEncryptAnnotation(HttpServletRequest servletRequest) {
|
||||||
|
RequestMappingHandlerMapping handlerMapping = SpringUtils.getBean("requestMappingHandlerMapping", RequestMappingHandlerMapping.class);
|
||||||
|
// 获取注解
|
||||||
|
try {
|
||||||
|
HandlerExecutionChain mappingHandler = handlerMapping.getHandler(servletRequest);
|
||||||
|
System.out.println(mappingHandler);
|
||||||
|
if (ObjectUtil.isNotNull(mappingHandler)) {
|
||||||
|
Object handler = mappingHandler.getHandler();
|
||||||
|
if (ObjectUtil.isNotNull(handler)) {
|
||||||
|
// 从handler获取注解
|
||||||
|
if (handler instanceof HandlerMethod handlerMethod) {
|
||||||
|
return handlerMethod.getMethodAnnotation(ApiEncrypt.class);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (Exception e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void destroy() {
|
public void destroy() {
|
||||||
}
|
}
|
||||||
|
|||||||
@ -24,7 +24,7 @@ public class DecryptRequestBodyWrapper extends HttpServletRequestWrapper {
|
|||||||
|
|
||||||
private final byte[] body;
|
private final byte[] body;
|
||||||
|
|
||||||
public DecryptRequestBodyWrapper(HttpServletRequest request, String publicKey, String privateKey, String headerFlag) throws IOException {
|
public DecryptRequestBodyWrapper(HttpServletRequest request, String privateKey, String headerFlag) throws IOException {
|
||||||
super(request);
|
super(request);
|
||||||
// 获取 AES 密码 采用 RSA 加密
|
// 获取 AES 密码 采用 RSA 加密
|
||||||
String headerRsa = request.getHeader(headerFlag);
|
String headerRsa = request.getHeader(headerFlag);
|
||||||
|
|||||||
@ -11,39 +11,19 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
|
|||||||
@ConfigurationProperties(prefix = "api-decrypt")
|
@ConfigurationProperties(prefix = "api-decrypt")
|
||||||
public class ApiDecryptProperties {
|
public class ApiDecryptProperties {
|
||||||
|
|
||||||
/**
|
|
||||||
* 加密开关
|
|
||||||
*/
|
|
||||||
private Boolean enabled;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 响应加密开关
|
|
||||||
*/
|
|
||||||
private Boolean responseEnabled;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 头部标识
|
* 头部标识
|
||||||
*/
|
*/
|
||||||
private String headerFlag;
|
private String headerFlag;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 请求加密公钥
|
* 响应加密公钥
|
||||||
*/
|
*/
|
||||||
private String publicKey;
|
private String publicKey;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 请求加密私钥
|
* 请求解密私钥
|
||||||
*/
|
*/
|
||||||
private String privateKey;
|
private String privateKey;
|
||||||
|
|
||||||
/**
|
|
||||||
* 响应加密公钥
|
|
||||||
*/
|
|
||||||
private String responsePublicKey;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 响应加密私钥
|
|
||||||
*/
|
|
||||||
private String responsePrivateKey;
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user