feat: Auto-refresh github token #3185
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bryanhuhta
commented
Apr 15, 2024
Comment on lines
-19
to
-43
| var ( | ||
| GithubAppClientID = os.Getenv("GITHUB_CLIENT_ID") | ||
| githubAppClientSecret = os.Getenv("GITHUB_CLIENT_SECRET") | ||
| githubSessionSecret = []byte(os.Getenv("GITHUB_SESSION_SECRET")) | ||
| ) | ||
|
|
||
| const ( | ||
| gitHubCookieName = "GitSession" | ||
| ) | ||
|
|
||
| // githubOAuth returns a github oauth2 config. | ||
| // Returns an error if the environment variables are not set. | ||
| func githubOAuth() (*oauth2.Config, error) { | ||
| if GithubAppClientID == "" { | ||
| return nil, errors.New("missing GITHUB_CLIENT_ID environment variable") | ||
| } | ||
| if githubAppClientSecret == "" { | ||
| return nil, errors.New("missing GITHUB_CLIENT_SECRET environment variable") | ||
| } | ||
| return &oauth2.Config{ | ||
| ClientID: GithubAppClientID, | ||
| ClientSecret: githubAppClientSecret, | ||
| Endpoint: o2endpoints.GitHub, | ||
| }, nil | ||
| } |
There was a problem hiding this comment.
A lot of this OAuth stuff got abstracted to token.go
Comment on lines
+43
to
+44
| q.logger.Log("err", err, "msg", "failed to get GitHub OAuth config") | ||
| return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("failed to authorize with GitHub")) |
There was a problem hiding this comment.
This pattern of "log the real error, return a generic message" is so we don't accidentally leak anything sensitive to the UI. While errors won't include tokens or any really sensitive info, better to be on the safe side with what we send back to the client.
Comment on lines
+97
to
+100
| err = rejectExpiredToken(token) | ||
| if err != nil { | ||
| return nil, err | ||
| } |
There was a problem hiding this comment.
We can check if the token is expired without having to talk to GitHub.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related: https://github.com/grafana/pyroscope-squad/issues/129
related: https://github.com/grafana/pyroscope-app-plugin/pull/392
When we go through the OAuth login flow with GitHub, GitHub sends us a use token and a refresh token. The user token expires in 8 hours and the refresh token expires in 6 months. Both tokens are encrypted into cookie the
GitHubLoginendpoint send back to the UI.This PR introduces mechanisms for the UI to request a new user token. To do so, I created a new endpoint
/vcs.v1.VCSService/GithubRefreshwhich will use the refresh token to get a new user token.