proxy package

Subpackages

• proxy.common package
  • Submodules
    • proxy.common._scm_version module
    • proxy.common._version module
      • proxy.py
    • proxy.common.backports module
      • proxy.py
    • proxy.common.constants module
      • proxy.py
    • proxy.common.flag module
      • proxy.py
    • proxy.common.logger module
      • proxy.py
    • proxy.common.pki module
      • proxy.py
    • proxy.common.plugins module
      • proxy.py
    • proxy.common.types module
      • proxy.py
    • proxy.common.utils module
      • proxy.py
    • proxy.common.version module
      • proxy.py
  • Module contents
    • proxy.py
• proxy.core package
  • Subpackages
    • proxy.core.acceptor package
      • Submodules
      • Module contents
    • proxy.core.base package
      • Submodules
      • Module contents
    • proxy.core.connection package
      • Submodules
      • Module contents
    • proxy.core.event package
      • Submodules
      • Module contents
    • proxy.core.listener package
      • Submodules
      • Module contents
    • proxy.core.ssh package
      • Submodules
      • Module contents
    • proxy.core.tls package
      • Submodules
      • Module contents
    • proxy.core.work package
      • Subpackages
      • Submodules
      • Module contents
  • Module contents
    • proxy.py
• proxy.dashboard package
  • Submodules
    • proxy.dashboard.dashboard module
      • proxy.py
  • Module contents
    • proxy.py
• proxy.http package
  • Subpackages
    • proxy.http.exception package
      • Submodules
      • Module contents
    • proxy.http.inspector package
      • Submodules
      • Module contents
    • proxy.http.parser package
      • Submodules
      • Module contents
    • proxy.http.proxy package
      • Submodules
      • Module contents
    • proxy.http.server package
      • Submodules
      • Module contents
    • proxy.http.websocket package
      • Submodules
      • Module contents
  • 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
• proxy.plugin package
  • Submodules
    • proxy.plugin.cloudflare_dns module
      • proxy.py
    • proxy.plugin.custom_dns_resolver module
      • proxy.py
    • proxy.plugin.filter_by_client_ip module
      • proxy.py
    • proxy.plugin.filter_by_upstream module
      • proxy.py
    • proxy.plugin.filter_by_url_regex module
      • proxy.py
    • proxy.plugin.man_in_the_middle module
      • proxy.py
    • proxy.plugin.mock_rest_api module
      • proxy.py
    • proxy.plugin.modify_chunk_response module
      • proxy.py
    • proxy.plugin.modify_post_data module
      • proxy.py
    • proxy.plugin.program_name module
      • proxy.py
    • proxy.plugin.proxy_pool module
      • proxy.py
    • proxy.plugin.redirect_to_custom_server module
      • proxy.py
    • proxy.plugin.reverse_proxy module
      • proxy.py
    • proxy.plugin.shortlink module
      • proxy.py
    • proxy.plugin.web_server_route module
      • proxy.py
  • Module contents
    • proxy.py
• proxy.socks package
  • Submodules
    • proxy.socks.client module
      • proxy.py
    • proxy.socks.handler module
      • proxy.py
    • proxy.socks.operations module
      • proxy.py
    • proxy.socks.packet module
      • proxy.py
  • Module contents
    • proxy.py

Submodules

• proxy.__main__ module
  • proxy.py
• proxy.proxy 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.Proxy(input_args: Optional[List[str]] = None, **opts: Any)

Bases: object

Proxy is a context manager to control proxy.py library core.

By default, AcceptorPool is started with HttpProtocolHandler work class. By definition, it expects HTTP traffic to flow between clients and server.

In --threadless mode and without --local-executor, a ThreadlessPool is also started. Executor pool receives newly accepted work by Acceptor and creates an instance of work class for processing the received work.

In --threadless mode and with --local-executor 0, acceptors will start a companion thread to handle accepted client connections.

Optionally, Proxy class also initializes the EventManager. A multi-process safe pubsub system which can be used to build various patterns for message sharing and/or signaling.

_delete_pid_file() → None

_delete_port_file() → None

static _handle_exit_signal(signum: int, _frame: Any) → None

_handle_siginfo(_signum: int, _frame: Any) → None

_register_signals() → None

static _setup_tunnel(flags: argparse.Namespace, ssh_handler_klass: Type[BaseSshTunnelHandler], ssh_listener_klass: Any, **kwargs: Any) → proxy.core.ssh.base.BaseSshTunnelListener

_write_pid_file() → None

_write_port_file() → None

property remote_executors_enabled: bool

setup() → None

shutdown() → None

class proxy.TestCase(methodName='runTest')

Bases: unittest.case.TestCase

Base TestCase class that automatically setup and tear down proxy.py.

DEFAULT_PROXY_PY_STARTUP_FLAGS = ['--hostname', '127.0.0.1', '--port', '0', '--num-workers', '1', '--num-acceptors', '1']

INPUT_ARGS: Optional[List[str]] = None

PROXY: Optional[proxy.proxy.Proxy] = None

_classSetupFailed = False

_class_cleanups = []

run(result: Optional[unittest.result.TestResult] = None) → Any

classmethod setUpClass() → None

Hook method for setting up class fixture before running tests in the class.

classmethod tearDownClass() → None

Hook method for deconstructing the class fixture after running all tests in the class.

vcr() → Generator[None, None, None]

static wait_for_server(proxy_port: int, wait_for_seconds: float = 10.0) → None

Wait for proxy.py server to come up.

proxy.entry_point() → None

proxy.main(**opts: Any) → None

proxy.sleep_loop(p: Optional[proxy.proxy.Proxy] = None) → None