tun

package module

Go to main page

Versions in this module

v0

v0.2.6

Apr 8, 2024

v0.2.0

Jan 11, 2024

Changes in this version

+ const OffloadOffset — darwin/amd64, js/wasm, windows/amd64

+ var ErrNetlinkBanned = E.New(...) — linux/amd64

+ var ErrTooManySegments = E.New("too many segments")

+ func BroadcastAddr(inet4Address []netip.Prefix) netip.Addr

+ type LinuxTUN interface

+ BatchRead func(buffers [][]byte, offset int, readN []int) (n int, err error)

+ BatchSize func() int

+ BatchWrite func(buffers [][]byte, offset int) error

+ TXChecksumOffload func() bool

type NativeTun — linux/amd64

+ func (t *NativeTun) BatchRead(buffers [][]byte, offset int, readN []int) (n int, err error)

+ func (t *NativeTun) BatchSize() int

+ func (t *NativeTun) BatchWrite(buffers [][]byte, offset int) error

+ func (t *NativeTun) FrontHeadroom() int

+ func (t *NativeTun) TXChecksumOffload() bool

+ func (t *NativeTun) WriteVectorised(buffers []*buf.Buffer) error

type Options

+ GSO bool

+ Inet4RouteExcludeAddress []netip.Prefix

+ Inet6RouteExcludeAddress []netip.Prefix

+ func (o *Options) BuildAutoRouteRanges(underNetworkExtension bool) ([]netip.Prefix, error)

type StackOptions

+ TunOptions Options

v0.2.0-beta.4

Dec 18, 2023

v0.2.0-beta.1

Dec 14, 2023

v0.1.14

Oct 1, 2023

Changes in this version

type DefaultInterfaceMonitor

+ DefaultInterface func(destination netip.Addr) (string, int)

v0.1.12

Sep 21, 2023

Changes in this version

+ const EventNoRoute

type NativeTun — darwin/amd64, linux/amd64, windows/amd64

+ func (t *NativeTun) CreateVectorisedWriter() N.VectorisedWriter

+ func (t *NativeTun) WriteVectorised(buffers []*buf.Buffer) error

type Options

+ ExcludeInterface []string

+ IncludeInterface []string

+ Logger logger.Logger

type Tun

+ CreateVectorisedWriter func() N.VectorisedWriter

v0.1.11

Aug 1, 2023

Changes in this version

type Stack

+ func NewMixed(options StackOptions) (Stack, error)

v0.1.8

Jul 2, 2023

v0.1.5

May 9, 2023

Changes in this version

type DefaultInterfaceMonitorOptions

+ UnderNetworkExtension bool

type StackOptions

+ ExperimentalFixWindowsFirewall bool

v0.1.4

Apr 22, 2023

Changes in this version

type StackOptions

+ ForwarderBindInterface bool

+ InterfaceFinder control.InterfaceFinder

type TCPSession

+ LastActive time.Time

v0.1.3

Apr 2, 2023

Changes in this version

+ func ActionTypeName(actionType ActionType) (string, error)

+ func NetworkFromName(name string) uint8

+ func NetworkName(network uint8) string

+ type ActionBlock struct

+ func (r *ActionBlock) ActionType() ActionType

+ func (r *ActionBlock) Timeout() bool

+ type ActionDirect struct

+ func (r *ActionDirect) ActionType() ActionType

+ type ActionReturn struct

+ func (r *ActionReturn) ActionType() ActionType

+ func (r *ActionReturn) Timeout() bool

+ type ActionType = uint8

+ const ActionTypeBlock

+ const ActionTypeDirect

+ const ActionTypeReturn

+ const ActionTypeUnknown

+ func ParseActionType(action string) (ActionType, error)

+ type DirectDestination interface

+ Close func() error

+ Timeout func() bool

+ WritePacket func(buffer *buf.Buffer) error

+ type NatMapping struct

+ func NewNatMapping(ipRewrite bool) *NatMapping

+ func (m *NatMapping) CreateSession(session RouteSession, context RouteContext)

+ func (m *NatMapping) DeleteSession(session RouteSession)

+ func (m *NatMapping) WritePacket(packet []byte) (bool, error)

+ type NatWriter struct

+ func NewNatWriter(inet4Address netip.Addr, inet6Address netip.Addr) *NatWriter

+ func (w *NatWriter) RewritePacket(packet []byte)

+ type RouteAction interface

+ ActionType func() ActionType

+ Timeout func() bool

+ type RouteContext interface

+ WritePacket func(packet []byte) error

+ type RouteMapping struct

+ func NewRouteMapping(maxAge int64) *RouteMapping

+ func (m *RouteMapping) Lookup(session RouteSession, constructor func() RouteAction) RouteAction

+ type RouteSession struct

+ Destination netip.AddrPort

+ IPVersion uint8

+ Network uint8

+ Source netip.AddrPort

+ type Router interface

+ RouteConnection func(session RouteSession, context RouteContext) RouteAction

type StackOptions

+ Router Router

+ UnderPlatform bool

v0.1.2

Mar 15, 2023

Changes in this version

type Options

+ FileDescriptor int

type Tun — darwin/amd64, linux/amd64

+ func New(options Options) (Tun, error)

type Tun — js/wasm

+ func New(config Options) (Tun, error)

type WinTun — windows/amd64

+ func New(options Options) (WinTun, error)

v0.1.0

Dec 5, 2022

Changes in this version

+ const EventAndroidVPNUpdate

+ const EventInterfaceUpdate

+ const IN6_IFF_NODAD — darwin/amd64

+ const IN6_IFF_SECURED — darwin/amd64

+ const ND6_INFINITE_LIFETIME — darwin/amd64

+ const PacketOffset

+ const SIOCAIFADDR_IN6 — darwin/amd64

+ const WithGVisor

+ var ErrGVisorNotIncluded = E.New(`gVisor is not included in this build, rebuild with -tags with_gvisor`)

+ var ErrNoRoute = E.New("no route to internet")

+ var TunnelType = "sing-tun" — windows/amd64

+ func CalculateInterfaceName(name string) (tunName string)

+ func ContextWithNeedTimeout(ctx context.Context, need bool) context.Context

+ func NeedTimeoutFromContext(ctx context.Context) bool

+ type DefaultInterfaceMonitor interface

+ AndroidVPNEnabled func() bool

+ Close func() error

+ DefaultInterfaceIndex func(destination netip.Addr) int

+ DefaultInterfaceName func(destination netip.Addr) string

+ OverrideAndroidVPN func() bool

+ RegisterCallback func(callback DefaultInterfaceUpdateCallback) *list.Element[DefaultInterfaceUpdateCallback]

+ Start func() error

+ UnregisterCallback func(element *list.Element[DefaultInterfaceUpdateCallback])

+ func NewDefaultInterfaceMonitor(networkMonitor NetworkUpdateMonitor, options DefaultInterfaceMonitorOptions) (DefaultInterfaceMonitor, error)

+ type DefaultInterfaceMonitorOptions struct

+ OverrideAndroidVPN bool

+ type DefaultInterfaceUpdateCallback = func(event int) error

+ type Handler interface

+ type NativeTun struct — darwin/amd64, linux/amd64, windows/amd64

+ func (t *NativeTun) Close() error

+ func (t *NativeTun) Read(p []byte) (n int, err error)

+ func (t *NativeTun) ReadFunc(block func(b []byte)) error

+ func (t *NativeTun) ReadPacket() ([]byte, func(), error)

+ func (t *NativeTun) Write(p []byte) (n int, err error)

+ type NetworkUpdateCallback = func() error

+ type NetworkUpdateMonitor interface

+ Close func() error

+ RegisterCallback func(callback NetworkUpdateCallback) *list.Element[NetworkUpdateCallback]

+ Start func() error

+ UnregisterCallback func(element *list.Element[NetworkUpdateCallback])

+ func NewNetworkUpdateMonitor(errorHandler E.Handler) (NetworkUpdateMonitor, error)

+ type Options struct

+ AutoRoute bool

+ ExcludePackage []string

+ ExcludeUID []ranges.Range[uint32]

+ IncludeAndroidUser []int

+ IncludePackage []string

+ IncludeUID []ranges.Range[uint32]

+ Inet4Address []netip.Prefix

+ Inet4RouteAddress []netip.Prefix

+ Inet6Address []netip.Prefix

+ Inet6RouteAddress []netip.Prefix

+ InterfaceMonitor DefaultInterfaceMonitor

+ MTU uint32

+ Name string

+ StrictRoute bool

+ TableIndex int

+ func (o *Options) BuildAndroidRules(packageManager PackageManager, errorHandler E.Handler)

+ func (o *Options) ExcludedRanges() (uidRanges []ranges.Range[uint32])

+ type PackageManager interface

+ Close func() error

+ IDByPackage func(packageName string) (uint32, bool)

+ IDBySharedPackage func(sharedPackage string) (uint32, bool)

+ PackageByID func(id uint32) (string, bool)

+ SharedPackageByID func(id uint32) (string, bool)

+ Start func() error

+ func NewPackageManager(callback PackageManagerCallback) (PackageManager, error)

+ type PackageManagerCallback interface

+ OnPackagesUpdated func(packages int, sharedUsers int)

+ type Session struct

+ DestinationAddress netip.Addr

+ DestinationPort uint16

+ SourceAddress netip.Addr

+ SourcePort uint16

+ type Stack interface

+ Close func() error

+ Start func() error

+ func NewGVisor(options StackOptions) (Stack, error)

+ func NewLWIP(options StackOptions) (Stack, error)

+ func NewStack(stack string, options StackOptions) (Stack, error)

+ func NewSystem(options StackOptions) (Stack, error)

+ type StackOptions struct

+ Context context.Context

+ EndpointIndependentNat bool

+ Handler Handler

+ Inet4Address []netip.Prefix

+ Inet6Address []netip.Prefix

+ Logger logger.Logger

+ MTU uint32

+ Name string

+ Tun Tun

+ UDPTimeout int64

+ type System struct

+ func (s *System) Close() error

+ func (s *System) Start() error

+ type TCPNat struct

+ func NewNat() *TCPNat

+ func (n *TCPNat) Lookup(source netip.AddrPort, destination netip.AddrPort) uint16

+ func (n *TCPNat) LookupBack(port uint16) *TCPSession

+ func (n *TCPNat) Revoke(natPort uint16, session *TCPSession)

+ type TCPSession struct

+ Destination netip.AddrPort

+ Source netip.AddrPort

+ type Tun interface

+ Close func() error

+ func Open(config Options) (Tun, error)

+ func Open(options Options) (Tun, error)

+ type WinTun interface

+ ReadPacket func() ([]byte, func(), error)

+ func Open(options Options) (WinTun, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL