Struct defguard_wireguard_rs::WGApi

pub struct WGApi(/* private fields */);

Shared multi-platform WireGuard management API

This struct adds an additional level of abstraction and can be used to detect the correct API implementation for most common platforms.

Implementations

impl WGApi

pub fn new( ifname: String, userspace: bool ) -> Result<Self, WireguardInterfaceError>

Create new instance of WGApi.

Errors

Will return WireguardInterfaceError is platform is not supported.

Trait Implementations

impl WireguardInterfaceApi for WGApi

fn create_interface(&self) -> Result<(), WireguardInterfaceError>

Creates a new WireGuard interface.

fn assign_address( &self, address: &IpAddrMask ) -> Result<(), WireguardInterfaceError>

Assigns IP address to an existing interface.

fn configure_peer_routing( &self, peers: &[Peer] ) -> Result<(), WireguardInterfaceError>

Add peer routing, basically a copy of wg-quick up <if_name> routing. Extracts all uniques allowed ips from Peer slice and add routing for every address.

fn configure_interface( &self, config: &InterfaceConfiguration ) -> Result<(), WireguardInterfaceError>

Updates configuration of an existing WireGuard interface.

fn remove_interface(&self) -> Result<(), WireguardInterfaceError>

Removes the WireGuard interface being managed.

fn configure_peer(&self, peer: &Peer) -> Result<(), WireguardInterfaceError>

Adds a peer or updates peer configuration.

fn configure_dns(&self, dns: &[IpAddr]) -> Result<(), WireguardInterfaceError>

Sets the DNS configuration for the WireGuard interface.

fn remove_peer(&self, peer_pubkey: &Key) -> Result<(), WireguardInterfaceError>

Removes a configured peer with a given pubkey.

fn read_interface_data(&self) -> Result<Host, WireguardInterfaceError>

Reads current WireGuard interface configuration and stats.