ipn/ipnlocal: reset auto-updates if unsupported on profile load (#11838)

Prior to
1613b18f82 (diff-314ba0d799f70c8998940903efb541e511f352b39a9eeeae8d475c921d66c2ac),
nodes could set AutoUpdate.Apply=true on unsupported platforms via
`EditPrefs`. Specifically, this affects tailnets where default
auto-updates are on.

Fix up those invalid prefs on profile reload, as a migration.

Updates #11544

Signed-off-by: Andrew Lytvynov <awly@tailscale.com>
This commit is contained in:
Andrew Lytvynov 2024-04-22 15:55:25 -07:00 committed by GitHub
parent 0a84215036
commit 06502b9048
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 34 additions and 0 deletions

View File

@ -14,6 +14,7 @@
"strings" "strings"
"time" "time"
"tailscale.com/clientupdate"
"tailscale.com/envknob" "tailscale.com/envknob"
"tailscale.com/ipn" "tailscale.com/ipn"
"tailscale.com/types/logger" "tailscale.com/types/logger"
@ -366,6 +367,16 @@ func (pm *profileManager) loadSavedPrefs(key ipn.StateKey) (ipn.PrefsView, error
ipn.IsLoginServerSynonym(savedPrefs.ControlURL) { ipn.IsLoginServerSynonym(savedPrefs.ControlURL) {
savedPrefs.ControlURL = "" savedPrefs.ControlURL = ""
} }
// Before
// https://github.com/tailscale/tailscale/pull/11814/commits/1613b18f8280c2bce786980532d012c9f0454fa2#diff-314ba0d799f70c8998940903efb541e511f352b39a9eeeae8d475c921d66c2ac
// prefs could set AutoUpdate.Apply=true via EditPrefs or tailnet
// auto-update defaults. After that change, such value is "invalid" and
// cause any EditPrefs calls to fail (other than disabling autp-updates).
//
// Reset AutoUpdate.Apply if we detect such invalid prefs.
if savedPrefs.AutoUpdate.Apply.EqualBool(true) && !clientupdate.CanAutoUpdate() {
savedPrefs.AutoUpdate.Apply.Clear()
}
return savedPrefs.View(), nil return savedPrefs.View(), nil
} }

View File

@ -11,6 +11,7 @@
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts" "github.com/google/go-cmp/cmp/cmpopts"
"tailscale.com/clientupdate"
"tailscale.com/ipn" "tailscale.com/ipn"
"tailscale.com/ipn/store/mem" "tailscale.com/ipn/store/mem"
"tailscale.com/tailcfg" "tailscale.com/tailcfg"
@ -339,6 +340,7 @@ func TestProfileManagement(t *testing.T) {
t.Fatalf("Profiles = %v; want %v", profiles, wantProfiles) t.Fatalf("Profiles = %v; want %v", profiles, wantProfiles)
} }
p := pm.CurrentPrefs() p := pm.CurrentPrefs()
t.Logf("\tCurrentPrefs = %s", p.Pretty())
if !p.Valid() { if !p.Valid() {
t.Fatalf("CurrentPrefs = %v; want valid", p) t.Fatalf("CurrentPrefs = %v; want valid", p)
} }
@ -458,6 +460,27 @@ func TestProfileManagement(t *testing.T) {
delete(wantProfiles, "tagged-node.2.ts.net") delete(wantProfiles, "tagged-node.2.ts.net")
wantCurProfile = "user@2.example.com" wantCurProfile = "user@2.example.com"
checkProfiles(t) checkProfiles(t)
if !clientupdate.CanAutoUpdate() {
t.Logf("Save an invalid AutoUpdate pref value")
prefs := pm.CurrentPrefs().AsStruct()
prefs.AutoUpdate.Apply.Set(true)
if err := pm.SetPrefs(prefs.View(), ipn.NetworkProfile{}); err != nil {
t.Fatal(err)
}
if !pm.CurrentPrefs().AutoUpdate().Apply.EqualBool(true) {
t.Fatal("SetPrefs failed to save auto-update setting")
}
// Re-load profiles to trigger migration for invalid auto-update value.
pm, err = newProfileManagerWithGOOS(store, logger.Discard, "linux")
if err != nil {
t.Fatal(err)
}
checkProfiles(t)
if pm.CurrentPrefs().AutoUpdate().Apply.EqualBool(true) {
t.Fatal("invalid auto-update setting persisted after reload")
}
}
} }
// TestProfileManagementWindows tests going into and out of Unattended mode on // TestProfileManagementWindows tests going into and out of Unattended mode on