mirror of
https://github.com/github/codeql.git
synced 2026-05-26 17:11:24 +02:00
ccfaa6ea7f
Switches the trunk dataflow library and all in-tree consumers
(frameworks, ApiGraphs, Concepts, regexp, security customisations,
test harness) from the legacy Flow.qll/ESSA stack to the new
shared-CFG facade (Cfg.qll) and the ESSA-shaped adapter on the
shared-SSA library (SsaImpl.qll).
Highlights:
* DataFlowPublic/Private/Dispatch, Attributes, VariableCapture,
IterableUnpacking, ImportResolution, ImportStar, LocalSources,
TaintTrackingPrivate, MatchUnpacking, TypeTrackingImpl,
SsaImpl, Builtins all now qualify CFG/SSA references with
Cfg:: / SsaImpl:: and stop pulling in semmle.python.essa.*.
* AstNodeImpl.qll/Cfg.qll: ImportMember exposes its inner
ImportExpr, DefinitionNode.getValue covers Alias / AnnAssign /
AugAssign / AssignExpr / For-target / Parameter-default,
ForNode is treated as an expression node, AnnotatedExitNode is
canonical, and BoolExprNode.getAnOperand drops the dominance
constraint that did not hold for short-circuit BBs.
* SsaImpl.qll: parameters always get a ParameterDefinition (so
unused parameters still have SSA defs), scope-entry defs for
module globals require an actual store somewhere, scope-exit
has a synthetic use so reaching-defs survives to module
boundary, and the legacy SsaSourceVariable / EssaVariable
surface (getName, getScope, getAUse, getASourceUse,
getAnImplicitUse) is reinstated for downstream queries.
* DataFlowPublic.qll: GuardNode redesigned around the new
structural outcome nodes (isAfterTrue / isAfterFalse). The
legacy ConditionBlock + flipped indirection is gone;
controlsBlock walks UP through 'not' / '==True' / 'is False'
etc. via outcomeOfGuard, accumulating polarity cleanly. Only
BarrierGuard<...> is preserved as public API.
* ModuleVariableNode.getAWrite and LocalFlow::definitionFlowStep
bypass SSA and consult Cfg::NameNode.defines /
Cfg::DefinitionNode.getValue directly, so that write defs
pruned by shared SSA (because the variable has no in-scope
read) still produce dataflow steps.
* Frameworks + downstream consumers: replace
EssaVariable.hasDefiningNode, getAReturnValueFlowNode,
Parameter.getDefault, Scope.getEntryNode / getANormalExit etc.
with CFG-side bridges through Cfg::ControlFlowNode.
The legacy Flow.qll / Essa.qll stack is untouched and remains
available for queries that import it directly.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
36 lines
1.3 KiB
Plaintext
36 lines
1.3 KiB
Plaintext
import python
|
|
private import semmle.python.controlflow.internal.Cfg as Cfg
|
|
import utils.test.dataflow.FlowTest
|
|
import utils.test.dataflow.testConfig
|
|
private import semmle.python.dataflow.new.internal.PrintNode
|
|
|
|
module DataFlowTest implements FlowTestSig {
|
|
string flowTag() { result = "flow" }
|
|
|
|
predicate relevantFlow(DataFlow::Node source, DataFlow::Node sink) {
|
|
TestFlow::flow(source, sink)
|
|
}
|
|
}
|
|
|
|
import MakeTest<MakeTestSig<DataFlowTest>>
|
|
|
|
query predicate missingAnnotationOnSink(Location location, string error, string element) {
|
|
error = "ERROR, you should add `# $ MISSING: flow` annotation" and
|
|
exists(DataFlow::Node sink |
|
|
TestConfig::isSink(sink) and
|
|
// note: we only care about `SINK` and not `SINK_F`, so we have to reconstruct manually.
|
|
exists(DataFlow::CallCfgNode call |
|
|
call.getFunction().asCfgNode().(Cfg::NameNode).getId() = "SINK" and
|
|
(sink = call.getArg(_) or sink = call.getArgByName(_))
|
|
) and
|
|
location = sink.getLocation() and
|
|
element = prettyExpr(sink.asExpr()) and
|
|
not TestFlow::flowTo(sink) and
|
|
not exists(FalseNegativeTestExpectation missingResult |
|
|
missingResult.getTag() = "flow" and
|
|
missingResult.getLocation().getFile() = location.getFile() and
|
|
missingResult.getLocation().getStartLine() = location.getStartLine()
|
|
)
|
|
)
|
|
}
|