Skip to content

Commit 10d5d09

Browse files
committed
JS: Polish taint-tracking section in response to review comment
1 parent ecccc7c commit 10d5d09

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/codeql/codeql-language-guides/migrating-javascript-dataflow-queries.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,9 @@ Taint tracking
9797
For configuration classes extending ``TaintTracking::Configuration``, the migration is similar but with a few differences:
9898

9999
- The ``TaintTracking::Global`` module should be used instead of ``DataFlow::Global``.
100-
- The ``isSanitizer`` predicate should be renamed to ``isBarrier``.
101-
- The ``isAdditionalTaintStep`` predicate should be renamed to ``isAdditionalFlowStep``.
100+
- Some predicates originating from ``TaintTracking::Configuration`` should be renamed to match the ``DataFlow::ConfigSig`` interface:
101+
- ``isSanitizer`` should be renamed to ``isBarrier``.
102+
- ``isAdditionalTaintStep`` should be renamed to ``isAdditionalFlowStep``.
102103

103104
Note that there is no such thing as ``TaintTracking::ConfigSig``. The ``DataFlow::ConfigSig`` interface is used for both data flow and taint tracking.
104105

@@ -107,6 +108,8 @@ For example:
107108
.. code-block:: ql
108109
109110
class MyConfig extends TaintTracking::Configuration {
111+
MyConfig() { this = "MyConfig" }
112+
110113
predicate isSanitizer(DataFlow::Node node) { ... }
111114
predicate isAdditionalTaintStep(DataFlow::Node node1, DataFlow::Node node2) { ... }
112115
...

0 commit comments

Comments
 (0)