Skip to content

Commit e09975f

Browse files
committed
JS: Replace 'remote-flow' kind with 'remote'
1 parent c2a10a3 commit e09975f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ This source is already known by the CodeQL JS analysis, but we'll show how it co
8989
- [
9090
"global",
9191
"Member[addEventListener].Argument[1].Parameter[0].Member[data]",
92-
"remote-flow",
92+
"remote",
9393
]
9494
9595
To break this down:
@@ -100,7 +100,7 @@ To break this down:
100100
- **Argument[1]** selects the second argument of calls to that member (the argument containing the callback).
101101
- **Parameter[0]** selects the first parameter of the callback (the parameter named **event**).
102102
- **Member[data]** selects accesses to the **data** property of the event object.
103-
- Finally, the kind **remote-flow** indicates that this is considered a source of remote flow.
103+
- Finally, the kind **remote** indicates that this is considered a source of remote flow.
104104

105105
Continued example: Restricting the event type
106106
---------------------------------------------
@@ -127,7 +127,7 @@ We can refine the model by adding the **WithStringArgument** component to restri
127127
- [
128128
"global",
129129
"Member[addEventListener].WithStringArgument[0=message].Argument[1].Parameter[0].Member[data]",
130-
"remote-flow",
130+
"remote",
131131
]
132132
133133
The **WithStringArgument[0=message]** component here selects the subset of calls to **addEventListener** where the first argument is a string literal with the value **"message"**.
@@ -308,7 +308,7 @@ Adds a new taint source. Most taint-tracking queries will use the new source.
308308

309309
- **type**: Name of a type from which to evaluate **path**.
310310
- **path**: Access path leading to the source.
311-
- **kind**: Kind of source to add. Currently only **remote-flow** is used.
311+
- **kind**: Kind of source to add. Currently only **remote** is used.
312312

313313
Example:
314314

@@ -319,7 +319,7 @@ Example:
319319
pack: codeql/javascript-all
320320
extensible: sourceModel
321321
data:
322-
- ["global", "Member[user].Member[name]", "remote-flow"]
322+
- ["global", "Member[user].Member[name]", "remote"]
323323
324324
sinkModel(type, path, kind)
325325
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -447,7 +447,7 @@ Kinds
447447
Source kinds
448448
~~~~~~~~~~~~
449449

450-
- **remote-flow**: A generic source of remote flow. Most taint-tracking queries will use such a source. Currently this is the only supported source kind.
450+
- **remote**: A generic source of remote flow. Most taint-tracking queries will use such a source. Currently this is the only supported source kind.
451451

452452
Sink kinds
453453
~~~~~~~~~~

0 commit comments

Comments
 (0)