Merge branch 'main' of github.com:vmware-tanzu/pinniped into active-directory-identity-provider
This commit is contained in:
commit
c590c8ff41
@ -47,7 +47,6 @@ linters:
|
|||||||
- scopelint
|
- scopelint
|
||||||
- sqlclosecheck
|
- sqlclosecheck
|
||||||
- unconvert
|
- unconvert
|
||||||
- unparam
|
|
||||||
- whitespace
|
- whitespace
|
||||||
|
|
||||||
issues:
|
issues:
|
||||||
|
@ -36,8 +36,6 @@ The following table includes the current roadmap for Pinniped. If you have any q
|
|||||||
Last Updated: July 2021
|
Last Updated: July 2021
|
||||||
Theme|Description|Timeline|
|
Theme|Description|Timeline|
|
||||||
|--|--|--|
|
|--|--|--|
|
||||||
|Remote OIDC login support|Add support for logging in from remote hosts without web browsers in the Pinniped CLI and Supervisor|Jul 2021|
|
|
||||||
|Non-Interactive Password based LDAP logins |Support for non-interactive LDAP Logins via CLI using Environmental Variables |Jul 2021|
|
|
||||||
|Non-Interactive Password based OIDC logins |Support for non-interactive OIDC Logins via CLI using Password Grant |Aug 2021|
|
|Non-Interactive Password based OIDC logins |Support for non-interactive OIDC Logins via CLI using Password Grant |Aug 2021|
|
||||||
|Active Directory Support|Extends upstream IDP protocols|Aug 2021|
|
|Active Directory Support|Extends upstream IDP protocols|Aug 2021|
|
||||||
|Multiple IDP support|Support multiple IDPs configured on a single Supervisor|Sept 2021|
|
|Multiple IDP support|Support multiple IDPs configured on a single Supervisor|Sept 2021|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
package v1alpha1
|
package v1alpha1
|
||||||
@ -39,9 +39,31 @@ type OIDCIdentityProviderStatus struct {
|
|||||||
// request parameters.
|
// request parameters.
|
||||||
type OIDCAuthorizationConfig struct {
|
type OIDCAuthorizationConfig struct {
|
||||||
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
||||||
// request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
// request flow with an OIDC identity provider.
|
||||||
|
// In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes
|
||||||
|
// in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field).
|
||||||
|
// By default, only the "openid" scope will be requested.
|
||||||
// +optional
|
// +optional
|
||||||
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
||||||
|
|
||||||
|
// AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant
|
||||||
|
// (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a
|
||||||
|
// username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow.
|
||||||
|
// The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be
|
||||||
|
// supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password
|
||||||
|
// Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose
|
||||||
|
// to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the
|
||||||
|
// cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be
|
||||||
|
// convenient for users, especially for identities from your OIDC provider which are not intended to represent a human
|
||||||
|
// actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
// you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this
|
||||||
|
// OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password
|
||||||
|
// Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords
|
||||||
|
// (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other
|
||||||
|
// web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins.
|
||||||
|
// AllowPasswordGrant defaults to false.
|
||||||
|
// +optional
|
||||||
|
AllowPasswordGrant bool `json:"allowPasswordGrant,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// OIDCClaims provides a mapping from upstream claims into identities.
|
// OIDCClaims provides a mapping from upstream claims into identities.
|
||||||
|
@ -0,0 +1,66 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package v1alpha1
|
||||||
|
|
||||||
|
// IDPType are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// as the "type" of each returned identity provider.
|
||||||
|
type IDPType string
|
||||||
|
|
||||||
|
// IDPFlow are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// in the array of allowed client "flows" for each returned identity provider.
|
||||||
|
type IDPFlow string
|
||||||
|
|
||||||
|
const (
|
||||||
|
IDPTypeOIDC IDPType = "oidc"
|
||||||
|
IDPTypeLDAP IDPType = "ldap"
|
||||||
|
IDPTypeActiveDirectory IDPType = "activedirectory"
|
||||||
|
|
||||||
|
IDPFlowCLIPassword IDPFlow = "cli_password"
|
||||||
|
IDPFlowBrowserAuthcode IDPFlow = "browser_authcode"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPType to a string.
|
||||||
|
func (r IDPType) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPType to a string.
|
||||||
|
func (r IDPType) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponse is part of the response from a FederationDomain's OpenID Provider Configuration
|
||||||
|
// Document returned by the .well-known/openid-configuration endpoint. It ignores all the standard OpenID Provider
|
||||||
|
// configuration metadata and only picks out the portion related to Supervisor identity provider discovery.
|
||||||
|
type OIDCDiscoveryResponse struct {
|
||||||
|
SupervisorDiscovery OIDCDiscoveryResponseIDPEndpoint `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponseIDPEndpoint contains the URL for the identity provider discovery endpoint.
|
||||||
|
type OIDCDiscoveryResponseIDPEndpoint struct {
|
||||||
|
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IDPDiscoveryResponse is the response of a FederationDomain's identity provider discovery endpoint.
|
||||||
|
type IDPDiscoveryResponse struct {
|
||||||
|
PinnipedIDPs []PinnipedIDP `json:"pinniped_identity_providers"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinnipedIDP describes a single identity provider as included in the response of a FederationDomain's
|
||||||
|
// identity provider discovery endpoint.
|
||||||
|
type PinnipedIDP struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type IDPType `json:"type"`
|
||||||
|
Flows []IDPFlow `json:"flows,omitempty"`
|
||||||
|
}
|
25
apis/supervisor/oidc/types_supervisor_oidc.go.tmpl
Normal file
25
apis/supervisor/oidc/types_supervisor_oidc.go.tmpl
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package oidc
|
||||||
|
|
||||||
|
// Constants related to the Supervisor FederationDomain's authorization and token endpoints.
|
||||||
|
const (
|
||||||
|
// AuthorizeUsernameHeaderName is the name of the HTTP header which can be used to transmit a username
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizeUsernameHeaderName = "Pinniped-Username"
|
||||||
|
|
||||||
|
// AuthorizePasswordHeaderName is the name of the HTTP header which can be used to transmit a password
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizePasswordHeaderName = "Pinniped-Password" //nolint:gosec // this is not a credential
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPNameParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the name of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPNameParamName = "pinniped_idp_name"
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPTypeParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the type of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPTypeParamName = "pinniped_idp_type"
|
||||||
|
)
|
@ -32,6 +32,7 @@ import (
|
|||||||
|
|
||||||
conciergev1alpha1 "go.pinniped.dev/generated/latest/apis/concierge/authentication/v1alpha1"
|
conciergev1alpha1 "go.pinniped.dev/generated/latest/apis/concierge/authentication/v1alpha1"
|
||||||
configv1alpha1 "go.pinniped.dev/generated/latest/apis/concierge/config/v1alpha1"
|
configv1alpha1 "go.pinniped.dev/generated/latest/apis/concierge/config/v1alpha1"
|
||||||
|
idpdiscoveryv1alpha1 "go.pinniped.dev/generated/latest/apis/supervisor/idpdiscovery/v1alpha1"
|
||||||
conciergeclientset "go.pinniped.dev/generated/latest/client/concierge/clientset/versioned"
|
conciergeclientset "go.pinniped.dev/generated/latest/client/concierge/clientset/versioned"
|
||||||
"go.pinniped.dev/internal/groupsuffix"
|
"go.pinniped.dev/internal/groupsuffix"
|
||||||
)
|
)
|
||||||
@ -68,6 +69,7 @@ type getKubeconfigOIDCParams struct {
|
|||||||
requestAudience string
|
requestAudience string
|
||||||
upstreamIDPName string
|
upstreamIDPName string
|
||||||
upstreamIDPType string
|
upstreamIDPType string
|
||||||
|
upstreamIDPFlow string
|
||||||
}
|
}
|
||||||
|
|
||||||
type getKubeconfigConciergeParams struct {
|
type getKubeconfigConciergeParams struct {
|
||||||
@ -97,23 +99,6 @@ type getKubeconfigParams struct {
|
|||||||
credentialCachePathSet bool
|
credentialCachePathSet bool
|
||||||
}
|
}
|
||||||
|
|
||||||
type supervisorOIDCDiscoveryResponseWithV1Alpha1 struct {
|
|
||||||
SupervisorDiscovery SupervisorDiscoveryResponseV1Alpha1 `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type SupervisorDiscoveryResponseV1Alpha1 struct {
|
|
||||||
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type supervisorIDPsDiscoveryResponseV1Alpha1 struct {
|
|
||||||
PinnipedIDPs []pinnipedIDPResponse `json:"pinniped_identity_providers"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type pinnipedIDPResponse struct {
|
|
||||||
Name string `json:"name"`
|
|
||||||
Type string `json:"type"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func kubeconfigCommand(deps kubeconfigDeps) *cobra.Command {
|
func kubeconfigCommand(deps kubeconfigDeps) *cobra.Command {
|
||||||
var (
|
var (
|
||||||
cmd = &cobra.Command{
|
cmd = &cobra.Command{
|
||||||
@ -153,7 +138,8 @@ func kubeconfigCommand(deps kubeconfigDeps) *cobra.Command {
|
|||||||
f.BoolVar(&flags.oidc.debugSessionCache, "oidc-debug-session-cache", false, "Print debug logs related to the OpenID Connect session cache")
|
f.BoolVar(&flags.oidc.debugSessionCache, "oidc-debug-session-cache", false, "Print debug logs related to the OpenID Connect session cache")
|
||||||
f.StringVar(&flags.oidc.requestAudience, "oidc-request-audience", "", "Request a token with an alternate audience using RFC8693 token exchange")
|
f.StringVar(&flags.oidc.requestAudience, "oidc-request-audience", "", "Request a token with an alternate audience using RFC8693 token exchange")
|
||||||
f.StringVar(&flags.oidc.upstreamIDPName, "upstream-identity-provider-name", "", "The name of the upstream identity provider used during login with a Supervisor")
|
f.StringVar(&flags.oidc.upstreamIDPName, "upstream-identity-provider-name", "", "The name of the upstream identity provider used during login with a Supervisor")
|
||||||
f.StringVar(&flags.oidc.upstreamIDPType, "upstream-identity-provider-type", "", "The type of the upstream identity provider used during login with a Supervisor (e.g. 'oidc', 'ldap', 'activedirectory')")
|
f.StringVar(&flags.oidc.upstreamIDPType, "upstream-identity-provider-type", "", fmt.Sprintf("The type of the upstream identity provider used during login with a Supervisor (e.g. '%s', '%s', '%s')", idpdiscoveryv1alpha1.IDPTypeOIDC, idpdiscoveryv1alpha1.IDPTypeLDAP, idpdiscoveryv1alpha1.IDPTypeActiveDirectory))
|
||||||
|
f.StringVar(&flags.oidc.upstreamIDPFlow, "upstream-identity-provider-flow", "", fmt.Sprintf("The type of client flow to use with the upstream identity provider during login with a Supervisor (e.g. '%s', '%s')", idpdiscoveryv1alpha1.IDPFlowCLIPassword, idpdiscoveryv1alpha1.IDPFlowBrowserAuthcode))
|
||||||
f.StringVar(&flags.kubeconfigPath, "kubeconfig", os.Getenv("KUBECONFIG"), "Path to kubeconfig file")
|
f.StringVar(&flags.kubeconfigPath, "kubeconfig", os.Getenv("KUBECONFIG"), "Path to kubeconfig file")
|
||||||
f.StringVar(&flags.kubeconfigContextOverride, "kubeconfig-context", "", "Kubeconfig context name (default: current active context)")
|
f.StringVar(&flags.kubeconfigContextOverride, "kubeconfig-context", "", "Kubeconfig context name (default: current active context)")
|
||||||
f.BoolVar(&flags.skipValidate, "skip-validation", false, "Skip final validation of the kubeconfig (default: false)")
|
f.BoolVar(&flags.skipValidate, "skip-validation", false, "Skip final validation of the kubeconfig (default: false)")
|
||||||
@ -243,8 +229,10 @@ func runGetKubeconfig(ctx context.Context, out io.Writer, deps kubeconfigDeps, f
|
|||||||
cluster.CertificateAuthorityData = flags.concierge.caBundle
|
cluster.CertificateAuthorityData = flags.concierge.caBundle
|
||||||
}
|
}
|
||||||
|
|
||||||
// If there is an issuer, and if both upstream flags are not already set, then try to discover Supervisor upstream IDP.
|
// If there is an issuer, and if any upstream IDP flags are not already set, then try to discover Supervisor upstream IDP details.
|
||||||
if len(flags.oidc.issuer) > 0 && (flags.oidc.upstreamIDPType == "" || flags.oidc.upstreamIDPName == "") {
|
// When all the upstream IDP flags are set by the user, then skip discovery and don't validate their input. Maybe they know something
|
||||||
|
// that we can't know, like the name of an IDP that they are going to define in the future.
|
||||||
|
if len(flags.oidc.issuer) > 0 && (flags.oidc.upstreamIDPType == "" || flags.oidc.upstreamIDPName == "" || flags.oidc.upstreamIDPFlow == "") {
|
||||||
if err := discoverSupervisorUpstreamIDP(ctx, &flags); err != nil {
|
if err := discoverSupervisorUpstreamIDP(ctx, &flags); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -346,6 +334,9 @@ func newExecConfig(deps kubeconfigDeps, flags getKubeconfigParams) (*clientcmdap
|
|||||||
if flags.oidc.upstreamIDPType != "" {
|
if flags.oidc.upstreamIDPType != "" {
|
||||||
execConfig.Args = append(execConfig.Args, "--upstream-identity-provider-type="+flags.oidc.upstreamIDPType)
|
execConfig.Args = append(execConfig.Args, "--upstream-identity-provider-type="+flags.oidc.upstreamIDPType)
|
||||||
}
|
}
|
||||||
|
if flags.oidc.upstreamIDPFlow != "" {
|
||||||
|
execConfig.Args = append(execConfig.Args, "--upstream-identity-provider-flow="+flags.oidc.upstreamIDPFlow)
|
||||||
|
}
|
||||||
|
|
||||||
return execConfig, nil
|
return execConfig, nil
|
||||||
}
|
}
|
||||||
@ -758,21 +749,31 @@ func discoverSupervisorUpstreamIDP(ctx context.Context, flags *getKubeconfigPara
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
upstreamIDPs, err := discoverAllAvailableSupervisorUpstreamIDPs(ctx, pinnipedIDPsEndpoint, httpClient)
|
discoveredUpstreamIDPs, err := discoverAllAvailableSupervisorUpstreamIDPs(ctx, pinnipedIDPsEndpoint, httpClient)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if len(upstreamIDPs) == 1 {
|
|
||||||
flags.oidc.upstreamIDPName = upstreamIDPs[0].Name
|
if len(discoveredUpstreamIDPs) == 0 {
|
||||||
flags.oidc.upstreamIDPType = upstreamIDPs[0].Type
|
// Discovered that the Supervisor does not have any upstream IDPs defined. Continue without putting one into the
|
||||||
} else if len(upstreamIDPs) > 1 {
|
// kubeconfig. This kubeconfig will only work if the user defines one (and only one) OIDC IDP in the Supervisor
|
||||||
idpName, idpType, err := selectUpstreamIDP(upstreamIDPs, flags.oidc.upstreamIDPName, flags.oidc.upstreamIDPType)
|
// later and wants to use the default client flow for OIDC (browser-based auth).
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
selectedIDPName, selectedIDPType, discoveredIDPFlows, err := selectUpstreamIDPNameAndType(discoveredUpstreamIDPs, flags.oidc.upstreamIDPName, flags.oidc.upstreamIDPType)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
flags.oidc.upstreamIDPName = idpName
|
|
||||||
flags.oidc.upstreamIDPType = idpType
|
selectedIDPFlow, err := selectUpstreamIDPFlow(discoveredIDPFlows, selectedIDPName, selectedIDPType, flags.oidc.upstreamIDPFlow)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
flags.oidc.upstreamIDPName = selectedIDPName
|
||||||
|
flags.oidc.upstreamIDPType = selectedIDPType.String()
|
||||||
|
flags.oidc.upstreamIDPFlow = selectedIDPFlow.String()
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -800,7 +801,7 @@ func discoverIDPsDiscoveryEndpointURL(ctx context.Context, issuer string, httpCl
|
|||||||
return "", fmt.Errorf("while fetching OIDC discovery data from issuer: %w", err)
|
return "", fmt.Errorf("while fetching OIDC discovery data from issuer: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
var body supervisorOIDCDiscoveryResponseWithV1Alpha1
|
var body idpdiscoveryv1alpha1.OIDCDiscoveryResponse
|
||||||
err = discoveredProvider.Claims(&body)
|
err = discoveredProvider.Claims(&body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("while fetching OIDC discovery data from issuer: %w", err)
|
return "", fmt.Errorf("while fetching OIDC discovery data from issuer: %w", err)
|
||||||
@ -809,7 +810,7 @@ func discoverIDPsDiscoveryEndpointURL(ctx context.Context, issuer string, httpCl
|
|||||||
return body.SupervisorDiscovery.PinnipedIDPsEndpoint, nil
|
return body.SupervisorDiscovery.PinnipedIDPsEndpoint, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func discoverAllAvailableSupervisorUpstreamIDPs(ctx context.Context, pinnipedIDPsEndpoint string, httpClient *http.Client) ([]pinnipedIDPResponse, error) {
|
func discoverAllAvailableSupervisorUpstreamIDPs(ctx context.Context, pinnipedIDPsEndpoint string, httpClient *http.Client) ([]idpdiscoveryv1alpha1.PinnipedIDP, error) {
|
||||||
request, err := http.NewRequestWithContext(ctx, http.MethodGet, pinnipedIDPsEndpoint, nil)
|
request, err := http.NewRequestWithContext(ctx, http.MethodGet, pinnipedIDPsEndpoint, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("while forming request to IDP discovery URL: %w", err)
|
return nil, fmt.Errorf("while forming request to IDP discovery URL: %w", err)
|
||||||
@ -831,7 +832,7 @@ func discoverAllAvailableSupervisorUpstreamIDPs(ctx context.Context, pinnipedIDP
|
|||||||
return nil, fmt.Errorf("unable to fetch IDP discovery data from issuer: could not read response body: %w", err)
|
return nil, fmt.Errorf("unable to fetch IDP discovery data from issuer: could not read response body: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
var body supervisorIDPsDiscoveryResponseV1Alpha1
|
var body idpdiscoveryv1alpha1.IDPDiscoveryResponse
|
||||||
err = json.Unmarshal(rawBody, &body)
|
err = json.Unmarshal(rawBody, &body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("unable to fetch IDP discovery data from issuer: could not parse response JSON: %w", err)
|
return nil, fmt.Errorf("unable to fetch IDP discovery data from issuer: could not parse response JSON: %w", err)
|
||||||
@ -840,53 +841,106 @@ func discoverAllAvailableSupervisorUpstreamIDPs(ctx context.Context, pinnipedIDP
|
|||||||
return body.PinnipedIDPs, nil
|
return body.PinnipedIDPs, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func selectUpstreamIDP(pinnipedIDPs []pinnipedIDPResponse, idpName, idpType string) (string, string, error) {
|
func selectUpstreamIDPNameAndType(pinnipedIDPs []idpdiscoveryv1alpha1.PinnipedIDP, specifiedIDPName, specifiedIDPType string) (string, idpdiscoveryv1alpha1.IDPType, []idpdiscoveryv1alpha1.IDPFlow, error) {
|
||||||
pinnipedIDPsString, _ := json.Marshal(pinnipedIDPs)
|
pinnipedIDPsString, _ := json.Marshal(pinnipedIDPs)
|
||||||
|
var discoveredFlows []idpdiscoveryv1alpha1.IDPFlow
|
||||||
switch {
|
switch {
|
||||||
case idpType != "":
|
case specifiedIDPName != "" && specifiedIDPType != "":
|
||||||
discoveredName := ""
|
// The user specified both name and type, so check to see if there exists an exact match.
|
||||||
for _, idp := range pinnipedIDPs {
|
for _, idp := range pinnipedIDPs {
|
||||||
if idp.Type == idpType {
|
if idp.Name == specifiedIDPName && idp.Type.Equals(specifiedIDPType) {
|
||||||
|
return specifiedIDPName, idp.Type, idp.Flows, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", "", nil, fmt.Errorf(
|
||||||
|
"no Supervisor upstream identity providers with name %q of type %q were found. "+
|
||||||
|
"Found these upstreams: %s", specifiedIDPName, specifiedIDPType, pinnipedIDPsString)
|
||||||
|
case specifiedIDPType != "":
|
||||||
|
// The user specified only a type, so check if there is only one of that type found.
|
||||||
|
discoveredName := ""
|
||||||
|
var discoveredType idpdiscoveryv1alpha1.IDPType
|
||||||
|
for _, idp := range pinnipedIDPs {
|
||||||
|
if idp.Type.Equals(specifiedIDPType) {
|
||||||
if discoveredName != "" {
|
if discoveredName != "" {
|
||||||
return "", "", fmt.Errorf(
|
return "", "", nil, fmt.Errorf(
|
||||||
"multiple Supervisor upstream identity providers of type \"%s\" were found,"+
|
"multiple Supervisor upstream identity providers of type %q were found, "+
|
||||||
"so the --upstream-identity-provider-name flag must be specified. "+
|
"so the --upstream-identity-provider-name flag must be specified. "+
|
||||||
"Found these upstreams: %s",
|
"Found these upstreams: %s",
|
||||||
idpType, pinnipedIDPsString)
|
specifiedIDPType, pinnipedIDPsString)
|
||||||
}
|
}
|
||||||
discoveredName = idp.Name
|
discoveredName = idp.Name
|
||||||
|
discoveredType = idp.Type
|
||||||
|
discoveredFlows = idp.Flows
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if discoveredName == "" {
|
if discoveredName == "" {
|
||||||
return "", "", fmt.Errorf(
|
return "", "", nil, fmt.Errorf(
|
||||||
"no Supervisor upstream identity providers of type \"%s\" were found."+
|
"no Supervisor upstream identity providers of type %q were found. "+
|
||||||
" Found these upstreams: %s", idpType, pinnipedIDPsString)
|
"Found these upstreams: %s", specifiedIDPType, pinnipedIDPsString)
|
||||||
}
|
}
|
||||||
return discoveredName, idpType, nil
|
return discoveredName, discoveredType, discoveredFlows, nil
|
||||||
case idpName != "":
|
case specifiedIDPName != "":
|
||||||
discoveredType := ""
|
// The user specified only a name, so check if there is only one of that name found.
|
||||||
|
var discoveredType idpdiscoveryv1alpha1.IDPType
|
||||||
for _, idp := range pinnipedIDPs {
|
for _, idp := range pinnipedIDPs {
|
||||||
if idp.Name == idpName {
|
if idp.Name == specifiedIDPName {
|
||||||
if discoveredType != "" {
|
if discoveredType != "" {
|
||||||
return "", "", fmt.Errorf(
|
return "", "", nil, fmt.Errorf(
|
||||||
"multiple Supervisor upstream identity providers with name \"%s\" were found,"+
|
"multiple Supervisor upstream identity providers with name %q were found, "+
|
||||||
"so the --upstream-identity-provider-type flag must be specified. Found these upstreams: %s",
|
"so the --upstream-identity-provider-type flag must be specified. Found these upstreams: %s",
|
||||||
idpName, pinnipedIDPsString)
|
specifiedIDPName, pinnipedIDPsString)
|
||||||
}
|
}
|
||||||
discoveredType = idp.Type
|
discoveredType = idp.Type
|
||||||
|
discoveredFlows = idp.Flows
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if discoveredType == "" {
|
if discoveredType == "" {
|
||||||
return "", "", fmt.Errorf(
|
return "", "", nil, fmt.Errorf(
|
||||||
"no Supervisor upstream identity providers with name \"%s\" were found."+
|
"no Supervisor upstream identity providers with name %q were found. "+
|
||||||
" Found these upstreams: %s", idpName, pinnipedIDPsString)
|
"Found these upstreams: %s", specifiedIDPName, pinnipedIDPsString)
|
||||||
}
|
}
|
||||||
return idpName, discoveredType, nil
|
return specifiedIDPName, discoveredType, discoveredFlows, nil
|
||||||
|
case len(pinnipedIDPs) == 1:
|
||||||
|
// The user did not specify any name or type, but there is only one found, so select it.
|
||||||
|
return pinnipedIDPs[0].Name, pinnipedIDPs[0].Type, pinnipedIDPs[0].Flows, nil
|
||||||
default:
|
default:
|
||||||
return "", "", fmt.Errorf(
|
// The user did not specify any name or type, and there is more than one found.
|
||||||
|
return "", "", nil, fmt.Errorf(
|
||||||
"multiple Supervisor upstream identity providers were found, "+
|
"multiple Supervisor upstream identity providers were found, "+
|
||||||
"so the --upstream-identity-provider-name/--upstream-identity-provider-type flags must be specified. "+
|
"so the --upstream-identity-provider-name/--upstream-identity-provider-type flags must be specified. "+
|
||||||
"Found these upstreams: %s",
|
"Found these upstreams: %s",
|
||||||
pinnipedIDPsString)
|
pinnipedIDPsString)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func selectUpstreamIDPFlow(discoveredIDPFlows []idpdiscoveryv1alpha1.IDPFlow, selectedIDPName string, selectedIDPType idpdiscoveryv1alpha1.IDPType, specifiedFlow string) (idpdiscoveryv1alpha1.IDPFlow, error) {
|
||||||
|
switch {
|
||||||
|
case len(discoveredIDPFlows) == 0:
|
||||||
|
// No flows listed by discovery means that we are talking to an old Supervisor from before this feature existed.
|
||||||
|
// If the user specified a flow on the CLI flag then use it without validation, otherwise skip flow selection
|
||||||
|
// and return empty string.
|
||||||
|
return idpdiscoveryv1alpha1.IDPFlow(specifiedFlow), nil
|
||||||
|
case specifiedFlow != "":
|
||||||
|
// The user specified a flow, so validate that it is available for the selected IDP.
|
||||||
|
for _, flow := range discoveredIDPFlows {
|
||||||
|
if flow.Equals(specifiedFlow) {
|
||||||
|
// Found it, so use it as specified by the user.
|
||||||
|
return flow, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf(
|
||||||
|
"no client flow %q for Supervisor upstream identity provider %q of type %q were found. "+
|
||||||
|
"Found these flows: %v",
|
||||||
|
specifiedFlow, selectedIDPName, selectedIDPType, discoveredIDPFlows)
|
||||||
|
case len(discoveredIDPFlows) == 1:
|
||||||
|
// The user did not specify a flow, but there is only one found, so select it.
|
||||||
|
return discoveredIDPFlows[0], nil
|
||||||
|
default:
|
||||||
|
// The user did not specify a flow, and more than one was found.
|
||||||
|
return "", fmt.Errorf(
|
||||||
|
"multiple client flows for Supervisor upstream identity provider %q of type %q were found, "+
|
||||||
|
"so the --upstream-identity-provider-flow flag must be specified. "+
|
||||||
|
"Found these flows: %v",
|
||||||
|
selectedIDPName, selectedIDPType, discoveredIDPFlows)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -149,6 +149,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
--static-token string Instead of doing an OIDC-based login, specify a static token
|
--static-token string Instead of doing an OIDC-based login, specify a static token
|
||||||
--static-token-env string Instead of doing an OIDC-based login, read a static token from the environment
|
--static-token-env string Instead of doing an OIDC-based login, read a static token from the environment
|
||||||
--timeout duration Timeout for autodiscovery and validation (default 10m0s)
|
--timeout duration Timeout for autodiscovery and validation (default 10m0s)
|
||||||
|
--upstream-identity-provider-flow string The type of client flow to use with the upstream identity provider during login with a Supervisor (e.g. 'cli_password', 'browser_authcode')
|
||||||
--upstream-identity-provider-name string The name of the upstream identity provider used during login with a Supervisor
|
--upstream-identity-provider-name string The name of the upstream identity provider used during login with a Supervisor
|
||||||
--upstream-identity-provider-type string The type of the upstream identity provider used during login with a Supervisor (e.g. 'oidc', 'ldap', 'activedirectory')
|
--upstream-identity-provider-type string The type of the upstream identity provider used during login with a Supervisor (e.g. 'oidc', 'ldap', 'activedirectory')
|
||||||
`)
|
`)
|
||||||
@ -814,7 +815,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "when IDP discovery document contains multiple pinniped_idps and no name or type flags are given",
|
name: "when IDP discovery document contains multiple IDPs and no name or type flags are given",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
return []string{
|
return []string{
|
||||||
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
@ -1033,6 +1034,33 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
return `Error: while forming request to IDP discovery URL: parse "https%://illegal_url": first path segment in URL cannot contain colon` + "\n"
|
return `Error: while forming request to IDP discovery URL: parse "https%://illegal_url": first path segment in URL cannot contain colon` + "\n"
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery does not find matching IDP when name and type are both specified",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-name", "does-not-exist-idp",
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-ldap-idp", "type": "ldap"},
|
||||||
|
{"name": "some-other-ldap-idp", "type": "ldap"}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return `Error: no Supervisor upstream identity providers with name "does-not-exist-idp" of type "ldap" were found.` +
|
||||||
|
` Found these upstreams: [{"name":"some-ldap-idp","type":"ldap"},{"name":"some-other-ldap-idp","type":"ldap"}]` + "\n"
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: "supervisor upstream IDP discovery fails to resolve ambiguity when type is specified but name is not",
|
name: "supervisor upstream IDP discovery fails to resolve ambiguity when type is specified but name is not",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
@ -1091,7 +1119,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "supervisor upstream IDP discovery fails to find any matching idps when type is specified but name is not",
|
name: "supervisor upstream IDP discovery fails to find any matching IDPs when type is specified but name is not",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
return []string{
|
return []string{
|
||||||
@ -1117,7 +1145,32 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "supervisor upstream IDP discovery fails to find any matching idps when name is specified but type is not",
|
name: "supervisor upstream IDP discovery fails to find any matching IDPs when type is specified but name is not and there is only one IDP found",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-oidc-idp", "type": "oidc"}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return `Error: no Supervisor upstream identity providers of type "ldap" were found.` +
|
||||||
|
` Found these upstreams: [{"name":"some-oidc-idp","type":"oidc"}]` + "\n"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery fails to find any matching IDPs when name is specified but type is not",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
return []string{
|
return []string{
|
||||||
@ -1142,6 +1195,80 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
` Found these upstreams: [{"name":"some-oidc-idp","type":"oidc"},{"name":"some-other-oidc-idp","type":"oidc"}]` + "\n"
|
` Found these upstreams: [{"name":"some-oidc-idp","type":"oidc"},{"name":"some-other-oidc-idp","type":"oidc"}]` + "\n"
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery fails to find any matching IDPs when name is specified but type is not and there is only one IDP found",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-name", "my-nonexistent-idp",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-oidc-idp", "type": "oidc"}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return `Error: no Supervisor upstream identity providers with name "my-nonexistent-idp" were found.` +
|
||||||
|
` Found these upstreams: [{"name":"some-oidc-idp","type":"oidc"}]` + "\n"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery when flow is specified but it does not match any flow returned by discovery",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-flow", "my-nonexistent-flow",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-oidc-idp", "type": "oidc", "flows": ["non-matching-flow-1", "non-matching-flow-2"]}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return `Error: no client flow "my-nonexistent-flow" for Supervisor upstream identity provider "some-oidc-idp" of type "oidc" were found.` +
|
||||||
|
` Found these flows: [non-matching-flow-1 non-matching-flow-2]` + "\n"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery when no flow is specified and more than one flow is returned by discovery",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-oidc-idp", "type": "oidc", "flows": ["flow1", "flow2"]}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return `Error: multiple client flows for Supervisor upstream identity provider "some-oidc-idp" of type "oidc" were found, so the --upstream-identity-provider-flow flag must be specified.` +
|
||||||
|
` Found these flows: [flow1 flow2]` + "\n"
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: "valid static token",
|
name: "valid static token",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
@ -1535,7 +1662,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "autodetect impersonation proxy with autodiscovered JWT authenticator",
|
name: "autodetect impersonation proxy with auto-discovered JWT authenticator",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
return []string{
|
return []string{
|
||||||
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
@ -1958,7 +2085,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}`, issuerURL)
|
}`, issuerURL)
|
||||||
},
|
},
|
||||||
idpsDiscoveryStatusCode: http.StatusBadRequest, // IDPs endpoint shouldn't be called by this test
|
idpsDiscoveryStatusCode: http.StatusBadRequest, // IDP discovery endpoint shouldn't be called by this test
|
||||||
wantLogs: func(issuerCABundle string, issuerURL string) []string {
|
wantLogs: func(issuerCABundle string, issuerURL string) []string {
|
||||||
return []string{
|
return []string{
|
||||||
`"level"=0 "msg"="discovered CredentialIssuer" "name"="test-credential-issuer"`,
|
`"level"=0 "msg"="discovered CredentialIssuer" "name"="test-credential-issuer"`,
|
||||||
@ -2015,13 +2142,14 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "when upstream idp related flags are sent, pass them through",
|
name: "when all upstream IDP related flags are sent, pass them through without performing IDP discovery",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
return []string{
|
return []string{
|
||||||
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
"--skip-validation",
|
"--skip-validation",
|
||||||
"--upstream-identity-provider-name=some-oidc-idp",
|
"--upstream-identity-provider-name=some-oidc-idp",
|
||||||
"--upstream-identity-provider-type=oidc",
|
"--upstream-identity-provider-type=oidc",
|
||||||
|
"--upstream-identity-provider-flow=foobar",
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
conciergeObjects: func(issuerCABundle string, issuerURL string) []runtime.Object {
|
conciergeObjects: func(issuerCABundle string, issuerURL string) []runtime.Object {
|
||||||
@ -2030,7 +2158,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
jwtAuthenticator(issuerCABundle, issuerURL),
|
jwtAuthenticator(issuerCABundle, issuerURL),
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
oidcDiscoveryStatusCode: http.StatusNotFound,
|
oidcDiscoveryStatusCode: http.StatusNotFound, // should not get called by the client in this case
|
||||||
wantLogs: func(issuerCABundle string, issuerURL string) []string {
|
wantLogs: func(issuerCABundle string, issuerURL string) []string {
|
||||||
return []string{
|
return []string{
|
||||||
`"level"=0 "msg"="discovered CredentialIssuer" "name"="test-credential-issuer"`,
|
`"level"=0 "msg"="discovered CredentialIssuer" "name"="test-credential-issuer"`,
|
||||||
@ -2080,6 +2208,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
- --request-audience=test-audience
|
- --request-audience=test-audience
|
||||||
- --upstream-identity-provider-name=some-oidc-idp
|
- --upstream-identity-provider-name=some-oidc-idp
|
||||||
- --upstream-identity-provider-type=oidc
|
- --upstream-identity-provider-type=oidc
|
||||||
|
- --upstream-identity-provider-flow=foobar
|
||||||
command: '.../path/to/pinniped'
|
command: '.../path/to/pinniped'
|
||||||
env: []
|
env: []
|
||||||
provideClusterInfo: true
|
provideClusterInfo: true
|
||||||
@ -2089,13 +2218,14 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "when upstream IDP related flags are sent, pass them through even when IDP discovery shows a different IDP",
|
name: "when all upstream IDP related flags are sent, pass them through even when IDP discovery shows a different IDP",
|
||||||
args: func(issuerCABundle string, issuerURL string) []string {
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
return []string{
|
return []string{
|
||||||
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
"--skip-validation",
|
"--skip-validation",
|
||||||
"--upstream-identity-provider-name=some-oidc-idp",
|
"--upstream-identity-provider-name=some-oidc-idp",
|
||||||
"--upstream-identity-provider-type=oidc",
|
"--upstream-identity-provider-type=oidc",
|
||||||
|
"--upstream-identity-provider-flow=foobar",
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
conciergeObjects: func(issuerCABundle string, issuerURL string) []runtime.Object {
|
conciergeObjects: func(issuerCABundle string, issuerURL string) []runtime.Object {
|
||||||
@ -2159,6 +2289,7 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
- --request-audience=test-audience
|
- --request-audience=test-audience
|
||||||
- --upstream-identity-provider-name=some-oidc-idp
|
- --upstream-identity-provider-name=some-oidc-idp
|
||||||
- --upstream-identity-provider-type=oidc
|
- --upstream-identity-provider-type=oidc
|
||||||
|
- --upstream-identity-provider-flow=foobar
|
||||||
command: '.../path/to/pinniped'
|
command: '.../path/to/pinniped'
|
||||||
env: []
|
env: []
|
||||||
provideClusterInfo: true
|
provideClusterInfo: true
|
||||||
@ -2340,6 +2471,244 @@ func TestGetKubeconfig(t *testing.T) {
|
|||||||
issuerURL,
|
issuerURL,
|
||||||
base64.StdEncoding.EncodeToString([]byte(issuerCABundle)))
|
base64.StdEncoding.EncodeToString([]byte(issuerCABundle)))
|
||||||
},
|
},
|
||||||
|
}, // TODO make sure there are active directory tests for various flows
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery when both name and type are specified but flow is not and a matching IDP is found",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-name", "some-ldap-idp",
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-ldap-idp", "type": "ldap"},
|
||||||
|
{"name": "some-oidc-idp", "type": "oidc"},
|
||||||
|
{"name": "some-other-oidc-idp", "type": "oidc"}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantStdout: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return here.Docf(`
|
||||||
|
apiVersion: v1
|
||||||
|
clusters:
|
||||||
|
- cluster:
|
||||||
|
certificate-authority-data: ZmFrZS1jZXJ0aWZpY2F0ZS1hdXRob3JpdHktZGF0YS12YWx1ZQ==
|
||||||
|
server: https://fake-server-url-value
|
||||||
|
name: kind-cluster-pinniped
|
||||||
|
contexts:
|
||||||
|
- context:
|
||||||
|
cluster: kind-cluster-pinniped
|
||||||
|
user: kind-user-pinniped
|
||||||
|
name: kind-context-pinniped
|
||||||
|
current-context: kind-context-pinniped
|
||||||
|
kind: Config
|
||||||
|
preferences: {}
|
||||||
|
users:
|
||||||
|
- name: kind-user-pinniped
|
||||||
|
user:
|
||||||
|
exec:
|
||||||
|
apiVersion: client.authentication.k8s.io/v1beta1
|
||||||
|
args:
|
||||||
|
- login
|
||||||
|
- oidc
|
||||||
|
- --issuer=%s
|
||||||
|
- --client-id=pinniped-cli
|
||||||
|
- --scopes=offline_access,openid,pinniped:request-audience
|
||||||
|
- --ca-bundle-data=%s
|
||||||
|
- --upstream-identity-provider-name=some-ldap-idp
|
||||||
|
- --upstream-identity-provider-type=ldap
|
||||||
|
command: '.../path/to/pinniped'
|
||||||
|
env: []
|
||||||
|
provideClusterInfo: true
|
||||||
|
`,
|
||||||
|
issuerURL,
|
||||||
|
base64.StdEncoding.EncodeToString([]byte(issuerCABundle)))
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery when flow is specified and no flows were returned by discovery uses the specified flow",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-flow", "foobar",
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-ldap-idp", "type": "ldap"},
|
||||||
|
{"name": "some-oidc-idp", "type": "oidc"},
|
||||||
|
{"name": "some-other-oidc-idp", "type": "oidc"}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantStdout: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return here.Docf(`
|
||||||
|
apiVersion: v1
|
||||||
|
clusters:
|
||||||
|
- cluster:
|
||||||
|
certificate-authority-data: ZmFrZS1jZXJ0aWZpY2F0ZS1hdXRob3JpdHktZGF0YS12YWx1ZQ==
|
||||||
|
server: https://fake-server-url-value
|
||||||
|
name: kind-cluster-pinniped
|
||||||
|
contexts:
|
||||||
|
- context:
|
||||||
|
cluster: kind-cluster-pinniped
|
||||||
|
user: kind-user-pinniped
|
||||||
|
name: kind-context-pinniped
|
||||||
|
current-context: kind-context-pinniped
|
||||||
|
kind: Config
|
||||||
|
preferences: {}
|
||||||
|
users:
|
||||||
|
- name: kind-user-pinniped
|
||||||
|
user:
|
||||||
|
exec:
|
||||||
|
apiVersion: client.authentication.k8s.io/v1beta1
|
||||||
|
args:
|
||||||
|
- login
|
||||||
|
- oidc
|
||||||
|
- --issuer=%s
|
||||||
|
- --client-id=pinniped-cli
|
||||||
|
- --scopes=offline_access,openid,pinniped:request-audience
|
||||||
|
- --ca-bundle-data=%s
|
||||||
|
- --upstream-identity-provider-name=some-ldap-idp
|
||||||
|
- --upstream-identity-provider-type=ldap
|
||||||
|
- --upstream-identity-provider-flow=foobar
|
||||||
|
command: '.../path/to/pinniped'
|
||||||
|
env: []
|
||||||
|
provideClusterInfo: true
|
||||||
|
`,
|
||||||
|
issuerURL,
|
||||||
|
base64.StdEncoding.EncodeToString([]byte(issuerCABundle)))
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery when flow is specified and it matches a flow returned by discovery uses the specified flow",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-flow", "cli_password",
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-ldap-idp", "type": "ldap", "flows": ["some_flow", "cli_password", "some_other_flow"]}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantStdout: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return here.Docf(`
|
||||||
|
apiVersion: v1
|
||||||
|
clusters:
|
||||||
|
- cluster:
|
||||||
|
certificate-authority-data: ZmFrZS1jZXJ0aWZpY2F0ZS1hdXRob3JpdHktZGF0YS12YWx1ZQ==
|
||||||
|
server: https://fake-server-url-value
|
||||||
|
name: kind-cluster-pinniped
|
||||||
|
contexts:
|
||||||
|
- context:
|
||||||
|
cluster: kind-cluster-pinniped
|
||||||
|
user: kind-user-pinniped
|
||||||
|
name: kind-context-pinniped
|
||||||
|
current-context: kind-context-pinniped
|
||||||
|
kind: Config
|
||||||
|
preferences: {}
|
||||||
|
users:
|
||||||
|
- name: kind-user-pinniped
|
||||||
|
user:
|
||||||
|
exec:
|
||||||
|
apiVersion: client.authentication.k8s.io/v1beta1
|
||||||
|
args:
|
||||||
|
- login
|
||||||
|
- oidc
|
||||||
|
- --issuer=%s
|
||||||
|
- --client-id=pinniped-cli
|
||||||
|
- --scopes=offline_access,openid,pinniped:request-audience
|
||||||
|
- --ca-bundle-data=%s
|
||||||
|
- --upstream-identity-provider-name=some-ldap-idp
|
||||||
|
- --upstream-identity-provider-type=ldap
|
||||||
|
- --upstream-identity-provider-flow=cli_password
|
||||||
|
command: '.../path/to/pinniped'
|
||||||
|
env: []
|
||||||
|
provideClusterInfo: true
|
||||||
|
`,
|
||||||
|
issuerURL,
|
||||||
|
base64.StdEncoding.EncodeToString([]byte(issuerCABundle)))
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "supervisor upstream IDP discovery when no flow is specified but there is only one flow returned by discovery uses the discovered flow",
|
||||||
|
args: func(issuerCABundle string, issuerURL string) []string {
|
||||||
|
f := testutil.WriteStringToTempFile(t, "testca-*.pem", issuerCABundle)
|
||||||
|
return []string{
|
||||||
|
"--kubeconfig", "./testdata/kubeconfig.yaml",
|
||||||
|
"--skip-validation",
|
||||||
|
"--no-concierge",
|
||||||
|
"--oidc-issuer", issuerURL,
|
||||||
|
"--oidc-ca-bundle", f.Name(),
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
oidcDiscoveryResponse: happyOIDCDiscoveryResponse,
|
||||||
|
idpsDiscoveryResponse: here.Docf(`{
|
||||||
|
"pinniped_identity_providers": [
|
||||||
|
{"name": "some-ldap-idp", "type": "ldap", "flows": ["cli_password"]}
|
||||||
|
]
|
||||||
|
}`),
|
||||||
|
wantStdout: func(issuerCABundle string, issuerURL string) string {
|
||||||
|
return here.Docf(`
|
||||||
|
apiVersion: v1
|
||||||
|
clusters:
|
||||||
|
- cluster:
|
||||||
|
certificate-authority-data: ZmFrZS1jZXJ0aWZpY2F0ZS1hdXRob3JpdHktZGF0YS12YWx1ZQ==
|
||||||
|
server: https://fake-server-url-value
|
||||||
|
name: kind-cluster-pinniped
|
||||||
|
contexts:
|
||||||
|
- context:
|
||||||
|
cluster: kind-cluster-pinniped
|
||||||
|
user: kind-user-pinniped
|
||||||
|
name: kind-context-pinniped
|
||||||
|
current-context: kind-context-pinniped
|
||||||
|
kind: Config
|
||||||
|
preferences: {}
|
||||||
|
users:
|
||||||
|
- name: kind-user-pinniped
|
||||||
|
user:
|
||||||
|
exec:
|
||||||
|
apiVersion: client.authentication.k8s.io/v1beta1
|
||||||
|
args:
|
||||||
|
- login
|
||||||
|
- oidc
|
||||||
|
- --issuer=%s
|
||||||
|
- --client-id=pinniped-cli
|
||||||
|
- --scopes=offline_access,openid,pinniped:request-audience
|
||||||
|
- --ca-bundle-data=%s
|
||||||
|
- --upstream-identity-provider-name=some-ldap-idp
|
||||||
|
- --upstream-identity-provider-type=ldap
|
||||||
|
- --upstream-identity-provider-flow=cli_password
|
||||||
|
command: '.../path/to/pinniped'
|
||||||
|
env: []
|
||||||
|
provideClusterInfo: true
|
||||||
|
`,
|
||||||
|
issuerURL,
|
||||||
|
base64.StdEncoding.EncodeToString([]byte(issuerCABundle)))
|
||||||
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
|
@ -14,6 +14,7 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/coreos/go-oidc/v3/oidc"
|
"github.com/coreos/go-oidc/v3/oidc"
|
||||||
@ -23,6 +24,7 @@ import (
|
|||||||
"k8s.io/client-go/transport"
|
"k8s.io/client-go/transport"
|
||||||
"k8s.io/klog/v2/klogr"
|
"k8s.io/klog/v2/klogr"
|
||||||
|
|
||||||
|
idpdiscoveryv1alpha1 "go.pinniped.dev/generated/latest/apis/supervisor/idpdiscovery/v1alpha1"
|
||||||
"go.pinniped.dev/internal/execcredcache"
|
"go.pinniped.dev/internal/execcredcache"
|
||||||
"go.pinniped.dev/internal/groupsuffix"
|
"go.pinniped.dev/internal/groupsuffix"
|
||||||
"go.pinniped.dev/internal/plog"
|
"go.pinniped.dev/internal/plog"
|
||||||
@ -74,6 +76,7 @@ type oidcLoginFlags struct {
|
|||||||
credentialCachePath string
|
credentialCachePath string
|
||||||
upstreamIdentityProviderName string
|
upstreamIdentityProviderName string
|
||||||
upstreamIdentityProviderType string
|
upstreamIdentityProviderType string
|
||||||
|
upstreamIdentityProviderFlow string
|
||||||
}
|
}
|
||||||
|
|
||||||
func oidcLoginCommand(deps oidcLoginCommandDeps) *cobra.Command {
|
func oidcLoginCommand(deps oidcLoginCommandDeps) *cobra.Command {
|
||||||
@ -107,7 +110,8 @@ func oidcLoginCommand(deps oidcLoginCommandDeps) *cobra.Command {
|
|||||||
cmd.Flags().StringVar(&flags.conciergeAPIGroupSuffix, "concierge-api-group-suffix", groupsuffix.PinnipedDefaultSuffix, "Concierge API group suffix")
|
cmd.Flags().StringVar(&flags.conciergeAPIGroupSuffix, "concierge-api-group-suffix", groupsuffix.PinnipedDefaultSuffix, "Concierge API group suffix")
|
||||||
cmd.Flags().StringVar(&flags.credentialCachePath, "credential-cache", filepath.Join(mustGetConfigDir(), "credentials.yaml"), "Path to cluster-specific credentials cache (\"\" disables the cache)")
|
cmd.Flags().StringVar(&flags.credentialCachePath, "credential-cache", filepath.Join(mustGetConfigDir(), "credentials.yaml"), "Path to cluster-specific credentials cache (\"\" disables the cache)")
|
||||||
cmd.Flags().StringVar(&flags.upstreamIdentityProviderName, "upstream-identity-provider-name", "", "The name of the upstream identity provider used during login with a Supervisor")
|
cmd.Flags().StringVar(&flags.upstreamIdentityProviderName, "upstream-identity-provider-name", "", "The name of the upstream identity provider used during login with a Supervisor")
|
||||||
cmd.Flags().StringVar(&flags.upstreamIdentityProviderType, "upstream-identity-provider-type", "oidc", "The type of the upstream identity provider used during login with a Supervisor (e.g. 'oidc', 'ldap', 'activedirectory')")
|
cmd.Flags().StringVar(&flags.upstreamIdentityProviderType, "upstream-identity-provider-type", idpdiscoveryv1alpha1.IDPTypeOIDC.String(), fmt.Sprintf("The type of the upstream identity provider used during login with a Supervisor (e.g. '%s', '%s', '%s')", idpdiscoveryv1alpha1.IDPTypeOIDC, idpdiscoveryv1alpha1.IDPTypeLDAP, idpdiscoveryv1alpha1.IDPTypeActiveDirectory))
|
||||||
|
cmd.Flags().StringVar(&flags.upstreamIdentityProviderFlow, "upstream-identity-provider-flow", "", fmt.Sprintf("The type of client flow to use with the upstream identity provider during login with a Supervisor (e.g. '%s', '%s')", idpdiscoveryv1alpha1.IDPFlowBrowserAuthcode, idpdiscoveryv1alpha1.IDPFlowCLIPassword))
|
||||||
|
|
||||||
// --skip-listen is mainly needed for testing. We'll leave it hidden until we have a non-testing use case.
|
// --skip-listen is mainly needed for testing. We'll leave it hidden until we have a non-testing use case.
|
||||||
mustMarkHidden(cmd, "skip-listen")
|
mustMarkHidden(cmd, "skip-listen")
|
||||||
@ -160,19 +164,14 @@ func runOIDCLogin(cmd *cobra.Command, deps oidcLoginCommandDeps, flags oidcLogin
|
|||||||
flags.upstreamIdentityProviderName, flags.upstreamIdentityProviderType))
|
flags.upstreamIdentityProviderName, flags.upstreamIdentityProviderType))
|
||||||
}
|
}
|
||||||
|
|
||||||
switch flags.upstreamIdentityProviderType {
|
flowOpts, err := flowOptions(
|
||||||
case "oidc":
|
idpdiscoveryv1alpha1.IDPType(flags.upstreamIdentityProviderType),
|
||||||
// this is the default, so don't need to do anything
|
idpdiscoveryv1alpha1.IDPFlow(flags.upstreamIdentityProviderFlow),
|
||||||
case "ldap":
|
)
|
||||||
opts = append(opts, oidcclient.WithCLISendingCredentials())
|
if err != nil {
|
||||||
case "activedirectory":
|
return err
|
||||||
opts = append(opts, oidcclient.WithCLISendingCredentials())
|
|
||||||
default:
|
|
||||||
// Surprisingly cobra does not support this kind of flag validation. See https://github.com/spf13/pflag/issues/236
|
|
||||||
return fmt.Errorf(
|
|
||||||
"--upstream-identity-provider-type value not recognized: %s (supported values: oidc, ldap, activedirectory)",
|
|
||||||
flags.upstreamIdentityProviderType)
|
|
||||||
}
|
}
|
||||||
|
opts = append(opts, flowOpts...)
|
||||||
|
|
||||||
var concierge *conciergeclient.Client
|
var concierge *conciergeclient.Client
|
||||||
if flags.conciergeEnabled {
|
if flags.conciergeEnabled {
|
||||||
@ -253,6 +252,46 @@ func runOIDCLogin(cmd *cobra.Command, deps oidcLoginCommandDeps, flags oidcLogin
|
|||||||
return json.NewEncoder(cmd.OutOrStdout()).Encode(cred)
|
return json.NewEncoder(cmd.OutOrStdout()).Encode(cred)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func flowOptions(requestedIDPType idpdiscoveryv1alpha1.IDPType, requestedFlow idpdiscoveryv1alpha1.IDPFlow) ([]oidcclient.Option, error) {
|
||||||
|
useCLIFlow := []oidcclient.Option{oidcclient.WithCLISendingCredentials()}
|
||||||
|
|
||||||
|
switch requestedIDPType {
|
||||||
|
case idpdiscoveryv1alpha1.IDPTypeOIDC:
|
||||||
|
switch requestedFlow {
|
||||||
|
case idpdiscoveryv1alpha1.IDPFlowCLIPassword:
|
||||||
|
return useCLIFlow, nil
|
||||||
|
case idpdiscoveryv1alpha1.IDPFlowBrowserAuthcode, "":
|
||||||
|
return nil, nil // browser authcode flow is the default Option, so don't need to return an Option here
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"--upstream-identity-provider-flow value not recognized for identity provider type %q: %s (supported values: %s)",
|
||||||
|
requestedIDPType, requestedFlow, strings.Join([]string{idpdiscoveryv1alpha1.IDPFlowBrowserAuthcode.String(), idpdiscoveryv1alpha1.IDPFlowCLIPassword.String()}, ", "))
|
||||||
|
}
|
||||||
|
case idpdiscoveryv1alpha1.IDPTypeLDAP, idpdiscoveryv1alpha1.IDPTypeActiveDirectory:
|
||||||
|
switch requestedFlow {
|
||||||
|
case idpdiscoveryv1alpha1.IDPFlowCLIPassword, "":
|
||||||
|
return useCLIFlow, nil
|
||||||
|
case idpdiscoveryv1alpha1.IDPFlowBrowserAuthcode:
|
||||||
|
fallthrough // not supported for LDAP providers, so fallthrough to error case
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"--upstream-identity-provider-flow value not recognized for identity provider type %q: %s (supported values: %s)",
|
||||||
|
requestedIDPType, requestedFlow, []string{idpdiscoveryv1alpha1.IDPFlowCLIPassword.String()})
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
// Surprisingly cobra does not support this kind of flag validation. See https://github.com/spf13/pflag/issues/236
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"--upstream-identity-provider-type value not recognized: %s (supported values: %s)",
|
||||||
|
requestedIDPType,
|
||||||
|
strings.Join([]string{
|
||||||
|
idpdiscoveryv1alpha1.IDPTypeOIDC.String(),
|
||||||
|
idpdiscoveryv1alpha1.IDPTypeLDAP.String(),
|
||||||
|
idpdiscoveryv1alpha1.IDPTypeActiveDirectory.String(),
|
||||||
|
}, ", "),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func makeClient(caBundlePaths []string, caBundleData []string) (*http.Client, error) {
|
func makeClient(caBundlePaths []string, caBundleData []string) (*http.Client, error) {
|
||||||
pool := x509.NewCertPool()
|
pool := x509.NewCertPool()
|
||||||
for _, p := range caBundlePaths {
|
for _, p := range caBundlePaths {
|
||||||
|
@ -77,6 +77,7 @@ func TestLoginOIDCCommand(t *testing.T) {
|
|||||||
--scopes strings OIDC scopes to request during login (default [offline_access,openid,pinniped:request-audience])
|
--scopes strings OIDC scopes to request during login (default [offline_access,openid,pinniped:request-audience])
|
||||||
--session-cache string Path to session cache file (default "` + cfgDir + `/sessions.yaml")
|
--session-cache string Path to session cache file (default "` + cfgDir + `/sessions.yaml")
|
||||||
--skip-browser Skip opening the browser (just print the URL)
|
--skip-browser Skip opening the browser (just print the URL)
|
||||||
|
--upstream-identity-provider-flow string The type of client flow to use with the upstream identity provider during login with a Supervisor (e.g. 'browser_authcode', 'cli_password')
|
||||||
--upstream-identity-provider-name string The name of the upstream identity provider used during login with a Supervisor
|
--upstream-identity-provider-name string The name of the upstream identity provider used during login with a Supervisor
|
||||||
--upstream-identity-provider-type string The type of the upstream identity provider used during login with a Supervisor (e.g. 'oidc', 'ldap', 'activedirectory') (default "oidc")
|
--upstream-identity-provider-type string The type of the upstream identity provider used during login with a Supervisor (e.g. 'oidc', 'ldap', 'activedirectory') (default "oidc")
|
||||||
`),
|
`),
|
||||||
@ -152,7 +153,7 @@ func TestLoginOIDCCommand(t *testing.T) {
|
|||||||
`),
|
`),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "oidc upstream type is allowed",
|
name: "oidc upstream type with default flow is allowed",
|
||||||
args: []string{
|
args: []string{
|
||||||
"--issuer", "test-issuer",
|
"--issuer", "test-issuer",
|
||||||
"--client-id", "test-client-id",
|
"--client-id", "test-client-id",
|
||||||
@ -163,7 +164,45 @@ func TestLoginOIDCCommand(t *testing.T) {
|
|||||||
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "ldap upstream type is allowed",
|
name: "oidc upstream type with CLI flow is allowed",
|
||||||
|
args: []string{
|
||||||
|
"--issuer", "test-issuer",
|
||||||
|
"--client-id", "test-client-id",
|
||||||
|
"--upstream-identity-provider-type", "oidc",
|
||||||
|
"--upstream-identity-provider-flow", "cli_password",
|
||||||
|
"--credential-cache", "", // must specify --credential-cache or else the cache file on disk causes test pollution
|
||||||
|
},
|
||||||
|
wantOptionsCount: 5,
|
||||||
|
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "oidc upstream type with browser flow is allowed",
|
||||||
|
args: []string{
|
||||||
|
"--issuer", "test-issuer",
|
||||||
|
"--client-id", "test-client-id",
|
||||||
|
"--upstream-identity-provider-type", "oidc",
|
||||||
|
"--upstream-identity-provider-flow", "browser_authcode",
|
||||||
|
"--credential-cache", "", // must specify --credential-cache or else the cache file on disk causes test pollution
|
||||||
|
},
|
||||||
|
wantOptionsCount: 4,
|
||||||
|
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "oidc upstream type with unsupported flow is an error",
|
||||||
|
args: []string{
|
||||||
|
"--issuer", "test-issuer",
|
||||||
|
"--client-id", "test-client-id",
|
||||||
|
"--upstream-identity-provider-type", "oidc",
|
||||||
|
"--upstream-identity-provider-flow", "foobar",
|
||||||
|
"--credential-cache", "", // must specify --credential-cache or else the cache file on disk causes test pollution
|
||||||
|
},
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: here.Doc(`
|
||||||
|
Error: --upstream-identity-provider-flow value not recognized for identity provider type "oidc": foobar (supported values: browser_authcode, cli_password)
|
||||||
|
`),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "ldap upstream type with default flow is allowed",
|
||||||
args: []string{
|
args: []string{
|
||||||
"--issuer", "test-issuer",
|
"--issuer", "test-issuer",
|
||||||
"--client-id", "test-client-id",
|
"--client-id", "test-client-id",
|
||||||
@ -174,7 +213,7 @@ func TestLoginOIDCCommand(t *testing.T) {
|
|||||||
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "activedirectory upstream type is allowed",
|
name: "activedirectory upstream type with default flow is allowed",
|
||||||
args: []string{
|
args: []string{
|
||||||
"--issuer", "test-issuer",
|
"--issuer", "test-issuer",
|
||||||
"--client-id", "test-client-id",
|
"--client-id", "test-client-id",
|
||||||
@ -184,6 +223,58 @@ func TestLoginOIDCCommand(t *testing.T) {
|
|||||||
wantOptionsCount: 5,
|
wantOptionsCount: 5,
|
||||||
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "ldap upstream type with CLI flow is allowed",
|
||||||
|
args: []string{
|
||||||
|
"--issuer", "test-issuer",
|
||||||
|
"--client-id", "test-client-id",
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
"--upstream-identity-provider-flow", "cli_password",
|
||||||
|
"--credential-cache", "", // must specify --credential-cache or else the cache file on disk causes test pollution
|
||||||
|
},
|
||||||
|
wantOptionsCount: 5,
|
||||||
|
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "ldap upstream type with unsupported flow is an error",
|
||||||
|
args: []string{
|
||||||
|
"--issuer", "test-issuer",
|
||||||
|
"--client-id", "test-client-id",
|
||||||
|
"--upstream-identity-provider-type", "ldap",
|
||||||
|
"--upstream-identity-provider-flow", "browser_authcode", // "browser_authcode" is only supported for OIDC upstreams
|
||||||
|
"--credential-cache", "", // must specify --credential-cache or else the cache file on disk causes test pollution
|
||||||
|
},
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: here.Doc(`
|
||||||
|
Error: --upstream-identity-provider-flow value not recognized for identity provider type "ldap": browser_authcode (supported values: [cli_password])
|
||||||
|
`),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "active directory upstream type with CLI flow is allowed",
|
||||||
|
args: []string{
|
||||||
|
"--issuer", "test-issuer",
|
||||||
|
"--client-id", "test-client-id",
|
||||||
|
"--upstream-identity-provider-type", "activedirectory",
|
||||||
|
"--upstream-identity-provider-flow", "cli_password",
|
||||||
|
"--credential-cache", "", // must specify --credential-cache or else the cache file on disk causes test pollution
|
||||||
|
},
|
||||||
|
wantOptionsCount: 5,
|
||||||
|
wantStdout: `{"kind":"ExecCredential","apiVersion":"client.authentication.k8s.io/v1beta1","spec":{"interactive":false},"status":{"expirationTimestamp":"3020-10-12T13:14:15Z","token":"test-id-token"}}` + "\n",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "active directory upstream type with unsupported flow is an error",
|
||||||
|
args: []string{
|
||||||
|
"--issuer", "test-issuer",
|
||||||
|
"--client-id", "test-client-id",
|
||||||
|
"--upstream-identity-provider-type", "activedirectory",
|
||||||
|
"--upstream-identity-provider-flow", "browser_authcode", // "browser_authcode" is only supported for OIDC upstreams
|
||||||
|
"--credential-cache", "", // must specify --credential-cache or else the cache file on disk causes test pollution
|
||||||
|
},
|
||||||
|
wantError: true,
|
||||||
|
wantStderr: here.Doc(`
|
||||||
|
Error: --upstream-identity-provider-flow value not recognized for identity provider type "activedirectory": browser_authcode (supported values: [cli_password])
|
||||||
|
`),
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: "login error",
|
name: "login error",
|
||||||
args: []string{
|
args: []string{
|
||||||
|
@ -153,6 +153,9 @@ rules:
|
|||||||
- apiGroups: [ "" ]
|
- apiGroups: [ "" ]
|
||||||
resources: [ configmaps ]
|
resources: [ configmaps ]
|
||||||
verbs: [ list, get, watch ]
|
verbs: [ list, get, watch ]
|
||||||
|
- apiGroups: [ coordination.k8s.io ]
|
||||||
|
resources: [ leases ]
|
||||||
|
verbs: [ create, get, update ]
|
||||||
---
|
---
|
||||||
kind: RoleBinding
|
kind: RoleBinding
|
||||||
apiVersion: rbac.authorization.k8s.io/v1
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
@ -59,11 +59,44 @@ spec:
|
|||||||
additionalScopes:
|
additionalScopes:
|
||||||
description: AdditionalScopes are the scopes in addition to "openid"
|
description: AdditionalScopes are the scopes in addition to "openid"
|
||||||
that will be requested as part of the authorization request
|
that will be requested as part of the authorization request
|
||||||
flow with an OIDC identity provider. By default only the "openid"
|
flow with an OIDC identity provider. In the case of a Resource
|
||||||
scope will be requested.
|
Owner Password Credentials Grant flow, AdditionalScopes are
|
||||||
|
the scopes in addition to "openid" that will be requested as
|
||||||
|
part of the token request (see also the allowPasswordGrant field).
|
||||||
|
By default, only the "openid" scope will be requested.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
type: array
|
type: array
|
||||||
|
allowPasswordGrant:
|
||||||
|
description: AllowPasswordGrant, when true, will allow the use
|
||||||
|
of OAuth 2.0's Resource Owner Password Credentials Grant (see
|
||||||
|
https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to
|
||||||
|
authenticate to the OIDC provider using a username and password
|
||||||
|
without a web browser, in addition to the usual browser-based
|
||||||
|
OIDC Authorization Code Flow. The Resource Owner Password Credentials
|
||||||
|
Grant is not officially part of the OIDC specification, so it
|
||||||
|
may not be supported by your OIDC provider. If your OIDC provider
|
||||||
|
supports returning ID tokens from a Resource Owner Password
|
||||||
|
Credentials Grant token request, then you can choose to set
|
||||||
|
this field to true. This will allow end users to choose to present
|
||||||
|
their username and password to the kubectl CLI (using the Pinniped
|
||||||
|
plugin) to authenticate to the cluster, without using a web
|
||||||
|
browser to log in as is customary in OIDC Authorization Code
|
||||||
|
Flow. This may be convenient for users, especially for identities
|
||||||
|
from your OIDC provider which are not intended to represent
|
||||||
|
a human actor, such as service accounts performing actions in
|
||||||
|
a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
you may wish to disable this behavior by setting this field
|
||||||
|
to false when you prefer to only allow users of this OIDCIdentityProvider
|
||||||
|
to log in via the browser-based OIDC Authorization Code Flow.
|
||||||
|
Using the Resource Owner Password Credentials Grant means that
|
||||||
|
the Pinniped CLI and Pinniped Supervisor will directly handle
|
||||||
|
your end users' passwords (similar to LDAPIdentityProvider),
|
||||||
|
and you will not be able to require multi-factor authentication
|
||||||
|
or use the other web-based login features of your OIDC provider
|
||||||
|
during Resource Owner Password Credentials Grant logins. AllowPasswordGrant
|
||||||
|
defaults to false.
|
||||||
|
type: boolean
|
||||||
type: object
|
type: object
|
||||||
claims:
|
claims:
|
||||||
description: Claims provides the names of token claims that will be
|
description: Claims provides the names of token claims that will be
|
||||||
|
@ -56,6 +56,9 @@ rules:
|
|||||||
- apiGroups: [apps]
|
- apiGroups: [apps]
|
||||||
resources: [replicasets,deployments]
|
resources: [replicasets,deployments]
|
||||||
verbs: [get]
|
verbs: [get]
|
||||||
|
- apiGroups: [ coordination.k8s.io ]
|
||||||
|
resources: [ leases ]
|
||||||
|
verbs: [ create, get, update ]
|
||||||
---
|
---
|
||||||
kind: RoleBinding
|
kind: RoleBinding
|
||||||
apiVersion: rbac.authorization.k8s.io/v1
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
3
generated/1.17/README.adoc
generated
3
generated/1.17/README.adoc
generated
@ -1099,7 +1099,8 @@ OIDCAuthorizationConfig provides information about how to form the OAuth2 author
|
|||||||
[cols="25a,75a", options="header"]
|
[cols="25a,75a", options="header"]
|
||||||
|===
|
|===
|
||||||
| Field | Description
|
| Field | Description
|
||||||
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field). By default, only the "openid" scope will be requested.
|
||||||
|
| *`allowPasswordGrant`* __boolean__ | AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow. The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be convenient for users, especially for identities from your OIDC provider which are not intended to represent a human actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it, you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins. AllowPasswordGrant defaults to false.
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
package v1alpha1
|
package v1alpha1
|
||||||
@ -39,9 +39,31 @@ type OIDCIdentityProviderStatus struct {
|
|||||||
// request parameters.
|
// request parameters.
|
||||||
type OIDCAuthorizationConfig struct {
|
type OIDCAuthorizationConfig struct {
|
||||||
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
||||||
// request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
// request flow with an OIDC identity provider.
|
||||||
|
// In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes
|
||||||
|
// in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field).
|
||||||
|
// By default, only the "openid" scope will be requested.
|
||||||
// +optional
|
// +optional
|
||||||
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
||||||
|
|
||||||
|
// AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant
|
||||||
|
// (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a
|
||||||
|
// username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow.
|
||||||
|
// The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be
|
||||||
|
// supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password
|
||||||
|
// Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose
|
||||||
|
// to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the
|
||||||
|
// cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be
|
||||||
|
// convenient for users, especially for identities from your OIDC provider which are not intended to represent a human
|
||||||
|
// actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
// you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this
|
||||||
|
// OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password
|
||||||
|
// Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords
|
||||||
|
// (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other
|
||||||
|
// web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins.
|
||||||
|
// AllowPasswordGrant defaults to false.
|
||||||
|
// +optional
|
||||||
|
AllowPasswordGrant bool `json:"allowPasswordGrant,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// OIDCClaims provides a mapping from upstream claims into identities.
|
// OIDCClaims provides a mapping from upstream claims into identities.
|
||||||
|
66
generated/1.17/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
66
generated/1.17/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package v1alpha1
|
||||||
|
|
||||||
|
// IDPType are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// as the "type" of each returned identity provider.
|
||||||
|
type IDPType string
|
||||||
|
|
||||||
|
// IDPFlow are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// in the array of allowed client "flows" for each returned identity provider.
|
||||||
|
type IDPFlow string
|
||||||
|
|
||||||
|
const (
|
||||||
|
IDPTypeOIDC IDPType = "oidc"
|
||||||
|
IDPTypeLDAP IDPType = "ldap"
|
||||||
|
IDPTypeActiveDirectory IDPType = "activedirectory"
|
||||||
|
|
||||||
|
IDPFlowCLIPassword IDPFlow = "cli_password"
|
||||||
|
IDPFlowBrowserAuthcode IDPFlow = "browser_authcode"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPType to a string.
|
||||||
|
func (r IDPType) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPType to a string.
|
||||||
|
func (r IDPType) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponse is part of the response from a FederationDomain's OpenID Provider Configuration
|
||||||
|
// Document returned by the .well-known/openid-configuration endpoint. It ignores all the standard OpenID Provider
|
||||||
|
// configuration metadata and only picks out the portion related to Supervisor identity provider discovery.
|
||||||
|
type OIDCDiscoveryResponse struct {
|
||||||
|
SupervisorDiscovery OIDCDiscoveryResponseIDPEndpoint `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponseIDPEndpoint contains the URL for the identity provider discovery endpoint.
|
||||||
|
type OIDCDiscoveryResponseIDPEndpoint struct {
|
||||||
|
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IDPDiscoveryResponse is the response of a FederationDomain's identity provider discovery endpoint.
|
||||||
|
type IDPDiscoveryResponse struct {
|
||||||
|
PinnipedIDPs []PinnipedIDP `json:"pinniped_identity_providers"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinnipedIDP describes a single identity provider as included in the response of a FederationDomain's
|
||||||
|
// identity provider discovery endpoint.
|
||||||
|
type PinnipedIDP struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type IDPType `json:"type"`
|
||||||
|
Flows []IDPFlow `json:"flows,omitempty"`
|
||||||
|
}
|
25
generated/1.17/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
25
generated/1.17/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package oidc
|
||||||
|
|
||||||
|
// Constants related to the Supervisor FederationDomain's authorization and token endpoints.
|
||||||
|
const (
|
||||||
|
// AuthorizeUsernameHeaderName is the name of the HTTP header which can be used to transmit a username
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizeUsernameHeaderName = "Pinniped-Username"
|
||||||
|
|
||||||
|
// AuthorizePasswordHeaderName is the name of the HTTP header which can be used to transmit a password
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizePasswordHeaderName = "Pinniped-Password" //nolint:gosec // this is not a credential
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPNameParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the name of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPNameParamName = "pinniped_idp_name"
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPTypeParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the type of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPTypeParamName = "pinniped_idp_type"
|
||||||
|
)
|
@ -59,11 +59,44 @@ spec:
|
|||||||
additionalScopes:
|
additionalScopes:
|
||||||
description: AdditionalScopes are the scopes in addition to "openid"
|
description: AdditionalScopes are the scopes in addition to "openid"
|
||||||
that will be requested as part of the authorization request
|
that will be requested as part of the authorization request
|
||||||
flow with an OIDC identity provider. By default only the "openid"
|
flow with an OIDC identity provider. In the case of a Resource
|
||||||
scope will be requested.
|
Owner Password Credentials Grant flow, AdditionalScopes are
|
||||||
|
the scopes in addition to "openid" that will be requested as
|
||||||
|
part of the token request (see also the allowPasswordGrant field).
|
||||||
|
By default, only the "openid" scope will be requested.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
type: array
|
type: array
|
||||||
|
allowPasswordGrant:
|
||||||
|
description: AllowPasswordGrant, when true, will allow the use
|
||||||
|
of OAuth 2.0's Resource Owner Password Credentials Grant (see
|
||||||
|
https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to
|
||||||
|
authenticate to the OIDC provider using a username and password
|
||||||
|
without a web browser, in addition to the usual browser-based
|
||||||
|
OIDC Authorization Code Flow. The Resource Owner Password Credentials
|
||||||
|
Grant is not officially part of the OIDC specification, so it
|
||||||
|
may not be supported by your OIDC provider. If your OIDC provider
|
||||||
|
supports returning ID tokens from a Resource Owner Password
|
||||||
|
Credentials Grant token request, then you can choose to set
|
||||||
|
this field to true. This will allow end users to choose to present
|
||||||
|
their username and password to the kubectl CLI (using the Pinniped
|
||||||
|
plugin) to authenticate to the cluster, without using a web
|
||||||
|
browser to log in as is customary in OIDC Authorization Code
|
||||||
|
Flow. This may be convenient for users, especially for identities
|
||||||
|
from your OIDC provider which are not intended to represent
|
||||||
|
a human actor, such as service accounts performing actions in
|
||||||
|
a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
you may wish to disable this behavior by setting this field
|
||||||
|
to false when you prefer to only allow users of this OIDCIdentityProvider
|
||||||
|
to log in via the browser-based OIDC Authorization Code Flow.
|
||||||
|
Using the Resource Owner Password Credentials Grant means that
|
||||||
|
the Pinniped CLI and Pinniped Supervisor will directly handle
|
||||||
|
your end users' passwords (similar to LDAPIdentityProvider),
|
||||||
|
and you will not be able to require multi-factor authentication
|
||||||
|
or use the other web-based login features of your OIDC provider
|
||||||
|
during Resource Owner Password Credentials Grant logins. AllowPasswordGrant
|
||||||
|
defaults to false.
|
||||||
|
type: boolean
|
||||||
type: object
|
type: object
|
||||||
claims:
|
claims:
|
||||||
description: Claims provides the names of token claims that will be
|
description: Claims provides the names of token claims that will be
|
||||||
|
3
generated/1.18/README.adoc
generated
3
generated/1.18/README.adoc
generated
@ -1099,7 +1099,8 @@ OIDCAuthorizationConfig provides information about how to form the OAuth2 author
|
|||||||
[cols="25a,75a", options="header"]
|
[cols="25a,75a", options="header"]
|
||||||
|===
|
|===
|
||||||
| Field | Description
|
| Field | Description
|
||||||
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field). By default, only the "openid" scope will be requested.
|
||||||
|
| *`allowPasswordGrant`* __boolean__ | AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow. The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be convenient for users, especially for identities from your OIDC provider which are not intended to represent a human actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it, you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins. AllowPasswordGrant defaults to false.
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
package v1alpha1
|
package v1alpha1
|
||||||
@ -39,9 +39,31 @@ type OIDCIdentityProviderStatus struct {
|
|||||||
// request parameters.
|
// request parameters.
|
||||||
type OIDCAuthorizationConfig struct {
|
type OIDCAuthorizationConfig struct {
|
||||||
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
||||||
// request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
// request flow with an OIDC identity provider.
|
||||||
|
// In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes
|
||||||
|
// in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field).
|
||||||
|
// By default, only the "openid" scope will be requested.
|
||||||
// +optional
|
// +optional
|
||||||
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
||||||
|
|
||||||
|
// AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant
|
||||||
|
// (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a
|
||||||
|
// username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow.
|
||||||
|
// The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be
|
||||||
|
// supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password
|
||||||
|
// Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose
|
||||||
|
// to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the
|
||||||
|
// cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be
|
||||||
|
// convenient for users, especially for identities from your OIDC provider which are not intended to represent a human
|
||||||
|
// actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
// you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this
|
||||||
|
// OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password
|
||||||
|
// Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords
|
||||||
|
// (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other
|
||||||
|
// web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins.
|
||||||
|
// AllowPasswordGrant defaults to false.
|
||||||
|
// +optional
|
||||||
|
AllowPasswordGrant bool `json:"allowPasswordGrant,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// OIDCClaims provides a mapping from upstream claims into identities.
|
// OIDCClaims provides a mapping from upstream claims into identities.
|
||||||
|
66
generated/1.18/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
66
generated/1.18/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package v1alpha1
|
||||||
|
|
||||||
|
// IDPType are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// as the "type" of each returned identity provider.
|
||||||
|
type IDPType string
|
||||||
|
|
||||||
|
// IDPFlow are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// in the array of allowed client "flows" for each returned identity provider.
|
||||||
|
type IDPFlow string
|
||||||
|
|
||||||
|
const (
|
||||||
|
IDPTypeOIDC IDPType = "oidc"
|
||||||
|
IDPTypeLDAP IDPType = "ldap"
|
||||||
|
IDPTypeActiveDirectory IDPType = "activedirectory"
|
||||||
|
|
||||||
|
IDPFlowCLIPassword IDPFlow = "cli_password"
|
||||||
|
IDPFlowBrowserAuthcode IDPFlow = "browser_authcode"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPType to a string.
|
||||||
|
func (r IDPType) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPType to a string.
|
||||||
|
func (r IDPType) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponse is part of the response from a FederationDomain's OpenID Provider Configuration
|
||||||
|
// Document returned by the .well-known/openid-configuration endpoint. It ignores all the standard OpenID Provider
|
||||||
|
// configuration metadata and only picks out the portion related to Supervisor identity provider discovery.
|
||||||
|
type OIDCDiscoveryResponse struct {
|
||||||
|
SupervisorDiscovery OIDCDiscoveryResponseIDPEndpoint `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponseIDPEndpoint contains the URL for the identity provider discovery endpoint.
|
||||||
|
type OIDCDiscoveryResponseIDPEndpoint struct {
|
||||||
|
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IDPDiscoveryResponse is the response of a FederationDomain's identity provider discovery endpoint.
|
||||||
|
type IDPDiscoveryResponse struct {
|
||||||
|
PinnipedIDPs []PinnipedIDP `json:"pinniped_identity_providers"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinnipedIDP describes a single identity provider as included in the response of a FederationDomain's
|
||||||
|
// identity provider discovery endpoint.
|
||||||
|
type PinnipedIDP struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type IDPType `json:"type"`
|
||||||
|
Flows []IDPFlow `json:"flows,omitempty"`
|
||||||
|
}
|
25
generated/1.18/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
25
generated/1.18/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package oidc
|
||||||
|
|
||||||
|
// Constants related to the Supervisor FederationDomain's authorization and token endpoints.
|
||||||
|
const (
|
||||||
|
// AuthorizeUsernameHeaderName is the name of the HTTP header which can be used to transmit a username
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizeUsernameHeaderName = "Pinniped-Username"
|
||||||
|
|
||||||
|
// AuthorizePasswordHeaderName is the name of the HTTP header which can be used to transmit a password
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizePasswordHeaderName = "Pinniped-Password" //nolint:gosec // this is not a credential
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPNameParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the name of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPNameParamName = "pinniped_idp_name"
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPTypeParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the type of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPTypeParamName = "pinniped_idp_type"
|
||||||
|
)
|
@ -59,11 +59,44 @@ spec:
|
|||||||
additionalScopes:
|
additionalScopes:
|
||||||
description: AdditionalScopes are the scopes in addition to "openid"
|
description: AdditionalScopes are the scopes in addition to "openid"
|
||||||
that will be requested as part of the authorization request
|
that will be requested as part of the authorization request
|
||||||
flow with an OIDC identity provider. By default only the "openid"
|
flow with an OIDC identity provider. In the case of a Resource
|
||||||
scope will be requested.
|
Owner Password Credentials Grant flow, AdditionalScopes are
|
||||||
|
the scopes in addition to "openid" that will be requested as
|
||||||
|
part of the token request (see also the allowPasswordGrant field).
|
||||||
|
By default, only the "openid" scope will be requested.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
type: array
|
type: array
|
||||||
|
allowPasswordGrant:
|
||||||
|
description: AllowPasswordGrant, when true, will allow the use
|
||||||
|
of OAuth 2.0's Resource Owner Password Credentials Grant (see
|
||||||
|
https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to
|
||||||
|
authenticate to the OIDC provider using a username and password
|
||||||
|
without a web browser, in addition to the usual browser-based
|
||||||
|
OIDC Authorization Code Flow. The Resource Owner Password Credentials
|
||||||
|
Grant is not officially part of the OIDC specification, so it
|
||||||
|
may not be supported by your OIDC provider. If your OIDC provider
|
||||||
|
supports returning ID tokens from a Resource Owner Password
|
||||||
|
Credentials Grant token request, then you can choose to set
|
||||||
|
this field to true. This will allow end users to choose to present
|
||||||
|
their username and password to the kubectl CLI (using the Pinniped
|
||||||
|
plugin) to authenticate to the cluster, without using a web
|
||||||
|
browser to log in as is customary in OIDC Authorization Code
|
||||||
|
Flow. This may be convenient for users, especially for identities
|
||||||
|
from your OIDC provider which are not intended to represent
|
||||||
|
a human actor, such as service accounts performing actions in
|
||||||
|
a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
you may wish to disable this behavior by setting this field
|
||||||
|
to false when you prefer to only allow users of this OIDCIdentityProvider
|
||||||
|
to log in via the browser-based OIDC Authorization Code Flow.
|
||||||
|
Using the Resource Owner Password Credentials Grant means that
|
||||||
|
the Pinniped CLI and Pinniped Supervisor will directly handle
|
||||||
|
your end users' passwords (similar to LDAPIdentityProvider),
|
||||||
|
and you will not be able to require multi-factor authentication
|
||||||
|
or use the other web-based login features of your OIDC provider
|
||||||
|
during Resource Owner Password Credentials Grant logins. AllowPasswordGrant
|
||||||
|
defaults to false.
|
||||||
|
type: boolean
|
||||||
type: object
|
type: object
|
||||||
claims:
|
claims:
|
||||||
description: Claims provides the names of token claims that will be
|
description: Claims provides the names of token claims that will be
|
||||||
|
3
generated/1.19/README.adoc
generated
3
generated/1.19/README.adoc
generated
@ -1099,7 +1099,8 @@ OIDCAuthorizationConfig provides information about how to form the OAuth2 author
|
|||||||
[cols="25a,75a", options="header"]
|
[cols="25a,75a", options="header"]
|
||||||
|===
|
|===
|
||||||
| Field | Description
|
| Field | Description
|
||||||
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field). By default, only the "openid" scope will be requested.
|
||||||
|
| *`allowPasswordGrant`* __boolean__ | AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow. The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be convenient for users, especially for identities from your OIDC provider which are not intended to represent a human actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it, you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins. AllowPasswordGrant defaults to false.
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
package v1alpha1
|
package v1alpha1
|
||||||
@ -39,9 +39,31 @@ type OIDCIdentityProviderStatus struct {
|
|||||||
// request parameters.
|
// request parameters.
|
||||||
type OIDCAuthorizationConfig struct {
|
type OIDCAuthorizationConfig struct {
|
||||||
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
||||||
// request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
// request flow with an OIDC identity provider.
|
||||||
|
// In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes
|
||||||
|
// in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field).
|
||||||
|
// By default, only the "openid" scope will be requested.
|
||||||
// +optional
|
// +optional
|
||||||
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
||||||
|
|
||||||
|
// AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant
|
||||||
|
// (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a
|
||||||
|
// username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow.
|
||||||
|
// The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be
|
||||||
|
// supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password
|
||||||
|
// Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose
|
||||||
|
// to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the
|
||||||
|
// cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be
|
||||||
|
// convenient for users, especially for identities from your OIDC provider which are not intended to represent a human
|
||||||
|
// actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
// you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this
|
||||||
|
// OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password
|
||||||
|
// Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords
|
||||||
|
// (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other
|
||||||
|
// web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins.
|
||||||
|
// AllowPasswordGrant defaults to false.
|
||||||
|
// +optional
|
||||||
|
AllowPasswordGrant bool `json:"allowPasswordGrant,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// OIDCClaims provides a mapping from upstream claims into identities.
|
// OIDCClaims provides a mapping from upstream claims into identities.
|
||||||
|
66
generated/1.19/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
66
generated/1.19/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package v1alpha1
|
||||||
|
|
||||||
|
// IDPType are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// as the "type" of each returned identity provider.
|
||||||
|
type IDPType string
|
||||||
|
|
||||||
|
// IDPFlow are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// in the array of allowed client "flows" for each returned identity provider.
|
||||||
|
type IDPFlow string
|
||||||
|
|
||||||
|
const (
|
||||||
|
IDPTypeOIDC IDPType = "oidc"
|
||||||
|
IDPTypeLDAP IDPType = "ldap"
|
||||||
|
IDPTypeActiveDirectory IDPType = "activedirectory"
|
||||||
|
|
||||||
|
IDPFlowCLIPassword IDPFlow = "cli_password"
|
||||||
|
IDPFlowBrowserAuthcode IDPFlow = "browser_authcode"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPType to a string.
|
||||||
|
func (r IDPType) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPType to a string.
|
||||||
|
func (r IDPType) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponse is part of the response from a FederationDomain's OpenID Provider Configuration
|
||||||
|
// Document returned by the .well-known/openid-configuration endpoint. It ignores all the standard OpenID Provider
|
||||||
|
// configuration metadata and only picks out the portion related to Supervisor identity provider discovery.
|
||||||
|
type OIDCDiscoveryResponse struct {
|
||||||
|
SupervisorDiscovery OIDCDiscoveryResponseIDPEndpoint `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponseIDPEndpoint contains the URL for the identity provider discovery endpoint.
|
||||||
|
type OIDCDiscoveryResponseIDPEndpoint struct {
|
||||||
|
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IDPDiscoveryResponse is the response of a FederationDomain's identity provider discovery endpoint.
|
||||||
|
type IDPDiscoveryResponse struct {
|
||||||
|
PinnipedIDPs []PinnipedIDP `json:"pinniped_identity_providers"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinnipedIDP describes a single identity provider as included in the response of a FederationDomain's
|
||||||
|
// identity provider discovery endpoint.
|
||||||
|
type PinnipedIDP struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type IDPType `json:"type"`
|
||||||
|
Flows []IDPFlow `json:"flows,omitempty"`
|
||||||
|
}
|
25
generated/1.19/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
25
generated/1.19/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package oidc
|
||||||
|
|
||||||
|
// Constants related to the Supervisor FederationDomain's authorization and token endpoints.
|
||||||
|
const (
|
||||||
|
// AuthorizeUsernameHeaderName is the name of the HTTP header which can be used to transmit a username
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizeUsernameHeaderName = "Pinniped-Username"
|
||||||
|
|
||||||
|
// AuthorizePasswordHeaderName is the name of the HTTP header which can be used to transmit a password
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizePasswordHeaderName = "Pinniped-Password" //nolint:gosec // this is not a credential
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPNameParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the name of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPNameParamName = "pinniped_idp_name"
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPTypeParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the type of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPTypeParamName = "pinniped_idp_type"
|
||||||
|
)
|
@ -59,11 +59,44 @@ spec:
|
|||||||
additionalScopes:
|
additionalScopes:
|
||||||
description: AdditionalScopes are the scopes in addition to "openid"
|
description: AdditionalScopes are the scopes in addition to "openid"
|
||||||
that will be requested as part of the authorization request
|
that will be requested as part of the authorization request
|
||||||
flow with an OIDC identity provider. By default only the "openid"
|
flow with an OIDC identity provider. In the case of a Resource
|
||||||
scope will be requested.
|
Owner Password Credentials Grant flow, AdditionalScopes are
|
||||||
|
the scopes in addition to "openid" that will be requested as
|
||||||
|
part of the token request (see also the allowPasswordGrant field).
|
||||||
|
By default, only the "openid" scope will be requested.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
type: array
|
type: array
|
||||||
|
allowPasswordGrant:
|
||||||
|
description: AllowPasswordGrant, when true, will allow the use
|
||||||
|
of OAuth 2.0's Resource Owner Password Credentials Grant (see
|
||||||
|
https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to
|
||||||
|
authenticate to the OIDC provider using a username and password
|
||||||
|
without a web browser, in addition to the usual browser-based
|
||||||
|
OIDC Authorization Code Flow. The Resource Owner Password Credentials
|
||||||
|
Grant is not officially part of the OIDC specification, so it
|
||||||
|
may not be supported by your OIDC provider. If your OIDC provider
|
||||||
|
supports returning ID tokens from a Resource Owner Password
|
||||||
|
Credentials Grant token request, then you can choose to set
|
||||||
|
this field to true. This will allow end users to choose to present
|
||||||
|
their username and password to the kubectl CLI (using the Pinniped
|
||||||
|
plugin) to authenticate to the cluster, without using a web
|
||||||
|
browser to log in as is customary in OIDC Authorization Code
|
||||||
|
Flow. This may be convenient for users, especially for identities
|
||||||
|
from your OIDC provider which are not intended to represent
|
||||||
|
a human actor, such as service accounts performing actions in
|
||||||
|
a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
you may wish to disable this behavior by setting this field
|
||||||
|
to false when you prefer to only allow users of this OIDCIdentityProvider
|
||||||
|
to log in via the browser-based OIDC Authorization Code Flow.
|
||||||
|
Using the Resource Owner Password Credentials Grant means that
|
||||||
|
the Pinniped CLI and Pinniped Supervisor will directly handle
|
||||||
|
your end users' passwords (similar to LDAPIdentityProvider),
|
||||||
|
and you will not be able to require multi-factor authentication
|
||||||
|
or use the other web-based login features of your OIDC provider
|
||||||
|
during Resource Owner Password Credentials Grant logins. AllowPasswordGrant
|
||||||
|
defaults to false.
|
||||||
|
type: boolean
|
||||||
type: object
|
type: object
|
||||||
claims:
|
claims:
|
||||||
description: Claims provides the names of token claims that will be
|
description: Claims provides the names of token claims that will be
|
||||||
|
3
generated/1.20/README.adoc
generated
3
generated/1.20/README.adoc
generated
@ -1099,7 +1099,8 @@ OIDCAuthorizationConfig provides information about how to form the OAuth2 author
|
|||||||
[cols="25a,75a", options="header"]
|
[cols="25a,75a", options="header"]
|
||||||
|===
|
|===
|
||||||
| Field | Description
|
| Field | Description
|
||||||
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
| *`additionalScopes`* __string array__ | AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization request flow with an OIDC identity provider. In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field). By default, only the "openid" scope will be requested.
|
||||||
|
| *`allowPasswordGrant`* __boolean__ | AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow. The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be convenient for users, especially for identities from your OIDC provider which are not intended to represent a human actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it, you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins. AllowPasswordGrant defaults to false.
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
package v1alpha1
|
package v1alpha1
|
||||||
@ -39,9 +39,31 @@ type OIDCIdentityProviderStatus struct {
|
|||||||
// request parameters.
|
// request parameters.
|
||||||
type OIDCAuthorizationConfig struct {
|
type OIDCAuthorizationConfig struct {
|
||||||
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
||||||
// request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
// request flow with an OIDC identity provider.
|
||||||
|
// In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes
|
||||||
|
// in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field).
|
||||||
|
// By default, only the "openid" scope will be requested.
|
||||||
// +optional
|
// +optional
|
||||||
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
||||||
|
|
||||||
|
// AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant
|
||||||
|
// (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a
|
||||||
|
// username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow.
|
||||||
|
// The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be
|
||||||
|
// supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password
|
||||||
|
// Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose
|
||||||
|
// to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the
|
||||||
|
// cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be
|
||||||
|
// convenient for users, especially for identities from your OIDC provider which are not intended to represent a human
|
||||||
|
// actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
// you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this
|
||||||
|
// OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password
|
||||||
|
// Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords
|
||||||
|
// (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other
|
||||||
|
// web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins.
|
||||||
|
// AllowPasswordGrant defaults to false.
|
||||||
|
// +optional
|
||||||
|
AllowPasswordGrant bool `json:"allowPasswordGrant,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// OIDCClaims provides a mapping from upstream claims into identities.
|
// OIDCClaims provides a mapping from upstream claims into identities.
|
||||||
|
66
generated/1.20/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
66
generated/1.20/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package v1alpha1
|
||||||
|
|
||||||
|
// IDPType are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// as the "type" of each returned identity provider.
|
||||||
|
type IDPType string
|
||||||
|
|
||||||
|
// IDPFlow are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// in the array of allowed client "flows" for each returned identity provider.
|
||||||
|
type IDPFlow string
|
||||||
|
|
||||||
|
const (
|
||||||
|
IDPTypeOIDC IDPType = "oidc"
|
||||||
|
IDPTypeLDAP IDPType = "ldap"
|
||||||
|
IDPTypeActiveDirectory IDPType = "activedirectory"
|
||||||
|
|
||||||
|
IDPFlowCLIPassword IDPFlow = "cli_password"
|
||||||
|
IDPFlowBrowserAuthcode IDPFlow = "browser_authcode"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPType to a string.
|
||||||
|
func (r IDPType) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPType to a string.
|
||||||
|
func (r IDPType) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponse is part of the response from a FederationDomain's OpenID Provider Configuration
|
||||||
|
// Document returned by the .well-known/openid-configuration endpoint. It ignores all the standard OpenID Provider
|
||||||
|
// configuration metadata and only picks out the portion related to Supervisor identity provider discovery.
|
||||||
|
type OIDCDiscoveryResponse struct {
|
||||||
|
SupervisorDiscovery OIDCDiscoveryResponseIDPEndpoint `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponseIDPEndpoint contains the URL for the identity provider discovery endpoint.
|
||||||
|
type OIDCDiscoveryResponseIDPEndpoint struct {
|
||||||
|
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IDPDiscoveryResponse is the response of a FederationDomain's identity provider discovery endpoint.
|
||||||
|
type IDPDiscoveryResponse struct {
|
||||||
|
PinnipedIDPs []PinnipedIDP `json:"pinniped_identity_providers"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinnipedIDP describes a single identity provider as included in the response of a FederationDomain's
|
||||||
|
// identity provider discovery endpoint.
|
||||||
|
type PinnipedIDP struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type IDPType `json:"type"`
|
||||||
|
Flows []IDPFlow `json:"flows,omitempty"`
|
||||||
|
}
|
25
generated/1.20/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
25
generated/1.20/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package oidc
|
||||||
|
|
||||||
|
// Constants related to the Supervisor FederationDomain's authorization and token endpoints.
|
||||||
|
const (
|
||||||
|
// AuthorizeUsernameHeaderName is the name of the HTTP header which can be used to transmit a username
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizeUsernameHeaderName = "Pinniped-Username"
|
||||||
|
|
||||||
|
// AuthorizePasswordHeaderName is the name of the HTTP header which can be used to transmit a password
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizePasswordHeaderName = "Pinniped-Password" //nolint:gosec // this is not a credential
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPNameParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the name of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPNameParamName = "pinniped_idp_name"
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPTypeParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the type of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPTypeParamName = "pinniped_idp_type"
|
||||||
|
)
|
@ -59,11 +59,44 @@ spec:
|
|||||||
additionalScopes:
|
additionalScopes:
|
||||||
description: AdditionalScopes are the scopes in addition to "openid"
|
description: AdditionalScopes are the scopes in addition to "openid"
|
||||||
that will be requested as part of the authorization request
|
that will be requested as part of the authorization request
|
||||||
flow with an OIDC identity provider. By default only the "openid"
|
flow with an OIDC identity provider. In the case of a Resource
|
||||||
scope will be requested.
|
Owner Password Credentials Grant flow, AdditionalScopes are
|
||||||
|
the scopes in addition to "openid" that will be requested as
|
||||||
|
part of the token request (see also the allowPasswordGrant field).
|
||||||
|
By default, only the "openid" scope will be requested.
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
type: array
|
type: array
|
||||||
|
allowPasswordGrant:
|
||||||
|
description: AllowPasswordGrant, when true, will allow the use
|
||||||
|
of OAuth 2.0's Resource Owner Password Credentials Grant (see
|
||||||
|
https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to
|
||||||
|
authenticate to the OIDC provider using a username and password
|
||||||
|
without a web browser, in addition to the usual browser-based
|
||||||
|
OIDC Authorization Code Flow. The Resource Owner Password Credentials
|
||||||
|
Grant is not officially part of the OIDC specification, so it
|
||||||
|
may not be supported by your OIDC provider. If your OIDC provider
|
||||||
|
supports returning ID tokens from a Resource Owner Password
|
||||||
|
Credentials Grant token request, then you can choose to set
|
||||||
|
this field to true. This will allow end users to choose to present
|
||||||
|
their username and password to the kubectl CLI (using the Pinniped
|
||||||
|
plugin) to authenticate to the cluster, without using a web
|
||||||
|
browser to log in as is customary in OIDC Authorization Code
|
||||||
|
Flow. This may be convenient for users, especially for identities
|
||||||
|
from your OIDC provider which are not intended to represent
|
||||||
|
a human actor, such as service accounts performing actions in
|
||||||
|
a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
you may wish to disable this behavior by setting this field
|
||||||
|
to false when you prefer to only allow users of this OIDCIdentityProvider
|
||||||
|
to log in via the browser-based OIDC Authorization Code Flow.
|
||||||
|
Using the Resource Owner Password Credentials Grant means that
|
||||||
|
the Pinniped CLI and Pinniped Supervisor will directly handle
|
||||||
|
your end users' passwords (similar to LDAPIdentityProvider),
|
||||||
|
and you will not be able to require multi-factor authentication
|
||||||
|
or use the other web-based login features of your OIDC provider
|
||||||
|
during Resource Owner Password Credentials Grant logins. AllowPasswordGrant
|
||||||
|
defaults to false.
|
||||||
|
type: boolean
|
||||||
type: object
|
type: object
|
||||||
claims:
|
claims:
|
||||||
description: Claims provides the names of token claims that will be
|
description: Claims provides the names of token claims that will be
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
package v1alpha1
|
package v1alpha1
|
||||||
@ -39,9 +39,31 @@ type OIDCIdentityProviderStatus struct {
|
|||||||
// request parameters.
|
// request parameters.
|
||||||
type OIDCAuthorizationConfig struct {
|
type OIDCAuthorizationConfig struct {
|
||||||
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
// AdditionalScopes are the scopes in addition to "openid" that will be requested as part of the authorization
|
||||||
// request flow with an OIDC identity provider. By default only the "openid" scope will be requested.
|
// request flow with an OIDC identity provider.
|
||||||
|
// In the case of a Resource Owner Password Credentials Grant flow, AdditionalScopes are the scopes
|
||||||
|
// in addition to "openid" that will be requested as part of the token request (see also the allowPasswordGrant field).
|
||||||
|
// By default, only the "openid" scope will be requested.
|
||||||
// +optional
|
// +optional
|
||||||
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
AdditionalScopes []string `json:"additionalScopes,omitempty"`
|
||||||
|
|
||||||
|
// AllowPasswordGrant, when true, will allow the use of OAuth 2.0's Resource Owner Password Credentials Grant
|
||||||
|
// (see https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) to authenticate to the OIDC provider using a
|
||||||
|
// username and password without a web browser, in addition to the usual browser-based OIDC Authorization Code Flow.
|
||||||
|
// The Resource Owner Password Credentials Grant is not officially part of the OIDC specification, so it may not be
|
||||||
|
// supported by your OIDC provider. If your OIDC provider supports returning ID tokens from a Resource Owner Password
|
||||||
|
// Credentials Grant token request, then you can choose to set this field to true. This will allow end users to choose
|
||||||
|
// to present their username and password to the kubectl CLI (using the Pinniped plugin) to authenticate to the
|
||||||
|
// cluster, without using a web browser to log in as is customary in OIDC Authorization Code Flow. This may be
|
||||||
|
// convenient for users, especially for identities from your OIDC provider which are not intended to represent a human
|
||||||
|
// actor, such as service accounts performing actions in a CI/CD environment. Even if your OIDC provider supports it,
|
||||||
|
// you may wish to disable this behavior by setting this field to false when you prefer to only allow users of this
|
||||||
|
// OIDCIdentityProvider to log in via the browser-based OIDC Authorization Code Flow. Using the Resource Owner Password
|
||||||
|
// Credentials Grant means that the Pinniped CLI and Pinniped Supervisor will directly handle your end users' passwords
|
||||||
|
// (similar to LDAPIdentityProvider), and you will not be able to require multi-factor authentication or use the other
|
||||||
|
// web-based login features of your OIDC provider during Resource Owner Password Credentials Grant logins.
|
||||||
|
// AllowPasswordGrant defaults to false.
|
||||||
|
// +optional
|
||||||
|
AllowPasswordGrant bool `json:"allowPasswordGrant,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// OIDCClaims provides a mapping from upstream claims into identities.
|
// OIDCClaims provides a mapping from upstream claims into identities.
|
||||||
|
66
generated/latest/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
66
generated/latest/apis/supervisor/idpdiscovery/v1alpha1/types_supervisor_idp_discovery.go
generated
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package v1alpha1
|
||||||
|
|
||||||
|
// IDPType are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// as the "type" of each returned identity provider.
|
||||||
|
type IDPType string
|
||||||
|
|
||||||
|
// IDPFlow are the strings that can be returned by the Supervisor identity provider discovery endpoint
|
||||||
|
// in the array of allowed client "flows" for each returned identity provider.
|
||||||
|
type IDPFlow string
|
||||||
|
|
||||||
|
const (
|
||||||
|
IDPTypeOIDC IDPType = "oidc"
|
||||||
|
IDPTypeLDAP IDPType = "ldap"
|
||||||
|
IDPTypeActiveDirectory IDPType = "activedirectory"
|
||||||
|
|
||||||
|
IDPFlowCLIPassword IDPFlow = "cli_password"
|
||||||
|
IDPFlowBrowserAuthcode IDPFlow = "browser_authcode"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPType to a string.
|
||||||
|
func (r IDPType) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPType to a string.
|
||||||
|
func (r IDPType) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equals is a convenience function for comparing an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) Equals(s string) bool {
|
||||||
|
return string(r) == s
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is a convenience function to convert an IDPFlow to a string.
|
||||||
|
func (r IDPFlow) String() string {
|
||||||
|
return string(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponse is part of the response from a FederationDomain's OpenID Provider Configuration
|
||||||
|
// Document returned by the .well-known/openid-configuration endpoint. It ignores all the standard OpenID Provider
|
||||||
|
// configuration metadata and only picks out the portion related to Supervisor identity provider discovery.
|
||||||
|
type OIDCDiscoveryResponse struct {
|
||||||
|
SupervisorDiscovery OIDCDiscoveryResponseIDPEndpoint `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OIDCDiscoveryResponseIDPEndpoint contains the URL for the identity provider discovery endpoint.
|
||||||
|
type OIDCDiscoveryResponseIDPEndpoint struct {
|
||||||
|
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IDPDiscoveryResponse is the response of a FederationDomain's identity provider discovery endpoint.
|
||||||
|
type IDPDiscoveryResponse struct {
|
||||||
|
PinnipedIDPs []PinnipedIDP `json:"pinniped_identity_providers"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinnipedIDP describes a single identity provider as included in the response of a FederationDomain's
|
||||||
|
// identity provider discovery endpoint.
|
||||||
|
type PinnipedIDP struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type IDPType `json:"type"`
|
||||||
|
Flows []IDPFlow `json:"flows,omitempty"`
|
||||||
|
}
|
25
generated/latest/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
25
generated/latest/apis/supervisor/oidc/types_supervisor_oidc.go
generated
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package oidc
|
||||||
|
|
||||||
|
// Constants related to the Supervisor FederationDomain's authorization and token endpoints.
|
||||||
|
const (
|
||||||
|
// AuthorizeUsernameHeaderName is the name of the HTTP header which can be used to transmit a username
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizeUsernameHeaderName = "Pinniped-Username"
|
||||||
|
|
||||||
|
// AuthorizePasswordHeaderName is the name of the HTTP header which can be used to transmit a password
|
||||||
|
// to the authorize endpoint when using a password flow, for example an OIDCIdentityProvider with a password grant
|
||||||
|
// or an LDAPIdentityProvider.
|
||||||
|
AuthorizePasswordHeaderName = "Pinniped-Password" //nolint:gosec // this is not a credential
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPNameParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the name of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPNameParamName = "pinniped_idp_name"
|
||||||
|
|
||||||
|
// AuthorizeUpstreamIDPTypeParamName is the name of the HTTP request parameter which can be used to help select which
|
||||||
|
// identity provider should be used for authentication by sending the type of the desired identity provider.
|
||||||
|
AuthorizeUpstreamIDPTypeParamName = "pinniped_idp_type"
|
||||||
|
)
|
17
go.mod
17
go.mod
@ -26,6 +26,7 @@ require (
|
|||||||
github.com/spf13/pflag v1.0.5
|
github.com/spf13/pflag v1.0.5
|
||||||
github.com/stretchr/testify v1.7.0
|
github.com/stretchr/testify v1.7.0
|
||||||
github.com/tdewolff/minify/v2 v2.9.21
|
github.com/tdewolff/minify/v2 v2.9.21
|
||||||
|
go.uber.org/atomic v1.7.0
|
||||||
golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a
|
golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a
|
||||||
golang.org/x/net v0.0.0-20210520170846-37e1c6afe023
|
golang.org/x/net v0.0.0-20210520170846-37e1c6afe023
|
||||||
golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602
|
golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602
|
||||||
@ -43,19 +44,3 @@ require (
|
|||||||
k8s.io/utils v0.0.0-20210707171843-4b05e18ac7d9
|
k8s.io/utils v0.0.0-20210707171843-4b05e18ac7d9
|
||||||
sigs.k8s.io/yaml v1.2.0
|
sigs.k8s.io/yaml v1.2.0
|
||||||
)
|
)
|
||||||
|
|
||||||
// Workaround a broken module version (see https://github.com/oleiade/reflections/issues/14).
|
|
||||||
// We need this until none of our deps tries to pull in v1.0.0, otherwise some tools like
|
|
||||||
// Dependabot will fail on our module.
|
|
||||||
replace github.com/oleiade/reflections v1.0.0 => github.com/oleiade/reflections v1.0.1
|
|
||||||
|
|
||||||
// We were never vulnerable to CVE-2020-26160 but this avoids future issues
|
|
||||||
// This fork is not particularly better though:
|
|
||||||
// https://github.com/form3tech-oss/jwt-go/issues/7
|
|
||||||
// We use the SHA of github.com/form3tech-oss/jwt-go@v3.2.2 to get around "used for two different module paths"
|
|
||||||
// https://golang.org/issues/26904
|
|
||||||
replace github.com/dgrijalva/jwt-go v3.2.0+incompatible => github.com/form3tech-oss/jwt-go v0.0.0-20200915135329-9162a5abdbc0
|
|
||||||
|
|
||||||
// Pin a gRPC module that's only used in some tests.
|
|
||||||
// This is required because sometime after v1.29.1, they moved this package into a separate module.
|
|
||||||
replace google.golang.org/grpc/examples => ./hack/dependencyhacks/grpcexamples/
|
|
||||||
|
4
go.sum
4
go.sum
@ -182,6 +182,7 @@ github.com/dgraph-io/ristretto v0.0.1/go.mod h1:T40EBc7CJke8TkpiYfGGKAeFjSaxuFXh
|
|||||||
github.com/dgraph-io/ristretto v0.0.2/go.mod h1:KPxhHT9ZxKefz+PCeOGsrHpl1qZ7i70dGTu2u+Ahh6E=
|
github.com/dgraph-io/ristretto v0.0.2/go.mod h1:KPxhHT9ZxKefz+PCeOGsrHpl1qZ7i70dGTu2u+Ahh6E=
|
||||||
github.com/dgraph-io/ristretto v0.0.3 h1:jh22xisGBjrEVnRZ1DVTpBVQm0Xndu8sMl0CWDzSIBI=
|
github.com/dgraph-io/ristretto v0.0.3 h1:jh22xisGBjrEVnRZ1DVTpBVQm0Xndu8sMl0CWDzSIBI=
|
||||||
github.com/dgraph-io/ristretto v0.0.3/go.mod h1:KPxhHT9ZxKefz+PCeOGsrHpl1qZ7i70dGTu2u+Ahh6E=
|
github.com/dgraph-io/ristretto v0.0.3/go.mod h1:KPxhHT9ZxKefz+PCeOGsrHpl1qZ7i70dGTu2u+Ahh6E=
|
||||||
|
github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
|
||||||
github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2 h1:tdlZCpZ/P9DhczCTSixgIKmwPv6+wP5DGjqLYw5SUiA=
|
github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2 h1:tdlZCpZ/P9DhczCTSixgIKmwPv6+wP5DGjqLYw5SUiA=
|
||||||
github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2/go.mod h1:SqUrOPUnsFjfmXRMNPybcSiG0BgUW2AuFH8PAnS2iTw=
|
github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2/go.mod h1:SqUrOPUnsFjfmXRMNPybcSiG0BgUW2AuFH8PAnS2iTw=
|
||||||
github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no=
|
github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no=
|
||||||
@ -224,7 +225,6 @@ github.com/felixge/httpsnoop v1.0.1 h1:lvB5Jl89CsZtGIWuTcDM1E/vkVs49/Ml7JJe07l8S
|
|||||||
github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
|
github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
|
||||||
github.com/fogleman/gg v1.2.1-0.20190220221249-0403632d5b90/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k=
|
github.com/fogleman/gg v1.2.1-0.20190220221249-0403632d5b90/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k=
|
||||||
github.com/fogleman/gg v1.3.0/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k=
|
github.com/fogleman/gg v1.3.0/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k=
|
||||||
github.com/form3tech-oss/jwt-go v0.0.0-20200915135329-9162a5abdbc0/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
|
|
||||||
github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
|
github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
|
||||||
github.com/form3tech-oss/jwt-go v3.2.3+incompatible h1:7ZaBxOI7TMoYBfyA3cQHErNNyAWIKUMIwqxEtgHOs5c=
|
github.com/form3tech-oss/jwt-go v3.2.3+incompatible h1:7ZaBxOI7TMoYBfyA3cQHErNNyAWIKUMIwqxEtgHOs5c=
|
||||||
github.com/form3tech-oss/jwt-go v3.2.3+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
|
github.com/form3tech-oss/jwt-go v3.2.3+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
|
||||||
@ -930,6 +930,7 @@ github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLA
|
|||||||
github.com/nxadm/tail v1.4.4 h1:DQuhQpB1tVlglWS2hLQ5OV6B5r8aGxSrPc5Qo6uTN78=
|
github.com/nxadm/tail v1.4.4 h1:DQuhQpB1tVlglWS2hLQ5OV6B5r8aGxSrPc5Qo6uTN78=
|
||||||
github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
|
github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
|
||||||
github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
|
github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
|
||||||
|
github.com/oleiade/reflections v1.0.0/go.mod h1:RbATFBbKYkVdqmSFtx13Bb/tVhR0lgOBXunWTZKeL4w=
|
||||||
github.com/oleiade/reflections v1.0.1 h1:D1XO3LVEYroYskEsoSiGItp9RUxG6jWnCVvrqH0HHQM=
|
github.com/oleiade/reflections v1.0.1 h1:D1XO3LVEYroYskEsoSiGItp9RUxG6jWnCVvrqH0HHQM=
|
||||||
github.com/oleiade/reflections v1.0.1/go.mod h1:rdFxbxq4QXVZWj0F+e9jqjDkc7dbp97vkRixKo2JR60=
|
github.com/oleiade/reflections v1.0.1/go.mod h1:rdFxbxq4QXVZWj0F+e9jqjDkc7dbp97vkRixKo2JR60=
|
||||||
github.com/onsi/ginkgo v0.0.0-20170829012221-11459a886d9c/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
|
github.com/onsi/ginkgo v0.0.0-20170829012221-11459a886d9c/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
|
||||||
@ -1793,6 +1794,7 @@ google.golang.org/grpc v1.36.1/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAG
|
|||||||
google.golang.org/grpc v1.37.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM=
|
google.golang.org/grpc v1.37.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM=
|
||||||
google.golang.org/grpc v1.38.0 h1:/9BgsAsa5nWe26HqOlvlgJnqBuktYOLCgjCPqsa56W0=
|
google.golang.org/grpc v1.38.0 h1:/9BgsAsa5nWe26HqOlvlgJnqBuktYOLCgjCPqsa56W0=
|
||||||
google.golang.org/grpc v1.38.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM=
|
google.golang.org/grpc v1.38.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM=
|
||||||
|
google.golang.org/grpc/examples v0.0.0-20210304020650-930c79186c99/go.mod h1:Ly7ZA/ARzg8fnPU9TyZIxoz33sEUuWX7txiqs8lPTgE=
|
||||||
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
|
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
|
||||||
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
|
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
|
||||||
google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
|
google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
|
||||||
|
@ -1,3 +0,0 @@
|
|||||||
module google.golang.org/grpc/examples
|
|
||||||
|
|
||||||
go 1.14
|
|
@ -46,7 +46,7 @@ function with_modules() {
|
|||||||
env_vars="KUBE_CACHE_MUTATION_DETECTOR=${kube_cache_mutation_detector} KUBE_PANIC_WATCH_DECODE_ERROR=${kube_panic_watch_decode_error}"
|
env_vars="KUBE_CACHE_MUTATION_DETECTOR=${kube_cache_mutation_detector} KUBE_PANIC_WATCH_DECODE_ERROR=${kube_panic_watch_decode_error}"
|
||||||
|
|
||||||
pushd "${ROOT}" >/dev/null
|
pushd "${ROOT}" >/dev/null
|
||||||
for mod_file in $(find . -maxdepth 4 -not -path "./generated/*" -not -path "./hack/*" -name go.mod | sort); do
|
for mod_file in $(find . -maxdepth 4 -not -path "./generated/*" -name go.mod | sort); do
|
||||||
mod_dir="$(dirname "${mod_file}")"
|
mod_dir="$(dirname "${mod_file}")"
|
||||||
(
|
(
|
||||||
echo "=> "
|
echo "=> "
|
||||||
|
@ -102,7 +102,7 @@ func newInternal( //nolint:funlen // yeah, it's kind of long.
|
|||||||
|
|
||||||
// Wire up the impersonation proxy signer CA as another valid authenticator for client cert auth,
|
// Wire up the impersonation proxy signer CA as another valid authenticator for client cert auth,
|
||||||
// along with the Kube API server's CA.
|
// along with the Kube API server's CA.
|
||||||
// Note: any changes to the the Authentication stack need to be kept in sync with any assumptions made
|
// Note: any changes to the Authentication stack need to be kept in sync with any assumptions made
|
||||||
// by getTransportForUser, especially if we ever update the TCR API to start returning bearer tokens.
|
// by getTransportForUser, especially if we ever update the TCR API to start returning bearer tokens.
|
||||||
kubeClientUnsafeForProxying, err := kubeclient.New(clientOpts...)
|
kubeClientUnsafeForProxying, err := kubeclient.New(clientOpts...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@ -297,12 +297,7 @@ func TestExpirerControllerSync(t *testing.T) {
|
|||||||
|
|
||||||
if test.wantDelete {
|
if test.wantDelete {
|
||||||
require.Len(t, *opts, 1)
|
require.Len(t, *opts, 1)
|
||||||
require.Equal(t, metav1.DeleteOptions{
|
require.Equal(t, testutil.NewPreconditions(testUID, testRV), (*opts)[0])
|
||||||
Preconditions: &metav1.Preconditions{
|
|
||||||
UID: &testUID,
|
|
||||||
ResourceVersion: &testRV,
|
|
||||||
},
|
|
||||||
}, (*opts)[0])
|
|
||||||
} else {
|
} else {
|
||||||
require.Len(t, *opts, 0)
|
require.Len(t, *opts, 0)
|
||||||
}
|
}
|
||||||
|
@ -29,14 +29,12 @@ import (
|
|||||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
"k8s.io/apimachinery/pkg/runtime"
|
"k8s.io/apimachinery/pkg/runtime"
|
||||||
"k8s.io/apimachinery/pkg/runtime/schema"
|
"k8s.io/apimachinery/pkg/runtime/schema"
|
||||||
"k8s.io/apimachinery/pkg/types"
|
|
||||||
"k8s.io/apimachinery/pkg/util/clock"
|
"k8s.io/apimachinery/pkg/util/clock"
|
||||||
"k8s.io/apimachinery/pkg/util/intstr"
|
"k8s.io/apimachinery/pkg/util/intstr"
|
||||||
kubeinformers "k8s.io/client-go/informers"
|
kubeinformers "k8s.io/client-go/informers"
|
||||||
"k8s.io/client-go/kubernetes"
|
"k8s.io/client-go/kubernetes"
|
||||||
kubernetesfake "k8s.io/client-go/kubernetes/fake"
|
kubernetesfake "k8s.io/client-go/kubernetes/fake"
|
||||||
coretesting "k8s.io/client-go/testing"
|
coretesting "k8s.io/client-go/testing"
|
||||||
"k8s.io/utils/pointer"
|
|
||||||
|
|
||||||
"go.pinniped.dev/generated/latest/apis/concierge/config/v1alpha1"
|
"go.pinniped.dev/generated/latest/apis/concierge/config/v1alpha1"
|
||||||
pinnipedfake "go.pinniped.dev/generated/latest/client/concierge/clientset/versioned/fake"
|
pinnipedfake "go.pinniped.dev/generated/latest/client/concierge/clientset/versioned/fake"
|
||||||
@ -1032,13 +1030,7 @@ func TestImpersonatorConfigControllerSync(t *testing.T) {
|
|||||||
// validate that we set delete preconditions correctly
|
// validate that we set delete preconditions correctly
|
||||||
r.NotEmpty(*deleteOptions)
|
r.NotEmpty(*deleteOptions)
|
||||||
for _, opt := range *deleteOptions {
|
for _, opt := range *deleteOptions {
|
||||||
uid := types.UID("uid-1234")
|
r.Equal(testutil.NewPreconditions("uid-1234", "rv-5678"), opt)
|
||||||
r.Equal(metav1.DeleteOptions{
|
|
||||||
Preconditions: &metav1.Preconditions{
|
|
||||||
UID: &uid,
|
|
||||||
ResourceVersion: pointer.String("rv-5678"),
|
|
||||||
},
|
|
||||||
}, opt)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -40,12 +40,29 @@ func NewLegacyPodCleanerController(
|
|||||||
controllerlib.Config{
|
controllerlib.Config{
|
||||||
Name: "legacy-pod-cleaner-controller",
|
Name: "legacy-pod-cleaner-controller",
|
||||||
Syncer: controllerlib.SyncFunc(func(ctx controllerlib.Context) error {
|
Syncer: controllerlib.SyncFunc(func(ctx controllerlib.Context) error {
|
||||||
if err := client.Kubernetes.CoreV1().Pods(ctx.Key.Namespace).Delete(ctx.Context, ctx.Key.Name, metav1.DeleteOptions{}); err != nil {
|
podClient := client.Kubernetes.CoreV1().Pods(ctx.Key.Namespace)
|
||||||
|
|
||||||
|
// avoid blind writes to the API
|
||||||
|
agentPod, err := podClient.Get(ctx.Context, ctx.Key.Name, metav1.GetOptions{})
|
||||||
|
if err != nil {
|
||||||
|
if k8serrors.IsNotFound(err) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("could not get legacy agent pod: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := podClient.Delete(ctx.Context, ctx.Key.Name, metav1.DeleteOptions{
|
||||||
|
Preconditions: &metav1.Preconditions{
|
||||||
|
UID: &agentPod.UID,
|
||||||
|
ResourceVersion: &agentPod.ResourceVersion,
|
||||||
|
},
|
||||||
|
}); err != nil {
|
||||||
if k8serrors.IsNotFound(err) {
|
if k8serrors.IsNotFound(err) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return fmt.Errorf("could not delete legacy agent pod: %w", err)
|
return fmt.Errorf("could not delete legacy agent pod: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("deleted legacy kube-cert-agent pod", "pod", klog.KRef(ctx.Key.Namespace, ctx.Key.Name))
|
log.Info("deleted legacy kube-cert-agent pod", "pod", klog.KRef(ctx.Key.Namespace, ctx.Key.Name))
|
||||||
return nil
|
return nil
|
||||||
}),
|
}),
|
||||||
|
@ -20,6 +20,7 @@ import (
|
|||||||
|
|
||||||
"go.pinniped.dev/internal/controllerlib"
|
"go.pinniped.dev/internal/controllerlib"
|
||||||
"go.pinniped.dev/internal/kubeclient"
|
"go.pinniped.dev/internal/kubeclient"
|
||||||
|
"go.pinniped.dev/internal/testutil"
|
||||||
"go.pinniped.dev/internal/testutil/testlogger"
|
"go.pinniped.dev/internal/testutil/testlogger"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -31,6 +32,8 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
Namespace: "concierge",
|
Namespace: "concierge",
|
||||||
Name: "pinniped-concierge-kube-cert-agent-without-extra-label",
|
Name: "pinniped-concierge-kube-cert-agent-without-extra-label",
|
||||||
Labels: map[string]string{"kube-cert-agent.pinniped.dev": "true"},
|
Labels: map[string]string{"kube-cert-agent.pinniped.dev": "true"},
|
||||||
|
UID: "1",
|
||||||
|
ResourceVersion: "2",
|
||||||
},
|
},
|
||||||
Spec: corev1.PodSpec{},
|
Spec: corev1.PodSpec{},
|
||||||
Status: corev1.PodStatus{Phase: corev1.PodRunning},
|
Status: corev1.PodStatus{Phase: corev1.PodRunning},
|
||||||
@ -40,10 +43,14 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
legacyAgentPodWithExtraLabel.Name = "pinniped-concierge-kube-cert-agent-with-extra-label"
|
legacyAgentPodWithExtraLabel.Name = "pinniped-concierge-kube-cert-agent-with-extra-label"
|
||||||
legacyAgentPodWithExtraLabel.Labels["extralabel"] = "labelvalue"
|
legacyAgentPodWithExtraLabel.Labels["extralabel"] = "labelvalue"
|
||||||
legacyAgentPodWithExtraLabel.Labels["anotherextralabel"] = "labelvalue"
|
legacyAgentPodWithExtraLabel.Labels["anotherextralabel"] = "labelvalue"
|
||||||
|
legacyAgentPodWithExtraLabel.UID = "3"
|
||||||
|
legacyAgentPodWithExtraLabel.ResourceVersion = "4"
|
||||||
|
|
||||||
nonLegacyAgentPod := legacyAgentPodWithExtraLabel.DeepCopy()
|
nonLegacyAgentPod := legacyAgentPodWithExtraLabel.DeepCopy()
|
||||||
nonLegacyAgentPod.Name = "pinniped-concierge-kube-cert-agent-not-legacy"
|
nonLegacyAgentPod.Name = "pinniped-concierge-kube-cert-agent-not-legacy"
|
||||||
nonLegacyAgentPod.Labels["kube-cert-agent.pinniped.dev"] = "v2"
|
nonLegacyAgentPod.Labels["kube-cert-agent.pinniped.dev"] = "v2"
|
||||||
|
nonLegacyAgentPod.UID = "5"
|
||||||
|
nonLegacyAgentPod.ResourceVersion = "6"
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
@ -52,10 +59,12 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
wantDistinctErrors []string
|
wantDistinctErrors []string
|
||||||
wantDistinctLogs []string
|
wantDistinctLogs []string
|
||||||
wantActions []coretesting.Action
|
wantActions []coretesting.Action
|
||||||
|
wantDeleteOptions []metav1.DeleteOptions
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "no pods",
|
name: "no pods",
|
||||||
wantActions: []coretesting.Action{},
|
wantActions: []coretesting.Action{},
|
||||||
|
wantDeleteOptions: []metav1.DeleteOptions{},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "mix of pods",
|
name: "mix of pods",
|
||||||
@ -69,8 +78,12 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
`legacy-pod-cleaner-controller "level"=0 "msg"="deleted legacy kube-cert-agent pod" "pod"={"name":"pinniped-concierge-kube-cert-agent-with-extra-label","namespace":"concierge"}`,
|
`legacy-pod-cleaner-controller "level"=0 "msg"="deleted legacy kube-cert-agent pod" "pod"={"name":"pinniped-concierge-kube-cert-agent-with-extra-label","namespace":"concierge"}`,
|
||||||
},
|
},
|
||||||
wantActions: []coretesting.Action{ // the first delete triggers the informer again, but the second invocation triggers a Not Found
|
wantActions: []coretesting.Action{ // the first delete triggers the informer again, but the second invocation triggers a Not Found
|
||||||
|
coretesting.NewGetAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
coretesting.NewGetAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
|
},
|
||||||
|
wantDeleteOptions: []metav1.DeleteOptions{
|
||||||
|
testutil.NewPreconditions("3", "4"),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -89,9 +102,15 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
"could not delete legacy agent pod: some delete error",
|
"could not delete legacy agent pod: some delete error",
|
||||||
},
|
},
|
||||||
wantActions: []coretesting.Action{
|
wantActions: []coretesting.Action{
|
||||||
|
coretesting.NewGetAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
|
coretesting.NewGetAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
},
|
},
|
||||||
|
wantDeleteOptions: []metav1.DeleteOptions{
|
||||||
|
testutil.NewPreconditions("3", "4"),
|
||||||
|
testutil.NewPreconditions("3", "4"),
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "fail to delete because of not found error",
|
name: "fail to delete because of not found error",
|
||||||
@ -107,8 +126,30 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
},
|
},
|
||||||
wantDistinctErrors: []string{""},
|
wantDistinctErrors: []string{""},
|
||||||
wantActions: []coretesting.Action{
|
wantActions: []coretesting.Action{
|
||||||
|
coretesting.NewGetAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
coretesting.NewDeleteAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
},
|
},
|
||||||
|
wantDeleteOptions: []metav1.DeleteOptions{
|
||||||
|
testutil.NewPreconditions("3", "4"),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "fail to delete because of not found error on get",
|
||||||
|
kubeObjects: []runtime.Object{
|
||||||
|
legacyAgentPodWithoutExtraLabel, // should not be delete (missing extra label)
|
||||||
|
legacyAgentPodWithExtraLabel, // should be deleted
|
||||||
|
nonLegacyAgentPod, // should not be deleted (missing legacy agent label)
|
||||||
|
},
|
||||||
|
addKubeReactions: func(clientset *kubefake.Clientset) {
|
||||||
|
clientset.PrependReactor("get", "*", func(action coretesting.Action) (handled bool, ret runtime.Object, err error) {
|
||||||
|
return true, nil, k8serrors.NewNotFound(action.GetResource().GroupResource(), "")
|
||||||
|
})
|
||||||
|
},
|
||||||
|
wantDistinctErrors: []string{""},
|
||||||
|
wantActions: []coretesting.Action{
|
||||||
|
coretesting.NewGetAction(corev1.Resource("pods").WithVersion("v1"), "concierge", legacyAgentPodWithExtraLabel.Name),
|
||||||
|
},
|
||||||
|
wantDeleteOptions: []metav1.DeleteOptions{},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
@ -120,6 +161,10 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
if tt.addKubeReactions != nil {
|
if tt.addKubeReactions != nil {
|
||||||
tt.addKubeReactions(kubeClientset)
|
tt.addKubeReactions(kubeClientset)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
opts := &[]metav1.DeleteOptions{}
|
||||||
|
trackDeleteClient := testutil.NewDeleteOptionsRecorder(kubeClientset, opts)
|
||||||
|
|
||||||
kubeInformers := informers.NewSharedInformerFactory(kubeClientset, 0)
|
kubeInformers := informers.NewSharedInformerFactory(kubeClientset, 0)
|
||||||
log := testlogger.New(t)
|
log := testlogger.New(t)
|
||||||
controller := NewLegacyPodCleanerController(
|
controller := NewLegacyPodCleanerController(
|
||||||
@ -127,7 +172,7 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
Namespace: "concierge",
|
Namespace: "concierge",
|
||||||
Labels: map[string]string{"extralabel": "labelvalue"},
|
Labels: map[string]string{"extralabel": "labelvalue"},
|
||||||
},
|
},
|
||||||
&kubeclient.Client{Kubernetes: kubeClientset},
|
&kubeclient.Client{Kubernetes: trackDeleteClient},
|
||||||
kubeInformers.Core().V1().Pods(),
|
kubeInformers.Core().V1().Pods(),
|
||||||
log,
|
log,
|
||||||
controllerlib.WithMaxRetries(1),
|
controllerlib.WithMaxRetries(1),
|
||||||
@ -140,6 +185,7 @@ func TestLegacyPodCleanerController(t *testing.T) {
|
|||||||
assert.Equal(t, tt.wantDistinctErrors, deduplicate(errorMessages), "unexpected errors")
|
assert.Equal(t, tt.wantDistinctErrors, deduplicate(errorMessages), "unexpected errors")
|
||||||
assert.Equal(t, tt.wantDistinctLogs, deduplicate(log.Lines()), "unexpected logs")
|
assert.Equal(t, tt.wantDistinctLogs, deduplicate(log.Lines()), "unexpected logs")
|
||||||
assert.Equal(t, tt.wantActions, kubeClientset.Actions()[2:], "unexpected actions")
|
assert.Equal(t, tt.wantActions, kubeClientset.Actions()[2:], "unexpected actions")
|
||||||
|
assert.Equal(t, tt.wantDeleteOptions, *opts, "unexpected delete options")
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -174,6 +174,7 @@ func (c *oidcWatcherController) validateUpstream(ctx controllerlib.Context, upst
|
|||||||
},
|
},
|
||||||
UsernameClaim: upstream.Spec.Claims.Username,
|
UsernameClaim: upstream.Spec.Claims.Username,
|
||||||
GroupsClaim: upstream.Spec.Claims.Groups,
|
GroupsClaim: upstream.Spec.Claims.Groups,
|
||||||
|
AllowPasswordGrant: upstream.Spec.AuthorizationConfig.AllowPasswordGrant,
|
||||||
}
|
}
|
||||||
conditions := []*v1alpha1.Condition{
|
conditions := []*v1alpha1.Condition{
|
||||||
c.validateSecret(upstream, &result),
|
c.validateSecret(upstream, &result),
|
||||||
|
@ -506,14 +506,17 @@ Get "invalid-url-that-is-really-really-long/.well-known/openid-configuration": u
|
|||||||
}},
|
}},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream becomes valid",
|
name: "upstream with error becomes valid",
|
||||||
inputUpstreams: []runtime.Object{&v1alpha1.OIDCIdentityProvider{
|
inputUpstreams: []runtime.Object{&v1alpha1.OIDCIdentityProvider{
|
||||||
ObjectMeta: metav1.ObjectMeta{Namespace: testNamespace, Name: "test-name"},
|
ObjectMeta: metav1.ObjectMeta{Namespace: testNamespace, Name: "test-name"},
|
||||||
Spec: v1alpha1.OIDCIdentityProviderSpec{
|
Spec: v1alpha1.OIDCIdentityProviderSpec{
|
||||||
Issuer: testIssuerURL,
|
Issuer: testIssuerURL,
|
||||||
TLS: &v1alpha1.TLSSpec{CertificateAuthorityData: testIssuerCABase64},
|
TLS: &v1alpha1.TLSSpec{CertificateAuthorityData: testIssuerCABase64},
|
||||||
Client: v1alpha1.OIDCClient{SecretName: testSecretName},
|
Client: v1alpha1.OIDCClient{SecretName: testSecretName},
|
||||||
AuthorizationConfig: v1alpha1.OIDCAuthorizationConfig{AdditionalScopes: append(testAdditionalScopes, "xyz", "openid")},
|
AuthorizationConfig: v1alpha1.OIDCAuthorizationConfig{
|
||||||
|
AdditionalScopes: append(testAdditionalScopes, "xyz", "openid"),
|
||||||
|
AllowPasswordGrant: true,
|
||||||
|
},
|
||||||
Claims: v1alpha1.OIDCClaims{Groups: testGroupsClaim, Username: testUsernameClaim},
|
Claims: v1alpha1.OIDCClaims{Groups: testGroupsClaim, Username: testUsernameClaim},
|
||||||
},
|
},
|
||||||
Status: v1alpha1.OIDCIdentityProviderStatus{
|
Status: v1alpha1.OIDCIdentityProviderStatus{
|
||||||
@ -541,6 +544,7 @@ Get "invalid-url-that-is-really-really-long/.well-known/openid-configuration": u
|
|||||||
Scopes: append(testExpectedScopes, "xyz"),
|
Scopes: append(testExpectedScopes, "xyz"),
|
||||||
UsernameClaim: testUsernameClaim,
|
UsernameClaim: testUsernameClaim,
|
||||||
GroupsClaim: testGroupsClaim,
|
GroupsClaim: testGroupsClaim,
|
||||||
|
AllowPasswordGrant: true,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
wantResultingUpstreams: []v1alpha1.OIDCIdentityProvider{{
|
wantResultingUpstreams: []v1alpha1.OIDCIdentityProvider{{
|
||||||
@ -562,7 +566,10 @@ Get "invalid-url-that-is-really-really-long/.well-known/openid-configuration": u
|
|||||||
Issuer: testIssuerURL,
|
Issuer: testIssuerURL,
|
||||||
TLS: &v1alpha1.TLSSpec{CertificateAuthorityData: testIssuerCABase64},
|
TLS: &v1alpha1.TLSSpec{CertificateAuthorityData: testIssuerCABase64},
|
||||||
Client: v1alpha1.OIDCClient{SecretName: testSecretName},
|
Client: v1alpha1.OIDCClient{SecretName: testSecretName},
|
||||||
AuthorizationConfig: v1alpha1.OIDCAuthorizationConfig{AdditionalScopes: testAdditionalScopes},
|
AuthorizationConfig: v1alpha1.OIDCAuthorizationConfig{
|
||||||
|
AdditionalScopes: testAdditionalScopes,
|
||||||
|
AllowPasswordGrant: false,
|
||||||
|
},
|
||||||
Claims: v1alpha1.OIDCClaims{Groups: testGroupsClaim, Username: testUsernameClaim},
|
Claims: v1alpha1.OIDCClaims{Groups: testGroupsClaim, Username: testUsernameClaim},
|
||||||
},
|
},
|
||||||
Status: v1alpha1.OIDCIdentityProviderStatus{
|
Status: v1alpha1.OIDCIdentityProviderStatus{
|
||||||
@ -590,6 +597,7 @@ Get "invalid-url-that-is-really-really-long/.well-known/openid-configuration": u
|
|||||||
Scopes: testExpectedScopes,
|
Scopes: testExpectedScopes,
|
||||||
UsernameClaim: testUsernameClaim,
|
UsernameClaim: testUsernameClaim,
|
||||||
GroupsClaim: testGroupsClaim,
|
GroupsClaim: testGroupsClaim,
|
||||||
|
AllowPasswordGrant: false,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
wantResultingUpstreams: []v1alpha1.OIDCIdentityProvider{{
|
wantResultingUpstreams: []v1alpha1.OIDCIdentityProvider{{
|
||||||
@ -639,6 +647,7 @@ Get "invalid-url-that-is-really-really-long/.well-known/openid-configuration": u
|
|||||||
Scopes: testExpectedScopes,
|
Scopes: testExpectedScopes,
|
||||||
UsernameClaim: testUsernameClaim,
|
UsernameClaim: testUsernameClaim,
|
||||||
GroupsClaim: testGroupsClaim,
|
GroupsClaim: testGroupsClaim,
|
||||||
|
AllowPasswordGrant: false,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
wantResultingUpstreams: []v1alpha1.OIDCIdentityProvider{{
|
wantResultingUpstreams: []v1alpha1.OIDCIdentityProvider{{
|
||||||
@ -797,6 +806,7 @@ oidc: issuer did not match the issuer returned by provider, expected "` + testIs
|
|||||||
require.Equal(t, tt.wantResultingCache[i].GetAuthorizationURL().String(), actualIDP.GetAuthorizationURL().String())
|
require.Equal(t, tt.wantResultingCache[i].GetAuthorizationURL().String(), actualIDP.GetAuthorizationURL().String())
|
||||||
require.Equal(t, tt.wantResultingCache[i].GetUsernameClaim(), actualIDP.GetUsernameClaim())
|
require.Equal(t, tt.wantResultingCache[i].GetUsernameClaim(), actualIDP.GetUsernameClaim())
|
||||||
require.Equal(t, tt.wantResultingCache[i].GetGroupsClaim(), actualIDP.GetGroupsClaim())
|
require.Equal(t, tt.wantResultingCache[i].GetGroupsClaim(), actualIDP.GetGroupsClaim())
|
||||||
|
require.Equal(t, tt.wantResultingCache[i].AllowsPasswordGrant(), actualIDP.AllowsPasswordGrant())
|
||||||
require.ElementsMatch(t, tt.wantResultingCache[i].GetScopes(), actualIDP.GetScopes())
|
require.ElementsMatch(t, tt.wantResultingCache[i].GetScopes(), actualIDP.GetScopes())
|
||||||
|
|
||||||
// We always want to use the proxy from env on these clients, so although the following assertions
|
// We always want to use the proxy from env on these clients, so although the following assertions
|
||||||
|
@ -102,7 +102,12 @@ func (c *garbageCollectorController) Sync(ctx controllerlib.Context) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if garbageCollectAfterTime.Before(frozenClock.Now()) {
|
if garbageCollectAfterTime.Before(frozenClock.Now()) {
|
||||||
err = c.kubeClient.CoreV1().Secrets(secret.Namespace).Delete(ctx.Context, secret.Name, metav1.DeleteOptions{})
|
err = c.kubeClient.CoreV1().Secrets(secret.Namespace).Delete(ctx.Context, secret.Name, metav1.DeleteOptions{
|
||||||
|
Preconditions: &metav1.Preconditions{
|
||||||
|
UID: &secret.UID,
|
||||||
|
ResourceVersion: &secret.ResourceVersion,
|
||||||
|
},
|
||||||
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
plog.WarningErr("failed to garbage collect resource", err, logKV(secret))
|
plog.WarningErr("failed to garbage collect resource", err, logKV(secret))
|
||||||
continue
|
continue
|
||||||
|
@ -18,6 +18,7 @@ import (
|
|||||||
"k8s.io/apimachinery/pkg/runtime/schema"
|
"k8s.io/apimachinery/pkg/runtime/schema"
|
||||||
"k8s.io/apimachinery/pkg/util/clock"
|
"k8s.io/apimachinery/pkg/util/clock"
|
||||||
kubeinformers "k8s.io/client-go/informers"
|
kubeinformers "k8s.io/client-go/informers"
|
||||||
|
"k8s.io/client-go/kubernetes"
|
||||||
kubernetesfake "k8s.io/client-go/kubernetes/fake"
|
kubernetesfake "k8s.io/client-go/kubernetes/fake"
|
||||||
kubetesting "k8s.io/client-go/testing"
|
kubetesting "k8s.io/client-go/testing"
|
||||||
|
|
||||||
@ -116,6 +117,8 @@ func TestGarbageCollectorControllerSync(t *testing.T) {
|
|||||||
subject controllerlib.Controller
|
subject controllerlib.Controller
|
||||||
kubeInformerClient *kubernetesfake.Clientset
|
kubeInformerClient *kubernetesfake.Clientset
|
||||||
kubeClient *kubernetesfake.Clientset
|
kubeClient *kubernetesfake.Clientset
|
||||||
|
deleteOptions *[]metav1.DeleteOptions
|
||||||
|
deleteOptionsRecorder kubernetes.Interface
|
||||||
kubeInformers kubeinformers.SharedInformerFactory
|
kubeInformers kubeinformers.SharedInformerFactory
|
||||||
cancelContext context.Context
|
cancelContext context.Context
|
||||||
cancelContextCancelFunc context.CancelFunc
|
cancelContextCancelFunc context.CancelFunc
|
||||||
@ -130,7 +133,7 @@ func TestGarbageCollectorControllerSync(t *testing.T) {
|
|||||||
// Set this at the last second to allow for injection of server override.
|
// Set this at the last second to allow for injection of server override.
|
||||||
subject = GarbageCollectorController(
|
subject = GarbageCollectorController(
|
||||||
fakeClock,
|
fakeClock,
|
||||||
kubeClient,
|
deleteOptionsRecorder,
|
||||||
kubeInformers.Core().V1().Secrets(),
|
kubeInformers.Core().V1().Secrets(),
|
||||||
controllerlib.WithInformer,
|
controllerlib.WithInformer,
|
||||||
)
|
)
|
||||||
@ -158,6 +161,8 @@ func TestGarbageCollectorControllerSync(t *testing.T) {
|
|||||||
|
|
||||||
kubeInformerClient = kubernetesfake.NewSimpleClientset()
|
kubeInformerClient = kubernetesfake.NewSimpleClientset()
|
||||||
kubeClient = kubernetesfake.NewSimpleClientset()
|
kubeClient = kubernetesfake.NewSimpleClientset()
|
||||||
|
deleteOptions = &[]metav1.DeleteOptions{}
|
||||||
|
deleteOptionsRecorder = testutil.NewDeleteOptionsRecorder(kubeClient, deleteOptions)
|
||||||
kubeInformers = kubeinformers.NewSharedInformerFactory(kubeInformerClient, 0)
|
kubeInformers = kubeinformers.NewSharedInformerFactory(kubeInformerClient, 0)
|
||||||
frozenNow = time.Now().UTC()
|
frozenNow = time.Now().UTC()
|
||||||
fakeClock = clock.NewFakeClock(frozenNow)
|
fakeClock = clock.NewFakeClock(frozenNow)
|
||||||
@ -195,6 +200,8 @@ func TestGarbageCollectorControllerSync(t *testing.T) {
|
|||||||
ObjectMeta: metav1.ObjectMeta{
|
ObjectMeta: metav1.ObjectMeta{
|
||||||
Name: "first expired secret",
|
Name: "first expired secret",
|
||||||
Namespace: installedInNamespace,
|
Namespace: installedInNamespace,
|
||||||
|
UID: "uid-123",
|
||||||
|
ResourceVersion: "rv-456",
|
||||||
Annotations: map[string]string{
|
Annotations: map[string]string{
|
||||||
"storage.pinniped.dev/garbage-collect-after": frozenNow.Add(-time.Second).Format(time.RFC3339),
|
"storage.pinniped.dev/garbage-collect-after": frozenNow.Add(-time.Second).Format(time.RFC3339),
|
||||||
},
|
},
|
||||||
@ -206,6 +213,8 @@ func TestGarbageCollectorControllerSync(t *testing.T) {
|
|||||||
ObjectMeta: metav1.ObjectMeta{
|
ObjectMeta: metav1.ObjectMeta{
|
||||||
Name: "second expired secret",
|
Name: "second expired secret",
|
||||||
Namespace: installedInNamespace,
|
Namespace: installedInNamespace,
|
||||||
|
UID: "uid-789",
|
||||||
|
ResourceVersion: "rv-555",
|
||||||
Annotations: map[string]string{
|
Annotations: map[string]string{
|
||||||
"storage.pinniped.dev/garbage-collect-after": frozenNow.Add(-2 * time.Second).Format(time.RFC3339),
|
"storage.pinniped.dev/garbage-collect-after": frozenNow.Add(-2 * time.Second).Format(time.RFC3339),
|
||||||
},
|
},
|
||||||
@ -237,6 +246,13 @@ func TestGarbageCollectorControllerSync(t *testing.T) {
|
|||||||
},
|
},
|
||||||
kubeClient.Actions(),
|
kubeClient.Actions(),
|
||||||
)
|
)
|
||||||
|
r.ElementsMatch(
|
||||||
|
[]metav1.DeleteOptions{
|
||||||
|
testutil.NewPreconditions("uid-123", "rv-456"),
|
||||||
|
testutil.NewPreconditions("uid-789", "rv-555"),
|
||||||
|
},
|
||||||
|
*deleteOptions,
|
||||||
|
)
|
||||||
list, err := kubeClient.CoreV1().Secrets(installedInNamespace).List(context.Background(), metav1.ListOptions{})
|
list, err := kubeClient.CoreV1().Secrets(installedInNamespace).List(context.Background(), metav1.ListOptions{})
|
||||||
r.NoError(err)
|
r.NoError(err)
|
||||||
r.Len(list.Items, 2)
|
r.Len(list.Items, 2)
|
||||||
|
@ -33,6 +33,7 @@ import (
|
|||||||
"go.pinniped.dev/internal/dynamiccert"
|
"go.pinniped.dev/internal/dynamiccert"
|
||||||
"go.pinniped.dev/internal/groupsuffix"
|
"go.pinniped.dev/internal/groupsuffix"
|
||||||
"go.pinniped.dev/internal/kubeclient"
|
"go.pinniped.dev/internal/kubeclient"
|
||||||
|
"go.pinniped.dev/internal/leaderelection"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@ -97,7 +98,7 @@ type Config struct {
|
|||||||
func PrepareControllers(c *Config) (func(ctx context.Context), error) {
|
func PrepareControllers(c *Config) (func(ctx context.Context), error) {
|
||||||
loginConciergeGroupData, identityConciergeGroupData := groupsuffix.ConciergeAggregatedGroups(c.APIGroupSuffix)
|
loginConciergeGroupData, identityConciergeGroupData := groupsuffix.ConciergeAggregatedGroups(c.APIGroupSuffix)
|
||||||
|
|
||||||
dref, _, err := deploymentref.New(c.ServerInstallationInfo)
|
dref, deployment, err := deploymentref.New(c.ServerInstallationInfo)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("cannot create deployment ref: %w", err)
|
return nil, fmt.Errorf("cannot create deployment ref: %w", err)
|
||||||
}
|
}
|
||||||
@ -107,7 +108,9 @@ func PrepareControllers(c *Config) (func(ctx context.Context), error) {
|
|||||||
return nil, fmt.Errorf("cannot create API service ref: %w", err)
|
return nil, fmt.Errorf("cannot create API service ref: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
client, err := kubeclient.New(
|
client, leaderElector, err := leaderelection.New(
|
||||||
|
c.ServerInstallationInfo,
|
||||||
|
deployment,
|
||||||
dref, // first try to use the deployment as an owner ref (for namespace scoped resources)
|
dref, // first try to use the deployment as an owner ref (for namespace scoped resources)
|
||||||
apiServiceRef, // fallback to our API service (for everything else we create)
|
apiServiceRef, // fallback to our API service (for everything else we create)
|
||||||
kubeclient.WithMiddleware(groupsuffix.New(c.APIGroupSuffix)),
|
kubeclient.WithMiddleware(groupsuffix.New(c.APIGroupSuffix)),
|
||||||
@ -303,7 +306,7 @@ func PrepareControllers(c *Config) (func(ctx context.Context), error) {
|
|||||||
// Return a function which starts the informers and controllers.
|
// Return a function which starts the informers and controllers.
|
||||||
return func(ctx context.Context) {
|
return func(ctx context.Context) {
|
||||||
informers.startAndWaitForSync(ctx)
|
informers.startAndWaitForSync(ctx)
|
||||||
go controllerManager.Start(ctx)
|
go leaderElector(ctx, controllerManager.Start)
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -644,7 +644,6 @@ func authenticatorAPIGroup(apiGroup string) withFunc {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:unparam // the apiGroupSuffix parameter might always be the same, but this is nice for test readability
|
|
||||||
func replaceGV(t *testing.T, baseGV schema.GroupVersion, apiGroupSuffix string) schema.GroupVersion {
|
func replaceGV(t *testing.T, baseGV schema.GroupVersion, apiGroupSuffix string) schema.GroupVersion {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
groupName, ok := Replace(baseGV.Group, apiGroupSuffix)
|
groupName, ok := Replace(baseGV.Group, apiGroupSuffix)
|
||||||
|
@ -146,7 +146,7 @@ func handleOtherVerbs(
|
|||||||
|
|
||||||
result, err := middlewareReq.mutateRequest(obj)
|
result, err := middlewareReq.mutateRequest(obj)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return true, nil, err
|
return true, nil, fmt.Errorf("middleware request for %#v failed to mutate: %w", middlewareReq, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !result.mutated {
|
if !result.mutated {
|
||||||
@ -231,7 +231,7 @@ func handleCreateOrUpdate(
|
|||||||
|
|
||||||
result, err := middlewareReq.mutateRequest(obj)
|
result, err := middlewareReq.mutateRequest(obj)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return true, nil, err
|
return true, nil, fmt.Errorf("middleware request for %#v failed to mutate: %w", middlewareReq, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !result.mutated {
|
if !result.mutated {
|
||||||
|
150
internal/leaderelection/leaderelection.go
Normal file
150
internal/leaderelection/leaderelection.go
Normal file
@ -0,0 +1,150 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package leaderelection
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"go.uber.org/atomic"
|
||||||
|
appsv1 "k8s.io/api/apps/v1"
|
||||||
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
|
"k8s.io/client-go/tools/leaderelection"
|
||||||
|
"k8s.io/client-go/tools/leaderelection/resourcelock"
|
||||||
|
|
||||||
|
"go.pinniped.dev/internal/constable"
|
||||||
|
"go.pinniped.dev/internal/downward"
|
||||||
|
"go.pinniped.dev/internal/kubeclient"
|
||||||
|
"go.pinniped.dev/internal/plog"
|
||||||
|
)
|
||||||
|
|
||||||
|
const ErrNotLeader constable.Error = "write attempt rejected as client is not leader"
|
||||||
|
|
||||||
|
// New returns a client that has a leader election middleware injected into it.
|
||||||
|
// This middleware will prevent all non-read requests to the Kubernetes API when
|
||||||
|
// the current process does not hold the leader election lock. Unlike normal
|
||||||
|
// leader election where the process blocks until it acquires the lock, this
|
||||||
|
// middleware approach lets the process run as normal for all read requests.
|
||||||
|
// Another difference is that if the process acquires the lock and then loses it
|
||||||
|
// (i.e. a failed renewal), it will not exit (i.e. restart). Instead, it will
|
||||||
|
// simply attempt to acquire the lock again.
|
||||||
|
//
|
||||||
|
// The returned function is blocking and will run the leader election polling
|
||||||
|
// logic and will coordinate lease release with the input controller starter function.
|
||||||
|
func New(podInfo *downward.PodInfo, deployment *appsv1.Deployment, opts ...kubeclient.Option) (
|
||||||
|
*kubeclient.Client,
|
||||||
|
func(context.Context, func(context.Context)),
|
||||||
|
error,
|
||||||
|
) {
|
||||||
|
internalClient, err := kubeclient.New(opts...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("could not create internal client for leader election: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
isLeader := atomic.NewBool(false)
|
||||||
|
|
||||||
|
identity := podInfo.Name
|
||||||
|
leaseName := deployment.Name
|
||||||
|
|
||||||
|
leaderElectionConfig := leaderelection.LeaderElectionConfig{
|
||||||
|
Lock: &resourcelock.LeaseLock{
|
||||||
|
LeaseMeta: metav1.ObjectMeta{
|
||||||
|
Namespace: podInfo.Namespace,
|
||||||
|
Name: leaseName,
|
||||||
|
},
|
||||||
|
Client: internalClient.Kubernetes.CoordinationV1(),
|
||||||
|
LockConfig: resourcelock.ResourceLockConfig{
|
||||||
|
Identity: identity,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
ReleaseOnCancel: true, // semantics for correct release handled by controllersWithLeaderElector below
|
||||||
|
LeaseDuration: 60 * time.Second,
|
||||||
|
RenewDeadline: 15 * time.Second,
|
||||||
|
RetryPeriod: 5 * time.Second,
|
||||||
|
Callbacks: leaderelection.LeaderCallbacks{
|
||||||
|
OnStartedLeading: func(_ context.Context) {
|
||||||
|
plog.Debug("leader gained", "identity", identity)
|
||||||
|
isLeader.Store(true)
|
||||||
|
},
|
||||||
|
OnStoppedLeading: func() {
|
||||||
|
plog.Debug("leader lost", "identity", identity)
|
||||||
|
isLeader.Store(false)
|
||||||
|
},
|
||||||
|
OnNewLeader: func(newLeader string) {
|
||||||
|
if newLeader == identity {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
plog.Debug("new leader elected", "newLeader", newLeader)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
Name: leaseName,
|
||||||
|
// this must be set to nil because we do not want to associate /healthz with a failed
|
||||||
|
// leader election renewal as we do not want to exit the process if the leader changes.
|
||||||
|
WatchDog: nil,
|
||||||
|
}
|
||||||
|
|
||||||
|
// validate our config here before we rely on it being functioning below
|
||||||
|
if _, err := leaderelection.NewLeaderElector(leaderElectionConfig); err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("invalid config - could not create leader elector: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
writeOnlyWhenLeader := kubeclient.MiddlewareFunc(func(_ context.Context, rt kubeclient.RoundTrip) {
|
||||||
|
switch rt.Verb() {
|
||||||
|
case kubeclient.VerbGet, kubeclient.VerbList, kubeclient.VerbWatch:
|
||||||
|
// reads are always allowed.
|
||||||
|
// note that while our pods/exec into the kube cert agent pod is a write request from the
|
||||||
|
// perspective of the Kube API, it is semantically a read request since no mutation occurs.
|
||||||
|
// we simply use it to fill a cache, and we need all pods to have a functioning cache.
|
||||||
|
// however, we do not need to handle it here because remotecommand.NewSPDYExecutor uses a
|
||||||
|
// kubeclient.Client.JSONConfig as input. since our middleware logic is only injected into
|
||||||
|
// the generated clientset code, this JSONConfig simply ignores this middleware all together.
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if isLeader.Load() { // only perform "expensive" test for writes
|
||||||
|
return // we are currently the leader, all actions are permitted
|
||||||
|
}
|
||||||
|
|
||||||
|
rt.MutateRequest(func(_ kubeclient.Object) error {
|
||||||
|
return ErrNotLeader // we are not the leader, fail the write request
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
leaderElectionOpts := append(
|
||||||
|
// all middleware are always executed so this being the first middleware is not relevant
|
||||||
|
[]kubeclient.Option{kubeclient.WithMiddleware(writeOnlyWhenLeader)},
|
||||||
|
opts..., // do not mutate input slice
|
||||||
|
)
|
||||||
|
|
||||||
|
client, err := kubeclient.New(leaderElectionOpts...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("could not create leader election client: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
controllersWithLeaderElector := func(ctx context.Context, controllers func(context.Context)) {
|
||||||
|
leaderElectorCtx, leaderElectorCancel := context.WithCancel(context.Background()) // purposefully detached context
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
controllers(ctx) // run the controllers with the global context, this blocks until the context is canceled
|
||||||
|
leaderElectorCancel() // once the controllers have all stopped, tell the leader elector to release the lock
|
||||||
|
}()
|
||||||
|
|
||||||
|
for { // run (and rerun on release) the leader elector with its own context (blocking)
|
||||||
|
select {
|
||||||
|
case <-leaderElectorCtx.Done():
|
||||||
|
return // keep trying to run until process exit
|
||||||
|
|
||||||
|
default:
|
||||||
|
// blocks while trying to acquire lease, unblocks on release.
|
||||||
|
// note that this creates a new leader elector on each loop to
|
||||||
|
// prevent any bugs from reusing that struct across elections.
|
||||||
|
// our config was validated above so this should never die.
|
||||||
|
leaderelection.RunOrDie(leaderElectorCtx, leaderElectionConfig)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return client, controllersWithLeaderElector, nil
|
||||||
|
}
|
@ -43,6 +43,20 @@ func (m *MockUpstreamOIDCIdentityProviderI) EXPECT() *MockUpstreamOIDCIdentityPr
|
|||||||
return m.recorder
|
return m.recorder
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AllowsPasswordGrant mocks base method.
|
||||||
|
func (m *MockUpstreamOIDCIdentityProviderI) AllowsPasswordGrant() bool {
|
||||||
|
m.ctrl.T.Helper()
|
||||||
|
ret := m.ctrl.Call(m, "AllowsPasswordGrant")
|
||||||
|
ret0, _ := ret[0].(bool)
|
||||||
|
return ret0
|
||||||
|
}
|
||||||
|
|
||||||
|
// AllowsPasswordGrant indicates an expected call of AllowsPasswordGrant.
|
||||||
|
func (mr *MockUpstreamOIDCIdentityProviderIMockRecorder) AllowsPasswordGrant() *gomock.Call {
|
||||||
|
mr.mock.ctrl.T.Helper()
|
||||||
|
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AllowsPasswordGrant", reflect.TypeOf((*MockUpstreamOIDCIdentityProviderI)(nil).AllowsPasswordGrant))
|
||||||
|
}
|
||||||
|
|
||||||
// ExchangeAuthcodeAndValidateTokens mocks base method.
|
// ExchangeAuthcodeAndValidateTokens mocks base method.
|
||||||
func (m *MockUpstreamOIDCIdentityProviderI) ExchangeAuthcodeAndValidateTokens(arg0 context.Context, arg1 string, arg2 pkce.Code, arg3 nonce.Nonce, arg4 string) (*oidctypes.Token, error) {
|
func (m *MockUpstreamOIDCIdentityProviderI) ExchangeAuthcodeAndValidateTokens(arg0 context.Context, arg1 string, arg2 pkce.Code, arg3 nonce.Nonce, arg4 string) (*oidctypes.Token, error) {
|
||||||
m.ctrl.T.Helper()
|
m.ctrl.T.Helper()
|
||||||
@ -142,6 +156,21 @@ func (mr *MockUpstreamOIDCIdentityProviderIMockRecorder) GetUsernameClaim() *gom
|
|||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetUsernameClaim", reflect.TypeOf((*MockUpstreamOIDCIdentityProviderI)(nil).GetUsernameClaim))
|
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetUsernameClaim", reflect.TypeOf((*MockUpstreamOIDCIdentityProviderI)(nil).GetUsernameClaim))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// PasswordCredentialsGrantAndValidateTokens mocks base method.
|
||||||
|
func (m *MockUpstreamOIDCIdentityProviderI) PasswordCredentialsGrantAndValidateTokens(arg0 context.Context, arg1, arg2 string) (*oidctypes.Token, error) {
|
||||||
|
m.ctrl.T.Helper()
|
||||||
|
ret := m.ctrl.Call(m, "PasswordCredentialsGrantAndValidateTokens", arg0, arg1, arg2)
|
||||||
|
ret0, _ := ret[0].(*oidctypes.Token)
|
||||||
|
ret1, _ := ret[1].(error)
|
||||||
|
return ret0, ret1
|
||||||
|
}
|
||||||
|
|
||||||
|
// PasswordCredentialsGrantAndValidateTokens indicates an expected call of PasswordCredentialsGrantAndValidateTokens.
|
||||||
|
func (mr *MockUpstreamOIDCIdentityProviderIMockRecorder) PasswordCredentialsGrantAndValidateTokens(arg0, arg1, arg2 interface{}) *gomock.Call {
|
||||||
|
mr.mock.ctrl.T.Helper()
|
||||||
|
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "PasswordCredentialsGrantAndValidateTokens", reflect.TypeOf((*MockUpstreamOIDCIdentityProviderI)(nil).PasswordCredentialsGrantAndValidateTokens), arg0, arg1, arg2)
|
||||||
|
}
|
||||||
|
|
||||||
// ValidateToken mocks base method.
|
// ValidateToken mocks base method.
|
||||||
func (m *MockUpstreamOIDCIdentityProviderI) ValidateToken(arg0 context.Context, arg1 *oauth2.Token, arg2 nonce.Nonce) (*oidctypes.Token, error) {
|
func (m *MockUpstreamOIDCIdentityProviderI) ValidateToken(arg0 context.Context, arg1 *oauth2.Token, arg2 nonce.Nonce) (*oidctypes.Token, error) {
|
||||||
m.ctrl.T.Helper()
|
m.ctrl.T.Helper()
|
||||||
|
@ -17,6 +17,7 @@ import (
|
|||||||
"golang.org/x/oauth2"
|
"golang.org/x/oauth2"
|
||||||
"k8s.io/apiserver/pkg/authentication/authenticator"
|
"k8s.io/apiserver/pkg/authentication/authenticator"
|
||||||
|
|
||||||
|
supervisoroidc "go.pinniped.dev/generated/latest/apis/supervisor/oidc"
|
||||||
"go.pinniped.dev/internal/httputil/httperr"
|
"go.pinniped.dev/internal/httputil/httperr"
|
||||||
"go.pinniped.dev/internal/httputil/securityheader"
|
"go.pinniped.dev/internal/httputil/securityheader"
|
||||||
"go.pinniped.dev/internal/oidc"
|
"go.pinniped.dev/internal/oidc"
|
||||||
@ -28,11 +29,6 @@ import (
|
|||||||
"go.pinniped.dev/pkg/oidcclient/pkce"
|
"go.pinniped.dev/pkg/oidcclient/pkce"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
|
||||||
CustomUsernameHeaderName = "Pinniped-Username"
|
|
||||||
CustomPasswordHeaderName = "Pinniped-Password" //nolint:gosec // this is not a credential
|
|
||||||
)
|
|
||||||
|
|
||||||
func NewHandler(
|
func NewHandler(
|
||||||
downstreamIssuer string,
|
downstreamIssuer string,
|
||||||
idpLister oidc.UpstreamIdentityProvidersLister,
|
idpLister oidc.UpstreamIdentityProvidersLister,
|
||||||
@ -59,7 +55,11 @@ func NewHandler(
|
|||||||
}
|
}
|
||||||
|
|
||||||
if oidcUpstream != nil {
|
if oidcUpstream != nil {
|
||||||
return handleAuthRequestForOIDCUpstream(r, w,
|
if len(r.Header.Values(supervisoroidc.AuthorizeUsernameHeaderName)) > 0 {
|
||||||
|
// The client set a username header, so they are trying to log in with a username/password.
|
||||||
|
return handleAuthRequestForOIDCUpstreamPasswordGrant(r, w, oauthHelperWithStorage, oidcUpstream)
|
||||||
|
}
|
||||||
|
return handleAuthRequestForOIDCUpstreamAuthcodeGrant(r, w,
|
||||||
oauthHelperWithoutStorage,
|
oauthHelperWithoutStorage,
|
||||||
generateCSRF, generateNonce, generatePKCE,
|
generateCSRF, generateNonce, generatePKCE,
|
||||||
oidcUpstream,
|
oidcUpstream,
|
||||||
@ -86,13 +86,8 @@ func handleAuthRequestForLDAPUpstream(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
username := r.Header.Get(CustomUsernameHeaderName)
|
username, password, hadUsernamePasswordValues := requireNonEmptyUsernameAndPasswordHeaders(r, w, oauthHelper, authorizeRequester)
|
||||||
password := r.Header.Get(CustomPasswordHeaderName)
|
if !hadUsernamePasswordValues {
|
||||||
if username == "" || password == "" {
|
|
||||||
// Return an error according to OIDC spec 3.1.2.6 (second paragraph).
|
|
||||||
err := errors.WithStack(fosite.ErrAccessDenied.WithHintf("Missing or blank username or password."))
|
|
||||||
plog.Info("authorize response error", oidc.FositeErrorForLog(err)...)
|
|
||||||
oauthHelper.WriteAuthorizeError(w, authorizeRequester, err)
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -102,33 +97,65 @@ func handleAuthRequestForLDAPUpstream(
|
|||||||
return httperr.New(http.StatusBadGateway, "unexpected error during upstream authentication")
|
return httperr.New(http.StatusBadGateway, "unexpected error during upstream authentication")
|
||||||
}
|
}
|
||||||
if !authenticated {
|
if !authenticated {
|
||||||
plog.Debug("failed upstream LDAP authentication", "upstreamName", ldapUpstream.GetName())
|
return writeAuthorizeError(w, oauthHelper, authorizeRequester,
|
||||||
// Return an error according to OIDC spec 3.1.2.6 (second paragraph).
|
fosite.ErrAccessDenied.WithHintf("Username/password not accepted by LDAP provider."))
|
||||||
err = errors.WithStack(fosite.ErrAccessDenied.WithHintf("Username/password not accepted by LDAP provider."))
|
}
|
||||||
plog.Info("authorize response error", oidc.FositeErrorForLog(err)...)
|
|
||||||
oauthHelper.WriteAuthorizeError(w, authorizeRequester, err)
|
subject := downstreamSubjectFromUpstreamLDAP(ldapUpstream, authenticateResponse)
|
||||||
|
username = authenticateResponse.User.GetName()
|
||||||
|
groups := authenticateResponse.User.GetGroups()
|
||||||
|
|
||||||
|
return makeDownstreamSessionAndReturnAuthcodeRedirect(r, w, oauthHelper, authorizeRequester, subject, username, groups)
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleAuthRequestForOIDCUpstreamPasswordGrant(
|
||||||
|
r *http.Request,
|
||||||
|
w http.ResponseWriter,
|
||||||
|
oauthHelper fosite.OAuth2Provider,
|
||||||
|
oidcUpstream provider.UpstreamOIDCIdentityProviderI,
|
||||||
|
) error {
|
||||||
|
authorizeRequester, created := newAuthorizeRequest(r, w, oauthHelper)
|
||||||
|
if !created {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
openIDSession := downstreamsession.MakeDownstreamSession(
|
username, password, hadUsernamePasswordValues := requireNonEmptyUsernameAndPasswordHeaders(r, w, oauthHelper, authorizeRequester)
|
||||||
downstreamSubjectFromUpstreamLDAP(ldapUpstream, authenticateResponse),
|
if !hadUsernamePasswordValues {
|
||||||
authenticateResponse.User.GetName(),
|
return nil
|
||||||
authenticateResponse.User.GetGroups(),
|
}
|
||||||
)
|
|
||||||
|
|
||||||
authorizeResponder, err := oauthHelper.NewAuthorizeResponse(r.Context(), authorizeRequester, openIDSession)
|
if !oidcUpstream.AllowsPasswordGrant() {
|
||||||
|
// Return a user-friendly error for this case which is entirely within our control.
|
||||||
|
return writeAuthorizeError(w, oauthHelper, authorizeRequester,
|
||||||
|
fosite.ErrAccessDenied.WithHint(
|
||||||
|
"Resource owner password credentials grant is not allowed for this upstream provider according to its configuration."))
|
||||||
|
}
|
||||||
|
|
||||||
|
token, err := oidcUpstream.PasswordCredentialsGrantAndValidateTokens(r.Context(), username, password)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
plog.Info("authorize response error", oidc.FositeErrorForLog(err)...)
|
// Upstream password grant errors can be generic errors (e.g. a network failure) or can be oauth2.RetrieveError errors
|
||||||
oauthHelper.WriteAuthorizeError(w, authorizeRequester, err)
|
// which represent the http response from the upstream server. These could be a 5XX or some other unexpected error,
|
||||||
return nil
|
// or could be a 400 with a JSON body as described by https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
|
||||||
|
// which notes that wrong resource owner credentials should result in an "invalid_grant" error.
|
||||||
|
// However, the exact response is undefined in the sense that there is no such thing as a password grant in
|
||||||
|
// the OIDC spec, so we don't try too hard to read the upstream errors in this case. (E.g. Dex departs from the
|
||||||
|
// spec and returns something other than an "invalid_grant" error for bad resource owner credentials.)
|
||||||
|
return writeAuthorizeError(w, oauthHelper, authorizeRequester,
|
||||||
|
fosite.ErrAccessDenied.WithDebug(err.Error())) // WithDebug hides the error from the client
|
||||||
}
|
}
|
||||||
|
|
||||||
oauthHelper.WriteAuthorizeResponse(w, authorizeRequester, authorizeResponder)
|
subject, username, groups, err := downstreamsession.GetDownstreamIdentityFromUpstreamIDToken(oidcUpstream, token.IDToken.Claims)
|
||||||
|
if err != nil {
|
||||||
return nil
|
// Return a user-friendly error for this case which is entirely within our control.
|
||||||
|
return writeAuthorizeError(w, oauthHelper, authorizeRequester,
|
||||||
|
fosite.ErrAccessDenied.WithHintf("Reason: %s.", err.Error()),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func handleAuthRequestForOIDCUpstream(
|
return makeDownstreamSessionAndReturnAuthcodeRedirect(r, w, oauthHelper, authorizeRequester, subject, username, groups)
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleAuthRequestForOIDCUpstreamAuthcodeGrant(
|
||||||
r *http.Request,
|
r *http.Request,
|
||||||
w http.ResponseWriter,
|
w http.ResponseWriter,
|
||||||
oauthHelper fosite.OAuth2Provider,
|
oauthHelper fosite.OAuth2Provider,
|
||||||
@ -155,9 +182,7 @@ func handleAuthRequestForOIDCUpstream(
|
|||||||
},
|
},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
plog.Info("authorize response error", oidc.FositeErrorForLog(err)...)
|
return writeAuthorizeError(w, oauthHelper, authorizeRequester, err)
|
||||||
oauthHelper.WriteAuthorizeError(w, authorizeRequester, err)
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
csrfValue, nonceValue, pkceValue, err := generateValues(generateCSRF, generateNonce, generatePKCE)
|
csrfValue, nonceValue, pkceValue, err := generateValues(generateCSRF, generateNonce, generatePKCE)
|
||||||
@ -224,11 +249,60 @@ func handleAuthRequestForOIDCUpstream(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func writeAuthorizeError(w http.ResponseWriter, oauthHelper fosite.OAuth2Provider, authorizeRequester fosite.AuthorizeRequester, err error) error {
|
||||||
|
if plog.Enabled(plog.LevelTrace) {
|
||||||
|
// When trace level logging is enabled, include the stack trace in the log message.
|
||||||
|
keysAndValues := oidc.FositeErrorForLog(err)
|
||||||
|
errWithStack := errors.WithStack(err)
|
||||||
|
keysAndValues = append(keysAndValues, "errWithStack")
|
||||||
|
// klog always prints error values using %s, which does not include stack traces,
|
||||||
|
// so convert the error to a string which includes the stack trace here.
|
||||||
|
keysAndValues = append(keysAndValues, fmt.Sprintf("%+v", errWithStack))
|
||||||
|
plog.Trace("authorize response error", keysAndValues...)
|
||||||
|
} else {
|
||||||
|
plog.Info("authorize response error", oidc.FositeErrorForLog(err)...)
|
||||||
|
}
|
||||||
|
// Return an error according to OIDC spec 3.1.2.6 (second paragraph).
|
||||||
|
oauthHelper.WriteAuthorizeError(w, authorizeRequester, err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeDownstreamSessionAndReturnAuthcodeRedirect(
|
||||||
|
r *http.Request,
|
||||||
|
w http.ResponseWriter,
|
||||||
|
oauthHelper fosite.OAuth2Provider,
|
||||||
|
authorizeRequester fosite.AuthorizeRequester,
|
||||||
|
subject string,
|
||||||
|
username string,
|
||||||
|
groups []string,
|
||||||
|
) error {
|
||||||
|
openIDSession := downstreamsession.MakeDownstreamSession(subject, username, groups)
|
||||||
|
|
||||||
|
authorizeResponder, err := oauthHelper.NewAuthorizeResponse(r.Context(), authorizeRequester, openIDSession)
|
||||||
|
if err != nil {
|
||||||
|
return writeAuthorizeError(w, oauthHelper, authorizeRequester, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
oauthHelper.WriteAuthorizeResponse(w, authorizeRequester, authorizeResponder)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func requireNonEmptyUsernameAndPasswordHeaders(r *http.Request, w http.ResponseWriter, oauthHelper fosite.OAuth2Provider, authorizeRequester fosite.AuthorizeRequester) (string, string, bool) {
|
||||||
|
username := r.Header.Get(supervisoroidc.AuthorizeUsernameHeaderName)
|
||||||
|
password := r.Header.Get(supervisoroidc.AuthorizePasswordHeaderName)
|
||||||
|
if username == "" || password == "" {
|
||||||
|
_ = writeAuthorizeError(w, oauthHelper, authorizeRequester,
|
||||||
|
fosite.ErrAccessDenied.WithHintf("Missing or blank username or password."))
|
||||||
|
return "", "", false
|
||||||
|
}
|
||||||
|
return username, password, true
|
||||||
|
}
|
||||||
|
|
||||||
func newAuthorizeRequest(r *http.Request, w http.ResponseWriter, oauthHelper fosite.OAuth2Provider) (fosite.AuthorizeRequester, bool) {
|
func newAuthorizeRequest(r *http.Request, w http.ResponseWriter, oauthHelper fosite.OAuth2Provider) (fosite.AuthorizeRequester, bool) {
|
||||||
authorizeRequester, err := oauthHelper.NewAuthorizeRequest(r.Context(), r)
|
authorizeRequester, err := oauthHelper.NewAuthorizeRequest(r.Context(), r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
plog.Info("authorize request error", oidc.FositeErrorForLog(err)...)
|
_ = writeAuthorizeError(w, oauthHelper, authorizeRequester, err)
|
||||||
oauthHelper.WriteAuthorizeError(w, authorizeRequester, err)
|
|
||||||
return nil, false
|
return nil, false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -6,7 +6,6 @@ package callback
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"crypto/subtle"
|
"crypto/subtle"
|
||||||
"fmt"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
|
||||||
@ -22,14 +21,6 @@ import (
|
|||||||
"go.pinniped.dev/internal/plog"
|
"go.pinniped.dev/internal/plog"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
|
||||||
// The name of the email claim from https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
|
||||||
emailClaimName = "email"
|
|
||||||
|
|
||||||
// The name of the email_verified claim from https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
|
||||||
emailVerifiedClaimName = "email_verified"
|
|
||||||
)
|
|
||||||
|
|
||||||
func NewHandler(
|
func NewHandler(
|
||||||
upstreamIDPs oidc.UpstreamOIDCIdentityProvidersLister,
|
upstreamIDPs oidc.UpstreamOIDCIdentityProvidersLister,
|
||||||
oauthHelper fosite.OAuth2Provider,
|
oauthHelper fosite.OAuth2Provider,
|
||||||
@ -77,14 +68,9 @@ func NewHandler(
|
|||||||
return httperr.New(http.StatusBadGateway, "error exchanging and validating upstream tokens")
|
return httperr.New(http.StatusBadGateway, "error exchanging and validating upstream tokens")
|
||||||
}
|
}
|
||||||
|
|
||||||
subject, username, err := getSubjectAndUsernameFromUpstreamIDToken(upstreamIDPConfig, token.IDToken.Claims)
|
subject, username, groups, err := downstreamsession.GetDownstreamIdentityFromUpstreamIDToken(upstreamIDPConfig, token.IDToken.Claims)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return httperr.Wrap(http.StatusUnprocessableEntity, err.Error(), err)
|
||||||
}
|
|
||||||
|
|
||||||
groups, err := getGroupsFromUpstreamIDToken(upstreamIDPConfig, token.IDToken.Claims)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
openIDSession := downstreamsession.MakeDownstreamSession(subject, username, groups)
|
openIDSession := downstreamsession.MakeDownstreamSession(subject, username, groups)
|
||||||
@ -182,166 +168,3 @@ func readState(r *http.Request, stateDecoder oidc.Decoder) (*oidc.UpstreamStateP
|
|||||||
|
|
||||||
return &state, nil
|
return &state, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func getSubjectAndUsernameFromUpstreamIDToken(
|
|
||||||
upstreamIDPConfig provider.UpstreamOIDCIdentityProviderI,
|
|
||||||
idTokenClaims map[string]interface{},
|
|
||||||
) (string, string, error) {
|
|
||||||
// The spec says the "sub" claim is only unique per issuer,
|
|
||||||
// so we will prepend the issuer string to make it globally unique.
|
|
||||||
upstreamIssuer := idTokenClaims[oidc.IDTokenIssuerClaim]
|
|
||||||
if upstreamIssuer == "" {
|
|
||||||
plog.Warning(
|
|
||||||
"issuer claim in upstream ID token missing",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"issClaim", upstreamIssuer,
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "issuer claim in upstream ID token missing")
|
|
||||||
}
|
|
||||||
upstreamIssuerAsString, ok := upstreamIssuer.(string)
|
|
||||||
if !ok {
|
|
||||||
plog.Warning(
|
|
||||||
"issuer claim in upstream ID token has invalid format",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"issClaim", upstreamIssuer,
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "issuer claim in upstream ID token has invalid format")
|
|
||||||
}
|
|
||||||
|
|
||||||
subjectAsInterface, ok := idTokenClaims[oidc.IDTokenSubjectClaim]
|
|
||||||
if !ok {
|
|
||||||
plog.Warning(
|
|
||||||
"no subject claim in upstream ID token",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "no subject claim in upstream ID token")
|
|
||||||
}
|
|
||||||
|
|
||||||
upstreamSubject, ok := subjectAsInterface.(string)
|
|
||||||
if !ok {
|
|
||||||
plog.Warning(
|
|
||||||
"subject claim in upstream ID token has invalid format",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "subject claim in upstream ID token has invalid format")
|
|
||||||
}
|
|
||||||
|
|
||||||
subject := downstreamSubjectFromUpstreamOIDC(upstreamIssuerAsString, upstreamSubject)
|
|
||||||
|
|
||||||
usernameClaimName := upstreamIDPConfig.GetUsernameClaim()
|
|
||||||
if usernameClaimName == "" {
|
|
||||||
return subject, subject, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the upstream username claim is configured to be the special "email" claim and the upstream "email_verified"
|
|
||||||
// claim is present, then validate that the "email_verified" claim is true.
|
|
||||||
emailVerifiedAsInterface, ok := idTokenClaims[emailVerifiedClaimName]
|
|
||||||
if usernameClaimName == emailClaimName && ok {
|
|
||||||
emailVerified, ok := emailVerifiedAsInterface.(bool)
|
|
||||||
if !ok {
|
|
||||||
plog.Warning(
|
|
||||||
"username claim configured as \"email\" and upstream email_verified claim is not a boolean",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"configuredUsernameClaim", usernameClaimName,
|
|
||||||
"emailVerifiedClaim", emailVerifiedAsInterface,
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "email_verified claim in upstream ID token has invalid format")
|
|
||||||
}
|
|
||||||
if !emailVerified {
|
|
||||||
plog.Warning(
|
|
||||||
"username claim configured as \"email\" and upstream email_verified claim has false value",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"configuredUsernameClaim", usernameClaimName,
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "email_verified claim in upstream ID token has false value")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
usernameAsInterface, ok := idTokenClaims[usernameClaimName]
|
|
||||||
if !ok {
|
|
||||||
plog.Warning(
|
|
||||||
"no username claim in upstream ID token",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"configuredUsernameClaim", usernameClaimName,
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "no username claim in upstream ID token")
|
|
||||||
}
|
|
||||||
|
|
||||||
username, ok := usernameAsInterface.(string)
|
|
||||||
if !ok {
|
|
||||||
plog.Warning(
|
|
||||||
"username claim in upstream ID token has invalid format",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"configuredUsernameClaim", usernameClaimName,
|
|
||||||
)
|
|
||||||
return "", "", httperr.New(http.StatusUnprocessableEntity, "username claim in upstream ID token has invalid format")
|
|
||||||
}
|
|
||||||
|
|
||||||
return subject, username, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func downstreamSubjectFromUpstreamOIDC(upstreamIssuerAsString string, upstreamSubject string) string {
|
|
||||||
return fmt.Sprintf("%s?%s=%s", upstreamIssuerAsString, oidc.IDTokenSubjectClaim, url.QueryEscape(upstreamSubject))
|
|
||||||
}
|
|
||||||
|
|
||||||
func getGroupsFromUpstreamIDToken(
|
|
||||||
upstreamIDPConfig provider.UpstreamOIDCIdentityProviderI,
|
|
||||||
idTokenClaims map[string]interface{},
|
|
||||||
) ([]string, error) {
|
|
||||||
groupsClaimName := upstreamIDPConfig.GetGroupsClaim()
|
|
||||||
if groupsClaimName == "" {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
groupsAsInterface, ok := idTokenClaims[groupsClaimName]
|
|
||||||
if !ok {
|
|
||||||
plog.Warning(
|
|
||||||
"no groups claim in upstream ID token",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"configuredGroupsClaim", groupsClaimName,
|
|
||||||
)
|
|
||||||
return nil, nil // the upstream IDP may have omitted the claim if the user has no groups
|
|
||||||
}
|
|
||||||
|
|
||||||
groupsAsArray, okAsArray := extractGroups(groupsAsInterface)
|
|
||||||
if !okAsArray {
|
|
||||||
plog.Warning(
|
|
||||||
"groups claim in upstream ID token has invalid format",
|
|
||||||
"upstreamName", upstreamIDPConfig.GetName(),
|
|
||||||
"configuredGroupsClaim", groupsClaimName,
|
|
||||||
)
|
|
||||||
return nil, httperr.New(http.StatusUnprocessableEntity, "groups claim in upstream ID token has invalid format")
|
|
||||||
}
|
|
||||||
|
|
||||||
return groupsAsArray, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func extractGroups(groupsAsInterface interface{}) ([]string, bool) {
|
|
||||||
groupsAsString, okAsString := groupsAsInterface.(string)
|
|
||||||
if okAsString {
|
|
||||||
return []string{groupsAsString}, true
|
|
||||||
}
|
|
||||||
|
|
||||||
groupsAsStringArray, okAsStringArray := groupsAsInterface.([]string)
|
|
||||||
if okAsStringArray {
|
|
||||||
return groupsAsStringArray, true
|
|
||||||
}
|
|
||||||
|
|
||||||
groupsAsInterfaceArray, okAsArray := groupsAsInterface.([]interface{})
|
|
||||||
if !okAsArray {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
var groupsAsStrings []string
|
|
||||||
for _, groupAsInterface := range groupsAsInterfaceArray {
|
|
||||||
groupAsString, okAsString := groupAsInterface.(string)
|
|
||||||
if !okAsString {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
if groupAsString != "" {
|
|
||||||
groupsAsStrings = append(groupsAsStrings, groupAsString)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return groupsAsStrings, true
|
|
||||||
}
|
|
||||||
|
@ -21,20 +21,19 @@ import (
|
|||||||
"go.pinniped.dev/internal/testutil"
|
"go.pinniped.dev/internal/testutil"
|
||||||
"go.pinniped.dev/internal/testutil/oidctestutil"
|
"go.pinniped.dev/internal/testutil/oidctestutil"
|
||||||
"go.pinniped.dev/pkg/oidcclient/nonce"
|
"go.pinniped.dev/pkg/oidcclient/nonce"
|
||||||
"go.pinniped.dev/pkg/oidcclient/oidctypes"
|
|
||||||
oidcpkce "go.pinniped.dev/pkg/oidcclient/pkce"
|
oidcpkce "go.pinniped.dev/pkg/oidcclient/pkce"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
happyUpstreamIDPName = "upstream-idp-name"
|
happyUpstreamIDPName = "upstream-idp-name"
|
||||||
|
|
||||||
upstreamIssuer = "https://my-upstream-issuer.com"
|
oidcUpstreamIssuer = "https://my-upstream-issuer.com"
|
||||||
upstreamSubject = "abc123-some guid" // has a space character which should get escaped in URL
|
oidcUpstreamSubject = "abc123-some guid" // has a space character which should get escaped in URL
|
||||||
queryEscapedUpstreamSubject = "abc123-some+guid"
|
oidcUpstreamSubjectQueryEscaped = "abc123-some+guid"
|
||||||
upstreamUsername = "test-pinniped-username"
|
oidcUpstreamUsername = "test-pinniped-username"
|
||||||
|
|
||||||
upstreamUsernameClaim = "the-user-claim"
|
oidcUpstreamUsernameClaim = "the-user-claim"
|
||||||
upstreamGroupsClaim = "the-groups-claim"
|
oidcUpstreamGroupsClaim = "the-groups-claim"
|
||||||
|
|
||||||
happyUpstreamAuthcode = "upstream-auth-code"
|
happyUpstreamAuthcode = "upstream-auth-code"
|
||||||
happyUpstreamRedirectURI = "https://example.com/callback"
|
happyUpstreamRedirectURI = "https://example.com/callback"
|
||||||
@ -56,7 +55,7 @@ const (
|
|||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
upstreamGroupMembership = []string{"test-pinniped-group-0", "test-pinniped-group-1"}
|
oidcUpstreamGroupMembership = []string{"test-pinniped-group-0", "test-pinniped-group-1"}
|
||||||
happyDownstreamScopesRequested = []string{"openid"}
|
happyDownstreamScopesRequested = []string{"openid"}
|
||||||
happyDownstreamScopesGranted = []string{"openid"}
|
happyDownstreamScopesGranted = []string{"openid"}
|
||||||
|
|
||||||
@ -113,7 +112,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
|
|
||||||
idp oidctestutil.TestUpstreamOIDCIdentityProvider
|
idps *oidctestutil.UpstreamIDPListerBuilder
|
||||||
method string
|
method string
|
||||||
path string
|
path string
|
||||||
csrfCookie string
|
csrfCookie string
|
||||||
@ -132,11 +131,11 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
wantDownstreamPKCEChallenge string
|
wantDownstreamPKCEChallenge string
|
||||||
wantDownstreamPKCEChallengeMethod string
|
wantDownstreamPKCEChallengeMethod string
|
||||||
|
|
||||||
wantExchangeAndValidateTokensCall *oidctestutil.ExchangeAuthcodeAndValidateTokenArgs
|
wantAuthcodeExchangeCall *expectedAuthcodeExchange
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "GET with good state and cookie and successful upstream token exchange with response_mode=form_post returns 200 with HTML+JS form",
|
name: "GET with good state and cookie and successful upstream token exchange with response_mode=form_post returns 200 with HTML+JS form",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(
|
path: newRequestPath().WithState(
|
||||||
happyUpstreamStateParam().WithAuthorizeRequestParams(
|
happyUpstreamStateParam().WithAuthorizeRequestParams(
|
||||||
@ -150,204 +149,254 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
wantStatus: http.StatusOK,
|
wantStatus: http.StatusOK,
|
||||||
wantContentType: "text/html;charset=UTF-8",
|
wantContentType: "text/html;charset=UTF-8",
|
||||||
wantBodyFormResponseRegexp: `<code id="manual-auth-code">(.+)</code>`,
|
wantBodyFormResponseRegexp: `<code id="manual-auth-code">(.+)</code>`,
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: upstreamUsername,
|
wantDownstreamIDTokenUsername: oidcUpstreamUsername,
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "GET with good state and cookie and successful upstream token exchange returns 302 to downstream client callback with its state and code",
|
name: "GET with good state and cookie and successful upstream token exchange returns 302 to downstream client callback with its state and code",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: upstreamUsername,
|
wantDownstreamIDTokenUsername: oidcUpstreamUsername,
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP provides no username or group claim configuration, so we use default username claim and skip groups",
|
name: "upstream IDP provides no username or group claim configuration, so we use default username claim and skip groups",
|
||||||
idp: happyUpstream().WithoutUsernameClaim().WithoutGroupsClaim().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithoutUsernameClaim().WithoutGroupsClaim().Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenUsername: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenGroups: []string{},
|
wantDownstreamIDTokenGroups: []string{},
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is missing",
|
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is missing",
|
||||||
idp: happyUpstream().WithUsernameClaim("email").
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
WithIDTokenClaim("email", "joe@whitehouse.gov").Build(),
|
happyUpstream().WithUsernameClaim("email").WithIDTokenClaim("email", "joe@whitehouse.gov").Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: "joe@whitehouse.gov",
|
wantDownstreamIDTokenUsername: "joe@whitehouse.gov",
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is present with true value",
|
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is present with true value",
|
||||||
idp: happyUpstream().WithUsernameClaim("email").
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithUsernameClaim("email").
|
||||||
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
||||||
WithIDTokenClaim("email_verified", true).Build(),
|
WithIDTokenClaim("email_verified", true).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: "joe@whitehouse.gov",
|
wantDownstreamIDTokenUsername: "joe@whitehouse.gov",
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP configures username claim as anything other than special claim `email` and `email_verified` upstream claim is present with false value",
|
name: "upstream IDP configures username claim as anything other than special claim `email` and `email_verified` upstream claim is present with false value",
|
||||||
idp: happyUpstream().WithUsernameClaim("some-claim").
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithUsernameClaim("some-claim").
|
||||||
WithIDTokenClaim("some-claim", "joe").
|
WithIDTokenClaim("some-claim", "joe").
|
||||||
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
||||||
WithIDTokenClaim("email_verified", false).Build(),
|
WithIDTokenClaim("email_verified", false).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound, // succeed despite `email_verified=false` because we're not using the email claim for anything
|
wantStatus: http.StatusFound, // succeed despite `email_verified=false` because we're not using the email claim for anything
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: "joe",
|
wantDownstreamIDTokenUsername: "joe",
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is present with illegal value",
|
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is present with illegal value",
|
||||||
idp: happyUpstream().WithUsernameClaim("email").
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().WithUsernameClaim("email").
|
||||||
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
||||||
WithIDTokenClaim("email_verified", "supposed to be boolean").Build(),
|
WithIDTokenClaim("email_verified", "supposed to be boolean").Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: email_verified claim in upstream ID token has invalid format\n",
|
wantBody: "Unprocessable Entity: email_verified claim in upstream ID token has invalid format\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is present with false value",
|
name: "upstream IDP configures username claim as special claim `email` and `email_verified` upstream claim is present with false value",
|
||||||
idp: happyUpstream().WithUsernameClaim("email").
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithUsernameClaim("email").
|
||||||
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
WithIDTokenClaim("email", "joe@whitehouse.gov").
|
||||||
WithIDTokenClaim("email_verified", false).Build(),
|
WithIDTokenClaim("email_verified", false).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: email_verified claim in upstream ID token has false value\n",
|
wantBody: "Unprocessable Entity: email_verified claim in upstream ID token has false value\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP provides username claim configuration as `sub`, so the downstream token subject should be exactly what they asked for",
|
name: "upstream IDP provides username claim configuration as `sub`, so the downstream token subject should be exactly what they asked for",
|
||||||
idp: happyUpstream().WithUsernameClaim("sub").Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithUsernameClaim("sub").Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: upstreamSubject,
|
wantDownstreamIDTokenUsername: oidcUpstreamSubject,
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP's configured groups claim in the ID token has a non-array value",
|
name: "upstream IDP's configured groups claim in the ID token has a non-array value",
|
||||||
idp: happyUpstream().WithIDTokenClaim(upstreamGroupsClaim, "notAnArrayGroup1 notAnArrayGroup2").Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim(oidcUpstreamGroupsClaim, "notAnArrayGroup1 notAnArrayGroup2").Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: upstreamUsername,
|
wantDownstreamIDTokenUsername: oidcUpstreamUsername,
|
||||||
wantDownstreamIDTokenGroups: []string{"notAnArrayGroup1 notAnArrayGroup2"},
|
wantDownstreamIDTokenGroups: []string{"notAnArrayGroup1 notAnArrayGroup2"},
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream IDP's configured groups claim in the ID token is a slice of interfaces",
|
name: "upstream IDP's configured groups claim in the ID token is a slice of interfaces",
|
||||||
idp: happyUpstream().WithIDTokenClaim(upstreamGroupsClaim, []interface{}{"group1", "group2"}).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim(oidcUpstreamGroupsClaim, []interface{}{"group1", "group2"}).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: upstreamUsername,
|
wantDownstreamIDTokenUsername: oidcUpstreamUsername,
|
||||||
wantDownstreamIDTokenGroups: []string{"group1", "group2"},
|
wantDownstreamIDTokenGroups: []string{"group1", "group2"},
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
// Pre-upstream-exchange verification
|
// Pre-upstream-exchange verification
|
||||||
{
|
{
|
||||||
name: "PUT method is invalid",
|
name: "PUT method is invalid",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodPut,
|
method: http.MethodPut,
|
||||||
path: newRequestPath().String(),
|
path: newRequestPath().String(),
|
||||||
wantStatus: http.StatusMethodNotAllowed,
|
wantStatus: http.StatusMethodNotAllowed,
|
||||||
@ -356,6 +405,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "POST method is invalid",
|
name: "POST method is invalid",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodPost,
|
method: http.MethodPost,
|
||||||
path: newRequestPath().String(),
|
path: newRequestPath().String(),
|
||||||
wantStatus: http.StatusMethodNotAllowed,
|
wantStatus: http.StatusMethodNotAllowed,
|
||||||
@ -364,6 +414,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "PATCH method is invalid",
|
name: "PATCH method is invalid",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodPatch,
|
method: http.MethodPatch,
|
||||||
path: newRequestPath().String(),
|
path: newRequestPath().String(),
|
||||||
wantStatus: http.StatusMethodNotAllowed,
|
wantStatus: http.StatusMethodNotAllowed,
|
||||||
@ -372,6 +423,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "DELETE method is invalid",
|
name: "DELETE method is invalid",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodDelete,
|
method: http.MethodDelete,
|
||||||
path: newRequestPath().String(),
|
path: newRequestPath().String(),
|
||||||
wantStatus: http.StatusMethodNotAllowed,
|
wantStatus: http.StatusMethodNotAllowed,
|
||||||
@ -380,6 +432,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "code param was not included on request",
|
name: "code param was not included on request",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).WithoutCode().String(),
|
path: newRequestPath().WithState(happyState).WithoutCode().String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
@ -389,6 +442,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "state param was not included on request",
|
name: "state param was not included on request",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithoutState().String(),
|
path: newRequestPath().WithoutState().String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
@ -398,7 +452,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "state param was not signed correctly, has expired, or otherwise cannot be decoded for any reason",
|
name: "state param was not signed correctly, has expired, or otherwise cannot be decoded for any reason",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState("this-will-not-decode").String(),
|
path: newRequestPath().WithState("this-will-not-decode").String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
@ -410,7 +464,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
// This shouldn't happen in practice because the authorize endpoint should have already run the same
|
// This shouldn't happen in practice because the authorize endpoint should have already run the same
|
||||||
// validations, but we would like to test the error handling in this endpoint anyway.
|
// validations, but we would like to test the error handling in this endpoint anyway.
|
||||||
name: "state param contains authorization request params which fail validation",
|
name: "state param contains authorization request params which fail validation",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(
|
path: newRequestPath().WithState(
|
||||||
happyUpstreamStateParam().
|
happyUpstreamStateParam().
|
||||||
@ -418,14 +472,18 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
Build(t, happyStateCodec),
|
Build(t, happyStateCodec),
|
||||||
).String(),
|
).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
|
|
||||||
wantStatus: http.StatusInternalServerError,
|
wantStatus: http.StatusInternalServerError,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Internal Server Error: error while generating and saving authcode\n",
|
wantBody: "Internal Server Error: error while generating and saving authcode\n",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "state's internal version does not match what we want",
|
name: "state's internal version does not match what we want",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyUpstreamStateParam().WithStateVersion("wrong-state-version").Build(t, happyStateCodec)).String(),
|
path: newRequestPath().WithState(happyUpstreamStateParam().WithStateVersion("wrong-state-version").Build(t, happyStateCodec)).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
@ -435,7 +493,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "state's downstream auth params element is invalid",
|
name: "state's downstream auth params element is invalid",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyUpstreamStateParam().
|
path: newRequestPath().WithState(happyUpstreamStateParam().
|
||||||
WithAuthorizeRequestParams("the following is an invalid url encoding token, and therefore this is an invalid param: %z").
|
WithAuthorizeRequestParams("the following is an invalid url encoding token, and therefore this is an invalid param: %z").
|
||||||
@ -447,7 +505,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "state's downstream auth params are missing required value (e.g., client_id)",
|
name: "state's downstream auth params are missing required value (e.g., client_id)",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(
|
path: newRequestPath().WithState(
|
||||||
happyUpstreamStateParam().
|
happyUpstreamStateParam().
|
||||||
@ -461,7 +519,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "state's downstream auth params does not contain openid scope",
|
name: "state's downstream auth params does not contain openid scope",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().
|
path: newRequestPath().
|
||||||
WithState(
|
WithState(
|
||||||
@ -472,18 +530,21 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: downstreamRedirectURI + `\?code=([^&]+)&scope=&state=` + happyDownstreamState,
|
wantRedirectLocationRegexp: downstreamRedirectURI + `\?code=([^&]+)&scope=&state=` + happyDownstreamState,
|
||||||
wantDownstreamIDTokenUsername: upstreamUsername,
|
wantDownstreamIDTokenUsername: oidcUpstreamUsername,
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamRequestedScopes: []string{"profile", "email"},
|
wantDownstreamRequestedScopes: []string{"profile", "email"},
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "state's downstream auth params also included offline_access scope",
|
name: "state's downstream auth params also included offline_access scope",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().
|
path: newRequestPath().
|
||||||
WithState(
|
WithState(
|
||||||
@ -494,19 +555,22 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: downstreamRedirectURI + `\?code=([^&]+)&scope=openid\+offline_access&state=` + happyDownstreamState,
|
wantRedirectLocationRegexp: downstreamRedirectURI + `\?code=([^&]+)&scope=openid\+offline_access&state=` + happyDownstreamState,
|
||||||
wantDownstreamIDTokenUsername: upstreamUsername,
|
wantDownstreamIDTokenUsername: oidcUpstreamUsername,
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamRequestedScopes: []string{"openid", "offline_access"},
|
wantDownstreamRequestedScopes: []string{"openid", "offline_access"},
|
||||||
wantDownstreamGrantedScopes: []string{"openid", "offline_access"},
|
wantDownstreamGrantedScopes: []string{"openid", "offline_access"},
|
||||||
wantDownstreamIDTokenGroups: upstreamGroupMembership,
|
wantDownstreamIDTokenGroups: oidcUpstreamGroupMembership,
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "the OIDCIdentityProvider CRD has been deleted",
|
name: "the OIDCIdentityProvider CRD has been deleted",
|
||||||
idp: otherUpstreamOIDCIdentityProvider,
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(&otherUpstreamOIDCIdentityProvider),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
@ -516,7 +580,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "the CSRF cookie does not exist on request",
|
name: "the CSRF cookie does not exist on request",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
wantStatus: http.StatusForbidden,
|
wantStatus: http.StatusForbidden,
|
||||||
@ -525,7 +589,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "cookie was not signed correctly, has expired, or otherwise cannot be decoded for any reason",
|
name: "cookie was not signed correctly, has expired, or otherwise cannot be decoded for any reason",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: "__Host-pinniped-csrf=this-value-was-not-signed-by-pinniped",
|
csrfCookie: "__Host-pinniped-csrf=this-value-was-not-signed-by-pinniped",
|
||||||
@ -535,7 +599,7 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "cookie csrf value does not match state csrf value",
|
name: "cookie csrf value does not match state csrf value",
|
||||||
idp: happyUpstream().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(happyUpstream().Build()),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyUpstreamStateParam().WithCSRF("wrong-csrf-value").Build(t, happyStateCodec)).String(),
|
path: newRequestPath().WithState(happyUpstreamStateParam().WithCSRF("wrong-csrf-value").Build(t, happyStateCodec)).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
@ -547,110 +611,235 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
// Upstream exchange
|
// Upstream exchange
|
||||||
{
|
{
|
||||||
name: "upstream auth code exchange fails",
|
name: "upstream auth code exchange fails",
|
||||||
idp: happyUpstream().WithoutUpstreamAuthcodeExchangeError(errors.New("some error")).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithUpstreamAuthcodeExchangeError(errors.New("some error")).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusBadGateway,
|
wantStatus: http.StatusBadGateway,
|
||||||
wantBody: "Bad Gateway: error exchanging and validating upstream tokens\n",
|
wantBody: "Bad Gateway: error exchanging and validating upstream tokens\n",
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token does not contain requested username claim",
|
name: "upstream ID token does not contain requested username claim",
|
||||||
idp: happyUpstream().WithoutIDTokenClaim(upstreamUsernameClaim).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithoutIDTokenClaim(oidcUpstreamUsernameClaim).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantBody: "Unprocessable Entity: no username claim in upstream ID token\n",
|
wantBody: "Unprocessable Entity: required claim in upstream ID token missing\n",
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token does not contain requested groups claim",
|
name: "upstream ID token does not contain requested groups claim",
|
||||||
idp: happyUpstream().WithoutIDTokenClaim(upstreamGroupsClaim).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithoutIDTokenClaim(oidcUpstreamGroupsClaim).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusFound,
|
wantStatus: http.StatusFound,
|
||||||
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
wantRedirectLocationRegexp: happyDownstreamRedirectLocationRegexp,
|
||||||
wantBody: "",
|
wantBody: "",
|
||||||
wantDownstreamIDTokenSubject: upstreamIssuer + "?sub=" + queryEscapedUpstreamSubject,
|
wantDownstreamIDTokenSubject: oidcUpstreamIssuer + "?sub=" + oidcUpstreamSubjectQueryEscaped,
|
||||||
wantDownstreamIDTokenUsername: upstreamUsername,
|
wantDownstreamIDTokenUsername: oidcUpstreamUsername,
|
||||||
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
wantDownstreamRequestedScopes: happyDownstreamScopesRequested,
|
||||||
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
wantDownstreamGrantedScopes: happyDownstreamScopesGranted,
|
||||||
wantDownstreamIDTokenGroups: []string{},
|
wantDownstreamIDTokenGroups: []string{},
|
||||||
wantDownstreamNonce: downstreamNonce,
|
wantDownstreamNonce: downstreamNonce,
|
||||||
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
wantDownstreamPKCEChallenge: downstreamPKCEChallenge,
|
||||||
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
wantDownstreamPKCEChallengeMethod: downstreamPKCEChallengeMethod,
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token contains username claim with weird format",
|
name: "upstream ID token contains username claim with weird format",
|
||||||
idp: happyUpstream().WithIDTokenClaim(upstreamUsernameClaim, 42).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim(oidcUpstreamUsernameClaim, 42).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: username claim in upstream ID token has invalid format\n",
|
wantBody: "Unprocessable Entity: required claim in upstream ID token has invalid format\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "upstream ID token contains username claim with empty string value",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim(oidcUpstreamUsernameClaim, "").Build(),
|
||||||
|
),
|
||||||
|
method: http.MethodGet,
|
||||||
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
|
csrfCookie: happyCSRFCookie,
|
||||||
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
|
wantContentType: htmlContentType,
|
||||||
|
wantBody: "Unprocessable Entity: required claim in upstream ID token is empty\n",
|
||||||
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token does not contain iss claim when using default username claim config",
|
name: "upstream ID token does not contain iss claim when using default username claim config",
|
||||||
idp: happyUpstream().WithIDTokenClaim("iss", "").WithoutUsernameClaim().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithoutIDTokenClaim("iss").WithoutUsernameClaim().Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: issuer claim in upstream ID token missing\n",
|
wantBody: "Unprocessable Entity: required claim in upstream ID token missing\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "upstream ID token does has an empty string value for iss claim when using default username claim config",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim("iss", "").WithoutUsernameClaim().Build(),
|
||||||
|
),
|
||||||
|
method: http.MethodGet,
|
||||||
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
|
csrfCookie: happyCSRFCookie,
|
||||||
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
|
wantContentType: htmlContentType,
|
||||||
|
wantBody: "Unprocessable Entity: required claim in upstream ID token is empty\n",
|
||||||
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token has an non-string iss claim when using default username claim config",
|
name: "upstream ID token has an non-string iss claim when using default username claim config",
|
||||||
idp: happyUpstream().WithIDTokenClaim("iss", 42).WithoutUsernameClaim().Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim("iss", 42).WithoutUsernameClaim().Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: issuer claim in upstream ID token has invalid format\n",
|
wantBody: "Unprocessable Entity: required claim in upstream ID token has invalid format\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "upstream ID token does not contain sub claim when using default username claim config",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithoutIDTokenClaim("sub").WithoutUsernameClaim().Build(),
|
||||||
|
),
|
||||||
|
method: http.MethodGet,
|
||||||
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
|
csrfCookie: happyCSRFCookie,
|
||||||
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
|
wantContentType: htmlContentType,
|
||||||
|
wantBody: "Unprocessable Entity: required claim in upstream ID token missing\n",
|
||||||
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "upstream ID token does has an empty string value for sub claim when using default username claim config",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim("sub", "").WithoutUsernameClaim().Build(),
|
||||||
|
),
|
||||||
|
method: http.MethodGet,
|
||||||
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
|
csrfCookie: happyCSRFCookie,
|
||||||
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
|
wantContentType: htmlContentType,
|
||||||
|
wantBody: "Unprocessable Entity: required claim in upstream ID token is empty\n",
|
||||||
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "upstream ID token has an non-string sub claim when using default username claim config",
|
||||||
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim("sub", 42).WithoutUsernameClaim().Build(),
|
||||||
|
),
|
||||||
|
method: http.MethodGet,
|
||||||
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
|
csrfCookie: happyCSRFCookie,
|
||||||
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
|
wantContentType: htmlContentType,
|
||||||
|
wantBody: "Unprocessable Entity: required claim in upstream ID token has invalid format\n",
|
||||||
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token contains groups claim with weird format",
|
name: "upstream ID token contains groups claim with weird format",
|
||||||
idp: happyUpstream().WithIDTokenClaim(upstreamGroupsClaim, 42).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim(oidcUpstreamGroupsClaim, 42).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: groups claim in upstream ID token has invalid format\n",
|
wantBody: "Unprocessable Entity: required claim in upstream ID token has invalid format\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token contains groups claim where one element is invalid",
|
name: "upstream ID token contains groups claim where one element is invalid",
|
||||||
idp: happyUpstream().WithIDTokenClaim(upstreamGroupsClaim, []interface{}{"foo", 7}).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim(oidcUpstreamGroupsClaim, []interface{}{"foo", 7}).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: groups claim in upstream ID token has invalid format\n",
|
wantBody: "Unprocessable Entity: required claim in upstream ID token has invalid format\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "upstream ID token contains groups claim with invalid null type",
|
name: "upstream ID token contains groups claim with invalid null type",
|
||||||
idp: happyUpstream().WithIDTokenClaim(upstreamGroupsClaim, nil).Build(),
|
idps: oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(
|
||||||
|
happyUpstream().WithIDTokenClaim(oidcUpstreamGroupsClaim, nil).Build(),
|
||||||
|
),
|
||||||
method: http.MethodGet,
|
method: http.MethodGet,
|
||||||
path: newRequestPath().WithState(happyState).String(),
|
path: newRequestPath().WithState(happyState).String(),
|
||||||
csrfCookie: happyCSRFCookie,
|
csrfCookie: happyCSRFCookie,
|
||||||
wantStatus: http.StatusUnprocessableEntity,
|
wantStatus: http.StatusUnprocessableEntity,
|
||||||
wantContentType: htmlContentType,
|
wantContentType: htmlContentType,
|
||||||
wantBody: "Unprocessable Entity: groups claim in upstream ID token has invalid format\n",
|
wantBody: "Unprocessable Entity: required claim in upstream ID token has invalid format\n",
|
||||||
wantExchangeAndValidateTokensCall: happyExchangeAndValidateTokensArgs,
|
wantAuthcodeExchangeCall: &expectedAuthcodeExchange{
|
||||||
|
performedByUpstreamName: happyUpstreamIDPName,
|
||||||
|
args: happyExchangeAndValidateTokensArgs,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
for _, test := range tests {
|
for _, test := range tests {
|
||||||
@ -669,9 +858,9 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
jwksProviderIsUnused := jwks.NewDynamicJWKSProvider()
|
jwksProviderIsUnused := jwks.NewDynamicJWKSProvider()
|
||||||
oauthHelper := oidc.FositeOauth2Helper(oauthStore, downstreamIssuer, hmacSecretFunc, jwksProviderIsUnused, timeoutsConfiguration)
|
oauthHelper := oidc.FositeOauth2Helper(oauthStore, downstreamIssuer, hmacSecretFunc, jwksProviderIsUnused, timeoutsConfiguration)
|
||||||
|
|
||||||
idpLister := oidctestutil.NewUpstreamIDPListerBuilder().WithOIDC(&test.idp).Build()
|
subject := NewHandler(test.idps.Build(), oauthHelper, happyStateCodec, happyCookieCodec, happyUpstreamRedirectURI)
|
||||||
subject := NewHandler(idpLister, oauthHelper, happyStateCodec, happyCookieCodec, happyUpstreamRedirectURI)
|
reqContext := context.WithValue(context.Background(), struct{ name string }{name: "test"}, "request-context")
|
||||||
req := httptest.NewRequest(test.method, test.path, nil)
|
req := httptest.NewRequest(test.method, test.path, nil).WithContext(reqContext)
|
||||||
if test.csrfCookie != "" {
|
if test.csrfCookie != "" {
|
||||||
req.Header.Set("Cookie", test.csrfCookie)
|
req.Header.Set("Cookie", test.csrfCookie)
|
||||||
}
|
}
|
||||||
@ -682,12 +871,13 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
|
|
||||||
testutil.RequireSecurityHeaders(t, rsp)
|
testutil.RequireSecurityHeaders(t, rsp)
|
||||||
|
|
||||||
if test.wantExchangeAndValidateTokensCall != nil {
|
if test.wantAuthcodeExchangeCall != nil {
|
||||||
require.Equal(t, 1, test.idp.ExchangeAuthcodeAndValidateTokensCallCount())
|
test.wantAuthcodeExchangeCall.args.Ctx = reqContext
|
||||||
test.wantExchangeAndValidateTokensCall.Ctx = req.Context()
|
test.idps.RequireExactlyOneCallToExchangeAuthcodeAndValidateTokens(t,
|
||||||
require.Equal(t, test.wantExchangeAndValidateTokensCall, test.idp.ExchangeAuthcodeAndValidateTokensArgs(0))
|
test.wantAuthcodeExchangeCall.performedByUpstreamName, test.wantAuthcodeExchangeCall.args,
|
||||||
|
)
|
||||||
} else {
|
} else {
|
||||||
require.Equal(t, 0, test.idp.ExchangeAuthcodeAndValidateTokensCallCount())
|
test.idps.RequireExactlyZeroCallsToExchangeAuthcodeAndValidateTokens(t)
|
||||||
}
|
}
|
||||||
|
|
||||||
require.Equal(t, test.wantStatus, rsp.Code)
|
require.Equal(t, test.wantStatus, rsp.Code)
|
||||||
@ -749,6 +939,11 @@ func TestCallbackEndpoint(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type expectedAuthcodeExchange struct {
|
||||||
|
performedByUpstreamName string
|
||||||
|
args *oidctestutil.ExchangeAuthcodeAndValidateTokenArgs
|
||||||
|
}
|
||||||
|
|
||||||
type requestPath struct {
|
type requestPath struct {
|
||||||
code, state *string
|
code, state *string
|
||||||
}
|
}
|
||||||
@ -838,70 +1033,20 @@ func (b *upstreamStateParamBuilder) WithStateVersion(version string) *upstreamSt
|
|||||||
return b
|
return b
|
||||||
}
|
}
|
||||||
|
|
||||||
type upstreamOIDCIdentityProviderBuilder struct {
|
func happyUpstream() *oidctestutil.TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
idToken map[string]interface{}
|
return oidctestutil.NewTestUpstreamOIDCIdentityProviderBuilder().
|
||||||
usernameClaim, groupsClaim string
|
WithName(happyUpstreamIDPName).
|
||||||
authcodeExchangeErr error
|
WithClientID("some-client-id").
|
||||||
}
|
WithScopes([]string{"scope1", "scope2"}).
|
||||||
|
WithUsernameClaim(oidcUpstreamUsernameClaim).
|
||||||
func happyUpstream() *upstreamOIDCIdentityProviderBuilder {
|
WithGroupsClaim(oidcUpstreamGroupsClaim).
|
||||||
return &upstreamOIDCIdentityProviderBuilder{
|
WithIDTokenClaim("iss", oidcUpstreamIssuer).
|
||||||
usernameClaim: upstreamUsernameClaim,
|
WithIDTokenClaim("sub", oidcUpstreamSubject).
|
||||||
groupsClaim: upstreamGroupsClaim,
|
WithIDTokenClaim(oidcUpstreamUsernameClaim, oidcUpstreamUsername).
|
||||||
idToken: map[string]interface{}{
|
WithIDTokenClaim(oidcUpstreamGroupsClaim, oidcUpstreamGroupMembership).
|
||||||
"iss": upstreamIssuer,
|
WithIDTokenClaim("other-claim", "should be ignored").
|
||||||
"sub": upstreamSubject,
|
WithAllowPasswordGrant(false).
|
||||||
upstreamUsernameClaim: upstreamUsername,
|
WithPasswordGrantError(errors.New("the callback endpoint should not use password grants"))
|
||||||
upstreamGroupsClaim: upstreamGroupMembership,
|
|
||||||
"other-claim": "should be ignored",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *upstreamOIDCIdentityProviderBuilder) WithUsernameClaim(value string) *upstreamOIDCIdentityProviderBuilder {
|
|
||||||
u.usernameClaim = value
|
|
||||||
return u
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *upstreamOIDCIdentityProviderBuilder) WithoutUsernameClaim() *upstreamOIDCIdentityProviderBuilder {
|
|
||||||
u.usernameClaim = ""
|
|
||||||
return u
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *upstreamOIDCIdentityProviderBuilder) WithoutGroupsClaim() *upstreamOIDCIdentityProviderBuilder {
|
|
||||||
u.groupsClaim = ""
|
|
||||||
return u
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *upstreamOIDCIdentityProviderBuilder) WithIDTokenClaim(name string, value interface{}) *upstreamOIDCIdentityProviderBuilder {
|
|
||||||
u.idToken[name] = value
|
|
||||||
return u
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *upstreamOIDCIdentityProviderBuilder) WithoutIDTokenClaim(claim string) *upstreamOIDCIdentityProviderBuilder {
|
|
||||||
delete(u.idToken, claim)
|
|
||||||
return u
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *upstreamOIDCIdentityProviderBuilder) WithoutUpstreamAuthcodeExchangeError(err error) *upstreamOIDCIdentityProviderBuilder {
|
|
||||||
u.authcodeExchangeErr = err
|
|
||||||
return u
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *upstreamOIDCIdentityProviderBuilder) Build() oidctestutil.TestUpstreamOIDCIdentityProvider {
|
|
||||||
return oidctestutil.TestUpstreamOIDCIdentityProvider{
|
|
||||||
Name: happyUpstreamIDPName,
|
|
||||||
ClientID: "some-client-id",
|
|
||||||
UsernameClaim: u.usernameClaim,
|
|
||||||
GroupsClaim: u.groupsClaim,
|
|
||||||
Scopes: []string{"scope1", "scope2"},
|
|
||||||
ExchangeAuthcodeAndValidateTokensFunc: func(ctx context.Context, authcode string, pkceCodeVerifier oidcpkce.Code, expectedIDTokenNonce nonce.Nonce) (*oidctypes.Token, error) {
|
|
||||||
if u.authcodeExchangeErr != nil {
|
|
||||||
return nil, u.authcodeExchangeErr
|
|
||||||
}
|
|
||||||
return &oidctypes.Token{IDToken: &oidctypes.IDToken{Claims: u.idToken}}, nil
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func shallowCopyAndModifyQuery(query url.Values, modifications map[string]string) url.Values {
|
func shallowCopyAndModifyQuery(query url.Values, modifications map[string]string) url.Values {
|
||||||
|
@ -9,6 +9,7 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
|
"go.pinniped.dev/generated/latest/apis/supervisor/idpdiscovery/v1alpha1"
|
||||||
"go.pinniped.dev/internal/oidc"
|
"go.pinniped.dev/internal/oidc"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -41,20 +42,11 @@ type Metadata struct {
|
|||||||
|
|
||||||
// vvv Custom vvv
|
// vvv Custom vvv
|
||||||
|
|
||||||
SupervisorDiscovery SupervisorDiscoveryMetadataV1Alpha1 `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
|
v1alpha1.OIDCDiscoveryResponse
|
||||||
|
|
||||||
// ^^^ Custom ^^^
|
// ^^^ Custom ^^^
|
||||||
}
|
}
|
||||||
|
|
||||||
type SupervisorDiscoveryMetadataV1Alpha1 struct {
|
|
||||||
PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type IdentityProviderMetadata struct {
|
|
||||||
Name string `json:"name"`
|
|
||||||
Type string `json:"type"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewHandler returns an http.Handler that serves an OIDC discovery endpoint.
|
// NewHandler returns an http.Handler that serves an OIDC discovery endpoint.
|
||||||
func NewHandler(issuerURL string) http.Handler {
|
func NewHandler(issuerURL string) http.Handler {
|
||||||
oidcConfig := Metadata{
|
oidcConfig := Metadata{
|
||||||
@ -62,7 +54,11 @@ func NewHandler(issuerURL string) http.Handler {
|
|||||||
AuthorizationEndpoint: issuerURL + oidc.AuthorizationEndpointPath,
|
AuthorizationEndpoint: issuerURL + oidc.AuthorizationEndpointPath,
|
||||||
TokenEndpoint: issuerURL + oidc.TokenEndpointPath,
|
TokenEndpoint: issuerURL + oidc.TokenEndpointPath,
|
||||||
JWKSURI: issuerURL + oidc.JWKSEndpointPath,
|
JWKSURI: issuerURL + oidc.JWKSEndpointPath,
|
||||||
SupervisorDiscovery: SupervisorDiscoveryMetadataV1Alpha1{PinnipedIDPsEndpoint: issuerURL + oidc.PinnipedIDPsPathV1Alpha1},
|
OIDCDiscoveryResponse: v1alpha1.OIDCDiscoveryResponse{
|
||||||
|
SupervisorDiscovery: v1alpha1.OIDCDiscoveryResponseIDPEndpoint{
|
||||||
|
PinnipedIDPsEndpoint: issuerURL + oidc.PinnipedIDPsPathV1Alpha1,
|
||||||
|
},
|
||||||
|
},
|
||||||
ResponseTypesSupported: []string{"code"},
|
ResponseTypesSupported: []string{"code"},
|
||||||
ResponseModesSupported: []string{"query", "form_post"},
|
ResponseModesSupported: []string{"query", "form_post"},
|
||||||
SubjectTypesSupported: []string{"public"},
|
SubjectTypesSupported: []string{"public"},
|
||||||
|
@ -4,13 +4,13 @@
|
|||||||
package discovery
|
package discovery
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"go.pinniped.dev/internal/here"
|
||||||
"go.pinniped.dev/internal/oidc"
|
"go.pinniped.dev/internal/oidc"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -24,7 +24,7 @@ func TestDiscovery(t *testing.T) {
|
|||||||
|
|
||||||
wantStatus int
|
wantStatus int
|
||||||
wantContentType string
|
wantContentType string
|
||||||
wantBodyJSON interface{}
|
wantBodyJSON string
|
||||||
wantBodyString string
|
wantBodyString string
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
@ -34,22 +34,24 @@ func TestDiscovery(t *testing.T) {
|
|||||||
path: "/some/path" + oidc.WellKnownEndpointPath,
|
path: "/some/path" + oidc.WellKnownEndpointPath,
|
||||||
wantStatus: http.StatusOK,
|
wantStatus: http.StatusOK,
|
||||||
wantContentType: "application/json",
|
wantContentType: "application/json",
|
||||||
wantBodyJSON: &Metadata{
|
wantBodyJSON: here.Doc(`
|
||||||
Issuer: "https://some-issuer.com/some/path",
|
{
|
||||||
AuthorizationEndpoint: "https://some-issuer.com/some/path/oauth2/authorize",
|
"issuer": "https://some-issuer.com/some/path",
|
||||||
TokenEndpoint: "https://some-issuer.com/some/path/oauth2/token",
|
"authorization_endpoint": "https://some-issuer.com/some/path/oauth2/authorize",
|
||||||
JWKSURI: "https://some-issuer.com/some/path/jwks.json",
|
"token_endpoint": "https://some-issuer.com/some/path/oauth2/token",
|
||||||
SupervisorDiscovery: SupervisorDiscoveryMetadataV1Alpha1{
|
"jwks_uri": "https://some-issuer.com/some/path/jwks.json",
|
||||||
PinnipedIDPsEndpoint: "https://some-issuer.com/some/path/v1alpha1/pinniped_identity_providers",
|
"response_types_supported": ["code"],
|
||||||
},
|
"response_modes_supported": ["query", "form_post"],
|
||||||
ResponseTypesSupported: []string{"code"},
|
"subject_types_supported": ["public"],
|
||||||
ResponseModesSupported: []string{"query", "form_post"},
|
"id_token_signing_alg_values_supported": ["ES256"],
|
||||||
SubjectTypesSupported: []string{"public"},
|
"token_endpoint_auth_methods_supported": ["client_secret_basic"],
|
||||||
IDTokenSigningAlgValuesSupported: []string{"ES256"},
|
"scopes_supported": ["openid", "offline"],
|
||||||
TokenEndpointAuthMethodsSupported: []string{"client_secret_basic"},
|
"claims_supported": ["groups"],
|
||||||
ScopesSupported: []string{"openid", "offline"},
|
"discovery.supervisor.pinniped.dev/v1alpha1": {
|
||||||
ClaimsSupported: []string{"groups"},
|
"pinniped_identity_providers_endpoint": "https://some-issuer.com/some/path/v1alpha1/pinniped_identity_providers"
|
||||||
},
|
}
|
||||||
|
}
|
||||||
|
`),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "bad method",
|
name: "bad method",
|
||||||
@ -73,10 +75,8 @@ func TestDiscovery(t *testing.T) {
|
|||||||
|
|
||||||
require.Equal(t, test.wantContentType, rsp.Header().Get("Content-Type"))
|
require.Equal(t, test.wantContentType, rsp.Header().Get("Content-Type"))
|
||||||
|
|
||||||
if test.wantBodyJSON != nil {
|
if test.wantBodyJSON != "" {
|
||||||
wantJSON, err := json.Marshal(test.wantBodyJSON)
|
require.JSONEq(t, test.wantBodyJSON, rsp.Body.String())
|
||||||
require.NoError(t, err)
|
|
||||||
require.JSONEq(t, string(wantJSON), rsp.Body.String())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if test.wantBodyString != "" {
|
if test.wantBodyString != "" {
|
||||||
|
@ -5,6 +5,8 @@
|
|||||||
package downstreamsession
|
package downstreamsession
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/url"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
oidc2 "github.com/coreos/go-oidc/v3/oidc"
|
oidc2 "github.com/coreos/go-oidc/v3/oidc"
|
||||||
@ -12,7 +14,24 @@ import (
|
|||||||
"github.com/ory/fosite/handler/openid"
|
"github.com/ory/fosite/handler/openid"
|
||||||
"github.com/ory/fosite/token/jwt"
|
"github.com/ory/fosite/token/jwt"
|
||||||
|
|
||||||
|
"go.pinniped.dev/internal/constable"
|
||||||
"go.pinniped.dev/internal/oidc"
|
"go.pinniped.dev/internal/oidc"
|
||||||
|
"go.pinniped.dev/internal/oidc/provider"
|
||||||
|
"go.pinniped.dev/internal/plog"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// The name of the email claim from https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||||
|
emailClaimName = "email"
|
||||||
|
|
||||||
|
// The name of the email_verified claim from https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||||
|
emailVerifiedClaimName = "email_verified"
|
||||||
|
|
||||||
|
requiredClaimMissingErr = constable.Error("required claim in upstream ID token missing")
|
||||||
|
requiredClaimInvalidFormatErr = constable.Error("required claim in upstream ID token has invalid format")
|
||||||
|
requiredClaimEmptyErr = constable.Error("required claim in upstream ID token is empty")
|
||||||
|
emailVerifiedClaimInvalidFormatErr = constable.Error("email_verified claim in upstream ID token has invalid format")
|
||||||
|
emailVerifiedClaimFalseErr = constable.Error("email_verified claim in upstream ID token has false value")
|
||||||
)
|
)
|
||||||
|
|
||||||
// MakeDownstreamSession creates a downstream OIDC session.
|
// MakeDownstreamSession creates a downstream OIDC session.
|
||||||
@ -41,3 +60,173 @@ func GrantScopesIfRequested(authorizeRequester fosite.AuthorizeRequester) {
|
|||||||
oidc.GrantScopeIfRequested(authorizeRequester, oidc2.ScopeOfflineAccess)
|
oidc.GrantScopeIfRequested(authorizeRequester, oidc2.ScopeOfflineAccess)
|
||||||
oidc.GrantScopeIfRequested(authorizeRequester, "pinniped:request-audience")
|
oidc.GrantScopeIfRequested(authorizeRequester, "pinniped:request-audience")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetDownstreamIdentityFromUpstreamIDToken returns the mapped subject, username, and group names, in that order.
|
||||||
|
func GetDownstreamIdentityFromUpstreamIDToken(
|
||||||
|
upstreamIDPConfig provider.UpstreamOIDCIdentityProviderI,
|
||||||
|
idTokenClaims map[string]interface{},
|
||||||
|
) (string, string, []string, error) {
|
||||||
|
subject, username, err := getSubjectAndUsernameFromUpstreamIDToken(upstreamIDPConfig, idTokenClaims)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
groups, err := getGroupsFromUpstreamIDToken(upstreamIDPConfig, idTokenClaims)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return subject, username, groups, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func getSubjectAndUsernameFromUpstreamIDToken(
|
||||||
|
upstreamIDPConfig provider.UpstreamOIDCIdentityProviderI,
|
||||||
|
idTokenClaims map[string]interface{},
|
||||||
|
) (string, string, error) {
|
||||||
|
// The spec says the "sub" claim is only unique per issuer,
|
||||||
|
// so we will prepend the issuer string to make it globally unique.
|
||||||
|
upstreamIssuer, err := extractStringClaimValue(oidc.IDTokenIssuerClaim, upstreamIDPConfig.GetName(), idTokenClaims)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
upstreamSubject, err := extractStringClaimValue(oidc.IDTokenSubjectClaim, upstreamIDPConfig.GetName(), idTokenClaims)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
subject := downstreamSubjectFromUpstreamOIDC(upstreamIssuer, upstreamSubject)
|
||||||
|
|
||||||
|
usernameClaimName := upstreamIDPConfig.GetUsernameClaim()
|
||||||
|
if usernameClaimName == "" {
|
||||||
|
return subject, subject, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the upstream username claim is configured to be the special "email" claim and the upstream "email_verified"
|
||||||
|
// claim is present, then validate that the "email_verified" claim is true.
|
||||||
|
emailVerifiedAsInterface, ok := idTokenClaims[emailVerifiedClaimName]
|
||||||
|
if usernameClaimName == emailClaimName && ok {
|
||||||
|
emailVerified, ok := emailVerifiedAsInterface.(bool)
|
||||||
|
if !ok {
|
||||||
|
plog.Warning(
|
||||||
|
"username claim configured as \"email\" and upstream email_verified claim is not a boolean",
|
||||||
|
"upstreamName", upstreamIDPConfig.GetName(),
|
||||||
|
"configuredUsernameClaim", usernameClaimName,
|
||||||
|
"emailVerifiedClaim", emailVerifiedAsInterface,
|
||||||
|
)
|
||||||
|
return "", "", emailVerifiedClaimInvalidFormatErr
|
||||||
|
}
|
||||||
|
if !emailVerified {
|
||||||
|
plog.Warning(
|
||||||
|
"username claim configured as \"email\" and upstream email_verified claim has false value",
|
||||||
|
"upstreamName", upstreamIDPConfig.GetName(),
|
||||||
|
"configuredUsernameClaim", usernameClaimName,
|
||||||
|
)
|
||||||
|
return "", "", emailVerifiedClaimFalseErr
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
username, err := extractStringClaimValue(usernameClaimName, upstreamIDPConfig.GetName(), idTokenClaims)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return subject, username, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func extractStringClaimValue(claimName string, upstreamIDPName string, idTokenClaims map[string]interface{}) (string, error) {
|
||||||
|
value, ok := idTokenClaims[claimName]
|
||||||
|
if !ok {
|
||||||
|
plog.Warning(
|
||||||
|
"required claim in upstream ID token missing",
|
||||||
|
"upstreamName", upstreamIDPName,
|
||||||
|
"claimName", claimName,
|
||||||
|
)
|
||||||
|
return "", requiredClaimMissingErr
|
||||||
|
}
|
||||||
|
|
||||||
|
valueAsString, ok := value.(string)
|
||||||
|
if !ok {
|
||||||
|
plog.Warning(
|
||||||
|
"required claim in upstream ID token is not a string value",
|
||||||
|
"upstreamName", upstreamIDPName,
|
||||||
|
"claimName", claimName,
|
||||||
|
)
|
||||||
|
return "", requiredClaimInvalidFormatErr
|
||||||
|
}
|
||||||
|
|
||||||
|
if valueAsString == "" {
|
||||||
|
plog.Warning(
|
||||||
|
"required claim in upstream ID token has an empty string value",
|
||||||
|
"upstreamName", upstreamIDPName,
|
||||||
|
"claimName", claimName,
|
||||||
|
)
|
||||||
|
return "", requiredClaimEmptyErr
|
||||||
|
}
|
||||||
|
|
||||||
|
return valueAsString, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func downstreamSubjectFromUpstreamOIDC(upstreamIssuerAsString string, upstreamSubject string) string {
|
||||||
|
return fmt.Sprintf("%s?%s=%s", upstreamIssuerAsString, oidc.IDTokenSubjectClaim, url.QueryEscape(upstreamSubject))
|
||||||
|
}
|
||||||
|
|
||||||
|
func getGroupsFromUpstreamIDToken(
|
||||||
|
upstreamIDPConfig provider.UpstreamOIDCIdentityProviderI,
|
||||||
|
idTokenClaims map[string]interface{},
|
||||||
|
) ([]string, error) {
|
||||||
|
groupsClaimName := upstreamIDPConfig.GetGroupsClaim()
|
||||||
|
if groupsClaimName == "" {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
groupsAsInterface, ok := idTokenClaims[groupsClaimName]
|
||||||
|
if !ok {
|
||||||
|
plog.Warning(
|
||||||
|
"no groups claim in upstream ID token",
|
||||||
|
"upstreamName", upstreamIDPConfig.GetName(),
|
||||||
|
"configuredGroupsClaim", groupsClaimName,
|
||||||
|
)
|
||||||
|
return nil, nil // the upstream IDP may have omitted the claim if the user has no groups
|
||||||
|
}
|
||||||
|
|
||||||
|
groupsAsArray, okAsArray := extractGroups(groupsAsInterface)
|
||||||
|
if !okAsArray {
|
||||||
|
plog.Warning(
|
||||||
|
"groups claim in upstream ID token has invalid format",
|
||||||
|
"upstreamName", upstreamIDPConfig.GetName(),
|
||||||
|
"configuredGroupsClaim", groupsClaimName,
|
||||||
|
)
|
||||||
|
return nil, requiredClaimInvalidFormatErr
|
||||||
|
}
|
||||||
|
|
||||||
|
return groupsAsArray, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func extractGroups(groupsAsInterface interface{}) ([]string, bool) {
|
||||||
|
groupsAsString, okAsString := groupsAsInterface.(string)
|
||||||
|
if okAsString {
|
||||||
|
return []string{groupsAsString}, true
|
||||||
|
}
|
||||||
|
|
||||||
|
groupsAsStringArray, okAsStringArray := groupsAsInterface.([]string)
|
||||||
|
if okAsStringArray {
|
||||||
|
return groupsAsStringArray, true
|
||||||
|
}
|
||||||
|
|
||||||
|
groupsAsInterfaceArray, okAsArray := groupsAsInterface.([]interface{})
|
||||||
|
if !okAsArray {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
var groupsAsStrings []string
|
||||||
|
for _, groupAsInterface := range groupsAsInterfaceArray {
|
||||||
|
groupAsString, okAsString := groupAsInterface.(string)
|
||||||
|
if !okAsString {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
if groupAsString != "" {
|
||||||
|
groupsAsStrings = append(groupsAsStrings, groupAsString)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return groupsAsStrings, true
|
||||||
|
}
|
||||||
|
@ -10,24 +10,10 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"sort"
|
"sort"
|
||||||
|
|
||||||
|
"go.pinniped.dev/generated/latest/apis/supervisor/idpdiscovery/v1alpha1"
|
||||||
"go.pinniped.dev/internal/oidc"
|
"go.pinniped.dev/internal/oidc"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
|
||||||
idpDiscoveryTypeLDAP = "ldap"
|
|
||||||
idpDiscoveryTypeOIDC = "oidc"
|
|
||||||
idpDiscoveryTypeActiveDirectory = "activedirectory"
|
|
||||||
)
|
|
||||||
|
|
||||||
type response struct {
|
|
||||||
IDPs []identityProviderResponse `json:"pinniped_identity_providers"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type identityProviderResponse struct {
|
|
||||||
Name string `json:"name"`
|
|
||||||
Type string `json:"type"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewHandler returns an http.Handler that serves the upstream IDP discovery endpoint.
|
// NewHandler returns an http.Handler that serves the upstream IDP discovery endpoint.
|
||||||
func NewHandler(upstreamIDPs oidc.UpstreamIdentityProvidersLister) http.Handler {
|
func NewHandler(upstreamIDPs oidc.UpstreamIdentityProvidersLister) http.Handler {
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
@ -51,24 +37,38 @@ func NewHandler(upstreamIDPs oidc.UpstreamIdentityProvidersLister) http.Handler
|
|||||||
}
|
}
|
||||||
|
|
||||||
func responseAsJSON(upstreamIDPs oidc.UpstreamIdentityProvidersLister) ([]byte, error) {
|
func responseAsJSON(upstreamIDPs oidc.UpstreamIdentityProvidersLister) ([]byte, error) {
|
||||||
r := response{
|
r := v1alpha1.IDPDiscoveryResponse{PinnipedIDPs: []v1alpha1.PinnipedIDP{}}
|
||||||
IDPs: []identityProviderResponse{},
|
|
||||||
}
|
|
||||||
|
|
||||||
// The cache of IDPs could change at any time, so always recalculate the list.
|
// The cache of IDPs could change at any time, so always recalculate the list.
|
||||||
for _, provider := range upstreamIDPs.GetLDAPIdentityProviders() {
|
for _, provider := range upstreamIDPs.GetLDAPIdentityProviders() {
|
||||||
r.IDPs = append(r.IDPs, identityProviderResponse{Name: provider.GetName(), Type: idpDiscoveryTypeLDAP})
|
r.PinnipedIDPs = append(r.PinnipedIDPs, v1alpha1.PinnipedIDP{
|
||||||
|
Name: provider.GetName(),
|
||||||
|
Type: v1alpha1.IDPTypeLDAP,
|
||||||
|
Flows: []v1alpha1.IDPFlow{v1alpha1.IDPFlowCLIPassword},
|
||||||
|
})
|
||||||
}
|
}
|
||||||
for _, provider := range upstreamIDPs.GetActiveDirectoryIdentityProviders() {
|
for _, provider := range upstreamIDPs.GetActiveDirectoryIdentityProviders() {
|
||||||
r.IDPs = append(r.IDPs, identityProviderResponse{Name: provider.GetName(), Type: idpDiscoveryTypeActiveDirectory})
|
r.PinnipedIDPs = append(r.PinnipedIDPs, v1alpha1.PinnipedIDP{
|
||||||
|
Name: provider.GetName(),
|
||||||
|
Type: v1alpha1.IDPTypeActiveDirectory,
|
||||||
|
Flows: []v1alpha1.IDPFlow{v1alpha1.IDPFlowCLIPassword},
|
||||||
|
})
|
||||||
}
|
}
|
||||||
for _, provider := range upstreamIDPs.GetOIDCIdentityProviders() {
|
for _, provider := range upstreamIDPs.GetOIDCIdentityProviders() {
|
||||||
r.IDPs = append(r.IDPs, identityProviderResponse{Name: provider.GetName(), Type: idpDiscoveryTypeOIDC})
|
flows := []v1alpha1.IDPFlow{v1alpha1.IDPFlowBrowserAuthcode}
|
||||||
|
if provider.AllowsPasswordGrant() {
|
||||||
|
flows = append(flows, v1alpha1.IDPFlowCLIPassword)
|
||||||
|
}
|
||||||
|
r.PinnipedIDPs = append(r.PinnipedIDPs, v1alpha1.PinnipedIDP{
|
||||||
|
Name: provider.GetName(),
|
||||||
|
Type: v1alpha1.IDPTypeOIDC,
|
||||||
|
Flows: flows,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Nobody like an API that changes the results unnecessarily. :)
|
// Nobody like an API that changes the results unnecessarily. :)
|
||||||
sort.SliceStable(r.IDPs, func(i, j int) bool {
|
sort.SliceStable(r.PinnipedIDPs, func(i, j int) bool {
|
||||||
return r.IDPs[i].Name < r.IDPs[j].Name
|
return r.PinnipedIDPs[i].Name < r.PinnipedIDPs[j].Name
|
||||||
})
|
})
|
||||||
|
|
||||||
var b bytes.Buffer
|
var b bytes.Buffer
|
||||||
|
@ -4,13 +4,13 @@
|
|||||||
package idpdiscovery
|
package idpdiscovery
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"go.pinniped.dev/internal/here"
|
||||||
"go.pinniped.dev/internal/oidc"
|
"go.pinniped.dev/internal/oidc"
|
||||||
"go.pinniped.dev/internal/oidc/provider"
|
"go.pinniped.dev/internal/oidc/provider"
|
||||||
"go.pinniped.dev/internal/testutil/oidctestutil"
|
"go.pinniped.dev/internal/testutil/oidctestutil"
|
||||||
@ -25,8 +25,8 @@ func TestIDPDiscovery(t *testing.T) {
|
|||||||
|
|
||||||
wantStatus int
|
wantStatus int
|
||||||
wantContentType string
|
wantContentType string
|
||||||
wantFirstResponseBodyJSON interface{}
|
wantFirstResponseBodyJSON string
|
||||||
wantSecondResponseBodyJSON interface{}
|
wantSecondResponseBodyJSON string
|
||||||
wantBodyString string
|
wantBodyString string
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
@ -35,28 +35,28 @@ func TestIDPDiscovery(t *testing.T) {
|
|||||||
path: "/some/path" + oidc.WellKnownEndpointPath,
|
path: "/some/path" + oidc.WellKnownEndpointPath,
|
||||||
wantStatus: http.StatusOK,
|
wantStatus: http.StatusOK,
|
||||||
wantContentType: "application/json",
|
wantContentType: "application/json",
|
||||||
wantFirstResponseBodyJSON: &response{
|
wantFirstResponseBodyJSON: here.Doc(`{
|
||||||
IDPs: []identityProviderResponse{
|
"pinniped_identity_providers": [
|
||||||
{Name: "a-some-ldap-idp", Type: "ldap"},
|
{"name": "a-some-ldap-idp", "type": "ldap", "flows": ["cli_password"]},
|
||||||
{Name: "a-some-oidc-idp", Type: "oidc"},
|
{"name": "a-some-oidc-idp", "type": "oidc", "flows": ["browser_authcode"]},
|
||||||
{Name: "x-some-idp", Type: "ldap"},
|
{"name": "x-some-idp", "type": "ldap", "flows": ["cli_password"]},
|
||||||
{Name: "x-some-idp", Type: "oidc"},
|
{"name": "x-some-idp", "type": "oidc", "flows": ["browser_authcode"]},
|
||||||
{Name: "y-some-ad-idp", Type: "activedirectory"},
|
{"name": "y-some-ad-idp", "type": "activedirectory", "flows": ["cli_password"]},
|
||||||
{Name: "z-some-ad-idp", Type: "activedirectory"},
|
{"name": "z-some-ad-idp", "type": "activedirectory", "flows": ["cli_password"]},
|
||||||
{Name: "z-some-ldap-idp", Type: "ldap"},
|
{"name": "z-some-ldap-idp", "type": "ldap", "flows": ["cli_password"]},
|
||||||
{Name: "z-some-oidc-idp", Type: "oidc"},
|
{"name": "z-some-oidc-idp", "type": "oidc", "flows": ["browser_authcode", "cli_password"]}
|
||||||
},
|
]
|
||||||
},
|
}`),
|
||||||
wantSecondResponseBodyJSON: &response{
|
wantSecondResponseBodyJSON: here.Doc(`{
|
||||||
IDPs: []identityProviderResponse{
|
"pinniped_identity_providers": [
|
||||||
{Name: "some-other-ad-idp-1", Type: "activedirectory"},
|
{"name": "some-other-ad-idp-1", "type": "activedirectory", "flows": ["cli_password"]},
|
||||||
{Name: "some-other-ad-idp-2", Type: "activedirectory"},
|
{"name": "some-other-ad-idp-2", "type": "activedirectory", "flows": ["cli_password"]},
|
||||||
{Name: "some-other-ldap-idp-1", Type: "ldap"},
|
{"name": "some-other-ldap-idp-1", "type": "ldap", "flows": ["cli_password"]},
|
||||||
{Name: "some-other-ldap-idp-2", Type: "ldap"},
|
{"name": "some-other-ldap-idp-2", "type": "ldap", "flows": ["cli_password"]},
|
||||||
{Name: "some-other-oidc-idp-1", Type: "oidc"},
|
{"name": "some-other-oidc-idp-1", "type": "oidc", "flows": ["browser_authcode", "cli_password"]},
|
||||||
{Name: "some-other-oidc-idp-2", Type: "oidc"},
|
{"name": "some-other-oidc-idp-2", "type": "oidc", "flows": ["browser_authcode"]}
|
||||||
},
|
]
|
||||||
},
|
}`),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "bad method",
|
name: "bad method",
|
||||||
@ -71,7 +71,7 @@ func TestIDPDiscovery(t *testing.T) {
|
|||||||
test := test
|
test := test
|
||||||
t.Run(test.name, func(t *testing.T) {
|
t.Run(test.name, func(t *testing.T) {
|
||||||
idpLister := oidctestutil.NewUpstreamIDPListerBuilder().
|
idpLister := oidctestutil.NewUpstreamIDPListerBuilder().
|
||||||
WithOIDC(&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "z-some-oidc-idp"}).
|
WithOIDC(&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "z-some-oidc-idp", AllowPasswordGrant: true}).
|
||||||
WithOIDC(&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "x-some-idp"}).
|
WithOIDC(&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "x-some-idp"}).
|
||||||
WithLDAP(&oidctestutil.TestUpstreamLDAPIdentityProvider{Name: "a-some-ldap-idp"}).
|
WithLDAP(&oidctestutil.TestUpstreamLDAPIdentityProvider{Name: "a-some-ldap-idp"}).
|
||||||
WithOIDC(&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "a-some-oidc-idp"}).
|
WithOIDC(&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "a-some-oidc-idp"}).
|
||||||
@ -90,10 +90,8 @@ func TestIDPDiscovery(t *testing.T) {
|
|||||||
|
|
||||||
require.Equal(t, test.wantContentType, rsp.Header().Get("Content-Type"))
|
require.Equal(t, test.wantContentType, rsp.Header().Get("Content-Type"))
|
||||||
|
|
||||||
if test.wantFirstResponseBodyJSON != nil {
|
if test.wantFirstResponseBodyJSON != "" {
|
||||||
wantJSON, err := json.Marshal(test.wantFirstResponseBodyJSON)
|
require.JSONEq(t, test.wantFirstResponseBodyJSON, rsp.Body.String())
|
||||||
require.NoError(t, err)
|
|
||||||
require.JSONEq(t, string(wantJSON), rsp.Body.String())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if test.wantBodyString != "" {
|
if test.wantBodyString != "" {
|
||||||
@ -106,7 +104,7 @@ func TestIDPDiscovery(t *testing.T) {
|
|||||||
&oidctestutil.TestUpstreamLDAPIdentityProvider{Name: "some-other-ldap-idp-2"},
|
&oidctestutil.TestUpstreamLDAPIdentityProvider{Name: "some-other-ldap-idp-2"},
|
||||||
})
|
})
|
||||||
idpLister.SetOIDCIdentityProviders([]provider.UpstreamOIDCIdentityProviderI{
|
idpLister.SetOIDCIdentityProviders([]provider.UpstreamOIDCIdentityProviderI{
|
||||||
&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "some-other-oidc-idp-1"},
|
&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "some-other-oidc-idp-1", AllowPasswordGrant: true},
|
||||||
&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "some-other-oidc-idp-2"},
|
&oidctestutil.TestUpstreamOIDCIdentityProvider{Name: "some-other-oidc-idp-2"},
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -123,10 +121,8 @@ func TestIDPDiscovery(t *testing.T) {
|
|||||||
|
|
||||||
require.Equal(t, test.wantContentType, rsp.Header().Get("Content-Type"))
|
require.Equal(t, test.wantContentType, rsp.Header().Get("Content-Type"))
|
||||||
|
|
||||||
if test.wantFirstResponseBodyJSON != nil {
|
if test.wantFirstResponseBodyJSON != "" {
|
||||||
wantJSON, err := json.Marshal(test.wantSecondResponseBodyJSON)
|
require.JSONEq(t, test.wantSecondResponseBodyJSON, rsp.Body.String())
|
||||||
require.NoError(t, err)
|
|
||||||
require.JSONEq(t, string(wantJSON), rsp.Body.String())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if test.wantBodyString != "" {
|
if test.wantBodyString != "" {
|
||||||
|
@ -251,11 +251,17 @@ func FositeErrorForLog(err error) []interface{} {
|
|||||||
rfc6749Error := fosite.ErrorToRFC6749Error(err)
|
rfc6749Error := fosite.ErrorToRFC6749Error(err)
|
||||||
keysAndValues := make([]interface{}, 0)
|
keysAndValues := make([]interface{}, 0)
|
||||||
keysAndValues = append(keysAndValues, "name")
|
keysAndValues = append(keysAndValues, "name")
|
||||||
keysAndValues = append(keysAndValues, rfc6749Error.ErrorField)
|
keysAndValues = append(keysAndValues, rfc6749Error.Error()) // Error() returns the ErrorField
|
||||||
keysAndValues = append(keysAndValues, "status")
|
keysAndValues = append(keysAndValues, "status")
|
||||||
keysAndValues = append(keysAndValues, rfc6749Error.Status())
|
keysAndValues = append(keysAndValues, rfc6749Error.Status()) // Status() encodes the CodeField as a string
|
||||||
keysAndValues = append(keysAndValues, "description")
|
keysAndValues = append(keysAndValues, "description")
|
||||||
keysAndValues = append(keysAndValues, rfc6749Error.DescriptionField)
|
keysAndValues = append(keysAndValues, rfc6749Error.GetDescription()) // GetDescription() returns the DescriptionField and the HintField
|
||||||
|
keysAndValues = append(keysAndValues, "debug")
|
||||||
|
keysAndValues = append(keysAndValues, rfc6749Error.Debug()) // Debug() returns the DebugField
|
||||||
|
if cause := rfc6749Error.Cause(); cause != nil { // Cause() returns the underlying error, or nil
|
||||||
|
keysAndValues = append(keysAndValues, "cause")
|
||||||
|
keysAndValues = append(keysAndValues, cause.Error())
|
||||||
|
}
|
||||||
return keysAndValues
|
return keysAndValues
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -17,26 +17,36 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type UpstreamOIDCIdentityProviderI interface {
|
type UpstreamOIDCIdentityProviderI interface {
|
||||||
// A name for this upstream provider, which will be used as a component of the path for the callback endpoint
|
// GetName returns a name for this upstream provider, which will be used as a component of the path for the
|
||||||
// hosted by the Supervisor.
|
// callback endpoint hosted by the Supervisor.
|
||||||
GetName() string
|
GetName() string
|
||||||
|
|
||||||
// The Oauth client ID registered with the upstream provider to be used in the authorization code flow.
|
// GetClientID returns the OAuth client ID registered with the upstream provider to be used in the authorization code flow.
|
||||||
GetClientID() string
|
GetClientID() string
|
||||||
|
|
||||||
// The Authorization Endpoint fetched from discovery.
|
// GetAuthorizationURL returns the Authorization Endpoint fetched from discovery.
|
||||||
GetAuthorizationURL() *url.URL
|
GetAuthorizationURL() *url.URL
|
||||||
|
|
||||||
// Scopes to request in authorization flow.
|
// GetScopes returns the scopes to request in authorization (authcode or password grant) flow.
|
||||||
GetScopes() []string
|
GetScopes() []string
|
||||||
|
|
||||||
// ID Token username claim name. May return empty string, in which case we will use some reasonable defaults.
|
// GetUsernameClaim returns the ID Token username claim name. May return empty string, in which case we
|
||||||
|
// will use some reasonable defaults.
|
||||||
GetUsernameClaim() string
|
GetUsernameClaim() string
|
||||||
|
|
||||||
// ID Token groups claim name. May return empty string, in which case we won't try to read groups from the upstream provider.
|
// GetGroupsClaim returns the ID Token groups claim name. May return empty string, in which case we won't
|
||||||
|
// try to read groups from the upstream provider.
|
||||||
GetGroupsClaim() string
|
GetGroupsClaim() string
|
||||||
|
|
||||||
// Performs upstream OIDC authorization code exchange and token validation.
|
// AllowsPasswordGrant returns true if a client should be allowed to use the resource owner password credentials grant
|
||||||
|
// flow with this upstream provider. When false, it should not be allowed.
|
||||||
|
AllowsPasswordGrant() bool
|
||||||
|
|
||||||
|
// PasswordCredentialsGrantAndValidateTokens performs upstream OIDC resource owner password credentials grant and
|
||||||
|
// token validation. Returns the validated raw tokens as well as the parsed claims of the ID token.
|
||||||
|
PasswordCredentialsGrantAndValidateTokens(ctx context.Context, username, password string) (*oidctypes.Token, error)
|
||||||
|
|
||||||
|
// ExchangeAuthcodeAndValidateTokens performs upstream OIDC authorization code exchange and token validation.
|
||||||
// Returns the validated raw tokens as well as the parsed claims of the ID token.
|
// Returns the validated raw tokens as well as the parsed claims of the ID token.
|
||||||
ExchangeAuthcodeAndValidateTokens(
|
ExchangeAuthcodeAndValidateTokens(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
@ -50,15 +60,15 @@ type UpstreamOIDCIdentityProviderI interface {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type UpstreamLDAPIdentityProviderI interface {
|
type UpstreamLDAPIdentityProviderI interface {
|
||||||
// A name for this upstream provider.
|
// GetName returns a name for this upstream provider.
|
||||||
GetName() string
|
GetName() string
|
||||||
|
|
||||||
// Return a URL which uniquely identifies this LDAP provider, e.g. "ldaps://host.example.com:1234".
|
// GetURL returns a URL which uniquely identifies this LDAP provider, e.g. "ldaps://host.example.com:1234".
|
||||||
// This URL is not used for connecting to the provider, but rather is used for creating a globally unique user
|
// This URL is not used for connecting to the provider, but rather is used for creating a globally unique user
|
||||||
// identifier by being combined with the user's UID, since user UIDs are only unique within one provider.
|
// identifier by being combined with the user's UID, since user UIDs are only unique within one provider.
|
||||||
GetURL() *url.URL
|
GetURL() *url.URL
|
||||||
|
|
||||||
// A method for performing user authentication against the upstream LDAP provider.
|
// UserAuthenticator adds an interface method for performing user authentication against the upstream LDAP provider.
|
||||||
authenticators.UserAuthenticator
|
authenticators.UserAuthenticator
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -61,6 +61,10 @@ func TestManager(t *testing.T) {
|
|||||||
downstreamPKCECodeVerifier = "some-pkce-verifier-that-must-be-at-least-43-characters-to-meet-entropy-requirements"
|
downstreamPKCECodeVerifier = "some-pkce-verifier-that-must-be-at-least-43-characters-to-meet-entropy-requirements"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
upstreamIDPFlows = []string{"browser_authcode"}
|
||||||
|
)
|
||||||
|
|
||||||
newGetRequest := func(url string) *http.Request {
|
newGetRequest := func(url string) *http.Request {
|
||||||
return httptest.NewRequest(http.MethodGet, url, nil)
|
return httptest.NewRequest(http.MethodGet, url, nil)
|
||||||
}
|
}
|
||||||
@ -89,19 +93,22 @@ func TestManager(t *testing.T) {
|
|||||||
r.Equal(parsedDiscoveryResult.SupervisorDiscovery.PinnipedIDPsEndpoint, expectedIssuer+oidc.PinnipedIDPsPathV1Alpha1)
|
r.Equal(parsedDiscoveryResult.SupervisorDiscovery.PinnipedIDPsEndpoint, expectedIssuer+oidc.PinnipedIDPsPathV1Alpha1)
|
||||||
}
|
}
|
||||||
|
|
||||||
requirePinnipedIDPsDiscoveryRequestToBeHandled := func(requestIssuer, requestURLSuffix, expectedIDPName, expectedIDPType string) {
|
requirePinnipedIDPsDiscoveryRequestToBeHandled := func(requestIssuer, requestURLSuffix, expectedIDPName, expectedIDPType string, expectedFlows []string) {
|
||||||
recorder := httptest.NewRecorder()
|
recorder := httptest.NewRecorder()
|
||||||
|
|
||||||
subject.ServeHTTP(recorder, newGetRequest(requestIssuer+oidc.PinnipedIDPsPathV1Alpha1+requestURLSuffix))
|
subject.ServeHTTP(recorder, newGetRequest(requestIssuer+oidc.PinnipedIDPsPathV1Alpha1+requestURLSuffix))
|
||||||
|
|
||||||
r.False(fallbackHandlerWasCalled)
|
r.False(fallbackHandlerWasCalled)
|
||||||
|
|
||||||
|
expectedFlowsJSON, err := json.Marshal(expectedFlows)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Minimal check to ensure that the right IDP discovery endpoint was called
|
// Minimal check to ensure that the right IDP discovery endpoint was called
|
||||||
r.Equal(http.StatusOK, recorder.Code)
|
r.Equal(http.StatusOK, recorder.Code)
|
||||||
responseBody, err := ioutil.ReadAll(recorder.Body)
|
responseBody, err := ioutil.ReadAll(recorder.Body)
|
||||||
r.NoError(err)
|
r.NoError(err)
|
||||||
r.Equal(
|
r.Equal(
|
||||||
fmt.Sprintf(`{"pinniped_identity_providers":[{"name":"%s","type":"%s"}]}`+"\n", expectedIDPName, expectedIDPType),
|
fmt.Sprintf(`{"pinniped_identity_providers":[{"name":"%s","type":"%s","flows":%s}]}`+"\n", expectedIDPName, expectedIDPType, expectedFlowsJSON),
|
||||||
string(responseBody),
|
string(responseBody),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
@ -314,14 +321,14 @@ func TestManager(t *testing.T) {
|
|||||||
requireDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "", issuer2)
|
requireDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "", issuer2)
|
||||||
requireDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "?some=query", issuer2)
|
requireDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "?some=query", issuer2)
|
||||||
|
|
||||||
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer1, "", upstreamIDPName, upstreamIDPType)
|
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer1, "", upstreamIDPName, upstreamIDPType, upstreamIDPFlows)
|
||||||
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2, "", upstreamIDPName, upstreamIDPType)
|
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2, "", upstreamIDPName, upstreamIDPType, upstreamIDPFlows)
|
||||||
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2, "?some=query", upstreamIDPName, upstreamIDPType)
|
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2, "?some=query", upstreamIDPName, upstreamIDPType, upstreamIDPFlows)
|
||||||
|
|
||||||
// Hostnames are case-insensitive, so test that we can handle that.
|
// Hostnames are case-insensitive, so test that we can handle that.
|
||||||
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer1DifferentCaseHostname, "", upstreamIDPName, upstreamIDPType)
|
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer1DifferentCaseHostname, "", upstreamIDPName, upstreamIDPType, upstreamIDPFlows)
|
||||||
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "", upstreamIDPName, upstreamIDPType)
|
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "", upstreamIDPName, upstreamIDPType, upstreamIDPFlows)
|
||||||
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "?some=query", upstreamIDPName, upstreamIDPType)
|
requirePinnipedIDPsDiscoveryRequestToBeHandled(issuer2DifferentCaseHostname, "?some=query", upstreamIDPName, upstreamIDPType, upstreamIDPFlows)
|
||||||
|
|
||||||
issuer1JWKS := requireJWKSRequestToBeHandled(issuer1, "", issuer1KeyID)
|
issuer1JWKS := requireJWKSRequestToBeHandled(issuer1, "", issuer1KeyID)
|
||||||
issuer2JWKS := requireJWKSRequestToBeHandled(issuer2, "", issuer2KeyID)
|
issuer2JWKS := requireJWKSRequestToBeHandled(issuer2, "", issuer2KeyID)
|
||||||
|
@ -42,6 +42,7 @@ import (
|
|||||||
"go.pinniped.dev/internal/downward"
|
"go.pinniped.dev/internal/downward"
|
||||||
"go.pinniped.dev/internal/groupsuffix"
|
"go.pinniped.dev/internal/groupsuffix"
|
||||||
"go.pinniped.dev/internal/kubeclient"
|
"go.pinniped.dev/internal/kubeclient"
|
||||||
|
"go.pinniped.dev/internal/leaderelection"
|
||||||
"go.pinniped.dev/internal/oidc/jwks"
|
"go.pinniped.dev/internal/oidc/jwks"
|
||||||
"go.pinniped.dev/internal/oidc/provider"
|
"go.pinniped.dev/internal/oidc/provider"
|
||||||
"go.pinniped.dev/internal/oidc/provider/manager"
|
"go.pinniped.dev/internal/oidc/provider/manager"
|
||||||
@ -95,6 +96,7 @@ func startControllers(
|
|||||||
pinnipedClient pinnipedclientset.Interface,
|
pinnipedClient pinnipedclientset.Interface,
|
||||||
kubeInformers kubeinformers.SharedInformerFactory,
|
kubeInformers kubeinformers.SharedInformerFactory,
|
||||||
pinnipedInformers pinnipedinformers.SharedInformerFactory,
|
pinnipedInformers pinnipedinformers.SharedInformerFactory,
|
||||||
|
leaderElector func(context.Context, func(context.Context)),
|
||||||
) {
|
) {
|
||||||
federationDomainInformer := pinnipedInformers.Config().V1alpha1().FederationDomains()
|
federationDomainInformer := pinnipedInformers.Config().V1alpha1().FederationDomains()
|
||||||
secretInformer := kubeInformers.Core().V1().Secrets()
|
secretInformer := kubeInformers.Core().V1().Secrets()
|
||||||
@ -271,7 +273,7 @@ func startControllers(
|
|||||||
kubeInformers.WaitForCacheSync(ctx.Done())
|
kubeInformers.WaitForCacheSync(ctx.Done())
|
||||||
pinnipedInformers.WaitForCacheSync(ctx.Done())
|
pinnipedInformers.WaitForCacheSync(ctx.Done())
|
||||||
|
|
||||||
go controllerManager.Start(ctx)
|
go leaderElector(ctx, controllerManager.Start)
|
||||||
}
|
}
|
||||||
|
|
||||||
func run(podInfo *downward.PodInfo, cfg *supervisor.Config) error {
|
func run(podInfo *downward.PodInfo, cfg *supervisor.Config) error {
|
||||||
@ -285,14 +287,25 @@ func run(podInfo *downward.PodInfo, cfg *supervisor.Config) error {
|
|||||||
return fmt.Errorf("cannot create deployment ref: %w", err)
|
return fmt.Errorf("cannot create deployment ref: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
client, err := kubeclient.New(
|
opts := []kubeclient.Option{
|
||||||
dref,
|
dref,
|
||||||
kubeclient.WithMiddleware(groupsuffix.New(*cfg.APIGroupSuffix)),
|
kubeclient.WithMiddleware(groupsuffix.New(*cfg.APIGroupSuffix)),
|
||||||
|
}
|
||||||
|
|
||||||
|
client, leaderElector, err := leaderelection.New(
|
||||||
|
podInfo,
|
||||||
|
supervisorDeployment,
|
||||||
|
opts...,
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("cannot create k8s client: %w", err)
|
return fmt.Errorf("cannot create k8s client: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
clientWithoutLeaderElection, err := kubeclient.New(opts...)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("cannot create k8s client without leader election: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
kubeInformers := kubeinformers.NewSharedInformerFactoryWithOptions(
|
kubeInformers := kubeinformers.NewSharedInformerFactoryWithOptions(
|
||||||
client.Kubernetes,
|
client.Kubernetes,
|
||||||
defaultResyncInterval,
|
defaultResyncInterval,
|
||||||
@ -322,7 +335,7 @@ func run(podInfo *downward.PodInfo, cfg *supervisor.Config) error {
|
|||||||
dynamicJWKSProvider,
|
dynamicJWKSProvider,
|
||||||
dynamicUpstreamIDPProvider,
|
dynamicUpstreamIDPProvider,
|
||||||
&secretCache,
|
&secretCache,
|
||||||
client.Kubernetes.CoreV1().Secrets(serverInstallationNamespace),
|
clientWithoutLeaderElection.Kubernetes.CoreV1().Secrets(serverInstallationNamespace), // writes to kube storage are allowed for non-leaders
|
||||||
)
|
)
|
||||||
|
|
||||||
startControllers(
|
startControllers(
|
||||||
@ -338,6 +351,7 @@ func run(podInfo *downward.PodInfo, cfg *supervisor.Config) error {
|
|||||||
client.PinnipedSupervisor,
|
client.PinnipedSupervisor,
|
||||||
kubeInformers,
|
kubeInformers,
|
||||||
pinnipedInformers,
|
pinnipedInformers,
|
||||||
|
leaderElector,
|
||||||
)
|
)
|
||||||
|
|
||||||
//nolint: gosec // Intentionally binding to all network interfaces.
|
//nolint: gosec // Intentionally binding to all network interfaces.
|
||||||
|
@ -7,6 +7,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
|
|
||||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
|
"k8s.io/apimachinery/pkg/types"
|
||||||
"k8s.io/client-go/kubernetes"
|
"k8s.io/client-go/kubernetes"
|
||||||
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
|
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
|
||||||
)
|
)
|
||||||
@ -32,10 +33,24 @@ type coreWrapper struct {
|
|||||||
opts *[]metav1.DeleteOptions
|
opts *[]metav1.DeleteOptions
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (c *coreWrapper) Pods(namespace string) corev1client.PodInterface {
|
||||||
|
return &podsWrapper{PodInterface: c.CoreV1Interface.Pods(namespace), opts: c.opts}
|
||||||
|
}
|
||||||
|
|
||||||
func (c *coreWrapper) Secrets(namespace string) corev1client.SecretInterface {
|
func (c *coreWrapper) Secrets(namespace string) corev1client.SecretInterface {
|
||||||
return &secretsWrapper{SecretInterface: c.CoreV1Interface.Secrets(namespace), opts: c.opts}
|
return &secretsWrapper{SecretInterface: c.CoreV1Interface.Secrets(namespace), opts: c.opts}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type podsWrapper struct {
|
||||||
|
corev1client.PodInterface
|
||||||
|
opts *[]metav1.DeleteOptions
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *podsWrapper) Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error {
|
||||||
|
*s.opts = append(*s.opts, opts)
|
||||||
|
return s.PodInterface.Delete(ctx, name, opts)
|
||||||
|
}
|
||||||
|
|
||||||
type secretsWrapper struct {
|
type secretsWrapper struct {
|
||||||
corev1client.SecretInterface
|
corev1client.SecretInterface
|
||||||
opts *[]metav1.DeleteOptions
|
opts *[]metav1.DeleteOptions
|
||||||
@ -45,3 +60,12 @@ func (s *secretsWrapper) Delete(ctx context.Context, name string, opts metav1.De
|
|||||||
*s.opts = append(*s.opts, opts)
|
*s.opts = append(*s.opts, opts)
|
||||||
return s.SecretInterface.Delete(ctx, name, opts)
|
return s.SecretInterface.Delete(ctx, name, opts)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func NewPreconditions(uid types.UID, rv string) metav1.DeleteOptions {
|
||||||
|
return metav1.DeleteOptions{
|
||||||
|
Preconditions: &metav1.Preconditions{
|
||||||
|
UID: &uid,
|
||||||
|
ResourceVersion: &rv,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -49,6 +49,14 @@ type ExchangeAuthcodeAndValidateTokenArgs struct {
|
|||||||
RedirectURI string
|
RedirectURI string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// PasswordCredentialsGrantAndValidateTokensArgs is used to spy on calls to
|
||||||
|
// TestUpstreamOIDCIdentityProvider.PasswordCredentialsGrantAndValidateTokensFunc().
|
||||||
|
type PasswordCredentialsGrantAndValidateTokensArgs struct {
|
||||||
|
Ctx context.Context
|
||||||
|
Username string
|
||||||
|
Password string
|
||||||
|
}
|
||||||
|
|
||||||
type TestUpstreamLDAPIdentityProvider struct {
|
type TestUpstreamLDAPIdentityProvider struct {
|
||||||
Name string
|
Name string
|
||||||
URL *url.URL
|
URL *url.URL
|
||||||
@ -76,6 +84,8 @@ type TestUpstreamOIDCIdentityProvider struct {
|
|||||||
UsernameClaim string
|
UsernameClaim string
|
||||||
GroupsClaim string
|
GroupsClaim string
|
||||||
Scopes []string
|
Scopes []string
|
||||||
|
AllowPasswordGrant bool
|
||||||
|
|
||||||
ExchangeAuthcodeAndValidateTokensFunc func(
|
ExchangeAuthcodeAndValidateTokensFunc func(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
authcode string,
|
authcode string,
|
||||||
@ -83,8 +93,16 @@ type TestUpstreamOIDCIdentityProvider struct {
|
|||||||
expectedIDTokenNonce nonce.Nonce,
|
expectedIDTokenNonce nonce.Nonce,
|
||||||
) (*oidctypes.Token, error)
|
) (*oidctypes.Token, error)
|
||||||
|
|
||||||
|
PasswordCredentialsGrantAndValidateTokensFunc func(
|
||||||
|
ctx context.Context,
|
||||||
|
username string,
|
||||||
|
password string,
|
||||||
|
) (*oidctypes.Token, error)
|
||||||
|
|
||||||
exchangeAuthcodeAndValidateTokensCallCount int
|
exchangeAuthcodeAndValidateTokensCallCount int
|
||||||
exchangeAuthcodeAndValidateTokensArgs []*ExchangeAuthcodeAndValidateTokenArgs
|
exchangeAuthcodeAndValidateTokensArgs []*ExchangeAuthcodeAndValidateTokenArgs
|
||||||
|
passwordCredentialsGrantAndValidateTokensCallCount int
|
||||||
|
passwordCredentialsGrantAndValidateTokensArgs []*PasswordCredentialsGrantAndValidateTokensArgs
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *TestUpstreamOIDCIdentityProvider) GetName() string {
|
func (u *TestUpstreamOIDCIdentityProvider) GetName() string {
|
||||||
@ -111,6 +129,20 @@ func (u *TestUpstreamOIDCIdentityProvider) GetGroupsClaim() string {
|
|||||||
return u.GroupsClaim
|
return u.GroupsClaim
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProvider) AllowsPasswordGrant() bool {
|
||||||
|
return u.AllowPasswordGrant
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProvider) PasswordCredentialsGrantAndValidateTokens(ctx context.Context, username, password string) (*oidctypes.Token, error) {
|
||||||
|
u.passwordCredentialsGrantAndValidateTokensCallCount++
|
||||||
|
u.passwordCredentialsGrantAndValidateTokensArgs = append(u.passwordCredentialsGrantAndValidateTokensArgs, &PasswordCredentialsGrantAndValidateTokensArgs{
|
||||||
|
Ctx: ctx,
|
||||||
|
Username: username,
|
||||||
|
Password: password,
|
||||||
|
})
|
||||||
|
return u.PasswordCredentialsGrantAndValidateTokensFunc(ctx, username, password)
|
||||||
|
}
|
||||||
|
|
||||||
func (u *TestUpstreamOIDCIdentityProvider) ExchangeAuthcodeAndValidateTokens(
|
func (u *TestUpstreamOIDCIdentityProvider) ExchangeAuthcodeAndValidateTokens(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
authcode string,
|
authcode string,
|
||||||
@ -192,10 +224,193 @@ func (b *UpstreamIDPListerBuilder) Build() provider.DynamicUpstreamIDPProvider {
|
|||||||
return idpProvider
|
return idpProvider
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (b *UpstreamIDPListerBuilder) RequireExactlyOneCallToPasswordCredentialsGrantAndValidateTokens(
|
||||||
|
t *testing.T,
|
||||||
|
expectedPerformedByUpstreamName string,
|
||||||
|
expectedArgs *PasswordCredentialsGrantAndValidateTokensArgs,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
var actualArgs *PasswordCredentialsGrantAndValidateTokensArgs
|
||||||
|
var actualNameOfUpstreamWhichMadeCall string
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams := 0
|
||||||
|
for _, upstreamOIDC := range b.upstreamOIDCIdentityProviders {
|
||||||
|
callCountOnThisUpstream := upstreamOIDC.passwordCredentialsGrantAndValidateTokensCallCount
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams += callCountOnThisUpstream
|
||||||
|
if callCountOnThisUpstream == 1 {
|
||||||
|
actualNameOfUpstreamWhichMadeCall = upstreamOIDC.Name
|
||||||
|
actualArgs = upstreamOIDC.passwordCredentialsGrantAndValidateTokensArgs[0]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
require.Equal(t, 1, actualCallCountAcrossAllOIDCUpstreams,
|
||||||
|
"should have been exactly one call to PasswordCredentialsGrantAndValidateTokens() by all OIDC upstreams",
|
||||||
|
)
|
||||||
|
require.Equal(t, expectedPerformedByUpstreamName, actualNameOfUpstreamWhichMadeCall,
|
||||||
|
"PasswordCredentialsGrantAndValidateTokens() was called on the wrong OIDC upstream",
|
||||||
|
)
|
||||||
|
require.Equal(t, expectedArgs, actualArgs)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *UpstreamIDPListerBuilder) RequireExactlyZeroCallsToPasswordCredentialsGrantAndValidateTokens(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams := 0
|
||||||
|
for _, upstreamOIDC := range b.upstreamOIDCIdentityProviders {
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams += upstreamOIDC.passwordCredentialsGrantAndValidateTokensCallCount
|
||||||
|
}
|
||||||
|
require.Equal(t, 0, actualCallCountAcrossAllOIDCUpstreams,
|
||||||
|
"expected exactly zero calls to PasswordCredentialsGrantAndValidateTokens()",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *UpstreamIDPListerBuilder) RequireExactlyOneCallToExchangeAuthcodeAndValidateTokens(
|
||||||
|
t *testing.T,
|
||||||
|
expectedPerformedByUpstreamName string,
|
||||||
|
expectedArgs *ExchangeAuthcodeAndValidateTokenArgs,
|
||||||
|
) {
|
||||||
|
t.Helper()
|
||||||
|
var actualArgs *ExchangeAuthcodeAndValidateTokenArgs
|
||||||
|
var actualNameOfUpstreamWhichMadeCall string
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams := 0
|
||||||
|
for _, upstreamOIDC := range b.upstreamOIDCIdentityProviders {
|
||||||
|
callCountOnThisUpstream := upstreamOIDC.exchangeAuthcodeAndValidateTokensCallCount
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams += callCountOnThisUpstream
|
||||||
|
if callCountOnThisUpstream == 1 {
|
||||||
|
actualNameOfUpstreamWhichMadeCall = upstreamOIDC.Name
|
||||||
|
actualArgs = upstreamOIDC.exchangeAuthcodeAndValidateTokensArgs[0]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
require.Equal(t, 1, actualCallCountAcrossAllOIDCUpstreams,
|
||||||
|
"should have been exactly one call to ExchangeAuthcodeAndValidateTokens() by all OIDC upstreams",
|
||||||
|
)
|
||||||
|
require.Equal(t, expectedPerformedByUpstreamName, actualNameOfUpstreamWhichMadeCall,
|
||||||
|
"ExchangeAuthcodeAndValidateTokens() was called on the wrong OIDC upstream",
|
||||||
|
)
|
||||||
|
require.Equal(t, expectedArgs, actualArgs)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *UpstreamIDPListerBuilder) RequireExactlyZeroCallsToExchangeAuthcodeAndValidateTokens(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams := 0
|
||||||
|
for _, upstreamOIDC := range b.upstreamOIDCIdentityProviders {
|
||||||
|
actualCallCountAcrossAllOIDCUpstreams += upstreamOIDC.exchangeAuthcodeAndValidateTokensCallCount
|
||||||
|
}
|
||||||
|
require.Equal(t, 0, actualCallCountAcrossAllOIDCUpstreams,
|
||||||
|
"expected exactly zero calls to ExchangeAuthcodeAndValidateTokens()",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
func NewUpstreamIDPListerBuilder() *UpstreamIDPListerBuilder {
|
func NewUpstreamIDPListerBuilder() *UpstreamIDPListerBuilder {
|
||||||
return &UpstreamIDPListerBuilder{}
|
return &UpstreamIDPListerBuilder{}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type TestUpstreamOIDCIdentityProviderBuilder struct {
|
||||||
|
name string
|
||||||
|
clientID string
|
||||||
|
scopes []string
|
||||||
|
idToken map[string]interface{}
|
||||||
|
usernameClaim string
|
||||||
|
groupsClaim string
|
||||||
|
authorizationURL url.URL
|
||||||
|
allowPasswordGrant bool
|
||||||
|
authcodeExchangeErr error
|
||||||
|
passwordGrantErr error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithName(value string) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.name = value
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithClientID(value string) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.clientID = value
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithAuthorizationURL(value url.URL) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.authorizationURL = value
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithAllowPasswordGrant(value bool) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.allowPasswordGrant = value
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithScopes(values []string) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.scopes = values
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithUsernameClaim(value string) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.usernameClaim = value
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithoutUsernameClaim() *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.usernameClaim = ""
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithGroupsClaim(value string) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.groupsClaim = value
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithoutGroupsClaim() *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.groupsClaim = ""
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithIDTokenClaim(name string, value interface{}) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
if u.idToken == nil {
|
||||||
|
u.idToken = map[string]interface{}{}
|
||||||
|
}
|
||||||
|
u.idToken[name] = value
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithoutIDTokenClaim(claim string) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
delete(u.idToken, claim)
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithUpstreamAuthcodeExchangeError(err error) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.authcodeExchangeErr = err
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) WithPasswordGrantError(err error) *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
u.passwordGrantErr = err
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *TestUpstreamOIDCIdentityProviderBuilder) Build() *TestUpstreamOIDCIdentityProvider {
|
||||||
|
return &TestUpstreamOIDCIdentityProvider{
|
||||||
|
Name: u.name,
|
||||||
|
ClientID: u.clientID,
|
||||||
|
UsernameClaim: u.usernameClaim,
|
||||||
|
GroupsClaim: u.groupsClaim,
|
||||||
|
Scopes: u.scopes,
|
||||||
|
AllowPasswordGrant: u.allowPasswordGrant,
|
||||||
|
AuthorizationURL: u.authorizationURL,
|
||||||
|
ExchangeAuthcodeAndValidateTokensFunc: func(ctx context.Context, authcode string, pkceCodeVerifier pkce.Code, expectedIDTokenNonce nonce.Nonce) (*oidctypes.Token, error) {
|
||||||
|
if u.authcodeExchangeErr != nil {
|
||||||
|
return nil, u.authcodeExchangeErr
|
||||||
|
}
|
||||||
|
return &oidctypes.Token{IDToken: &oidctypes.IDToken{Claims: u.idToken}}, nil
|
||||||
|
},
|
||||||
|
PasswordCredentialsGrantAndValidateTokensFunc: func(ctx context.Context, username, password string) (*oidctypes.Token, error) {
|
||||||
|
if u.passwordGrantErr != nil {
|
||||||
|
return nil, u.passwordGrantErr
|
||||||
|
}
|
||||||
|
return &oidctypes.Token{IDToken: &oidctypes.IDToken{Claims: u.idToken}}, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewTestUpstreamOIDCIdentityProviderBuilder() *TestUpstreamOIDCIdentityProviderBuilder {
|
||||||
|
return &TestUpstreamOIDCIdentityProviderBuilder{}
|
||||||
|
}
|
||||||
|
|
||||||
// Declare a separate type from the production code to ensure that the state param's contents was serialized
|
// Declare a separate type from the production code to ensure that the state param's contents was serialized
|
||||||
// in the format that we expect, with the json keys that we expect, etc. This also ensure that the order of
|
// in the format that we expect, with the json keys that we expect, etc. This also ensure that the order of
|
||||||
// the serialized fields is the same, which doesn't really matter expect that we can make simpler equality
|
// the serialized fields is the same, which doesn't really matter expect that we can make simpler equality
|
||||||
|
@ -6,6 +6,7 @@ package upstreamoidc
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
|
||||||
@ -32,11 +33,12 @@ type ProviderConfig struct {
|
|||||||
UsernameClaim string
|
UsernameClaim string
|
||||||
GroupsClaim string
|
GroupsClaim string
|
||||||
Config *oauth2.Config
|
Config *oauth2.Config
|
||||||
|
Client *http.Client
|
||||||
|
AllowPasswordGrant bool
|
||||||
Provider interface {
|
Provider interface {
|
||||||
Verifier(*coreosoidc.Config) *coreosoidc.IDTokenVerifier
|
Verifier(*coreosoidc.Config) *coreosoidc.IDTokenVerifier
|
||||||
UserInfo(ctx context.Context, tokenSource oauth2.TokenSource) (*coreosoidc.UserInfo, error)
|
UserInfo(ctx context.Context, tokenSource oauth2.TokenSource) (*coreosoidc.UserInfo, error)
|
||||||
}
|
}
|
||||||
Client *http.Client
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *ProviderConfig) GetName() string {
|
func (p *ProviderConfig) GetName() string {
|
||||||
@ -64,6 +66,32 @@ func (p *ProviderConfig) GetGroupsClaim() string {
|
|||||||
return p.GroupsClaim
|
return p.GroupsClaim
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (p *ProviderConfig) AllowsPasswordGrant() bool {
|
||||||
|
return p.AllowPasswordGrant
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *ProviderConfig) PasswordCredentialsGrantAndValidateTokens(ctx context.Context, username, password string) (*oidctypes.Token, error) {
|
||||||
|
// Disallow this grant when requested.
|
||||||
|
if !p.AllowPasswordGrant {
|
||||||
|
return nil, fmt.Errorf("resource owner password credentials grant is not allowed for this upstream provider according to its configuration")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Note that this implicitly uses the scopes from p.Config.Scopes.
|
||||||
|
tok, err := p.Config.PasswordCredentialsToken(
|
||||||
|
coreosoidc.ClientContext(ctx, p.Client),
|
||||||
|
username,
|
||||||
|
password,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// There is no nonce to validate for a resource owner password credentials grant because it skips using
|
||||||
|
// the authorize endpoint and goes straight to the token endpoint.
|
||||||
|
const skipNonceValidation nonce.Nonce = ""
|
||||||
|
return p.ValidateToken(ctx, tok, skipNonceValidation)
|
||||||
|
}
|
||||||
|
|
||||||
func (p *ProviderConfig) ExchangeAuthcodeAndValidateTokens(ctx context.Context, authcode string, pkceCodeVerifier pkce.Code, expectedIDTokenNonce nonce.Nonce, redirectURI string) (*oidctypes.Token, error) {
|
func (p *ProviderConfig) ExchangeAuthcodeAndValidateTokens(ctx context.Context, authcode string, pkceCodeVerifier pkce.Code, expectedIDTokenNonce nonce.Nonce, redirectURI string) (*oidctypes.Token, error) {
|
||||||
tok, err := p.Config.Exchange(
|
tok, err := p.Config.Exchange(
|
||||||
coreosoidc.ClientContext(ctx, p.Client),
|
coreosoidc.ClientContext(ctx, p.Client),
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
package upstreamoidc
|
package upstreamoidc
|
||||||
@ -45,6 +45,13 @@ func TestProviderConfig(t *testing.T) {
|
|||||||
require.ElementsMatch(t, []string{"scope1", "scope2"}, p.GetScopes())
|
require.ElementsMatch(t, []string{"scope1", "scope2"}, p.GetScopes())
|
||||||
require.Equal(t, "test-username-claim", p.GetUsernameClaim())
|
require.Equal(t, "test-username-claim", p.GetUsernameClaim())
|
||||||
require.Equal(t, "test-groups-claim", p.GetGroupsClaim())
|
require.Equal(t, "test-groups-claim", p.GetGroupsClaim())
|
||||||
|
|
||||||
|
// AllowPasswordGrant defaults to false.
|
||||||
|
require.False(t, p.AllowsPasswordGrant())
|
||||||
|
p.AllowPasswordGrant = true
|
||||||
|
require.True(t, p.AllowsPasswordGrant())
|
||||||
|
p.AllowPasswordGrant = false
|
||||||
|
require.False(t, p.AllowsPasswordGrant())
|
||||||
})
|
})
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@ -66,6 +73,218 @@ func TestProviderConfig(t *testing.T) {
|
|||||||
// if the error string for unsupported user info changes, this will hopefully catch it
|
// if the error string for unsupported user info changes, this will hopefully catch it
|
||||||
_, userInfoNotSupported := (&oidc.Provider{}).UserInfo(context.Background(), nil)
|
_, userInfoNotSupported := (&oidc.Provider{}).UserInfo(context.Background(), nil)
|
||||||
|
|
||||||
|
t.Run("PasswordCredentialsGrantAndValidateTokens", func(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
disallowPasswordGrant bool
|
||||||
|
returnIDTok string
|
||||||
|
tokenStatusCode int
|
||||||
|
wantErr string
|
||||||
|
wantToken oidctypes.Token
|
||||||
|
|
||||||
|
userInfo *oidc.UserInfo
|
||||||
|
userInfoErr error
|
||||||
|
wantUserInfoCalled bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid",
|
||||||
|
returnIDTok: validIDToken,
|
||||||
|
wantToken: oidctypes.Token{
|
||||||
|
AccessToken: &oidctypes.AccessToken{
|
||||||
|
Token: "test-access-token",
|
||||||
|
Expiry: metav1.Time{},
|
||||||
|
},
|
||||||
|
RefreshToken: &oidctypes.RefreshToken{
|
||||||
|
Token: "test-refresh-token",
|
||||||
|
},
|
||||||
|
IDToken: &oidctypes.IDToken{
|
||||||
|
Token: validIDToken,
|
||||||
|
Expiry: metav1.Time{},
|
||||||
|
Claims: map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
"bat": "baz",
|
||||||
|
"aud": "test-client-id",
|
||||||
|
"iat": 1.606768593e+09,
|
||||||
|
"jti": "test-jti",
|
||||||
|
"nbf": 1.606768593e+09,
|
||||||
|
"sub": "test-user",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
userInfoErr: userInfoNotSupported,
|
||||||
|
wantUserInfoCalled: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid with userinfo",
|
||||||
|
returnIDTok: validIDToken,
|
||||||
|
wantToken: oidctypes.Token{
|
||||||
|
AccessToken: &oidctypes.AccessToken{
|
||||||
|
Token: "test-access-token",
|
||||||
|
Expiry: metav1.Time{},
|
||||||
|
},
|
||||||
|
RefreshToken: &oidctypes.RefreshToken{
|
||||||
|
Token: "test-refresh-token",
|
||||||
|
},
|
||||||
|
IDToken: &oidctypes.IDToken{
|
||||||
|
Token: validIDToken,
|
||||||
|
Expiry: metav1.Time{},
|
||||||
|
Claims: map[string]interface{}{
|
||||||
|
"foo": "awesomeness", // overwrite existing claim
|
||||||
|
"bat": "baz",
|
||||||
|
"aud": "test-client-id",
|
||||||
|
"iat": 1.606768593e+09,
|
||||||
|
"jti": "test-jti",
|
||||||
|
"nbf": 1.606768593e+09,
|
||||||
|
"sub": "test-user",
|
||||||
|
"groups": "fancy-group", // add a new claim
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// claims is private field so we have to use hacks to set it
|
||||||
|
userInfo: forceUserInfoWithClaims("test-user", `{"foo":"awesomeness","groups":"fancy-group"}`),
|
||||||
|
wantUserInfoCalled: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "password grant not allowed",
|
||||||
|
disallowPasswordGrant: true, // password grant is not allowed in this ProviderConfig
|
||||||
|
wantErr: "resource owner password credentials grant is not allowed for this upstream provider according to its configuration",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "token request fails with http error",
|
||||||
|
tokenStatusCode: http.StatusForbidden,
|
||||||
|
wantErr: "oauth2: cannot fetch token: 403 Forbidden\nResponse: fake error\n",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing ID token",
|
||||||
|
wantErr: "received response missing ID token",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid ID token",
|
||||||
|
returnIDTok: "invalid-jwt",
|
||||||
|
wantErr: "received invalid ID token: oidc: malformed jwt: square/go-jose: compact JWS format must have three parts",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid access token hash",
|
||||||
|
returnIDTok: invalidAccessTokenHashIDToken,
|
||||||
|
wantErr: "received invalid ID token: access token hash does not match value in ID token",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "user info fetch error",
|
||||||
|
returnIDTok: validIDToken,
|
||||||
|
wantErr: "could not fetch user info claims: could not get user info: some network error",
|
||||||
|
userInfoErr: errors.New("some network error"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "user info sub error",
|
||||||
|
returnIDTok: validIDToken,
|
||||||
|
wantErr: "could not fetch user info claims: userinfo 'sub' claim (test-user-2) did not match id_token 'sub' claim (test-user)",
|
||||||
|
userInfo: &oidc.UserInfo{Subject: "test-user-2"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "user info is not json",
|
||||||
|
returnIDTok: validIDToken,
|
||||||
|
wantErr: "could not fetch user info claims: could not unmarshal user info claims: invalid character 'i' looking for beginning of value",
|
||||||
|
// claims is private field so we have to use hacks to set it
|
||||||
|
userInfo: forceUserInfoWithClaims("test-user", `invalid-json-data`),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid sub claim",
|
||||||
|
returnIDTok: invalidSubClaim,
|
||||||
|
wantToken: oidctypes.Token{
|
||||||
|
AccessToken: &oidctypes.AccessToken{
|
||||||
|
Token: "test-access-token",
|
||||||
|
Expiry: metav1.Time{},
|
||||||
|
},
|
||||||
|
RefreshToken: &oidctypes.RefreshToken{
|
||||||
|
Token: "test-refresh-token",
|
||||||
|
},
|
||||||
|
IDToken: &oidctypes.IDToken{
|
||||||
|
Token: invalidSubClaim,
|
||||||
|
Expiry: metav1.Time{},
|
||||||
|
Claims: map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
"bat": "baz",
|
||||||
|
"aud": "test-client-id",
|
||||||
|
"iat": 1.61021969e+09,
|
||||||
|
"jti": "test-jti",
|
||||||
|
"nbf": 1.61021969e+09,
|
||||||
|
// no sub claim
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
wantUserInfoCalled: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
tt := tt
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
tokenServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
require.Equal(t, http.MethodPost, r.Method)
|
||||||
|
require.NoError(t, r.ParseForm())
|
||||||
|
require.Equal(t, 6, len(r.Form))
|
||||||
|
require.Equal(t, "password", r.Form.Get("grant_type"))
|
||||||
|
require.Equal(t, "test-client-id", r.Form.Get("client_id"))
|
||||||
|
require.Equal(t, "test-client-secret", r.Form.Get("client_secret"))
|
||||||
|
require.Equal(t, "test-username", r.Form.Get("username"))
|
||||||
|
require.Equal(t, "test-password", r.Form.Get("password"))
|
||||||
|
require.Equal(t, "scope1 scope2", r.Form.Get("scope"))
|
||||||
|
if tt.tokenStatusCode != 0 {
|
||||||
|
http.Error(w, "fake error", http.StatusForbidden)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var response struct {
|
||||||
|
oauth2.Token
|
||||||
|
IDToken string `json:"id_token,omitempty"`
|
||||||
|
}
|
||||||
|
response.AccessToken = "test-access-token"
|
||||||
|
response.RefreshToken = "test-refresh-token"
|
||||||
|
response.Expiry = time.Now().Add(time.Hour)
|
||||||
|
response.IDToken = tt.returnIDTok
|
||||||
|
w.Header().Set("content-type", "application/json")
|
||||||
|
require.NoError(t, json.NewEncoder(w).Encode(&response))
|
||||||
|
}))
|
||||||
|
t.Cleanup(tokenServer.Close)
|
||||||
|
|
||||||
|
p := ProviderConfig{
|
||||||
|
Name: "test-name",
|
||||||
|
UsernameClaim: "test-username-claim",
|
||||||
|
GroupsClaim: "test-groups-claim",
|
||||||
|
Config: &oauth2.Config{
|
||||||
|
ClientID: "test-client-id",
|
||||||
|
ClientSecret: "test-client-secret",
|
||||||
|
Endpoint: oauth2.Endpoint{
|
||||||
|
AuthURL: "https://example.com",
|
||||||
|
TokenURL: tokenServer.URL,
|
||||||
|
AuthStyle: oauth2.AuthStyleInParams,
|
||||||
|
},
|
||||||
|
Scopes: []string{"scope1", "scope2"},
|
||||||
|
},
|
||||||
|
Provider: &mockProvider{
|
||||||
|
userInfo: tt.userInfo,
|
||||||
|
userInfoErr: tt.userInfoErr,
|
||||||
|
},
|
||||||
|
AllowPasswordGrant: !tt.disallowPasswordGrant,
|
||||||
|
}
|
||||||
|
|
||||||
|
tok, err := p.PasswordCredentialsGrantAndValidateTokens(
|
||||||
|
context.Background(),
|
||||||
|
"test-username",
|
||||||
|
"test-password",
|
||||||
|
)
|
||||||
|
|
||||||
|
if tt.wantErr != "" {
|
||||||
|
require.EqualError(t, err, tt.wantErr)
|
||||||
|
require.Nil(t, tok)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, &tt.wantToken, tok)
|
||||||
|
require.Equal(t, tt.wantUserInfoCalled, p.Provider.(*mockProvider).called)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("ExchangeAuthcodeAndValidateTokens", func(t *testing.T) {
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
authCode string
|
authCode string
|
||||||
@ -253,9 +472,12 @@ func TestProviderConfig(t *testing.T) {
|
|||||||
tokenServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
tokenServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
require.Equal(t, http.MethodPost, r.Method)
|
require.Equal(t, http.MethodPost, r.Method)
|
||||||
require.NoError(t, r.ParseForm())
|
require.NoError(t, r.ParseForm())
|
||||||
|
require.Len(t, r.Form, 6)
|
||||||
require.Equal(t, "test-client-id", r.Form.Get("client_id"))
|
require.Equal(t, "test-client-id", r.Form.Get("client_id"))
|
||||||
|
require.Equal(t, "test-client-secret", r.Form.Get("client_secret"))
|
||||||
require.Equal(t, "test-pkce", r.Form.Get("code_verifier"))
|
require.Equal(t, "test-pkce", r.Form.Get("code_verifier"))
|
||||||
require.Equal(t, "authorization_code", r.Form.Get("grant_type"))
|
require.Equal(t, "authorization_code", r.Form.Get("grant_type"))
|
||||||
|
require.Equal(t, "https://example.com/callback", r.Form.Get("redirect_uri"))
|
||||||
require.NotEmpty(t, r.Form.Get("code"))
|
require.NotEmpty(t, r.Form.Get("code"))
|
||||||
if r.Form.Get("code") != "valid" {
|
if r.Form.Get("code") != "valid" {
|
||||||
http.Error(w, "invalid authorization code", http.StatusForbidden)
|
http.Error(w, "invalid authorization code", http.StatusForbidden)
|
||||||
@ -280,6 +502,7 @@ func TestProviderConfig(t *testing.T) {
|
|||||||
GroupsClaim: "test-groups-claim",
|
GroupsClaim: "test-groups-claim",
|
||||||
Config: &oauth2.Config{
|
Config: &oauth2.Config{
|
||||||
ClientID: "test-client-id",
|
ClientID: "test-client-id",
|
||||||
|
ClientSecret: "test-client-secret",
|
||||||
Endpoint: oauth2.Endpoint{
|
Endpoint: oauth2.Endpoint{
|
||||||
AuthURL: "https://example.com",
|
AuthURL: "https://example.com",
|
||||||
TokenURL: tokenServer.URL,
|
TokenURL: tokenServer.URL,
|
||||||
@ -293,9 +516,14 @@ func TestProviderConfig(t *testing.T) {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx := context.Background()
|
tok, err := p.ExchangeAuthcodeAndValidateTokens(
|
||||||
|
context.Background(),
|
||||||
|
tt.authCode,
|
||||||
|
"test-pkce",
|
||||||
|
tt.expectNonce,
|
||||||
|
"https://example.com/callback",
|
||||||
|
)
|
||||||
|
|
||||||
tok, err := p.ExchangeAuthcodeAndValidateTokens(ctx, tt.authCode, "test-pkce", tt.expectNonce, "https://example.com/callback")
|
|
||||||
if tt.wantErr != "" {
|
if tt.wantErr != "" {
|
||||||
require.EqualError(t, err, tt.wantErr)
|
require.EqualError(t, err, tt.wantErr)
|
||||||
require.Nil(t, tok)
|
require.Nil(t, tok)
|
||||||
@ -306,6 +534,7 @@ func TestProviderConfig(t *testing.T) {
|
|||||||
require.Equal(t, tt.wantUserInfoCalled, p.Provider.(*mockProvider).called)
|
require.Equal(t, tt.wantUserInfoCalled, p.Provider.(*mockProvider).called)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// mockVerifier returns an *oidc.IDTokenVerifier that validates any correctly serialized JWT without doing much else.
|
// mockVerifier returns an *oidc.IDTokenVerifier that validates any correctly serialized JWT without doing much else.
|
||||||
|
@ -28,6 +28,7 @@ import (
|
|||||||
"golang.org/x/term"
|
"golang.org/x/term"
|
||||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
|
|
||||||
|
supervisoroidc "go.pinniped.dev/generated/latest/apis/supervisor/oidc"
|
||||||
"go.pinniped.dev/internal/httputil/httperr"
|
"go.pinniped.dev/internal/httputil/httperr"
|
||||||
"go.pinniped.dev/internal/httputil/securityheader"
|
"go.pinniped.dev/internal/httputil/securityheader"
|
||||||
"go.pinniped.dev/internal/oidc/provider"
|
"go.pinniped.dev/internal/oidc/provider"
|
||||||
@ -52,11 +53,6 @@ const (
|
|||||||
// we set this to be relatively long.
|
// we set this to be relatively long.
|
||||||
overallTimeout = 90 * time.Minute
|
overallTimeout = 90 * time.Minute
|
||||||
|
|
||||||
supervisorAuthorizeUpstreamNameParam = "pinniped_idp_name"
|
|
||||||
supervisorAuthorizeUpstreamTypeParam = "pinniped_idp_type"
|
|
||||||
supervisorAuthorizeUpstreamUsernameHeader = "Pinniped-Username"
|
|
||||||
supervisorAuthorizeUpstreamPasswordHeader = "Pinniped-Password" // nolint:gosec // this is not a credential
|
|
||||||
|
|
||||||
defaultLDAPUsernamePrompt = "Username: "
|
defaultLDAPUsernamePrompt = "Username: "
|
||||||
defaultLDAPPasswordPrompt = "Password: "
|
defaultLDAPPasswordPrompt = "Password: "
|
||||||
|
|
||||||
@ -237,8 +233,8 @@ func WithRequestAudience(audience string) Option {
|
|||||||
// WithCLISendingCredentials causes the login flow to use CLI-based prompts for username and password and causes the
|
// WithCLISendingCredentials causes the login flow to use CLI-based prompts for username and password and causes the
|
||||||
// call to the Issuer's authorize endpoint to be made directly (no web browser) with the username and password on custom
|
// call to the Issuer's authorize endpoint to be made directly (no web browser) with the username and password on custom
|
||||||
// HTTP headers. This is only intended to be used when the issuer is a Pinniped Supervisor and the upstream identity
|
// HTTP headers. This is only intended to be used when the issuer is a Pinniped Supervisor and the upstream identity
|
||||||
// provider type supports this style of authentication. Currently this is supported by LDAPIdentityProviders and
|
// provider type supports this style of authentication. Currently, this is supported by LDAPIdentityProviders, ActiveDirectoryIdentityProviders,
|
||||||
// ActiveDirectoryIdentityProviders.
|
// and by OIDCIdentityProviders which optionally enable the resource owner password credentials grant flow.
|
||||||
// This should never be used with non-Supervisor issuers because it will send the user's password to the authorization
|
// This should never be used with non-Supervisor issuers because it will send the user's password to the authorization
|
||||||
// endpoint as a custom header, which would be ignored but could potentially get logged somewhere by the issuer.
|
// endpoint as a custom header, which would be ignored but could potentially get logged somewhere by the issuer.
|
||||||
func WithCLISendingCredentials() Option {
|
func WithCLISendingCredentials() Option {
|
||||||
@ -389,8 +385,12 @@ func (h *handlerState) baseLogin() (*oidctypes.Token, error) {
|
|||||||
h.pkce.Method(),
|
h.pkce.Method(),
|
||||||
}
|
}
|
||||||
if h.upstreamIdentityProviderName != "" {
|
if h.upstreamIdentityProviderName != "" {
|
||||||
authorizeOptions = append(authorizeOptions, oauth2.SetAuthURLParam(supervisorAuthorizeUpstreamNameParam, h.upstreamIdentityProviderName))
|
authorizeOptions = append(authorizeOptions,
|
||||||
authorizeOptions = append(authorizeOptions, oauth2.SetAuthURLParam(supervisorAuthorizeUpstreamTypeParam, h.upstreamIdentityProviderType))
|
oauth2.SetAuthURLParam(supervisoroidc.AuthorizeUpstreamIDPNameParamName, h.upstreamIdentityProviderName),
|
||||||
|
)
|
||||||
|
authorizeOptions = append(authorizeOptions,
|
||||||
|
oauth2.SetAuthURLParam(supervisoroidc.AuthorizeUpstreamIDPTypeParamName, h.upstreamIdentityProviderType),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Choose the appropriate authorization and authcode exchange strategy.
|
// Choose the appropriate authorization and authcode exchange strategy.
|
||||||
@ -445,8 +445,8 @@ func (h *handlerState) cliBasedAuth(authorizeOptions *[]oauth2.AuthCodeOption) (
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("could not build authorize request: %w", err)
|
return nil, fmt.Errorf("could not build authorize request: %w", err)
|
||||||
}
|
}
|
||||||
authReq.Header.Set(supervisorAuthorizeUpstreamUsernameHeader, username)
|
authReq.Header.Set(supervisoroidc.AuthorizeUsernameHeaderName, username)
|
||||||
authReq.Header.Set(supervisorAuthorizeUpstreamPasswordHeader, password)
|
authReq.Header.Set(supervisoroidc.AuthorizePasswordHeaderName, password)
|
||||||
authRes, err := h.httpClient.Do(authReq)
|
authRes, err := h.httpClient.Do(authReq)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("authorization response error: %w", err)
|
return nil, fmt.Errorf("authorization response error: %w", err)
|
||||||
|
@ -238,7 +238,7 @@ func TestLogin(t *testing.T) { // nolint:gocyclo
|
|||||||
formPostProviderMux.HandleFunc("/.well-known/openid-configuration", discoveryHandler(formPostSuccessServer, []string{"query", "form_post"}))
|
formPostProviderMux.HandleFunc("/.well-known/openid-configuration", discoveryHandler(formPostSuccessServer, []string{"query", "form_post"}))
|
||||||
formPostProviderMux.HandleFunc("/token", tokenHandler)
|
formPostProviderMux.HandleFunc("/token", tokenHandler)
|
||||||
|
|
||||||
defaultDiscoveryResponse := func(req *http.Request) (*http.Response, error) { // nolint:unparam
|
defaultDiscoveryResponse := func(req *http.Request) (*http.Response, error) {
|
||||||
// Call the handler function from the test server to calculate the response.
|
// Call the handler function from the test server to calculate the response.
|
||||||
handler, _ := providerMux.Handler(req)
|
handler, _ := providerMux.Handler(req)
|
||||||
recorder := httptest.NewRecorder()
|
recorder := httptest.NewRecorder()
|
||||||
@ -246,7 +246,7 @@ func TestLogin(t *testing.T) { // nolint:gocyclo
|
|||||||
return recorder.Result(), nil
|
return recorder.Result(), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
defaultLDAPTestOpts := func(t *testing.T, h *handlerState, authResponse *http.Response, authError error) error { // nolint:unparam
|
defaultLDAPTestOpts := func(t *testing.T, h *handlerState, authResponse *http.Response, authError error) error {
|
||||||
h.generateState = func() (state.State, error) { return "test-state", nil }
|
h.generateState = func() (state.State, error) { return "test-state", nil }
|
||||||
h.generatePKCE = func() (pkce.Code, error) { return "test-pkce", nil }
|
h.generatePKCE = func() (pkce.Code, error) { return "test-pkce", nil }
|
||||||
h.generateNonce = func() (nonce.Nonce, error) { return "test-nonce", nil }
|
h.generateNonce = func() (nonce.Nonce, error) { return "test-nonce", nil }
|
||||||
|
@ -93,15 +93,18 @@ to authenticate the user to the cluster.
|
|||||||
If the Pinniped Supervisor is used for authentication to that cluster, then the user's authentication experience
|
If the Pinniped Supervisor is used for authentication to that cluster, then the user's authentication experience
|
||||||
will depend on which type of identity provider was configured.
|
will depend on which type of identity provider was configured.
|
||||||
|
|
||||||
- For an OIDC identity provider, `kubectl` will open the user's web browser and direct it to the login page of
|
- For an OIDC identity provider, there are two supported client flows.
|
||||||
their OIDC Provider. This login flow is controlled by the provider, so it may include two-factor authentication or
|
|
||||||
other features provided by the OIDC Provider.
|
|
||||||
|
|
||||||
If the user's browser is not available, then `kubectl` will instead print a URL which can be visited in a
|
When using the default browser-based flow, `kubectl` will open the user's web browser and direct it to the login page of
|
||||||
browser (potentially on a different computer) to complete the authentication.
|
their OIDC Provider. This login flow is controlled by the provider, so it may include two-factor authentication or
|
||||||
|
other features provided by the OIDC Provider. If the user's browser is not available, then `kubectl` will instead
|
||||||
|
print a URL which can be visited in a browser (potentially on a different computer) to complete the authentication.
|
||||||
|
|
||||||
|
When using the optional CLI-based flow, `kubectl` will interactively prompt the user for their username and password at the CLI.
|
||||||
|
Alternatively, the user can set the environment variables `PINNIPED_USERNAME` and `PINNIPED_PASSWORD` for the
|
||||||
|
`kubectl` process to avoid the interactive prompts.
|
||||||
|
|
||||||
- For an LDAP identity provider, `kubectl` will interactively prompt the user for their username and password at the CLI.
|
- For an LDAP identity provider, `kubectl` will interactively prompt the user for their username and password at the CLI.
|
||||||
|
|
||||||
Alternatively, the user can set the environment variables `PINNIPED_USERNAME` and `PINNIPED_PASSWORD` for the
|
Alternatively, the user can set the environment variables `PINNIPED_USERNAME` and `PINNIPED_PASSWORD` for the
|
||||||
`kubectl` process to avoid the interactive prompts.
|
`kubectl` process to avoid the interactive prompts.
|
||||||
|
|
||||||
|
@ -17,6 +17,8 @@ web:
|
|||||||
tlsKey: /var/certs/dex-key.pem
|
tlsKey: /var/certs/dex-key.pem
|
||||||
oauth2:
|
oauth2:
|
||||||
skipApprovalScreen: true
|
skipApprovalScreen: true
|
||||||
|
#! Allow the resource owner password grant, which Dex implements to also return ID tokens.
|
||||||
|
passwordConnector: local
|
||||||
staticClients:
|
staticClients:
|
||||||
- id: pinniped-cli
|
- id: pinniped-cli
|
||||||
name: 'Pinniped CLI'
|
name: 'Pinniped CLI'
|
||||||
|
@ -438,7 +438,7 @@ func TestImpersonationProxy(t *testing.T) { //nolint:gocyclo // yeah, it's compl
|
|||||||
t.Run("using and watching all the basic verbs", func(t *testing.T) {
|
t.Run("using and watching all the basic verbs", func(t *testing.T) {
|
||||||
parallelIfNotEKS(t)
|
parallelIfNotEKS(t)
|
||||||
// Create a namespace, because it will be easier to exercise "deletecollection" if we have a namespace.
|
// Create a namespace, because it will be easier to exercise "deletecollection" if we have a namespace.
|
||||||
namespaceName := createTestNamespace(t, adminClient)
|
namespaceName := testlib.CreateNamespace(ctx, t, "impersonation").Name
|
||||||
|
|
||||||
// Create and start informer to exercise the "watch" verb for us.
|
// Create and start informer to exercise the "watch" verb for us.
|
||||||
informerFactory := k8sinformers.NewSharedInformerFactoryWithOptions(
|
informerFactory := k8sinformers.NewSharedInformerFactoryWithOptions(
|
||||||
@ -827,7 +827,7 @@ func TestImpersonationProxy(t *testing.T) { //nolint:gocyclo // yeah, it's compl
|
|||||||
// this works because impersonation cannot set UID and thus the final user info the proxy sees has no UID
|
// this works because impersonation cannot set UID and thus the final user info the proxy sees has no UID
|
||||||
t.Run("nested impersonation as a service account is allowed if it has enough RBAC permissions", func(t *testing.T) {
|
t.Run("nested impersonation as a service account is allowed if it has enough RBAC permissions", func(t *testing.T) {
|
||||||
parallelIfNotEKS(t)
|
parallelIfNotEKS(t)
|
||||||
namespaceName := createTestNamespace(t, adminClient)
|
namespaceName := testlib.CreateNamespace(ctx, t, "impersonation").Name
|
||||||
saName, saToken, saUID := createServiceAccountToken(ctx, t, adminClient, namespaceName)
|
saName, saToken, saUID := createServiceAccountToken(ctx, t, adminClient, namespaceName)
|
||||||
nestedImpersonationClient := newImpersonationProxyClientWithCredentials(t,
|
nestedImpersonationClient := newImpersonationProxyClientWithCredentials(t,
|
||||||
&loginv1alpha1.ClusterCredential{Token: saToken}, impersonationProxyURL, impersonationProxyCACertPEM,
|
&loginv1alpha1.ClusterCredential{Token: saToken}, impersonationProxyURL, impersonationProxyCACertPEM,
|
||||||
@ -916,7 +916,7 @@ func TestImpersonationProxy(t *testing.T) { //nolint:gocyclo // yeah, it's compl
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Test using a service account token.
|
// Test using a service account token.
|
||||||
namespaceName := createTestNamespace(t, adminClient)
|
namespaceName := testlib.CreateNamespace(ctx, t, "impersonation").Name
|
||||||
saName, saToken, _ := createServiceAccountToken(ctx, t, adminClient, namespaceName)
|
saName, saToken, _ := createServiceAccountToken(ctx, t, adminClient, namespaceName)
|
||||||
impersonationProxyServiceAccountPinnipedConciergeClient := newImpersonationProxyClientWithCredentials(t,
|
impersonationProxyServiceAccountPinnipedConciergeClient := newImpersonationProxyClientWithCredentials(t,
|
||||||
&loginv1alpha1.ClusterCredential{Token: saToken},
|
&loginv1alpha1.ClusterCredential{Token: saToken},
|
||||||
@ -935,7 +935,7 @@ func TestImpersonationProxy(t *testing.T) { //nolint:gocyclo // yeah, it's compl
|
|||||||
})
|
})
|
||||||
|
|
||||||
t.Run("WhoAmIRequests and SA token request", func(t *testing.T) {
|
t.Run("WhoAmIRequests and SA token request", func(t *testing.T) {
|
||||||
namespaceName := createTestNamespace(t, adminClient)
|
namespaceName := testlib.CreateNamespace(ctx, t, "impersonation").Name
|
||||||
kubeClient := adminClient.CoreV1()
|
kubeClient := adminClient.CoreV1()
|
||||||
saName, _, saUID := createServiceAccountToken(ctx, t, adminClient, namespaceName)
|
saName, _, saUID := createServiceAccountToken(ctx, t, adminClient, namespaceName)
|
||||||
|
|
||||||
@ -1145,7 +1145,7 @@ func TestImpersonationProxy(t *testing.T) { //nolint:gocyclo // yeah, it's compl
|
|||||||
|
|
||||||
t.Run("websocket client", func(t *testing.T) {
|
t.Run("websocket client", func(t *testing.T) {
|
||||||
parallelIfNotEKS(t)
|
parallelIfNotEKS(t)
|
||||||
namespaceName := createTestNamespace(t, adminClient)
|
namespaceName := testlib.CreateNamespace(ctx, t, "impersonation").Name
|
||||||
|
|
||||||
impersonationRestConfig := impersonationProxyRestConfig(
|
impersonationRestConfig := impersonationProxyRestConfig(
|
||||||
refreshCredential(t, impersonationProxyURL, impersonationProxyCACertPEM),
|
refreshCredential(t, impersonationProxyURL, impersonationProxyCACertPEM),
|
||||||
@ -1224,7 +1224,7 @@ func TestImpersonationProxy(t *testing.T) { //nolint:gocyclo // yeah, it's compl
|
|||||||
|
|
||||||
t.Run("http2 client", func(t *testing.T) {
|
t.Run("http2 client", func(t *testing.T) {
|
||||||
parallelIfNotEKS(t)
|
parallelIfNotEKS(t)
|
||||||
namespaceName := createTestNamespace(t, adminClient)
|
namespaceName := testlib.CreateNamespace(ctx, t, "impersonation").Name
|
||||||
|
|
||||||
wantConfigMapLabelKey, wantConfigMapLabelValue := "some-label-key", "some-label-value"
|
wantConfigMapLabelKey, wantConfigMapLabelValue := "some-label-key", "some-label-value"
|
||||||
wantConfigMap := &corev1.ConfigMap{
|
wantConfigMap := &corev1.ConfigMap{
|
||||||
@ -1783,7 +1783,7 @@ func TestImpersonationProxy(t *testing.T) { //nolint:gocyclo // yeah, it's compl
|
|||||||
testlib.RequireEventually(t, func(requireEventually *require.Assertions) {
|
testlib.RequireEventually(t, func(requireEventually *require.Assertions) {
|
||||||
_, err := adminClient.CoreV1().Secrets(env.ConciergeNamespace).Get(ctx, impersonationProxyTLSSecretName(env), metav1.GetOptions{})
|
_, err := adminClient.CoreV1().Secrets(env.ConciergeNamespace).Get(ctx, impersonationProxyTLSSecretName(env), metav1.GetOptions{})
|
||||||
requireEventually.Truef(k8serrors.IsNotFound(err), "expected NotFound error, got %v", err)
|
requireEventually.Truef(k8serrors.IsNotFound(err), "expected NotFound error, got %v", err)
|
||||||
}, 10*time.Second, 250*time.Millisecond)
|
}, time.Minute, time.Second)
|
||||||
|
|
||||||
// Check that the generated CA cert Secret was not deleted by the controller because it's supposed to keep this
|
// Check that the generated CA cert Secret was not deleted by the controller because it's supposed to keep this
|
||||||
// around in case we decide to later re-enable the impersonator. We want to avoid generating new CA certs when
|
// around in case we decide to later re-enable the impersonator. We want to avoid generating new CA certs when
|
||||||
@ -1864,27 +1864,6 @@ func ensureDNSResolves(t *testing.T, urlString string) {
|
|||||||
}, 5*time.Minute, 1*time.Second)
|
}, 5*time.Minute, 1*time.Second)
|
||||||
}
|
}
|
||||||
|
|
||||||
func createTestNamespace(t *testing.T, adminClient kubernetes.Interface) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
namespace, err := adminClient.CoreV1().Namespaces().Create(ctx, &corev1.Namespace{
|
|
||||||
ObjectMeta: metav1.ObjectMeta{GenerateName: "impersonation-integration-test-"},
|
|
||||||
}, metav1.CreateOptions{})
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
t.Logf("cleaning up test namespace %s", namespace.Name)
|
|
||||||
require.NoError(t, adminClient.CoreV1().Namespaces().Delete(ctx, namespace.Name, metav1.DeleteOptions{}))
|
|
||||||
})
|
|
||||||
return namespace.Name
|
|
||||||
}
|
|
||||||
|
|
||||||
func createServiceAccountToken(ctx context.Context, t *testing.T, adminClient kubernetes.Interface, namespaceName string) (name, token string, uid types.UID) {
|
func createServiceAccountToken(ctx context.Context, t *testing.T, adminClient kubernetes.Interface, namespaceName string) (name, token string, uid types.UID) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
|
@ -271,7 +271,7 @@ func TestE2EFullIntegration(t *testing.T) {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("with Supervisor OIDC upstream IDP and manual flow", func(t *testing.T) {
|
t.Run("with Supervisor OIDC upstream IDP and manual authcode copy-paste from browser flow", func(t *testing.T) {
|
||||||
// Start a fresh browser driver because we don't want to share cookies between the various tests in this file.
|
// Start a fresh browser driver because we don't want to share cookies between the various tests in this file.
|
||||||
page := browsertest.Open(t)
|
page := browsertest.Open(t)
|
||||||
|
|
||||||
@ -365,7 +365,7 @@ func TestE2EFullIntegration(t *testing.T) {
|
|||||||
|
|
||||||
// Read all of the remaining output from the subprocess until EOF.
|
// Read all of the remaining output from the subprocess until EOF.
|
||||||
t.Logf("waiting for kubectl to output namespace list")
|
t.Logf("waiting for kubectl to output namespace list")
|
||||||
// Read all of the output from the subprocess until EOF.
|
// Read all output from the subprocess until EOF.
|
||||||
// Ignore any errors returned because there is always an error on linux.
|
// Ignore any errors returned because there is always an error on linux.
|
||||||
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
||||||
requireKubectlGetNamespaceOutput(t, env, string(kubectlOutputBytes))
|
requireKubectlGetNamespaceOutput(t, env, string(kubectlOutputBytes))
|
||||||
@ -382,6 +382,159 @@ func TestE2EFullIntegration(t *testing.T) {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
t.Run("with Supervisor OIDC upstream IDP and CLI password flow without web browser", func(t *testing.T) {
|
||||||
|
expectedUsername := env.SupervisorUpstreamOIDC.Username
|
||||||
|
expectedGroups := env.SupervisorUpstreamOIDC.ExpectedGroups
|
||||||
|
|
||||||
|
// Create a ClusterRoleBinding to give our test user from the upstream read-only access to the cluster.
|
||||||
|
testlib.CreateTestClusterRoleBinding(t,
|
||||||
|
rbacv1.Subject{Kind: rbacv1.UserKind, APIGroup: rbacv1.GroupName, Name: expectedUsername},
|
||||||
|
rbacv1.RoleRef{Kind: "ClusterRole", APIGroup: rbacv1.GroupName, Name: "view"},
|
||||||
|
)
|
||||||
|
testlib.WaitForUserToHaveAccess(t, expectedUsername, []string{}, &authorizationv1.ResourceAttributes{
|
||||||
|
Verb: "get",
|
||||||
|
Group: "",
|
||||||
|
Version: "v1",
|
||||||
|
Resource: "namespaces",
|
||||||
|
})
|
||||||
|
|
||||||
|
// Create upstream OIDC provider and wait for it to become ready.
|
||||||
|
testlib.CreateTestOIDCIdentityProvider(t, idpv1alpha1.OIDCIdentityProviderSpec{
|
||||||
|
Issuer: env.SupervisorUpstreamOIDC.Issuer,
|
||||||
|
TLS: &idpv1alpha1.TLSSpec{
|
||||||
|
CertificateAuthorityData: base64.StdEncoding.EncodeToString([]byte(env.SupervisorUpstreamOIDC.CABundle)),
|
||||||
|
},
|
||||||
|
AuthorizationConfig: idpv1alpha1.OIDCAuthorizationConfig{
|
||||||
|
AdditionalScopes: env.SupervisorUpstreamOIDC.AdditionalScopes,
|
||||||
|
AllowPasswordGrant: true, // allow the CLI password flow for this OIDCIdentityProvider
|
||||||
|
},
|
||||||
|
Claims: idpv1alpha1.OIDCClaims{
|
||||||
|
Username: env.SupervisorUpstreamOIDC.UsernameClaim,
|
||||||
|
Groups: env.SupervisorUpstreamOIDC.GroupsClaim,
|
||||||
|
},
|
||||||
|
Client: idpv1alpha1.OIDCClient{
|
||||||
|
SecretName: testlib.CreateClientCredsSecret(t, env.SupervisorUpstreamOIDC.ClientID, env.SupervisorUpstreamOIDC.ClientSecret).Name,
|
||||||
|
},
|
||||||
|
}, idpv1alpha1.PhaseReady)
|
||||||
|
|
||||||
|
// Use a specific session cache for this test.
|
||||||
|
sessionCachePath := tempDir + "/oidc-test-sessions-password-grant.yaml"
|
||||||
|
kubeconfigPath := runPinnipedGetKubeconfig(t, env, pinnipedExe, tempDir, []string{
|
||||||
|
"get", "kubeconfig",
|
||||||
|
"--concierge-api-group-suffix", env.APIGroupSuffix,
|
||||||
|
"--concierge-authenticator-type", "jwt",
|
||||||
|
"--concierge-authenticator-name", authenticator.Name,
|
||||||
|
"--oidc-skip-browser",
|
||||||
|
"--oidc-skip-listen",
|
||||||
|
"--upstream-identity-provider-flow", "cli_password", // create a kubeconfig configured to use the cli_password flow
|
||||||
|
"--oidc-ca-bundle", testCABundlePath,
|
||||||
|
"--oidc-session-cache", sessionCachePath,
|
||||||
|
})
|
||||||
|
|
||||||
|
// Run "kubectl get namespaces" which should trigger a browser-less CLI prompt login via the plugin.
|
||||||
|
start := time.Now()
|
||||||
|
kubectlCmd := exec.CommandContext(ctx, "kubectl", "get", "namespace", "--kubeconfig", kubeconfigPath)
|
||||||
|
kubectlCmd.Env = append(os.Environ(), env.ProxyEnv()...)
|
||||||
|
ptyFile, err := pty.Start(kubectlCmd)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Wait for the subprocess to print the username prompt, then type the user's username.
|
||||||
|
readFromFileUntilStringIsSeen(t, ptyFile, "Username: ")
|
||||||
|
_, err = ptyFile.WriteString(expectedUsername + "\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Wait for the subprocess to print the password prompt, then type the user's password.
|
||||||
|
readFromFileUntilStringIsSeen(t, ptyFile, "Password: ")
|
||||||
|
_, err = ptyFile.WriteString(env.SupervisorUpstreamOIDC.Password + "\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Read all output from the subprocess until EOF.
|
||||||
|
// Ignore any errors returned because there is always an error on linux.
|
||||||
|
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
||||||
|
requireKubectlGetNamespaceOutput(t, env, string(kubectlOutputBytes))
|
||||||
|
|
||||||
|
t.Logf("first kubectl command took %s", time.Since(start).String())
|
||||||
|
|
||||||
|
requireUserCanUseKubectlWithoutAuthenticatingAgain(ctx, t, env,
|
||||||
|
downstream,
|
||||||
|
kubeconfigPath,
|
||||||
|
sessionCachePath,
|
||||||
|
pinnipedExe,
|
||||||
|
expectedUsername,
|
||||||
|
expectedGroups,
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("with Supervisor OIDC upstream IDP and CLI password flow when OIDCIdentityProvider disallows it", func(t *testing.T) {
|
||||||
|
// Create upstream OIDC provider and wait for it to become ready.
|
||||||
|
oidcIdentityProvider := testlib.CreateTestOIDCIdentityProvider(t, idpv1alpha1.OIDCIdentityProviderSpec{
|
||||||
|
Issuer: env.SupervisorUpstreamOIDC.Issuer,
|
||||||
|
TLS: &idpv1alpha1.TLSSpec{
|
||||||
|
CertificateAuthorityData: base64.StdEncoding.EncodeToString([]byte(env.SupervisorUpstreamOIDC.CABundle)),
|
||||||
|
},
|
||||||
|
AuthorizationConfig: idpv1alpha1.OIDCAuthorizationConfig{
|
||||||
|
AdditionalScopes: env.SupervisorUpstreamOIDC.AdditionalScopes,
|
||||||
|
AllowPasswordGrant: false, // disallow the CLI password flow for this OIDCIdentityProvider!
|
||||||
|
},
|
||||||
|
Claims: idpv1alpha1.OIDCClaims{
|
||||||
|
Username: env.SupervisorUpstreamOIDC.UsernameClaim,
|
||||||
|
Groups: env.SupervisorUpstreamOIDC.GroupsClaim,
|
||||||
|
},
|
||||||
|
Client: idpv1alpha1.OIDCClient{
|
||||||
|
SecretName: testlib.CreateClientCredsSecret(t, env.SupervisorUpstreamOIDC.ClientID, env.SupervisorUpstreamOIDC.ClientSecret).Name,
|
||||||
|
},
|
||||||
|
}, idpv1alpha1.PhaseReady)
|
||||||
|
|
||||||
|
// Use a specific session cache for this test.
|
||||||
|
sessionCachePath := tempDir + "/oidc-test-sessions-password-grant-negative-test.yaml"
|
||||||
|
kubeconfigPath := runPinnipedGetKubeconfig(t, env, pinnipedExe, tempDir, []string{
|
||||||
|
"get", "kubeconfig",
|
||||||
|
"--concierge-api-group-suffix", env.APIGroupSuffix,
|
||||||
|
"--concierge-authenticator-type", "jwt",
|
||||||
|
"--concierge-authenticator-name", authenticator.Name,
|
||||||
|
"--oidc-skip-browser",
|
||||||
|
"--oidc-skip-listen",
|
||||||
|
// Create a kubeconfig configured to use the cli_password flow. By specifying all
|
||||||
|
// available --upstream-identity-provider-* options the CLI should skip IDP discovery
|
||||||
|
// and use the provided values without validating them. "cli_password" will not show
|
||||||
|
// up in the list of available flows for this IDP in the discovery response.
|
||||||
|
"--upstream-identity-provider-name", oidcIdentityProvider.Name,
|
||||||
|
"--upstream-identity-provider-type", "oidc",
|
||||||
|
"--upstream-identity-provider-flow", "cli_password",
|
||||||
|
"--oidc-ca-bundle", testCABundlePath,
|
||||||
|
"--oidc-session-cache", sessionCachePath,
|
||||||
|
})
|
||||||
|
|
||||||
|
// Run "kubectl get namespaces" which should trigger a browser-less CLI prompt login via the plugin.
|
||||||
|
kubectlCmd := exec.CommandContext(ctx, "kubectl", "get", "namespace", "--kubeconfig", kubeconfigPath)
|
||||||
|
kubectlCmd.Env = append(os.Environ(), env.ProxyEnv()...)
|
||||||
|
ptyFile, err := pty.Start(kubectlCmd)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Wait for the subprocess to print the username prompt, then type the user's username.
|
||||||
|
readFromFileUntilStringIsSeen(t, ptyFile, "Username: ")
|
||||||
|
_, err = ptyFile.WriteString(env.SupervisorUpstreamOIDC.Username + "\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Wait for the subprocess to print the password prompt, then type the user's password.
|
||||||
|
readFromFileUntilStringIsSeen(t, ptyFile, "Password: ")
|
||||||
|
_, err = ptyFile.WriteString(env.SupervisorUpstreamOIDC.Password + "\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Read all output from the subprocess until EOF.
|
||||||
|
// Ignore any errors returned because there is always an error on linux.
|
||||||
|
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
||||||
|
kubectlOutput := string(kubectlOutputBytes)
|
||||||
|
|
||||||
|
// The output should look like an authentication failure, because the OIDCIdentityProvider disallows password grants.
|
||||||
|
t.Log("kubectl command output (expecting a login failed error):\n", kubectlOutput)
|
||||||
|
require.Contains(t, kubectlOutput,
|
||||||
|
`Error: could not complete Pinniped login: login failed with code "access_denied": `+
|
||||||
|
`The resource owner or authorization server denied the request. `+
|
||||||
|
`Resource owner password credentials grant is not allowed for this upstream provider according to its configuration.`,
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
// Add an LDAP upstream IDP and try using it to authenticate during kubectl commands
|
// Add an LDAP upstream IDP and try using it to authenticate during kubectl commands
|
||||||
// by interacting with the CLI's username and password prompts.
|
// by interacting with the CLI's username and password prompts.
|
||||||
t.Run("with Supervisor LDAP upstream IDP using username and password prompts", func(t *testing.T) {
|
t.Run("with Supervisor LDAP upstream IDP using username and password prompts", func(t *testing.T) {
|
||||||
@ -422,7 +575,7 @@ func TestE2EFullIntegration(t *testing.T) {
|
|||||||
_, err = ptyFile.WriteString(env.SupervisorUpstreamLDAP.TestUserPassword + "\n")
|
_, err = ptyFile.WriteString(env.SupervisorUpstreamLDAP.TestUserPassword + "\n")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Read all of the output from the subprocess until EOF.
|
// Read all output from the subprocess until EOF.
|
||||||
// Ignore any errors returned because there is always an error on linux.
|
// Ignore any errors returned because there is always an error on linux.
|
||||||
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
||||||
requireKubectlGetNamespaceOutput(t, env, string(kubectlOutputBytes))
|
requireKubectlGetNamespaceOutput(t, env, string(kubectlOutputBytes))
|
||||||
@ -487,7 +640,7 @@ func TestE2EFullIntegration(t *testing.T) {
|
|||||||
ptyFile, err := pty.Start(kubectlCmd)
|
ptyFile, err := pty.Start(kubectlCmd)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Read all of the output from the subprocess until EOF.
|
// Read all output from the subprocess until EOF.
|
||||||
// Ignore any errors returned because there is always an error on linux.
|
// Ignore any errors returned because there is always an error on linux.
|
||||||
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
kubectlOutputBytes, _ := ioutil.ReadAll(ptyFile)
|
||||||
requireKubectlGetNamespaceOutput(t, env, string(kubectlOutputBytes))
|
requireKubectlGetNamespaceOutput(t, env, string(kubectlOutputBytes))
|
||||||
|
279
test/integration/leaderelection_test.go
Normal file
279
test/integration/leaderelection_test.go
Normal file
@ -0,0 +1,279 @@
|
|||||||
|
// Copyright 2021 the Pinniped contributors. All Rights Reserved.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package integration
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
appsv1 "k8s.io/api/apps/v1"
|
||||||
|
authenticationv1 "k8s.io/api/authentication/v1"
|
||||||
|
coordinationv1 "k8s.io/api/coordination/v1"
|
||||||
|
corev1 "k8s.io/api/core/v1"
|
||||||
|
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||||
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
|
"k8s.io/apimachinery/pkg/util/rand"
|
||||||
|
"k8s.io/apimachinery/pkg/util/sets"
|
||||||
|
"k8s.io/client-go/util/retry"
|
||||||
|
"k8s.io/utils/pointer"
|
||||||
|
|
||||||
|
"go.pinniped.dev/internal/downward"
|
||||||
|
"go.pinniped.dev/internal/kubeclient"
|
||||||
|
"go.pinniped.dev/internal/leaderelection"
|
||||||
|
"go.pinniped.dev/test/testlib"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestLeaderElection(t *testing.T) {
|
||||||
|
_ = testlib.IntegrationEnv(t)
|
||||||
|
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
|
||||||
|
t.Cleanup(cancel)
|
||||||
|
|
||||||
|
leaseName := "leader-election-" + rand.String(5)
|
||||||
|
|
||||||
|
namespace := testlib.CreateNamespace(ctx, t, leaseName)
|
||||||
|
|
||||||
|
clients := leaderElectionClients(t, namespace, leaseName)
|
||||||
|
|
||||||
|
// the tests below are order dependant to some degree and definitely cannot be run in parallel
|
||||||
|
|
||||||
|
t.Run("sanity check write prevention", func(t *testing.T) {
|
||||||
|
lease := checkOnlyLeaderCanWrite(ctx, t, namespace, leaseName, clients)
|
||||||
|
logLease(t, lease)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("clients handle leader election transition correctly", func(t *testing.T) {
|
||||||
|
lease := forceTransition(ctx, t, namespace, leaseName, clients)
|
||||||
|
logLease(t, lease)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("sanity check write prevention after transition", func(t *testing.T) {
|
||||||
|
lease := checkOnlyLeaderCanWrite(ctx, t, namespace, leaseName, clients)
|
||||||
|
logLease(t, lease)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("clients handle leader election restart correctly", func(t *testing.T) {
|
||||||
|
lease := forceRestart(ctx, t, namespace, leaseName, clients)
|
||||||
|
logLease(t, lease)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("sanity check write prevention after restart", func(t *testing.T) {
|
||||||
|
lease := checkOnlyLeaderCanWrite(ctx, t, namespace, leaseName, clients)
|
||||||
|
logLease(t, lease)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func leaderElectionClient(t *testing.T, namespace *corev1.Namespace, leaseName, identity string) *kubeclient.Client {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
podInfo := &downward.PodInfo{
|
||||||
|
Namespace: namespace.Name,
|
||||||
|
Name: identity,
|
||||||
|
}
|
||||||
|
deployment := &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Name: leaseName}}
|
||||||
|
|
||||||
|
client, leaderElector, err := leaderelection.New(podInfo, deployment, testlib.NewKubeclientOptions(t, testlib.NewClientConfig(t))...)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
controllerCtx, controllerCancel := context.WithCancel(context.Background())
|
||||||
|
leaderCtx, leaderCancel := context.WithCancel(context.Background())
|
||||||
|
|
||||||
|
t.Cleanup(func() {
|
||||||
|
controllerCancel()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-leaderCtx.Done():
|
||||||
|
// leader election client stopped correctly
|
||||||
|
|
||||||
|
case <-time.After(time.Minute):
|
||||||
|
t.Errorf("leader election client in namespace %q with lease %q and identity %q failed to stop",
|
||||||
|
namespace.Name, leaseName, identity)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
time.Sleep(time.Duration(rand.Int63nRange(1, 10)) * time.Second) // randomize start of client and controllers
|
||||||
|
|
||||||
|
// this blocks
|
||||||
|
leaderElector(controllerCtx, func(ctx context.Context) {
|
||||||
|
<-ctx.Done()
|
||||||
|
time.Sleep(time.Duration(rand.Int63nRange(1, 10)) * time.Second) // randomize stop of controllers
|
||||||
|
})
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-controllerCtx.Done():
|
||||||
|
// leaderElector correctly stopped but only after controllers stopped
|
||||||
|
|
||||||
|
default:
|
||||||
|
t.Errorf("leader election client in namespace %q with lease %q and identity %q stopped early",
|
||||||
|
namespace.Name, leaseName, identity)
|
||||||
|
}
|
||||||
|
|
||||||
|
leaderCancel()
|
||||||
|
}()
|
||||||
|
|
||||||
|
return client
|
||||||
|
}
|
||||||
|
|
||||||
|
func leaderElectionClients(t *testing.T, namespace *corev1.Namespace, leaseName string) map[string]*kubeclient.Client {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
count := rand.IntnRange(1, 6)
|
||||||
|
out := make(map[string]*kubeclient.Client, count)
|
||||||
|
|
||||||
|
for i := 0; i < count; i++ {
|
||||||
|
identity := "leader-election-client-" + rand.String(5)
|
||||||
|
out[identity] = leaderElectionClient(t, namespace, leaseName, identity)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Logf("running leader election client tests with %d clients: %v", len(out), sets.StringKeySet(out).List())
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func pickRandomLeaderElectionClient(clients map[string]*kubeclient.Client) *kubeclient.Client {
|
||||||
|
for _, client := range clients {
|
||||||
|
client := client
|
||||||
|
return client
|
||||||
|
}
|
||||||
|
panic("clients map was empty")
|
||||||
|
}
|
||||||
|
|
||||||
|
func waitForIdentity(ctx context.Context, t *testing.T, namespace *corev1.Namespace, leaseName string, clients map[string]*kubeclient.Client) *coordinationv1.Lease {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
identities := sets.StringKeySet(clients)
|
||||||
|
var out *coordinationv1.Lease
|
||||||
|
|
||||||
|
testlib.RequireEventuallyWithoutError(t, func() (bool, error) {
|
||||||
|
lease, err := pickRandomLeaderElectionClient(clients).Kubernetes.CoordinationV1().Leases(namespace.Name).Get(ctx, leaseName, metav1.GetOptions{})
|
||||||
|
if apierrors.IsNotFound(err) {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
out = lease
|
||||||
|
return lease.Spec.HolderIdentity != nil && identities.Has(*lease.Spec.HolderIdentity), nil
|
||||||
|
}, 3*time.Minute, time.Second)
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func runWriteRequest(ctx context.Context, client *kubeclient.Client) error {
|
||||||
|
_, err := client.Kubernetes.AuthenticationV1().TokenReviews().Create(ctx, &authenticationv1.TokenReview{
|
||||||
|
Spec: authenticationv1.TokenReviewSpec{Token: "any-non-empty-value"},
|
||||||
|
}, metav1.CreateOptions{})
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func runWriteRequests(ctx context.Context, clients map[string]*kubeclient.Client) map[string]error {
|
||||||
|
out := make(map[string]error, len(clients))
|
||||||
|
|
||||||
|
for identity, client := range clients {
|
||||||
|
identity, client := identity, client
|
||||||
|
|
||||||
|
out[identity] = runWriteRequest(ctx, client)
|
||||||
|
}
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func pickCurrentLeaderClient(ctx context.Context, t *testing.T, namespace *corev1.Namespace, leaseName string, clients map[string]*kubeclient.Client) *kubeclient.Client {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
lease := waitForIdentity(ctx, t, namespace, leaseName, clients)
|
||||||
|
return clients[*lease.Spec.HolderIdentity]
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkOnlyLeaderCanWrite(ctx context.Context, t *testing.T, namespace *corev1.Namespace, leaseName string, clients map[string]*kubeclient.Client) *coordinationv1.Lease {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
lease := waitForIdentity(ctx, t, namespace, leaseName, clients)
|
||||||
|
|
||||||
|
testlib.RequireEventually(t, func(requireEventually *require.Assertions) {
|
||||||
|
var leaders, nonLeaders int
|
||||||
|
for identity, err := range runWriteRequests(ctx, clients) {
|
||||||
|
identity, err := identity, err
|
||||||
|
|
||||||
|
if identity == *lease.Spec.HolderIdentity {
|
||||||
|
leaders++
|
||||||
|
requireEventually.NoError(err, "leader client %q should have no error", identity)
|
||||||
|
} else {
|
||||||
|
nonLeaders++
|
||||||
|
requireEventually.Error(err, "non leader client %q should have write error but it was nil", identity)
|
||||||
|
requireEventually.True(errors.Is(err, leaderelection.ErrNotLeader), "non leader client %q should have write error: %v", identity, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
requireEventually.Equal(1, leaders, "did not see leader")
|
||||||
|
requireEventually.Equal(len(clients)-1, nonLeaders, "did not see non-leader")
|
||||||
|
}, time.Minute, time.Second)
|
||||||
|
|
||||||
|
return lease
|
||||||
|
}
|
||||||
|
|
||||||
|
func forceTransition(ctx context.Context, t *testing.T, namespace *corev1.Namespace, leaseName string, clients map[string]*kubeclient.Client) *coordinationv1.Lease {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var startTransitions int32
|
||||||
|
var startTime metav1.MicroTime
|
||||||
|
|
||||||
|
errRetry := retry.RetryOnConflict(retry.DefaultBackoff, func() error {
|
||||||
|
startLease := waitForIdentity(ctx, t, namespace, leaseName, clients)
|
||||||
|
startTransitions = *startLease.Spec.LeaseTransitions
|
||||||
|
startTime = *startLease.Spec.AcquireTime
|
||||||
|
|
||||||
|
startLease = startLease.DeepCopy()
|
||||||
|
startLease.Spec.HolderIdentity = pointer.String("some-other-client" + rand.String(5))
|
||||||
|
|
||||||
|
_, err := pickCurrentLeaderClient(ctx, t, namespace, leaseName, clients).
|
||||||
|
Kubernetes.CoordinationV1().Leases(namespace.Name).Update(ctx, startLease, metav1.UpdateOptions{})
|
||||||
|
return err
|
||||||
|
})
|
||||||
|
require.NoError(t, errRetry)
|
||||||
|
|
||||||
|
finalLease := waitForIdentity(ctx, t, namespace, leaseName, clients)
|
||||||
|
finalTransitions := *finalLease.Spec.LeaseTransitions
|
||||||
|
finalTime := *finalLease.Spec.AcquireTime
|
||||||
|
|
||||||
|
require.Greater(t, finalTransitions, startTransitions)
|
||||||
|
require.Greater(t, finalTime.UnixNano(), startTime.UnixNano())
|
||||||
|
|
||||||
|
time.Sleep(2 * time.Minute) // need to give clients time to notice this change because leader election is polling based
|
||||||
|
|
||||||
|
return finalLease
|
||||||
|
}
|
||||||
|
|
||||||
|
func forceRestart(ctx context.Context, t *testing.T, namespace *corev1.Namespace, leaseName string, clients map[string]*kubeclient.Client) *coordinationv1.Lease {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
startLease := waitForIdentity(ctx, t, namespace, leaseName, clients)
|
||||||
|
|
||||||
|
err := pickCurrentLeaderClient(ctx, t, namespace, leaseName, clients).
|
||||||
|
Kubernetes.CoordinationV1().Leases(namespace.Name).Delete(ctx, leaseName, metav1.DeleteOptions{})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
newLease := waitForIdentity(ctx, t, namespace, leaseName, clients)
|
||||||
|
require.Zero(t, *newLease.Spec.LeaseTransitions)
|
||||||
|
require.Greater(t, newLease.Spec.AcquireTime.UnixNano(), startLease.Spec.AcquireTime.UnixNano())
|
||||||
|
|
||||||
|
time.Sleep(2 * time.Minute) // need to give clients time to notice this change because leader election is polling based
|
||||||
|
|
||||||
|
return newLease
|
||||||
|
}
|
||||||
|
|
||||||
|
func logLease(t *testing.T, lease *coordinationv1.Lease) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
bytes, err := json.MarshalIndent(lease, "", "\t")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
t.Logf("current lease:\n%s", string(bytes))
|
||||||
|
}
|
@ -67,7 +67,7 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
},
|
},
|
||||||
}, idpv1alpha1.PhaseReady)
|
}, idpv1alpha1.PhaseReady)
|
||||||
},
|
},
|
||||||
requestAuthorization: requestAuthorizationUsingOIDCIdentityProvider,
|
requestAuthorization: requestAuthorizationUsingBrowserAuthcodeFlow,
|
||||||
// the ID token Subject should include the upstream user ID after the upstream issuer name
|
// the ID token Subject should include the upstream user ID after the upstream issuer name
|
||||||
wantDownstreamIDTokenSubjectToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Issuer+"?sub=") + ".+",
|
wantDownstreamIDTokenSubjectToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Issuer+"?sub=") + ".+",
|
||||||
// the ID token Username should include the upstream user ID after the upstream issuer name
|
// the ID token Username should include the upstream user ID after the upstream issuer name
|
||||||
@ -97,11 +97,45 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
},
|
},
|
||||||
}, idpv1alpha1.PhaseReady)
|
}, idpv1alpha1.PhaseReady)
|
||||||
},
|
},
|
||||||
requestAuthorization: requestAuthorizationUsingOIDCIdentityProvider,
|
requestAuthorization: requestAuthorizationUsingBrowserAuthcodeFlow,
|
||||||
wantDownstreamIDTokenSubjectToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Issuer+"?sub=") + ".+",
|
wantDownstreamIDTokenSubjectToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Issuer+"?sub=") + ".+",
|
||||||
wantDownstreamIDTokenUsernameToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Username),
|
wantDownstreamIDTokenUsernameToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Username),
|
||||||
wantDownstreamIDTokenGroups: env.SupervisorUpstreamOIDC.ExpectedGroups,
|
wantDownstreamIDTokenGroups: env.SupervisorUpstreamOIDC.ExpectedGroups,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "oidc with CLI password flow",
|
||||||
|
maybeSkip: func(t *testing.T) {
|
||||||
|
// never need to skip this test
|
||||||
|
},
|
||||||
|
createIDP: func(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
testlib.CreateTestOIDCIdentityProvider(t, idpv1alpha1.OIDCIdentityProviderSpec{
|
||||||
|
Issuer: env.SupervisorUpstreamOIDC.Issuer,
|
||||||
|
TLS: &idpv1alpha1.TLSSpec{
|
||||||
|
CertificateAuthorityData: base64.StdEncoding.EncodeToString([]byte(env.SupervisorUpstreamOIDC.CABundle)),
|
||||||
|
},
|
||||||
|
Client: idpv1alpha1.OIDCClient{
|
||||||
|
SecretName: testlib.CreateClientCredsSecret(t, env.SupervisorUpstreamOIDC.ClientID, env.SupervisorUpstreamOIDC.ClientSecret).Name,
|
||||||
|
},
|
||||||
|
AuthorizationConfig: idpv1alpha1.OIDCAuthorizationConfig{
|
||||||
|
AllowPasswordGrant: true, // allow the CLI password flow for this OIDCIdentityProvider
|
||||||
|
},
|
||||||
|
}, idpv1alpha1.PhaseReady)
|
||||||
|
},
|
||||||
|
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
||||||
|
requestAuthorizationUsingCLIPasswordFlow(t,
|
||||||
|
downstreamAuthorizeURL,
|
||||||
|
env.SupervisorUpstreamOIDC.Username, // username to present to server during login
|
||||||
|
env.SupervisorUpstreamOIDC.Password, // password to present to server during login
|
||||||
|
httpClient,
|
||||||
|
false,
|
||||||
|
)
|
||||||
|
},
|
||||||
|
// the ID token Subject should include the upstream user ID after the upstream issuer name
|
||||||
|
wantDownstreamIDTokenSubjectToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Issuer+"?sub=") + ".+",
|
||||||
|
// the ID token Username should include the upstream user ID after the upstream issuer name
|
||||||
|
wantDownstreamIDTokenUsernameToMatch: regexp.QuoteMeta(env.SupervisorUpstreamOIDC.Issuer+"?sub=") + ".+",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: "ldap with email as username and groups names as DNs and using an LDAP provider which supports TLS",
|
name: "ldap with email as username and groups names as DNs and using an LDAP provider which supports TLS",
|
||||||
maybeSkip: func(t *testing.T) {
|
maybeSkip: func(t *testing.T) {
|
||||||
@ -150,7 +184,7 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
requireSuccessfulLDAPIdentityProviderConditions(t, ldapIDP, expectedMsg)
|
requireSuccessfulLDAPIdentityProviderConditions(t, ldapIDP, expectedMsg)
|
||||||
},
|
},
|
||||||
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
||||||
requestAuthorizationUsingLDAPIdentityProvider(t,
|
requestAuthorizationUsingCLIPasswordFlow(t,
|
||||||
downstreamAuthorizeURL,
|
downstreamAuthorizeURL,
|
||||||
env.SupervisorUpstreamLDAP.TestUserMailAttributeValue, // username to present to server during login
|
env.SupervisorUpstreamLDAP.TestUserMailAttributeValue, // username to present to server during login
|
||||||
env.SupervisorUpstreamLDAP.TestUserPassword, // password to present to server during login
|
env.SupervisorUpstreamLDAP.TestUserPassword, // password to present to server during login
|
||||||
@ -216,7 +250,7 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
requireSuccessfulLDAPIdentityProviderConditions(t, ldapIDP, expectedMsg)
|
requireSuccessfulLDAPIdentityProviderConditions(t, ldapIDP, expectedMsg)
|
||||||
},
|
},
|
||||||
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
||||||
requestAuthorizationUsingLDAPIdentityProvider(t,
|
requestAuthorizationUsingCLIPasswordFlow(t,
|
||||||
downstreamAuthorizeURL,
|
downstreamAuthorizeURL,
|
||||||
env.SupervisorUpstreamLDAP.TestUserCN, // username to present to server during login
|
env.SupervisorUpstreamLDAP.TestUserCN, // username to present to server during login
|
||||||
env.SupervisorUpstreamLDAP.TestUserPassword, // password to present to server during login
|
env.SupervisorUpstreamLDAP.TestUserPassword, // password to present to server during login
|
||||||
@ -282,7 +316,7 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
requireSuccessfulLDAPIdentityProviderConditions(t, ldapIDP, expectedMsg)
|
requireSuccessfulLDAPIdentityProviderConditions(t, ldapIDP, expectedMsg)
|
||||||
},
|
},
|
||||||
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
||||||
requestAuthorizationUsingLDAPIdentityProvider(t,
|
requestAuthorizationUsingCLIPasswordFlow(t,
|
||||||
downstreamAuthorizeURL,
|
downstreamAuthorizeURL,
|
||||||
env.SupervisorUpstreamLDAP.TestUserMailAttributeValue, // username to present to server during login
|
env.SupervisorUpstreamLDAP.TestUserMailAttributeValue, // username to present to server during login
|
||||||
"incorrect", // password to present to server during login
|
"incorrect", // password to present to server during login
|
||||||
@ -329,7 +363,7 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
requireSuccessfulActiveDirectoryIdentityProviderConditions(t, adIDP, expectedMsg)
|
requireSuccessfulActiveDirectoryIdentityProviderConditions(t, adIDP, expectedMsg)
|
||||||
},
|
},
|
||||||
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
||||||
requestAuthorizationUsingLDAPIdentityProvider(t,
|
requestAuthorizationUsingCLIPasswordFlow(t,
|
||||||
downstreamAuthorizeURL,
|
downstreamAuthorizeURL,
|
||||||
env.SupervisorUpstreamActiveDirectory.TestUserPrincipalNameValue, // username to present to server during login
|
env.SupervisorUpstreamActiveDirectory.TestUserPrincipalNameValue, // username to present to server during login
|
||||||
env.SupervisorUpstreamActiveDirectory.TestUserPassword, // password to present to server during login
|
env.SupervisorUpstreamActiveDirectory.TestUserPassword, // password to present to server during login
|
||||||
@ -396,7 +430,7 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
requireSuccessfulActiveDirectoryIdentityProviderConditions(t, adIDP, expectedMsg)
|
requireSuccessfulActiveDirectoryIdentityProviderConditions(t, adIDP, expectedMsg)
|
||||||
},
|
},
|
||||||
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
||||||
requestAuthorizationUsingLDAPIdentityProvider(t,
|
requestAuthorizationUsingCLIPasswordFlow(t,
|
||||||
downstreamAuthorizeURL,
|
downstreamAuthorizeURL,
|
||||||
env.SupervisorUpstreamActiveDirectory.TestUserMailAttributeValue, // username to present to server during login
|
env.SupervisorUpstreamActiveDirectory.TestUserMailAttributeValue, // username to present to server during login
|
||||||
env.SupervisorUpstreamActiveDirectory.TestUserPassword, // password to present to server during login
|
env.SupervisorUpstreamActiveDirectory.TestUserPassword, // password to present to server during login
|
||||||
@ -450,7 +484,7 @@ func TestSupervisorLogin(t *testing.T) {
|
|||||||
requireSuccessfulActiveDirectoryIdentityProviderConditions(t, adIDP, expectedMsg)
|
requireSuccessfulActiveDirectoryIdentityProviderConditions(t, adIDP, expectedMsg)
|
||||||
},
|
},
|
||||||
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
requestAuthorization: func(t *testing.T, downstreamAuthorizeURL, _ string, httpClient *http.Client) {
|
||||||
requestAuthorizationUsingLDAPIdentityProvider(t,
|
requestAuthorizationUsingCLIPasswordFlow(t,
|
||||||
downstreamAuthorizeURL,
|
downstreamAuthorizeURL,
|
||||||
env.SupervisorUpstreamActiveDirectory.TestDeactivatedUserSAMAccountNameValue, // username to present to server during login
|
env.SupervisorUpstreamActiveDirectory.TestDeactivatedUserSAMAccountNameValue, // username to present to server during login
|
||||||
env.SupervisorUpstreamActiveDirectory.TestDeactivatedUserPassword, // password to present to server during login
|
env.SupervisorUpstreamActiveDirectory.TestDeactivatedUserPassword, // password to present to server during login
|
||||||
@ -767,7 +801,7 @@ func verifyTokenResponse(
|
|||||||
require.NotEmpty(t, tokenResponse.RefreshToken)
|
require.NotEmpty(t, tokenResponse.RefreshToken)
|
||||||
}
|
}
|
||||||
|
|
||||||
func requestAuthorizationUsingOIDCIdentityProvider(t *testing.T, downstreamAuthorizeURL, downstreamCallbackURL string, httpClient *http.Client) {
|
func requestAuthorizationUsingBrowserAuthcodeFlow(t *testing.T, downstreamAuthorizeURL, downstreamCallbackURL string, httpClient *http.Client) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
env := testlib.IntegrationEnv(t)
|
env := testlib.IntegrationEnv(t)
|
||||||
|
|
||||||
@ -796,7 +830,7 @@ func requestAuthorizationUsingOIDCIdentityProvider(t *testing.T, downstreamAutho
|
|||||||
browsertest.WaitForURL(t, page, callbackURLPattern)
|
browsertest.WaitForURL(t, page, callbackURLPattern)
|
||||||
}
|
}
|
||||||
|
|
||||||
func requestAuthorizationUsingLDAPIdentityProvider(t *testing.T, downstreamAuthorizeURL, upstreamUsername, upstreamPassword string, httpClient *http.Client, wantErr bool) {
|
func requestAuthorizationUsingCLIPasswordFlow(t *testing.T, downstreamAuthorizeURL, upstreamUsername, upstreamPassword string, httpClient *http.Client, wantErr bool) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
ctx, cancelFunc := context.WithTimeout(context.Background(), time.Minute)
|
ctx, cancelFunc := context.WithTimeout(context.Background(), time.Minute)
|
||||||
|
@ -137,13 +137,19 @@ func newAnonymousClientRestConfigWithCertAndKeyAdded(t *testing.T, clientCertifi
|
|||||||
return config
|
return config
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func NewKubeclientOptions(t *testing.T, config *rest.Config) []kubeclient.Option {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
return []kubeclient.Option{
|
||||||
|
kubeclient.WithConfig(config),
|
||||||
|
kubeclient.WithMiddleware(groupsuffix.New(IntegrationEnv(t).APIGroupSuffix)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func NewKubeclient(t *testing.T, config *rest.Config) *kubeclient.Client {
|
func NewKubeclient(t *testing.T, config *rest.Config) *kubeclient.Client {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
env := IntegrationEnv(t)
|
|
||||||
client, err := kubeclient.New(
|
client, err := kubeclient.New(NewKubeclientOptions(t, config)...)
|
||||||
kubeclient.WithConfig(config),
|
|
||||||
kubeclient.WithMiddleware(groupsuffix.New(env.APIGroupSuffix)),
|
|
||||||
)
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
return client
|
return client
|
||||||
}
|
}
|
||||||
@ -543,6 +549,30 @@ func CreatePod(ctx context.Context, t *testing.T, name, namespace string, spec c
|
|||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func CreateNamespace(ctx context.Context, t *testing.T, name string) *corev1.Namespace {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
adminClient := NewKubernetesClientset(t)
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(ctx, time.Minute)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
namespace, err := adminClient.CoreV1().Namespaces().Create(ctx, &corev1.Namespace{
|
||||||
|
ObjectMeta: metav1.ObjectMeta{GenerateName: name + "-integration-test-"},
|
||||||
|
}, metav1.CreateOptions{})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
t.Cleanup(func() {
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
t.Logf("cleaning up test namespace %s", namespace.Name)
|
||||||
|
require.NoError(t, adminClient.CoreV1().Namespaces().Delete(ctx, namespace.Name, metav1.DeleteOptions{}))
|
||||||
|
})
|
||||||
|
|
||||||
|
return namespace
|
||||||
|
}
|
||||||
|
|
||||||
func WaitForUserToHaveAccess(t *testing.T, user string, groups []string, shouldHaveAccessTo *authorizationv1.ResourceAttributes) {
|
func WaitForUserToHaveAccess(t *testing.T, user string, groups []string, shouldHaveAccessTo *authorizationv1.ResourceAttributes) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
client := NewKubernetesClientset(t)
|
client := NewKubernetesClientset(t)
|
||||||
|
Loading…
Reference in New Issue
Block a user