Async TUN/TAP

Asynchronous allocation of TUN/TAP devices in Rust using async-std. Use tokio-tun for tokio version.

Getting Started

• Create a tun device using TunBuilder and read from it in a loop:

```rust use asyncstd::os::unix::io::AsRawFd; use asyncstd::prelude::*; use asyncstd::task; use asynctun::result::Result; use async_tun::TunBuilder; use std::net::Ipv4Addr;

async fn asyncmain() -> Result<()> { let tun = TunBuilder::new() .name("") // if name is empty, then it is set by kernel. .tap(false) // false (default): TUN, true: TAP. .packetinfo(false) // false: IFFNOPI, default is true. .up() // or set it up manually using sudo ip link set <tun-name> up. .try_build() // or .try_build_mq(queues) for multi-queue support. .await?;

println!("tun created, name: {}, fd: {}", tun.name(), tun.as_raw_fd());

let mut reader = tun.reader();
let mut buf = [0u8; 1024];
loop {
    let n = reader.read(&mut buf).await?;
    println!("reading {} bytes: {:?}", n, &buf[..n]);
}

}

fn main() -> Result<()> { task::blockon(asyncmain()) } ```

• Run the code using sudo:

bash ➜ sudo -E /path/to/cargo run

• Set the address of device (address and netmask could also be set using TunBuilder):

bash ➜ sudo ip a add 10.0.0.1/24 dev <tun-name>

• Ping to read packets:

bash ➜ ping 10.0.0.2

• Display devices and analyze the network traffic:

➜ ip tuntap ➜ sudo tshark -i <tun-name>

Supported Platforms

• [x] Linux
• [ ] FreeBSD
• [ ] Android
• [ ] OSX
• [ ] iOS
• [ ] Windows

Examples

• read: Split tun to (reader, writer) pair and read packets from reader.
• read-mq: Read from multi-queue tun.