Skip to content

Commit 1dce119

Browse files
committed
docs: update threat model description to include 'response' category
1 parent b3601b1 commit 1dce119

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/codeql/reusables/threat-model-description.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
A threat model is a named class of dataflow sources that can be enabled or disabled independently. Threat models allow you to control the set of dataflow sources that you want to consider unsafe. For example, one codebase may only consider remote HTTP requests to be tainted, whereas another may also consider data from local files to be unsafe. You can use threat models to ensure that the relevant taint sources are used in a CodeQL analysis.
44

5-
The ``kind`` property of the ``sourceModel`` determines which threat model a source is associated with. There are two main categories:
5+
The ``kind`` property of the ``sourceModel`` determines which threat model a source is associated with. There are three main categories:
66

77
- ``remote`` which represents requests and responses from the network.
88
- ``local`` which represents data from local files (``file``), command-line arguments (``commandargs``), database reads (``database``), environment variables(``environment``), standard input (``stdin``) and Windows registry values ("windows-registry"). Currently, Windows registry values are used by C# only.
9+
- ``response`` which represents the response data coming back from an outgoing HTTP request is considered a source of taint.
910

1011
Note that subcategories can be turned included or excluded separately, so you can specify ``local`` without ``database``, or just ``commandargs`` and ``environment`` without the rest of ``local``.
1112

0 commit comments

Comments
 (0)