tun

Documentation

Index

• Constants
• type NativeTun
  • func (tun *NativeTun) Close() error
  • func (tun *NativeTun) Events() chan TUNEvent
  • func (tun *NativeTun) File() *os.File
  • func (tun *NativeTun) Flush() error
  • func (tun *NativeTun) ForceMTU(mtu int)
  • func (tun *NativeTun) GUID() windows.GUID
  • 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) Write(buff []byte, offset int) (int, error)
• type TUNDevice
  • func CreateTUN(ifname string) (TUNDevice, error)
• type TUNEvent

Constants

const (
	TUNEventUp = 1 << iota
	TUNEventDown
	TUNEventMTUUpdate
)

Types

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 TUNEvent

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) GUID

func (tun *NativeTun) GUID() windows.GUID

GUID returns Windows adapter instance ID.

func (*NativeTun) LUID

func (tun *NativeTun) LUID() uint64

GUID returns Windows adapter 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) Write

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

type TUNDevice

type TUNDevice 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 TUNEvent          // 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) (TUNDevice, error)

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

type TUNEvent

type TUNEvent int