C#: Fix false positives in cs/log-forging for extension methods#21498
Open
Gregro wants to merge 1 commit intogithub:mainfrom
Open
C#: Fix false positives in cs/log-forging for extension methods#21498Gregro wants to merge 1 commit intogithub:mainfrom
Gregro wants to merge 1 commit intogithub:mainfrom
Conversation
86f9414 to
2539358
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the C# cs/log-forging dataflow to avoid treating user-defined logger extension methods as sinks, reducing false positives while still flagging framework logging extension methods via Models as Data.
Changes:
- Refines the log-forging sink definition to focus on direct instance calls on logger types rather than all calls with logger arguments.
- Adds Models-as-Data sink models for
Microsoft.Extensions.Logging.LoggerExtensionslogging APIs. - Extends CWE-117 test coverage to include safe/unsafe user-defined extension methods and updates expected results + changelog.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| csharp/ql/test/query-tests/Security Features/CWE-117/LogForging.expected | Updates expected results to reflect new sink modeling and interprocedural flows through extension methods. |
| csharp/ql/test/query-tests/Security Features/CWE-117/LogForging.cs | Adds user-defined logger extension methods (safe/unsafe) to validate reduced false positives. |
| csharp/ql/lib/semmle/code/csharp/security/dataflow/LogForgingQuery.qll | Adjusts sink definition intended to exclude extension methods from being treated as sinks. |
| csharp/ql/lib/ext/Microsoft.Extensions.Logging.Sinks.model.yml | Introduces explicit sink models for Microsoft.Extensions.Logging.LoggerExtensions APIs. |
| csharp/ql/lib/change-notes/2026-03-19-fix-log-forging-extension-methods.md | Documents the analysis change and new MaD modeling. |
Comment on lines
+61
to
+63
| this.getExpr() = any(LoggerType i).getAMethod().getACall().getAnArgument() or | ||
| this.getExpr() = | ||
| any(MethodCall call | call.getQualifier().getType() instanceof LoggerType).getAnArgument() |
| } | ||
| } | ||
|
|
||
| static class LoggerExtensions |
| { | ||
| public static void WarnSafe(this ILogger logger, string message) | ||
| { | ||
| logger.Warn(message.Replace(Environment.NewLine, "")); |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The log forging query previously treated all arguments to methods called on logger types as sinks, including user-defined extension methods. This caused false positives when extension methods sanitize input internally, since interprocedural analysis was bypassed.
Now, only direct instance method calls on logger types are treated as sinks. User-defined extension methods are analyzed interprocedurally, allowing the query to see sanitization within method bodies.
Known framework extension methods (
Microsoft.Extensions.Logging.LoggerExtensions) are modeled as explicit sinks via Models as Data.Fixes #15824