- Notifications
You must be signed in to change notification settings - Fork1k
chore: instrument external oauth2 requests#11519
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
20 commits Select commitHold shift + click to select a range
b7f13fa chore: instrument external oauth2 requests
Emyrkfd1e012 Add a unit test
Emyrka6de1e3 remove internet based request
Emyrk005883a use ctx
Emyrk2f77f99 typo
Emyrk3377a9b Work on instrumenting related oauth2 calls
Emyrk07fd10d remove print
Emyrk117a405 typos
Emyrk73abae6 Fixup some unit tests
Emyrke5e190d fixup test cases
Emyrkd4b36d3 remove oidc instrument
Emyrk8964297 typos
Emyrk2ba7a5c more test coverage
Emyrk8963aaa left debug
Emyrkbfa427f Add comments
Emyrk9d1c76c use consts for source labels
Emyrkc149f8f Spell out config
Emyrk30c459f fix compile
Emyrkcd98806 Use req with context
Emyrk85e2d91 no panic
EmyrkFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
10 changes: 5 additions & 5 deletionscli/create_test.go
This file contains hidden or 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
24 changes: 18 additions & 6 deletionscli/server.go
This file contains hidden or 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
52 changes: 48 additions & 4 deletionscoderd/coderdtest/oidctest/idp.go
This file contains hidden or 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
57 changes: 30 additions & 27 deletionscoderd/externalauth/externalauth.go
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -22,19 +22,14 @@ import ( | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/database/dbtime" | ||
| "github.com/coder/coder/v2/coderd/httpapi" | ||
| "github.com/coder/coder/v2/coderd/promoauth" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/retry" | ||
| ) | ||
| // Config is used for authentication for Git operations. | ||
| type Config struct { | ||
| promoauth.InstrumentedOAuth2Config | ||
| // ID is a unique identifier for the authenticator. | ||
| ID string | ||
| // Type is the type of provider. | ||
| @@ -192,12 +187,8 @@ func (c *Config) ValidateToken(ctx context.Context, token string) (bool, *coders | ||
| return false, nil, err | ||
| } | ||
| req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", token)) | ||
| res, err :=c.InstrumentedOAuth2Config.Do(ctx, promoauth.SourceValidateToken,req) | ||
| if err != nil { | ||
| return false, nil, err | ||
| } | ||
| @@ -247,7 +238,7 @@ func (c *Config) AppInstallations(ctx context.Context, token string) ([]codersdk | ||
| return nil, false, err | ||
| } | ||
| req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", token)) | ||
| res, err :=c.InstrumentedOAuth2Config.Do(ctx, promoauth.SourceAppInstallations,req) | ||
| if err != nil { | ||
| return nil, false, err | ||
| } | ||
| @@ -287,6 +278,8 @@ func (c *Config) AppInstallations(ctx context.Context, token string) ([]codersdk | ||
| } | ||
| type DeviceAuth struct { | ||
| // Config is provided for the http client method. | ||
| Config promoauth.InstrumentedOAuth2Config | ||
| ClientID string | ||
| TokenURL string | ||
| Scopes []string | ||
| @@ -307,8 +300,17 @@ func (c *DeviceAuth) AuthorizeDevice(ctx context.Context) (*codersdk.ExternalAut | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| do := http.DefaultClient.Do | ||
| if c.Config != nil { | ||
| // The cfg can be nil in unit tests. | ||
| do = func(req *http.Request) (*http.Response, error) { | ||
| return c.Config.Do(ctx, promoauth.SourceAuthorizeDevice, req) | ||
| } | ||
| } | ||
| resp, err := do(req) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Noticed we never check HTTP status code for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I am not sure, I did not write this part. Have not checked the payloads myself here. | ||
| req.Header.Set("Accept", "application/json") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| @@ -401,7 +403,7 @@ func (c *DeviceAuth) formatDeviceCodeURL() (string, error) { | ||
| // ConvertConfig converts the SDK configuration entry format | ||
| // to the parsed and ready-to-consume in coderd provider type. | ||
| func ConvertConfig(instrument *promoauth.Factory,entries []codersdk.ExternalAuthConfig, accessURL *url.URL) ([]*Config, error) { | ||
| ids := map[string]struct{}{} | ||
| configs := []*Config{} | ||
| for _, entry := range entries { | ||
| @@ -453,7 +455,7 @@ func ConvertConfig(entries []codersdk.ExternalAuthConfig, accessURL *url.URL) ([ | ||
| Scopes: entry.Scopes, | ||
| } | ||
| var oauthConfigpromoauth.OAuth2Config = oc | ||
| // Azure DevOps uses JWT token authentication! | ||
| if entry.Type == string(codersdk.EnhancedExternalAuthProviderAzureDevops) { | ||
| oauthConfig = &jwtConfig{oc} | ||
| @@ -463,24 +465,25 @@ func ConvertConfig(entries []codersdk.ExternalAuthConfig, accessURL *url.URL) ([ | ||
| } | ||
| cfg := &Config{ | ||
| InstrumentedOAuth2Config: instrument.New(entry.ID,oauthConfig), | ||
| ID:entry.ID, | ||
| Regex:regex, | ||
| Type:entry.Type, | ||
| NoRefresh:entry.NoRefresh, | ||
| ValidateURL:entry.ValidateURL, | ||
| AppInstallationsURL:entry.AppInstallationsURL, | ||
| AppInstallURL:entry.AppInstallURL, | ||
| DisplayName:entry.DisplayName, | ||
| DisplayIcon:entry.DisplayIcon, | ||
| ExtraTokenKeys:entry.ExtraTokenKeys, | ||
| } | ||
| if entry.DeviceFlow { | ||
| if entry.DeviceCodeURL == "" { | ||
| return nil, xerrors.Errorf("external auth provider %q: device auth url must be provided", entry.ID) | ||
| } | ||
| cfg.DeviceAuth = &DeviceAuth{ | ||
| Config: cfg, | ||
| ClientID: entry.ClientID, | ||
| TokenURL: oc.Endpoint.TokenURL, | ||
| Scopes: entry.Scopes, | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.