|
| 1 | +package dev.aikido.agent.wrappers.spring; |
| 2 | + |
| 3 | +import dev.aikido.agent.wrappers.Wrapper; |
| 4 | +import dev.aikido.agent_api.collectors.WebRequestCollector; |
| 5 | +import dev.aikido.agent_api.collectors.WebResponseCollector; |
| 6 | +import dev.aikido.agent_api.context.ContextObject; |
| 7 | +import dev.aikido.agent_api.context.SpringMVCContextObject; |
| 8 | +import dev.aikido.agent_api.helpers.logging.LogManager; |
| 9 | +import dev.aikido.agent_api.helpers.logging.Logger; |
| 10 | + |
| 11 | +import javax.servlet.http.Cookie; |
| 12 | +import javax.servlet.http.HttpServletRequest; |
| 13 | +import javax.servlet.http.HttpServletResponse; |
| 14 | +import net.bytebuddy.asm.Advice; |
| 15 | +import net.bytebuddy.description.method.MethodDescription; |
| 16 | +import net.bytebuddy.description.type.TypeDescription; |
| 17 | +import net.bytebuddy.matcher.ElementMatcher; |
| 18 | +import net.bytebuddy.matcher.ElementMatchers; |
| 19 | + |
| 20 | +import java.lang.reflect.Executable; |
| 21 | +import java.util.ArrayList; |
| 22 | +import java.util.Enumeration; |
| 23 | +import java.util.HashMap; |
| 24 | +import java.util.List; |
| 25 | + |
| 26 | +import static net.bytebuddy.implementation.bytecode.assign.Assigner.Typing.DYNAMIC; |
| 27 | +import static net.bytebuddy.matcher.ElementMatchers.nameContains; |
| 28 | +import static net.bytebuddy.matcher.ElementMatchers.takesArgument; |
| 29 | + |
| 30 | +public class SpringMVCJavaxWrapper implements Wrapper { |
| 31 | + public static final Logger logger = LogManager.getLogger(SpringMVCJavaxWrapper.class); |
| 32 | + |
| 33 | + @Override |
| 34 | + public String getName() { |
| 35 | + // We wrap the function doFilterInternal which gets called with |
| 36 | + // HttpServletRequest request, HttpServletResponse response |
| 37 | + // And is part of org.springframework.web.filter.RequestContextFilter |
| 38 | + // See: https://github.com/spring-projects/spring-framework/blob/4749d810db0261ce16ae5f32da6d375bb8087430/spring-web/src/main/java/org/springframework/web/filter/RequestContextFilter.java#L92 |
| 39 | + return SpringMVCAdvice.class.getName(); |
| 40 | + } |
| 41 | + @Override |
| 42 | + public ElementMatcher<? super MethodDescription> getMatcher() { |
| 43 | + return ElementMatchers.nameContainsIgnoreCase("doFilterInternal") |
| 44 | + .and(takesArgument(0, nameContains("javax"))) |
| 45 | + .and(takesArgument(1, nameContains("javax"))); |
| 46 | + } |
| 47 | + |
| 48 | + @Override |
| 49 | + public ElementMatcher<? super TypeDescription> getTypeMatcher() { |
| 50 | + return nameContains("org.springframework.web.filter.RequestContextFilter"); |
| 51 | + } |
| 52 | + |
| 53 | + public static class SpringMVCAdvice { |
| 54 | + // Wrapper to skip if it's inside this wrapper (i.e. our own response : ) |
| 55 | + public record SkipOnWrapper(HttpServletResponse response) {}; |
| 56 | + /** |
| 57 | + * @return the first value of Object is used as a boolean, if it's true code will |
| 58 | + * not execute (skip execution). The second value is the servlet request. |
| 59 | + */ |
| 60 | + @Advice.OnMethodEnter(skipOn = SkipOnWrapper.class, suppress = Throwable.class) |
| 61 | + public static Object interceptOnEnter( |
| 62 | + @Advice.Origin Executable method, |
| 63 | + @Advice.Argument(value = 0, typing = DYNAMIC, optional = true) HttpServletRequest request, |
| 64 | + @Advice.Argument(value = 1, typing = DYNAMIC, optional = true) HttpServletResponse response) throws Throwable { |
| 65 | + if (request == null) { |
| 66 | + logger.debug("@OnMethodEnter: request is null, not parsing request."); |
| 67 | + return response; |
| 68 | + } |
| 69 | + // extract headers : |
| 70 | + HashMap<String, Enumeration<String>> headersMap = new HashMap<>(); |
| 71 | + Enumeration<String> headerNames = request.getHeaderNames(); |
| 72 | + while (headerNames != null && headerNames.hasMoreElements()) { |
| 73 | + String headerName = headerNames.nextElement(); |
| 74 | + Enumeration<String> headerValue = request.getHeaders(headerName); |
| 75 | + headersMap.put(headerName, headerValue); |
| 76 | + } |
| 77 | + // extract cookies : |
| 78 | + HashMap<String, List<String>> cookiesMap = new HashMap<>(); |
| 79 | + Cookie[] cookies = request.getCookies(); |
| 80 | + if (cookies != null) { |
| 81 | + for (Cookie cookie : cookies) { |
| 82 | + // If no entry exists, create a new empty entry |
| 83 | + if (!cookiesMap.containsKey(cookie.getName())) { |
| 84 | + cookiesMap.put(cookie.getName(), new ArrayList<>()); |
| 85 | + } |
| 86 | + cookiesMap.get(cookie.getName()).add(cookie.getValue()); |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + ContextObject contextObject = new SpringMVCContextObject( |
| 91 | + request.getMethod(), request.getRequestURL(), request.getRemoteAddr(), |
| 92 | + request.getParameterMap(), cookiesMap, headersMap |
| 93 | + ); |
| 94 | + |
| 95 | + // Write a new response: |
| 96 | + WebRequestCollector.Res res = WebRequestCollector.report(contextObject); |
| 97 | + if (res != null) { |
| 98 | + logger.trace("Writing a new response"); |
| 99 | + response.setStatus(res.status()); |
| 100 | + response.setContentType("text/plain"); |
| 101 | + response.getWriter().write(res.msg()); |
| 102 | + return new SkipOnWrapper(response); |
| 103 | + } |
| 104 | + return response; |
| 105 | + } |
| 106 | + |
| 107 | + @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class) |
| 108 | + public static void interceptOnExit(@Advice.Enter Object response) { |
| 109 | + if (response != null && response instanceof HttpServletResponse httpServletResponse) { |
| 110 | + WebResponseCollector.report(httpServletResponse.getStatus()); // Report status code. |
| 111 | + } |
| 112 | + } |
| 113 | + } |
| 114 | +} |
0 commit comments