33 releases
0.9.1 | Sep 18, 2023 |
---|---|
0.9.0 | Jul 9, 2023 |
0.8.0 | Jul 5, 2023 |
0.7.0 | Aug 18, 2022 |
0.2.3 | Oct 28, 2020 |
#89 in Asynchronous
3,663 downloads per month
Used in 3 crates
30KB
653 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
Tun::builder()
and read from it in a loop:
#[tokio::main]
async fn main() {
let tun = Tun::builder()
.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.
.unwrap();
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.unwrap();
println!("reading {} bytes: {:?}", n, &buf[..n]);
}
}
- Run the code using
sudo
:
sudo -E $(which 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 usingtokio::select!
.
sudo -E $(which cargo) run --example read
sudo -E $(which cargo) run --example read-mq
Dependencies
~4–16MB
~165K SLoC