Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions internal/pkg/auth/service_account.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,27 @@ func AuthenticateServiceAccount(p *print.Printer, rt http.RoundTripper, disableW
authFields[IDP_TOKEN_ENDPOINT] = ""

if !disableWriting {
// Clean up user credentials to avoid stale fields
if err = DeleteAuthField(USER_EMAIL); err != nil {
p.Debug(print.ErrorLevel, "failed to delete auth field %s: %v", USER_EMAIL, err)
}

if err = DeleteAuthField(REFRESH_TOKEN); err != nil {
p.Debug(print.ErrorLevel, "failed to delete auth field %s: &v", USER_EMAIL, err)
}

if err = DeleteAuthField(SERVICE_ACCOUNT_TOKEN); err != nil {
p.Debug(print.ErrorLevel, "failed to delete auth field %s: &v", REFRESH_TOKEN, err)
}

if err = DeleteAuthField(SERVICE_ACCOUNT_KEY); err != nil {
p.Debug(print.ErrorLevel, "failed to delete auth field %s: &v", SERVICE_ACCOUNT_TOKEN, err)
}

if err = DeleteAuthField(PRIVATE_KEY); err != nil {
p.Debug(print.ErrorLevel, "failed to delete auth field %s: &v", SERVICE_ACCOUNT_KEY, err)
}

err = SetAuthFlow(authFlowType)
if err != nil {
return "", "", fmt.Errorf("set auth flow type: %w", err)
Expand Down
85 changes: 67 additions & 18 deletions internal/pkg/auth/storage.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,12 @@ func setAuthFieldWithProfile(profile string, key authFieldKey, value string) err
if errFallback != nil {
return fmt.Errorf("write to keyring failed (%w), try writing to encoded text file: %w", err, errFallback)
}
// If writing to the text file succeeded as a fallback, clean up any stale key in the keyring
// so GetAuthField won't return outdated credentials.
_ = deleteAuthFieldInKeyring(profile, key)
} else {
// If writing to the keyring succeeded, clean up any old entry from the encoded text file.
_ = deleteAuthFieldInEncodedTextFile(profile, key)
Comment on lines +111 to +114

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why isn't error handling necessary here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It just tries to remove stale keys. If the deletion for the keyring fails, it means that there was no key before. For the deletion in the encoded text files it can have multiple issues, mostly permission issues or a broken file. If we would have a logger here, we could do log the here, but I wouldn't return an error when something in deleteAuthFieldInEncodedTextFile failed while the actual setting of auth fields in the keyring was successful

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checked the library: it'll return keyring.ErrNotFound when not found. I'd add a conditional and report the other errors to the user.

}

return nil
Expand All @@ -130,31 +136,34 @@ func DeleteAuthField(key authFieldKey) error {
}

func deleteAuthFieldWithProfile(profile string, key authFieldKey) error {
var errKeyring, errFile error

err := deleteAuthFieldInKeyring(profile, key)
if err != nil && !errors.Is(err, keyring.ErrNotFound) {
errKeyring = err
}

err = deleteAuthFieldInEncodedTextFile(profile, key)
if err != nil {
// if the key is not found, we can ignore the error
if !errors.Is(err, keyring.ErrNotFound) {
errFallback := deleteAuthFieldInEncodedTextFile(profile, key)
if errFallback != nil {
return fmt.Errorf("delete from keyring failed (%w), try deleting from encoded text file: %w", err, errFallback)
}
}
errFile = err
}

if errKeyring != nil && errFile != nil {
return fmt.Errorf("delete from keyring: %w, delete from encoded text file: %w", errKeyring, errFile)
}

return nil
}

func deleteAuthFieldInEncodedTextFile(activeProfile string, key authFieldKey) error {
err := createEncodedTextFile(activeProfile)
if err != nil {
return err
}

textFileDir := config.GetProfileFolderPath(activeProfile)
textFilePath := filepath.Join(textFileDir, textFileName)

contentEncoded, err := os.ReadFile(textFilePath)
if err != nil {
if os.IsNotExist(err) {
return nil
}
return fmt.Errorf("read file: %w", err)
}

Expand All @@ -170,8 +179,21 @@ func deleteAuthFieldInEncodedTextFile(activeProfile string, key authFieldKey) er
return fmt.Errorf("unmarshal file: %w", err)
}

if _, ok := content[key]; !ok {
return nil
}

delete(content, key)

if len(content) == 0 {
err = os.Remove(textFilePath)
if err != nil && !os.IsNotExist(err) {
return fmt.Errorf("remove empty encoded text file: %w", err)
}

return nil
}

contentBytes, err = json.Marshal(content)
if err != nil {
return fmt.Errorf("marshal file: %w", err)
Expand Down Expand Up @@ -291,11 +313,6 @@ func getAuthFieldFromKeyring(activeProfile string, key authFieldKey) (string, er
}

func getAuthFieldFromEncodedTextFile(activeProfile string, key authFieldKey) (string, error) {
err := createEncodedTextFile(activeProfile)
if err != nil {
return "", err
}

textFileDir := config.GetProfileFolderPath(activeProfile)
textFilePath := filepath.Join(textFileDir, textFileName)

Expand Down Expand Up @@ -403,6 +420,17 @@ func GetAuthEmail() (string, error) {
}

func LoginUser(email, accessToken, refreshToken, sessionExpiresAtUnix string) error {
// Clean up any service account credentials that might be present
saFields := []authFieldKey{
SERVICE_ACCOUNT_KEY,
PRIVATE_KEY,
SERVICE_ACCOUNT_TOKEN,
SERVICE_ACCOUNT_EMAIL,
}
for _, key := range saFields {
_ = DeleteAuthField(key)
}

authFields := map[authFieldKey]string{
SESSION_EXPIRES_AT_UNIX: sessionExpiresAtUnix,
ACCESS_TOKEN: accessToken,
Expand All @@ -419,13 +447,26 @@ func LoginUser(email, accessToken, refreshToken, sessionExpiresAtUnix string) er
}

func LogoutUser() error {
for _, key := range loginAuthFieldKeys {
for _, key := range authFieldKeys {
err := DeleteAuthField(key)
if err != nil {
return fmt.Errorf("delete auth field \"%s\": %w", key, err)
}
}

activeProfile, err := config.GetProfile()
if err != nil {
return fmt.Errorf("get profile: %w", err)
}

textFileDir := config.GetProfileFolderPath(activeProfile)
textFilePath := filepath.Join(textFileDir, textFileName)

err = os.Remove(textFilePath)
if err != nil && !os.IsNotExist(err) {
return fmt.Errorf("remove auth storage file: %w", err)
}

return nil
}

Expand All @@ -446,5 +487,13 @@ func DeleteProfileAuth(profile string) error {
}
}

textFileDir := config.GetProfileFolderPath(profile)
textFilePath := filepath.Join(textFileDir, textFileName)

err = os.Remove(textFilePath)
if err != nil && !os.IsNotExist(err) {
return fmt.Errorf("remove auth storage file: %w", err)
}

return nil
}
Loading
Loading