2023-08-01 16:04:21 +00:00
// Copyright 2022-2023 the Pinniped contributors. All Rights Reserved.
2022-02-02 00:50:30 +00:00
// SPDX-License-Identifier: Apache-2.0
package integration
import (
"context"
"encoding/base64"
"fmt"
"io"
"net/url"
"os"
"os/exec"
"path/filepath"
"regexp"
"runtime"
"sort"
"strings"
"testing"
"time"
"github.com/creack/pty"
"github.com/stretchr/testify/require"
authorizationv1 "k8s.io/api/authorization/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
authv1alpha "go.pinniped.dev/generated/latest/apis/concierge/authentication/v1alpha1"
configv1alpha1 "go.pinniped.dev/generated/latest/apis/supervisor/config/v1alpha1"
idpv1alpha1 "go.pinniped.dev/generated/latest/apis/supervisor/idp/v1alpha1"
"go.pinniped.dev/internal/certauthority"
2023-06-22 22:12:33 +00:00
"go.pinniped.dev/internal/federationdomain/oidc"
"go.pinniped.dev/internal/federationdomain/oidcclientvalidator"
"go.pinniped.dev/internal/federationdomain/storage"
2022-02-02 00:50:30 +00:00
"go.pinniped.dev/internal/psession"
"go.pinniped.dev/pkg/oidcclient"
"go.pinniped.dev/pkg/oidcclient/filesession"
"go.pinniped.dev/test/testlib"
"go.pinniped.dev/test/testlib/browsertest"
)
func TestSupervisorWarnings_Browser ( t * testing . T ) {
env := testlib . IntegrationEnv ( t )
ctx , cancelFunc := context . WithTimeout ( context . Background ( ) , 10 * time . Minute )
defer cancelFunc ( )
// Build pinniped CLI.
pinnipedExe := testlib . PinnipedCLIPath ( t )
2023-08-29 22:03:11 +00:00
tempDir := t . TempDir ( )
2022-02-02 00:50:30 +00:00
// Infer the downstream issuer URL from the callback associated with the upstream test client registration.
issuerURL , err := url . Parse ( env . SupervisorUpstreamOIDC . CallbackURL )
require . NoError ( t , err )
require . True ( t , strings . HasSuffix ( issuerURL . Path , "/callback" ) )
issuerURL . Path = strings . TrimSuffix ( issuerURL . Path , "/callback" )
t . Logf ( "testing with downstream issuer URL %s" , issuerURL . String ( ) )
// Generate a CA bundle with which to serve this provider.
t . Logf ( "generating test CA" )
ca , err := certauthority . New ( "Downstream Test CA" , 1 * time . Hour )
require . NoError ( t , err )
// Save that bundle plus the one that signs the upstream issuer, for test purposes.
testCABundlePath := filepath . Join ( tempDir , "test-ca.pem" )
testCABundlePEM := [ ] byte ( string ( ca . Bundle ( ) ) + "\n" + env . SupervisorUpstreamOIDC . CABundle )
testCABundleBase64 := base64 . StdEncoding . EncodeToString ( testCABundlePEM )
2022-08-24 21:45:55 +00:00
require . NoError ( t , os . WriteFile ( testCABundlePath , testCABundlePEM , 0600 ) )
2022-02-02 00:50:30 +00:00
// Use the CA to issue a TLS server cert.
t . Logf ( "issuing test certificate" )
tlsCert , err := ca . IssueServerCert ( [ ] string { issuerURL . Hostname ( ) } , nil , 1 * time . Hour )
require . NoError ( t , err )
certPEM , keyPEM , err := certauthority . ToPEM ( tlsCert )
require . NoError ( t , err )
// Write the serving cert to a secret.
certSecret := testlib . CreateTestSecret ( t ,
env . SupervisorNamespace ,
"oidc-provider-tls" ,
corev1 . SecretTypeTLS ,
map [ string ] string { "tls.crt" : string ( certPEM ) , "tls.key" : string ( keyPEM ) } ,
)
// Create the downstream FederationDomain and expect it to go into the success status condition.
downstream := testlib . CreateTestFederationDomain ( ctx , t ,
issuerURL . String ( ) ,
certSecret . Name ,
2023-06-30 20:43:40 +00:00
configv1alpha1 . FederationDomainPhaseReady ,
2022-02-02 00:50:30 +00:00
)
// Create a JWTAuthenticator that will validate the tokens from the downstream issuer.
clusterAudience := "test-cluster-" + testlib . RandHex ( t , 8 )
authenticator := testlib . CreateTestJWTAuthenticator ( ctx , t , authv1alpha . JWTAuthenticatorSpec {
Issuer : downstream . Spec . Issuer ,
Audience : clusterAudience ,
TLS : & authv1alpha . TLSSpec { CertificateAuthorityData : testCABundleBase64 } ,
} )
2022-03-02 17:03:22 +00:00
const (
yellowColor = "\u001b[33;1m"
resetColor = "\u001b[0m"
)
2022-02-02 00:50:30 +00:00
t . Run ( "LDAP group refresh flow" , func ( t * testing . T ) {
2022-06-08 19:57:00 +00:00
testlib . SkipTestWhenLDAPIsUnavailable ( t , env )
2022-02-02 00:50:30 +00:00
expectedUsername := env . SupervisorUpstreamLDAP . TestUserMailAttributeValue
2023-06-27 16:37:43 +00:00
createdProvider := setupClusterForEndToEndLDAPTest ( t , expectedUsername , env )
2022-02-02 00:50:30 +00:00
// Use a specific session cache for this test.
sessionCachePath := tempDir + "/ldap-test-refresh-sessions.yaml"
credentialCachePath := tempDir + "/ldap-test-refresh-credentials.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-session-cache" , sessionCachePath ,
"--credential-cache" , credentialCachePath ,
2022-06-22 15:21:16 +00:00
"--oidc-scopes" , "offline_access,openid,pinniped:request-audience,groups" ,
2022-02-02 00:50:30 +00:00
} )
// Run "kubectl get namespaces" which should trigger a cli-based login.
start := time . Now ( )
kubectlCmd := exec . CommandContext ( ctx , "kubectl" , "get" , "namespace" , "--kubeconfig" , kubeconfigPath )
kubectlCmd . Env = append ( os . Environ ( ) , env . ProxyEnv ( ) ... )
var kubectlStdoutPipe io . ReadCloser
if runtime . GOOS != "darwin" {
// For some unknown reason this breaks the pty library on some MacOS machines.
// The problem doesn't reproduce for everyone, so this is just a workaround.
kubectlStdoutPipe , err = kubectlCmd . StdoutPipe ( )
require . NoError ( t , err )
}
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 . SupervisorUpstreamLDAP . TestUserPassword + "\n" )
require . NoError ( t , err )
// Read all of the remaining output from the subprocess until EOF.
t . Logf ( "waiting for kubectl to output namespace list" )
// Read all output from the subprocess until EOF.
// Ignore any errors returned because there is always an error on linux.
2022-08-24 21:45:55 +00:00
kubectlPtyOutputBytes , _ := io . ReadAll ( ptyFile )
2022-02-02 00:50:30 +00:00
if kubectlStdoutPipe != nil {
// On non-MacOS check that stdout of the CLI contains the expected output.
2022-08-24 21:45:55 +00:00
kubectlStdOutOutputBytes , _ := io . ReadAll ( kubectlStdoutPipe )
2022-02-02 00:50:30 +00:00
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlStdOutOutputBytes ) )
} else {
// On MacOS check that the pty (stdout+stderr+stdin) of the CLI contains the expected output.
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlPtyOutputBytes ) )
}
t . Logf ( "first kubectl command took %s" , time . Since ( start ) . String ( ) )
// To simulate the groups having changed without actually changing the groups the user belongs to in the LDAP
// server, we update the refresh token secret to have a different value for the groups.
// Then the refresh flow will update them back to their real values.
// To do this, we get the refresh token signature out of the cache, use it to get the Secret, update it, and
// put it back.
cache := filesession . New ( sessionCachePath , filesession . WithErrorReporter ( func ( err error ) {
require . NoError ( t , err )
} ) )
// construct the cache key
Create username scope, required for clients to get username in ID token
- For backwards compatibility with older Pinniped CLIs, the pinniped-cli
client does not need to request the username or groups scopes for them
to be granted. For dynamic clients, the usual OAuth2 rules apply:
the client must be allowed to request the scopes according to its
configuration, and the client must actually request the scopes in the
authorization request.
- If the username scope was not granted, then there will be no username
in the ID token, and the cluster-scoped token exchange will fail since
there would be no username in the resulting cluster-scoped ID token.
- The OIDC well-known discovery endpoint lists the username and groups
scopes in the scopes_supported list, and lists the username and groups
claims in the claims_supported list.
- Add username and groups scopes to the default list of scopes
put into kubeconfig files by "pinniped get kubeconfig" CLI command,
and the default list of scopes used by "pinniped login oidc" when
no list of scopes is specified in the kubeconfig file
- The warning header about group memberships changing during upstream
refresh will only be sent to the pinniped-cli client, since it is
only intended for kubectl and it could leak the username to the
client (which may not have the username scope granted) through the
warning message text.
- Add the user's username to the session storage as a new field, so that
during upstream refresh we can compare the original username from the
initial authorization to the refreshed username, even in the case when
the username scope was not granted (and therefore the username is not
stored in the ID token claims of the session storage)
- Bump the Supervisor session storage format version from 2 to 3
due to the username field being added to the session struct
- Extract commonly used string constants related to OIDC flows to api
package.
- Change some import names to make them consistent:
- Always import github.com/coreos/go-oidc/v3/oidc as "coreosoidc"
- Always import go.pinniped.dev/generated/latest/apis/supervisor/oidc
as "oidcapi"
- Always import go.pinniped.dev/internal/oidc as "oidc"
2022-08-08 23:29:22 +00:00
downstreamScopes := [ ] string { "offline_access" , "openid" , "pinniped:request-audience" , "groups" }
2022-02-02 00:50:30 +00:00
sort . Strings ( downstreamScopes )
sessionCacheKey := oidcclient . SessionCacheKey {
2023-06-27 16:37:43 +00:00
Issuer : downstream . Spec . Issuer ,
ClientID : "pinniped-cli" ,
Scopes : downstreamScopes ,
RedirectURI : "http://localhost:0/callback" ,
UpstreamProviderName : createdProvider . Name ,
2022-02-02 00:50:30 +00:00
}
// use it to get the cache entry
token := cache . GetToken ( sessionCacheKey )
require . NotNil ( t , token )
// using the refresh token signature contained in the cache, get the refresh token session
// out of kube secret storage.
2022-07-14 16:51:11 +00:00
supervisorSecretsClient := testlib . NewKubernetesClientset ( t ) . CoreV1 ( ) . Secrets ( env . SupervisorNamespace )
supervisorOIDCClientsClient := testlib . NewSupervisorClientset ( t ) . ConfigV1alpha1 ( ) . OIDCClients ( env . SupervisorNamespace )
2023-06-22 22:12:33 +00:00
oauthStore := storage . NewKubeStorage ( supervisorSecretsClient , supervisorOIDCClientsClient , oidc . DefaultOIDCTimeoutsConfiguration ( ) , oidcclientvalidator . DefaultMinBcryptCost )
2022-02-02 00:50:30 +00:00
refreshTokenSignature := strings . Split ( token . RefreshToken . Token , "." ) [ 1 ]
storedRefreshSession , err := oauthStore . GetRefreshTokenSession ( ctx , refreshTokenSignature , nil )
require . NoError ( t , err )
// change the groups to simulate them changing in the IDP.
pinnipedSession , ok := storedRefreshSession . GetSession ( ) . ( * psession . PinnipedSession )
require . True ( t , ok , "should have been able to cast session data to PinnipedSession" )
2023-06-27 16:37:43 +00:00
pinnipedSession . Custom . UpstreamGroups = [ ] string { "some-wrong-group" , "some-other-group" } // update upstream groups
pinnipedSession . Fosite . Claims . Extra [ "groups" ] = [ ] string { "some-wrong-group" , "some-other-group" } // update downstream groups
2022-02-02 00:50:30 +00:00
require . NoError ( t , oauthStore . DeleteRefreshTokenSession ( ctx , refreshTokenSignature ) )
require . NoError ( t , oauthStore . CreateRefreshTokenSession ( ctx , refreshTokenSignature , storedRefreshSession ) )
// remove the credential cache, which includes the cached cert, so it won't be reused and the refresh flow will be triggered.
err = os . Remove ( credentialCachePath )
require . NoError ( t , err )
// wait for the existing tokens to expire, triggering the refresh flow.
ctx2 , cancel2 := context . WithTimeout ( ctx , 1 * time . Minute )
defer cancel2 ( )
// Run kubectl, which should work without any prompting for authentication.
kubectlCmd2 := exec . CommandContext ( ctx2 , "kubectl" , "get" , "namespace" , "--kubeconfig" , kubeconfigPath )
kubectlCmd2 . Env = append ( os . Environ ( ) , env . ProxyEnv ( ) ... )
startTime2 := time . Now ( )
var kubectlStdoutPipe2 io . ReadCloser
if runtime . GOOS != "darwin" {
// For some unknown reason this breaks the pty library on some MacOS machines.
// The problem doesn't reproduce for everyone, so this is just a workaround.
kubectlStdoutPipe2 , err = kubectlCmd2 . StdoutPipe ( )
require . NoError ( t , err )
}
ptyFile2 , err := pty . Start ( kubectlCmd2 )
require . NoError ( t , err )
// Read all of the remaining output from the subprocess until EOF.
t . Logf ( "waiting for kubectl to output namespace list" )
// Read all output from the subprocess until EOF.
// Ignore any errors returned because there is always an error on linux.
2022-08-24 21:45:55 +00:00
kubectlPtyOutputBytes2 , _ := io . ReadAll ( ptyFile2 )
2022-02-02 00:50:30 +00:00
if kubectlStdoutPipe2 != nil {
// On non-MacOS check that stdout of the CLI contains the expected output.
2022-08-24 21:45:55 +00:00
kubectlStdOutOutputBytes2 , _ := io . ReadAll ( kubectlStdoutPipe2 )
2022-02-02 00:50:30 +00:00
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlStdOutOutputBytes2 ) )
} else {
// On MacOS check that the pty (stdout+stderr+stdin) of the CLI contains the expected output.
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlPtyOutputBytes2 ) )
}
// the output should include a warning that the groups have changed.
2022-03-02 17:03:22 +00:00
require . Contains ( t , string ( kubectlPtyOutputBytes2 ) , fmt . Sprintf ( ` %sWarning:%s User %q has been added to the following groups: %q ` + "\r\n" , yellowColor , resetColor , env . SupervisorUpstreamLDAP . TestUserMailAttributeValue , env . SupervisorUpstreamLDAP . TestUserDirectGroupsDNs ) )
require . Contains ( t , string ( kubectlPtyOutputBytes2 ) , fmt . Sprintf ( ` %sWarning:%s User %q has been removed from the following groups: ["some-other-group" "some-wrong-group"] ` + "\r\n" , yellowColor , resetColor , env . SupervisorUpstreamLDAP . TestUserMailAttributeValue ) )
2022-02-02 00:50:30 +00:00
t . Logf ( "second kubectl command took %s" , time . Since ( startTime2 ) . String ( ) )
} )
2022-06-08 19:57:00 +00:00
2022-03-02 17:50:07 +00:00
t . Run ( "Active Directory group refresh flow" , func ( t * testing . T ) {
2022-06-08 19:57:00 +00:00
testlib . SkipTestWhenActiveDirectoryIsUnavailable ( t , env )
2022-03-02 17:50:07 +00:00
expectedUsername , password := testlib . CreateFreshADTestUser ( t , env )
sAMAccountName := expectedUsername + "@" + env . SupervisorUpstreamActiveDirectory . Domain
setupClusterForEndToEndActiveDirectoryTest ( t , sAMAccountName , env )
// Use a specific session cache for this test.
sessionCachePath := tempDir + "/ldap-test-refresh-sessions.yaml"
credentialCachePath := tempDir + "/ldap-test-refresh-credentials.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-session-cache" , sessionCachePath ,
"--credential-cache" , credentialCachePath ,
2022-06-22 23:16:32 +00:00
"--oidc-scopes" , "offline_access,openid,pinniped:request-audience,groups" ,
2022-03-02 17:50:07 +00:00
} )
// Run "kubectl get namespaces" which should trigger a cli-based login.
start := time . Now ( )
kubectlCmd := exec . CommandContext ( ctx , "kubectl" , "get" , "namespace" , "--kubeconfig" , kubeconfigPath )
kubectlCmd . Env = append ( os . Environ ( ) , env . ProxyEnv ( ) ... )
var kubectlStdoutPipe io . ReadCloser
if runtime . GOOS != "darwin" {
// For some unknown reason this breaks the pty library on some MacOS machines.
// The problem doesn't reproduce for everyone, so this is just a workaround.
kubectlStdoutPipe , err = kubectlCmd . StdoutPipe ( )
require . NoError ( t , err )
}
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 ( password + "\n" )
require . NoError ( t , err )
// Read all of the remaining output from the subprocess until EOF.
t . Logf ( "waiting for kubectl to output namespace list" )
// Read all output from the subprocess until EOF.
// Ignore any errors returned because there is always an error on linux.
2022-08-24 21:45:55 +00:00
kubectlPtyOutputBytes , _ := io . ReadAll ( ptyFile )
2022-03-02 17:50:07 +00:00
if kubectlStdoutPipe != nil {
// On non-MacOS check that stdout of the CLI contains the expected output.
2022-08-24 21:45:55 +00:00
kubectlStdOutOutputBytes , _ := io . ReadAll ( kubectlStdoutPipe )
2022-03-02 17:50:07 +00:00
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlStdOutOutputBytes ) )
} else {
// On MacOS check that the pty (stdout+stderr+stdin) of the CLI contains the expected output.
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlPtyOutputBytes ) )
}
t . Logf ( "first kubectl command took %s" , time . Since ( start ) . String ( ) )
// create an active directory group, and add our user to it.
groupName := testlib . CreateFreshADTestGroup ( t , env )
testlib . AddTestUserToGroup ( t , env , groupName , expectedUsername )
// remove the credential cache, which includes the cached cert, so it won't be reused and the refresh flow will be triggered.
err = os . Remove ( credentialCachePath )
require . NoError ( t , err )
ctx2 , cancel2 := context . WithTimeout ( ctx , 1 * time . Minute )
defer cancel2 ( )
// Run kubectl, which should work without any prompting for authentication.
kubectlCmd2 := exec . CommandContext ( ctx2 , "kubectl" , "get" , "namespace" , "--kubeconfig" , kubeconfigPath )
kubectlCmd2 . Env = append ( os . Environ ( ) , env . ProxyEnv ( ) ... )
startTime2 := time . Now ( )
var kubectlStdoutPipe2 io . ReadCloser
if runtime . GOOS != "darwin" {
// For some unknown reason this breaks the pty library on some MacOS machines.
// The problem doesn't reproduce for everyone, so this is just a workaround.
kubectlStdoutPipe2 , err = kubectlCmd2 . StdoutPipe ( )
require . NoError ( t , err )
}
ptyFile2 , err := pty . Start ( kubectlCmd2 )
require . NoError ( t , err )
// Read all of the remaining output from the subprocess until EOF.
t . Logf ( "waiting for kubectl to output namespace list" )
// Read all output from the subprocess until EOF.
// Ignore any errors returned because there is always an error on linux.
2022-08-24 21:45:55 +00:00
kubectlPtyOutputBytes2 , _ := io . ReadAll ( ptyFile2 )
2022-03-02 17:50:07 +00:00
if kubectlStdoutPipe2 != nil {
// On non-MacOS check that stdout of the CLI contains the expected output.
2022-08-24 21:45:55 +00:00
kubectlStdOutOutputBytes2 , _ := io . ReadAll ( kubectlStdoutPipe2 )
2022-03-02 17:50:07 +00:00
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlStdOutOutputBytes2 ) )
} else {
// On MacOS check that the pty (stdout+stderr+stdin) of the CLI contains the expected output.
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlPtyOutputBytes2 ) )
}
// the output should include a warning that a group has been added.
require . Contains ( t , string ( kubectlPtyOutputBytes2 ) , fmt . Sprintf ( ` %sWarning:%s User %q has been added to the following groups: %q ` + "\r\n" , yellowColor , resetColor , sAMAccountName , [ ] string { groupName + "@" + env . SupervisorUpstreamActiveDirectory . Domain } ) )
// there should not be a warning about being removed from groups, since we haven't done so.
require . NotContains ( t , string ( kubectlPtyOutputBytes2 ) , "has been removed from" )
t . Logf ( "second kubectl command took %s" , time . Since ( startTime2 ) . String ( ) )
} )
2022-02-02 00:50:30 +00:00
t . Run ( "OIDC group refresh flow" , func ( t * testing . T ) {
if len ( env . SupervisorUpstreamOIDC . ExpectedGroups ) == 0 {
t . Skip ( "Skipping OIDC group refresh test since there are no groups" )
}
// Start a fresh browser driver because we don't want to share cookies between the various tests in this file.
2023-08-01 16:04:21 +00:00
browser := browsertest . OpenBrowser ( t )
2022-02-02 00:50:30 +00:00
expectedUsername := env . SupervisorUpstreamOIDC . Username
// 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.
2023-06-27 16:37:43 +00:00
createdProvider := testlib . CreateTestOIDCIdentityProvider ( t , idpv1alpha1 . OIDCIdentityProviderSpec {
2022-02-02 00:50:30 +00:00
Issuer : env . SupervisorUpstreamOIDC . Issuer ,
TLS : & idpv1alpha1 . TLSSpec {
CertificateAuthorityData : base64 . StdEncoding . EncodeToString ( [ ] byte ( env . SupervisorUpstreamOIDC . CABundle ) ) ,
} ,
AuthorizationConfig : idpv1alpha1 . OIDCAuthorizationConfig {
AdditionalScopes : env . SupervisorUpstreamOIDC . AdditionalScopes ,
} ,
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 + "/ldap-test-refresh-sessions.yaml"
credentialCachePath := tempDir + "/ldap-test-refresh-credentials.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" ,
"--oidc-ca-bundle" , testCABundlePath ,
"--oidc-session-cache" , sessionCachePath ,
2022-06-22 23:16:32 +00:00
"--oidc-scopes" , "offline_access,openid,pinniped:request-audience,groups" ,
2022-02-02 00:50:30 +00:00
"--credential-cache" , credentialCachePath ,
} )
// Run "kubectl get namespaces" which should trigger a cli-based login.
start := time . Now ( )
kubectlCmd := exec . CommandContext ( ctx , "kubectl" , "get" , "namespace" , "--kubeconfig" , kubeconfigPath )
kubectlCmd . Env = append ( os . Environ ( ) , env . ProxyEnv ( ) ... )
var kubectlStdoutPipe io . ReadCloser
if runtime . GOOS != "darwin" {
// For some unknown reason this breaks the pty library on some MacOS machines.
// The problem doesn't reproduce for everyone, so this is just a workaround.
kubectlStdoutPipe , err = kubectlCmd . StdoutPipe ( )
require . NoError ( t , err )
}
ptyFile , err := pty . Start ( kubectlCmd )
require . NoError ( t , err )
// Wait for the subprocess to print the login prompt.
t . Logf ( "waiting for CLI to output login URL and manual prompt" )
output := readFromFileUntilStringIsSeen ( t , ptyFile , "Optionally, paste your authorization code: " )
require . Contains ( t , output , "Log in by visiting this link:" )
require . Contains ( t , output , "Optionally, paste your authorization code: " )
// Find the line with the login URL.
var loginURL string
for _ , line := range strings . Split ( output , "\n" ) {
trimmed := strings . TrimSpace ( line )
if strings . HasPrefix ( trimmed , "https://" ) {
loginURL = trimmed
}
}
require . NotEmptyf ( t , loginURL , "didn't find login URL in output: %s" , output )
t . Logf ( "navigating to login page" )
2023-08-01 16:04:21 +00:00
browser . Navigate ( t , loginURL )
2022-02-02 00:50:30 +00:00
// Expect to be redirected to the upstream provider and log in.
2023-08-01 16:04:21 +00:00
browsertest . LoginToUpstreamOIDC ( t , browser , env . SupervisorUpstreamOIDC )
2022-02-02 00:50:30 +00:00
// Expect to be redirected to the downstream callback which is serving the form_post HTML.
t . Logf ( "waiting for response page %s" , downstream . Spec . Issuer )
2023-08-01 16:04:21 +00:00
browser . WaitForURL ( t , regexp . MustCompile ( regexp . QuoteMeta ( downstream . Spec . Issuer ) ) )
2022-02-02 00:50:30 +00:00
// The response page should have failed to automatically post, and should now be showing the manual instructions.
2023-08-01 16:04:21 +00:00
authCode := formpostExpectManualState ( t , browser )
2022-02-02 00:50:30 +00:00
// Enter the auth code in the waiting prompt, followed by a newline.
t . Logf ( "'manually' pasting authorization code %q to waiting prompt" , authCode )
_ , err = ptyFile . WriteString ( authCode + "\n" )
require . NoError ( t , err )
// Read all of the remaining output from the subprocess until EOF.
t . Logf ( "waiting for kubectl to output namespace list" )
// Read all output from the subprocess until EOF.
// Ignore any errors returned because there is always an error on linux.
2022-08-24 21:45:55 +00:00
kubectlPtyOutputBytes , _ := io . ReadAll ( ptyFile )
2022-02-02 00:50:30 +00:00
if kubectlStdoutPipe != nil {
// On non-MacOS check that stdout of the CLI contains the expected output.
2022-08-24 21:45:55 +00:00
kubectlStdOutOutputBytes , _ := io . ReadAll ( kubectlStdoutPipe )
2022-02-02 00:50:30 +00:00
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlStdOutOutputBytes ) )
} else {
// On MacOS check that the pty (stdout+stderr+stdin) of the CLI contains the expected output.
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlPtyOutputBytes ) )
}
t . Logf ( "first kubectl command took %s" , time . Since ( start ) . String ( ) )
// To simulate the groups having changed without actually changing the groups the user belongs to in the LDAP
// server, we update the refresh token secret to have a different value for the groups.
// Then the refresh flow will update them back to their real values.
// To do this, we get the refresh token signature out of the cache, use it to get the Secret, update it, and
// put it back.
cache := filesession . New ( sessionCachePath , filesession . WithErrorReporter ( func ( err error ) {
require . NoError ( t , err )
} ) )
// construct the cache key
Create username scope, required for clients to get username in ID token
- For backwards compatibility with older Pinniped CLIs, the pinniped-cli
client does not need to request the username or groups scopes for them
to be granted. For dynamic clients, the usual OAuth2 rules apply:
the client must be allowed to request the scopes according to its
configuration, and the client must actually request the scopes in the
authorization request.
- If the username scope was not granted, then there will be no username
in the ID token, and the cluster-scoped token exchange will fail since
there would be no username in the resulting cluster-scoped ID token.
- The OIDC well-known discovery endpoint lists the username and groups
scopes in the scopes_supported list, and lists the username and groups
claims in the claims_supported list.
- Add username and groups scopes to the default list of scopes
put into kubeconfig files by "pinniped get kubeconfig" CLI command,
and the default list of scopes used by "pinniped login oidc" when
no list of scopes is specified in the kubeconfig file
- The warning header about group memberships changing during upstream
refresh will only be sent to the pinniped-cli client, since it is
only intended for kubectl and it could leak the username to the
client (which may not have the username scope granted) through the
warning message text.
- Add the user's username to the session storage as a new field, so that
during upstream refresh we can compare the original username from the
initial authorization to the refreshed username, even in the case when
the username scope was not granted (and therefore the username is not
stored in the ID token claims of the session storage)
- Bump the Supervisor session storage format version from 2 to 3
due to the username field being added to the session struct
- Extract commonly used string constants related to OIDC flows to api
package.
- Change some import names to make them consistent:
- Always import github.com/coreos/go-oidc/v3/oidc as "coreosoidc"
- Always import go.pinniped.dev/generated/latest/apis/supervisor/oidc
as "oidcapi"
- Always import go.pinniped.dev/internal/oidc as "oidc"
2022-08-08 23:29:22 +00:00
downstreamScopes := [ ] string { "offline_access" , "openid" , "pinniped:request-audience" , "groups" }
2022-02-02 00:50:30 +00:00
sort . Strings ( downstreamScopes )
sessionCacheKey := oidcclient . SessionCacheKey {
2023-06-27 16:37:43 +00:00
Issuer : downstream . Spec . Issuer ,
ClientID : "pinniped-cli" ,
Scopes : downstreamScopes ,
RedirectURI : "http://localhost:0/callback" ,
UpstreamProviderName : createdProvider . Name ,
2022-02-02 00:50:30 +00:00
}
// use it to get the cache entry
token := cache . GetToken ( sessionCacheKey )
require . NotNil ( t , token )
// using the refresh token signature contained in the cache, get the refresh token session
// out of kube secret storage.
2022-07-14 16:51:11 +00:00
supervisorSecretsClient := testlib . NewKubernetesClientset ( t ) . CoreV1 ( ) . Secrets ( env . SupervisorNamespace )
supervisorOIDCClientsClient := testlib . NewSupervisorClientset ( t ) . ConfigV1alpha1 ( ) . OIDCClients ( env . SupervisorNamespace )
2023-06-22 22:12:33 +00:00
oauthStore := storage . NewKubeStorage ( supervisorSecretsClient , supervisorOIDCClientsClient , oidc . DefaultOIDCTimeoutsConfiguration ( ) , oidcclientvalidator . DefaultMinBcryptCost )
2022-02-02 00:50:30 +00:00
refreshTokenSignature := strings . Split ( token . RefreshToken . Token , "." ) [ 1 ]
storedRefreshSession , err := oauthStore . GetRefreshTokenSession ( ctx , refreshTokenSignature , nil )
require . NoError ( t , err )
// change the groups to simulate them changing in the IDP.
pinnipedSession , ok := storedRefreshSession . GetSession ( ) . ( * psession . PinnipedSession )
require . True ( t , ok , "should have been able to cast session data to PinnipedSession" )
pinnipedSession . Fosite . Claims . Extra [ "groups" ] = [ ] string { "some-wrong-group" , "some-other-group" }
require . NoError ( t , oauthStore . DeleteRefreshTokenSession ( ctx , refreshTokenSignature ) )
require . NoError ( t , oauthStore . CreateRefreshTokenSession ( ctx , refreshTokenSignature , storedRefreshSession ) )
// remove the credential cache, which includes the cached cert, so it won't be reused and the refresh flow will be triggered.
err = os . Remove ( credentialCachePath )
require . NoError ( t , err )
// wait for the existing tokens to expire, triggering the refresh flow.
ctx2 , cancel2 := context . WithTimeout ( ctx , 1 * time . Minute )
defer cancel2 ( )
// Run kubectl, which should work without any prompting for authentication.
kubectlCmd2 := exec . CommandContext ( ctx2 , "kubectl" , "get" , "namespace" , "--kubeconfig" , kubeconfigPath )
kubectlCmd2 . Env = append ( os . Environ ( ) , env . ProxyEnv ( ) ... )
startTime2 := time . Now ( )
var kubectlStdoutPipe2 io . ReadCloser
if runtime . GOOS != "darwin" {
// For some unknown reason this breaks the pty library on some MacOS machines.
// The problem doesn't reproduce for everyone, so this is just a workaround.
kubectlStdoutPipe2 , err = kubectlCmd2 . StdoutPipe ( )
require . NoError ( t , err )
}
ptyFile2 , err := pty . Start ( kubectlCmd2 )
require . NoError ( t , err )
// Read all of the remaining output from the subprocess until EOF.
t . Logf ( "waiting for kubectl to output namespace list" )
// Read all output from the subprocess until EOF.
// Ignore any errors returned because there is always an error on linux.
2022-08-24 21:45:55 +00:00
kubectlPtyOutputBytes2 , _ := io . ReadAll ( ptyFile2 )
2022-02-02 00:50:30 +00:00
if kubectlStdoutPipe2 != nil {
// On non-MacOS check that stdout of the CLI contains the expected output.
2022-08-24 21:45:55 +00:00
kubectlStdOutOutputBytes2 , _ := io . ReadAll ( kubectlStdoutPipe2 )
2022-02-02 00:50:30 +00:00
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlStdOutOutputBytes2 ) )
} else {
// On MacOS check that the pty (stdout+stderr+stdin) of the CLI contains the expected output.
requireKubectlGetNamespaceOutput ( t , env , string ( kubectlPtyOutputBytes2 ) )
}
// the output should include a warning that the groups have changed.
2022-03-02 17:03:22 +00:00
require . Contains ( t , string ( kubectlPtyOutputBytes2 ) , fmt . Sprintf ( ` %sWarning:%s User %q has been added to the following groups: %q ` + "\r\n" , yellowColor , resetColor , env . SupervisorUpstreamOIDC . Username , env . SupervisorUpstreamOIDC . ExpectedGroups ) )
require . Contains ( t , string ( kubectlPtyOutputBytes2 ) , fmt . Sprintf ( ` %sWarning:%s User %q has been removed from the following groups: ["some-other-group" "some-wrong-group"] ` + "\r\n" , yellowColor , resetColor , env . SupervisorUpstreamOIDC . Username ) )
2022-02-02 00:50:30 +00:00
t . Logf ( "second kubectl command took %s" , time . Since ( startTime2 ) . String ( ) )
} )
}