proxy.http.websocket package

Submodules

• proxy.http.websocket.client module
  • proxy.py
• proxy.http.websocket.frame module
  • proxy.py
• proxy.http.websocket.plugin module
  • proxy.py
• proxy.http.websocket.transport module
  • proxy.py

Module contents

proxy.py

⚡⚡⚡ Fast, Lightweight, Pluggable, TLS interception capable proxy server focused on Network monitoring, controls & Application development, testing, debugging.

copyright

3. 2013-present by Abhinav Singh and contributors.

license

BSD, see LICENSE for more details.

class proxy.http.websocket.WebSocketTransportBasePlugin(flags: argparse.Namespace, client: HttpClientConnection, event_queue: proxy.core.event.queue.EventQueue)

Bases: abc.ABC

Abstract class for plugins extending dashboard websocket API.

_abc_impl = <_abc._abc_data object>

connected() → None

Invoked when client websocket handshake finishes.

disconnected() → None

Invoked when client websocket connection gets closed.

abstract handle_message(message: Dict[str, Any]) → None

Handle messages for registered methods.

abstract methods() → List[str]

Return list of methods that this plugin will handle.

reply(data: Dict[str, Any]) → None

class proxy.http.websocket.WebsocketClient(hostname: bytes, port: int, path: bytes = b'/', on_message: Optional[Callable[[proxy.http.websocket.frame.WebsocketFrame], None]] = None)

Bases: proxy.core.connection.connection.TcpConnection

Websocket client connection.

TODO: Make me compatible with the work framework.

_abc_impl = <_abc._abc_data object>

property connection: Union[ssl.SSLSocket, socket.socket]

Must return the socket connection to use in this class.

handshake() → None

Start websocket upgrade & handshake protocol

run() → None

run_once() → bool

shutdown(_data: Optional[bytes] = None) → None

Closes connection with the server.

upgrade() → None

Creates a key and sends websocket handshake packet to upstream. Receives response from the server and asserts that websocket accept header is valid in the response.

class proxy.http.websocket.WebsocketFrame

Bases: object

Websocket frames parser and constructor.

GUID = b'258EAFA5-E914-47DA-95CA-C5AB0DC85B11'

static apply_mask(data: bytes, mask: bytes) → bytes

build() → bytes

static key_to_accept(key: bytes) → bytes

parse(raw: bytes) → bytes

parse_fin_and_rsv(byte: int) → None

parse_mask_and_payload(byte: int) → None

reset() → None

classmethod text(data: bytes) → bytes