Skip to content

Commit 62f15d0

Browse files
authored
Merge pull request #21742 from owen-mc/docs/fixes
Docs: several minor fixes
2 parents f912731 + b47afaf commit 62f15d0

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

docs/codeql/codeql-language-guides/customizing-library-models-for-go.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ The first five values identify the function to be modeled as a summary.
223223
- The first value ``slices`` is the package name.
224224
- The second value ``""`` is left blank, since the function is not a method of a type.
225225
- The third value ``False`` is a flag that indicates whether or not the model also applies to subtypes. This has no effect for non-method functions.
226-
- The fourth value ``Max`` is the function name.
226+
- The fourth value ``Concat`` is the function name.
227227
- The fifth value ``""`` is the input type signature. For Go it should always be an empty string. It is needed for other languages where multiple functions may have the same name and they need to be distinguished by the number and types of the arguments.
228228

229229
The sixth value should be left empty and is out of scope for this documentation.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ The CodeQL library for Java and Kotlin analysis exposes the following extensible
6363
- ``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>`."
6464
- ``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.
6565
- ``summaryModel(package, type, subtypes, name, signature, ext, input, output, kind, provenance)``. This is used to model flow through elements.
66-
- ``barrierModel(namespace, type, subtypes, name, signature, ext, output, kind, provenance)``. This is used to model barriers, which are elements that stop the flow of taint.
67-
- ``barrierGuardModel(namespace, type, subtypes, name, signature, ext, input, acceptingValue, kind, provenance)``. This is used to model barrier guards, which are elements that can stop the flow of taint depending on a conditional check.
66+
- ``barrierModel(package, type, subtypes, name, signature, ext, output, kind, provenance)``. This is used to model barriers, which are elements that stop the flow of taint.
67+
- ``barrierGuardModel(package, type, subtypes, name, signature, ext, input, acceptingValue, kind, provenance)``. This is used to model barrier guards, which are elements that can stop the flow of taint depending on a conditional check.
6868
- ``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. Manual neutral models (those with a provenance such as ``manual`` or ``ai-manual``) override generated summary models (those with a provenance such as ``df-generated``) so that the summary will be ignored. Other than that, neutral models have a slight impact on the dataflow dispatch logic, which is out of scope for this documentation.
6969

7070
The extensible predicates are populated using the models defined in data extension files.

docs/codeql/codeql-language-guides/customizing-library-models-for-javascript.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ We need to add a tuple to the ``sourceModel(type, path, kind)`` extensible predi
381381
- The first column, ``"@example/middleware"``, begins the search at imports of the hypothetical NPM package ``@example/middleware``.
382382
- ``Member[injectData]`` selects accesses to the ``injectData`` member.
383383
- ``ReturnValue`` selects the return value of the call to ``injectData``.
384-
- ``GuardedRouteHandler`` interprets the current value as a middleware function and selects all route handlers guarded by that middleware. Since the current value is passd to ``app.use()``, the callback subsequently passed to ``app.get()`` is seen as a guarded route handler.
384+
- ``GuardedRouteHandler`` interprets the current value as a middleware function and selects all route handlers guarded by that middleware. Since the current value is passed to ``app.use()``, the callback subsequently passed to ``app.get()`` is seen as a guarded route handler.
385385
- ``Parameter[0]`` selects the first parameter of the callback (the parameter named ``req``).
386386
- ``Member[data]`` selects accesses to the ``data`` property of the ``req`` object.
387387
- Finally, the kind ``remote`` indicates that this is considered a source of remote flow.

docs/codeql/codeql-language-guides/customizing-library-models-for-ruby.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ We need to add a tuple to the ``sinkModel(type, path, kind)`` extensible predica
5656
5757
5858
- The first column, ``"TTY::Command"``, identifies a set of values from which to begin the search for the sink.
59-
The string ``"TTY::Command""`` means we start at the places where the codebase constructs instances of the class ``TTY::Command``.
59+
The string ``"TTY::Command"`` means we start at the places where the codebase constructs instances of the class ``TTY::Command``.
6060
- The second column is an access path that is evaluated from left to right, starting at the values that were identified by the first column.
6161

6262
- ``Method[run]`` selects calls to the ``run`` method of the ``TTY::Command`` class.

0 commit comments

Comments
 (0)