proxy.http.server package

Submodules

• proxy.http.server.middleware module
  • proxy.py
• proxy.http.server.pac_plugin module
  • proxy.py
• proxy.http.server.plugin module
  • proxy.py
• proxy.http.server.protocols module
  • proxy.py
• proxy.http.server.reverse module
  • proxy.py
• proxy.http.server.web 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.server.HttpWebServerBasePlugin(uid: str, flags: argparse.Namespace, client: proxy.http.connection.HttpClientConnection, event_queue: proxy.core.event.queue.EventQueue, upstream_conn_pool: Optional[UpstreamConnectionPool] = None)

Bases: proxy.http.descriptors.DescriptorsHandlerMixin, abc.ABC

Web Server Plugin for routing of requests.

_abc_impl = <_abc._abc_data object>

do_upgrade(request: proxy.http.parser.parser.HttpParser) → bool

abstract handle_request(request: proxy.http.parser.parser.HttpParser) → None

Handle the request and serve response.

name() → str

A unique name for your plugin.

Defaults to name of the class. This helps plugin developers to directly access a specific plugin by its name.

on_access_log(context: Dict[str, Any]) → Optional[Dict[str, Any]]

Use this method to override default access log format (see DEFAULT_WEB_ACCESS_LOG_FORMAT) or to add/update/modify passed context for usage by default access logger.

Return updated log context to use for default logging format, OR Return None if plugin has logged the request.

on_client_connection_close() → None

Client has closed the connection, do any clean up task now.

on_client_data(request: proxy.http.parser.parser.HttpParser, raw: memoryview) → Optional[memoryview]

Return None to avoid default webserver parsing of client data.

on_websocket_message(frame: proxy.http.websocket.frame.WebsocketFrame) → None

Handle websocket frame.

on_websocket_open() → None

Called when websocket handshake has finished.

abstract routes() → List[Tuple[int, str]]

Return List(protocol, path) that this plugin handles.

static serve_static_file(path: str, min_compression_length: int) → memoryview

class proxy.http.server.HttpWebServerPacFilePlugin(*args: Any, **kwargs: Any)

Bases: proxy.http.server.plugin.HttpWebServerBasePlugin

_abc_impl = <_abc._abc_data object>

cache_pac_file_response() → None

handle_request(request: proxy.http.parser.parser.HttpParser) → None

Handle the request and serve response.

routes() → List[Tuple[int, str]]

Return List(protocol, path) that this plugin handles.

class proxy.http.server.HttpWebServerPlugin(*args: Any, **kwargs: Any)

Bases: proxy.http.plugin.HttpProtocolHandlerPlugin

HttpProtocolHandler plugin which handles incoming requests to local web server.

_abc_impl = <_abc._abc_data object>

_initialize_web_plugins() → None

property _protocol: Tuple[bool, int]

_try_route(path: bytes) → bool

_try_static_or_404(path: bytes) → None

access_log(context: Dict[str, Any]) → None

encryption_enabled() → bool

async get_descriptors() → Tuple[List[int], List[int]]

Implementations must return a list of descriptions that they wish to read from and write into.

on_client_connection_close() → None

Client connection shutdown has been received, flush has been called, perform any cleanup work here.

on_client_data(raw: memoryview) → None

Called only after original request has been completely received.

on_request_complete() → Union[socket.socket, bool]

Called right after client request parser has reached COMPLETE state.

on_response_chunk(chunk: List[memoryview]) → List[memoryview]

Handle data chunks as received from the server.

Return optionally modified chunk to return back to client.

static protocols() → List[int]

async read_from_descriptors(r: List[int]) → bool

Implementations must now read data over the socket.

switch_to_websocket() → None

async write_to_descriptors(w: List[int]) → bool

Implementations must now write/flush data over the socket.

Note that buffer management is in-build into the connection classes. Hence implementations MUST call flush() here, to send any buffered data over the socket.

class proxy.http.server.ReverseProxyBasePlugin(uid: str, flags: argparse.Namespace, client: proxy.http.connection.HttpClientConnection, event_queue: proxy.core.event.queue.EventQueue, upstream_conn_pool: Optional[UpstreamConnectionPool] = None)

Bases: proxy.http.descriptors.DescriptorsHandlerMixin, abc.ABC

ReverseProxy base plugin class.

_abc_impl = <_abc._abc_data object>

before_routing(request: proxy.http.parser.parser.HttpParser) → Optional[proxy.http.parser.parser.HttpParser]

Plugins can modify request, return response, close connection.

If None is returned, request will be dropped and closed.

handle_route(request: proxy.http.parser.parser.HttpParser, pattern: proxy.common.types.RePattern) → Union[memoryview, proxy.http.url.Url, TcpServerConnection]

Implement this method if you have configured dynamic routes.

on_access_log(context: Dict[str, Any]) → Optional[Dict[str, Any]]

Use this method to override default access log format (see DEFAULT_REVERSE_PROXY_ACCESS_LOG_FORMAT) or to add/update/modify passed context for usage by default access logger.

Return updated log context to use for default logging format, OR Return None if plugin has logged the request.

protocols() → List[int]

regexes() → List[str]

Helper method to return list of route regular expressions.

abstract routes() → List[Union[str, Tuple[str, List[bytes]]]]

List of routes registered by plugin.

There are 2 types of routes:

1. Dynamic routes (str): Should be a regular expression

2. Static routes (tuple): Contain 2 elements, a route regular expression and list of upstream urls to serve when the route matches.

Static routes doesn’t require you to implement the handle_route method. Reverse proxy core will automatically pick one of the configured upstream URL and serve it out-of-box.

Dynamic routes are helpful when you want to dynamically match and serve upstream urls. To handle dynamic routes, you must implement the handle_route method, which must return the url to serve.