async-tun 0.4.0

Asynchronous allocation of TUN/TAP devices
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# Async TUN/TAP

[![Build](https://github.com/yaa110/async-tun/workflows/Build/badge.svg)](https://github.com/yaa110/async-tun/actions) [![crates.io](https://img.shields.io/crates/v/async-tun.svg)](https://crates.io/crates/async-tun) [![Documentation](https://img.shields.io/badge/docs-async--tun-blue.svg)](https://docs.rs/async-tun)

Asynchronous allocation of TUN/TAP devices in Rust using [`async-std`](https://crates.io/crates/async-std).

## Getting Started

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

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

async fn async_main() -> Result<()> {
    let mut 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()
        .await?;

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

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

fn main() -> Result<()> {
    task::block_on(async_main())
}
```

- 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 (without Multi-Queue)
- [ ] FreeBSD
- [ ] OpenBSD
- [ ] NetBSD
- [ ] Android
- [ ] OSX
- [ ] iOS
- [ ] Solaris
- [ ] Windows
- [ ] QNX