mirror of
https://github.com/github/codeql.git
synced 2026-05-27 17:41:24 +02:00
26df3945d3
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>
60 lines
2.0 KiB
Plaintext
60 lines
2.0 KiB
Plaintext
import python
|
|
private import semmle.python.controlflow.internal.Cfg as Cfg
|
|
import semmle.python.dataflow.new.DataFlow
|
|
import utils.test.InlineExpectationsTest
|
|
private import semmle.python.dataflow.new.internal.PrintNode
|
|
private import semmle.python.dataflow.new.internal.DataFlowPrivate as DataFlowPrivate
|
|
|
|
/**
|
|
* A routing test is designed to test that values are routed to the
|
|
* correct arguments of the correct functions. It is assumed that
|
|
* the functions tested sink their arguments sequentially, that is
|
|
* `SINK1(arg1)`, etc.
|
|
*/
|
|
signature module RoutingTestSig {
|
|
class Argument;
|
|
|
|
string flowTag(Argument arg);
|
|
|
|
predicate relevantFlow(DataFlow::Node fromNode, DataFlow::Node toNode, Argument arg);
|
|
}
|
|
|
|
module MakeTestSig<RoutingTestSig Impl> implements TestSig {
|
|
string getARelevantTag() { result in ["func", Impl::flowTag(_)] }
|
|
|
|
predicate hasActualResult(Location location, string element, string tag, string value) {
|
|
exists(DataFlow::Node fromNode, DataFlow::Node toNode, Impl::Argument arg |
|
|
Impl::relevantFlow(fromNode, toNode, arg)
|
|
|
|
|
location = fromNode.getLocation() and
|
|
element = fromNode.toString() and
|
|
(
|
|
tag = Impl::flowTag(arg) and
|
|
if "\"" + tag + "\"" = fromValue(fromNode) then value = "" else value = fromValue(fromNode)
|
|
or
|
|
// only have result for `func` tag if the function where `arg<n>` is used, is
|
|
// different from the function name of the call where `arg<n>` was specified as
|
|
// an argument
|
|
tag = "func" and
|
|
value = toFunc(toNode) and
|
|
not value = fromFunc(fromNode)
|
|
)
|
|
)
|
|
}
|
|
}
|
|
|
|
pragma[inline]
|
|
private string fromValue(DataFlow::Node fromNode) {
|
|
result = "\"" + prettyNode(fromNode).replaceAll("\"", "'") + "\""
|
|
}
|
|
|
|
pragma[inline]
|
|
private string fromFunc(DataFlow::ArgumentNode fromNode) {
|
|
result = fromNode.getCall().getNode().(Cfg::CallNode).getFunction().getNode().(Name).getId()
|
|
}
|
|
|
|
pragma[inline]
|
|
private string toFunc(DataFlow::Node toNode) {
|
|
result = toNode.getEnclosingCallable().getQualifiedName()
|
|
}
|