ipnlocal

Documentation

Index

• type LocalBackend
  • func NewLocalBackend(logf logger.Logf, logid string, store ipn.StateStore, e wgengine.Engine) (*LocalBackend, error)
  • func (b *LocalBackend) CheckIPForwarding() error
  • func (b *LocalBackend) DeleteFile(name string) error
  • func (b *LocalBackend) EditPrefs(mp *ipn.MaskedPrefs) (*ipn.Prefs, error)
  • func (b *LocalBackend) FakeExpireAfter(x time.Duration)
  • func (b *LocalBackend) FileTargets() ([]*apitype.FileTarget, error)
  • func (b *LocalBackend) InServerMode() bool
  • func (b *LocalBackend) Login(token *tailcfg.Oauth2Token)
  • func (b *LocalBackend) Logout()
  • func (b *LocalBackend) LogoutSync(ctx context.Context) error
  • func (b *LocalBackend) NetMap() *netmap.NetworkMap
  • func (b *LocalBackend) OpenFile(name string) (rc io.ReadCloser, size int64, err error)
  • func (b *LocalBackend) OperatorUserID() string
  • func (b *LocalBackend) PeerDialControlFunc() func(network, address string, c syscall.RawConn) error
  • func (b *LocalBackend) Ping(ipStr string, useTSMP bool)
  • func (b *LocalBackend) Prefs() *ipn.Prefs
  • func (b *LocalBackend) RequestEngineStatus()
  • func (b *LocalBackend) ResetForClientDisconnect()
  • func (b *LocalBackend) SetControlClientGetterForTesting(newControlClient func(controlclient.Options) (controlclient.Client, error))
  • func (b *LocalBackend) SetCurrentUserID(uid string)
  • func (b *LocalBackend) SetDecompressor(fn func() (controlclient.Decompressor, error))
  • func (b *LocalBackend) SetDirectFileRoot(dir string)
  • func (b *LocalBackend) SetHTTPTestClient(c *http.Client)
  • func (b *LocalBackend) SetNotifyCallback(notify func(ipn.Notify))
  • func (b *LocalBackend) SetPrefs(newp *ipn.Prefs)
  • func (b *LocalBackend) Shutdown()
  • func (b *LocalBackend) Start(opts ipn.Options) error
  • func (b *LocalBackend) StartLoginInteractive()
  • func (b *LocalBackend) State() ipn.State
  • func (b *LocalBackend) Status() *ipnstate.Status
  • func (b *LocalBackend) StatusWithoutPeers() *ipnstate.Status
  • func (b *LocalBackend) TestOnlyPublicKeys() (machineKey tailcfg.MachineKey, nodeKey tailcfg.NodeKey)
  • func (b *LocalBackend) UpdateStatus(sb *ipnstate.StatusBuilder)
  • func (b *LocalBackend) WaitingFiles() ([]apitype.WaitingFile, error)
  • func (b *LocalBackend) WhoIs(ipp netaddr.IPPort) (n *tailcfg.Node, u tailcfg.UserProfile, ok bool)

Types

type LocalBackend

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

LocalBackend is the glue between the major pieces of the Tailscale network software: the cloud control plane (via controlclient), the network data plane (via wgengine), and the user-facing UIs and CLIs (collectively called "frontends", via LocalBackend's implementation of the Backend interface).

LocalBackend implements the overall state machine for the Tailscale application. Frontends, controlclient and wgengine can feed events into LocalBackend to advance the state machine, and advancing the state machine generates events back out to zero or more components.

func NewLocalBackend

func NewLocalBackend(logf logger.Logf, logid string, store ipn.StateStore, e wgengine.Engine) (*LocalBackend, error)

NewLocalBackend returns a new LocalBackend that is ready to run, but is not actually running.

func (*LocalBackend) CheckIPForwarding

func (b *LocalBackend) CheckIPForwarding() error

func (*LocalBackend) DeleteFile

func (b *LocalBackend) DeleteFile(name string) error

func (*LocalBackend) EditPrefs

func (b *LocalBackend) EditPrefs(mp *ipn.MaskedPrefs) (*ipn.Prefs, error)

func (*LocalBackend) FakeExpireAfter

func (b *LocalBackend) FakeExpireAfter(x time.Duration)

FakeExpireAfter implements Backend.

func (*LocalBackend) FileTargets

func (b *LocalBackend) FileTargets() ([]*apitype.FileTarget, error)

FileTargets lists nodes that the current node can send files to.

func (*LocalBackend) InServerMode

func (b *LocalBackend) InServerMode() bool

func (*LocalBackend) Login

func (b *LocalBackend) Login(token *tailcfg.Oauth2Token)

Login implements Backend.

func (*LocalBackend) Logout

func (b *LocalBackend) Logout()

Logout tells the controlclient that we want to log out, and transitions the local engine to the logged-out state without waiting for controlclient to be in that state.

func (*LocalBackend) LogoutSync

func (b *LocalBackend) LogoutSync(ctx context.Context) error

func (*LocalBackend) NetMap

func (b *LocalBackend) NetMap() *netmap.NetworkMap

NetMap returns the latest cached network map received from controlclient, or nil if no network map was received yet.

func (*LocalBackend) OpenFile

func (b *LocalBackend) OpenFile(name string) (rc io.ReadCloser, size int64, err error)

func (*LocalBackend) OperatorUserID

func (b *LocalBackend) OperatorUserID() string

OperatorUserID returns the current pref's OperatorUser's ID (in os/user.User.Uid string form), or the empty string if none.

func (*LocalBackend) PeerDialControlFunc

func (b *LocalBackend) PeerDialControlFunc() func(network, address string, c syscall.RawConn) error

PeerDialControlFunc returns a net.Dialer.Control func (possibly nil) to use to dial other Tailscale peers from the current environment.

func (*LocalBackend) Ping

func (b *LocalBackend) Ping(ipStr string, useTSMP bool)

func (*LocalBackend) Prefs

func (b *LocalBackend) Prefs() *ipn.Prefs

Prefs returns a copy of b's current prefs, with any private keys removed.

func (*LocalBackend) RequestEngineStatus

func (b *LocalBackend) RequestEngineStatus()

RequestEngineStatus implements Backend.

func (*LocalBackend) ResetForClientDisconnect

func (b *LocalBackend) ResetForClientDisconnect()

ResetForClientDisconnect resets the backend for GUI clients running in interactive (non-headless) mode. This is currently used only by Windows. This causes all state to be cleared, lest an unrelated user connect to tailscaled next. But it does not trigger a logout; we don't want to the user to have to reauthenticate in the future when they restart the GUI.

func (*LocalBackend) SetControlClientGetterForTesting

func (b *LocalBackend) SetControlClientGetterForTesting(newControlClient func(controlclient.Options) (controlclient.Client, error))

SetControlClientGetterForTesting sets the func that creates a control plane client. It can be called at most once, before Start.

func (*LocalBackend) SetCurrentUserID

func (b *LocalBackend) SetCurrentUserID(uid string)

func (*LocalBackend) SetDecompressor

func (b *LocalBackend) SetDecompressor(fn func() (controlclient.Decompressor, error))

SetDecompressor sets a decompression function, which must be a zstd reader.

This exists because the iOS/Mac NetworkExtension is very resource constrained, and the zstd package is too heavy to fit in the constrained RSS limit.

func (*LocalBackend) SetDirectFileRoot

func (b *LocalBackend) SetDirectFileRoot(dir string)

SetDirectFileRoot sets the directory to download files to directly, without buffering them through an intermediate daemon-owned tailcfg.UserID-specific directory.

This must be called before the LocalBackend starts being used.

func (*LocalBackend) SetHTTPTestClient

func (b *LocalBackend) SetHTTPTestClient(c *http.Client)

SetHTTPTestClient sets an alternate HTTP client to use with connections to the coordination server. It exists for testing. Using nil means to use the default.

func (*LocalBackend) SetNotifyCallback

func (b *LocalBackend) SetNotifyCallback(notify func(ipn.Notify))

func (*LocalBackend) SetPrefs

func (b *LocalBackend) SetPrefs(newp *ipn.Prefs)

SetPrefs saves new user preferences and propagates them throughout the system. Implements Backend.

func (*LocalBackend) Shutdown

func (b *LocalBackend) Shutdown()

Shutdown halts the backend and all its sub-components. The backend can no longer be used after Shutdown returns.

func (*LocalBackend) Start

func (b *LocalBackend) Start(opts ipn.Options) error

Start applies the configuration specified in opts, and starts the state machine.

TODO(danderson): this function is trying to do too many things at once: it loads state, or imports it, or updates prefs sometimes, contains some settings that are one-shot things done by `tailscale up` because we had nowhere else to put them, and there's no clear guarantee that switching from one user's state to another is actually a supported operation (it should be, but it's very unclear from the following whether or not that is a safe transition).

func (*LocalBackend) StartLoginInteractive

func (b *LocalBackend) StartLoginInteractive()

StartLoginInteractive implements Backend. It requests a new interactive login from controlclient, unless such a flow is already in progress, in which case StartLoginInteractive attempts to pick up the in-progress flow where it left off.

func (*LocalBackend) State

func (b *LocalBackend) State() ipn.State

State returns the backend state machine's current state.

func (*LocalBackend) Status

func (b *LocalBackend) Status() *ipnstate.Status

Status returns the latest status of the backend and its sub-components.

func (*LocalBackend) StatusWithoutPeers

func (b *LocalBackend) StatusWithoutPeers() *ipnstate.Status

StatusWithoutPeers is like Status but omits any details of peers.

func (*LocalBackend) TestOnlyPublicKeys

func (b *LocalBackend) TestOnlyPublicKeys() (machineKey tailcfg.MachineKey, nodeKey tailcfg.NodeKey)

TestOnlyPublicKeys returns the current machine and node public keys. Used in tests only to facilitate automated node authorization in the test harness.

func (*LocalBackend) UpdateStatus

func (b *LocalBackend) UpdateStatus(sb *ipnstate.StatusBuilder)

UpdateStatus implements ipnstate.StatusUpdater.

func (*LocalBackend) WaitingFiles

func (b *LocalBackend) WaitingFiles() ([]apitype.WaitingFile, error)

func (*LocalBackend) WhoIs

func (b *LocalBackend) WhoIs(ipp netaddr.IPPort) (n *tailcfg.Node, u tailcfg.UserProfile, ok bool)

WhoIs reports the node and user who owns the node with the given IP:port. If the IP address is a Tailscale IP, the provided port may be 0. If ok == true, n and u are valid.