tun

Documentation

Index

• func Delete(name string) error
• type Option
  • func Address(address string) Option
  • func DestAddress(address string) Option
  • func MTU(mtu int) Option
  • func RemoveRoute(dest net.IPNet) Option
  • func Route(dest net.IPNet) Option
• type TUN
  • func New(name string, opts ...Option) (*TUN, error)
  • func (t *TUN) Apply(opts ...Option) error
  • func (t *TUN) Down() error
  • func (t *TUN) Up() error

Functions

func Delete

func Delete(name string) error

Delete removes a TUN device from the host.

Types

type Option

type Option func(tun *TUN) error

Option defines a TUN device modifier option.

func Address

func Address(address string) Option

Address sets the local address and subnet for an interface. On MacOS devices use this function to set the Src Address for an interface and use DestAddress to set the destination ip.

func DestAddress

func DestAddress(address string) Option

DestAddress sets the destination address for a point-to-point interface. Only use this option on MacOS devices.

func MTU

func MTU(mtu int) Option

MTU sets the Maximum Transmission Unit size for an interface.

func RemoveRoute

func RemoveRoute(dest net.IPNet) Option

RemoveRoute removes an entry from the system route table

func Route

func Route(dest net.IPNet) Option

Route adds an entry to the system route table

type TUN

type TUN struct {
	Iface *water.Interface
	MTU   int
	Src   string
	Dst   string
}

TUN is a struct containing the fields necessary to configure a system TUN device. Access the internal TUN device through TUN.Iface

func New

func New(name string, opts ...Option) (*TUN, error)

New creates and returns a new TUN interface for the application.

func (*TUN) Apply

func (t *TUN) Apply(opts ...Option) error

Apply configures the specified options for a TUN device.

func (*TUN) Down

func (t *TUN) Down() error

Down brings down an interface stopping active connections.

func (*TUN) Up

func (t *TUN) Up() error

Up brings up an interface to allow it to start accepting connections.