mirror of
https://github.com/tailscale/tailscale.git
synced 2024-11-25 19:15:34 +00:00
1384c24e41
Updates #12172 (then need to update other repos) Change-Id: I439f65e0119b09e00da2ef5c7a4f002f93558578 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
91 lines
3.6 KiB
Go
91 lines
3.6 KiB
Go
// Copyright (c) Tailscale Inc & AUTHORS
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// Package controlclient implements the client for the Tailscale
|
|
// control plane.
|
|
//
|
|
// It handles authentication, port picking, and collects the local
|
|
// network configuration.
|
|
package controlclient
|
|
|
|
import (
|
|
"context"
|
|
|
|
"tailscale.com/tailcfg"
|
|
)
|
|
|
|
// LoginFlags is a bitmask of options to change the behavior of Client.Login
|
|
// and LocalBackend.
|
|
type LoginFlags int
|
|
|
|
const (
|
|
LoginDefault = LoginFlags(0)
|
|
LoginInteractive = LoginFlags(1 << iota) // force user login and key refresh
|
|
LoginEphemeral // set RegisterRequest.Ephemeral
|
|
|
|
// LocalBackendStartKeyOSNeutral instructs NewLocalBackend to start the
|
|
// LocalBackend without any OS-dependent StateStore StartKey behavior.
|
|
//
|
|
// See https://github.com/tailscale/tailscale/issues/6973.
|
|
LocalBackendStartKeyOSNeutral
|
|
)
|
|
|
|
// Client represents a client connection to the control server.
|
|
// Currently this is done through a pair of polling https requests in
|
|
// the Auto client, but that might change eventually.
|
|
//
|
|
// The Client must be comparable as it is used by the Observer to detect stale
|
|
// clients.
|
|
type Client interface {
|
|
// Shutdown closes this session, which should not be used any further
|
|
// afterwards.
|
|
Shutdown()
|
|
// Login begins an interactive or non-interactive login process.
|
|
// Client will eventually call the Status callback with either a
|
|
// LoginFinished flag (on success) or an auth URL (if further
|
|
// interaction is needed). It merely sets the process in motion,
|
|
// and doesn't wait for it to complete.
|
|
Login(LoginFlags)
|
|
// Logout starts a synchronous logout process. It doesn't return
|
|
// until the logout operation has been completed.
|
|
Logout(context.Context) error
|
|
// SetPaused pauses or unpauses the controlclient activity as much
|
|
// as possible, without losing its internal state, to minimize
|
|
// unnecessary network activity.
|
|
// TODO: It might be better to simply shutdown the controlclient and
|
|
// make a new one when it's time to unpause.
|
|
SetPaused(bool)
|
|
// AuthCantContinue returns whether authentication is blocked. If it
|
|
// is, you either need to visit the auth URL (previously sent in a
|
|
// Status callback) or call the Login function appropriately.
|
|
// TODO: this probably belongs in the Status itself instead.
|
|
AuthCantContinue() bool
|
|
// SetHostinfo changes the Hostinfo structure that will be sent in
|
|
// subsequent node registration requests.
|
|
// TODO: a server-side change would let us simply upload this
|
|
// in a separate http request. It has nothing to do with the rest of
|
|
// the state machine.
|
|
SetHostinfo(*tailcfg.Hostinfo)
|
|
// SetNetinfo changes the NetIinfo structure that will be sent in
|
|
// subsequent node registration requests.
|
|
// TODO: a server-side change would let us simply upload this
|
|
// in a separate http request. It has nothing to do with the rest of
|
|
// the state machine.
|
|
SetNetInfo(*tailcfg.NetInfo)
|
|
// SetTKAHead changes the TKA head hash value that will be sent in
|
|
// subsequent netmap requests.
|
|
SetTKAHead(headHash string)
|
|
// UpdateEndpoints changes the Endpoint structure that will be sent
|
|
// in subsequent node registration requests.
|
|
// TODO: a server-side change would let us simply upload this
|
|
// in a separate http request. It has nothing to do with the rest of
|
|
// the state machine.
|
|
UpdateEndpoints(endpoints []tailcfg.Endpoint)
|
|
}
|
|
|
|
// UserVisibleError is an error that should be shown to users.
|
|
type UserVisibleError string
|
|
|
|
func (e UserVisibleError) Error() string { return string(e) }
|
|
func (e UserVisibleError) UserVisibleError() string { return string(e) }
|