csharp: odata lib - #22384
Open
hugo-syn wants to merge 3 commits into
Open
Conversation
Adds semmle.code.csharp.frameworks.OData, following the WCF.qll/JsonNET.qll convention: values cast, as-converted, or type-tested out of an untyped ODataActionParameters dictionary, and entities tracked by Delta<T> (via GetInstance/Patch/Put/CopyChangedValues/CopyUnchangedValues), have no static type relationship to the action method's own parameter types, so their members aren't picked up by the existing AspNetRemoteFlowSourceMember modeling. This adds a TaintedMember for those bound types (with the same nested-type/collection recursion as AspNetRemoteFlowSourceMember), plus two AdditionalTaintStep steps for the Delta<T> method calls, which don't fit the member-read shape TaintedMember covers. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Match WCF.qll's convention: only the TaintedMember/AdditionalTaintStep wiring classes stay private, everything else that identifies a reusable OData domain concept (ODataActionParametersClass, DeltaClass, ODataBoundType, DeltaMutatingMethod, DeltaGetInstanceMethod) is public. Also renames the test fixtures to generic placeholder names. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
import csharp already publicly imports semmle.code.csharp.dataflow.TaintTracking (and DataFlow), same as WCF.qll/JsonNET.qll rely on implicitly. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
michaelnebel
left a comment
michaelnebel
left a comment
Contributor
There was a problem hiding this comment.
Thank you very much! It is really good, if we can get our modelling extended even further!
I have added some initial comments / questions. Maybe OData parameter like types are only relevant for classes that extend ODataController. Should that somehow be incorporated in the logic?
Comment on lines
+152
to
+160
| private class DeltaGetInstanceTaintStep extends AdditionalTaintStep { | ||
| override predicate step(DataFlow::Node node1, DataFlow::Node node2) { | ||
| exists(MethodCall mc | | ||
| mc.getTarget().getUnboundDeclaration() instanceof DeltaGetInstanceMethod and | ||
| node1.asExpr() = mc.getQualifier() and | ||
| node2.asExpr() = mc | ||
| ) | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Perhaps, the QL implementation can be replaced by Models as Data?
Below is the row for one of the GetInstance methods.
extensions:
- addsTo:
pack: codeql/csharp-all
extensible: summaryModel
data:
- ["Microsoft.AspNet.OData", "Delta<TStructuralType>", True, "GetInstance", "()", "", "Argument[this]", "ReturnValue", "taint", "manual"]
Comment on lines
+3
to
+25
| namespace Microsoft.AspNet.OData | ||
| { | ||
| public class ODataActionParameters : Dictionary<string, object> | ||
| { | ||
| } | ||
|
|
||
| public class Delta<TStructuralType> where TStructuralType : class | ||
| { | ||
| private TStructuralType instance; | ||
|
|
||
| public Delta() { instance = default(TStructuralType); } | ||
|
|
||
| public TStructuralType GetInstance() => instance; | ||
|
|
||
| public void Patch(TStructuralType original) { } | ||
|
|
||
| public void Put(TStructuralType original) { } | ||
|
|
||
| public void CopyChangedValues(TStructuralType original) { } | ||
|
|
||
| public void CopyUnchangedValues(TStructuralType original) { } | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Ideally, we would like to keep stub implementations separate from the test and store them in test/resources/stubs.
This will require an options file for the test; If possible, it is also preferred, if the test relies fully on stubs and not any .dll files.
Comment on lines
+97
to
+112
| private class CandidateODataMember extends Member { | ||
| CandidateODataMember() { | ||
| this.isPublic() and | ||
| not this.isStatic() and | ||
| ( | ||
| this = | ||
| any(Property p | | ||
| p.isAutoImplemented() and | ||
| p.getGetter().isPublic() and | ||
| p.getSetter().isPublic() | ||
| ) | ||
| or | ||
| this = any(Field f | f.isPublic()) | ||
| ) | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
This appears to be a copy of the CandidateMemberToTaint. Perhaps, the implementation from Remote.qll can be re-used?
| TaintTracking::localExprTaint(any(ODataActionParameterRead r), e) | ||
| } | ||
|
|
||
| /** The generic `Delta<TStructuralType>` change-tracking class, across OData library versions. */ |
Contributor
There was a problem hiding this comment.
Maybe refer to the unbound declaration with "Delta1" instead of Delta<TStructuralType> as the type parameter is named T for Microsoft.AspNetCore.OData.Deltas.Delta<T>
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
2 participants
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.
Add predicates and classes for the OData library https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnet.odata?view=odata-aspnetcore-7.0&viewFallbackFrom=odata-aspnetcore-8.0