wiretun 0.5.0

WireGuard 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
47
48
49
50
51
52
53
54
55
56
57
58

#![deny(
    warnings,
    rust_2018_idioms,
    clippy::clone_on_ref_ptr,
    clippy::dbg_macro,
    clippy::enum_glob_use,
    clippy::get_unwrap,
    clippy::macro_use_imports,
    clippy::str_to_string,
    clippy::inefficient_to_string,
    clippy::too_many_lines,
    clippy::or_fun_call
)]

//! # WireTun
//!
//! WireTun is a user-space WireGuard implementation in Rust.
//!
//! ## What is WireGuard?
//!
//! WireGuard is a modern, high-performance VPN protocol that is designed to be simple to use and easy to configure.
//! It is often used to create secure private networks and build reliable, low-latency connections.
//!
//! ## Features
//!
//! - Implementation of the [WireGuard](https://www.wireguard.com/) protocol in Rust.
//! - Asynchronous I/O using [Tokio](https://tokio.rs/).
//!
//! # Examples
//!
//! ```no_run
//! use wiretun::{Cidr, Device, DeviceConfig, PeerConfig};
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!    let cfg = DeviceConfig::default()
//!        .listen_port(40001);
//!    let device = Device::native("utun88", cfg).await?;
//!    Ok(())
//! }

mod device;
pub mod noise;
mod tun;

pub use device::{
    Cidr, Device, DeviceConfig, DeviceControl, Endpoint, ParseCidrError, PeerConfig, Transport,
    UdpTransport,
};
pub use noise::crypto::{LocalStaticSecret, PeerStaticSecret};
pub use tun::{Error as TunError, Tun};

#[cfg(feature = "native")]
/// Native tun implementation.
pub use tun::NativeTun;

#[cfg(feature = "uapi")]
pub mod uapi;