wireguard 0.2.0

The Rust wireguard reference implementation, converted into a usable library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use super::Endpoint;
use std::error::Error;

pub trait Reader<E: Endpoint>: Send + Sync {
    type Error: Error;

    fn read(&self, buf: &mut [u8]) -> Result<(usize, E), Self::Error>;
}

pub trait Writer<E: Endpoint>: Send + Sync + 'static {
    type Error: Error;

    fn write(&self, buf: &[u8], dst: &mut E) -> Result<(), Self::Error>;
}

pub trait UDP: Send + Sync + 'static {
    type Error: Error;
    type Endpoint: Endpoint;

    /* Until Rust gets type equality constraints these have to be generic */
    type Writer: Writer<Self::Endpoint>;
    type Reader: Reader<Self::Endpoint>;
}

/// On platforms where fwmark can be set and the
/// implementation can bind to a new port during later configuration (UAPI support),
/// this type provides the ability to set the fwmark and close the socket (by dropping the instance)
pub trait Owner: Send {
    type Error: Error;

    fn get_port(&self) -> u16;

    fn set_fwmark(&mut self, value: Option<u32>) -> Result<(), Self::Error>;
}

/// On some platforms the application can itself bind to a socket.
/// This enables configuration using the UAPI interface.
pub trait PlatformUDP: UDP {
    type Owner: Owner;

    /// Bind to a new port, returning the reader/writer and
    /// an associated instance of the owner type, which closes the UDP socket upon "drop"
    /// and enables configuration of the fwmark value.
    #[allow(clippy::type_complexity)]
    fn bind(port: u16) -> Result<(Vec<Self::Reader>, Self::Writer, Self::Owner), Self::Error>;
}