WireGuard interface for mitmproxy
Project description
mitmproxy_wireguard
Transparently proxy any device that can be configured as a WireGuard client!
Work-In-Progress.
Interface
The API interface of the PyO3 module is documented in mitmproxy_wireguard.pyi
:
Server
class: a running WireGuard server instance, with methods for- graceful shutdown (
close
/wait_closed
) - sending UDP packets
- graceful shutdown (
TcpStream
class: an established TCP connection (provides APIs identical to Python's)asyncio.StreamReader
andasyncio.StreamWriter
)start_server
coroutine: initialize, start, and return aServer
instance
Architecture
DONE
- multi-threaded / asynchronous WireGuard server using tokio:
- one worker thread for the user-space WireGuard server
- one worker thread for the user-space network stack
- one worker thread for communicating with the Python runtime
- basic TCP/IPv4 functionality, IPv6 only partially supported
- basic UDP functionality
- Python interface similar to the one provided by
asyncio.start_server
- basic support for reading WireGuard configuration files
TODO
- better and more complete IPv6 support
- unit tests
- various other
TODO
andFIXME
items (documented in the code)
Hacking
Setting up the development environment is relatively straightforward, as only a Rust toolchain and Python 3 are required:
# set up a new venv
python3 -m venv venv
# enter venv (use the activation script for your shell)
source ./venv/bin/activate
# install maturin and pdoc
pip install maturin pdoc
Compiling the native Rust module then becomes easy:
# compile native Rust module and install it in venv
maturin develop
# compile native Rust module with optimizations
maturin develop --release
Once that's done (phew! Rust sure does take a while to compile!), the test echo server should work correctly. It will print instructions for connecting to it over a WireGuard VPN:
python3 ./echo_test_server.py
Docs
Documentation for the Python module can be built with pdoc
.
The documentation is built from the mitmproxy_wireguard.pyi
type stubs and the
rustdoc documentation strings themselves. So to generate the documentation, the
native module needs to be rebuilt, as well:
maturin develop
pdoc mitmproxy_wireguard
By default, this will build the documentation in HTML format and serve it on http://localhost:8080.
Note: This requires version >=11.2.0
of pdoc. It is the first version that
supports generating documentation for "native-only" Python modules (like our
mitmproxy_wireguard
PyO3 module).
Introspecting the tokio runtime
The asynchronous runtime can be introspected using tokio-console
if the crate
was built with the tracing
feature:
tokio-console http://localhost:6669
There should be no task that is busy when the program is idle, i.e. there should be no busy waiting.
Note: This requires maturin>=0.12.15
, as earlier versions accidentally
clobbered the RUSTFLAGS
that were passed to the Rust compiler, breaking use
of the console_subscriber
for tokio-console
, which requires using the
--cfg tokio_unstable
flag.
Code style
The format for Rust code is enforced by rustfmt.toml
. Some used configuration
options are only available on nightly Rust. To apply the formatting rules, use:
cargo +nightly fmt
The format for Python code (i.e. the test echo server and the type stubs in
mitmproxy_wireguard.pyi
) is enforced with black
and can be applied with:
black echo_test_server.py mitmproxy_wireguard.pyi benches/*.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for mitmproxy_wireguard-0.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e59e034329d5e0c55985061d27edf296e7597f805257c9b012be838c3d67c847 |
|
MD5 | 281bf276d9e0ccca3c86f21c3a0ab045 |
|
BLAKE2b-256 | 37305f529d68f183587433d4744c611efcea87b35a322a6d7902d7c2bdc304d7 |
Hashes for mitmproxy_wireguard-0.1.6-cp37-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b94a753bd448c7c2122561003ee59fa59eaa78de2d375bdaf6596ed95ea31319 |
|
MD5 | b1b6ca24dd706523ae688fc0faf9aee2 |
|
BLAKE2b-256 | ff907bc18eaced5cfc01526810e6e9a76309c93bb797293dac28d2625edf8970 |
Hashes for mitmproxy_wireguard-0.1.6-cp37-abi3-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb9251a421b2bb6d9b6dac71f257f732afb77fddd483bd0be70d8b3f41b2d1bb |
|
MD5 | d2bd0fba2e7758390a5f0c7bcdf80793 |
|
BLAKE2b-256 | a32018b5c448f8e9a8eed0ca0dbff045d8e30f8ffba0cb7e6a9d8ae529330120 |
Hashes for mitmproxy_wireguard-0.1.6-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3572d920bba6605de9722166dd6c64e30b087753f3e491b7580f56a1981cd10 |
|
MD5 | 269726da80bbf4bdb854f9887955fdb0 |
|
BLAKE2b-256 | 2b0dc5b718e4e164872aa679224469686ac2555cf662cbead972a4b734f06cfa |
Hashes for mitmproxy_wireguard-0.1.6-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a41675966b17d5b28aeb6469031f674519cc4358ab1fcaf475147b1b82a25332 |
|
MD5 | 06e279dadfac33991da2f8d9a90a77cc |
|
BLAKE2b-256 | 08bf825d13b0b6af952bb82a5908949fdcd8f55b43e037145b10146fd0db9955 |