Merge pull request #4514 from tausbn/python-add-module-boundary-flow-steps

Python: Add module boundary flow steps

Author: yoff

python/ql/src/experimental/dataflow/internal/DataFlowPrivate.qll

@@ -798,6 +798,29 @@ predicate jumpStep(Node nodeFrom, Node nodeTo) {
   or
   // Module variable write
   nodeFrom = nodeTo.(ModuleVariableNode).getAWrite()
+  or
+  // Read of module attribute:
+  exists(AttrRead r, ModuleValue mv |
+    r.getObject().asCfgNode().pointsTo(mv) and
+    module_export(mv.getScope(), r.getAttributeName(), nodeFrom) and
+    nodeTo = r
+  )
+}
+
+/**
+ * Holds if the module `m` defines a name `name` by assigning `defn` to it. This is an
+ * overapproximation, as `name` may not in fact be exported (e.g. by defining an `__all__` that does
+ * not include `name`).
+ */
+private predicate module_export(Module m, string name, CfgNode defn) {
+  exists(EssaVariable v |
+    v.getName() = name and
+    v.getAUse() = m.getANormalExit()
+  |
+    defn.getNode() = v.getDefinition().(AssignmentDefinition).getValue()
+    or
+    defn.getNode() = v.getDefinition().(ArgumentRefinement).getArgument()
+  )
 }
 
 //--------

python/ql/test/experimental/dataflow/pep_328/__init__.py

@@ -0,0 +1 @@
+pass

python/ql/test/experimental/dataflow/pep_328/package/__init__.py

@@ -0,0 +1 @@
+bar = "bar"

python/ql/test/experimental/dataflow/pep_328/package/moduleA.py

@@ -0,0 +1 @@
+foo = "foo"

python/ql/test/experimental/dataflow/pep_328/package/subpackage1/__init__.py

@@ -0,0 +1,16 @@
+from .moduleY import spam
+from .moduleY import spam as ham
+from . import moduleY
+from ..subpackage1 import moduleY
+from ..subpackage2.moduleZ import eggs
+from ..moduleA import foo
+
+try:
+    from ...package import bar
+except Exception as e:
+    print(e)
+
+try:
+    from ...sys import path
+except Exception as e:
+    print(e)

python/ql/test/experimental/dataflow/pep_328/package/subpackage1/moduleX.py

@@ -0,0 +1,16 @@
+from .moduleY import spam
+from .moduleY import spam as ham
+from . import moduleY
+from ..subpackage1 import moduleY
+from ..subpackage2.moduleZ import eggs
+from ..moduleA import foo
+
+try:
+    from ...package import bar
+except Exception as e:
+    print(e)
+
+try:
+    from ...sys import path
+except Exception as e:
+    print(e)

python/ql/test/experimental/dataflow/pep_328/package/subpackage1/moduleY.py

@@ -0,0 +1 @@
+spam = "spam"

python/ql/test/experimental/dataflow/pep_328/package/subpackage2/__init__.py

@@ -0,0 +1 @@
+pass

python/ql/test/experimental/dataflow/pep_328/package/subpackage2/moduleZ.py

@@ -0,0 +1 @@
+eggs = "eggs"

python/ql/test/experimental/dataflow/pep_328/start.py

@@ -0,0 +1 @@
+import package.subpackage1.moduleX