mitmproxy-rs

0.12.9 · active · verified Fri Apr 10

mitmproxy-rs is a Python library that re-implements the core functionality of the `mitmproxy` project in Rust, providing a high-performance, async-first HTTP/HTTPS proxy. It offers a largely compatible API for programmatic interception and modification of network traffic, targeting Python 3.12 and newer. As of version 0.12.9, it's under active development with frequent minor releases.

Warnings

breaking While aiming for API compatibility, `mitmproxy-rs` is a separate implementation. Some APIs, especially for advanced features or internal structures, may diverge from the original `mitmproxy` library.
Fix: Always consult the `mitmproxy-rs` documentation for specific API usage. Do not assume direct drop-in replacement without verification, especially when migrating from `mitmproxy`.
breaking The generic `Flow` object was split into `HttpFlow` and `TcpFlow` for better type clarity and functionality separation.
Fix: Update type hints and instantiations from `Flow` to `HttpFlow` or `TcpFlow` as appropriate. E.g., `flow: HttpFlow` instead of `flow: Flow`.
breaking The main proxy class was renamed from `Proxy` to `Server` for clearer semantics.
Fix: Replace all instances of `mitmproxy_rs.Proxy(...)` with `mitmproxy_rs.Server(...)`.
breaking The `Mode` enum for proxy operation was renamed to `ProxyMode`.
Fix: Update references from `mitmproxy_rs.Mode` to `mitmproxy_rs.ProxyMode`.
gotcha The library explicitly requires Python 3.12 or newer due to its Rust binding implementation details.
Fix: Ensure your Python environment is version 3.12 or later before installing. Using `pyenv` or virtual environments is recommended for managing Python versions.

Install

pip install mitmproxy-rs Install stable version

Imports

Server
```
from mitmproxy_rs import Server
```
HttpFlow
```
from mitmproxy_rs import HttpFlow
```
The generic `Flow` class was replaced by `HttpFlow` and `TcpFlow` in version 0.12.0.
TcpFlow
```
from mitmproxy_rs import TcpFlow
```
The generic `Flow` class was replaced by `HttpFlow` and `TcpFlow` in version 0.12.0.
ProxyMode
```
from mitmproxy_rs import ProxyMode
```
The `Mode` enum was renamed to `ProxyMode` in version 0.10.0.

Quickstart

This example starts a simple HTTP proxy that listens on `127.0.0.1:8080` and prints the method and URL of every intercepted HTTP request. It showcases the `Server` and `HttpFlow` objects.

import mitmproxy_rs
import asyncio

async def main():
    # A simple HTTP proxy that logs all requests
    async with mitmproxy_rs.Server(listen_host="127.0.0.1", listen_port=8080) as server:
        async for flow in server.run():
            print(f"[{flow.request.method}] {flow.request.pretty_url}")

if __name__ == "__main__":
    asyncio.run(main())

view raw JSON →