Skip to content
This repository has been archived by the owner. It is now read-only.
Native Go Wrapper for TUN/TAP devices on Linux and Mac OS X
Go
Branch: master
Clone or download

Latest commit

Latest commit cb1fb27 Jul 12, 2019

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Replace ICMP example with packet dump example Feb 11, 2016
LICENSE Initial Commit Feb 10, 2016
README.md add maintenance notice Jul 12, 2019
device_darwin.go
device_linux.go improve cross platform error handling, raise errors when device is no… Feb 11, 2016
device_unsupported.go Initial Commit Feb 10, 2016
interface.go

README.md

This repository is unmaintained: You should use the more comprehensive and well maintained water library.

TUN/TAP

GoDoc License

NOTE: This package is new and should be considered unstable, in terms of both API and function.

tuntap is a native wrapper for interfacing with TUN/TAP network devices in an idiomatic fashion.

Currently supported are Linux and Mac OS X.

go get github.com/jamescun/tuntap

Configuration

The configuration required to open a TUN/TAP device varies by platform. The differences are noted below.

Linux

When creating a TUN/TAP device, Linux expects to be given a name for the new interface, and a new interface will be allocated for it by the kernel module. If left blank, one will be generated (tun|tap)([0-9]+).

tap, err := tuntap.Tap("tap1") // created tap1 device if available
tun, err := tuntap.Tun("")     // created tun device at first available id (tun0)

Mac OS X

On startup, the Mac OS X TUN/TAP kernel extension will allocate multiple TUN/TAP devices, up to the maximum number of each. When creating a TUN/TAP device, Mac OS X expects to be given a path to an unused device. If left blank, this package will attempt to find the first unused one.

tap, err := tuntap.Tap("/dev/tap1") // open tap1 device if unused
tun, err := tuntap.Tun("")          // open first available tun device (tun0)

Additionally, unlike Linux, a TUN/TAP device is not "ready" on OS X until it has an address assigned to it. Any attempt to read from/write to the interface will fail with ErrBusy. It is safe to backoff and try again until a successful operation.

Examples

See the examples directory.

You can’t perform that action at this time.