Skip to content

Commit 38acfcf

Browse files
committed
C++: Doc tweaks addressing review comments.
1 parent 7aec488 commit 38acfcf

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,11 @@ The first five values identify the callable (in this case a free function) to be
9696
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``read_until``.
9797

9898
The sixth value should be left empty and is out of scope for this documentation.
99-
The remaining values are used to define the ``access path``, the ``kind``, and the ``provenance`` (origin) of the source.
99+
The remaining values are used to define the output specification, the ``kind``, and the ``provenance`` (origin) of the source.
100100

101-
- The seventh value ``"Argument[*1]"`` is the ``access path``, which means that the sink is the first indirection (or pointed-to value, ``*``) of the second argument (``Argument[1]``) passed to the function.
101+
- The seventh value ``"Argument[*1]"`` is the output specification, which means in this case that the sink is the first indirection (or pointed-to value, ``*``) of the second argument (``Argument[1]``) passed to the function.
102102
- 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. For more information, see ":ref:`Threat models <threat-models-cpp>`."
103-
- The ninth value ``"manual"`` is the provenance of the source, which is used to identify the origin of the source.
103+
- The ninth value ``"manual"`` is the provenance of the source, which is used to identify the origin of the source model.
104104

105105
Example: Taint sink in the ``boost::asio`` namespace
106106
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -132,11 +132,11 @@ The first five values identify the callable (in this case a free function) to be
132132
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``write``.
133133

134134
The sixth value should be left empty and is out of scope for this documentation.
135-
The remaining values are used to define the ``access path``, the ``kind``, and the ``provenance`` (origin) of the sink.
135+
The remaining values are used to define the output specification, the ``kind``, and the ``provenance`` (origin) of the sink.
136136

137-
- The seventh value ``"Argument[*1]"`` is the ``access path``, which means that the sink is the first indirection (or pointed-to value, ``*``) of the second argument (``Argument[1]``) passed to the function.
137+
- The seventh value ``"Argument[*1]"`` is the output specification, which means in this case that the sink is the first indirection (or pointed-to value, ``*``) of the second argument (``Argument[1]``) passed to the function.
138138
- The eighth value ``"remote-sink"`` is the kind of the sink. The sink kind is used to define the queries where the sink is in scope.
139-
- The ninth value ``"manual"`` is the provenance of the sink, which is used to identify the origin of the sink.
139+
- The ninth value ``"manual"`` is the provenance of the sink, which is used to identify the origin of the sink model.
140140

141141
Example: Add flow through the ``boost::asio::buffer`` method
142142
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -169,12 +169,12 @@ The first five values identify the callable (in this case free function) to be m
169169
- The fifth value is the function input type signature, which can be used to narrow down between functions that have the same name. In this case, we want the model to include all functions in ``boost::asio`` called ``buffer``.
170170

171171
The sixth value should be left empty and is out of scope for this documentation.
172-
The remaining values are used to define the ``access path``, the ``kind``, and the ``provenance`` (origin) of the summary.
172+
The remaining values are used to define the input and output specifications, the ``kind``, and the ``provenance`` (origin) of the summary.
173173

174-
- The seventh value is the access path to the input (where data flows from). ``Argument[*0]`` is the access path to the first indirection (or pointed-to value, ``*``) of the first argument (``Argument[0]``) passed to the function.
175-
- The eighth value ``"ReturnValue"`` is the access path to the output (where data flows to), in this case the return value.
174+
- The seventh value is the input specification (where data flows from). ``Argument[*0]`` specifies the first indirection (or pointed-to value, ``*``) of the first argument (``Argument[0]``) passed to the function.
175+
- The eighth value ``"ReturnValue"`` is the output specification (where data flows to), in this case the return value.
176176
- The ninth value ``"taint"`` is the kind of the flow. ``taint`` means that taint is propagated through the call.
177-
- The tenth value ``"manual"`` is the provenance of the summary, which is used to identify the origin of the summary.
177+
- The tenth value ``"manual"`` is the provenance of the summary, which is used to identify the origin of the summary model.
178178

179179
.. _threat-models-cpp:
180180

0 commit comments

Comments
 (0)