#wireguard #vpn #network-security #networking #linux-networking

defguard_wireguard_rs

A unified multi-platform high-level API for managing WireGuard interfaces

10 releases

0.4.2 Feb 8, 2024
0.4.1 Feb 5, 2024
0.4.0 Jan 25, 2024
0.3.2 Dec 19, 2023
0.2.3 Oct 16, 2023

#585 in Network programming

Download history 495/week @ 2024-08-08 611/week @ 2024-08-15 671/week @ 2024-08-22 737/week @ 2024-08-29 798/week @ 2024-09-05 620/week @ 2024-09-12 782/week @ 2024-09-19 330/week @ 2024-09-26 351/week @ 2024-10-03 291/week @ 2024-10-10 190/week @ 2024-10-17 151/week @ 2024-10-24 201/week @ 2024-10-31 182/week @ 2024-11-07 103/week @ 2024-11-14 71/week @ 2024-11-21

612 downloads per month
Used in 2 crates

Apache-2.0

165KB
4K SLoC

defguard

defguard_wireguard_rs is a multi-platform Rust library providing a unified high-level API for managing WireGuard interfaces using native OS kernel and userspace WireGuard protocol implementations. It can be used to create your own WireGuard™️ VPN servers or clients for secure and private networking.

It was developed as part of defguard security platform and used in the gateway/server as well as desktop client.

Supported platforms

  • Native OS Kernel: Linux, FreeBSD (and pfSense/OPNSense), Windows
  • Userspace using wireguard-go - Linux, macOS, FreeBSD

Unique features

  • Peer routing - see WGApi docs.
  • Configuring DNS resolver - see WGApi docs.
    • On FreeBSD network interfaces are managed using ioctl.
    • On Linux, handle network routing using netlink.
    • fwmark handling

Windows support

Please note that WireGuard needs to be installed on Windows with commands wg and wireguard available to be called from the command line.

Note on wireguard-go

If you intend to use the userspace WireGuard implementation you should note that currently the library assumes that the wireguard-go binary will be available at runtime. There are some sanity checks when instantiating the API, but installing it is outside the scope of this project.

Examples

Documentation

See the documentation for more information.

Community and Support

Find us on Matrix: #defguard:teonite.com

Contribution

Please review the Contributing guide for information on how to get started contributing to the project. You might also find our environment setup guide handy.

Legal

WireGuard is registered trademarks of Jason A. Donenfeld.

Dependencies

~0.6–2MB
~44K SLoC