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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46d66595c5fc521aed6fb6289b527cc7d2ab5a5cb5a4237294d2a0dc209a0362 |
|
MD5 | 0cf76f1f6911127ec256c091d61365fb |
|
BLAKE2b-256 | 52527ae915fcd403d708ede68e2d9bc7a5b893ffea6afe6ab8ef332f5ea0a03f |
Hashes for mitmproxy_wireguard-0.1.4-cp37-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 823d1dc847a37e09dfa0ca96d6533f8a1a3ef4c97e325735a09701fb3493ade7 |
|
MD5 | 96304dc638dceadf1e92b391baf2109f |
|
BLAKE2b-256 | ff04f7618e860018f4b1fc7ca81150a2ea8f72947762a67af4effd219de121aa |
Hashes for mitmproxy_wireguard-0.1.4-cp37-abi3-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 154ffff7081023ae86cecea8d35e43ae371a6f1f2e1150862a0abb2b8d2fff2e |
|
MD5 | 5ecd6eb83d08c3f0a42d726b1243e6ff |
|
BLAKE2b-256 | 0b19b0ae964cbc7d9294adad70b49a98959d9d83ef9d1578ae08879c0222b8a6 |
Hashes for mitmproxy_wireguard-0.1.4-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa2ed5e85664c34d99b7f15e189cc803d8fe3da47a491d18151c61f1bb049024 |
|
MD5 | fd9df8c384891c01dc51954be7e73fe6 |
|
BLAKE2b-256 | 1b64975c621604d430b0aa6c7ea86b2c236ec684fb8f355d4ba2f78f07a4f6d6 |
Hashes for mitmproxy_wireguard-0.1.4-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67234c71ebc95a7b56c30863788f0452a50f73f8389219aa03057317d4d45ec9 |
|
MD5 | 1d8c3efe656440af5d066714fd074567 |
|
BLAKE2b-256 | 13193e28f1656122e4fd7c9047dd9ba23727bc7dd999fc6d9c6879ada04baa48 |