Struct boringtun::noise::Tunn

pub struct Tunn { /* fields omitted */ }

Tunnel represents a point-to-point WireGuard connection

Methods

impl Tunn

pub fn tick_handshake_started(&self)

pub fn timer_tick(&self, timer_name: TimerName)

pub fn timer_tick_session_established(&self, is_initiator: bool)

pub fn update_timers<'a>(&self, dst: &'a mut [u8]) -> TunnResult<'a>

pub fn time_since_last_handshake(&self) -> Option<Duration>

pub fn persistent_keepalive(&self) -> Option<u16>

impl Tunn

pub fn new(
    static_private: Arc<X25519SecretKey>,
    peer_static_public: Arc<X25519PublicKey>,
    preshared_key: Option<[u8; 32]>,
    persistent_keepalive: Option<u16>,
    index: u32
) -> Result<Box<Tunn>, &'static str>

Create a new tunnel using own private key and the peer public key

pub fn set_logger(
    &mut self,
    logger: Box<dyn Fn(&str) + Send>,
    verbosity: Verbosity
)

Set the log function and logging level for the tunnel

pub fn set_static_private(
    &self,
    static_private: Arc<X25519SecretKey>
) -> Result<(), WireGuardError>

Update the private key and clear existing sessions

pub fn tunnel_to_network<'a>(
    &self,
    src: &[u8],
    dst: &'a mut [u8]
) -> TunnResult<'a>

Receives an IP packet from the tunnel interface and encapsulates it. Returns wireguard_result.

Panics

Panics if dst buffer is too small. Size of dst should be at least src.len() + 32, and no less than 148 bytes.

pub fn network_to_tunnel<'a>(
    &self,
    src: &[u8],
    dst: &'a mut [u8]
) -> TunnResult<'a>

Receives a UDP packet from the network and parses it. Returns wireguard_result. If the result is of type TunnResult::WriteToNetwork, must repeat the call with empty src, until TunnResult::Done is returned.

pub fn format_handshake_initiation<'a>(
    &self,
    dst: &'a mut [u8],
    force_resend: bool
) -> TunnResult<'a>

pub fn dst_address(packet: &[u8]) -> Option<IpAddr>

pub fn log(&self, lvl: Verbosity, entry: &str)

pub fn stats(&self) -> (Option<u64>, usize, usize)

Return stats from the tunnel:

• Time since last handshake in seconds
• Data bytes sent
• Data bytes received