Compare commits

..

No commits in common. "master" and "v0.2.4" have entirely different histories.

23 changed files with 911 additions and 1955 deletions

View file

@ -1,4 +0,0 @@
[env]
# Each interface needs 1 IP allocated to the WireGuard peer IP.
# "8" = 7 tunnels per protocol.
SMOLTCP_IFACE_MAX_ADDR_COUNT = "8"

View file

@ -1,6 +1,6 @@
#!/bin/sh #!/bin/sh
# brew install asciidoctor brew install asciidoctor
# brew install openssl@1.1 brew install openssl@1.1
# cp /usr/local/opt/openssl@1.1/lib/pkgconfig/*.pc /usr/local/lib/pkgconfig/ cp /usr/local/opt/openssl@1.1/lib/pkgconfig/*.pc /usr/local/lib/pkgconfig/

View file

@ -1,10 +0,0 @@
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "cargo"
directory: "/"
schedule:
interval: "weekly"
rebase-strategy: "disabled"

View file

@ -10,7 +10,7 @@ jobs:
matrix: matrix:
rust: rust:
- stable - stable
- 1.80.0 - 1.55.0
steps: steps:
- name: Checkout sources - name: Checkout sources
uses: actions/checkout@v2 uses: actions/checkout@v2
@ -26,12 +26,6 @@ jobs:
with: with:
command: check command: check
- name: Run cargo check without default features
uses: actions-rs/cargo@v1
with:
command: check
args: --no-default-features
test: test:
name: Test Suite name: Test Suite
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -39,7 +33,7 @@ jobs:
matrix: matrix:
rust: rust:
- stable - stable
- 1.80.0 - 1.55.0
steps: steps:
- name: Checkout sources - name: Checkout sources
uses: actions/checkout@v2 uses: actions/checkout@v2

View file

@ -61,7 +61,7 @@ jobs:
run: echo "${{ env.VERSION }}" > artifacts/release-version run: echo "${{ env.VERSION }}" > artifacts/release-version
- name: Upload artifacts - name: Upload artifacts
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v1
with: with:
name: artifacts name: artifacts
path: artifacts path: artifacts
@ -75,28 +75,20 @@ jobs:
RUST_BACKTRACE: 1 RUST_BACKTRACE: 1
strategy: strategy:
matrix: matrix:
build: [ linux-amd64, linux-aarch64, macos-aarch64, windows ] build: [ linux-amd64, macos-intel, windows ]
include: include:
- build: linux-amd64 - build: linux-amd64
os: ubuntu-latest os: ubuntu-18.04
rust: stable rust: stable
target: x86_64-unknown-linux-musl target: x86_64-unknown-linux-musl
cross: true - build: macos-intel
- build: linux-aarch64
os: ubuntu-latest
rust: stable
target: aarch64-unknown-linux-musl
cross: true
- build: macos-aarch64
os: macos-latest os: macos-latest
rust: stable rust: stable
target: aarch64-apple-darwin target: x86_64-apple-darwin
cross: false
- build: windows - build: windows
os: windows-2019 os: windows-2019
rust: stable rust: stable
target: x86_64-pc-windows-msvc target: x86_64-pc-windows-msvc
cross: false
steps: steps:
- name: Checkout repository - name: Checkout repository
@ -105,7 +97,7 @@ jobs:
fetch-depth: 1 fetch-depth: 1
- name: Install packages (Ubuntu) - name: Install packages (Ubuntu)
if: matrix.os == 'ubuntu-latest' if: matrix.os == 'ubuntu-18.04'
run: | run: |
.github/ci/ubuntu-install-packages .github/ci/ubuntu-install-packages
- name: Install packages (macOS) - name: Install packages (macOS)
@ -121,7 +113,7 @@ jobs:
target: ${{ matrix.target }} target: ${{ matrix.target }}
- name: Get release download URL - name: Get release download URL
uses: actions/download-artifact@v4 uses: actions/download-artifact@v1
with: with:
name: artifacts name: artifacts
path: artifacts path: artifacts
@ -134,24 +126,17 @@ jobs:
echo "release upload url: $release_upload_url" echo "release upload url: $release_upload_url"
- name: Build onetun binary - name: Build onetun binary
shell: bash run: cargo build --release
run: |
if [ "${{ matrix.cross }}" = "true" ]; then
cargo install cross
cross build --release --target ${{ matrix.target }}
else
cargo build --release --target ${{ matrix.target }}
fi
- name: Prepare onetun binary - name: Prepare onetun binary
shell: bash shell: bash
run: | run: |
mkdir -p ci/assets mkdir -p ci/assets
if [ "${{ matrix.build }}" = "windows" ]; then if [ "${{ matrix.build }}" = "windows" ]; then
cp "target/${{ matrix.target }}/release/onetun.exe" "ci/assets/onetun.exe" cp "target/release/onetun.exe" "ci/assets/onetun.exe"
echo "ASSET=onetun.exe" >> $GITHUB_ENV echo "ASSET=onetun.exe" >> $GITHUB_ENV
else else
cp "target/${{ matrix.target }}/release/onetun" "ci/assets/onetun-${{ matrix.build }}" cp "target/release/onetun" "ci/assets/onetun-${{ matrix.build }}"
echo "ASSET=onetun-${{ matrix.build }}" >> $GITHUB_ENV echo "ASSET=onetun-${{ matrix.build }}" >> $GITHUB_ENV
fi fi

2
.gitignore vendored
View file

@ -2,5 +2,3 @@
/.idea /.idea
.envrc .envrc
*.log *.log
*.pcap
.DS_Store

1132
Cargo.lock generated

File diff suppressed because it is too large Load diff

View file

@ -1,48 +1,21 @@
[package] [package]
name = "onetun" name = "onetun"
version = "0.3.10" version = "0.2.4"
edition = "2021" edition = "2018"
license = "MIT"
description = "A cross-platform, user-space WireGuard port-forwarder that requires no system network configurations."
authors = ["Aram Peres <aram.peres@gmail.com>"]
repository = "https://github.com/aramperes/onetun"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
# Required dependencies (bin and lib) boringtun = { git = "https://github.com/cloudflare/boringtun", rev = "fbcf2689e7776a5af805c5a38feb5c8988829980", default-features = false }
boringtun = { version = "0.6.0", default-features = false } clap = { version = "2.33", default-features = false, features = ["suggestions"] }
log = "0.4" log = "0.4"
pretty_env_logger = "0.4"
anyhow = "1" anyhow = "1"
tokio = { version = "1", features = [ "rt", "sync", "io-util", "net", "time", "fs", "macros" ] } smoltcp = { version = "0.8.0", default-features = false, features = ["std", "log", "medium-ip", "proto-ipv4", "proto-ipv6", "socket-udp", "socket-tcp"] }
futures = "0.3" tokio = { version = "1", features = ["full"] }
rand = "0.8" futures = "0.3.17"
rand = "0.8.4"
nom = "7" nom = "7"
async-trait = "0.1" async-trait = "0.1.51"
priority-queue = "2.1" dashmap = "4.0.2"
smoltcp = { version = "0.12", default-features = false, features = [ priority-queue = "1.2.0"
"std",
"log",
"medium-ip",
"proto-ipv4",
"proto-ipv6",
"socket-udp",
"socket-tcp",
] }
bytes = "1"
base64 = "0.13"
# forward boringtuns tracing events to log
tracing = { version = "0.1", default-features = false, features = ["log"] }
# bin-only dependencies
clap = { version = "4.4.11", default-features = false, features = ["suggestions", "std", "env", "help", "wrap_help"], optional = true }
pretty_env_logger = { version = "0.5", optional = true }
async-recursion = "1.0"
[features]
pcap = []
default = [ "bin" ]
bin = [ "clap", "pretty_env_logger", "pcap", "tokio/rt-multi-thread" ]
[lib]

View file

@ -1,11 +1,10 @@
FROM rust:1.82.0 as cargo-build FROM rust:1.55 as cargo-build
WORKDIR /usr/src/onetun WORKDIR /usr/src/onetun
COPY Cargo.toml Cargo.toml COPY Cargo.toml Cargo.toml
# Placeholder to download dependencies and cache them using layering # Placeholder to download dependencies and cache them using layering
RUN mkdir src/ RUN mkdir src/
RUN touch src/lib.rs
RUN echo "fn main() {println!(\"if you see this, the build broke\")}" > src/main.rs RUN echo "fn main() {println!(\"if you see this, the build broke\")}" > src/main.rs
RUN cargo build --release RUN cargo build --release
RUN rm -f target/x86_64-unknown-linux-musl/release/deps/myapp* RUN rm -f target/x86_64-unknown-linux-musl/release/deps/myapp*
@ -15,9 +14,8 @@ COPY . .
RUN cargo build --release RUN cargo build --release
FROM debian:11-slim FROM debian:11-slim
RUN apt-get update \ RUN apt-get update
&& apt-get install dumb-init -y \ RUN apt-get install dumb-init -y
&& rm -rf /var/lib/apt/lists/*
COPY --from=cargo-build /usr/src/onetun/target/release/onetun /usr/local/bin/onetun COPY --from=cargo-build /usr/src/onetun/target/release/onetun /usr/local/bin/onetun

View file

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2025 Aram Peres Copyright (c) 2021 Aram Peres
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

204
README.md
View file

@ -2,48 +2,20 @@
# onetun # onetun
A cross-platform, user-space WireGuard port-forwarder that requires **no root-access or system network configurations**. A cross-platform, user-space WireGuard port-forwarder that requires no system network configurations.
[![crates.io](https://img.shields.io/crates/v/onetun.svg)](https://crates.io/crates/onetun)
[![MIT licensed](https://img.shields.io/crates/l/onetun.svg)](./LICENSE)
[![Build status](https://github.com/aramperes/onetun/actions/workflows/build.yml/badge.svg)](https://github.com/aramperes/onetun/actions) [![Build status](https://github.com/aramperes/onetun/actions/workflows/build.yml/badge.svg)](https://github.com/aramperes/onetun/actions)
[![Latest Release](https://img.shields.io/github/v/tag/aramperes/onetun?label=release)](https://github.com/aramperes/onetun/releases/latest) [![Latest Release](https://img.shields.io/github/v/tag/aramperes/onetun?label=release)](https://github.com/aramperes/onetun/releases/latest)
## Use-case ## Use-case
Access TCP or UDP services running on your WireGuard network, from devices that don't have WireGuard installed. - You have an existing WireGuard endpoint (router), accessible using its UDP endpoint (typically port 51820); and
- You have a peer on the WireGuard network, running a TCP or UDP service on a port accessible to the WireGuard network; and
- You want to access this TCP or UDP service from a second computer, on which you can't install WireGuard because you
can't (no root access) or don't want to (polluting OS configs).
For example, For example, this can be useful to forward a port from a Kubernetes cluster to a server behind WireGuard,
without needing to install WireGuard in a Pod.
- Personal or shared computers where you can't install WireGuard (root)
- IoT and mobile devices
- Root-less containers
## Download
onetun is available to install from [crates.io](https://crates.io/crates/onetun) with Rust ≥1.80.0:
```shell
cargo install onetun
```
You can also download the binary for Windows, macOS (Apple Silicon), and Linux (amd64, arm64) from
the [Releases](https://github.com/aramperes/onetun/releases) page.
You can also run onetun using [Docker](https://hub.docker.com/r/aramperes/onetun):
```shell
docker run --rm --name onetun --user 1000 -p 8080:8080 aramperes/onetun \
0.0.0.0:8080:192.168.4.2:8080 [...options...]
```
You can also build onetun locally, using Rust ≥1.80.0:
```shell
git clone https://github.com/aramperes/onetun && cd onetun
cargo build --release
./target/release/onetun
```
## Usage ## Usage
@ -54,14 +26,14 @@ access, or install any WireGuard tool on your local system for it to work.
The only prerequisite is to register a peer IP and public key on the remote WireGuard endpoint; those are necessary for The only prerequisite is to register a peer IP and public key on the remote WireGuard endpoint; those are necessary for
the WireGuard endpoint to trust the onetun peer and for packets to be routed. the WireGuard endpoint to trust the onetun peer and for packets to be routed.
```shell ```
onetun [src_host:]<src_port>:<dst_host>:<dst_port>[:TCP,UDP,...] [...] \ ./onetun [src_host:]<src_port>:<dst_host>:<dst_port>[:TCP,UDP,...] [...] \
--endpoint-addr <public WireGuard endpoint address> \ --endpoint-addr <public WireGuard endpoint address> \
--endpoint-public-key <the public key of the peer on the endpoint> \ --endpoint-public-key <the public key of the peer on the endpoint> \
--private-key <private key assigned to onetun> \ --private-key <private key assigned to onetun> \
--source-peer-ip <IP assigned to onetun> \ --source-peer-ip <IP assigned to onetun> \
--keep-alive <optional persistent keep-alive in seconds> \ --keep-alive <optional persistent keep-alive in seconds> \
--log <optional log level, defaults to "info"> --log <optional log level, defaults to "info"
``` ```
> Note: you can use environment variables for all of these flags. Use `onetun --help` for details. > Note: you can use environment variables for all of these flags. Use `onetun --help` for details.
@ -70,7 +42,7 @@ onetun [src_host:]<src_port>:<dst_host>:<dst_port>[:TCP,UDP,...] [...] \
Suppose your WireGuard endpoint has the following configuration, and is accessible from `140.30.3.182:51820`: Suppose your WireGuard endpoint has the following configuration, and is accessible from `140.30.3.182:51820`:
```shell ```
# /etc/wireguard/wg0.conf # /etc/wireguard/wg0.conf
[Interface] [Interface]
@ -93,7 +65,7 @@ We want to access a web server on the friendly peer (`192.168.4.2`) on port `808
local port, say `127.0.0.1:8080`, that will tunnel through WireGuard to reach the peer web server: local port, say `127.0.0.1:8080`, that will tunnel through WireGuard to reach the peer web server:
```shell ```shell
onetun 127.0.0.1:8080:192.168.4.2:8080 \ ./onetun 127.0.0.1:8080:192.168.4.2:8080 \
--endpoint-addr 140.30.3.182:51820 \ --endpoint-addr 140.30.3.182:51820 \
--endpoint-public-key 'PUB_****************************************' \ --endpoint-public-key 'PUB_****************************************' \
--private-key 'PRIV_BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB' \ --private-key 'PRIV_BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB' \
@ -103,14 +75,14 @@ onetun 127.0.0.1:8080:192.168.4.2:8080 \
You'll then see this log: You'll then see this log:
```shell ```
INFO onetun > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
``` ```
Which means you can now access the port locally! Which means you can now access the port locally!
```shell ```
curl 127.0.0.1:8080 $ curl 127.0.0.1:8080
Hello world! Hello world!
``` ```
@ -118,32 +90,24 @@ Hello world!
**onetun** supports running multiple tunnels in parallel. For example: **onetun** supports running multiple tunnels in parallel. For example:
```shell ```
onetun 127.0.0.1:8080:192.168.4.2:8080 127.0.0.1:8081:192.168.4.4:8081 $ ./onetun 127.0.0.1:8080:192.168.4.2:8080 127.0.0.1:8081:192.168.4.4:8081
INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8081]->[192.168.4.4:8081] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8081]->[192.168.4.4:8081] (via [140.30.3.182:51820] as peer 192.168.4.3)
``` ```
... would open TCP ports 8080 and 8081 locally, which forward to their respective ports on the different peers. ... would open TCP ports 8080 and 8081 locally, which forward to their respective ports on the different peers.
#### Maximum number of tunnels
`smoltcp` imposes a compile-time limit on the number of IP addresses assigned to an interface. **onetun** increases
the default value to support most use-cases. In effect, the default limit on the number of **onetun** peers
is **7 per protocol** (TCP and UDP).
Should you need more unique IP addresses to forward ports to, you can increase the limit in `.cargo/config.toml` and recompile **onetun**.
### UDP Support ### UDP Support
**onetun** supports UDP forwarding. You can add `:UDP` at the end of the port-forward configuration, or `UDP,TCP` to support **onetun** supports UDP forwarding. You can add `:UDP` at the end of the port-forward configuration, or `UDP,TCP` to support
both protocols on the same port (note that this opens 2 separate tunnels, just on the same port) both protocols on the same port (note that this opens 2 separate tunnels, just on the same port)
```shell ```
onetun 127.0.0.1:8080:192.168.4.2:8080:UDP $ ./onetun 127.0.0.1:8080:192.168.4.2:8080:UDP
INFO onetun::tunnel > Tunneling UDP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling UDP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
onetun 127.0.0.1:8080:192.168.4.2:8080:UDP,TCP $ ./onetun 127.0.0.1:8080:192.168.4.2:8080:UDP,TCP
INFO onetun::tunnel > Tunneling UDP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling UDP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
``` ```
@ -155,77 +119,61 @@ it in any production capacity.
**onetun** supports both IPv4 and IPv6. In fact, you can use onetun to forward some IP version to another, e.g. 6-to-4: **onetun** supports both IPv4 and IPv6. In fact, you can use onetun to forward some IP version to another, e.g. 6-to-4:
```shell ```
onetun [::1]:8080:192.168.4.2:8080 $ ./onetun [::1]:8080:192.168.4.2:8080
INFO onetun::tunnel > Tunneling TCP [[::1]:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling TCP [[::1]:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
``` ```
Note that each tunnel can only support one "source" IP version and one "destination" IP version. If you want to support Note that each tunnel can only support one "source" IP version and one "destination" IP version. If you want to support
both IPv4 and IPv6 on the same port, you should create a second port-forward: both IPv4 and IPv6 on the same port, you should create a second port-forward:
```shell ```
onetun [::1]:8080:192.168.4.2:8080 127.0.0.1:8080:192.168.4.2:8080 $ ./onetun [::1]:8080:192.168.4.2:8080 127.0.0.1:8080:192.168.4.2:8080
INFO onetun::tunnel > Tunneling TCP [[::1]:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling TCP [[::1]:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3) INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
``` ```
### Packet Capture ## Download
For debugging purposes, you can enable the capture of IP packets sent between onetun and the WireGuard peer. Normally I would publish `onetun` to crates.io. However, it depends on some features
The output is a libpcap capture file that can be viewed with Wireshark. in [smoltcp](https://github.com/smoltcp-rs/smoltcp) and
[boringtun](https://github.com/cloudflare/boringtun) that haven't been published yet, so I'm forced to use their Git
repos as dependencies for now.
In the meantime, you can download the binary for Windows, macOS (Intel), and Linux (amd64) from
the [Releases](https://github.com/aramperes/onetun/releases) page.
You can also run onetun using [Docker](https://hub.docker.com/r/aramperes/onetun):
```shell ```shell
onetun --pcap wg.pcap 127.0.0.1:8080:192.168.4.2:8080 docker run --rm --name onetun --user 1000 -p 8080:8080 aramperes/onetun \
INFO onetun::pcap > Capturing WireGuard IP packets to wg.pcap 0.0.0.0:8080:192.168.4.2:8080 [...options...]
INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [140.30.3.182:51820] as peer 192.168.4.3)
``` ```
To capture packets sent to and from the onetun local port, you must use an external tool like `tcpdump` with root access: You can also build onetun locally, using Rust:
```shell ```shell
sudo tcpdump -i lo -w local.pcap 'dst 127.0.0.1 && port 8080' $ git clone https://github.com/aramperes/onetun && cd onetun
``` $ cargo build --release
$ ./target/release/onetun
### WireGuard Options
By default, onetun will create the UDP socket to communicate with the WireGuard endpoint on all interfaces and on a dynamic port,
i.e. `0.0.0.0:0` for IPv4 endpoints, or `[::]:0` for IPv6.
You can bind to a static address instead using `--endpoint-bind-addr`:
```shell
onetun --endpoint-bind-addr 0.0.0.0:51820 --endpoint-addr 140.30.3.182:51820 [...]
```
The security of the WireGuard connection can be further enhanced with a **pre-shared key** (PSK). You can generate such a key with the `wg genpsk` command, and provide it using `--preshared-key`.
The peer must also have this key configured using the `PresharedKey` option.
```shell
onetun --preshared-key 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' [...]
``` ```
## Architecture ## Architecture
**In short:** onetun uses [smoltcp's](https://github.com/smoltcp-rs/smoltcp) TCP/IP and UDP stack to generate IP packets
using its state machine ("virtual interface"). The generated IP packets are
encrypted by [boringtun](https://github.com/cloudflare/boringtun) and sent to the WireGuard endpoint. Encrypted IP packets received
from the WireGuard endpoint are decrypted using boringtun and sent through the smoltcp virtual interface state machine.
onetun creates "virtual sockets" in the virtual interface to forward data sent from inbound connections,
as well as to receive data from the virtual interface to forward back to the local client.
---
onetun uses [tokio](https://github.com/tokio-rs/tokio), the async runtime, to listen for new TCP connections on the onetun uses [tokio](https://github.com/tokio-rs/tokio), the async runtime, to listen for new TCP connections on the
given port. given port.
When a client connects to the onetun's TCP port, a "virtual client" is When a client connects to the local TCP port, it uses [smoltcp](https://github.com/smoltcp-rs/smoltcp) to
created in a [smoltcp](https://github.com/smoltcp-rs/smoltcp) "virtual" TCP/IP interface, which runs fully inside the onetun create a "virtual interface", with a "virtual client" and a "virtual server" for the connection. These "virtual"
process. An ephemeral "virtual port" is assigned to the "virtual client", which maps back to the local client. components are the crux of how onetun works. They essentially replace the host's TCP/IP stack with smoltcp's, which
fully runs inside onetun. An ephemeral "virtual port" is also assigned to the connection, in order to route packets
back to the right connection.
When the real client opens the connection, the virtual client socket opens a TCP connection to the virtual server When the real client opens the connection, the virtual client socket opens a TCP connection to the virtual server.
(a dummy socket bound to the remote host/port). The virtual interface in turn crafts the `SYN` segment and wraps it in an IP packet. The virtual interface (implemented by smoltcp) in turn crafts the `SYN` segment and wraps it in an IP packet.
Because of how the virtual client and server are configured, the IP packet is crafted with a source address Because of how the virtual client and server are configured, the IP packet is crafted with a source address
being the configured `source-peer-ip` (`192.168.4.3` in the example above), being the configured `source-peer-ip` (`192.168.4.3` in the example above),
and the destination address matches the port-forward's configured destination (`192.168.4.2`). and the destination address is the remote peer's (`192.168.4.2`).
By doing this, we let smoltcp handle the crafting of the IP packets, and the handling of the client's TCP states. By doing this, we let smoltcp handle the crafting of the IP packets, and the handling of the client's TCP states.
Instead of actually sending those packets to the virtual server, Instead of actually sending those packets to the virtual server,
@ -236,8 +184,8 @@ Once the WireGuard endpoint receives an encrypted IP packet, it decrypts it usin
It reads the destination address, re-encrypts the IP packet using the matching peer's public key, and sends it off to It reads the destination address, re-encrypts the IP packet using the matching peer's public key, and sends it off to
the peer's UDP endpoint. the peer's UDP endpoint.
The peer receives the encrypted IP and decrypts it. It can then read the inner payload (the TCP segment), The remote peer receives the encrypted IP and decrypts it. It can then read the inner payload (the TCP segment),
forward it to the server's port, which handles the TCP segment. The TCP server responds with `SYN-ACK`, which goes back through forward it to the server's port, which handles the TCP segment. The server responds with `SYN-ACK`, which goes back through
the peer's local WireGuard interface, gets encrypted, forwarded to the WireGuard endpoint, and then finally back to onetun's UDP port. the peer's local WireGuard interface, gets encrypted, forwarded to the WireGuard endpoint, and then finally back to onetun's UDP port.
When onetun receives an encrypted packet from the WireGuard endpoint, it decrypts it using boringtun. When onetun receives an encrypted packet from the WireGuard endpoint, it decrypts it using boringtun.
@ -267,56 +215,6 @@ if the least recently used port hasn't been used for a certain amount of time. I
All in all, I would not recommend using UDP forwarding for public services, since it's most likely prone to simple DoS or DDoS. All in all, I would not recommend using UDP forwarding for public services, since it's most likely prone to simple DoS or DDoS.
## HTTP/SOCKS Proxy
**onetun** is a Transport-layer proxy (also known as port forwarding); it is not in scope to provide
a HTTP/SOCKS proxy server. However, you can easily chain **onetun** with a proxy server on a remote
that is locked down to your WireGuard network.
For example, you could run [dante-server](https://www.inet.no/dante/) on a peer (ex. `192.168.4.2`) with the following configuration:
```
# /etc/danted.conf
logoutput: syslog
user.privileged: root
user.unprivileged: nobody
internal: 192.168.4.2 port=1080
external: eth0
socksmethod: none
clientmethod: none
# Locks down proxy use to WireGuard peers (192.168.4.x)
client pass {
from: 192.168.4.0/24 to: 0.0.0.0/0
}
socks pass {
from: 192.168.4.0/24 to: 0.0.0.0/0
}
```
Then use **onetun** to expose the SOCKS5 proxy locally:
```shell
onetun 127.0.0.1:1080:192.168.4.2:1080
INFO onetun::tunnel > Tunneling TCP [127.0.0.1:1080]->[192.168.4.2:1080] (via [140.30.3.182:51820] as peer 192.168.4.3)
```
Test with `curl` (or configure your browser):
```shell
curl -x socks5://127.0.0.1:1080 https://ifconfig.me
```
## Contributing and Maintenance
I will gladly accept contributions to onetun, and set aside time to review all pull-requests.
Please consider opening a GitHub issue if you are unsure if your contribution is within the scope of the project.
**Disclaimer**: I do not have enough personal time to actively maintain onetun besides open-source contributions.
## License ## License
MIT License. See `LICENSE` for details. Copyright &copy; 2025 Aram Peres. MIT. See `LICENSE` for details.

View file

@ -5,43 +5,35 @@ use std::fs::read_to_string;
use std::net::{IpAddr, SocketAddr, ToSocketAddrs}; use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
use std::sync::Arc; use std::sync::Arc;
use anyhow::{bail, Context}; use anyhow::Context;
pub use boringtun::x25519::{PublicKey, StaticSecret}; use boringtun::crypto::{X25519PublicKey, X25519SecretKey};
use clap::{App, Arg};
const DEFAULT_PORT_FORWARD_SOURCE: &str = "127.0.0.1"; #[derive(Clone, Debug)]
#[derive(Clone)]
pub struct Config { pub struct Config {
pub port_forwards: Vec<PortForwardConfig>, pub(crate) port_forwards: Vec<PortForwardConfig>,
#[allow(dead_code)] pub(crate) private_key: Arc<X25519SecretKey>,
pub remote_port_forwards: Vec<PortForwardConfig>, pub(crate) endpoint_public_key: Arc<X25519PublicKey>,
pub private_key: Arc<StaticSecret>, pub(crate) endpoint_addr: SocketAddr,
pub endpoint_public_key: Arc<PublicKey>, pub(crate) source_peer_ip: IpAddr,
pub preshared_key: Option<[u8; 32]>, pub(crate) keepalive_seconds: Option<u16>,
pub endpoint_addr: SocketAddr, pub(crate) max_transmission_unit: usize,
pub endpoint_bind_addr: SocketAddr, pub(crate) log: String,
pub source_peer_ip: IpAddr, pub(crate) warnings: Vec<String>,
pub keepalive_seconds: Option<u16>,
pub max_transmission_unit: usize,
pub log: String,
pub warnings: Vec<String>,
pub pcap_file: Option<String>,
} }
impl Config { impl Config {
#[cfg(feature = "bin")]
pub fn from_args() -> anyhow::Result<Self> { pub fn from_args() -> anyhow::Result<Self> {
use clap::{Arg, Command};
let mut warnings = vec![]; let mut warnings = vec![];
let matches = Command::new("onetun") let matches = App::new("onetun")
.author("Aram Peres <aram.peres@gmail.com>") .author("Aram Peres <aram.peres@gmail.com>")
.version(env!("CARGO_PKG_VERSION")) .version(env!("CARGO_PKG_VERSION"))
.args(&[ .args(&[
Arg::new("PORT_FORWARD") Arg::with_name("PORT_FORWARD")
.required(false) .required(false)
.num_args(1..) .multiple(true)
.takes_value(true)
.help("Port forward configurations. The format of each argument is [src_host:]<src_port>:<dst_host>:<dst_port>[:TCP,UDP,...], \ .help("Port forward configurations. The format of each argument is [src_host:]<src_port>:<dst_host>:<dst_port>[:TCP,UDP,...], \
where [src_host] is the local IP to listen on, <src_port> is the local port to listen on, <dst_host> is the remote peer IP to forward to, and <dst_port> is the remote port to forward to. \ where [src_host] is the local IP to listen on, <src_port> is the local port to listen on, <dst_host> is the remote peer IP to forward to, and <dst_port> is the remote port to forward to. \
Environment variables of the form 'ONETUN_PORT_FORWARD_[#]' are also accepted, where [#] starts at 1.\n\ Environment variables of the form 'ONETUN_PORT_FORWARD_[#]' are also accepted, where [#] starts at 1.\n\
@ -55,94 +47,61 @@ impl Config {
\tlocalhost:8080:192.168.4.1:8081:TCP\n\ \tlocalhost:8080:192.168.4.1:8081:TCP\n\
\tlocalhost:8080:peer.intranet:8081:TCP\ \tlocalhost:8080:peer.intranet:8081:TCP\
"), "),
Arg::new("private-key") Arg::with_name("private-key")
.conflicts_with("private-key-file") .required_unless("private-key-file")
.num_args(1) .takes_value(true)
.long("private-key") .long("private-key")
.env("ONETUN_PRIVATE_KEY") .env("ONETUN_PRIVATE_KEY")
.help("The private key of this peer. The corresponding public key should be registered in the WireGuard endpoint. \ .help("The private key of this peer. The corresponding public key should be registered in the WireGuard endpoint. \
You can also use '--private-key-file' to specify a file containing the key instead."), You can also use '--private-key-file' to specify a file containing the key instead."),
Arg::new("private-key-file") Arg::with_name("private-key-file")
.num_args(1) .takes_value(true)
.long("private-key-file") .long("private-key-file")
.env("ONETUN_PRIVATE_KEY_FILE") .env("ONETUN_PRIVATE_KEY_FILE")
.help("The path to a file containing the private key of this peer. The corresponding public key should be registered in the WireGuard endpoint."), .help("The path to a file containing the private key of this peer. The corresponding public key should be registered in the WireGuard endpoint."),
Arg::new("endpoint-public-key") Arg::with_name("endpoint-public-key")
.required(true) .required(true)
.num_args(1) .takes_value(true)
.long("endpoint-public-key") .long("endpoint-public-key")
.env("ONETUN_ENDPOINT_PUBLIC_KEY") .env("ONETUN_ENDPOINT_PUBLIC_KEY")
.help("The public key of the WireGuard endpoint (remote)."), .help("The public key of the WireGuard endpoint (remote)."),
Arg::new("preshared-key") Arg::with_name("endpoint-addr")
.required(false)
.num_args(1)
.long("preshared-key")
.env("ONETUN_PRESHARED_KEY")
.help("The pre-shared key (PSK) as configured with the peer."),
Arg::new("endpoint-addr")
.required(true) .required(true)
.num_args(1) .takes_value(true)
.long("endpoint-addr") .long("endpoint-addr")
.env("ONETUN_ENDPOINT_ADDR") .env("ONETUN_ENDPOINT_ADDR")
.help("The address (IP + port) of the WireGuard endpoint (remote). Example: 1.2.3.4:51820"), .help("The address (IP + port) of the WireGuard endpoint (remote). Example: 1.2.3.4:51820"),
Arg::new("endpoint-bind-addr") Arg::with_name("source-peer-ip")
.required(false)
.num_args(1)
.long("endpoint-bind-addr")
.env("ONETUN_ENDPOINT_BIND_ADDR")
.help("The address (IP + port) used to bind the local UDP socket for the WireGuard tunnel. Example: 1.2.3.4:30000. Defaults to 0.0.0.0:0 for IPv4 endpoints, or [::]:0 for IPv6 endpoints."),
Arg::new("source-peer-ip")
.required(true) .required(true)
.num_args(1) .takes_value(true)
.long("source-peer-ip") .long("source-peer-ip")
.env("ONETUN_SOURCE_PEER_IP") .env("ONETUN_SOURCE_PEER_IP")
.help("The source IP to identify this peer as (local). Example: 192.168.4.3"), .help("The source IP to identify this peer as (local). Example: 192.168.4.3"),
Arg::new("keep-alive") Arg::with_name("keep-alive")
.required(false) .required(false)
.num_args(1) .takes_value(true)
.long("keep-alive") .long("keep-alive")
.env("ONETUN_KEEP_ALIVE") .env("ONETUN_KEEP_ALIVE")
.help("Configures a persistent keep-alive for the WireGuard tunnel, in seconds."), .help("Configures a persistent keep-alive for the WireGuard tunnel, in seconds."),
Arg::new("max-transmission-unit") Arg::with_name("max-transmission-unit")
.required(false) .required(false)
.num_args(1) .takes_value(true)
.long("max-transmission-unit") .long("max-transmission-unit")
.env("ONETUN_MTU") .env("ONETUN_MTU")
.default_value("1420") .default_value("1420")
.help("Configures the max-transmission-unit (MTU) of the WireGuard tunnel."), .help("Configures the max-transmission-unit (MTU) of the WireGuard tunnel."),
Arg::new("log") Arg::with_name("log")
.required(false) .required(false)
.num_args(1) .takes_value(true)
.long("log") .long("log")
.env("ONETUN_LOG") .env("ONETUN_LOG")
.default_value("info") .default_value("info")
.help("Configures the log level and format."), .help("Configures the log level and format.")
Arg::new("pcap")
.required(false)
.num_args(1)
.long("pcap")
.env("ONETUN_PCAP")
.help("Decrypts and captures IP packets on the WireGuard tunnel to a given output file."),
Arg::new("remote")
.required(false)
.num_args(1..)
.long("remote")
.short('r')
.help("Remote port forward configurations. The format of each argument is <src_port>:<dst_host>:<dst_port>[:TCP,UDP,...], \
where <src_port> is the port the other peers will reach the server with, <dst_host> is the IP to forward to, and <dst_port> is the port to forward to. \
The <src_port> will be bound on onetun's peer IP, as specified by --source-peer-ip. If you pass a different value for <src_host> here, it will be rejected.\n\
Note: <dst_host>:<dst_port> must be reachable by onetun. If referring to another WireGuard peer, use --bridge instead (not supported yet).\n\
Environment variables of the form 'ONETUN_REMOTE_PORT_FORWARD_[#]' are also accepted, where [#] starts at 1.\n\
Examples:\n\
\t--remote 8080:localhost:8081:TCP,UDP\n\
\t--remote 8080:[::1]:8081:TCP\n\
\t--remote 8080:google.com:80\
"),
]).get_matches(); ]).get_matches();
// Combine `PORT_FORWARD` arg and `ONETUN_PORT_FORWARD_#` envs // Combine `PORT_FORWARD` arg and `ONETUN_PORT_FORWARD_#` envs
let mut port_forward_strings = HashSet::new(); let mut port_forward_strings = HashSet::new();
if let Some(values) = matches.get_many::<String>("PORT_FORWARD") { if let Some(values) = matches.values_of("PORT_FORWARD") {
for value in values { for value in values {
port_forward_strings.insert(value.to_owned()); port_forward_strings.insert(value.to_owned());
} }
@ -154,68 +113,26 @@ impl Config {
break; break;
} }
} }
if port_forward_strings.is_empty() {
return Err(anyhow::anyhow!("No port forward configurations given."));
}
// Parse `PORT_FORWARD` strings into `PortForwardConfig` // Parse `PORT_FORWARD` strings into `PortForwardConfig`
let port_forwards: anyhow::Result<Vec<Vec<PortForwardConfig>>> = port_forward_strings let port_forwards: anyhow::Result<Vec<Vec<PortForwardConfig>>> = port_forward_strings
.into_iter() .into_iter()
.map(|s| PortForwardConfig::from_notation(&s, DEFAULT_PORT_FORWARD_SOURCE)) .map(|s| PortForwardConfig::from_notation(&s))
.collect(); .collect();
let port_forwards: Vec<PortForwardConfig> = port_forwards let port_forwards: Vec<PortForwardConfig> = port_forwards
.context("Failed to parse port forward config")? .with_context(|| "Failed to parse port forward config")?
.into_iter() .into_iter()
.flatten() .flatten()
.collect(); .collect();
// Read source-peer-ip
let source_peer_ip = parse_ip(matches.get_one::<String>("source-peer-ip"))
.context("Invalid source peer IP")?;
// Combined `remote` arg and `ONETUN_REMOTE_PORT_FORWARD_#` envs
let mut port_forward_strings = HashSet::new();
if let Some(values) = matches.get_many::<String>("remote") {
for value in values {
port_forward_strings.insert(value.to_owned());
}
}
for n in 1.. {
if let Ok(env) = std::env::var(format!("ONETUN_REMOTE_PORT_FORWARD_{}", n)) {
port_forward_strings.insert(env);
} else {
break;
}
}
// Parse `PORT_FORWARD` strings into `PortForwardConfig`
let remote_port_forwards: anyhow::Result<Vec<Vec<PortForwardConfig>>> =
port_forward_strings
.into_iter()
.map(|s| {
PortForwardConfig::from_notation(
&s,
matches.get_one::<String>("source-peer-ip").unwrap(),
)
})
.collect();
let mut remote_port_forwards: Vec<PortForwardConfig> = remote_port_forwards
.context("Failed to parse remote port forward config")?
.into_iter()
.flatten()
.collect();
for port_forward in remote_port_forwards.iter_mut() {
if port_forward.source.ip() != source_peer_ip {
bail!("Remote port forward config <src_host> must match --source-peer-ip ({}), or be omitted.", source_peer_ip);
}
port_forward.source = SocketAddr::from((source_peer_ip, port_forward.source.port()));
port_forward.remote = true;
}
if port_forwards.is_empty() && remote_port_forwards.is_empty() {
bail!("No port forward configurations given.");
}
// Read private key from file or CLI argument // Read private key from file or CLI argument
let (group_readable, world_readable) = matches let (group_readable, world_readable) = matches
.get_one::<String>("private-key-file") .value_of("private-key-file")
.and_then(is_file_insecurely_readable) .map(is_file_insecurely_readable)
.flatten()
.unwrap_or_default(); .unwrap_or_default();
if group_readable { if group_readable {
warnings.push("Private key file is group-readable. This is insecure.".into()); warnings.push("Private key file is group-readable. This is insecure.".into());
@ -224,116 +141,71 @@ impl Config {
warnings.push("Private key file is world-readable. This is insecure.".into()); warnings.push("Private key file is world-readable. This is insecure.".into());
} }
let private_key = if let Some(private_key_file) = let private_key = if let Some(private_key_file) = matches.value_of("private-key-file") {
matches.get_one::<String>("private-key-file")
{
read_to_string(private_key_file) read_to_string(private_key_file)
.map(|s| s.trim().to_string()) .map(|s| s.trim().to_string())
.context("Failed to read private key file") .with_context(|| "Failed to read private key file")
} else { } else {
if std::env::var("ONETUN_PRIVATE_KEY").is_err() { if std::env::var("ONETUN_PRIVATE_KEY").is_err() {
warnings.push("Private key was passed using CLI. This is insecure. \ warnings.push("Private key was passed using CLI. This is insecure. \
Use \"--private-key-file <file containing private key>\", or the \"ONETUN_PRIVATE_KEY\" env variable instead.".into()); Use \"--private-key-file <file containing private key>\", or the \"ONETUN_PRIVATE_KEY\" env variable instead.".into());
} }
matches matches
.get_one::<String>("private-key") .value_of("private-key")
.cloned() .map(String::from)
.context("Missing private key") .with_context(|| "Missing private key")
}?; }?;
let endpoint_addr = parse_addr(matches.get_one::<String>("endpoint-addr"))
.context("Invalid endpoint address")?;
let endpoint_bind_addr = if let Some(addr) = matches.get_one::<String>("endpoint-bind-addr")
{
let addr = parse_addr(Some(addr)).context("Invalid bind address")?;
// Make sure the bind address and endpoint address are the same IP version
if addr.ip().is_ipv4() != endpoint_addr.ip().is_ipv4() {
bail!("Endpoint and bind addresses must be the same IP version");
}
addr
} else {
// Return the IP version of the endpoint address
match endpoint_addr {
SocketAddr::V4(_) => parse_addr(Some("0.0.0.0:0"))?,
SocketAddr::V6(_) => parse_addr(Some("[::]:0"))?,
}
};
Ok(Self { Ok(Self {
port_forwards, port_forwards,
remote_port_forwards, private_key: Arc::new(
private_key: Arc::new(parse_private_key(&private_key).context("Invalid private key")?), parse_private_key(&private_key).with_context(|| "Invalid private key")?,
endpoint_public_key: Arc::new(
parse_public_key(matches.get_one::<String>("endpoint-public-key"))
.context("Invalid endpoint public key")?,
), ),
preshared_key: parse_preshared_key(matches.get_one::<String>("preshared-key"))?, endpoint_public_key: Arc::new(
endpoint_addr, parse_public_key(matches.value_of("endpoint-public-key"))
endpoint_bind_addr, .with_context(|| "Invalid endpoint public key")?,
source_peer_ip, ),
keepalive_seconds: parse_keep_alive(matches.get_one::<String>("keep-alive")) endpoint_addr: parse_addr(matches.value_of("endpoint-addr"))
.context("Invalid keep-alive value")?, .with_context(|| "Invalid endpoint address")?,
max_transmission_unit: parse_mtu(matches.get_one::<String>("max-transmission-unit")) source_peer_ip: parse_ip(matches.value_of("source-peer-ip"))
.context("Invalid max-transmission-unit value")?, .with_context(|| "Invalid source peer IP")?,
log: matches keepalive_seconds: parse_keep_alive(matches.value_of("keep-alive"))
.get_one::<String>("log") .with_context(|| "Invalid keep-alive value")?,
.cloned() max_transmission_unit: parse_mtu(matches.value_of("max-transmission-unit"))
.unwrap_or_default(), .with_context(|| "Invalid max-transmission-unit value")?,
pcap_file: matches.get_one::<String>("pcap").cloned(), log: matches.value_of("log").unwrap_or_default().into(),
warnings, warnings,
}) })
} }
} }
fn parse_addr<T: AsRef<str>>(s: Option<T>) -> anyhow::Result<SocketAddr> { fn parse_addr(s: Option<&str>) -> anyhow::Result<SocketAddr> {
s.context("Missing address")? s.with_context(|| "Missing address")?
.as_ref()
.to_socket_addrs() .to_socket_addrs()
.context("Invalid address")? .with_context(|| "Invalid address")?
.next() .next()
.context("Could not lookup address") .with_context(|| "Could not lookup address")
} }
fn parse_ip(s: Option<&String>) -> anyhow::Result<IpAddr> { fn parse_ip(s: Option<&str>) -> anyhow::Result<IpAddr> {
s.context("Missing IP address")? s.with_context(|| "Missing IP")?
.parse::<IpAddr>() .parse::<IpAddr>()
.context("Invalid IP address") .with_context(|| "Invalid IP address")
} }
fn parse_private_key(s: &str) -> anyhow::Result<StaticSecret> { fn parse_private_key(s: &str) -> anyhow::Result<X25519SecretKey> {
let decoded = base64::decode(s).context("Failed to decode private key")?; s.parse::<X25519SecretKey>()
if let Ok::<[u8; 32], _>(bytes) = decoded.try_into() { .map_err(|e| anyhow::anyhow!("{}", e))
Ok(StaticSecret::from(bytes))
} else {
bail!("Invalid private key")
}
} }
fn parse_public_key(s: Option<&String>) -> anyhow::Result<PublicKey> { fn parse_public_key(s: Option<&str>) -> anyhow::Result<X25519PublicKey> {
let encoded = s.context("Missing public key")?; s.with_context(|| "Missing public key")?
let decoded = base64::decode(encoded).context("Failed to decode public key")?; .parse::<X25519PublicKey>()
if let Ok::<[u8; 32], _>(bytes) = decoded.try_into() { .map_err(|e| anyhow::anyhow!("{}", e))
Ok(PublicKey::from(bytes)) .with_context(|| "Invalid public key")
} else {
bail!("Invalid public key")
}
} }
fn parse_preshared_key(s: Option<&String>) -> anyhow::Result<Option<[u8; 32]>> { fn parse_keep_alive(s: Option<&str>) -> anyhow::Result<Option<u16>> {
if let Some(s) = s {
let decoded = base64::decode(s).context("Failed to decode preshared key")?;
if let Ok::<[u8; 32], _>(bytes) = decoded.try_into() {
Ok(Some(bytes))
} else {
bail!("Invalid preshared key")
}
} else {
Ok(None)
}
}
fn parse_keep_alive(s: Option<&String>) -> anyhow::Result<Option<u16>> {
if let Some(s) = s { if let Some(s) = s {
let parsed: u16 = s.parse().with_context(|| { let parsed: u16 = s.parse().with_context(|| {
format!( format!(
@ -347,21 +219,23 @@ fn parse_keep_alive(s: Option<&String>) -> anyhow::Result<Option<u16>> {
} }
} }
fn parse_mtu(s: Option<&String>) -> anyhow::Result<usize> { fn parse_mtu(s: Option<&str>) -> anyhow::Result<usize> {
s.context("Missing MTU")?.parse().context("Invalid MTU") s.with_context(|| "Missing MTU")?
.parse()
.with_context(|| "Invalid MTU")
} }
#[cfg(unix)] #[cfg(unix)]
fn is_file_insecurely_readable(path: &String) -> Option<(bool, bool)> { fn is_file_insecurely_readable(path: &str) -> Option<(bool, bool)> {
use std::fs::File; use std::fs::File;
use std::os::unix::fs::MetadataExt; use std::os::unix::fs::MetadataExt;
let mode = File::open(path).ok()?.metadata().ok()?.mode(); let mode = File::open(&path).ok()?.metadata().ok()?.mode();
Some((mode & 0o40 > 0, mode & 0o4 > 0)) Some((mode & 0o40 > 0, mode & 0o4 > 0))
} }
#[cfg(not(unix))] #[cfg(not(unix))]
fn is_file_insecurely_readable(_path: &String) -> Option<(bool, bool)> { fn is_file_insecurely_readable(_path: &str) -> Option<(bool, bool)> {
// No good way to determine permissions on non-Unix target // No good way to determine permissions on non-Unix target
None None
} }
@ -374,8 +248,6 @@ pub struct PortForwardConfig {
pub destination: SocketAddr, pub destination: SocketAddr,
/// The transport protocol to use for the port (Layer 4). /// The transport protocol to use for the port (Layer 4).
pub protocol: PortProtocol, pub protocol: PortProtocol,
/// Whether this is a remote port forward.
pub remote: bool,
} }
impl PortForwardConfig { impl PortForwardConfig {
@ -398,7 +270,7 @@ impl PortForwardConfig {
/// - IPv6 addresses must be prefixed with `[` and suffixed with `]`. Example: `[::1]`. /// - IPv6 addresses must be prefixed with `[` and suffixed with `]`. Example: `[::1]`.
/// - Any `u16` is accepted as `src_port` and `dst_port` /// - Any `u16` is accepted as `src_port` and `dst_port`
/// - Specifying protocols (`PROTO1,PROTO2,...`) is optional and defaults to `TCP`. Values must be separated by commas. /// - Specifying protocols (`PROTO1,PROTO2,...`) is optional and defaults to `TCP`. Values must be separated by commas.
pub fn from_notation(s: &str, default_source: &str) -> anyhow::Result<Vec<PortForwardConfig>> { pub fn from_notation(s: &str) -> anyhow::Result<Vec<PortForwardConfig>> {
mod parsers { mod parsers {
use nom::branch::alt; use nom::branch::alt;
use nom::bytes::complete::is_not; use nom::bytes::complete::is_not;
@ -476,22 +348,28 @@ impl PortForwardConfig {
.1; .1;
let source = ( let source = (
src_addr.0.unwrap_or(default_source), src_addr.0.unwrap_or("127.0.0.1"),
src_addr.1.parse::<u16>().context("Invalid source port")?, src_addr
.1
.parse::<u16>()
.with_context(|| "Invalid source port")?,
) )
.to_socket_addrs() .to_socket_addrs()
.context("Invalid source address")? .with_context(|| "Invalid source address")?
.next() .next()
.context("Could not resolve source address")?; .with_context(|| "Could not resolve source address")?;
let destination = ( let destination = (
dst_addr.0, dst_addr.0,
dst_addr.1.parse::<u16>().context("Invalid source port")?, dst_addr
.1
.parse::<u16>()
.with_context(|| "Invalid source port")?,
) )
.to_socket_addrs() // TODO: Pass this as given and use DNS config instead (issue #15) .to_socket_addrs() // TODO: Pass this as given and use DNS config instead (issue #15)
.context("Invalid destination address")? .with_context(|| "Invalid destination address")?
.next() .next()
.context("Could not resolve destination address")?; .with_context(|| "Could not resolve destination address")?;
// Parse protocols // Parse protocols
let protocols = if let Some(protocols) = protocols { let protocols = if let Some(protocols) = protocols {
@ -501,7 +379,7 @@ impl PortForwardConfig {
} else { } else {
Ok(vec![PortProtocol::Tcp]) Ok(vec![PortProtocol::Tcp])
} }
.context("Failed to parse protocols")?; .with_context(|| "Failed to parse protocols")?;
// Returns an config for each protocol // Returns an config for each protocol
Ok(protocols Ok(protocols
@ -510,7 +388,6 @@ impl PortForwardConfig {
source, source,
destination, destination,
protocol, protocol,
remote: false,
}) })
.collect()) .collect())
} }
@ -518,16 +395,8 @@ impl PortForwardConfig {
impl Display for PortForwardConfig { impl Display for PortForwardConfig {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
if self.remote {
write!(
f,
"(remote){}:{}:{}",
self.source, self.destination, self.protocol
)
} else {
write!(f, "{}:{}:{}", self.source, self.destination, self.protocol) write!(f, "{}:{}:{}", self.source, self.destination, self.protocol)
} }
}
} }
/// Layer 7 protocols for ports. /// Layer 7 protocols for ports.
@ -574,23 +443,18 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_1() { fn test_parse_port_forward_config_1() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation( PortForwardConfig::from_notation("192.168.0.1:8080:192.168.4.1:8081:TCP,UDP")
"192.168.0.1:8080:192.168.4.1:8081:TCP,UDP",
DEFAULT_PORT_FORWARD_SOURCE
)
.expect("Failed to parse"), .expect("Failed to parse"),
vec![ vec![
PortForwardConfig { PortForwardConfig {
source: SocketAddr::from_str("192.168.0.1:8080").unwrap(), source: SocketAddr::from_str("192.168.0.1:8080").unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}, },
PortForwardConfig { PortForwardConfig {
source: SocketAddr::from_str("192.168.0.1:8080").unwrap(), source: SocketAddr::from_str("192.168.0.1:8080").unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Udp, protocol: PortProtocol::Udp
remote: false,
} }
] ]
); );
@ -599,16 +463,12 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_2() { fn test_parse_port_forward_config_2() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation( PortForwardConfig::from_notation("192.168.0.1:8080:192.168.4.1:8081:TCP")
"192.168.0.1:8080:192.168.4.1:8081:TCP",
DEFAULT_PORT_FORWARD_SOURCE
)
.expect("Failed to parse"), .expect("Failed to parse"),
vec![PortForwardConfig { vec![PortForwardConfig {
source: SocketAddr::from_str("192.168.0.1:8080").unwrap(), source: SocketAddr::from_str("192.168.0.1:8080").unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}] }]
); );
} }
@ -616,16 +476,12 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_3() { fn test_parse_port_forward_config_3() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation( PortForwardConfig::from_notation("0.0.0.0:8080:192.168.4.1:8081")
"0.0.0.0:8080:192.168.4.1:8081",
DEFAULT_PORT_FORWARD_SOURCE
)
.expect("Failed to parse"), .expect("Failed to parse"),
vec![PortForwardConfig { vec![PortForwardConfig {
source: SocketAddr::from_str("0.0.0.0:8080").unwrap(), source: SocketAddr::from_str("0.0.0.0:8080").unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}] }]
); );
} }
@ -633,16 +489,12 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_4() { fn test_parse_port_forward_config_4() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation( PortForwardConfig::from_notation("[::1]:8080:192.168.4.1:8081")
"[::1]:8080:192.168.4.1:8081",
DEFAULT_PORT_FORWARD_SOURCE
)
.expect("Failed to parse"), .expect("Failed to parse"),
vec![PortForwardConfig { vec![PortForwardConfig {
source: SocketAddr::from_str("[::1]:8080").unwrap(), source: SocketAddr::from_str("[::1]:8080").unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}] }]
); );
} }
@ -650,13 +502,11 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_5() { fn test_parse_port_forward_config_5() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation("8080:192.168.4.1:8081", DEFAULT_PORT_FORWARD_SOURCE) PortForwardConfig::from_notation("8080:192.168.4.1:8081").expect("Failed to parse"),
.expect("Failed to parse"),
vec![PortForwardConfig { vec![PortForwardConfig {
source: SocketAddr::from_str("127.0.0.1:8080").unwrap(), source: SocketAddr::from_str("127.0.0.1:8080").unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}] }]
); );
} }
@ -664,16 +514,11 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_6() { fn test_parse_port_forward_config_6() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation( PortForwardConfig::from_notation("8080:192.168.4.1:8081:TCP").expect("Failed to parse"),
"8080:192.168.4.1:8081:TCP",
DEFAULT_PORT_FORWARD_SOURCE
)
.expect("Failed to parse"),
vec![PortForwardConfig { vec![PortForwardConfig {
source: SocketAddr::from_str("127.0.0.1:8080").unwrap(), source: SocketAddr::from_str("127.0.0.1:8080").unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}] }]
); );
} }
@ -681,16 +526,12 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_7() { fn test_parse_port_forward_config_7() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation( PortForwardConfig::from_notation("localhost:8080:192.168.4.1:8081")
"localhost:8080:192.168.4.1:8081",
DEFAULT_PORT_FORWARD_SOURCE
)
.expect("Failed to parse"), .expect("Failed to parse"),
vec![PortForwardConfig { vec![PortForwardConfig {
source: "localhost:8080".to_socket_addrs().unwrap().next().unwrap(), source: "localhost:8080".to_socket_addrs().unwrap().next().unwrap(),
destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(), destination: SocketAddr::from_str("192.168.4.1:8081").unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}] }]
); );
} }
@ -698,16 +539,12 @@ mod tests {
#[test] #[test]
fn test_parse_port_forward_config_8() { fn test_parse_port_forward_config_8() {
assert_eq!( assert_eq!(
PortForwardConfig::from_notation( PortForwardConfig::from_notation("localhost:8080:localhost:8081:TCP")
"localhost:8080:localhost:8081:TCP",
DEFAULT_PORT_FORWARD_SOURCE
)
.expect("Failed to parse"), .expect("Failed to parse"),
vec![PortForwardConfig { vec![PortForwardConfig {
source: "localhost:8080".to_socket_addrs().unwrap().next().unwrap(), source: "localhost:8080".to_socket_addrs().unwrap().next().unwrap(),
destination: "localhost:8081".to_socket_addrs().unwrap().next().unwrap(), destination: "localhost:8081".to_socket_addrs().unwrap().next().unwrap(),
protocol: PortProtocol::Tcp, protocol: PortProtocol::Tcp
remote: false,
}] }]
); );
} }

View file

@ -1,5 +1,3 @@
use bytes::Bytes;
use std::fmt::{Display, Formatter};
use std::sync::atomic::{AtomicU32, Ordering}; use std::sync::atomic::{AtomicU32, Ordering};
use std::sync::Arc; use std::sync::Arc;
@ -17,56 +15,17 @@ pub enum Event {
/// A connection was dropped from the pool and should be closed in all interfaces. /// A connection was dropped from the pool and should be closed in all interfaces.
ClientConnectionDropped(VirtualPort), ClientConnectionDropped(VirtualPort),
/// Data received by the local server that should be sent to the virtual server. /// Data received by the local server that should be sent to the virtual server.
LocalData(PortForwardConfig, VirtualPort, Bytes), LocalData(PortForwardConfig, VirtualPort, Vec<u8>),
/// Data received by the remote server that should be sent to the local client. /// Data received by the remote server that should be sent to the local client.
RemoteData(VirtualPort, Bytes), RemoteData(VirtualPort, Vec<u8>),
/// IP packet received from the WireGuard tunnel that should be passed through the corresponding virtual device. /// IP packet received from the WireGuard tunnel that should be passed through the corresponding virtual device.
InboundInternetPacket(PortProtocol, Bytes), InboundInternetPacket(PortProtocol, Vec<u8>),
/// IP packet to be sent through the WireGuard tunnel as crafted by the virtual device. /// IP packet to be sent through the WireGuard tunnel as crafted by the virtual device.
OutboundInternetPacket(Bytes), OutboundInternetPacket(Vec<u8>),
/// Notifies that a virtual device read an IP packet. /// Notifies that a virtual device read an IP packet.
VirtualDeviceFed(PortProtocol), VirtualDeviceFed(PortProtocol),
} }
impl Display for Event {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match self {
Event::Dumb => {
write!(f, "Dumb{{}}")
}
Event::ClientConnectionInitiated(pf, vp) => {
write!(f, "ClientConnectionInitiated{{ pf={} vp={} }}", pf, vp)
}
Event::ClientConnectionDropped(vp) => {
write!(f, "ClientConnectionDropped{{ vp={} }}", vp)
}
Event::LocalData(pf, vp, data) => {
let size = data.len();
write!(f, "LocalData{{ pf={} vp={} size={} }}", pf, vp, size)
}
Event::RemoteData(vp, data) => {
let size = data.len();
write!(f, "RemoteData{{ vp={} size={} }}", vp, size)
}
Event::InboundInternetPacket(proto, data) => {
let size = data.len();
write!(
f,
"InboundInternetPacket{{ proto={} size={} }}",
proto, size
)
}
Event::OutboundInternetPacket(data) => {
let size = data.len();
write!(f, "OutboundInternetPacket{{ size={} }}", size)
}
Event::VirtualDeviceFed(proto) => {
write!(f, "VirtualDeviceFed{{ proto={} }}", proto)
}
}
}
}
#[derive(Clone)] #[derive(Clone)]
pub struct Bus { pub struct Bus {
counter: Arc<AtomicU32>, counter: Arc<AtomicU32>,
@ -125,6 +84,7 @@ impl BusEndpoint {
// If the event was sent by this endpoint, it is skipped // If the event was sent by this endpoint, it is skipped
continue; continue;
} else { } else {
trace!("#{} <- {:?}", self.id, event);
return event; return event;
} }
} }
@ -151,7 +111,7 @@ pub struct BusSender {
impl BusSender { impl BusSender {
/// Sends the event on the bus. Note that the messages sent by this endpoint won't reach itself. /// Sends the event on the bus. Note that the messages sent by this endpoint won't reach itself.
pub fn send(&self, event: Event) { pub fn send(&self, event: Event) {
trace!("#{} -> {}", self.id, event); trace!("#{} -> {:?}", self.id, event);
match self.tx.send((self.id, event)) { match self.tx.send((self.id, event)) {
Ok(_) => {} Ok(_) => {}
Err(_) => error!("Failed to send event to bus from endpoint #{}", self.id), Err(_) => error!("Failed to send event to bus from endpoint #{}", self.id),

View file

@ -1,122 +0,0 @@
#[macro_use]
extern crate log;
use std::sync::Arc;
use anyhow::Context;
use crate::config::{Config, PortProtocol};
use crate::events::Bus;
use crate::tunnel::tcp::TcpPortPool;
use crate::tunnel::udp::UdpPortPool;
use crate::virtual_device::VirtualIpDevice;
use crate::virtual_iface::tcp::TcpVirtualInterface;
use crate::virtual_iface::udp::UdpVirtualInterface;
use crate::virtual_iface::VirtualInterfacePoll;
use crate::wg::WireGuardTunnel;
pub mod config;
pub mod events;
#[cfg(feature = "pcap")]
pub mod pcap;
pub mod tunnel;
pub mod virtual_device;
pub mod virtual_iface;
pub mod wg;
/// Starts the onetun tunnels in separate tokio tasks.
///
/// Note: This future completes immediately.
pub async fn start_tunnels(config: Config, bus: Bus) -> anyhow::Result<()> {
// Initialize the port pool for each protocol
let tcp_port_pool = TcpPortPool::new();
let udp_port_pool = UdpPortPool::new();
#[cfg(feature = "pcap")]
if let Some(pcap_file) = config.pcap_file.clone() {
// Start packet capture
let bus = bus.clone();
tokio::spawn(async move { pcap::capture(pcap_file, bus).await });
}
let wg = WireGuardTunnel::new(&config, bus.clone())
.await
.context("Failed to initialize WireGuard tunnel")?;
let wg = Arc::new(wg);
{
// Start routine task for WireGuard
let wg = wg.clone();
tokio::spawn(async move { wg.routine_task().await });
}
{
// Start consumption task for WireGuard
let wg = wg.clone();
tokio::spawn(Box::pin(async move { wg.consume_task().await }));
}
{
// Start production task for WireGuard
let wg = wg.clone();
tokio::spawn(async move { wg.produce_task().await });
}
if config
.port_forwards
.iter()
.any(|pf| pf.protocol == PortProtocol::Tcp)
{
// TCP device
let bus = bus.clone();
let device =
VirtualIpDevice::new(PortProtocol::Tcp, bus.clone(), config.max_transmission_unit);
// Start TCP Virtual Interface
let port_forwards = config.port_forwards.clone();
let iface = TcpVirtualInterface::new(port_forwards, bus, config.source_peer_ip);
tokio::spawn(async move { iface.poll_loop(device).await });
}
if config
.port_forwards
.iter()
.any(|pf| pf.protocol == PortProtocol::Udp)
{
// UDP device
let bus = bus.clone();
let device =
VirtualIpDevice::new(PortProtocol::Udp, bus.clone(), config.max_transmission_unit);
// Start UDP Virtual Interface
let port_forwards = config.port_forwards.clone();
let iface = UdpVirtualInterface::new(port_forwards, bus, config.source_peer_ip);
tokio::spawn(async move { iface.poll_loop(device).await });
}
{
let port_forwards = config.port_forwards;
let source_peer_ip = config.source_peer_ip;
port_forwards
.into_iter()
.map(|pf| {
(
pf,
wg.clone(),
tcp_port_pool.clone(),
udp_port_pool.clone(),
bus.clone(),
)
})
.for_each(move |(pf, wg, tcp_port_pool, udp_port_pool, bus)| {
tokio::spawn(async move {
tunnel::port_forward(pf, source_peer_ip, tcp_port_pool, udp_port_pool, wg, bus)
.await
.unwrap_or_else(|e| error!("Port-forward failed for {} : {}", pf, e))
});
});
}
Ok(())
}

View file

@ -1,36 +1,128 @@
#[cfg(feature = "bin")]
#[macro_use] #[macro_use]
extern crate log; extern crate log;
#[cfg(feature = "bin")] use std::sync::Arc;
use anyhow::Context;
use crate::config::{Config, PortProtocol};
use crate::events::Bus;
use crate::tunnel::tcp::TcpPortPool;
use crate::tunnel::udp::UdpPortPool;
use crate::virtual_device::VirtualIpDevice;
use crate::virtual_iface::tcp::TcpVirtualInterface;
use crate::virtual_iface::udp::UdpVirtualInterface;
use crate::virtual_iface::VirtualInterfacePoll;
use crate::wg::WireGuardTunnel;
pub mod config;
pub mod events;
pub mod tunnel;
pub mod virtual_device;
pub mod virtual_iface;
pub mod wg;
#[tokio::main] #[tokio::main]
async fn main() -> anyhow::Result<()> { async fn main() -> anyhow::Result<()> {
use anyhow::Context; let config = Config::from_args().with_context(|| "Failed to read config")?;
use onetun::{config::Config, events::Bus};
let config = Config::from_args().context("Configuration has errors")?;
init_logger(&config)?; init_logger(&config)?;
for warning in &config.warnings { for warning in &config.warnings {
warn!("{}", warning); warn!("{}", warning);
} }
// Initialize the port pool for each protocol
let tcp_port_pool = TcpPortPool::new();
let udp_port_pool = UdpPortPool::new();
let bus = Bus::default(); let bus = Bus::default();
onetun::start_tunnels(config, bus).await?;
let wg = WireGuardTunnel::new(&config, bus.clone())
.await
.with_context(|| "Failed to initialize WireGuard tunnel")?;
let wg = Arc::new(wg);
{
// Start routine task for WireGuard
let wg = wg.clone();
tokio::spawn(async move { wg.routine_task().await });
}
{
// Start consumption task for WireGuard
let wg = wg.clone();
tokio::spawn(async move { wg.consume_task().await });
}
{
// Start production task for WireGuard
let wg = wg.clone();
tokio::spawn(async move { wg.produce_task().await });
}
if config
.port_forwards
.iter()
.any(|pf| pf.protocol == PortProtocol::Tcp)
{
// TCP device
let bus = bus.clone();
let device =
VirtualIpDevice::new(PortProtocol::Tcp, bus.clone(), config.max_transmission_unit);
// Start TCP Virtual Interface
let port_forwards = config.port_forwards.clone();
let iface = TcpVirtualInterface::new(port_forwards, bus, config.source_peer_ip);
tokio::spawn(async move { iface.poll_loop(device).await });
}
if config
.port_forwards
.iter()
.any(|pf| pf.protocol == PortProtocol::Udp)
{
// UDP device
let bus = bus.clone();
let device =
VirtualIpDevice::new(PortProtocol::Udp, bus.clone(), config.max_transmission_unit);
// Start UDP Virtual Interface
let port_forwards = config.port_forwards.clone();
let iface = UdpVirtualInterface::new(port_forwards, bus, config.source_peer_ip);
tokio::spawn(async move { iface.poll_loop(device).await });
}
{
let port_forwards = config.port_forwards;
let source_peer_ip = config.source_peer_ip;
port_forwards
.into_iter()
.map(|pf| {
(
pf,
wg.clone(),
tcp_port_pool.clone(),
udp_port_pool.clone(),
bus.clone(),
)
})
.for_each(move |(pf, wg, tcp_port_pool, udp_port_pool, bus)| {
tokio::spawn(async move {
tunnel::port_forward(pf, source_peer_ip, tcp_port_pool, udp_port_pool, wg, bus)
.await
.unwrap_or_else(|e| error!("Port-forward failed for {} : {}", pf, e))
});
});
}
futures::future::pending().await futures::future::pending().await
} }
#[cfg(not(feature = "bin"))] fn init_logger(config: &Config) -> anyhow::Result<()> {
fn main() -> anyhow::Result<()> {
Err(anyhow::anyhow!("Binary compiled without 'bin' feature"))
}
#[cfg(feature = "bin")]
fn init_logger(config: &onetun::config::Config) -> anyhow::Result<()> {
use anyhow::Context;
let mut builder = pretty_env_logger::formatted_timed_builder(); let mut builder = pretty_env_logger::formatted_timed_builder();
builder.parse_filters(&config.log); builder.parse_filters(&config.log);
builder.try_init().context("Failed to initialize logger") builder
.try_init()
.with_context(|| "Failed to initialize logger")
} }

View file

@ -1,113 +0,0 @@
use crate::events::Event;
use crate::Bus;
use anyhow::Context;
use smoltcp::time::Instant;
use tokio::fs::File;
use tokio::io::{AsyncWriteExt, BufWriter};
struct Pcap {
writer: BufWriter<File>,
}
/// libpcap file writer
/// This is mostly taken from `smoltcp`, but rewritten to be async.
impl Pcap {
async fn flush(&mut self) -> anyhow::Result<()> {
self.writer
.flush()
.await
.context("Failed to flush pcap writer")
}
async fn write(&mut self, data: &[u8]) -> anyhow::Result<usize> {
self.writer
.write(data)
.await
.with_context(|| format!("Failed to write {} bytes to pcap writer", data.len()))
}
async fn write_u16(&mut self, value: u16) -> anyhow::Result<()> {
self.writer
.write_u16(value)
.await
.context("Failed to write u16 to pcap writer")
}
async fn write_u32(&mut self, value: u32) -> anyhow::Result<()> {
self.writer
.write_u32(value)
.await
.context("Failed to write u32 to pcap writer")
}
async fn global_header(&mut self) -> anyhow::Result<()> {
self.write_u32(0xa1b2c3d4).await?; // magic number
self.write_u16(2).await?; // major version
self.write_u16(4).await?; // minor version
self.write_u32(0).await?; // timezone (= UTC)
self.write_u32(0).await?; // accuracy (not used)
self.write_u32(65535).await?; // maximum packet length
self.write_u32(101).await?; // link-layer header type (101 = IP)
self.flush().await
}
async fn packet_header(&mut self, timestamp: Instant, length: usize) -> anyhow::Result<()> {
assert!(length <= 65535);
self.write_u32(timestamp.secs() as u32).await?; // timestamp seconds
self.write_u32(timestamp.micros() as u32).await?; // timestamp microseconds
self.write_u32(length as u32).await?; // captured length
self.write_u32(length as u32).await?; // original length
Ok(())
}
async fn packet(&mut self, timestamp: Instant, packet: &[u8]) -> anyhow::Result<()> {
self.packet_header(timestamp, packet.len())
.await
.context("Failed to write packet header to pcap writer")?;
self.write(packet)
.await
.context("Failed to write packet to pcap writer")?;
self.writer
.flush()
.await
.context("Failed to flush pcap writer")?;
self.flush().await
}
}
/// Listens on the event bus for IP packets sent from and to the WireGuard tunnel.
pub async fn capture(pcap_file: String, bus: Bus) -> anyhow::Result<()> {
let mut endpoint = bus.new_endpoint();
let file = File::create(&pcap_file)
.await
.context("Failed to create pcap file")?;
let writer = BufWriter::new(file);
let mut writer = Pcap { writer };
writer
.global_header()
.await
.context("Failed to write global header to pcap writer")?;
info!("Capturing WireGuard IP packets to {}", &pcap_file);
loop {
match endpoint.recv().await {
Event::InboundInternetPacket(_proto, ip) => {
let instant = Instant::now();
writer
.packet(instant, &ip)
.await
.context("Failed to write inbound IP packet to pcap writer")?;
}
Event::OutboundInternetPacket(ip) => {
let instant = Instant::now();
writer
.packet(instant, &ip)
.await
.context("Failed to write output IP packet to pcap writer")?;
}
_ => {}
}
}
}

View file

@ -8,6 +8,7 @@ use crate::tunnel::udp::UdpPortPool;
use crate::wg::WireGuardTunnel; use crate::wg::WireGuardTunnel;
pub mod tcp; pub mod tcp;
#[allow(unused)]
pub mod udp; pub mod udp;
pub async fn port_forward( pub async fn port_forward(

View file

@ -1,18 +1,17 @@
use crate::config::{PortForwardConfig, PortProtocol};
use crate::virtual_iface::VirtualPort;
use anyhow::Context;
use std::collections::VecDeque; use std::collections::VecDeque;
use std::ops::Range;
use std::sync::Arc; use std::sync::Arc;
use tokio::net::{TcpListener, TcpStream};
use std::ops::Range;
use std::time::Duration; use std::time::Duration;
use anyhow::Context; use crate::events::{Bus, Event};
use bytes::BytesMut;
use rand::seq::SliceRandom; use rand::seq::SliceRandom;
use rand::thread_rng; use rand::thread_rng;
use tokio::io::AsyncWriteExt; use tokio::io::AsyncWriteExt;
use tokio::net::{TcpListener, TcpStream};
use crate::config::{PortForwardConfig, PortProtocol};
use crate::events::{Bus, Event};
use crate::virtual_iface::VirtualPort;
const MAX_PACKET: usize = 65536; const MAX_PACKET: usize = 65536;
const MIN_PORT: u16 = 1000; const MIN_PORT: u16 = 1000;
@ -27,14 +26,14 @@ pub async fn tcp_proxy_server(
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let listener = TcpListener::bind(port_forward.source) let listener = TcpListener::bind(port_forward.source)
.await .await
.context("Failed to listen on TCP proxy server")?; .with_context(|| "Failed to listen on TCP proxy server")?;
loop { loop {
let port_pool = port_pool.clone(); let port_pool = port_pool.clone();
let (socket, peer_addr) = listener let (socket, peer_addr) = listener
.accept() .accept()
.await .await
.context("Failed to accept connection on TCP proxy server")?; .with_context(|| "Failed to accept connection on TCP proxy server")?;
// Assign a 'virtual port': this is a unique port number used to route IP packets // Assign a 'virtual port': this is a unique port number used to route IP packets
// received from the WireGuard tunnel. It is the port number that the virtual client will // received from the WireGuard tunnel. It is the port number that the virtual client will
@ -82,7 +81,7 @@ async fn handle_tcp_proxy_connection(
let mut endpoint = bus.new_endpoint(); let mut endpoint = bus.new_endpoint();
endpoint.send(Event::ClientConnectionInitiated(port_forward, virtual_port)); endpoint.send(Event::ClientConnectionInitiated(port_forward, virtual_port));
let mut buffer = BytesMut::with_capacity(MAX_PACKET); let mut buffer = Vec::with_capacity(MAX_PACKET);
loop { loop {
tokio::select! { tokio::select! {
readable_result = socket.readable() => { readable_result = socket.readable() => {
@ -91,7 +90,7 @@ async fn handle_tcp_proxy_connection(
match socket.try_read_buf(&mut buffer) { match socket.try_read_buf(&mut buffer) {
Ok(size) if size > 0 => { Ok(size) if size > 0 => {
let data = Vec::from(&buffer[..size]); let data = Vec::from(&buffer[..size]);
endpoint.send(Event::LocalData(port_forward, virtual_port, data.into())); endpoint.send(Event::LocalData(port_forward, virtual_port, data));
// Reset buffer // Reset buffer
buffer.clear(); buffer.clear();
} }
@ -124,30 +123,15 @@ async fn handle_tcp_proxy_connection(
} }
Event::RemoteData(e_vp, data) if e_vp == virtual_port => { Event::RemoteData(e_vp, data) if e_vp == virtual_port => {
// Have remote data to send to the local client // Have remote data to send to the local client
if let Err(e) = socket.writable().await { let size = data.len();
error!("[{}] Failed to check if writable: {:?}", virtual_port, e); match socket.write(&data).await {
} Ok(size) => debug!("[{}] Sent {} bytes to local client", virtual_port, size),
let expected = data.len();
let mut sent = 0;
loop {
if sent >= expected {
break;
}
match socket.write(&data[sent..expected]).await {
Ok(written) => {
debug!("[{}] Sent {} (expected {}) bytes to local client", virtual_port, written, expected);
sent += written;
if sent < expected {
debug!("[{}] Will try to resend remaining {} bytes to local client", virtual_port, (expected - written));
}
},
Err(e) => { Err(e) => {
error!("[{}] Failed to send {} bytes to local client: {:?}", virtual_port, expected, e); error!("[{}] Failed to send {} bytes to local client: {:?}", virtual_port, size, e);
break; break;
} }
} }
} }
}
_ => {} _ => {}
} }
} }
@ -186,13 +170,13 @@ impl TcpPortPool {
} }
} }
/// Requests a free port from the pool. An error is returned if none is available (exhausted max capacity). /// Requests a free port from the pool. An error is returned if none is available (exhaused max capacity).
pub async fn next(&self) -> anyhow::Result<VirtualPort> { pub async fn next(&self) -> anyhow::Result<VirtualPort> {
let mut inner = self.inner.write().await; let mut inner = self.inner.write().await;
let port = inner let port = inner
.queue .queue
.pop_front() .pop_front()
.context("TCP virtual port pool is exhausted")?; .with_context(|| "TCP virtual port pool is exhausted")?;
Ok(VirtualPort::new(port, PortProtocol::Tcp)) Ok(VirtualPort::new(port, PortProtocol::Tcp))
} }

View file

@ -1,19 +1,22 @@
use std::collections::{HashMap, VecDeque}; use std::collections::{BTreeMap, HashMap, VecDeque};
use std::net::{IpAddr, SocketAddr}; use std::net::{IpAddr, SocketAddr};
use std::ops::Range; use std::ops::Range;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc; use std::sync::Arc;
use std::time::Instant; use std::time::Instant;
use crate::events::{Bus, Event};
use anyhow::Context; use anyhow::Context;
use bytes::Bytes;
use priority_queue::double_priority_queue::DoublePriorityQueue; use priority_queue::double_priority_queue::DoublePriorityQueue;
use priority_queue::priority_queue::PriorityQueue;
use rand::seq::SliceRandom; use rand::seq::SliceRandom;
use rand::thread_rng; use rand::thread_rng;
use tokio::net::UdpSocket; use tokio::net::UdpSocket;
use crate::config::{PortForwardConfig, PortProtocol}; use crate::config::{PortForwardConfig, PortProtocol};
use crate::events::{Bus, Event}; use crate::virtual_iface::udp::UdpVirtualInterface;
use crate::virtual_iface::VirtualPort; use crate::virtual_iface::{VirtualInterfacePoll, VirtualPort};
use crate::wg::WireGuardTunnel;
const MAX_PACKET: usize = 65536; const MAX_PACKET: usize = 65536;
const MIN_PORT: u16 = 1000; const MIN_PORT: u16 = 1000;
@ -37,7 +40,7 @@ pub async fn udp_proxy_server(
let mut endpoint = bus.new_endpoint(); let mut endpoint = bus.new_endpoint();
let socket = UdpSocket::bind(port_forward.source) let socket = UdpSocket::bind(port_forward.source)
.await .await
.context("Failed to bind on UDP proxy address")?; .with_context(|| "Failed to bind on UDP proxy address")?;
let mut buffer = [0u8; MAX_PACKET]; let mut buffer = [0u8; MAX_PACKET];
loop { loop {
@ -60,33 +63,17 @@ pub async fn udp_proxy_server(
} }
} }
event = endpoint.recv() => { event = endpoint.recv() => {
if let Event::RemoteData(virtual_port, data) = event { if let Event::RemoteData(port, data) = event {
if let Some(peer) = port_pool.get_peer_addr(virtual_port).await { if let Some(peer) = port_pool.get_peer_addr(port).await {
// Have remote data to send to the local client if let Err(e) = socket.send_to(&data, peer).await {
if let Err(e) = socket.writable().await { error!(
error!("[{}] Failed to check if writable: {:?}", virtual_port, e); "[{}] Failed to send UDP datagram to real client ({}): {:?}",
port,
peer,
e,
);
} }
let expected = data.len(); port_pool.update_last_transmit(port).await;
let mut sent = 0;
loop {
if sent >= expected {
break;
}
match socket.send_to(&data[sent..expected], peer).await {
Ok(written) => {
debug!("[{}] Sent {} (expected {}) bytes to local client", virtual_port, written, expected);
sent += written;
if sent < expected {
debug!("[{}] Will try to resend remaining {} bytes to local client", virtual_port, (expected - written));
}
},
Err(e) => {
error!("[{}] Failed to send {} bytes to local client: {:?}", virtual_port, expected, e);
break;
}
}
}
port_pool.update_last_transmit(virtual_port).await;
} }
} }
} }
@ -99,11 +86,11 @@ async fn next_udp_datagram(
socket: &UdpSocket, socket: &UdpSocket,
buffer: &mut [u8], buffer: &mut [u8],
port_pool: UdpPortPool, port_pool: UdpPortPool,
) -> anyhow::Result<Option<(VirtualPort, Bytes)>> { ) -> anyhow::Result<Option<(VirtualPort, Vec<u8>)>> {
let (size, peer_addr) = socket let (size, peer_addr) = socket
.recv_from(buffer) .recv_from(buffer)
.await .await
.context("Failed to accept incoming UDP datagram")?; .with_context(|| "Failed to accept incoming UDP datagram")?;
// Assign a 'virtual port': this is a unique port number used to route IP packets // Assign a 'virtual port': this is a unique port number used to route IP packets
// received from the WireGuard tunnel. It is the port number that the virtual client will // received from the WireGuard tunnel. It is the port number that the virtual client will
@ -127,7 +114,7 @@ async fn next_udp_datagram(
port_pool.update_last_transmit(port).await; port_pool.update_last_transmit(port).await;
let data = buffer[..size].to_vec(); let data = buffer[..size].to_vec();
Ok(Some((port, data.into()))) Ok(Some((port, data)))
} }
/// A pool of virtual ports available for TCP connections. /// A pool of virtual ports available for TCP connections.
@ -212,7 +199,7 @@ impl UdpPortPool {
None None
} }
}) })
.context("Virtual port pool is exhausted")?; .with_context(|| "virtual port pool is exhausted")?;
inner.port_by_peer_addr.insert(peer_addr, port); inner.port_by_peer_addr.insert(peer_addr, port);
inner.peer_addr_by_port.insert(port, peer_addr); inner.peer_addr_by_port.insert(port, peer_addr);
@ -223,13 +210,13 @@ impl UdpPortPool {
pub async fn update_last_transmit(&self, port: VirtualPort) { pub async fn update_last_transmit(&self, port: VirtualPort) {
let mut inner = self.inner.write().await; let mut inner = self.inner.write().await;
if let Some(peer) = inner.peer_addr_by_port.get(&port.num()).copied() { if let Some(peer) = inner.peer_addr_by_port.get(&port.num()).copied() {
let pq: &mut DoublePriorityQueue<u16, Instant> = inner let mut pq: &mut DoublePriorityQueue<u16, Instant> = inner
.peer_port_usage .peer_port_usage
.entry(peer.ip()) .entry(peer.ip())
.or_insert_with(Default::default); .or_insert_with(Default::default);
pq.push(port.num(), Instant::now()); pq.push(port.num(), Instant::now());
} }
let pq: &mut DoublePriorityQueue<u16, Instant> = &mut inner.port_usage; let mut pq: &mut DoublePriorityQueue<u16, Instant> = &mut inner.port_usage;
pq.push(port.num(), Instant::now()); pq.push(port.num(), Instant::now());
} }

View file

@ -1,15 +1,10 @@
use crate::config::PortProtocol; use crate::config::PortProtocol;
use crate::events::{BusSender, Event}; use crate::events::{BusSender, Event};
use crate::Bus; use crate::Bus;
use bytes::{BufMut, Bytes, BytesMut}; use smoltcp::phy::{Device, DeviceCapabilities, Medium};
use smoltcp::{ use smoltcp::time::Instant;
phy::{DeviceCapabilities, Medium}, use std::collections::VecDeque;
time::Instant, use std::sync::{Arc, Mutex};
};
use std::{
collections::VecDeque,
sync::{Arc, Mutex},
};
/// A virtual device that processes IP packets through smoltcp and WireGuard. /// A virtual device that processes IP packets through smoltcp and WireGuard.
pub struct VirtualIpDevice { pub struct VirtualIpDevice {
@ -18,7 +13,7 @@ pub struct VirtualIpDevice {
/// Channel receiver for received IP packets. /// Channel receiver for received IP packets.
bus_sender: BusSender, bus_sender: BusSender,
/// Local queue for packets received from the bus that need to go through the smoltcp interface. /// Local queue for packets received from the bus that need to go through the smoltcp interface.
process_queue: Arc<Mutex<VecDeque<Bytes>>>, process_queue: Arc<Mutex<VecDeque<Vec<u8>>>>,
} }
impl VirtualIpDevice { impl VirtualIpDevice {
@ -54,17 +49,11 @@ impl VirtualIpDevice {
} }
} }
impl smoltcp::phy::Device for VirtualIpDevice { impl<'a> Device<'a> for VirtualIpDevice {
type RxToken<'a> type RxToken = RxToken;
= RxToken type TxToken = TxToken;
where
Self: 'a;
type TxToken<'a>
= TxToken
where
Self: 'a;
fn receive(&mut self, _timestamp: Instant) -> Option<(Self::RxToken<'_>, Self::TxToken<'_>)> { fn receive(&'a mut self) -> Option<(Self::RxToken, Self::TxToken)> {
let next = { let next = {
let mut queue = self let mut queue = self
.process_queue .process_queue
@ -74,13 +63,7 @@ impl smoltcp::phy::Device for VirtualIpDevice {
}; };
match next { match next {
Some(buffer) => Some(( Some(buffer) => Some((
Self::RxToken { Self::RxToken { buffer },
buffer: {
let mut buf = BytesMut::new();
buf.put(buffer);
buf
},
},
Self::TxToken { Self::TxToken {
sender: self.bus_sender.clone(), sender: self.bus_sender.clone(),
}, },
@ -89,7 +72,7 @@ impl smoltcp::phy::Device for VirtualIpDevice {
} }
} }
fn transmit(&mut self, _timestamp: Instant) -> Option<Self::TxToken<'_>> { fn transmit(&'a mut self) -> Option<Self::TxToken> {
Some(TxToken { Some(TxToken {
sender: self.bus_sender.clone(), sender: self.bus_sender.clone(),
}) })
@ -105,15 +88,15 @@ impl smoltcp::phy::Device for VirtualIpDevice {
#[doc(hidden)] #[doc(hidden)]
pub struct RxToken { pub struct RxToken {
buffer: BytesMut, buffer: Vec<u8>,
} }
impl smoltcp::phy::RxToken for RxToken { impl smoltcp::phy::RxToken for RxToken {
fn consume<R, F>(self, f: F) -> R fn consume<R, F>(mut self, _timestamp: Instant, f: F) -> smoltcp::Result<R>
where where
F: FnOnce(&[u8]) -> R, F: FnOnce(&mut [u8]) -> smoltcp::Result<R>,
{ {
f(&self.buffer) f(&mut self.buffer)
} }
} }
@ -123,14 +106,14 @@ pub struct TxToken {
} }
impl smoltcp::phy::TxToken for TxToken { impl smoltcp::phy::TxToken for TxToken {
fn consume<R, F>(self, len: usize, f: F) -> R fn consume<R, F>(self, _timestamp: Instant, len: usize, f: F) -> smoltcp::Result<R>
where where
F: FnOnce(&mut [u8]) -> R, F: FnOnce(&mut [u8]) -> smoltcp::Result<R>,
{ {
let mut buffer = vec![0; len]; let mut buffer = Vec::new();
buffer.resize(len, 0);
let result = f(&mut buffer); let result = f(&mut buffer);
self.sender self.sender.send(Event::OutboundInternetPacket(buffer));
.send(Event::OutboundInternetPacket(buffer.into()));
result result
} }
} }

View file

@ -5,19 +5,12 @@ use crate::virtual_iface::{VirtualInterfacePoll, VirtualPort};
use crate::Bus; use crate::Bus;
use anyhow::Context; use anyhow::Context;
use async_trait::async_trait; use async_trait::async_trait;
use bytes::Bytes; use smoltcp::iface::{InterfaceBuilder, SocketHandle};
use smoltcp::iface::PollResult; use smoltcp::socket::{TcpSocket, TcpSocketBuffer, TcpState};
use smoltcp::{ use smoltcp::wire::{IpAddress, IpCidr};
iface::{Config, Interface, SocketHandle, SocketSet}, use std::collections::{HashMap, HashSet, VecDeque};
socket::tcp, use std::net::IpAddr;
time::Instant, use std::time::Duration;
wire::{HardwareAddress, IpAddress, IpCidr, IpVersion},
};
use std::{
collections::{HashMap, HashSet, VecDeque},
net::IpAddr,
time::Duration,
};
const MAX_PACKET: usize = 65536; const MAX_PACKET: usize = 65536;
@ -26,7 +19,6 @@ pub struct TcpVirtualInterface {
source_peer_ip: IpAddr, source_peer_ip: IpAddr,
port_forwards: Vec<PortForwardConfig>, port_forwards: Vec<PortForwardConfig>,
bus: Bus, bus: Bus,
sockets: SocketSet<'static>,
} }
impl TcpVirtualInterface { impl TcpVirtualInterface {
@ -40,34 +32,33 @@ impl TcpVirtualInterface {
.collect(), .collect(),
source_peer_ip, source_peer_ip,
bus, bus,
sockets: SocketSet::new([]),
} }
} }
fn new_server_socket(port_forward: PortForwardConfig) -> anyhow::Result<tcp::Socket<'static>> { fn new_server_socket(port_forward: PortForwardConfig) -> anyhow::Result<TcpSocket<'static>> {
static mut TCP_SERVER_RX_DATA: [u8; 0] = []; static mut TCP_SERVER_RX_DATA: [u8; 0] = [];
static mut TCP_SERVER_TX_DATA: [u8; 0] = []; static mut TCP_SERVER_TX_DATA: [u8; 0] = [];
let tcp_rx_buffer = tcp::SocketBuffer::new(unsafe { &mut TCP_SERVER_RX_DATA[..] }); let tcp_rx_buffer = TcpSocketBuffer::new(unsafe { &mut TCP_SERVER_RX_DATA[..] });
let tcp_tx_buffer = tcp::SocketBuffer::new(unsafe { &mut TCP_SERVER_TX_DATA[..] }); let tcp_tx_buffer = TcpSocketBuffer::new(unsafe { &mut TCP_SERVER_TX_DATA[..] });
let mut socket = tcp::Socket::new(tcp_rx_buffer, tcp_tx_buffer); let mut socket = TcpSocket::new(tcp_rx_buffer, tcp_tx_buffer);
socket socket
.listen(( .listen((
IpAddress::from(port_forward.destination.ip()), IpAddress::from(port_forward.destination.ip()),
port_forward.destination.port(), port_forward.destination.port(),
)) ))
.context("Virtual server socket failed to listen")?; .with_context(|| "Virtual server socket failed to listen")?;
Ok(socket) Ok(socket)
} }
fn new_client_socket() -> anyhow::Result<tcp::Socket<'static>> { fn new_client_socket() -> anyhow::Result<TcpSocket<'static>> {
let rx_data = vec![0u8; MAX_PACKET]; let rx_data = vec![0u8; MAX_PACKET];
let tx_data = vec![0u8; MAX_PACKET]; let tx_data = vec![0u8; MAX_PACKET];
let tcp_rx_buffer = tcp::SocketBuffer::new(rx_data); let tcp_rx_buffer = TcpSocketBuffer::new(rx_data);
let tcp_tx_buffer = tcp::SocketBuffer::new(tx_data); let tcp_tx_buffer = TcpSocketBuffer::new(tx_data);
let socket = tcp::Socket::new(tcp_rx_buffer, tcp_tx_buffer); let socket = TcpSocket::new(tcp_rx_buffer, tcp_tx_buffer);
Ok(socket) Ok(socket)
} }
@ -79,32 +70,26 @@ impl TcpVirtualInterface {
} }
addresses addresses
.into_iter() .into_iter()
.map(|addr| IpCidr::new(addr, addr_length(&addr))) .map(|addr| IpCidr::new(addr, 32))
.collect() .collect()
} }
} }
#[async_trait] #[async_trait]
impl VirtualInterfacePoll for TcpVirtualInterface { impl VirtualInterfacePoll for TcpVirtualInterface {
async fn poll_loop(mut self, mut device: VirtualIpDevice) -> anyhow::Result<()> { async fn poll_loop(self, device: VirtualIpDevice) -> anyhow::Result<()> {
// Create CIDR block for source peer IP + each port forward IP // Create CIDR block for source peer IP + each port forward IP
let addresses = self.addresses(); let addresses = self.addresses();
let config = Config::new(HardwareAddress::Ip);
// Create virtual interface (contains smoltcp state machine) // Create virtual interface (contains smoltcp state machine)
let mut iface = Interface::new(config, &mut device, Instant::now()); let mut iface = InterfaceBuilder::new(device, vec![])
iface.update_ip_addrs(|ip_addrs| { .ip_addrs(addresses)
addresses.into_iter().for_each(|addr| { .finalize();
ip_addrs
.push(addr)
.expect("maximum number of IPs in TCP interface reached");
});
});
// Create virtual server for each port forward // Create virtual server for each port forward
for port_forward in self.port_forwards.iter() { for port_forward in self.port_forwards.iter() {
let server_socket = TcpVirtualInterface::new_server_socket(*port_forward)?; let server_socket = TcpVirtualInterface::new_server_socket(*port_forward)?;
self.sockets.add(server_socket); iface.add_socket(server_socket);
} }
// The next time to poll the interface. Can be None for instant poll. // The next time to poll the interface. Can be None for instant poll.
@ -117,7 +102,7 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
let mut port_client_handle_map: HashMap<VirtualPort, SocketHandle> = HashMap::new(); let mut port_client_handle_map: HashMap<VirtualPort, SocketHandle> = HashMap::new();
// Data packets to send from a virtual client // Data packets to send from a virtual client
let mut send_queue: HashMap<VirtualPort, VecDeque<Bytes>> = HashMap::new(); let mut send_queue: HashMap<VirtualPort, VecDeque<Vec<u8>>> = HashMap::new();
loop { loop {
tokio::select! { tokio::select! {
@ -128,26 +113,17 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
} => { } => {
let loop_start = smoltcp::time::Instant::now(); let loop_start = smoltcp::time::Instant::now();
// Find closed sockets match iface.poll(loop_start) {
port_client_handle_map.retain(|virtual_port, client_handle| { Ok(processed) if processed => {
let client_socket = self.sockets.get_mut::<tcp::Socket>(*client_handle); trace!("TCP virtual interface polled some packets to be processed");
if client_socket.state() == tcp::State::Closed {
endpoint.send(Event::ClientConnectionDropped(*virtual_port));
send_queue.remove(virtual_port);
self.sockets.remove(*client_handle);
false
} else {
// Not closed, retain
true
} }
}); Err(e) => error!("TCP virtual interface poll error: {:?}", e),
_ => {}
if iface.poll(loop_start, &mut device, &mut self.sockets) == PollResult::SocketStateChanged {
log::trace!("TCP virtual interface polled some packets to be processed");
} }
// Find client socket send data to
for (virtual_port, client_handle) in port_client_handle_map.iter() { for (virtual_port, client_handle) in port_client_handle_map.iter() {
let client_socket = self.sockets.get_mut::<tcp::Socket>(*client_handle); let client_socket = iface.get_socket::<TcpSocket>(*client_handle);
if client_socket.can_send() { if client_socket.can_send() {
if let Some(send_queue) = send_queue.get_mut(virtual_port) { if let Some(send_queue) = send_queue.get_mut(virtual_port) {
let to_transfer = send_queue.pop_front(); let to_transfer = send_queue.pop_front();
@ -158,7 +134,7 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
if sent < total { if sent < total {
// Sometimes only a subset is sent, so the rest needs to be sent on the next poll // Sometimes only a subset is sent, so the rest needs to be sent on the next poll
let tx_extra = Vec::from(&to_transfer_slice[sent..total]); let tx_extra = Vec::from(&to_transfer_slice[sent..total]);
send_queue.push_front(tx_extra.into()); send_queue.push_front(tx_extra);
} }
} }
Err(e) => { Err(e) => {
@ -167,17 +143,24 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
); );
} }
} }
} else if client_socket.state() == tcp::State::CloseWait { break;
} else if client_socket.state() == TcpState::CloseWait {
client_socket.close(); client_socket.close();
break;
} }
} }
} }
}
// Find client socket recv data from
for (virtual_port, client_handle) in port_client_handle_map.iter() {
let client_socket = iface.get_socket::<TcpSocket>(*client_handle);
if client_socket.can_recv() { if client_socket.can_recv() {
match client_socket.recv(|buffer| (buffer.len(), Bytes::from(buffer.to_vec()))) { match client_socket.recv(|buffer| (buffer.len(), buffer.to_vec())) {
Ok(data) => { Ok(data) => {
debug!("[{}] Received {} bytes from virtual server", virtual_port, data.len());
if !data.is_empty() { if !data.is_empty() {
endpoint.send(Event::RemoteData(*virtual_port, data)); endpoint.send(Event::RemoteData(*virtual_port, data));
break;
} }
} }
Err(e) => { Err(e) => {
@ -189,8 +172,22 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
} }
} }
// Find closed sockets
port_client_handle_map.retain(|virtual_port, client_handle| {
let client_socket = iface.get_socket::<TcpSocket>(*client_handle);
if client_socket.state() == TcpState::Closed {
endpoint.send(Event::ClientConnectionDropped(*virtual_port));
send_queue.remove(virtual_port);
iface.remove_socket(*client_handle);
false
} else {
// Not closed, retain
true
}
});
// The virtual interface determines the next time to poll (this is to reduce unnecessary polls) // The virtual interface determines the next time to poll (this is to reduce unnecessary polls)
next_poll = match iface.poll_delay(loop_start, &self.sockets) { next_poll = match iface.poll_delay(loop_start) {
Some(smoltcp::time::Duration::ZERO) => None, Some(smoltcp::time::Duration::ZERO) => None,
Some(delay) => { Some(delay) => {
trace!("TCP Virtual interface delayed next poll by {}", delay); trace!("TCP Virtual interface delayed next poll by {}", delay);
@ -203,14 +200,13 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
match event { match event {
Event::ClientConnectionInitiated(port_forward, virtual_port) => { Event::ClientConnectionInitiated(port_forward, virtual_port) => {
let client_socket = TcpVirtualInterface::new_client_socket()?; let client_socket = TcpVirtualInterface::new_client_socket()?;
let client_handle = self.sockets.add(client_socket); let client_handle = iface.add_socket(client_socket);
// Add handle to map // Add handle to map
port_client_handle_map.insert(virtual_port, client_handle); port_client_handle_map.insert(virtual_port, client_handle);
send_queue.insert(virtual_port, VecDeque::new()); send_queue.insert(virtual_port, VecDeque::new());
let client_socket = self.sockets.get_mut::<tcp::Socket>(client_handle); let (client_socket, context) = iface.get_socket_and_context::<TcpSocket>(client_handle);
let context = iface.context();
client_socket client_socket
.connect( .connect(
@ -221,13 +217,17 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
), ),
(IpAddress::from(self.source_peer_ip), virtual_port.num()), (IpAddress::from(self.source_peer_ip), virtual_port.num()),
) )
.context("Virtual server socket failed to listen")?; .with_context(|| "Virtual server socket failed to listen")?;
next_poll = None; next_poll = None;
} }
Event::ClientConnectionDropped(virtual_port) => { Event::ClientConnectionDropped(virtual_port) => {
if let Some(client_handle) = port_client_handle_map.get(&virtual_port) { if let Some(client_handle) = port_client_handle_map.get(&virtual_port) {
let client_socket = self.sockets.get_mut::<tcp::Socket>(*client_handle); let client_handle = *client_handle;
port_client_handle_map.remove(&virtual_port);
send_queue.remove(&virtual_port);
let client_socket = iface.get_socket::<TcpSocket>(client_handle);
client_socket.close(); client_socket.close();
next_poll = None; next_poll = None;
} }
@ -238,7 +238,7 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
next_poll = None; next_poll = None;
} }
} }
Event::VirtualDeviceFed(PortProtocol::Tcp) => { Event::VirtualDeviceFed(protocol) if protocol == PortProtocol::Tcp => {
next_poll = None; next_poll = None;
} }
_ => {} _ => {}
@ -248,10 +248,3 @@ impl VirtualInterfacePoll for TcpVirtualInterface {
} }
} }
} }
const fn addr_length(addr: &IpAddress) -> u8 {
match addr.version() {
IpVersion::Ipv4 => 32,
IpVersion::Ipv6 => 128,
}
}

View file

@ -1,23 +1,20 @@
use crate::config::PortForwardConfig; #![allow(dead_code)]
use anyhow::Context;
use std::collections::{HashMap, HashSet, VecDeque};
use std::net::IpAddr;
use crate::events::Event; use crate::events::Event;
use crate::{Bus, PortProtocol};
use async_trait::async_trait;
use smoltcp::iface::{InterfaceBuilder, SocketHandle};
use smoltcp::socket::{UdpPacketMetadata, UdpSocket, UdpSocketBuffer};
use smoltcp::wire::{IpAddress, IpCidr};
use std::time::Duration;
use crate::config::PortForwardConfig;
use crate::virtual_device::VirtualIpDevice; use crate::virtual_device::VirtualIpDevice;
use crate::virtual_iface::{VirtualInterfacePoll, VirtualPort}; use crate::virtual_iface::{VirtualInterfacePoll, VirtualPort};
use crate::{Bus, PortProtocol};
use anyhow::Context;
use async_trait::async_trait;
use bytes::Bytes;
use smoltcp::iface::PollResult;
use smoltcp::{
iface::{Config, Interface, SocketHandle, SocketSet},
socket::udp::{self, UdpMetadata},
time::Instant,
wire::{HardwareAddress, IpAddress, IpCidr, IpVersion},
};
use std::{
collections::{HashMap, HashSet, VecDeque},
net::IpAddr,
time::Duration,
};
const MAX_PACKET: usize = 65536; const MAX_PACKET: usize = 65536;
@ -25,7 +22,6 @@ pub struct UdpVirtualInterface {
source_peer_ip: IpAddr, source_peer_ip: IpAddr,
port_forwards: Vec<PortForwardConfig>, port_forwards: Vec<PortForwardConfig>,
bus: Bus, bus: Bus,
sockets: SocketSet<'static>,
} }
impl UdpVirtualInterface { impl UdpVirtualInterface {
@ -39,47 +35,44 @@ impl UdpVirtualInterface {
.collect(), .collect(),
source_peer_ip, source_peer_ip,
bus, bus,
sockets: SocketSet::new([]),
} }
} }
fn new_server_socket(port_forward: PortForwardConfig) -> anyhow::Result<udp::Socket<'static>> { fn new_server_socket(port_forward: PortForwardConfig) -> anyhow::Result<UdpSocket<'static>> {
static mut UDP_SERVER_RX_META: [udp::PacketMetadata; 0] = []; static mut UDP_SERVER_RX_META: [UdpPacketMetadata; 0] = [];
static mut UDP_SERVER_RX_DATA: [u8; 0] = []; static mut UDP_SERVER_RX_DATA: [u8; 0] = [];
static mut UDP_SERVER_TX_META: [udp::PacketMetadata; 0] = []; static mut UDP_SERVER_TX_META: [UdpPacketMetadata; 0] = [];
static mut UDP_SERVER_TX_DATA: [u8; 0] = []; static mut UDP_SERVER_TX_DATA: [u8; 0] = [];
let udp_rx_buffer = let udp_rx_buffer = UdpSocketBuffer::new(unsafe { &mut UDP_SERVER_RX_META[..] }, unsafe {
udp::PacketBuffer::new(unsafe { &mut UDP_SERVER_RX_META[..] }, unsafe {
&mut UDP_SERVER_RX_DATA[..] &mut UDP_SERVER_RX_DATA[..]
}); });
let udp_tx_buffer = let udp_tx_buffer = UdpSocketBuffer::new(unsafe { &mut UDP_SERVER_TX_META[..] }, unsafe {
udp::PacketBuffer::new(unsafe { &mut UDP_SERVER_TX_META[..] }, unsafe {
&mut UDP_SERVER_TX_DATA[..] &mut UDP_SERVER_TX_DATA[..]
}); });
let mut socket = udp::Socket::new(udp_rx_buffer, udp_tx_buffer); let mut socket = UdpSocket::new(udp_rx_buffer, udp_tx_buffer);
socket socket
.bind(( .bind((
IpAddress::from(port_forward.destination.ip()), IpAddress::from(port_forward.destination.ip()),
port_forward.destination.port(), port_forward.destination.port(),
)) ))
.context("UDP virtual server socket failed to bind")?; .with_context(|| "UDP virtual server socket failed to bind")?;
Ok(socket) Ok(socket)
} }
fn new_client_socket( fn new_client_socket(
source_peer_ip: IpAddr, source_peer_ip: IpAddr,
client_port: VirtualPort, client_port: VirtualPort,
) -> anyhow::Result<udp::Socket<'static>> { ) -> anyhow::Result<UdpSocket<'static>> {
let rx_meta = vec![udp::PacketMetadata::EMPTY; 10]; let rx_meta = vec![UdpPacketMetadata::EMPTY; 10];
let tx_meta = vec![udp::PacketMetadata::EMPTY; 10]; let tx_meta = vec![UdpPacketMetadata::EMPTY; 10];
let rx_data = vec![0u8; MAX_PACKET]; let rx_data = vec![0u8; MAX_PACKET];
let tx_data = vec![0u8; MAX_PACKET]; let tx_data = vec![0u8; MAX_PACKET];
let udp_rx_buffer = udp::PacketBuffer::new(rx_meta, rx_data); let udp_rx_buffer = UdpSocketBuffer::new(rx_meta, rx_data);
let udp_tx_buffer = udp::PacketBuffer::new(tx_meta, tx_data); let udp_tx_buffer = UdpSocketBuffer::new(tx_meta, tx_data);
let mut socket = udp::Socket::new(udp_rx_buffer, udp_tx_buffer); let mut socket = UdpSocket::new(udp_rx_buffer, udp_tx_buffer);
socket socket
.bind((IpAddress::from(source_peer_ip), client_port.num())) .bind((IpAddress::from(source_peer_ip), client_port.num()))
.context("UDP virtual client failed to bind")?; .with_context(|| "UDP virtual client failed to bind")?;
Ok(socket) Ok(socket)
} }
@ -91,32 +84,26 @@ impl UdpVirtualInterface {
} }
addresses addresses
.into_iter() .into_iter()
.map(|addr| IpCidr::new(addr, addr_length(&addr))) .map(|addr| IpCidr::new(addr, 32))
.collect() .collect()
} }
} }
#[async_trait] #[async_trait]
impl VirtualInterfacePoll for UdpVirtualInterface { impl VirtualInterfacePoll for UdpVirtualInterface {
async fn poll_loop(mut self, mut device: VirtualIpDevice) -> anyhow::Result<()> { async fn poll_loop(self, device: VirtualIpDevice) -> anyhow::Result<()> {
// Create CIDR block for source peer IP + each port forward IP // Create CIDR block for source peer IP + each port forward IP
let addresses = self.addresses(); let addresses = self.addresses();
let config = Config::new(HardwareAddress::Ip);
// Create virtual interface (contains smoltcp state machine) // Create virtual interface (contains smoltcp state machine)
let mut iface = Interface::new(config, &mut device, Instant::now()); let mut iface = InterfaceBuilder::new(device, vec![])
iface.update_ip_addrs(|ip_addrs| { .ip_addrs(addresses)
addresses.into_iter().for_each(|addr| { .finalize();
ip_addrs
.push(addr)
.expect("maximum number of IPs in UDP interface reached");
});
});
// Create virtual server for each port forward // Create virtual server for each port forward
for port_forward in self.port_forwards.iter() { for port_forward in self.port_forwards.iter() {
let server_socket = UdpVirtualInterface::new_server_socket(*port_forward)?; let server_socket = UdpVirtualInterface::new_server_socket(*port_forward)?;
self.sockets.add(server_socket); iface.add_socket(server_socket);
} }
// The next time to poll the interface. Can be None for instant poll. // The next time to poll the interface. Can be None for instant poll.
@ -129,7 +116,7 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
let mut port_client_handle_map: HashMap<VirtualPort, SocketHandle> = HashMap::new(); let mut port_client_handle_map: HashMap<VirtualPort, SocketHandle> = HashMap::new();
// Data packets to send from a virtual client // Data packets to send from a virtual client
let mut send_queue: HashMap<VirtualPort, VecDeque<(PortForwardConfig, Bytes)>> = let mut send_queue: HashMap<VirtualPort, VecDeque<(PortForwardConfig, Vec<u8>)>> =
HashMap::new(); HashMap::new();
loop { loop {
@ -141,12 +128,17 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
} => { } => {
let loop_start = smoltcp::time::Instant::now(); let loop_start = smoltcp::time::Instant::now();
if iface.poll(loop_start, &mut device, &mut self.sockets) == PollResult::SocketStateChanged { match iface.poll(loop_start) {
log::trace!("UDP virtual interface polled some packets to be processed"); Ok(processed) if processed => {
trace!("UDP virtual interface polled some packets to be processed");
}
Err(e) => error!("UDP virtual interface poll error: {:?}", e),
_ => {}
} }
// Find client socket send data to
for (virtual_port, client_handle) in port_client_handle_map.iter() { for (virtual_port, client_handle) in port_client_handle_map.iter() {
let client_socket = self.sockets.get_mut::<udp::Socket>(*client_handle); let client_socket = iface.get_socket::<UdpSocket>(*client_handle);
if client_socket.can_send() { if client_socket.can_send() {
if let Some(send_queue) = send_queue.get_mut(virtual_port) { if let Some(send_queue) = send_queue.get_mut(virtual_port) {
let to_transfer = send_queue.pop_front(); let to_transfer = send_queue.pop_front();
@ -154,7 +146,7 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
client_socket client_socket
.send_slice( .send_slice(
&data, &data,
UdpMetadata::from(port_forward.destination), (IpAddress::from(port_forward.destination.ip()), port_forward.destination.port()).into(),
) )
.unwrap_or_else(|e| { .unwrap_or_else(|e| {
error!( error!(
@ -162,14 +154,21 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
virtual_port, e virtual_port, e
); );
}); });
break;
} }
} }
} }
}
// Find client socket recv data from
for (virtual_port, client_handle) in port_client_handle_map.iter() {
let client_socket = iface.get_socket::<UdpSocket>(*client_handle);
if client_socket.can_recv() { if client_socket.can_recv() {
match client_socket.recv() { match client_socket.recv() {
Ok((data, _peer)) => { Ok((data, _peer)) => {
if !data.is_empty() { if !data.is_empty() {
endpoint.send(Event::RemoteData(*virtual_port, data.to_vec().into())); endpoint.send(Event::RemoteData(*virtual_port, data.to_vec()));
break;
} }
} }
Err(e) => { Err(e) => {
@ -182,7 +181,7 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
} }
// The virtual interface determines the next time to poll (this is to reduce unnecessary polls) // The virtual interface determines the next time to poll (this is to reduce unnecessary polls)
next_poll = match iface.poll_delay(loop_start, &self.sockets) { next_poll = match iface.poll_delay(loop_start) {
Some(smoltcp::time::Duration::ZERO) => None, Some(smoltcp::time::Duration::ZERO) => None,
Some(delay) => { Some(delay) => {
trace!("UDP Virtual interface delayed next poll by {}", delay); trace!("UDP Virtual interface delayed next poll by {}", delay);
@ -200,7 +199,7 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
} else { } else {
// Client socket does not exist // Client socket does not exist
let client_socket = UdpVirtualInterface::new_client_socket(self.source_peer_ip, virtual_port)?; let client_socket = UdpVirtualInterface::new_client_socket(self.source_peer_ip, virtual_port)?;
let client_handle = self.sockets.add(client_socket); let client_handle = iface.add_socket(client_socket);
// Add handle to map // Add handle to map
port_client_handle_map.insert(virtual_port, client_handle); port_client_handle_map.insert(virtual_port, client_handle);
@ -208,7 +207,7 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
} }
next_poll = None; next_poll = None;
} }
Event::VirtualDeviceFed(PortProtocol::Udp) => { Event::VirtualDeviceFed(protocol) if protocol == PortProtocol::Udp => {
next_poll = None; next_poll = None;
} }
_ => {} _ => {}
@ -218,10 +217,3 @@ impl VirtualInterfacePoll for UdpVirtualInterface {
} }
} }
} }
const fn addr_length(addr: &IpAddress) -> u8 {
match addr.version() {
IpVersion::Ipv4 => 32,
IpVersion::Ipv6 => 128,
}
}

View file

@ -1,15 +1,12 @@
use std::net::{IpAddr, SocketAddr}; use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
use std::time::Duration; use std::time::Duration;
use crate::Bus; use crate::Bus;
use anyhow::Context; use anyhow::Context;
use async_recursion::async_recursion;
use boringtun::noise::errors::WireGuardError;
use boringtun::noise::{Tunn, TunnResult}; use boringtun::noise::{Tunn, TunnResult};
use log::Level; use log::Level;
use smoltcp::wire::{IpProtocol, IpVersion, Ipv4Packet, Ipv6Packet}; use smoltcp::wire::{IpProtocol, IpVersion, Ipv4Packet, Ipv6Packet};
use tokio::net::UdpSocket; use tokio::net::UdpSocket;
use tokio::sync::Mutex;
use crate::config::{Config, PortProtocol}; use crate::config::{Config, PortProtocol};
use crate::events::Event; use crate::events::Event;
@ -24,7 +21,7 @@ const MAX_PACKET: usize = 65536;
pub struct WireGuardTunnel { pub struct WireGuardTunnel {
pub(crate) source_peer_ip: IpAddr, pub(crate) source_peer_ip: IpAddr,
/// `boringtun` peer/tunnel implementation, used for crypto & WG protocol. /// `boringtun` peer/tunnel implementation, used for crypto & WG protocol.
peer: Mutex<Box<Tunn>>, peer: Box<Tunn>,
/// The UDP socket for the public WireGuard endpoint to connect to. /// The UDP socket for the public WireGuard endpoint to connect to.
udp: UdpSocket, udp: UdpSocket,
/// The address of the public WireGuard endpoint (UDP). /// The address of the public WireGuard endpoint (UDP).
@ -37,11 +34,14 @@ impl WireGuardTunnel {
/// Initialize a new WireGuard tunnel. /// Initialize a new WireGuard tunnel.
pub async fn new(config: &Config, bus: Bus) -> anyhow::Result<Self> { pub async fn new(config: &Config, bus: Bus) -> anyhow::Result<Self> {
let source_peer_ip = config.source_peer_ip; let source_peer_ip = config.source_peer_ip;
let peer = Mutex::new(Box::new(Self::create_tunnel(config)?)); let peer = Self::create_tunnel(config)?;
let endpoint = config.endpoint_addr; let endpoint = config.endpoint_addr;
let udp = UdpSocket::bind(config.endpoint_bind_addr) let udp = UdpSocket::bind(match endpoint {
SocketAddr::V4(_) => "0.0.0.0:0",
SocketAddr::V6(_) => "[::]:0",
})
.await .await
.context("Failed to create UDP socket for WireGuard connection")?; .with_context(|| "Failed to create UDP socket for WireGuard connection")?;
Ok(Self { Ok(Self {
source_peer_ip, source_peer_ip,
@ -56,16 +56,12 @@ impl WireGuardTunnel {
pub async fn send_ip_packet(&self, packet: &[u8]) -> anyhow::Result<()> { pub async fn send_ip_packet(&self, packet: &[u8]) -> anyhow::Result<()> {
trace_ip_packet("Sending IP packet", packet); trace_ip_packet("Sending IP packet", packet);
let mut send_buf = [0u8; MAX_PACKET]; let mut send_buf = [0u8; MAX_PACKET];
let encapsulate_result = { match self.peer.encapsulate(packet, &mut send_buf) {
let mut peer = self.peer.lock().await;
peer.encapsulate(packet, &mut send_buf)
};
match encapsulate_result {
TunnResult::WriteToNetwork(packet) => { TunnResult::WriteToNetwork(packet) => {
self.udp self.udp
.send_to(packet, self.endpoint) .send_to(packet, self.endpoint)
.await .await
.context("Failed to send encrypted IP packet to WireGuard endpoint.")?; .with_context(|| "Failed to send encrypted IP packet to WireGuard endpoint.")?;
debug!( debug!(
"Sent {} bytes to WireGuard endpoint (encrypted IP packet)", "Sent {} bytes to WireGuard endpoint (encrypted IP packet)",
packet.len() packet.len()
@ -109,14 +105,7 @@ impl WireGuardTunnel {
loop { loop {
let mut send_buf = [0u8; MAX_PACKET]; let mut send_buf = [0u8; MAX_PACKET];
let tun_result = { self.peer.lock().await.update_timers(&mut send_buf) }; match self.peer.update_timers(&mut send_buf) {
self.handle_routine_tun_result(tun_result).await;
}
}
#[async_recursion]
async fn handle_routine_tun_result<'a: 'async_recursion>(&self, result: TunnResult<'a>) -> () {
match result {
TunnResult::WriteToNetwork(packet) => { TunnResult::WriteToNetwork(packet) => {
debug!( debug!(
"Sending routine packet of {} bytes to WireGuard endpoint", "Sending routine packet of {} bytes to WireGuard endpoint",
@ -132,18 +121,6 @@ impl WireGuardTunnel {
} }
}; };
} }
TunnResult::Err(WireGuardError::ConnectionExpired) => {
warn!("Wireguard handshake has expired!");
let mut buf = vec![0u8; MAX_PACKET];
let result = self
.peer
.lock()
.await
.format_handshake_initiation(&mut buf[..], false);
self.handle_routine_tun_result(result).await
}
TunnResult::Err(e) => { TunnResult::Err(e) => {
error!( error!(
"Failed to prepare routine packet for WireGuard endpoint: {:?}", "Failed to prepare routine packet for WireGuard endpoint: {:?}",
@ -157,7 +134,8 @@ impl WireGuardTunnel {
other => { other => {
warn!("Unexpected WireGuard routine task state: {:?}", other); warn!("Unexpected WireGuard routine task state: {:?}", other);
} }
}; }
}
} }
/// WireGuard consumption task. Receives encrypted packets from the WireGuard endpoint, /// WireGuard consumption task. Receives encrypted packets from the WireGuard endpoint,
@ -181,11 +159,7 @@ impl WireGuardTunnel {
}; };
let data = &recv_buf[..size]; let data = &recv_buf[..size];
let decapsulate_result = { match self.peer.decapsulate(None, data, &mut send_buf) {
let mut peer = self.peer.lock().await;
peer.decapsulate(None, data, &mut send_buf)
};
match decapsulate_result {
TunnResult::WriteToNetwork(packet) => { TunnResult::WriteToNetwork(packet) => {
match self.udp.send_to(packet, self.endpoint).await { match self.udp.send_to(packet, self.endpoint).await {
Ok(_) => {} Ok(_) => {}
@ -194,10 +168,9 @@ impl WireGuardTunnel {
continue; continue;
} }
}; };
let mut peer = self.peer.lock().await;
loop { loop {
let mut send_buf = [0u8; MAX_PACKET]; let mut send_buf = [0u8; MAX_PACKET];
match peer.decapsulate(None, &[], &mut send_buf) { match self.peer.decapsulate(None, &[], &mut send_buf) {
TunnResult::WriteToNetwork(packet) => { TunnResult::WriteToNetwork(packet) => {
match self.udp.send_to(packet, self.endpoint).await { match self.udp.send_to(packet, self.endpoint).await {
Ok(_) => {} Ok(_) => {}
@ -223,7 +196,7 @@ impl WireGuardTunnel {
trace_ip_packet("Received IP packet", packet); trace_ip_packet("Received IP packet", packet);
if let Some(proto) = self.route_protocol(packet) { if let Some(proto) = self.route_protocol(packet) {
endpoint.send(Event::InboundInternetPacket(proto, packet.to_vec().into())); endpoint.send(Event::InboundInternetPacket(proto, packet.into()));
} }
} }
_ => {} _ => {}
@ -231,20 +204,17 @@ impl WireGuardTunnel {
} }
} }
fn create_tunnel(config: &Config) -> anyhow::Result<Tunn> { fn create_tunnel(config: &Config) -> anyhow::Result<Box<Tunn>> {
let private = config.private_key.as_ref().clone();
let public = *config.endpoint_public_key.as_ref();
Tunn::new( Tunn::new(
private, config.private_key.clone(),
public, config.endpoint_public_key.clone(),
config.preshared_key, None,
config.keepalive_seconds, config.keepalive_seconds,
0, 0,
None, None,
) )
.map_err(|s| anyhow::anyhow!("{}", s)) .map_err(|s| anyhow::anyhow!("{}", s))
.context("Failed to initialize boringtun Tunn") .with_context(|| "Failed to initialize boringtun Tunn")
} }
/// Determine the inner protocol of the incoming IP packet (TCP/UDP). /// Determine the inner protocol of the incoming IP packet (TCP/UDP).
@ -253,23 +223,25 @@ impl WireGuardTunnel {
Ok(IpVersion::Ipv4) => Ipv4Packet::new_checked(&packet) Ok(IpVersion::Ipv4) => Ipv4Packet::new_checked(&packet)
.ok() .ok()
// Only care if the packet is destined for this tunnel // Only care if the packet is destined for this tunnel
.filter(|packet| packet.dst_addr() == self.source_peer_ip) .filter(|packet| Ipv4Addr::from(packet.dst_addr()) == self.source_peer_ip)
.and_then(|packet| match packet.next_header() { .map(|packet| match packet.protocol() {
IpProtocol::Tcp => Some(PortProtocol::Tcp), IpProtocol::Tcp => Some(PortProtocol::Tcp),
IpProtocol::Udp => Some(PortProtocol::Udp), IpProtocol::Udp => Some(PortProtocol::Udp),
// Unrecognized protocol, so we cannot determine where to route // Unrecognized protocol, so we cannot determine where to route
_ => None, _ => None,
}), })
.flatten(),
Ok(IpVersion::Ipv6) => Ipv6Packet::new_checked(&packet) Ok(IpVersion::Ipv6) => Ipv6Packet::new_checked(&packet)
.ok() .ok()
// Only care if the packet is destined for this tunnel // Only care if the packet is destined for this tunnel
.filter(|packet| packet.dst_addr() == self.source_peer_ip) .filter(|packet| Ipv6Addr::from(packet.dst_addr()) == self.source_peer_ip)
.and_then(|packet| match packet.next_header() { .map(|packet| match packet.next_header() {
IpProtocol::Tcp => Some(PortProtocol::Tcp), IpProtocol::Tcp => Some(PortProtocol::Tcp),
IpProtocol::Udp => Some(PortProtocol::Udp), IpProtocol::Udp => Some(PortProtocol::Udp),
// Unrecognized protocol, so we cannot determine where to route // Unrecognized protocol, so we cannot determine where to route
_ => None, _ => None,
}), })
.flatten(),
_ => None, _ => None,
} }
} }