Skip to content

Commit 54d7805

Browse files
committed
Modify Java threat model link to be Java-specific
1 parent d3ee5f6 commit 54d7805

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/codeql/codeql-language-guides/customizing-library-models-for-java-and-kotlin.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Extensible predicates used to create custom models in Java and Kotlin
6161

6262
The CodeQL library for Java and Kotlin analysis exposes the following extensible predicates:
6363

64-
- ``sourceModel(package, type, subtypes, name, signature, ext, output, kind, provenance)``. This is used to model sources of potentially tainted data. The ``kind`` of the sources defined using this predicate determine which threat model they are associated with. Different threat models can be used to customize the sources used in an analysis. For more information, see ":ref:`Threat models <threat-models>`."
64+
- ``sourceModel(package, type, subtypes, name, signature, ext, output, kind, provenance)``. This is used to model sources of potentially tainted data. The ``kind`` of the sources defined using this predicate determine which threat model they are associated with. Different threat models can be used to customize the sources used in an analysis. For more information, see ":ref:`Threat models <threat-models-java>`."
6565
- ``sinkModel(package, type, subtypes, name, signature, ext, input, kind, provenance)``. This is used to model sinks where tainted data maybe used in a way that makes the code vulnerable.
6666
- ``summaryModel(package, type, subtypes, name, signature, ext, input, output, kind, provenance)``. This is used to model flow through elements.
6767
- ``neutralModel(package, type, name, signature, kind, provenance)``. This is similar to a summary model but used to model the flow of values that have only a minor impact on the dataflow analysis.
@@ -151,7 +151,7 @@ The sixth value should be left empty and is out of scope for this documentation.
151151
The remaining values are used to define the ``access path``, the ``kind``, and the ``provenance`` (origin) of the source.
152152

153153
- The seventh value ``ReturnValue`` is the access path to the return of the method, which means that it is the return value that should be considered a source of tainted input.
154-
- The eighth value ``remote`` is the kind of the source. The source kind is used to define the threat model where the source is in scope. ``remote`` applies to many of the security related queries as it means a remote source of untrusted data. As an example the SQL injection query uses ``remote`` sources. For more information, see ":ref:`Threat models <threat-models>`."
154+
- The eighth value ``remote`` is the kind of the source. The source kind is used to define the threat model where the source is in scope. ``remote`` applies to many of the security related queries as it means a remote source of untrusted data. As an example the SQL injection query uses ``remote`` sources. For more information, see ":ref:`Threat models <threat-models-java>`."
155155
- The ninth value ``manual`` is the provenance of the source, which is used to identify the origin of the source.
156156

157157
Example: Add flow through the ``concat`` method
@@ -292,7 +292,7 @@ The first four values identify the callable (in this case a method) to be modele
292292
- The fifth value ``summary`` is the kind of the neutral.
293293
- The sixth value ``manual`` is the provenance of the neutral.
294294

295-
.. _threat-models:
295+
.. _threat-models-java:
296296

297297
Threat models
298298
-------------

0 commit comments

Comments
 (0)