tun

Documentation

Index

• Constants
• Variables
• type Device
  • func CreateTUN(ifname string, mtu int) (Device, error)
  • func CreateTUNWithRequestedGUID(ifname string, requestedGUID *windows.GUID, mtu int) (Device, error)
• type Event
• type NativeTun
  • func (tun *NativeTun) Close() error
  • func (tun *NativeTun) Events() chan Event
  • func (tun *NativeTun) File() *os.File
  • func (tun *NativeTun) Flush() error
  • func (tun *NativeTun) ForceMTU(mtu int)
  • func (tun *NativeTun) LUID() uint64
  • func (tun *NativeTun) MTU() (int, error)
  • func (tun *NativeTun) Name() (string, error)
  • func (tun *NativeTun) Read(buff []byte, offset int) (int, error)
  • func (tun *NativeTun) RunningVersion() (version uint32, err error)
  • func (tun *NativeTun) Write(buff []byte, offset int) (int, error)

Constants

const (
	EventUp = 1 << iota
	EventDown
	EventMTUUpdate
)

Variables

var WintunPool *wintun.Pool

Types

type Device

type Device interface {
	File() *os.File                 // returns the file descriptor of the device
	Read([]byte, int) (int, error)  // read a packet from the device (without any additional headers)
	Write([]byte, int) (int, error) // writes a packet to the device (without any additional headers)
	Flush() error                   // flush all previous writes to the device
	MTU() (int, error)              // returns the MTU of the device
	Name() (string, error)          // fetches and returns the current name
	Events() chan Event             // returns a constant channel of events related to the device
	Close() error                   // stops the device and closes the event channel
}

func CreateTUN

func CreateTUN(ifname string, mtu int) (Device, error)

CreateTUN creates a Wintun interface with the given name. Should a Wintun interface with the same name exist, it is reused.

func CreateTUNWithRequestedGUID

func CreateTUNWithRequestedGUID(ifname string, requestedGUID *windows.GUID, mtu int) (Device, error)

CreateTUNWithRequestedGUID creates a Wintun interface with the given name and a requested GUID. Should a Wintun interface with the same name exist, it is reused.

type Event

type Event int

type NativeTun

type NativeTun struct {
	// contains filtered or unexported fields
}

func (*NativeTun) Close

func (tun *NativeTun) Close() error

func (*NativeTun) Events

func (tun *NativeTun) Events() chan Event

func (*NativeTun) File

func (tun *NativeTun) File() *os.File

func (*NativeTun) Flush

func (tun *NativeTun) Flush() error

func (*NativeTun) ForceMTU

func (tun *NativeTun) ForceMTU(mtu int)

TODO: This is a temporary hack. We really need to be monitoring the interface in real time and adapting to MTU changes.

func (*NativeTun) LUID

func (tun *NativeTun) LUID() uint64

LUID returns Windows interface instance ID.

func (*NativeTun) MTU

func (tun *NativeTun) MTU() (int, error)

func (*NativeTun) Name

func (tun *NativeTun) Name() (string, error)

func (*NativeTun) Read

func (tun *NativeTun) Read(buff []byte, offset int) (int, error)

func (*NativeTun) RunningVersion

func (tun *NativeTun) RunningVersion() (version uint32, err error)

RunningVersion returns the running version of the Wintun driver.

func (*NativeTun) Write

func (tun *NativeTun) Write(buff []byte, offset int) (int, error)