mirror of
https://github.com/netbirdio/netbird.git
synced 2026-08-04 19:45:14 -04:00
## Describe your changes Three fixes to how the desktop GUI keeps the account email that backs the SSO `login_hint`. Each is independent and reviewable on its own. **1. Store the email after a GUI SSO login** The daemon returns the authenticated user's email from `WaitSSOLogin` but cannot persist it: it runs as root while the per-profile state file is user-owned. The CLI's `handleSSOLogin` writes it after its own `WaitSSOLogin`; the GUI path read the value and dropped it. The profile was therefore left with no email, so `Profiles.List` showed no account for it, and later logins and session extends went out with no `login_hint` — leaving the IdP to pick an account instead of reusing the one the profile belongs to. Mirror the CLI and store it, next to the `Logout` path that already clears the same file for the same reason. **2. File the email against the profile the login ran for** `SetActiveProfileState` resolves the target itself, so it writes to whichever profile is active when it is called. A GUI SSO login spans seconds of user interaction in the browser, and the tray stays clickable throughout: switching profiles in that window left the email filed under the profile that happened to be active when the flow returned. The wrong profile then advertised an account it does not own, and offered it as the `login_hint` next time. Adds `SetProfileState(id, state)`, the write-side counterpart of the existing `GetProfileState(id)`, and keeps `SetActiveProfileState` as a wrapper for callers with no particular profile in mind. `Login` now reports the profile it resolved so the frontend can hand it back with the SSO wait, which closes the window. **3. Delete the email when a profile is removed** Removing a profile left its state file behind: the daemon deletes what it owns, but the email file is user-owned and out of reach for a root daemon — the same split that already puts the `Logout` cleanup on the UI side. Beyond the stray file, legacy profiles are keyed by name rather than by a generated ID, so recreating a profile under a removed one's name inherited its email — shown as the account in the profile list and sent as the `login_hint` on the next login. ## Issue ticket number and link ## Stack <!-- branch-stack --> ### Checklist - [x] Is it a bug fix - [ ] Is a typo/documentation fix - [ ] Is a feature enhancement - [ ] It is a refactor - [ ] Created tests that fail without the change (if possible) - [ ] This change does **not** modify the public API, gRPC protocols, functionality behavior, CLI / service flags, or introduce a new feature — **OR** I have discussed it with the NetBird team beforehand (link the issue / Slack thread in the description). See [CONTRIBUTING.md](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTING.md#discuss-changes-with-the-netbird-team-first). > By submitting this pull request, you confirm that you have read and agree to the terms of the [Contributor License Agreement](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT.md). ## Documentation Select exactly one: - [ ] I added/updated documentation for this change - [x] Documentation is **not needed** for this change (explain why) ### Docs PR URL (required if "docs added" is checked) Paste the PR link from https://github.com/netbirdio/docs here: https://github.com/netbirdio/docs/pull/__ <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - SSO login details can now be saved to the specific profile selected during sign-in. - Profile state can be managed independently for different profiles. - **Bug Fixes** - Removing a profile now also cleans up its associated saved state. - Cleanup issues no longer prevent successful profile removal and are handled gracefully. - Existing active-profile behavior remains unchanged. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
106 lines
3.3 KiB
Go
106 lines
3.3 KiB
Go
package profilemanager
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/netbirdio/netbird/util"
|
|
)
|
|
|
|
type ProfileState struct {
|
|
Email string `json:"email"`
|
|
}
|
|
|
|
// GetProfileState reads the per-profile state file keyed by profile ID.
|
|
// The state file lives in the user's config directory. Legacy state files
|
|
// keyed by the old profile name remain readable.
|
|
func (pm *ProfileManager) GetProfileState(id ID) (*ProfileState, error) {
|
|
configDir, err := getConfigDir()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("get config directory: %w", err)
|
|
}
|
|
|
|
if id != defaultProfileName && !IsValidProfileFilenameStem(id) {
|
|
return nil, fmt.Errorf("invalid profile ID: %q", id)
|
|
}
|
|
|
|
stateFile := filepath.Join(configDir, id.String()+".state.json")
|
|
stateFileExists, err := fileExists(stateFile)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to check if profile state file exists: %w", err)
|
|
}
|
|
if !stateFileExists {
|
|
return nil, errors.New("profile state file does not exist")
|
|
}
|
|
|
|
var state ProfileState
|
|
_, err = util.ReadJson(stateFile, &state)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("read profile state: %w", err)
|
|
}
|
|
|
|
return &state, nil
|
|
}
|
|
|
|
// SetProfileState writes the state file of the profile identified by id. Prefer
|
|
// it over SetActiveProfileState whenever the caller knows which profile the data
|
|
// belongs to: an SSO login spans seconds of user interaction, and the active
|
|
// profile can change during it, which would file the account email under
|
|
// whichever profile happened to be active when the flow returned.
|
|
func (pm *ProfileManager) SetProfileState(id ID, state *ProfileState) error {
|
|
configDir, err := getConfigDir()
|
|
if err != nil {
|
|
return fmt.Errorf("get config directory: %w", err)
|
|
}
|
|
|
|
if id == "" {
|
|
return fmt.Errorf("empty profile ID")
|
|
}
|
|
if id != defaultProfileName && !IsValidProfileFilenameStem(id) {
|
|
return fmt.Errorf("invalid profile ID: %q", id)
|
|
}
|
|
|
|
stateFile := filepath.Join(configDir, id.String()+".state.json")
|
|
if err := util.WriteJsonWithRestrictedPermission(context.Background(), stateFile, state); err != nil {
|
|
return fmt.Errorf("write profile state: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// SetActiveProfileState writes the state file of whichever profile is active at
|
|
// call time. Use SetProfileState when the target profile is known.
|
|
func (pm *ProfileManager) SetActiveProfileState(state *ProfileState) error {
|
|
activeProf, err := pm.GetActiveProfile()
|
|
if err != nil {
|
|
if errors.Is(err, ErrNoActiveProfile) {
|
|
return fmt.Errorf("no active profile set: %w", err)
|
|
}
|
|
return fmt.Errorf("get active profile: %w", err)
|
|
}
|
|
|
|
return pm.SetProfileState(activeProf.ID, state)
|
|
}
|
|
|
|
// RemoveProfileState deletes the per-profile state file (which holds the
|
|
// account email used for the SSO login hint and the UI display). Called after
|
|
// a successful logout so a logged-out profile no longer shows a stale account
|
|
// email. The state file only stores the email, so deleting it is equivalent to
|
|
// clearing it; the next SSO login recreates it. A missing file is not an error.
|
|
func (pm *ProfileManager) RemoveProfileState(profileName string) error {
|
|
configDir, err := getConfigDir()
|
|
if err != nil {
|
|
return fmt.Errorf("get config directory: %w", err)
|
|
}
|
|
|
|
stateFile := filepath.Join(configDir, profileName+".state.json")
|
|
if err := os.Remove(stateFile); err != nil && !os.IsNotExist(err) {
|
|
return fmt.Errorf("remove profile state: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|