cn.herodotus.engine.rest.protect.crypto.enhance.DecryptRequestParamMapResolver Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2020-2030 郑庚伟 ZHENGGENGWEI (码匠君), Licensed under the AGPL License
*
* This file is part of Herodotus Engine.
*
* Herodotus Engine is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Herodotus Engine is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*/
package cn.herodotus.engine.rest.protect.crypto.enhance;
import cn.herodotus.engine.assistant.definition.constants.DefaultConstants;
import cn.herodotus.engine.assistant.core.utils.http.SessionUtils;
import cn.herodotus.engine.rest.core.annotation.Crypto;
import cn.herodotus.engine.rest.protect.crypto.processor.HttpCryptoProcessor;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.Part;
import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.MethodParameter;
import org.springframework.core.ResolvableType;
import org.springframework.http.HttpMethod;
import org.springframework.lang.Nullable;
import org.springframework.util.CollectionUtils;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.annotation.RequestParamMapMethodArgumentResolver;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;
import org.springframework.web.multipart.MultipartFile;
import java.util.Map;
/**
* Description: @RequestParam 解密处理器
*
* 主要针对具备以下几种条件情况，用该处理器进行处理
* 1. 使用未指定名称的 @RequestParam 注解，同时参数类型为Map的。
* 2. 使用了@Crypto注解，且requestDecrypt参数为 true。或者 请求路径是 '/oauth/token'
*
* @author : gengwei.zheng
* @date : 2021/10/5 16:40
*/
public class DecryptRequestParamMapResolver implements HandlerMethodArgumentResolver {
private static final Logger log = LoggerFactory.getLogger(DecryptRequestParamMapResolver.class);
private HttpCryptoProcessor httpCryptoProcessor;
private RequestParamMapMethodArgumentResolver requestParamMapMethodArgumentResolver;
public void setInterfaceCryptoProcessor(HttpCryptoProcessor httpCryptoProcessor) {
this.httpCryptoProcessor = httpCryptoProcessor;
}
public void setRequestParamMapMethodArgumentResolver(RequestParamMapMethodArgumentResolver requestParamMapMethodArgumentResolver) {
this.requestParamMapMethodArgumentResolver = requestParamMapMethodArgumentResolver;
}
@Override
public boolean supportsParameter(MethodParameter methodParameter) {
String methodName = methodParameter.getMethod().getName();
boolean isSupports = requestParamMapMethodArgumentResolver.supportsParameter(methodParameter);
log.trace("[Herodotus] |- Is DecryptRequestParamMapResolver supports method [{}] ? Status is [{}].", methodName, isSupports);
return isSupports;
}
/**
* 判断该接口方法是否用@Crypto注解标记，同时requestDecrypt的值是true
*
* @param methodParameter {@link MethodParameter}
* @return 是否开启了自定义@Crypto
*/
private boolean isConfigCrypto(MethodParameter methodParameter) {
Crypto crypto = methodParameter.getMethodAnnotation(Crypto.class);
return ObjectUtils.isNotEmpty(crypto) && crypto.requestDecrypt();
}
/**
* 是否 Post /oauth/token 请求
*
* @param uri 请求uri
* @param method 请求类型
* @return 是否 Post /oauth/token 请求
*/
private boolean isOauthTokenRequest(String uri, String method) {
return StringUtils.equals(uri, DefaultConstants.TOKEN_ENDPOINT) && StringUtils.equalsIgnoreCase(method, HttpMethod.POST.name());
}
/**
* 是否是常规Map
*
* @param methodParameter {@link MethodParameter}
* @return boolean
*/
private boolean isRegularMap(MethodParameter methodParameter) {
if (!MultiValueMap.class.isAssignableFrom(methodParameter.getParameterType())) {
ResolvableType resolvableType = ResolvableType.forMethodParameter(methodParameter);
Class valueType = resolvableType.asMap().getGeneric(1).resolve();
return !(valueType == MultipartFile.class || valueType == Part.class);
}
return false;
}
@Override
@Nullable
public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class);
String requestURI = request.getRequestURI();
String requestMethod = request.getMethod();
if (isConfigCrypto(methodParameter) || isOauthTokenRequest(requestURI, requestMethod)) {
String sessionId = SessionUtils.analyseSessionId(request);
if (SessionUtils.isCryptoEnabled(request, sessionId)) {
if (isRegularMap(methodParameter)) {
Map parameterMap = webRequest.getParameterMap();
Map result = CollectionUtils.newLinkedHashMap(parameterMap.size());
for (Map.Entry entry : parameterMap.entrySet()) {
String key = entry.getKey();
String[] values = entry.getValue();
if (values.length > 0) {
String value = httpCryptoProcessor.decrypt(sessionId, values[0]);
;
result.put(key, value);
}
}
return result;
}
} else {
log.warn("[Herodotus] |- Cannot find Herodotus Cloud custom session header. Use interface crypto founction need add X_HERODOTUS_SESSION_ID to request header.");
}
}
log.debug("[Herodotus] |- The decryption conditions are not met DecryptRequestParamMapResolver, skip! to next!");
return requestParamMapMethodArgumentResolver.resolveArgument(methodParameter, mavContainer, webRequest, binderFactory);
}
}