proxy.http package

Subpackages

• proxy.http.exception package
  • Submodules
    • proxy.http.exception.base module
      • proxy.py
    • proxy.http.exception.http_request_rejected module
      • proxy.py
    • proxy.http.exception.proxy_auth_failed module
      • proxy.py
    • proxy.http.exception.proxy_conn_failed module
      • proxy.py
  • Module contents
    • proxy.py
• proxy.http.inspector package
  • Submodules
    • proxy.http.inspector.devtools module
      • proxy.py
    • proxy.http.inspector.inspect_traffic module
      • proxy.py
    • proxy.http.inspector.transformer module
      • proxy.py
  • Module contents
    • proxy.py
• proxy.http.parser package
  • Submodules
    • proxy.http.parser.chunk module
      • proxy.py
    • proxy.http.parser.parser module
      • proxy.py
    • proxy.http.parser.protocol module
      • proxy.py
    • proxy.http.parser.types module
      • proxy.py
  • Module contents
    • proxy.py
• proxy.http.proxy package
  • Submodules
    • proxy.http.proxy.auth module
      • proxy.py
    • proxy.http.proxy.plugin module
      • proxy.py
    • proxy.http.proxy.server module
      • proxy.py
  • Module contents
    • proxy.py
• 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
• 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

Submodules

• proxy.http.client module
  • proxy.py
• proxy.http.codes module
  • proxy.py
• proxy.http.connection module
  • proxy.py
• proxy.http.descriptors module
  • proxy.py
• proxy.http.handler module
  • proxy.py
• proxy.http.headers module
  • proxy.py
• proxy.http.methods module
  • proxy.py
• proxy.http.plugin module
  • proxy.py
• proxy.http.protocols module
  • proxy.py
• proxy.http.responses module
  • proxy.py
• proxy.http.url 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.HttpClientConnection(conn: Union[ssl.SSLSocket, socket.socket], addr: Optional[Tuple[str, int]] = None)

Bases: proxy.core.connection.client.TcpClientConnection

_abc_impl = <_abc._abc_data object>

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

Bases: proxy.core.base.tcp_server.BaseTcpServerHandler[proxy.http.connection.HttpClientConnection]

HTTP, HTTPS, HTTP2, WebSockets protocol handler.

Accepts Client connection and delegates to HttpProtocolHandlerPlugin.

_abc_impl = <_abc._abc_data object>

_connection_inactive_for() → float

_discover_plugin_klass(protocol: int) → Optional[Type[proxy.http.plugin.HttpProtocolHandlerPlugin]]

Discovers and return matching HTTP handler plugin matching protocol.

_flush() → None

_initialize_plugin(klass: Type[proxy.http.plugin.HttpProtocolHandlerPlugin]) → proxy.http.plugin.HttpProtocolHandlerPlugin

Initializes passed HTTP protocol handler plugin class.

_parse_first_request(data: memoryview) → bool

async _run_once() → bool

async _selected_events() → Tuple[Dict[int, int], List[int], List[int]]

static create(*args: Any) → proxy.http.connection.HttpClientConnection

Implementations are responsible for creation of work objects from incoming args. This helps keep work core agnostic to creation of externally defined work class objects.

async get_events() → Dict[int, int]

Return sockets and events (read or write) that we are interested in.

handle_data(data: memoryview) → Optional[bool]

Handles incoming data from client.

async handle_events(readables: List[int], writables: List[int]) → bool

Returns True if proxy must tear down.

async handle_readables(readables: List[int]) → bool

async handle_writables(writables: List[int]) → bool

initialize() → None

Optionally upgrades connection to HTTPS, sets conn in non-blocking mode and initializes HTTP protocol plugins.

is_inactive() → bool

Return True if connection should be considered inactive.

run() → None

run() method is not used when in –threadless mode.

This is here just to maintain backward compatibility with threaded mode.

shutdown() → None

Implementation must close any opened resources here and call super().shutdown().

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

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

Base HttpProtocolHandler Plugin class.

NOTE: This is an internal plugin and in most cases only useful for core contributors. If you are looking for proxy server plugins see <proxy.HttpProxyBasePlugin>.

Implements various lifecycle events for an accepted client connection. Following events are of interest:

1. Client Connection Accepted A new plugin instance is created per accepted client connection. Add your logic within __init__ constructor for any per connection setup.

2. Client Request Chunk Received on_client_data is called for every chunk of data sent by the client.

3. Client Request Complete on_request_complete is called once client request has completed.

4. Server Response Chunk Received on_response_chunk is called for every chunk received from the server.

5. Client Connection Closed Add your logic within on_client_connection_close for any per connection tear-down.

_abc_impl = <_abc._abc_data object>

abstract on_client_connection_close() → None

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

abstract on_client_data(raw: memoryview) → None

Called only after original request has been completely received.

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

Called right after client request parser has reached COMPLETE state.

abstract 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.

abstract static protocols() → List[int]

property tls_interception_enabled: bool

class proxy.http.Url(scheme: Optional[bytes] = None, username: Optional[bytes] = None, password: Optional[bytes] = None, hostname: Optional[bytes] = None, port: Optional[int] = None, remainder: Optional[bytes] = None)

Bases: object

urllib.urlparse doesn’t work for proxy.py, so we wrote a simple URL.

Currently, URL only implements what is necessary for HttpParser to work.

static _parse(raw: bytes) → Tuple[Optional[bytes], Optional[bytes], bytes, Optional[int]]

classmethod from_bytes(raw: bytes, allowed_url_schemes: Optional[List[bytes]] = None) → proxy.http.url.Url

A URL within proxy.py core can have several styles, because proxy.py supports both proxy and web server use cases.

Example: For a Web server, url is like / or /get or /get?key=value For a HTTPS connect tunnel, url is like httpbin.org:443 For a HTTP proxy request, url is like http://httpbin.org/get

proxy.py internally never expects a https scheme in the request line. But Url class provides support for parsing any scheme present in the URLs. e.g. ftp, icap etc.

If a url with no scheme is parsed, e.g. //host/abc.js, then scheme defaults to http.

Further: 1) URL may contain unicode characters 2) URL may contain IPv4 and IPv6 format addresses instead of domain names

property has_credentials: bool

Returns true if both username and password components are present.