3 releases (breaking)
0.5.1 | Apr 16, 2022 |
---|---|
0.4.0 | Nov 2, 2021 |
0.3.16 | Sep 23, 2021 |
#1518 in Asynchronous
33KB
701 lines
Tokio TUN/TAP
Asynchronous allocation of TUN/TAP devices in Rust using tokio
. Use async-tun for async-std
version.
Getting Started
- Create a tun device using
TunBuilder
and read from it in a loop:
#[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
Dependencies
~4–16MB
~154K SLoC