Tokio TUN/TAP

Asynchronous allocation of TUN/TAP devices in Rust using tokio.

Getting Started

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

use std::net::Ipv4Addr;
use std::os::unix::io::AsRawFd;
use tokio::prelude::*;
use tokio_tun::result::Result;
use tokio_tun::TunBuilder;

#[tokio::main]
async fn main() -> Result<()> {
    let tun = TunBuilder::new()
        .name("")            // if name is empty, then it is set by kernel.
        .tap(false)          // false (default): TUN, true: TAP.
        .packet_info(false)  // false: IFF_NO_PI, 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.

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

    let (mut reader, mut _writer) = tokio::io::split(tun);

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

• Run the code using sudo:

➜  sudo -E /path/to/cargo run

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

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

• Ping to read packets:

➜  ping 10.0.0.2

• Display devices and analyze the network traffic:

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

Supported Platforms

• 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 using tokio::select!.