controlclient

package
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 16, 2021 License: BSD-3-Clause Imports: 54 Imported by: 29

Documentation

Overview

Package controlclient implements the client for the Tailscale control plane.

It handles authentication, port picking, and collects the local network configuration.

Index

Constants

View Source 
const (
	StateNew = State(iota)
	StateNotAuthenticated
	StateAuthenticating
	StateURLVisitRequired
	StateAuthenticated
	StateSynchronized // connected and received map update
)
View Source 
const (
	LoginDefault     = LoginFlags(0)
	LoginInteractive = LoginFlags(1 << iota) // force user login and key refresh
)

Variables

View Source 
var Debug = initDebug()

Debug contains temporary internal-only debug knobs. They're unexported to not draw attention to them.

Functions

func DERPRouteFlag added in v1.2.0 

func DERPRouteFlag() opt.Bool

DERPRouteFlag reports the last reported value from control for whether DERP route optimization (Issue 150) should be enabled.

func NewHostinfo 

func NewHostinfo() *tailcfg.Hostinfo

func TrimWGConfig added in v1.2.0 

func TrimWGConfig() opt.Bool

TrimWGConfig reports the last reported value from control for whether we should do lazy wireguard configuration.

Types

type Client 

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

Client connects to a tailcontrol server for a node.

func New 

func New(opts Options) (*Client, error)

New creates and starts a new Client.

func NewNoStart 

func NewNoStart(opts Options) (*Client, error)

NewNoStart creates a new Client, but without calling Start on it.

func (*Client) AuthCantContinue 

func (c *Client) AuthCantContinue() bool

func (*Client) Direct added in v0.98.1 

func (c *Client) Direct() *Direct

Direct returns the underlying direct client object. Used in tests only.

func (*Client) Expiry added in v0.98.1 

func (c *Client) Expiry() *time.Time

Expiry returns the credential expiration time, or the zero time if the expiration time isn't known. Used in tests only.

func (*Client) Login 

func (c *Client) Login(t *oauth2.Token, flags LoginFlags)

func (*Client) Logout 

func (c *Client) Logout()

func (*Client) SetHostinfo 

func (c *Client) SetHostinfo(hi *tailcfg.Hostinfo)

func (*Client) SetNetInfo 

func (c *Client) SetNetInfo(ni *tailcfg.NetInfo)

func (*Client) SetPaused added in v1.2.0 

func (c *Client) SetPaused(paused bool)

SetPaused controls whether HTTP activity should be paused.

The client can be paused and unpaused repeatedly, unlike Start and Shutdown, which can only be used once.

func (*Client) SetStatusFunc 

func (c *Client) SetStatusFunc(fn func(Status))

func (*Client) Shutdown 

func (c *Client) Shutdown()

func (*Client) Start 

func (c *Client) Start()

Start starts the client's goroutines.

It should only be called for clients created by NewNoStart.

func (*Client) TestOnlyNodePublicKey added in v0.98.1 

func (c *Client) TestOnlyNodePublicKey() wgkey.Key

NodePublicKey returns the node public key currently in use. This is used exclusively in tests.

func (*Client) TestOnlySetAuthKey added in v0.98.1 

func (c *Client) TestOnlySetAuthKey(authkey string)

func (*Client) TestOnlyTimeNow added in v0.98.1 

func (c *Client) TestOnlyTimeNow() time.Time

func (*Client) UpdateEndpoints 

func (c *Client) UpdateEndpoints(localPort uint16, endpoints []string)

type Decompressor 

type Decompressor interface {
	DecodeAll(input, dst []byte) ([]byte, error)
	Close()
}

type Direct 

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

Direct is the client that connects to a tailcontrol server for a node.

func NewDirect 

func NewDirect(opts Options) (*Direct, error)

NewDirect returns a new Direct client.

func (*Direct) GetPersist 

func (c *Direct) GetPersist() persist.Persist

func (*Direct) PollNetMap 

func (c *Direct) PollNetMap(ctx context.Context, maxPolls int, cb func(*netmap.NetworkMap)) error

PollNetMap makes a /map request to download the network map, calling cb with each new netmap.

maxPolls is how many network maps to download; common values are 1 or -1 (to keep a long-poll query open to the server).

func (*Direct) SendLiteMapUpdate added in v1.4.0 

func (c *Direct) SendLiteMapUpdate(ctx context.Context) error

SendLiteMapUpdate makes a /map request to update the server of our latest state, but does not fetch anything. It returns an error if the server did not return a successful 200 OK response.

func (*Direct) SetEndpoints 

func (c *Direct) SetEndpoints(localPort uint16, endpoints []string) (changed bool)

SetEndpoints updates the list of locally advertised endpoints. It won't be replicated to the server until a *fresh* call to PollNetMap(). You don't need to restart PollNetMap if we return changed==false.

func (*Direct) SetHostinfo 

func (c *Direct) SetHostinfo(hi *tailcfg.Hostinfo) bool

SetHostinfo clones the provided Hostinfo and remembers it for the next update. It reports whether the Hostinfo has changed.

func (*Direct) SetNetInfo 

func (c *Direct) SetNetInfo(ni *tailcfg.NetInfo) bool

SetNetInfo clones the provided NetInfo and remembers it for the next update. It reports whether the NetInfo has changed.

func (*Direct) TryLogin 

func (c *Direct) TryLogin(ctx context.Context, t *oauth2.Token, flags LoginFlags) (url string, err error)

func (*Direct) TryLogout 

func (c *Direct) TryLogout(ctx context.Context) error

func (*Direct) WaitLoginURL 

func (c *Direct) WaitLoginURL(ctx context.Context, url string) (newUrl string, err error)

type LoginFlags 

type LoginFlags int

type LoginGoal 

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

type Options 

type Options struct {
	Persist           persist.Persist   // initial persistent data
	MachinePrivateKey wgkey.Private     // the machine key to use
	ServerURL         string            // URL of the tailcontrol server
	AuthKey           string            // optional node auth key for auto registration
	TimeNow           func() time.Time  // time.Now implementation used by Client
	Hostinfo          *tailcfg.Hostinfo // non-nil passes ownership, nil means to use default using os.Hostname, etc
	DiscoPublicKey    tailcfg.DiscoKey
	NewDecompressor   func() (Decompressor, error)
	KeepAlive         bool
	Logf              logger.Logf
	HTTPTestClient    *http.Client // optional HTTP client to use (for tests only)
	DebugFlags        []string     // debug settings to send to control
	LinkMonitor       *monitor.Mon // optional link monitor

	// KeepSharerAndUserSplit controls whether the client
	// understands Node.Sharer. If false, the Sharer is mapped to the User.
	KeepSharerAndUserSplit bool
}

type State added in v0.98.1 

type State int

State is the high-level state of the client. It is used only in unit tests for proper sequencing, don't depend on it anywhere else. TODO(apenwarr): eliminate 'state', as it's now obsolete.

func (State) MarshalText added in v0.98.1 

func (s State) MarshalText() ([]byte, error)

func (State) String added in v0.98.1 

func (s State) String() string

type Status 

type Status struct {
	LoginFinished *empty.Message
	Err           string
	URL           string
	Persist       *persist.Persist   // locally persisted configuration
	NetMap        *netmap.NetworkMap // server-pushed configuration
	Hostinfo      *tailcfg.Hostinfo  // current Hostinfo data
	State         State
	// contains filtered or unexported fields
}

func (*Status) Equal 

func (s *Status) Equal(s2 *Status) bool

Equal reports whether s and s2 are equal.

func (Status) String 

func (s Status) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.