Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ The resulting module has an identical signature to the one obtained from ``DataF
Flow sources
~~~~~~~~~~~~

The data flow library contains some predefined flow sources. The class ``RemoteFlowSource`` (defined in ``semmle.code.java.dataflow.FlowSources``) represents data flow sources that may be controlled by a remote user, which is useful for finding security problems.
The data flow library contains some predefined flow sources. The class ``RemoteFlowSource`` represents data flow sources that may be controlled by a remote user, which is useful for finding security problems.

Examples
~~~~~~~~
Expand Down Expand Up @@ -312,7 +312,7 @@ Exercise 3

import go

class GetenvSource extends CallExpr {
class GetenvSource extends DataFlow::CallNode {
GetenvSource() {
exists(Function m | m = this.getTarget() |
m.hasQualifiedName("os", "Getenv")
Expand All @@ -327,7 +327,7 @@ Exercise 4

import go

class GetenvSource extends CallExpr {
class GetenvSource extends DataFlow::CallNode {
GetenvSource() {
exists(Function m | m = this.getTarget() |
m.hasQualifiedName("os", "Getenv")
Expand All @@ -350,7 +350,6 @@ Exercise 4
sink.asExpr() = call.getArgument(0)
)
}
}
}

module GetenvToURLFlow = DataFlow::Global<GetenvToURLConfig>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -354,11 +354,50 @@ This data flow configuration tracks data flow from environment variables to open
select fileOpen, "This call to 'os.open' uses data from $@.",
environment, "call to 'os.getenv'"

Path Query Example
~~~~~~~~~~~~~~~~~~

Here is the first example above, converted into a path query:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to be more explicit here, maybe:

Suggested change
Here is the first example above, converted into a path query:
Here is the network input example above, converted into a path query:

Alternatively, you could give the two queries above a heading.


.. code-block:: ql

/**
* @kind path-problem
* @problem.severity warning
* @id file-system-access-from-remote-input
*/

import python
import semmle.python.dataflow.new.DataFlow
import semmle.python.dataflow.new.TaintTracking
import semmle.python.dataflow.new.RemoteFlowSources
import semmle.python.Concepts

module RemoteToFileConfiguration implements DataFlow::ConfigSig {
predicate isSource(DataFlow::Node source) {
source instanceof RemoteFlowSource
}

predicate isSink(DataFlow::Node sink) {
sink = any(FileSystemAccess fa).getAPathArgument()
}
}

module RemoteToFileFlow = TaintTracking::Global<RemoteToFileConfiguration>;

import RemoteToFileFlow::PathGraph

from RemoteToFileFlow::PathNode input, RemoteToFileFlow::PathNode fileAccess
where RemoteToFileFlow::flowPath(input, fileAccess)
select fileAccess.getNode(), input, fileAccess, "This file access uses data from $@.",
input, "user-controllable input."

For more information, see ":doc:`Creating path queries <creating-path-queries>`".

Further reading
---------------

- `Exploring data flow with path queries <https://docs.github.com/en/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries>`__ in the GitHub documentation.
- `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__ in the GitHub documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've changed docs sites from GitHub to CodeQL, so we can simplify this:

Suggested change
- `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__ in the GitHub documentation.
- `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__.



.. include:: ../reusables/python-further-reading.rst
Expand Down
Loading