From 6fbae45d49dcab6a96aee173d2e97f31e313f309 Mon Sep 17 00:00:00 2001 From: Joe Farebrother Date: Mon, 1 Dec 2025 20:14:36 +0000 Subject: [PATCH] Update qldoc --- python/ql/lib/semmle/python/frameworks/Websockets.qll | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/python/ql/lib/semmle/python/frameworks/Websockets.qll b/python/ql/lib/semmle/python/frameworks/Websockets.qll index 88a3e701eea..6690a6ec036 100644 --- a/python/ql/lib/semmle/python/frameworks/Websockets.qll +++ b/python/ql/lib/semmle/python/frameworks/Websockets.qll @@ -41,19 +41,20 @@ module Websockets { override string getFramework() { result = "websockets" } } + /** Provides taint models for instances of `ServerConnection` objects passed to websocket handlers. */ module ServerConnection { /** - * A source of instances of `websockets.asyncio.ServerConnection` and `websockets.threading.ServerConnection`, extend this class to model new instances. + * A source of instances of `websockets.asyncio.ServerConnection` and `websockets.sync.ServerConnection`, extend this class to model new instances. * * This can include instantiations of the class, return values from function * calls, or a special parameter that will be set when functions are called by an external * library. * - * Use the predicate `WebSocket::instance()` to get references to instances of `websockets.asyncio.ServerConnection` and `websockets.threading.ServerConnection`. + * Use the predicate `WebSocket::instance()` to get references to instances of `websockets.asyncio.ServerConnection` and `websockets.sync.ServerConnection`. */ abstract class InstanceSource extends DataFlow::LocalSourceNode { } - /** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.threading.ServerConnection`. */ + /** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.sync.ServerConnection`. */ private DataFlow::TypeTrackingNode instance(DataFlow::TypeTracker t) { t.start() and result instanceof InstanceSource @@ -61,7 +62,7 @@ module Websockets { exists(DataFlow::TypeTracker t2 | result = instance(t2).track(t2, t)) } - /** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.threading.ServerConnection`. */ + /** Gets a reference to an instance of `websockets.asyncio.ServerConnection` or `websockets.sync.ServerConnection`. */ DataFlow::Node instance() { instance(DataFlow::TypeTracker::end()).flowsTo(result) } private class HandlerParam extends DataFlow::Node, InstanceSource {