feat: introducing the auth package (removing bascule, spf13 and jwt dependency)
#273
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
denopink
added
the
enhancement
denopink
commented
Jan 9, 2025
auth/acquire.go
Outdated
Comment on lines
4
to
10
| package auth | ||
|
|
||
| // Acquirer acquires the credential for http request authorization headers. | ||
| type Acquirer interface { | ||
| // Acquire gets a credential string. | ||
| Acquire() (string, error) | ||
| } |
There was a problem hiding this comment.
replaces bascule.Acquirer
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #273 +/- ##
==========================================
+ Coverage 82.58% 83.29% +0.70%
==========================================
Files 18 19 +1
Lines 890 808 -82
==========================================
- Hits 735 673 -62
+ Misses 130 117 -13
+ Partials 25 18 -7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
denopink
commented
Jan 9, 2025
Comment on lines
+8
to
+10
| type PartnerIDsKey struct{} | ||
|
|
||
| type PrincipalKey struct{} |
There was a problem hiding this comment.
get partnerIDs and Principal instead of relying on bascule
denopink
commented
Jan 9, 2025
Comment on lines
-126
to
-170
| func extractPartnerIDs(config transportConfig, c context.Context, r *http.Request) ([]string, error) { | ||
| auth, present := bascule.FromContext(c) | ||
| if !present { | ||
| return nil, errAuthNotPresent | ||
| } | ||
| if auth.Token == nil { | ||
| return nil, errAuthTokenIsNil | ||
| } | ||
|
|
||
| var partners []string | ||
|
|
||
| switch auth.Token.Type() { | ||
| case basicstr: | ||
| authHeader := r.Header[config.basicPartnerIDsHeader] | ||
| for _, value := range authHeader { | ||
| fields := strings.Split(value, ",") | ||
| for i := 0; i < len(fields); i++ { | ||
| fields[i] = strings.TrimSpace(fields[i]) | ||
| } | ||
| partners = append(partners, fields...) | ||
| } | ||
| return partners, nil | ||
| case jwtstr: | ||
| authToken := auth.Token | ||
| partnersInterface, attrExist := bascule.GetNestedAttribute(authToken.Attributes(), basculechecks.PartnerKeys()...) | ||
| if !attrExist { | ||
| return nil, errPartnerIDsDoNotExist | ||
| } | ||
| vals, err := cast.ToStringSliceE(partnersInterface) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("%w: %v", errGettingPartnerIDs, err) | ||
| } | ||
| partners = vals | ||
| return partners, nil | ||
| } | ||
| return nil, errAuthIsNotOfTypeBasicOrJWT | ||
| } | ||
|
|
||
| func encodeAddWebhookResponse(ctx context.Context, rw http.ResponseWriter, _ interface{}) error { | ||
| rw.Header().Set(contentTypeHeader, jsonContentType) | ||
| rw.Write([]byte(`{"message": "Success"}`)) | ||
| return nil | ||
| } | ||
|
|
||
| func getOwner(ctx context.Context) string { |
There was a problem hiding this comment.
getting principal and partner ids via context instead of using bascule
denopink
changed the title
auth.Acquirer interfaceauth package (removing bascule and jwt dependency)
denopink
force-pushed
the
denopink/feat/auth-interface
branch
2 times, most recently
from
cfaf49c to
acc3c87
Compare
denopink
changed the title
auth package (removing bascule and jwt dependency) auth package (removing bascule and jwt dependency)
denopink
commented
Jan 9, 2025
Comment on lines
12
to
19
| "io" | ||
| "net/http" | ||
|
|
||
| "github.com/xmidt-org/ancla/auth" | ||
| "github.com/xmidt-org/ancla/model" | ||
| "github.com/xmidt-org/bascule/acquire" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
There was a problem hiding this comment.
replace bascule acquire with ancla's auth.Acquirer
denopink
commented
Jan 9, 2025
| } | ||
| return &acquire.DefaultAcquirer{}, nil | ||
| } | ||
|
|
There was a problem hiding this comment.
required for bascule, no longer needed
denopink
commented
Jan 9, 2025
| cfg.BasicClientConfig.Auth.JWT.GetExpiration = p.expiration | ||
| return nil | ||
| } | ||
|
|
There was a problem hiding this comment.
required by bascule, no longer needed
denopink
changed the title
auth package (removing bascule and jwt dependency)auth package (removing bascule, spf13 and jwt dependency)
denopink
force-pushed
the
denopink/feat/auth-interface
branch
from
acc3c87 to
f8c742d
Compare
… dependency) - removed bascule, spf13 and jwt dependency (and related code) by introducing the `auth` package - ancla will rely on the `auth.Acquirer` interface for cred renewal instead of using bascule - ancla will receive cred principal and partner IDs via context instead of using bascule
denopink
force-pushed
the
denopink/feat/auth-interface
branch
from
f8c742d to
cc9b408
Compare
schmidtw
reviewed
Jan 13, 2025
schmidtw
approved these changes
Jan 13, 2025
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.
authpackageauth.Acquirerinterface for cred renewal instead of using bascule