Skip to content

Python: Add consistency check for PhaseDependentFlow #15775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2024
Merged

Python: Add consistency check for PhaseDependentFlow #15775

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d182eae
Python: Add consistency check for `PhaseDependentFlow`
RasmusWL Mar 1, 2024
85a45b0
Python: Fix comment
RasmusWL Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Python: Add consistency check for PhaseDependentFlow 
This would have found the problem in
#15755.

As highlighted in the comment in the code, it's not a perfect solution
since we don't have an automatic way to ensure we don't introduce a new
PhaseDependentFlow use with a new step relation and forget to add it to
this consistency check... but I think this consistency check still adds
value!
  • Loading branch information
@RasmusWL
RasmusWL committed Mar 1, 2024
commit d182eae868aada28abe51ba5a29da13210f0fa16
21 changes: 21 additions & 0 deletions python/ql/consistency-queries/PhaseDependentFlowConsistency.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
private import python
private import semmle.python.dataflow.new.DataFlow::DataFlow
private import semmle.python.dataflow.new.internal.DataFlowPrivate as DataFlowPrivate
private import semmle.python.dataflow.new.internal.VariableCapture as VariableCapture

from Node node
where
not exists(node.getScope()) and
exists(Node nodeFrom, Node nodeTo | node in [nodeFrom, nodeTo] |
// the list of step relations used with PhaseDependentFlow has been compiled
// manually, and there isn't really a good way to do so manually :|
DataFlowPrivate::LocalFlow::definitionFlowStep(nodeFrom, nodeTo)
or
DataFlowPrivate::LocalFlow::expressionFlowStep(nodeFrom, nodeTo)
or
DataFlowPrivate::LocalFlow::useUseFlowStep(nodeFrom, nodeTo)
or
VariableCapture::valueStep(nodeFrom, nodeTo)
)
select node,
"Node being used in PhaseDependentFlow does not have result for .getScope(), so will not work properly (since division into run-time/import-time is based on .getScope result)"