Skip to content

Commit 6afdaa3

Browse files
committed
Java: Address review comments.
1 parent aba7d84 commit 6afdaa3

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ The first five values identify the callable (in this case a method) to be modele
126126
- The fourth value **getInputStream** is the method name.
127127
- The fifth value **()** is the method input type signature.
128128

129-
For most practical purposes the sixth value is not relevant.
129+
The sixth value is only relevant internally and can be omitted in most use cases.
130130
The remaining values are used to define the **access path**, the **kind**, and the **provenance** (origin) of the source.
131131

132132
- 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.
@@ -173,7 +173,7 @@ These are the same for both of the rows above as we are adding two summaries for
173173
- The fourth value **concat** is the method name.
174174
- The fifth value **(String)** is the method input type signature.
175175

176-
For most practical purposes the sixth value is not relevant.
176+
The sixth value is only relevant internally and can be omitted in most use cases.
177177
The remaining values are used to define the **access path**, the **kind**, and the **provenance** (origin) of the summary.
178178

179179
- The seventh value is the access path to the input (where data flows from). **Argument[-1]** is the access path to the qualifier (**s1** in the example) and **Argument[0]** is the access path to the first argument (**s2** in the example).
@@ -219,7 +219,7 @@ These are the same for both of the rows above as we are adding two summaries for
219219
- The fourth value **map** is the method name.
220220
- The fifth value **Function** is the method input type signature.
221221

222-
For most practical purposes the sixth value is not relevant.
222+
The sixth value is only relevant internally and can be omitted in most use cases.
223223
The remaining values are used to define the **access path**, the **kind**, and the **provenance** (origin) of the summary definition.
224224

225225
- The seventh value is the access path to the **input** (where data flows from).
@@ -361,6 +361,7 @@ The following sink kinds are supported:
361361
- **bean-validation**: ?
362362
- **ssti**: ?
363363
- **fragment-injection**: ?
364+
- **regex-use[**\ `arg`\ **]**: ?
364365

365366
summaryModel(package, type, subtypes, name, signature, ext, input, output, kind, provenance)
366367
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -380,7 +381,7 @@ The following kinds are supported:
380381
neutralModel(package, type, name, signature, provenance)
381382
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
382383

383-
No flow. This extensible predicate is used to model elements without flow.
384+
This extensible predicate is not typically needed externally, but included here for completeness.
384385

385386
- **provenance**: Provenance (origin) of the flow through.
386387

@@ -400,6 +401,7 @@ The following components are supported:
400401
- **ReturnValue** selects the return value.
401402
- **Field[**\ `name`\ **]** selects the field with the fully qualified name `name`.
402403
- **SyntheticField[**\ `name`\ **]** selects the synthetic field with name `name`.
404+
- **SyntheticGlobal[**\ `name`\ **]** selects the synthetic global with name `name`.
403405
- **ArrayElement** selects the elements of an array.
404406
- **Element** selects the elements of a collection-like container.
405407
- **MapKey** selects the element keys of a map.
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
.. _data-extensions:
22

33
Data Extensions
4-
===============
4+
===============
5+
6+
.. pull-quote::
7+
8+
Beta Notice - Internal documentation
9+
10+
Data extensions are documented internally in a Google doc.

0 commit comments

Comments
 (0)