router
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package router presents an interface to manipulate the host networkstack's state.
Index¶
Constants¶
This section is empty.
Variables¶
HookCleanUp is the optional registration point for router implementationsto register a cleanup function forCleanUp to use. It's meant forimplementations in wgengine/router/osrouter.
HookNewUserspaceRouter is the registration point for router implementationsto register a constructor for userspace routers. It's meant for implementationsin wgengine/router/osrouter.
If no implementation is registered,New will return an error.
Functions¶
Types¶
typeCallbackRouter¶added inv1.8.0
type CallbackRouter struct {SetBoth func(rcfg *Config, dcfg *dns.OSConfig)errorSplitDNSbool// GetBaseConfigFunc optionally specifies a function to return the current DNS// config in response to GetBaseConfig.//// If nil, reading the current config isn't supported and GetBaseConfig()// will return ErrGetBaseConfigNotSupported.GetBaseConfigFunc func() (dns.OSConfig,error)// InitialMTU is the MTU the tun should be initialized with.// Zero means don't change the MTU from the default. This MTU// is applied only once, shortly after the TUN is created, and// ignored thereafter.InitialMTUuint32// contains filtered or unexported fields}CallbackRouter is an implementation of both Router and dns.OSConfigurator.When either network or DNS settings are changed, SetBoth is called with both configs.Mainly used as a shim for OSes that want to set both network andDNS configuration simultaneously (Mac, iOS, Android).
func (*CallbackRouter)Close¶added inv1.8.0
func (r *CallbackRouter) Close()error
func (*CallbackRouter)GetBaseConfig¶added inv1.8.0
func (r *CallbackRouter) GetBaseConfig() (dns.OSConfig,error)
func (*CallbackRouter)Set¶added inv1.8.0
func (r *CallbackRouter) Set(rcfg *Config)error
Set implements Router.
func (*CallbackRouter)SetDNS¶added inv1.8.0
func (r *CallbackRouter) SetDNS(dcfgdns.OSConfig)error
SetDNS implements dns.OSConfigurator.
func (*CallbackRouter)SupportsSplitDNS¶added inv1.8.0
func (r *CallbackRouter) SupportsSplitDNS()bool
SupportsSplitDNS implements dns.OSConfigurator.
typeConfig¶
type Config struct {// LocalAddrs are the address(es) for this node. This is// typically one IPv4/32 (the 100.x.y.z CGNAT) and one// IPv6/128 (Tailscale ULA).LocalAddrs []netip.Prefix// Routes are the routes that point into the Tailscale// interface. These are the /32 and /128 routes to peers, as// well as any other subnets that peers are advertising and// this node has chosen to use.Routes []netip.Prefix// LocalRoutes are the routes that should not be routed through Tailscale.// There are no priorities set in how these routes are added, normal// routing rules apply.LocalRoutes []netip.Prefix// NewMTU is currently only used by the MacOS network extension// app to set the MTU of the tun in the router configuration// callback. If zero, the MTU is unchanged.NewMTUint// SubnetRoutes is the list of subnets that this node is// advertising to other Tailscale nodes.// As of 2023-10-11, this field is only used for network// flow logging and is otherwise ignored.SubnetRoutes []netip.Prefix// Linux-only things below, ignored on other platforms.SNATSubnetRoutesbool// SNAT traffic to local subnetsStatefulFilteringbool// Apply stateful filtering to inbound connectionsNetfilterModepreftype.NetfilterMode// how much to manage netfilter rulesNetfilterKindstring// what kind of netfilter to use ("nftables", "iptables", or "" to auto-detect)}Config is the subset of Tailscale configuration that is relevant tothe OS's network stack.
typeNewOpts¶added inv1.90.0
type NewOpts struct {Logflogger.Logf// requiredTuntun.Device// requiredNetMon *netmon.Monitor// optionalHealth *health.Tracker// required (but TODO: support optional later)Bus *eventbus.Bus// required}NewOpts are the options passed to the NewUserspaceRouter hook.
typePortUpdate¶added inv1.90.0
PortUpdate is an eventbus value, reporting the port and address familymagicsock is currently listening on, so it can be threaded through firewallsand such.
typeRouter¶
type Router interface {// Up brings the router up.Up()error// Set updates the OS network stack with a new Config. It may be// called multiple times with identical Configs, which the// implementation should handle gracefully.Set(*Config)error// Close closes the router.Close()error}Router is responsible for managing the system network stack.
There is typically only one instance of this interface per process.
funcConsolidatingRoutes¶added inv1.66.0
ConsolidatingRoutes wraps a Router with logic that consolidates Routeswhenever Set is called. It attempts to consolidate cfg.Routes into thesmallest possible set.
funcNew¶
func New(logflogger.Logf, tundevtun.Device, netMon *netmon.Monitor,health *health.Tracker, bus *eventbus.Bus,) (Router,error)
New returns a new Router for the current platform, using theprovided tun device.
If netMon is nil, it's not used. It's currently (2021-07-20) onlyused on Linux in some situations.
Source Files
Directories