-
Notifications
You must be signed in to change notification settings - Fork 288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix session rewriting false positives #7323
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
73bdc9f
Fix session rewriting for servlet3
jandro996 bcf26a4
Fix session rewriting for jakarta impl
jandro996 50eedb3
leftovers
jandro996 8feb8c5
Merge branch 'master' into alejandro.gonzalez/session-rewriting-fix
jandro996 dec0f2a
Rename instrumentation to be consistent in naming between jakarta and…
jandro996 fe03b9f
Merge branch 'master' into alejandro.gonzalez/session-rewriting-fix
jandro996 ae0d857
Merge branch 'master' into alejandro.gonzalez/session-rewriting-fix
jandro996 3727c44
Merge branch 'master' into alejandro.gonzalez/session-rewriting-fix
jandro996 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
110 changes: 110 additions & 0 deletions
110
.../datadog/trace/instrumentation/servlet3/IastOptOutHttpServletRequest3Instrumentation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| package datadog.trace.instrumentation.servlet3; | ||
|
|
||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed; | ||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.HierarchyMatchers.extendsClass; | ||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.HierarchyMatchers.implementsInterface; | ||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; | ||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.namedNoneOf; | ||
| import static net.bytebuddy.matcher.ElementMatchers.*; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import datadog.trace.agent.tooling.Instrumenter; | ||
| import datadog.trace.agent.tooling.InstrumenterModule; | ||
| import datadog.trace.api.iast.InstrumentationBridge; | ||
| import datadog.trace.api.iast.Sink; | ||
| import datadog.trace.api.iast.VulnerabilityTypes; | ||
| import datadog.trace.api.iast.sink.ApplicationModule; | ||
| import datadog.trace.bootstrap.InstrumentationContext; | ||
| import java.util.Collections; | ||
| import java.util.HashSet; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import javax.servlet.ServletContext; | ||
| import javax.servlet.SessionTrackingMode; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.servlet.http.HttpSession; | ||
| import net.bytebuddy.asm.Advice; | ||
| import net.bytebuddy.description.type.TypeDescription; | ||
| import net.bytebuddy.matcher.ElementMatcher; | ||
|
|
||
| @AutoService(InstrumenterModule.class) | ||
| public class IastOptOutHttpServletRequest3Instrumentation extends InstrumenterModule.Iast | ||
| implements Instrumenter.ForTypeHierarchy { | ||
|
|
||
| public IastOptOutHttpServletRequest3Instrumentation() { | ||
| super("servlet", "servlet-3"); | ||
| } | ||
|
|
||
| @Override | ||
| public String muzzleDirective() { | ||
| return "servlet-3.x"; | ||
| } | ||
|
|
||
| @Override | ||
| public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() { | ||
| // Avoid matching request before servlet-3.x which don't have session tracking modes | ||
| return hasClassNamed("javax.servlet.SessionTrackingMode"); | ||
| } | ||
|
|
||
| @Override | ||
| public String hierarchyMarkerType() { | ||
| return "javax.servlet.http.HttpServletRequest"; | ||
| } | ||
|
|
||
| @Override | ||
| public ElementMatcher<TypeDescription> hierarchyMatcher() { | ||
| return implementsInterface(named(hierarchyMarkerType())) | ||
| // ignore wrappers that ship with servlet-api | ||
| .and(namedNoneOf("javax.servlet.http.HttpServletRequestWrapper")) | ||
| .and(not(extendsClass(named("javax.servlet.http.HttpServletRequestWrapper")))); | ||
| } | ||
|
|
||
| @Override | ||
| public void methodAdvice(MethodTransformer transformer) { | ||
| transformer.applyAdvice( | ||
| named("getSession").and(returns(named("javax.servlet.http.HttpSession"))).and(isPublic()), | ||
| getClass().getName() + "$GetHttpSessionAdvice"); | ||
| } | ||
|
|
||
| @Override | ||
| public Map<String, String> contextStore() { | ||
| return Collections.singletonMap( | ||
| "javax.servlet.ServletContext", "javax.servlet.SessionTrackingMode"); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean isOptOutEnabled() { | ||
| return true; | ||
| } | ||
|
|
||
| public static class GetHttpSessionAdvice { | ||
| @Advice.OnMethodExit(suppress = Throwable.class) | ||
| @Sink(VulnerabilityTypes.SESSION_REWRITING) | ||
| public static void onExit( | ||
| @Advice.This final HttpServletRequest request, @Advice.Return final HttpSession session) { | ||
| if (session == null) { | ||
| return; | ||
| } | ||
| final ApplicationModule module = InstrumentationBridge.APPLICATION; | ||
| if (module == null) { | ||
| return; | ||
| } | ||
| final ServletContext context = request.getServletContext(); | ||
| if (InstrumentationContext.get(ServletContext.class, SessionTrackingMode.class).get(context) | ||
| != null) { | ||
| return; | ||
| } | ||
| // We only want to report it once per application | ||
| InstrumentationContext.get(ServletContext.class, SessionTrackingMode.class) | ||
| .put(context, SessionTrackingMode.URL); | ||
| if (context.getEffectiveSessionTrackingModes() != null | ||
| && !context.getEffectiveSessionTrackingModes().isEmpty()) { | ||
| Set<String> sessionTrackingModes = new HashSet<>(); | ||
| for (SessionTrackingMode mode : context.getEffectiveSessionTrackingModes()) { | ||
| sessionTrackingModes.add(mode.name()); | ||
| } | ||
| module.checkSessionTrackingModes(sessionTrackingModes); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
98 changes: 98 additions & 0 deletions
98
...og/trace/instrumentation/servlet5/IastOptOutJakartaHttpServletRequestInstrumentation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| package datadog.trace.instrumentation.servlet5; | ||
|
|
||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.HierarchyMatchers.extendsClass; | ||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.HierarchyMatchers.implementsInterface; | ||
| import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named; | ||
| import static net.bytebuddy.matcher.ElementMatchers.*; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import datadog.trace.agent.tooling.Instrumenter; | ||
| import datadog.trace.agent.tooling.InstrumenterModule; | ||
| import datadog.trace.api.iast.*; | ||
| import datadog.trace.api.iast.sink.ApplicationModule; | ||
| import datadog.trace.bootstrap.InstrumentationContext; | ||
| import jakarta.servlet.ServletContext; | ||
| import jakarta.servlet.SessionTrackingMode; | ||
| import jakarta.servlet.http.HttpServletRequest; | ||
| import jakarta.servlet.http.HttpSession; | ||
| import java.util.*; | ||
| import net.bytebuddy.asm.Advice; | ||
| import net.bytebuddy.description.type.TypeDescription; | ||
| import net.bytebuddy.matcher.ElementMatcher; | ||
|
|
||
| @SuppressWarnings("unused") | ||
| @AutoService(InstrumenterModule.class) | ||
| public class IastOptOutJakartaHttpServletRequestInstrumentation extends InstrumenterModule.Iast | ||
| implements Instrumenter.ForTypeHierarchy { | ||
|
|
||
| private static final String CLASS_NAME = | ||
| IastOptOutJakartaHttpServletRequestInstrumentation.class.getName(); | ||
| private static final ElementMatcher.Junction<? super TypeDescription> WRAPPER_CLASS = | ||
| named("jakarta.servlet.http.HttpServletRequestWrapper"); | ||
|
|
||
| public IastOptOutJakartaHttpServletRequestInstrumentation() { | ||
| super("servlet", "servlet-5", "servlet-request"); | ||
| } | ||
|
|
||
| @Override | ||
| public String hierarchyMarkerType() { | ||
| return "jakarta.servlet.http.HttpServletRequest"; | ||
| } | ||
|
|
||
| @Override | ||
| public ElementMatcher<TypeDescription> hierarchyMatcher() { | ||
| return implementsInterface(named(hierarchyMarkerType())) | ||
| .and(not(WRAPPER_CLASS)) | ||
| .and(not(extendsClass(WRAPPER_CLASS))); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean isOptOutEnabled() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public void methodAdvice(MethodTransformer transformer) { | ||
| transformer.applyAdvice( | ||
| named("getSession").and(returns(named("jakarta.servlet.http.HttpSession"))).and(isPublic()), | ||
| CLASS_NAME + "$GetHttpSessionAdvice"); | ||
| } | ||
|
|
||
| @Override | ||
| public Map<String, String> contextStore() { | ||
| return Collections.singletonMap( | ||
| "jakarta.servlet.ServletContext", "jakarta.servlet.SessionTrackingMode"); | ||
| } | ||
|
|
||
| public static class GetHttpSessionAdvice { | ||
| @Advice.OnMethodExit(suppress = Throwable.class) | ||
| @Sink(VulnerabilityTypes.SESSION_REWRITING) | ||
| public static void onExit( | ||
| @Advice.This final HttpServletRequest request, @Advice.Return final HttpSession session) { | ||
| if (session == null) { | ||
| return; | ||
| } | ||
| final ApplicationModule module = InstrumentationBridge.APPLICATION; | ||
| if (module == null) { | ||
| return; | ||
| } | ||
| final ServletContext context = request.getServletContext(); | ||
|
|
||
| if (InstrumentationContext.get(ServletContext.class, SessionTrackingMode.class).get(context) | ||
| != null) { | ||
| return; | ||
| } | ||
| // We only want to report it once per application | ||
| InstrumentationContext.get(ServletContext.class, SessionTrackingMode.class) | ||
| .put(context, SessionTrackingMode.URL); | ||
| if (context.getEffectiveSessionTrackingModes() != null | ||
| && !context.getEffectiveSessionTrackingModes().isEmpty()) { | ||
| Set<String> sessionTrackingModes = new HashSet<>(); | ||
| for (SessionTrackingMode mode : context.getEffectiveSessionTrackingModes()) { | ||
| sessionTrackingModes.add(mode.name()); | ||
| } | ||
| module.checkSessionTrackingModes(sessionTrackingModes); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although we already have a JakartaHttpServletRequestInstrumentation for IAST we need another one due to session rewriting is an opt-out feature