feat(organizations): supports bearer token #869
+572
−46
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
github-actions
bot
added
feature
core-apis
helm-charts
documentation
gciezkowski-acc
changed the title
gciezkowski-acc
changed the title
gciezkowski-acc
force-pushed
the
feat/805_orgranization_supports_bearer_token
branch
from
c52776b to
eddbbb0
Compare
gciezkowski-acc
requested review from
IvoGoman,
uwe-mayer and
abhijith-darshan
abhijith-darshan
requested changes
Feb 6, 2025
Comment on lines
260
to
294
| var authType *scim.AuthType | ||
| var basicAuthUser, basicAuthPw, bearerToken string | ||
| var err error | ||
| if scimConfig.BasicAuthUser.Secret != nil && scimConfig.BasicAuthPw.Secret != nil { // Conditions to avoid panic | ||
| basicAuthUser, err = clientutil.GetSecretKeyFromSecretKeyReference(ctx, r.Client, namespace, *scimConfig.BasicAuthUser.Secret) | ||
| if err != nil { | ||
| return greenhousesapv1alpha1.FalseCondition(greenhousesapv1alpha1.SCIMAPIAvailableCondition, greenhousesapv1alpha1.SecretNotFoundReason, "BasicAuthUser missing") | ||
| } | ||
| basicAuthPw, err = clientutil.GetSecretKeyFromSecretKeyReference(ctx, r.Client, namespace, *scimConfig.BasicAuthPw.Secret) | ||
| if err != nil { | ||
| return greenhousesapv1alpha1.FalseCondition(greenhousesapv1alpha1.SCIMAPIAvailableCondition, greenhousesapv1alpha1.SecretNotFoundReason, "BasicAuthPw missing") | ||
| } | ||
| newAuthType := scim.Basic | ||
| authType = &newAuthType | ||
| } | ||
| basicAuthPw, err := clientutil.GetSecretKeyFromSecretKeyReference(ctx, r.Client, namespace, *scimConfig.BasicAuthPw.Secret) | ||
| if err != nil { | ||
| return greenhousesapv1alpha1.FalseCondition(greenhousesapv1alpha1.SCIMAPIAvailableCondition, greenhousesapv1alpha1.SecretNotFoundReason, "BasicAuthPw missing") | ||
| if scimConfig.BearerToken.Secret != nil { | ||
| bearerToken, err = clientutil.GetSecretKeyFromSecretKeyReference(ctx, r.Client, namespace, *scimConfig.BearerToken.Secret) | ||
| if err != nil { | ||
| return greenhousesapv1alpha1.FalseCondition(greenhousesapv1alpha1.SCIMAPIAvailableCondition, greenhousesapv1alpha1.SecretNotFoundReason, "BearerToken missing") | ||
| } | ||
| newAuthType := scim.BearerToken | ||
| authType = &newAuthType | ||
| } | ||
| if authType == nil { | ||
| return greenhousesapv1alpha1.FalseCondition(greenhousesapv1alpha1.SCIMAPIAvailableCondition, greenhousesapv1alpha1.SCIMConfigNotProvidedReason, "SCIM config is not provided") |
There was a problem hiding this comment.
We need to avoid this. The auth type must come from spec and should not be guessed. This way we can switch case between multiple auth types and plus you won't need any validating webhooks.
In order to not break our apis you can do for example in organization_types -
type SCIMConfig struct {
// URL to the SCIM server.
BaseURL string `json:"baseURL"`
// AuthType is the type of authentication to be used.
// +kubebuilder:validation:Enum=basic;token
// +kubebuilder:default="basic"
AuthType string `json:"authType,omitempty"` // You can also make the string as type ScimAuthType string
// User to be used for basic authentication.
BasicAuthUser ValueFromSource `json:"basicAuthUser,omitempty"`
// Password to be used for basic authentication.
BasicAuthPw ValueFromSource `json:"basicAuthPw,omitempty"`
.....
}now you can switch case the authType and error out if the secrets for a particular auth type is not found. For our existing resources in the cluster they will all get basic by default since we supported only basic auth.
pkg/scim/scim_client.go
Outdated
Comment on lines
62
to
84
| func (t *bearerTokenTransport) RoundTrip(req *http.Request) (*http.Response, error) { | ||
| req.Header.Set("Authorization", "Bearer "+t.Token) | ||
| return t.Next.RoundTrip(req) | ||
| } | ||
|
|
There was a problem hiding this comment.
It would be better if we extended the transport to include customizable header + prefix as some providers might have custom auth headers - example -
if t.Header == "" {
t.Header = "Authorization"
}
if t.Prefix == "" {
t.Prefix = "Bearer"
}
req.Header.Set(t.Header, fmt.Sprintf("%s %s", t.Prefix, t.Token))
return t.Next.RoundTrip(req)This way if no custom headers or prefix is not provided then we do a default fallback to Authorization: Bearer ey.....
gciezkowski-acc
force-pushed
the
feat/805_orgranization_supports_bearer_token
branch
from
eddbbb0 to
b4115b6
Compare
gciezkowski-acc
force-pushed
the
feat/805_orgranization_supports_bearer_token
branch
from
9942ca4 to
a69ba14
Compare
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.
Description
What type of PR is this? (check all applicable)
Related Tickets & Documents
Added tests?
I wrote new unit tests for organization webhook.
Added to documentation?
Checklist