Skip to content

feat: Better warning for expired API Key #2329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bbernays wants to merge 1 commit into from
Closed

feat: Better warning for expired API Key #2329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions premium/usage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,9 @@ func (u *BatchUpdater) CheckQuota(ctx context.Context) (CheckQuotaResult, error)
return CheckQuotaResult{HasQuota: false}, fmt.Errorf("failed to get usage: %w", err)
}
if usage.StatusCode() != http.StatusOK {
if u.tokenClient.GetTokenType() == auth.APIKey && usage.StatusCode() == http.StatusForbidden {
u.logger.Warn().Msg("API Key may have expired. Please see the CloudQuery Console see the expiration status.")
Copy link
Copy Markdown
Contributor

@hermanschaaf hermanschaaf Nov 19, 2025

Choose a reason for hiding this comment

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

I think you could also get a 403 if it's invalid, so maybe we can say

API Key invalid or may have expired. Please see the CloudQuery Console for details.

Better would be to return a specific message from the API if it has expired, and then telling the user so, but this would already be an improvement

Copy link
Copy Markdown
Contributor Author

@bbernays bbernays Nov 19, 2025

Choose a reason for hiding this comment

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

Agreed, That a server side message would be the best. But this at least gives users an initial troubleshooting step

Copy link
Copy Markdown
Contributor Author

@bbernays bbernays Nov 19, 2025

Choose a reason for hiding this comment

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

I'm also unsure of the security implications of revealing whether the key is valid/invalid/expired. I am not aware of any other APIs that will tell you if the the credentials are valid, but expired

Copy link
Copy Markdown
Contributor Author

@bbernays bbernays Nov 19, 2025

Choose a reason for hiding this comment

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

If the API key is invalid (ie they typed it in wrong or added an extra space) looking at the console doesn't tell them anything

Copy link
Copy Markdown
Contributor

@hermanschaaf hermanschaaf Nov 19, 2025

Choose a reason for hiding this comment

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

I have seen other APIs that will tell you it's expired. I think it's okay, there's nothing an attacker can do with it anyway, and it's 99.9% of the time going to be useful to the legitimate owner to get that message

Copy link
Copy Markdown
Member

@disq disq Nov 19, 2025

Choose a reason for hiding this comment

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

https://github.com/cloudquery/cloud/blob/b830bf0f69a3e070b9ace1556f03e79d30eaf034/cloud/internal/server/middleware/auth.go#L142-L145 (internal link)

Copy link
Copy Markdown
Contributor Author

@bbernays bbernays Nov 19, 2025

Choose a reason for hiding this comment

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

So it seems like we already have a custom error message for expired tokens https://github.com/cloudquery/cloud/blob/b830bf0f69a3e070b9ace1556f03e79d30eaf034/platform/internal/response/response.go#L129C1-L130C1

Copy link
Copy Markdown
Member

@erezrokah erezrokah Nov 25, 2025

Choose a reason for hiding this comment

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

What's left to do here? Do we print the correct message or not?

}
return CheckQuotaResult{HasQuota: false}, fmt.Errorf("failed to get usage: %s", usage.Status())
}

Expand Down
Loading