const TPMPrefix = "tpmseal:"

funcHasKnownProviderPrefix¶added inv1.86.0

func HasKnownProviderPrefix(pathstring)bool

HasKnownProviderPrefix reports whether path uses one of the registeredProvider prefixes.

funcNew¶

func New(logflogger.Logf, pathstring) (ipn.StateStore,error)

New returns a StateStore based on the provided argand registered stores.The arg is of the form "prefix:rest", where prefix was previouslyregistered with Register.

By default the following stores are registered:

• if the string begins with "mem:", the suffixis ignored and an in-memory store is used.
• (Linux-only) if the string begins with "arn:",the suffix an AWS ARN for an SSM.
• (Linux-only) if the string begins with "kube:",the suffix is a Kubernetes secret name
• (Linux or Windows) if the string begins with "tpmseal:", the suffix isfilepath that is sealed with the local TPM device.
• In all other cases, the path is treated as a filepath.

funcNewFileStore¶

func NewFileStore(logflogger.Logf, pathstring) (ipn.StateStore,error)

NewFileStore returns a new file store that persists to path.

funcRegister¶

func Register(prefixstring, fnProvider)

Register registers a prefix to be used forNewStore. It panics if the prefix is empty, or if theprefix is already registered.The provided fn is called with the path passed to NewStore;the prefix is not stripped.

funcRegisterForTest¶added inv1.86.0

func RegisterForTest(ttestenv.TB, prefixstring, fnProvider)

RegisterForTest registers a prefix to be used for NewStore in tests. Anexisting registered prefix will be replaced.

funcTryWindowsAppDataMigration¶

func TryWindowsAppDataMigration(logflogger.Logf, pathstring)string

TryWindowsAppDataMigration attempts to copy the Windows state filefrom its old location to the new location. (Issue 2856)

Tailscale 1.14 and before stored state under %LocalAppData%(usually "C:\WINDOWS\system32\config\systemprofile\AppData\Local"when tailscaled.exe is running as a non-user system service).However it is frequently cleared for almost any reason: Windowsupdates, System Restore, even various System Cleaner utilities.

Returns a string of the path to use for the state file.This will be a fallback %LocalAppData% path if migration fails,a %ProgramData% path otherwise.

typeExportableStore¶added inv1.86.0

type ExportableStore interface {ipn.StateStore// All returns an iterator over all store keys. Using ReadState or// WriteState is not safe while iterating and can lead to a deadlock. The// order of keys in the iterator is not specified and may change between// runs.All()iter.Seq2[ipn.StateKey, []byte]}

ExportableStore is an ipn.StateStore that can export all of its contents.This interface is optional to implement, and used for migrating the statebetween different store implementations.

typeFileStore¶

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

FileStore is a StateStore that uses a JSON file for persistence.

func (s *FileStore) All()iter.Seq2[ipn.StateKey, []byte]

func (s *FileStore) Path()string

func (s *FileStore) ReadState(idipn.StateKey) ([]byte,error)

func (s *FileStore) String()string

func (s *FileStore) WriteState(idipn.StateKey, bs []byte)error

typeProvider¶

type Provider func(logflogger.Logf, argstring) (ipn.StateStore,error)

Provider returns a StateStore for the provided path.The arg is of the form "prefix:rest", where prefix was previously registered with Register.