Skip to content

feat: Better warning for expired API Key#2329

Closed
bbernays wants to merge 1 commit intomainfrom
better-error-for-expired-token
Closed

feat: Better warning for expired API Key#2329
bbernays wants to merge 1 commit intomainfrom
better-error-for-expired-token

Conversation

@bbernays
Copy link
Copy Markdown
Contributor

Summary


Use the following steps to ensure your PR is ready to be reviewed

  • Read the contribution guidelines 🧑‍🎓
  • Run go fmt to format your code 🖊
  • Lint your changes via golangci-lint run 🚨 (install golangci-lint here)
  • Update or add tests 🧪
  • Ensure the status checks below are successful ✅

@bbernays bbernays requested a review from a team as a code owner November 19, 2025 15:41
Comment thread premium/usage.go
}
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

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

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

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

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

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

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

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?

@erezrokah
Copy link
Copy Markdown
Member

Closing as stale. Please re-open if needed

@erezrokah erezrokah closed this Dec 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants