qkniep / pqwg-rust

PQ-safe userspace WireGuard® Implementation in Rust

PQ-WG in Rust

Proof-of-concept implementation for the Bachelor's thesis "Post-Quantum Cryptography in WireGuard VPN". This is a user space implementation of the WireGuard^® protocol and modified post-quantum protocols. This branch implements the original WireGuard protocol and the L1 handshake as explained in the thesis.

To use the L2 and L3 handshake protocols, you have to switch to the lvl23 branch:

git checkout lvl23

Benchmarks are run with the following commands:

cargo bench --features pqlvl0 -- Handshake --measurement-time 60 --sample-size 100
cargo bench --features pqlvl1 -- Handshake --measurement-time 60 --sample-size 100

cargo bench --features pqlvl0 -- NPackets --measurement-time 60 --sample-size 100
cargo bench --features pqlvl1 -- NPackets --measurement-time 60 --sample-size 100

Where --measurement-time and --sample-size are the Criterion.rs parameters, which are in this example set to 60 seconds and 100 samples respectively.

The parmeter pqlvl0 makes the benchmark use the WireGuard protocol, and pqlvl1 uses the L1 handshake protocol. And where Handshake measures just the handshake and on packet sent over the tunnel, and NPackets runs a series of tests with different numbers of packets, which can be specified in benches/mybench.rs, by changing the following vector to be the numbers of packets for the different runs:

vec![1u32, 2000u32],

To switch the PQ cryptographic primitive, the file src/crypto/pqcrypto/mod.rs has to be changed in the following lines:

mod kyber1024;
pub use kyber1024::*;

The string kyber1024 has to be replace with on of the supported values for the cryptographic primitive:

• kyber512, kyber768, kyber1024
• lightsaber, firesaber
• newhope512, newhope1024
• ntru2048, ntru4096
• sidhp434, sidhp751, sidhp751comp

Dependencies

The liboqs C-library needs to be installed to use the project, as it is used via FFI bindings.

License

The project is licensed under the 3-Clause BSD License.

BELOW IS THE ORIGINAL README FILE OF THE BORINGTUN PROJECT.

BoringTun

BoringTun is an implementation of the WireGuard^® protocol designed for portability and speed.

The project consists of two parts:

• The executable boringtun, a userspace WireGuard implementation for Linux and macOS.
• The library boringtun that can be used to implement fast and efficient WireGuard client apps on various platforms, including iOS and Android. It implements the underlying WireGuard protocol, without the network or tunnel stacks, those can be implemented in a platform idiomatic way.

⚠️ NOTE: This crate is still undergoing review for security concerns. Therefore, we recommend that you take caution before using it in a production application.

Installation

You can install this project using cargo:

cargo install boringtun

Building

• Library only: cargo build --lib --release [--target $(TARGET_TRIPLE)]
• Executable: cargo build --bin boringtun --release [--target $(TARGET_TRIPLE)]

By default the executable is placed in the ./target/release folder. You can copy it to a desired location manually, or install it using cargo install --bin boringtun --path ..

Running

As per the specification, to start a tunnel use:

boringtun [-f/--foreground] INTERFACE-NAME

The tunnel can then be configured using wg, as a regular WireGuard tunnel, or any other tool.

It is also possible to use with wg-quick by setting the environment variable WG_QUICK_USERSPACE_IMPLEMENTATION to boringtun. For example:

sudo WG_QUICK_USERSPACE_IMPLEMENTATION=boringtun WG_SUDO=1 wg-quick up CONFIGURATION

Testing

Testing this project has a few requirements:

• sudo: required to create tunnels. When you run cargo test you'll be prompted for your password.
• Docker: you can install it here. If you are on Ubuntu/Debian you can run apt-get install docker.io.

Benchmarking

To benchmark this project you can run this command:

cargo +nightly bench

This command depends on the unstable test feature of the Rust compiler. As a result, you'll need to use the nightly channel of Rust when you run it.

Supported platforms

Target triple	Binary	Library
x86_64-unknown-linux-gnu	✓	✓
aarch64-unknown-linux-gnu	✓	✓
armv7-unknown-linux-gnueabihf	✓	✓
x86_64-apple-darwin	✓	✓
x86_64-pc-windows-msvc		✓
aarch64-apple-ios		✓	FFI bindings
armv7-apple-ios		✓	FFI bindings
armv7s-apple-ios		✓	FFI bindings
aarch64-linux-android		✓	JNI bindings
arm-linux-androideabi		✓	JNI bindings

_{Other platforms may be added in the future}

Linux

x86-64, aarch64 and armv7 architectures are supported. The behaviour should be identical to that of wireguard-go, with the following difference:

boringtun will drop privileges when started. When privileges are dropped it is not possible to set fwmark. If fwmark is required, such as when using wg-quick, instead running with sudo, give the executable the CAP_NET_ADMIN capability using: sudo setcap cap_net_admin+epi boringtun. Alternatively run with --disable-drop-privileges or set the environment variable WG_SUDO=1.

macOS

The behaviour is similar to that of wireguard-go. Specifically the interface name must be utun[0-9]+ for an explicit interface name or utun to have the kernel select the lowest available. If you choose utun as the interface name, and the environment variable WG_TUN_NAME_FILE is defined, then the actual name of the interface chosen by the kernel is written to the file specified by that variable.

---

FFI bindings

The library exposes a set of C ABI bindings, those are defined in the wireguard_ffi.h header file. The C bindings can be used with C/C++, Swift (using a bridging header) or C# (using DLLImport with CallingConvention set to Cdecl).

JNI bindings

The library exposes a set of Java Native Interface bindings, those are defined in src/jni.rs.

License

The project is licensed under the 3-Clause BSD License.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the 3-Clause BSD License, shall licensed as above, without any additional terms or conditions.

If you want to contribute to this project, please read our CONTRIBUTING.md.

---

_{WireGuard is a registered trademark of Jason A. Donenfeld. BoringTun is not sponsored or endorsed by Jason A. Donenfeld.}