network-lock.go 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488
  1. // Copyright (c) Tailscale Inc & AUTHORS
  2. // SPDX-License-Identifier: BSD-3-Clause
  3. //go:build !ts_omit_tailnetlock
  4. package ipnlocal
  5. import (
  6. "bytes"
  7. "context"
  8. "crypto/ed25519"
  9. "crypto/rand"
  10. "encoding/base64"
  11. "encoding/binary"
  12. "encoding/json"
  13. "errors"
  14. "fmt"
  15. "io"
  16. "net/http"
  17. "net/netip"
  18. "os"
  19. "path/filepath"
  20. "slices"
  21. "time"
  22. "tailscale.com/health"
  23. "tailscale.com/health/healthmsg"
  24. "tailscale.com/ipn"
  25. "tailscale.com/ipn/ipnstate"
  26. "tailscale.com/net/tsaddr"
  27. "tailscale.com/tailcfg"
  28. "tailscale.com/tka"
  29. "tailscale.com/tsconst"
  30. "tailscale.com/types/key"
  31. "tailscale.com/types/logger"
  32. "tailscale.com/types/netmap"
  33. "tailscale.com/types/persist"
  34. "tailscale.com/types/tkatype"
  35. "tailscale.com/util/mak"
  36. "tailscale.com/util/set"
  37. )
  38. // TODO(tom): RPC retry/backoff was broken and has been removed. Fix?
  39. var (
  40. errMissingNetmap = errors.New("missing netmap: verify that you are logged in")
  41. errNetworkLockNotActive = errors.New("network-lock is not active")
  42. tkaCompactionDefaults = tka.CompactionOptions{
  43. MinChain: 24, // Keep at minimum 24 AUMs since head.
  44. MinAge: 14 * 24 * time.Hour, // Keep 2 weeks of AUMs.
  45. }
  46. )
  47. type tkaState struct {
  48. profile ipn.ProfileID
  49. authority *tka.Authority
  50. storage tka.CompactableChonk
  51. filtered []ipnstate.TKAPeer
  52. }
  53. func (b *LocalBackend) initTKALocked() error {
  54. cp := b.pm.CurrentProfile()
  55. if cp.ID() == "" {
  56. b.tka = nil
  57. return nil
  58. }
  59. if b.tka != nil {
  60. if b.tka.profile == cp.ID() {
  61. // Already initialized.
  62. return nil
  63. }
  64. // As we're switching profiles, we need to reset the TKA to nil.
  65. b.tka = nil
  66. }
  67. root := b.TailscaleVarRoot()
  68. if root == "" {
  69. b.tka = nil
  70. b.logf("cannot fetch existing TKA state; no state directory for network-lock")
  71. return nil
  72. }
  73. chonkDir := b.chonkPathLocked()
  74. if _, err := os.Stat(chonkDir); err == nil {
  75. // The directory exists, which means network-lock has been initialized.
  76. storage, err := tka.ChonkDir(chonkDir)
  77. if err != nil {
  78. return fmt.Errorf("opening tailchonk: %v", err)
  79. }
  80. authority, err := tka.Open(storage)
  81. if err != nil {
  82. return fmt.Errorf("initializing tka: %v", err)
  83. }
  84. if err := authority.Compact(storage, tkaCompactionDefaults); err != nil {
  85. b.logf("tka compaction failed: %v", err)
  86. }
  87. b.tka = &tkaState{
  88. profile: cp.ID(),
  89. authority: authority,
  90. storage: storage,
  91. }
  92. b.logf("tka initialized at head %x", authority.Head())
  93. }
  94. return nil
  95. }
  96. // noNetworkLockStateDirWarnable is a Warnable to warn the user that Tailnet Lock data
  97. // (in particular, the list of AUMs in the TKA state) is being stored in memory and will
  98. // be lost when tailscaled restarts.
  99. var noNetworkLockStateDirWarnable = health.Register(&health.Warnable{
  100. Code: "no-tailnet-lock-state-dir",
  101. Title: "No statedir for Tailnet Lock",
  102. Severity: health.SeverityMedium,
  103. Text: health.StaticMessage(healthmsg.InMemoryTailnetLockState),
  104. })
  105. // tkaFilterNetmapLocked checks the signatures on each node key, dropping
  106. // nodes from the netmap whose signature does not verify.
  107. //
  108. // b.mu must be held.
  109. func (b *LocalBackend) tkaFilterNetmapLocked(nm *netmap.NetworkMap) {
  110. if b.tka == nil && !b.capTailnetLock {
  111. b.health.SetTKAHealth(nil)
  112. return
  113. }
  114. if b.tka == nil {
  115. b.health.SetTKAHealth(nil)
  116. return // TKA not enabled.
  117. }
  118. tracker := rotationTracker{logf: b.logf}
  119. var toDelete map[int]bool // peer index => true
  120. for i, p := range nm.Peers {
  121. if p.UnsignedPeerAPIOnly() {
  122. // Not subject to tailnet lock.
  123. continue
  124. }
  125. if p.KeySignature().Len() == 0 {
  126. b.logf("Network lock is dropping peer %v(%v) due to missing signature", p.ID(), p.StableID())
  127. mak.Set(&toDelete, i, true)
  128. } else {
  129. details, err := b.tka.authority.NodeKeyAuthorizedWithDetails(p.Key(), p.KeySignature().AsSlice())
  130. if err != nil {
  131. b.logf("Network lock is dropping peer %v(%v) due to failed signature check: %v", p.ID(), p.StableID(), err)
  132. mak.Set(&toDelete, i, true)
  133. continue
  134. }
  135. if details != nil {
  136. // Rotation details are returned when the node key is signed by a valid SigRotation signature.
  137. tracker.addRotationDetails(p.Key(), details)
  138. }
  139. }
  140. }
  141. obsoleteByRotation := tracker.obsoleteKeys()
  142. // nm.Peers is ordered, so deletion must be order-preserving.
  143. if len(toDelete) > 0 || len(obsoleteByRotation) > 0 {
  144. peers := make([]tailcfg.NodeView, 0, len(nm.Peers))
  145. filtered := make([]ipnstate.TKAPeer, 0, len(toDelete)+len(obsoleteByRotation))
  146. for i, p := range nm.Peers {
  147. if !toDelete[i] && !obsoleteByRotation.Contains(p.Key()) {
  148. peers = append(peers, p)
  149. } else {
  150. if obsoleteByRotation.Contains(p.Key()) {
  151. b.logf("Network lock is dropping peer %v(%v) due to key rotation", p.ID(), p.StableID())
  152. }
  153. // Record information about the node we filtered out.
  154. filtered = append(filtered, tkaStateFromPeer(p))
  155. }
  156. }
  157. nm.Peers = peers
  158. b.tka.filtered = filtered
  159. } else {
  160. b.tka.filtered = nil
  161. }
  162. // Check that we ourselves are not locked out, report a health issue if so.
  163. if nm.SelfNode.Valid() && b.tka.authority.NodeKeyAuthorized(nm.SelfNode.Key(), nm.SelfNode.KeySignature().AsSlice()) != nil {
  164. b.health.SetTKAHealth(errors.New(healthmsg.LockedOut))
  165. } else {
  166. b.health.SetTKAHealth(nil)
  167. }
  168. }
  169. // rotationTracker determines the set of node keys that are made obsolete by key
  170. // rotation.
  171. // - for each SigRotation signature, all previous node keys referenced by the
  172. // nested signatures are marked as obsolete.
  173. // - if there are multiple SigRotation signatures tracing back to the same
  174. // wrapping pubkey of the initial SigDirect signature (e.g. if a node is
  175. // cloned with all its keys), we keep just one of them, marking the others as
  176. // obsolete.
  177. type rotationTracker struct {
  178. // obsolete is the set of node keys that are obsolete due to key rotation.
  179. // users of rotationTracker should use the obsoleteKeys method for complete results.
  180. obsolete set.Set[key.NodePublic]
  181. // byWrappingKey keeps track of rotation details per wrapping pubkey.
  182. byWrappingKey map[string][]sigRotationDetails
  183. logf logger.Logf
  184. }
  185. // sigRotationDetails holds information about a node key signed by a SigRotation.
  186. type sigRotationDetails struct {
  187. np key.NodePublic
  188. numPrevKeys int
  189. }
  190. // addRotationDetails records the rotation signature details for a node key.
  191. func (r *rotationTracker) addRotationDetails(np key.NodePublic, d *tka.RotationDetails) {
  192. r.obsolete.Make()
  193. r.obsolete.AddSlice(d.PrevNodeKeys)
  194. if d.InitialSig.SigKind != tka.SigDirect {
  195. // Only enforce uniqueness of chains originating from a SigDirect
  196. // signature. Chains that begin with a SigCredential can legitimately
  197. // start from the same wrapping pubkey when multiple nodes join the
  198. // network using the same reusable auth key.
  199. return
  200. }
  201. rd := sigRotationDetails{
  202. np: np,
  203. numPrevKeys: len(d.PrevNodeKeys),
  204. }
  205. if r.byWrappingKey == nil {
  206. r.byWrappingKey = make(map[string][]sigRotationDetails)
  207. }
  208. wp := string(d.InitialSig.WrappingPubkey)
  209. r.byWrappingKey[wp] = append(r.byWrappingKey[wp], rd)
  210. }
  211. // obsoleteKeys returns the set of node keys that are obsolete due to key rotation.
  212. func (r *rotationTracker) obsoleteKeys() set.Set[key.NodePublic] {
  213. for _, v := range r.byWrappingKey {
  214. // Do not consider signatures for keys that have been marked as obsolete
  215. // by another signature.
  216. v = slices.DeleteFunc(v, func(rd sigRotationDetails) bool {
  217. return r.obsolete.Contains(rd.np)
  218. })
  219. if len(v) == 0 {
  220. continue
  221. }
  222. // If there are multiple rotation signatures with the same wrapping
  223. // pubkey, we need to decide which one is the "latest", and keep it.
  224. // The signature with the largest number of previous keys is likely to
  225. // be the latest.
  226. slices.SortStableFunc(v, func(a, b sigRotationDetails) int {
  227. // Sort by decreasing number of previous keys.
  228. return b.numPrevKeys - a.numPrevKeys
  229. })
  230. // If there are several signatures with the same number of previous
  231. // keys, we cannot determine which one is the latest, so all of them are
  232. // rejected for safety.
  233. if len(v) >= 2 && v[0].numPrevKeys == v[1].numPrevKeys {
  234. r.logf("at least two nodes (%s and %s) have equally valid rotation signatures with the same wrapping pubkey, rejecting", v[0].np, v[1].np)
  235. for _, rd := range v {
  236. r.obsolete.Add(rd.np)
  237. }
  238. } else {
  239. // The first key in v is the one with the longest chain of previous
  240. // keys, so it must be the newest one. Mark all older keys as obsolete.
  241. for _, rd := range v[1:] {
  242. r.obsolete.Add(rd.np)
  243. }
  244. }
  245. }
  246. return r.obsolete
  247. }
  248. // tkaSyncIfNeeded examines TKA info reported from the control plane,
  249. // performing the steps necessary to synchronize local tka state.
  250. //
  251. // There are 4 scenarios handled here:
  252. // - Enablement: nm.TKAEnabled but b.tka == nil
  253. // ∴ reach out to /machine/tka/bootstrap to get the genesis AUM, then
  254. // initialize TKA.
  255. // - Disablement: !nm.TKAEnabled but b.tka != nil
  256. // ∴ reach out to /machine/tka/bootstrap to read the disablement secret,
  257. // then verify and clear tka local state.
  258. // - Sync needed: b.tka.Head != nm.TKAHead
  259. // ∴ complete multi-step synchronization flow.
  260. // - Everything up to date: All other cases.
  261. // ∴ no action necessary.
  262. //
  263. // tkaSyncIfNeeded immediately takes b.takeSyncLock which is held throughout,
  264. // and may take b.mu as required.
  265. func (b *LocalBackend) tkaSyncIfNeeded(nm *netmap.NetworkMap, prefs ipn.PrefsView) error {
  266. b.tkaSyncLock.Lock() // take tkaSyncLock to make this function an exclusive section.
  267. defer b.tkaSyncLock.Unlock()
  268. b.mu.Lock() // take mu to protect access to synchronized fields.
  269. defer b.mu.Unlock()
  270. if b.tka == nil && !b.capTailnetLock {
  271. return nil
  272. }
  273. isEnabled := b.tka != nil
  274. wantEnabled := nm.TKAEnabled
  275. if isEnabled || wantEnabled {
  276. b.logf("tkaSyncIfNeeded: isEnabled=%t, wantEnabled=%t, head=%v", isEnabled, wantEnabled, nm.TKAHead)
  277. }
  278. ourNodeKey, ok := prefs.Persist().PublicNodeKeyOK()
  279. if !ok {
  280. return errors.New("tkaSyncIfNeeded: no node key in prefs")
  281. }
  282. didJustEnable := false
  283. if isEnabled != wantEnabled {
  284. var ourHead tka.AUMHash
  285. if b.tka != nil {
  286. ourHead = b.tka.authority.Head()
  287. }
  288. // Regardless of whether we are moving to disabled or enabled, we
  289. // need information from the tka bootstrap endpoint.
  290. b.mu.Unlock()
  291. bs, err := b.tkaFetchBootstrap(ourNodeKey, ourHead)
  292. b.mu.Lock()
  293. if err != nil {
  294. return fmt.Errorf("fetching bootstrap: %w", err)
  295. }
  296. if wantEnabled && !isEnabled {
  297. if err := b.tkaBootstrapFromGenesisLocked(bs.GenesisAUM, prefs.Persist()); err != nil {
  298. return fmt.Errorf("bootstrap: %w", err)
  299. }
  300. isEnabled = true
  301. didJustEnable = true
  302. } else if !wantEnabled && isEnabled {
  303. if err := b.tkaApplyDisablementLocked(bs.DisablementSecret); err != nil {
  304. // We log here instead of returning an error (which itself would be
  305. // logged), so that sync will continue even if control gives us an
  306. // incorrect disablement secret.
  307. b.logf("Disablement failed, leaving TKA enabled. Error: %v", err)
  308. } else {
  309. isEnabled = false
  310. b.health.SetTKAHealth(nil)
  311. }
  312. } else {
  313. return fmt.Errorf("[bug] unreachable invariant of wantEnabled w/ isEnabled")
  314. }
  315. }
  316. // We always transmit the sync RPCs if TKA was just enabled.
  317. // This informs the control plane that our TKA state is now
  318. // initialized to the transmitted TKA head hash.
  319. if isEnabled && (b.tka.authority.Head() != nm.TKAHead || didJustEnable) {
  320. if err := b.tkaSyncLocked(ourNodeKey); err != nil {
  321. return fmt.Errorf("tka sync: %w", err)
  322. }
  323. // Try to compact the TKA state, to avoid unbounded storage on nodes.
  324. //
  325. // We run this on every sync so that clients compact consistently. In many
  326. // cases this will be a no-op.
  327. if err := b.tka.authority.Compact(b.tka.storage, tkaCompactionDefaults); err != nil {
  328. return fmt.Errorf("tka compact: %w", err)
  329. }
  330. }
  331. return nil
  332. }
  333. // tkaSyncLocked synchronizes TKA state with control. b.mu must be held
  334. // and tka must be initialized. b.mu will be stepped out of (and back into)
  335. // during network RPCs.
  336. //
  337. // b.mu must be held.
  338. func (b *LocalBackend) tkaSyncLocked(ourNodeKey key.NodePublic) error {
  339. offer, err := b.tka.authority.SyncOffer(b.tka.storage)
  340. if err != nil {
  341. return fmt.Errorf("offer: %w", err)
  342. }
  343. b.mu.Unlock()
  344. offerResp, err := b.tkaDoSyncOffer(ourNodeKey, offer)
  345. b.mu.Lock()
  346. if err != nil {
  347. return fmt.Errorf("offer RPC: %w", err)
  348. }
  349. controlOffer, err := tka.ToSyncOffer(offerResp.Head, offerResp.Ancestors)
  350. if err != nil {
  351. return fmt.Errorf("control offer: %v", err)
  352. }
  353. if controlOffer.Head == offer.Head {
  354. // We are up to date.
  355. return nil
  356. }
  357. // Compute missing AUMs before we apply any AUMs from the control-plane,
  358. // so we still submit AUMs to control even if they are not part of the
  359. // active chain.
  360. toSendAUMs, err := b.tka.authority.MissingAUMs(b.tka.storage, controlOffer)
  361. if err != nil {
  362. return fmt.Errorf("computing missing AUMs: %w", err)
  363. }
  364. // If we got this far, then we are not up to date. Either the control-plane
  365. // has updates for us, or we have updates for the control plane.
  366. //
  367. // TODO(tom): Do we want to keep processing even if the Inform fails? Need
  368. // to think through if theres holdback concerns here or not.
  369. if len(offerResp.MissingAUMs) > 0 {
  370. aums := make([]tka.AUM, len(offerResp.MissingAUMs))
  371. for i, a := range offerResp.MissingAUMs {
  372. if err := aums[i].Unserialize(a); err != nil {
  373. return fmt.Errorf("MissingAUMs[%d]: %v", i, err)
  374. }
  375. }
  376. if err := b.tka.authority.Inform(b.tka.storage, aums); err != nil {
  377. return fmt.Errorf("inform failed: %v", err)
  378. }
  379. }
  380. // NOTE(tom): We always send this RPC so control knows what TKA
  381. // head we landed at.
  382. head := b.tka.authority.Head()
  383. b.mu.Unlock()
  384. sendResp, err := b.tkaDoSyncSend(ourNodeKey, head, toSendAUMs, false)
  385. b.mu.Lock()
  386. if err != nil {
  387. return fmt.Errorf("send RPC: %v", err)
  388. }
  389. var remoteHead tka.AUMHash
  390. if err := remoteHead.UnmarshalText([]byte(sendResp.Head)); err != nil {
  391. return fmt.Errorf("head unmarshal: %v", err)
  392. }
  393. if remoteHead != b.tka.authority.Head() {
  394. b.logf("TKA desync: expected consensus after sync but our head is %v and the control plane's is %v", b.tka.authority.Head(), remoteHead)
  395. }
  396. return nil
  397. }
  398. // tkaApplyDisablementLocked checks a disablement secret and locally disables
  399. // TKA (if correct). An error is returned if disablement failed.
  400. //
  401. // b.mu must be held & TKA must be initialized.
  402. func (b *LocalBackend) tkaApplyDisablementLocked(secret []byte) error {
  403. if b.tka.authority.ValidDisablement(secret) {
  404. if err := b.tka.storage.RemoveAll(); err != nil {
  405. return err
  406. }
  407. b.tka = nil
  408. return nil
  409. }
  410. return errors.New("incorrect disablement secret")
  411. }
  412. // chonkPathLocked returns the absolute path to the directory in which TKA
  413. // state (the 'tailchonk') is stored.
  414. //
  415. // b.mu must be held.
  416. func (b *LocalBackend) chonkPathLocked() string {
  417. return filepath.Join(b.TailscaleVarRoot(), "tka-profiles", string(b.pm.CurrentProfile().ID()))
  418. }
  419. // tkaBootstrapFromGenesisLocked initializes the local (on-disk) state of the
  420. // tailnet key authority, based on the given genesis AUM.
  421. //
  422. // b.mu must be held.
  423. func (b *LocalBackend) tkaBootstrapFromGenesisLocked(g tkatype.MarshaledAUM, persist persist.PersistView) error {
  424. var genesis tka.AUM
  425. if err := genesis.Unserialize(g); err != nil {
  426. return fmt.Errorf("reading genesis: %v", err)
  427. }
  428. if persist.Valid() && persist.DisallowedTKAStateIDs().Len() > 0 {
  429. if genesis.State == nil {
  430. return errors.New("invalid genesis: missing State")
  431. }
  432. bootstrapStateID := fmt.Sprintf("%d:%d", genesis.State.StateID1, genesis.State.StateID2)
  433. for _, stateID := range persist.DisallowedTKAStateIDs().All() {
  434. if stateID == bootstrapStateID {
  435. return fmt.Errorf("TKA with stateID of %q is disallowed on this node", stateID)
  436. }
  437. }
  438. }
  439. root := b.TailscaleVarRoot()
  440. var storage tka.CompactableChonk
  441. if root == "" {
  442. b.health.SetUnhealthy(noNetworkLockStateDirWarnable, nil)
  443. b.logf("network-lock using in-memory storage; no state directory")
  444. storage = tka.ChonkMem()
  445. } else {
  446. chonkDir := b.chonkPathLocked()
  447. chonk, err := tka.ChonkDir(chonkDir)
  448. if err != nil {
  449. return fmt.Errorf("chonk: %v", err)
  450. }
  451. storage = chonk
  452. }
  453. authority, err := tka.Bootstrap(storage, genesis)
  454. if err != nil {
  455. return fmt.Errorf("tka bootstrap: %v", err)
  456. }
  457. b.tka = &tkaState{
  458. profile: b.pm.CurrentProfile().ID(),
  459. authority: authority,
  460. storage: storage,
  461. }
  462. return nil
  463. }
  464. // NetworkLockStatus returns a structure describing the state of the
  465. // tailnet key authority, if any.
  466. func (b *LocalBackend) NetworkLockStatus() *ipnstate.NetworkLockStatus {
  467. b.mu.Lock()
  468. defer b.mu.Unlock()
  469. var (
  470. nodeKey *key.NodePublic
  471. nlPriv key.NLPrivate
  472. )
  473. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() && !p.Persist().PrivateNodeKey().IsZero() {
  474. nkp := p.Persist().PublicNodeKey()
  475. nodeKey = &nkp
  476. nlPriv = p.Persist().NetworkLockKey()
  477. }
  478. if nlPriv.IsZero() {
  479. return &ipnstate.NetworkLockStatus{
  480. Enabled: false,
  481. NodeKey: nodeKey,
  482. }
  483. }
  484. if b.tka == nil {
  485. return &ipnstate.NetworkLockStatus{
  486. Enabled: false,
  487. NodeKey: nodeKey,
  488. PublicKey: nlPriv.Public(),
  489. }
  490. }
  491. var head [32]byte
  492. h := b.tka.authority.Head()
  493. copy(head[:], h[:])
  494. var selfAuthorized bool
  495. nodeKeySignature := &tka.NodeKeySignature{}
  496. nm := b.currentNode().NetMap()
  497. if nm != nil {
  498. selfAuthorized = b.tka.authority.NodeKeyAuthorized(nm.SelfNode.Key(), nm.SelfNode.KeySignature().AsSlice()) == nil
  499. if err := nodeKeySignature.Unserialize(nm.SelfNode.KeySignature().AsSlice()); err != nil {
  500. b.logf("failed to decode self node key signature: %v", err)
  501. }
  502. }
  503. keys := b.tka.authority.Keys()
  504. outKeys := make([]ipnstate.TKAKey, len(keys))
  505. for i, k := range keys {
  506. outKeys[i] = ipnstate.TKAKey{
  507. Key: key.NLPublicFromEd25519Unsafe(k.Public),
  508. Metadata: k.Meta,
  509. Votes: k.Votes,
  510. }
  511. }
  512. filtered := make([]*ipnstate.TKAPeer, len(b.tka.filtered))
  513. for i := range len(filtered) {
  514. filtered[i] = b.tka.filtered[i].Clone()
  515. }
  516. var visible []*ipnstate.TKAPeer
  517. if nm != nil {
  518. visible = make([]*ipnstate.TKAPeer, len(nm.Peers))
  519. for i, p := range nm.Peers {
  520. s := tkaStateFromPeer(p)
  521. visible[i] = &s
  522. }
  523. }
  524. stateID1, _ := b.tka.authority.StateIDs()
  525. return &ipnstate.NetworkLockStatus{
  526. Enabled: true,
  527. Head: &head,
  528. PublicKey: nlPriv.Public(),
  529. NodeKey: nodeKey,
  530. NodeKeySigned: selfAuthorized,
  531. NodeKeySignature: nodeKeySignature,
  532. TrustedKeys: outKeys,
  533. FilteredPeers: filtered,
  534. VisiblePeers: visible,
  535. StateID: stateID1,
  536. }
  537. }
  538. func tkaStateFromPeer(p tailcfg.NodeView) ipnstate.TKAPeer {
  539. fp := ipnstate.TKAPeer{
  540. Name: p.Name(),
  541. ID: p.ID(),
  542. StableID: p.StableID(),
  543. TailscaleIPs: make([]netip.Addr, 0, p.Addresses().Len()),
  544. NodeKey: p.Key(),
  545. }
  546. for _, addr := range p.Addresses().All() {
  547. if addr.IsSingleIP() && tsaddr.IsTailscaleIP(addr.Addr()) {
  548. fp.TailscaleIPs = append(fp.TailscaleIPs, addr.Addr())
  549. }
  550. }
  551. var decoded tka.NodeKeySignature
  552. if err := decoded.Unserialize(p.KeySignature().AsSlice()); err == nil {
  553. fp.NodeKeySignature = decoded
  554. }
  555. return fp
  556. }
  557. // NetworkLockInit enables network-lock for the tailnet, with the tailnets'
  558. // key authority initialized to trust the provided keys.
  559. //
  560. // Initialization involves two RPCs with control, termed 'begin' and 'finish'.
  561. // The Begin RPC transmits the genesis Authority Update Message, which
  562. // encodes the initial state of the authority, and the list of all nodes
  563. // needing signatures is returned as a response.
  564. // The Finish RPC submits signatures for all these nodes, at which point
  565. // Control has everything it needs to atomically enable network lock.
  566. func (b *LocalBackend) NetworkLockInit(keys []tka.Key, disablementValues [][]byte, supportDisablement []byte) error {
  567. var ourNodeKey key.NodePublic
  568. var nlPriv key.NLPrivate
  569. b.mu.Lock()
  570. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() && !p.Persist().PrivateNodeKey().IsZero() {
  571. ourNodeKey = p.Persist().PublicNodeKey()
  572. nlPriv = p.Persist().NetworkLockKey()
  573. }
  574. b.mu.Unlock()
  575. if ourNodeKey.IsZero() || nlPriv.IsZero() {
  576. return errors.New("no node-key: is tailscale logged in?")
  577. }
  578. var entropy [16]byte
  579. if _, err := rand.Read(entropy[:]); err != nil {
  580. return err
  581. }
  582. // Generates a genesis AUM representing trust in the provided keys.
  583. // We use an in-memory tailchonk because we don't want to commit to
  584. // the filesystem until we've finished the initialization sequence,
  585. // just in case something goes wrong.
  586. _, genesisAUM, err := tka.Create(tka.ChonkMem(), tka.State{
  587. Keys: keys,
  588. // TODO(tom): s/tka.State.DisablementSecrets/tka.State.DisablementValues
  589. // This will center on consistent nomenclature:
  590. // - DisablementSecret: value needed to disable.
  591. // - DisablementValue: the KDF of the disablement secret, a public value.
  592. DisablementSecrets: disablementValues,
  593. StateID1: binary.LittleEndian.Uint64(entropy[:8]),
  594. StateID2: binary.LittleEndian.Uint64(entropy[8:]),
  595. }, nlPriv)
  596. if err != nil {
  597. return fmt.Errorf("tka.Create: %v", err)
  598. }
  599. b.logf("Generated genesis AUM to initialize network lock, trusting the following keys:")
  600. for i, k := range genesisAUM.State.Keys {
  601. b.logf(" - key[%d] = tlpub:%x with %d votes", i, k.Public, k.Votes)
  602. }
  603. // Phase 1/2 of initialization: Transmit the genesis AUM to Control.
  604. initResp, err := b.tkaInitBegin(ourNodeKey, genesisAUM)
  605. if err != nil {
  606. return fmt.Errorf("tka init-begin RPC: %w", err)
  607. }
  608. // Our genesis AUM was accepted but before Control turns on enforcement of
  609. // node-key signatures, we need to sign keys for all the existing nodes.
  610. // If we don't get these signatures ahead of time, everyone will lose
  611. // connectivity because control won't have any signatures to send which
  612. // satisfy network-lock checks.
  613. sigs := make(map[tailcfg.NodeID]tkatype.MarshaledSignature, len(initResp.NeedSignatures))
  614. for _, nodeInfo := range initResp.NeedSignatures {
  615. nks, err := signNodeKey(nodeInfo, nlPriv)
  616. if err != nil {
  617. return fmt.Errorf("generating signature: %v", err)
  618. }
  619. sigs[nodeInfo.NodeID] = nks.Serialize()
  620. }
  621. // Finalize enablement by transmitting signature for all nodes to Control.
  622. _, err = b.tkaInitFinish(ourNodeKey, sigs, supportDisablement)
  623. return err
  624. }
  625. // NetworkLockAllowed reports whether the node is allowed to use Tailnet Lock.
  626. func (b *LocalBackend) NetworkLockAllowed() bool {
  627. b.mu.Lock()
  628. defer b.mu.Unlock()
  629. return b.capTailnetLock
  630. }
  631. // Only use is in tests.
  632. func (b *LocalBackend) NetworkLockVerifySignatureForTest(nks tkatype.MarshaledSignature, nodeKey key.NodePublic) error {
  633. b.mu.Lock()
  634. defer b.mu.Unlock()
  635. if b.tka == nil {
  636. return errNetworkLockNotActive
  637. }
  638. return b.tka.authority.NodeKeyAuthorized(nodeKey, nks)
  639. }
  640. // Only use is in tests.
  641. func (b *LocalBackend) NetworkLockKeyTrustedForTest(keyID tkatype.KeyID) bool {
  642. b.mu.Lock()
  643. defer b.mu.Unlock()
  644. if b.tka == nil {
  645. panic("network lock not initialized")
  646. }
  647. return b.tka.authority.KeyTrusted(keyID)
  648. }
  649. // NetworkLockForceLocalDisable shuts down TKA locally, and denylists the current
  650. // TKA from being initialized locally in future.
  651. func (b *LocalBackend) NetworkLockForceLocalDisable() error {
  652. b.mu.Lock()
  653. defer b.mu.Unlock()
  654. if b.tka == nil {
  655. return errNetworkLockNotActive
  656. }
  657. id1, id2 := b.tka.authority.StateIDs()
  658. stateID := fmt.Sprintf("%d:%d", id1, id2)
  659. cn := b.currentNode()
  660. newPrefs := b.pm.CurrentPrefs().AsStruct().Clone() // .Persist should always be initialized here.
  661. newPrefs.Persist.DisallowedTKAStateIDs = append(newPrefs.Persist.DisallowedTKAStateIDs, stateID)
  662. if err := b.pm.SetPrefs(newPrefs.View(), cn.NetworkProfile()); err != nil {
  663. return fmt.Errorf("saving prefs: %w", err)
  664. }
  665. if err := b.tka.storage.RemoveAll(); err != nil {
  666. return fmt.Errorf("deleting TKA state: %w", err)
  667. }
  668. b.tka = nil
  669. return nil
  670. }
  671. // NetworkLockSign signs the given node-key and submits it to the control plane.
  672. // rotationPublic, if specified, must be an ed25519 public key.
  673. func (b *LocalBackend) NetworkLockSign(nodeKey key.NodePublic, rotationPublic []byte) error {
  674. ourNodeKey, sig, err := func(nodeKey key.NodePublic, rotationPublic []byte) (key.NodePublic, tka.NodeKeySignature, error) {
  675. b.mu.Lock()
  676. defer b.mu.Unlock()
  677. var nlPriv key.NLPrivate
  678. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() {
  679. nlPriv = p.Persist().NetworkLockKey()
  680. }
  681. if nlPriv.IsZero() {
  682. return key.NodePublic{}, tka.NodeKeySignature{}, errMissingNetmap
  683. }
  684. if b.tka == nil {
  685. return key.NodePublic{}, tka.NodeKeySignature{}, errNetworkLockNotActive
  686. }
  687. if !b.tka.authority.KeyTrusted(nlPriv.KeyID()) {
  688. return key.NodePublic{}, tka.NodeKeySignature{}, errors.New(tsconst.TailnetLockNotTrustedMsg)
  689. }
  690. p, err := nodeKey.MarshalBinary()
  691. if err != nil {
  692. return key.NodePublic{}, tka.NodeKeySignature{}, err
  693. }
  694. sig := tka.NodeKeySignature{
  695. SigKind: tka.SigDirect,
  696. KeyID: nlPriv.KeyID(),
  697. Pubkey: p,
  698. WrappingPubkey: rotationPublic,
  699. }
  700. sig.Signature, err = nlPriv.SignNKS(sig.SigHash())
  701. if err != nil {
  702. return key.NodePublic{}, tka.NodeKeySignature{}, fmt.Errorf("signature failed: %w", err)
  703. }
  704. return b.pm.CurrentPrefs().Persist().PublicNodeKey(), sig, nil
  705. }(nodeKey, rotationPublic)
  706. if err != nil {
  707. return err
  708. }
  709. b.logf("Generated network-lock signature for %v, submitting to control plane", nodeKey)
  710. if _, err := b.tkaSubmitSignature(ourNodeKey, sig.Serialize()); err != nil {
  711. return err
  712. }
  713. return nil
  714. }
  715. // NetworkLockModify adds and/or removes keys in the tailnet's key authority.
  716. func (b *LocalBackend) NetworkLockModify(addKeys, removeKeys []tka.Key) (err error) {
  717. defer func() {
  718. if err != nil {
  719. err = fmt.Errorf("modify network-lock keys: %w", err)
  720. }
  721. }()
  722. b.mu.Lock()
  723. defer b.mu.Unlock()
  724. var ourNodeKey key.NodePublic
  725. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() && !p.Persist().PrivateNodeKey().IsZero() {
  726. ourNodeKey = p.Persist().PublicNodeKey()
  727. }
  728. if ourNodeKey.IsZero() {
  729. return errors.New("no node-key: is tailscale logged in?")
  730. }
  731. var nlPriv key.NLPrivate
  732. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() {
  733. nlPriv = p.Persist().NetworkLockKey()
  734. }
  735. if nlPriv.IsZero() {
  736. return errMissingNetmap
  737. }
  738. if b.tka == nil {
  739. return errNetworkLockNotActive
  740. }
  741. if !b.tka.authority.KeyTrusted(nlPriv.KeyID()) {
  742. return errors.New("this node does not have a trusted tailnet lock key")
  743. }
  744. updater := b.tka.authority.NewUpdater(nlPriv)
  745. for _, addKey := range addKeys {
  746. if err := updater.AddKey(addKey); err != nil {
  747. return err
  748. }
  749. }
  750. for _, removeKey := range removeKeys {
  751. keyID, err := removeKey.ID()
  752. if err != nil {
  753. return err
  754. }
  755. if err := updater.RemoveKey(keyID); err != nil {
  756. return err
  757. }
  758. }
  759. aums, err := updater.Finalize(b.tka.storage)
  760. if err != nil {
  761. return err
  762. }
  763. if len(aums) == 0 {
  764. return nil
  765. }
  766. head := b.tka.authority.Head()
  767. b.mu.Unlock()
  768. resp, err := b.tkaDoSyncSend(ourNodeKey, head, aums, true)
  769. b.mu.Lock()
  770. if err != nil {
  771. return err
  772. }
  773. var controlHead tka.AUMHash
  774. if err := controlHead.UnmarshalText([]byte(resp.Head)); err != nil {
  775. return err
  776. }
  777. lastHead := aums[len(aums)-1].Hash()
  778. if controlHead != lastHead {
  779. return errors.New("central tka head differs from submitted AUM, try again")
  780. }
  781. return nil
  782. }
  783. // NetworkLockDisable disables network-lock using the provided disablement secret.
  784. func (b *LocalBackend) NetworkLockDisable(secret []byte) error {
  785. var (
  786. ourNodeKey key.NodePublic
  787. head tka.AUMHash
  788. err error
  789. )
  790. b.mu.Lock()
  791. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() && !p.Persist().PrivateNodeKey().IsZero() {
  792. ourNodeKey = p.Persist().PublicNodeKey()
  793. }
  794. if b.tka == nil {
  795. err = errNetworkLockNotActive
  796. } else {
  797. head = b.tka.authority.Head()
  798. if !b.tka.authority.ValidDisablement(secret) {
  799. err = errors.New("incorrect disablement secret")
  800. }
  801. }
  802. b.mu.Unlock()
  803. if err != nil {
  804. return err
  805. }
  806. if ourNodeKey.IsZero() {
  807. return errors.New("no node-key: is tailscale logged in?")
  808. }
  809. _, err = b.tkaDoDisablement(ourNodeKey, head, secret)
  810. return err
  811. }
  812. // NetworkLockLog returns the changelog of TKA state up to maxEntries in size.
  813. func (b *LocalBackend) NetworkLockLog(maxEntries int) ([]ipnstate.NetworkLockUpdate, error) {
  814. b.mu.Lock()
  815. defer b.mu.Unlock()
  816. if b.tka == nil {
  817. return nil, errNetworkLockNotActive
  818. }
  819. var out []ipnstate.NetworkLockUpdate
  820. cursor := b.tka.authority.Head()
  821. for range maxEntries {
  822. aum, err := b.tka.storage.AUM(cursor)
  823. if err != nil {
  824. if err == os.ErrNotExist {
  825. break
  826. }
  827. return out, fmt.Errorf("reading AUM (%v): %w", cursor, err)
  828. }
  829. update := ipnstate.NetworkLockUpdate{
  830. Hash: cursor,
  831. Change: aum.MessageKind.String(),
  832. Raw: aum.Serialize(),
  833. }
  834. out = append(out, update)
  835. parent, hasParent := aum.Parent()
  836. if !hasParent {
  837. break
  838. }
  839. cursor = parent
  840. }
  841. return out, nil
  842. }
  843. // NetworkLockAffectedSigs returns the signatures which would be invalidated
  844. // by removing trust in the specified KeyID.
  845. func (b *LocalBackend) NetworkLockAffectedSigs(keyID tkatype.KeyID) ([]tkatype.MarshaledSignature, error) {
  846. var (
  847. ourNodeKey key.NodePublic
  848. err error
  849. )
  850. b.mu.Lock()
  851. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() && !p.Persist().PrivateNodeKey().IsZero() {
  852. ourNodeKey = p.Persist().PublicNodeKey()
  853. }
  854. if b.tka == nil {
  855. err = errNetworkLockNotActive
  856. }
  857. b.mu.Unlock()
  858. if err != nil {
  859. return nil, err
  860. }
  861. resp, err := b.tkaReadAffectedSigs(ourNodeKey, keyID)
  862. if err != nil {
  863. return nil, err
  864. }
  865. b.mu.Lock()
  866. defer b.mu.Unlock()
  867. if b.tka == nil {
  868. return nil, errNetworkLockNotActive
  869. }
  870. // Confirm for ourselves tha the signatures would actually be invalidated
  871. // by removal of trusted in the specified key.
  872. for i, sigBytes := range resp.Signatures {
  873. var sig tka.NodeKeySignature
  874. if err := sig.Unserialize(sigBytes); err != nil {
  875. return nil, fmt.Errorf("failed decoding signature %d: %w", i, err)
  876. }
  877. sigKeyID, err := sig.UnverifiedAuthorizingKeyID()
  878. if err != nil {
  879. return nil, fmt.Errorf("extracting SigID from signature %d: %w", i, err)
  880. }
  881. if !bytes.Equal(keyID, sigKeyID) {
  882. return nil, fmt.Errorf("got signature with keyID %X from request for %X", sigKeyID, keyID)
  883. }
  884. var nodeKey key.NodePublic
  885. if err := nodeKey.UnmarshalBinary(sig.Pubkey); err != nil {
  886. return nil, fmt.Errorf("failed decoding pubkey for signature %d: %w", i, err)
  887. }
  888. if err := b.tka.authority.NodeKeyAuthorized(nodeKey, sigBytes); err != nil {
  889. return nil, fmt.Errorf("signature %d is not valid: %w", i, err)
  890. }
  891. }
  892. return resp.Signatures, nil
  893. }
  894. // NetworkLockGenerateRecoveryAUM generates an AUM which retroactively removes trust in the
  895. // specified keys. This AUM is signed by the current node and returned.
  896. //
  897. // If forkFrom is specified, it is used as the parent AUM to fork from. If the zero value,
  898. // the parent AUM is determined automatically.
  899. func (b *LocalBackend) NetworkLockGenerateRecoveryAUM(removeKeys []tkatype.KeyID, forkFrom tka.AUMHash) (*tka.AUM, error) {
  900. b.mu.Lock()
  901. defer b.mu.Unlock()
  902. if b.tka == nil {
  903. return nil, errNetworkLockNotActive
  904. }
  905. var nlPriv key.NLPrivate
  906. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() {
  907. nlPriv = p.Persist().NetworkLockKey()
  908. }
  909. if nlPriv.IsZero() {
  910. return nil, errMissingNetmap
  911. }
  912. aum, err := b.tka.authority.MakeRetroactiveRevocation(b.tka.storage, removeKeys, nlPriv.KeyID(), forkFrom)
  913. if err != nil {
  914. return nil, err
  915. }
  916. // Sign it ourselves.
  917. aum.Signatures, err = nlPriv.SignAUM(aum.SigHash())
  918. if err != nil {
  919. return nil, fmt.Errorf("signing failed: %w", err)
  920. }
  921. return aum, nil
  922. }
  923. // NetworkLockCosignRecoveryAUM co-signs the provided recovery AUM and returns
  924. // the updated structure.
  925. //
  926. // The recovery AUM provided should be the output from a previous call to
  927. // NetworkLockGenerateRecoveryAUM or NetworkLockCosignRecoveryAUM.
  928. func (b *LocalBackend) NetworkLockCosignRecoveryAUM(aum *tka.AUM) (*tka.AUM, error) {
  929. b.mu.Lock()
  930. defer b.mu.Unlock()
  931. if b.tka == nil {
  932. return nil, errNetworkLockNotActive
  933. }
  934. var nlPriv key.NLPrivate
  935. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() {
  936. nlPriv = p.Persist().NetworkLockKey()
  937. }
  938. if nlPriv.IsZero() {
  939. return nil, errMissingNetmap
  940. }
  941. for _, sig := range aum.Signatures {
  942. if bytes.Equal(sig.KeyID, nlPriv.KeyID()) {
  943. return nil, errors.New("this node has already signed this recovery AUM")
  944. }
  945. }
  946. // Sign it ourselves.
  947. sigs, err := nlPriv.SignAUM(aum.SigHash())
  948. if err != nil {
  949. return nil, fmt.Errorf("signing failed: %w", err)
  950. }
  951. aum.Signatures = append(aum.Signatures, sigs...)
  952. return aum, nil
  953. }
  954. func (b *LocalBackend) NetworkLockSubmitRecoveryAUM(aum *tka.AUM) error {
  955. b.mu.Lock()
  956. defer b.mu.Unlock()
  957. if b.tka == nil {
  958. return errNetworkLockNotActive
  959. }
  960. var ourNodeKey key.NodePublic
  961. if p := b.pm.CurrentPrefs(); p.Valid() && p.Persist().Valid() && !p.Persist().PrivateNodeKey().IsZero() {
  962. ourNodeKey = p.Persist().PublicNodeKey()
  963. }
  964. if ourNodeKey.IsZero() {
  965. return errors.New("no node-key: is tailscale logged in?")
  966. }
  967. b.mu.Unlock()
  968. _, err := b.tkaDoSyncSend(ourNodeKey, aum.Hash(), []tka.AUM{*aum}, false)
  969. b.mu.Lock()
  970. return err
  971. }
  972. var tkaSuffixEncoder = base64.RawStdEncoding
  973. // NetworkLockWrapPreauthKey wraps a pre-auth key with information to
  974. // enable unattended bringup in the locked tailnet.
  975. //
  976. // The provided trusted tailnet-lock key is used to sign
  977. // a SigCredential structure, which is encoded along with the
  978. // private key and appended to the pre-auth key.
  979. func (b *LocalBackend) NetworkLockWrapPreauthKey(preauthKey string, tkaKey key.NLPrivate) (string, error) {
  980. b.mu.Lock()
  981. defer b.mu.Unlock()
  982. if b.tka == nil {
  983. return "", errNetworkLockNotActive
  984. }
  985. pub, priv, err := ed25519.GenerateKey(nil) // nil == crypto/rand
  986. if err != nil {
  987. return "", err
  988. }
  989. sig := tka.NodeKeySignature{
  990. SigKind: tka.SigCredential,
  991. KeyID: tkaKey.KeyID(),
  992. WrappingPubkey: pub,
  993. }
  994. sig.Signature, err = tkaKey.SignNKS(sig.SigHash())
  995. if err != nil {
  996. return "", fmt.Errorf("signing failed: %w", err)
  997. }
  998. b.logf("Generated network-lock credential signature using %s", tkaKey.Public().CLIString())
  999. return fmt.Sprintf("%s--TL%s-%s", preauthKey, tkaSuffixEncoder.EncodeToString(sig.Serialize()), tkaSuffixEncoder.EncodeToString(priv)), nil
  1000. }
  1001. // NetworkLockVerifySigningDeeplink asks the authority to verify the given deeplink
  1002. // URL. See the comment for ValidateDeeplink for details.
  1003. func (b *LocalBackend) NetworkLockVerifySigningDeeplink(url string) tka.DeeplinkValidationResult {
  1004. b.mu.Lock()
  1005. defer b.mu.Unlock()
  1006. if b.tka == nil {
  1007. return tka.DeeplinkValidationResult{IsValid: false, Error: errNetworkLockNotActive.Error()}
  1008. }
  1009. return b.tka.authority.ValidateDeeplink(url)
  1010. }
  1011. func signNodeKey(nodeInfo tailcfg.TKASignInfo, signer key.NLPrivate) (*tka.NodeKeySignature, error) {
  1012. p, err := nodeInfo.NodePublic.MarshalBinary()
  1013. if err != nil {
  1014. return nil, err
  1015. }
  1016. sig := tka.NodeKeySignature{
  1017. SigKind: tka.SigDirect,
  1018. KeyID: signer.KeyID(),
  1019. Pubkey: p,
  1020. WrappingPubkey: nodeInfo.RotationPubkey,
  1021. }
  1022. sig.Signature, err = signer.SignNKS(sig.SigHash())
  1023. if err != nil {
  1024. return nil, fmt.Errorf("signature failed: %w", err)
  1025. }
  1026. return &sig, nil
  1027. }
  1028. func (b *LocalBackend) tkaInitBegin(ourNodeKey key.NodePublic, aum tka.AUM) (*tailcfg.TKAInitBeginResponse, error) {
  1029. var req bytes.Buffer
  1030. if err := json.NewEncoder(&req).Encode(tailcfg.TKAInitBeginRequest{
  1031. Version: tailcfg.CurrentCapabilityVersion,
  1032. NodeKey: ourNodeKey,
  1033. GenesisAUM: aum.Serialize(),
  1034. }); err != nil {
  1035. return nil, fmt.Errorf("encoding request: %v", err)
  1036. }
  1037. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1038. defer cancel()
  1039. req2, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/init/begin", &req)
  1040. if err != nil {
  1041. return nil, fmt.Errorf("req: %w", err)
  1042. }
  1043. res, err := b.DoNoiseRequest(req2)
  1044. if err != nil {
  1045. return nil, fmt.Errorf("resp: %w", err)
  1046. }
  1047. if res.StatusCode != 200 {
  1048. body, _ := io.ReadAll(res.Body)
  1049. res.Body.Close()
  1050. return nil, fmt.Errorf("request returned (%d): %s", res.StatusCode, string(body))
  1051. }
  1052. a := new(tailcfg.TKAInitBeginResponse)
  1053. err = json.NewDecoder(&io.LimitedReader{R: res.Body, N: 10 * 1024 * 1024}).Decode(a)
  1054. res.Body.Close()
  1055. if err != nil {
  1056. return nil, fmt.Errorf("decoding JSON: %w", err)
  1057. }
  1058. return a, nil
  1059. }
  1060. func (b *LocalBackend) tkaInitFinish(ourNodeKey key.NodePublic, nks map[tailcfg.NodeID]tkatype.MarshaledSignature, supportDisablement []byte) (*tailcfg.TKAInitFinishResponse, error) {
  1061. var req bytes.Buffer
  1062. if err := json.NewEncoder(&req).Encode(tailcfg.TKAInitFinishRequest{
  1063. Version: tailcfg.CurrentCapabilityVersion,
  1064. NodeKey: ourNodeKey,
  1065. Signatures: nks,
  1066. SupportDisablement: supportDisablement,
  1067. }); err != nil {
  1068. return nil, fmt.Errorf("encoding request: %v", err)
  1069. }
  1070. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1071. defer cancel()
  1072. req2, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/init/finish", &req)
  1073. if err != nil {
  1074. return nil, fmt.Errorf("req: %w", err)
  1075. }
  1076. res, err := b.DoNoiseRequest(req2)
  1077. if err != nil {
  1078. return nil, fmt.Errorf("resp: %w", err)
  1079. }
  1080. if res.StatusCode != 200 {
  1081. body, _ := io.ReadAll(res.Body)
  1082. res.Body.Close()
  1083. return nil, fmt.Errorf("request returned (%d): %s", res.StatusCode, string(body))
  1084. }
  1085. a := new(tailcfg.TKAInitFinishResponse)
  1086. err = json.NewDecoder(&io.LimitedReader{R: res.Body, N: 1024 * 1024}).Decode(a)
  1087. res.Body.Close()
  1088. if err != nil {
  1089. return nil, fmt.Errorf("decoding JSON: %w", err)
  1090. }
  1091. return a, nil
  1092. }
  1093. // tkaFetchBootstrap sends a /machine/tka/bootstrap RPC to the control plane
  1094. // over noise. This is used to get values necessary to enable or disable TKA.
  1095. func (b *LocalBackend) tkaFetchBootstrap(ourNodeKey key.NodePublic, head tka.AUMHash) (*tailcfg.TKABootstrapResponse, error) {
  1096. bootstrapReq := tailcfg.TKABootstrapRequest{
  1097. Version: tailcfg.CurrentCapabilityVersion,
  1098. NodeKey: ourNodeKey,
  1099. }
  1100. if !head.IsZero() {
  1101. head, err := head.MarshalText()
  1102. if err != nil {
  1103. return nil, fmt.Errorf("head.MarshalText failed: %v", err)
  1104. }
  1105. bootstrapReq.Head = string(head)
  1106. }
  1107. var req bytes.Buffer
  1108. if err := json.NewEncoder(&req).Encode(bootstrapReq); err != nil {
  1109. return nil, fmt.Errorf("encoding request: %v", err)
  1110. }
  1111. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1112. defer cancel()
  1113. if err := ctx.Err(); err != nil {
  1114. return nil, fmt.Errorf("ctx: %w", err)
  1115. }
  1116. req2, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/bootstrap", &req)
  1117. if err != nil {
  1118. return nil, fmt.Errorf("req: %w", err)
  1119. }
  1120. res, err := b.DoNoiseRequest(req2)
  1121. if err != nil {
  1122. return nil, fmt.Errorf("resp: %w", err)
  1123. }
  1124. if res.StatusCode != 200 {
  1125. body, _ := io.ReadAll(res.Body)
  1126. res.Body.Close()
  1127. return nil, fmt.Errorf("request returned (%d): %s", res.StatusCode, string(body))
  1128. }
  1129. a := new(tailcfg.TKABootstrapResponse)
  1130. err = json.NewDecoder(&io.LimitedReader{R: res.Body, N: 1024 * 1024}).Decode(a)
  1131. res.Body.Close()
  1132. if err != nil {
  1133. return nil, fmt.Errorf("decoding JSON: %w", err)
  1134. }
  1135. return a, nil
  1136. }
  1137. // tkaDoSyncOffer sends a /machine/tka/sync/offer RPC to the control plane
  1138. // over noise. This is the first of two RPCs implementing tka synchronization.
  1139. func (b *LocalBackend) tkaDoSyncOffer(ourNodeKey key.NodePublic, offer tka.SyncOffer) (*tailcfg.TKASyncOfferResponse, error) {
  1140. head, ancestors, err := tka.FromSyncOffer(offer)
  1141. if err != nil {
  1142. return nil, fmt.Errorf("encoding offer: %v", err)
  1143. }
  1144. syncReq := tailcfg.TKASyncOfferRequest{
  1145. Version: tailcfg.CurrentCapabilityVersion,
  1146. NodeKey: ourNodeKey,
  1147. Head: head,
  1148. Ancestors: ancestors,
  1149. }
  1150. var req bytes.Buffer
  1151. if err := json.NewEncoder(&req).Encode(syncReq); err != nil {
  1152. return nil, fmt.Errorf("encoding request: %v", err)
  1153. }
  1154. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1155. defer cancel()
  1156. req2, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/sync/offer", &req)
  1157. if err != nil {
  1158. return nil, fmt.Errorf("req: %w", err)
  1159. }
  1160. res, err := b.DoNoiseRequest(req2)
  1161. if err != nil {
  1162. return nil, fmt.Errorf("resp: %w", err)
  1163. }
  1164. if res.StatusCode != 200 {
  1165. body, _ := io.ReadAll(res.Body)
  1166. res.Body.Close()
  1167. return nil, fmt.Errorf("request returned (%d): %s", res.StatusCode, string(body))
  1168. }
  1169. a := new(tailcfg.TKASyncOfferResponse)
  1170. err = json.NewDecoder(&io.LimitedReader{R: res.Body, N: 10 * 1024 * 1024}).Decode(a)
  1171. res.Body.Close()
  1172. if err != nil {
  1173. return nil, fmt.Errorf("decoding JSON: %w", err)
  1174. }
  1175. return a, nil
  1176. }
  1177. // tkaDoSyncSend sends a /machine/tka/sync/send RPC to the control plane
  1178. // over noise. This is the second of two RPCs implementing tka synchronization.
  1179. func (b *LocalBackend) tkaDoSyncSend(ourNodeKey key.NodePublic, head tka.AUMHash, aums []tka.AUM, interactive bool) (*tailcfg.TKASyncSendResponse, error) {
  1180. headBytes, err := head.MarshalText()
  1181. if err != nil {
  1182. return nil, fmt.Errorf("head.MarshalText: %w", err)
  1183. }
  1184. sendReq := tailcfg.TKASyncSendRequest{
  1185. Version: tailcfg.CurrentCapabilityVersion,
  1186. NodeKey: ourNodeKey,
  1187. Head: string(headBytes),
  1188. MissingAUMs: make([]tkatype.MarshaledAUM, len(aums)),
  1189. Interactive: interactive,
  1190. }
  1191. for i, a := range aums {
  1192. sendReq.MissingAUMs[i] = a.Serialize()
  1193. }
  1194. var req bytes.Buffer
  1195. if err := json.NewEncoder(&req).Encode(sendReq); err != nil {
  1196. return nil, fmt.Errorf("encoding request: %v", err)
  1197. }
  1198. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1199. defer cancel()
  1200. req2, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/sync/send", &req)
  1201. if err != nil {
  1202. return nil, fmt.Errorf("req: %w", err)
  1203. }
  1204. res, err := b.DoNoiseRequest(req2)
  1205. if err != nil {
  1206. return nil, fmt.Errorf("resp: %w", err)
  1207. }
  1208. if res.StatusCode != 200 {
  1209. body, _ := io.ReadAll(res.Body)
  1210. res.Body.Close()
  1211. return nil, fmt.Errorf("request returned (%d): %s", res.StatusCode, string(body))
  1212. }
  1213. a := new(tailcfg.TKASyncSendResponse)
  1214. err = json.NewDecoder(&io.LimitedReader{R: res.Body, N: 10 * 1024 * 1024}).Decode(a)
  1215. res.Body.Close()
  1216. if err != nil {
  1217. return nil, fmt.Errorf("decoding JSON: %w", err)
  1218. }
  1219. return a, nil
  1220. }
  1221. func (b *LocalBackend) tkaDoDisablement(ourNodeKey key.NodePublic, head tka.AUMHash, secret []byte) (*tailcfg.TKADisableResponse, error) {
  1222. headBytes, err := head.MarshalText()
  1223. if err != nil {
  1224. return nil, fmt.Errorf("head.MarshalText: %w", err)
  1225. }
  1226. var req bytes.Buffer
  1227. if err := json.NewEncoder(&req).Encode(tailcfg.TKADisableRequest{
  1228. Version: tailcfg.CurrentCapabilityVersion,
  1229. NodeKey: ourNodeKey,
  1230. Head: string(headBytes),
  1231. DisablementSecret: secret,
  1232. }); err != nil {
  1233. return nil, fmt.Errorf("encoding request: %v", err)
  1234. }
  1235. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1236. defer cancel()
  1237. req2, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/disable", &req)
  1238. if err != nil {
  1239. return nil, fmt.Errorf("req: %w", err)
  1240. }
  1241. res, err := b.DoNoiseRequest(req2)
  1242. if err != nil {
  1243. return nil, fmt.Errorf("resp: %w", err)
  1244. }
  1245. if res.StatusCode != 200 {
  1246. body, _ := io.ReadAll(res.Body)
  1247. res.Body.Close()
  1248. return nil, fmt.Errorf("request returned (%d): %s", res.StatusCode, string(body))
  1249. }
  1250. a := new(tailcfg.TKADisableResponse)
  1251. err = json.NewDecoder(&io.LimitedReader{R: res.Body, N: 1024 * 1024}).Decode(a)
  1252. res.Body.Close()
  1253. if err != nil {
  1254. return nil, fmt.Errorf("decoding JSON: %w", err)
  1255. }
  1256. return a, nil
  1257. }
  1258. func (b *LocalBackend) tkaSubmitSignature(ourNodeKey key.NodePublic, sig tkatype.MarshaledSignature) (*tailcfg.TKASubmitSignatureResponse, error) {
  1259. var req bytes.Buffer
  1260. if err := json.NewEncoder(&req).Encode(tailcfg.TKASubmitSignatureRequest{
  1261. Version: tailcfg.CurrentCapabilityVersion,
  1262. NodeKey: ourNodeKey,
  1263. Signature: sig,
  1264. }); err != nil {
  1265. return nil, fmt.Errorf("encoding request: %v", err)
  1266. }
  1267. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1268. defer cancel()
  1269. req2, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/sign", &req)
  1270. if err != nil {
  1271. return nil, fmt.Errorf("req: %w", err)
  1272. }
  1273. res, err := b.DoNoiseRequest(req2)
  1274. if err != nil {
  1275. return nil, fmt.Errorf("resp: %w", err)
  1276. }
  1277. if res.StatusCode != 200 {
  1278. body, _ := io.ReadAll(res.Body)
  1279. res.Body.Close()
  1280. return nil, fmt.Errorf("request returned (%d): %s", res.StatusCode, string(body))
  1281. }
  1282. a := new(tailcfg.TKASubmitSignatureResponse)
  1283. err = json.NewDecoder(&io.LimitedReader{R: res.Body, N: 1024 * 1024}).Decode(a)
  1284. res.Body.Close()
  1285. if err != nil {
  1286. return nil, fmt.Errorf("decoding JSON: %w", err)
  1287. }
  1288. return a, nil
  1289. }
  1290. func (b *LocalBackend) tkaReadAffectedSigs(ourNodeKey key.NodePublic, key tkatype.KeyID) (*tailcfg.TKASignaturesUsingKeyResponse, error) {
  1291. var encodedReq bytes.Buffer
  1292. if err := json.NewEncoder(&encodedReq).Encode(tailcfg.TKASignaturesUsingKeyRequest{
  1293. Version: tailcfg.CurrentCapabilityVersion,
  1294. NodeKey: ourNodeKey,
  1295. KeyID: key,
  1296. }); err != nil {
  1297. return nil, fmt.Errorf("encoding request: %v", err)
  1298. }
  1299. ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
  1300. defer cancel()
  1301. req, err := http.NewRequestWithContext(ctx, "GET", "https://unused/machine/tka/affected-sigs", &encodedReq)
  1302. if err != nil {
  1303. return nil, fmt.Errorf("req: %w", err)
  1304. }
  1305. resp, err := b.DoNoiseRequest(req)
  1306. if err != nil {
  1307. return nil, fmt.Errorf("resp: %w", err)
  1308. }
  1309. if resp.StatusCode != 200 {
  1310. body, _ := io.ReadAll(resp.Body)
  1311. resp.Body.Close()
  1312. return nil, fmt.Errorf("request returned (%d): %s", resp.StatusCode, string(body))
  1313. }
  1314. a := new(tailcfg.TKASignaturesUsingKeyResponse)
  1315. err = json.NewDecoder(&io.LimitedReader{R: resp.Body, N: 1024 * 1024}).Decode(a)
  1316. resp.Body.Close()
  1317. if err != nil {
  1318. return nil, fmt.Errorf("decoding JSON: %w", err)
  1319. }
  1320. return a, nil
  1321. }