Skip to content

Commit 6fbae45

Browse files
Update qldoc
1 parent 6a1e26c commit 6fbae45

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

python/ql/lib/semmle/python/frameworks/Websockets.qll

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,27 +41,28 @@ module Websockets {
4141
override string getFramework() { result = "websockets" }
4242
}
4343

44+
/** Provides taint models for instances of `ServerConnection` objects passed to websocket handlers. */
4445
module ServerConnection {
4546
/**
46-
* A source of instances of `websockets.asyncio.ServerConnection` and `websockets.threading.ServerConnection`, extend this class to model new instances.
47+
* A source of instances of `websockets.asyncio.ServerConnection` and `websockets.sync.ServerConnection`, extend this class to model new instances.
4748
*
4849
* This can include instantiations of the class, return values from function
4950
* calls, or a special parameter that will be set when functions are called by an external
5051
* library.
5152
*
52-
* Use the predicate `WebSocket::instance()` to get references to instances of `websockets.asyncio.ServerConnection` and `websockets.threading.ServerConnection`.
53+
* Use the predicate `WebSocket::instance()` to get references to instances of `websockets.asyncio.ServerConnection` and `websockets.sync.ServerConnection`.
5354
*/
5455
abstract class InstanceSource extends DataFlow::LocalSourceNode { }
5556

56-
/** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.threading.ServerConnection`. */
57+
/** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.sync.ServerConnection`. */
5758
private DataFlow::TypeTrackingNode instance(DataFlow::TypeTracker t) {
5859
t.start() and
5960
result instanceof InstanceSource
6061
or
6162
exists(DataFlow::TypeTracker t2 | result = instance(t2).track(t2, t))
6263
}
6364

64-
/** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.threading.ServerConnection`. */
65+
/** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.sync.ServerConnection`. */
6566
DataFlow::Node instance() { instance(DataFlow::TypeTracker::end()).flowsTo(result) }
6667

6768
private class HandlerParam extends DataFlow::Node, InstanceSource {

0 commit comments

Comments
 (0)