hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-21 03:06:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

C#: Add QLDoc to the shared Capture summary models library.

Browse Source
This commit is contained in:
Michael Nebel
2022-03-09 14:10:32 +01:00
parent 8d2593ba0c
commit d114582b56
2 changed files with 46 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
java/ql/src/utils/model-generator/CaptureSummaryModels.qll
View File

@@ -1,16 +1,12 @@
/**
* Provides classes and predicates related to capturing summary models
* of the Standard or a 3rd party library.
*/
import CaptureSummaryModelsSpecific
/**
* Capture fluent APIs that return `this`.
* Example of a fluent API:
* ```
* public class Foo {
* public Foo someAPI() {
* // some side-effect
* return this;
* }
* }
* ```
* Gets the summary model of `api`, if it follows the `fluent` programming pattern (returns `this`).
*/
string captureQualifierFlow(TargetApi api) {
exists(ReturnStmt rtn |
@@ -20,14 +16,26 @@ string captureQualifierFlow(TargetApi api) {
result = asValueModel(api, qualifierString(), "ReturnValue")
}
class TaintRead extends DataFlow::FlowState {
/**
* A FlowState representing a tainted read.
*/
private class TaintRead extends DataFlow::FlowState {
TaintRead() { this = "TaintRead" }
}
class TaintStore extends DataFlow::FlowState {
/**
* A FlowState representing a tainted write.
*/
private class TaintStore extends DataFlow::FlowState {
TaintStore() { this = "TaintStore" }
}
/**
* A TaintTracking Configuration used for tracking flow through APIs.
* The sources are the parameters of an API and the sinks are the return values (excluding `this`) and parameters.
*
* This can be used to generate Flow summaries for APIs from parameter to return.
*/
class ThroughFlowConfig extends TaintTracking::Configuration {
ThroughFlowConfig() { this = "ThroughFlowConfig" }
@@ -72,6 +80,9 @@ class ThroughFlowConfig extends TaintTracking::Configuration {
}
}
/**
* Gets the summary model(s) of `api`, if there is flow from parameters to return value or parameter.
*/
string captureThroughFlow(TargetApi api) {
exists(
ThroughFlowConfig config, DataFlow::ParameterNode p, ReturnNodeExt returnNodeExt, string input,