mmproxy-rs

A Rust implementation of MMProxy! 🚀

License: MIT crates.io

Rationale

Many previous implementations only support PROXY Protocol for either TCP or UDP, whereas this version supports both TCP and UDP.

Another reason to choose mmproxy-rs may be if you want to avoid interference from Garbage Collection pauses, which is what originally triggered the re-write from the amazing go-mmproxy.

Features

Requirements

Install Rust with rustup if you haven't already.

sh $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh $ cargo --version

Installation

From git: sh cargo install --git https://github.com/saiko-tech/mmproxy-rs

From crates.io sh cargo install mmproxy

Usage

``` Usage: mmproxy [-h] [options]

Options: -h, --help Prints the help string. -4, --ipv4 Address to which IPv4 traffic will be forwarded to. (default: "127.0.0.1:443") -6, --ipv6 Address to which IPv6 traffic will be forwarded to. (default: "[::1]:443")

-a, --allowed-subnets Path to a file that contains allowed subnets of the proxy servers.

-c, --close-after Number of seconds after which UDP socket will be cleaned up. (default: 60)

-l, --listen-addr Address the proxy listens on. (default: "0.0.0.0:8443")

--listeners Number of listener sockets that will be opened for the listen address. (Linux 3.9+) (default: 1) -p, --protocol

Protocol that will be proxied: tcp, udp. (default: tcp) -m, --mark The mark that will be set on outbound packets. (default: 0) ```

Example

You'll need root permissions or CAP_NET_ADMIN capability set on the mmproxy binary with setcap(8).

sh address=X.X.X.X # get this via "ip addr" command - don't use 0.0.0.0! bind_port=8080 upstream_port=8081 sudo ip rule add from 127.0.0.1/8 iif lo table 123 sudo ip route add local 0.0.0.0/0 dev lo table 123 sudo mmproxy -m 123 -l $address:$bind_port -4 127.0.0.1:$upstream_port -p udp

Benchmarking

Tests were run on a Linux 6.0.12-arch1-1 box with an AMD Ryzen 5 5600H @ 3.3GHz (12 logical cores).

TCP mode

Setup

bpf-echo server simulated the upstream service that the proxy sent traffic to. The traffic was generated using tcpkali.

The following command was used to generate load:

sh tcpkali -c 50 -T 10s -e1 'PROXY TCP4 127.0.0.1 127.0.0.1 \{connection.uid} 25578\r\n' -m 'PING\r\n' 127.0.0.1:1122

which specifies 50 concurrent connections, a runtime of 10 seconds, sending a PROXYv1 header for each connection, and using the message PING\r\n over TCP.

Results

| | ↓ Mbps | ↑ Mbps | ↓ pkt/s | ↑ pkt/s | | ---------- | --------- | --------- | --------- | --------- | | no-proxy | 34662.036 | 53945.378 | 3173626.3 | 4630027.6 | | go-mmproxy | 27527.743 | 44128.818 | 2520408.4 | 3787491.3 | | mmproxy-rs | 27228.169 | 50173.384 | 2492924.1 | 4306284.7 |

UDP Mode

Setup

iperf client -> udppp -> mmproxy-rs/go-mmproxy -> iperf server

``` $ udppp -m 1 -l 25578 -r 25577 -h "127.0.0.1" -b "127.0.0.1" -p // udppp

mmproxy -l "127.0.0.1:25577" -4 "127.0.0.1:1122" -p udp -c 1 // mmproxy-rs

mmproxy -l "127.0.0.1:25577" -4 "127.0.0.1:1122" -p udp -close-after 1 // go-mmproxy

$ iperf -sup 1122 // iperf server $ iperf -c 127.0.0.1 -p 25578 -Rub 10G // iperf client ```

Results

| | transfer | bandwidth | |------------|-------------|----------------| | no-proxy | 6.31 GBytes | 5.42 Gbits/sec | | go-mmproxy | 3.13 GBytes | 2.69 Gbits/sec | | mmproxy-rs | 3.70 GBytes | 3.18 Gbits/sec |

The iperf test was run in reverse mode, with the server sending data to the client. The results suggest that mmproxy-rs has higher throughput from upstream to downstream compared to go-mmproxy.

Acknowledgements and References