571 lines
16 KiB
Go
571 lines
16 KiB
Go
package providers
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"testing"
|
|
|
|
"github.com/coreos/go-oidc"
|
|
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
type redeemTokenResponse struct {
|
|
AccessToken string `json:"access_token"`
|
|
RefreshToken string `json:"refresh_token"`
|
|
ExpiresIn int64 `json:"expires_in"`
|
|
TokenType string `json:"token_type"`
|
|
IDToken string `json:"id_token,omitempty"`
|
|
}
|
|
|
|
func newOIDCProvider(serverURL *url.URL) *OIDCProvider {
|
|
|
|
providerData := &ProviderData{
|
|
ProviderName: "oidc",
|
|
ClientID: oidcClientID,
|
|
ClientSecret: oidcSecret,
|
|
LoginURL: &url.URL{
|
|
Scheme: serverURL.Scheme,
|
|
Host: serverURL.Host,
|
|
Path: "/login/oauth/authorize"},
|
|
RedeemURL: &url.URL{
|
|
Scheme: serverURL.Scheme,
|
|
Host: serverURL.Host,
|
|
Path: "/login/oauth/access_token"},
|
|
ProfileURL: &url.URL{
|
|
Scheme: serverURL.Scheme,
|
|
Host: serverURL.Host,
|
|
Path: "/profile"},
|
|
ValidateURL: &url.URL{
|
|
Scheme: serverURL.Scheme,
|
|
Host: serverURL.Host,
|
|
Path: "/api"},
|
|
Scope: "openid profile offline_access",
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
Verifier: oidc.NewVerifier(
|
|
oidcIssuer,
|
|
mockJWKS{},
|
|
&oidc.Config{ClientID: oidcClientID},
|
|
),
|
|
}
|
|
|
|
p := &OIDCProvider{ProviderData: providerData}
|
|
|
|
return p
|
|
}
|
|
|
|
func newOIDCServer(body []byte) (*url.URL, *httptest.Server) {
|
|
s := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
|
|
rw.Header().Add("content-type", "application/json")
|
|
_, _ = rw.Write(body)
|
|
}))
|
|
u, _ := url.Parse(s.URL)
|
|
return u, s
|
|
}
|
|
|
|
func newTestOIDCSetup(body []byte) (*httptest.Server, *OIDCProvider) {
|
|
redeemURL, server := newOIDCServer(body)
|
|
provider := newOIDCProvider(redeemURL)
|
|
return server, provider
|
|
}
|
|
|
|
func TestOIDCProviderRedeem(t *testing.T) {
|
|
|
|
idToken, _ := newSignedTestIDToken(defaultIDToken)
|
|
body, _ := json.Marshal(redeemTokenResponse{
|
|
AccessToken: accessToken,
|
|
ExpiresIn: 10,
|
|
TokenType: "Bearer",
|
|
RefreshToken: refreshToken,
|
|
IDToken: idToken,
|
|
})
|
|
|
|
server, provider := newTestOIDCSetup(body)
|
|
defer server.Close()
|
|
|
|
session, err := provider.Redeem(context.Background(), provider.RedeemURL.String(), "code1234")
|
|
assert.Equal(t, nil, err)
|
|
assert.Equal(t, defaultIDToken.Email, session.Email)
|
|
assert.Equal(t, accessToken, session.AccessToken)
|
|
assert.Equal(t, idToken, session.IDToken)
|
|
assert.Equal(t, refreshToken, session.RefreshToken)
|
|
assert.Equal(t, "123456789", session.User)
|
|
}
|
|
|
|
func TestOIDCProviderRedeem_custom_userid(t *testing.T) {
|
|
|
|
idToken, _ := newSignedTestIDToken(defaultIDToken)
|
|
body, _ := json.Marshal(redeemTokenResponse{
|
|
AccessToken: accessToken,
|
|
ExpiresIn: 10,
|
|
TokenType: "Bearer",
|
|
RefreshToken: refreshToken,
|
|
IDToken: idToken,
|
|
})
|
|
|
|
server, provider := newTestOIDCSetup(body)
|
|
provider.EmailClaim = "phone_number"
|
|
defer server.Close()
|
|
|
|
session, err := provider.Redeem(context.Background(), provider.RedeemURL.String(), "code1234")
|
|
assert.Equal(t, nil, err)
|
|
assert.Equal(t, defaultIDToken.Phone, session.Email)
|
|
}
|
|
|
|
func TestOIDCProvider_EnrichSession(t *testing.T) {
|
|
testCases := map[string]struct {
|
|
ExistingSession *sessions.SessionState
|
|
EmailClaim string
|
|
GroupsClaim string
|
|
ProfileJSON map[string]interface{}
|
|
ExpectedError error
|
|
ExpectedSession *sessions.SessionState
|
|
}{
|
|
"Already Populated": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
"groups": []string{"new", "thing"},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Email": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "found@email.com",
|
|
"groups": []string{"new", "thing"},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
Email: "found@email.com",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
|
|
"Missing Email Only in Profile URL": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "found@email.com",
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
Email: "found@email.com",
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Email with Custom Claim": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "weird",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"weird": "weird@claim.com",
|
|
"groups": []string{"new", "thing"},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
Email: "weird@claim.com",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Email not in Profile URL": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"groups": []string{"new", "thing"},
|
|
},
|
|
ExpectedError: errors.New("neither the id_token nor the profileURL set an email"),
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "missing.email",
|
|
Groups: []string{"already", "populated"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Groups": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: nil,
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
"groups": []string{"new", "thing"},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{"new", "thing"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Groups with Complex Groups in Profile URL": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: nil,
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
"groups": []map[string]interface{}{
|
|
{
|
|
"groupId": "Admin Group Id",
|
|
"roles": []string{"Admin"},
|
|
},
|
|
},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{"{\"groupId\":\"Admin Group Id\",\"roles\":[\"Admin\"]}"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Groups with Singleton Complex Group in Profile URL": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: nil,
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
"groups": map[string]interface{}{
|
|
"groupId": "Admin Group Id",
|
|
"roles": []string{"Admin"},
|
|
},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{"{\"groupId\":\"Admin Group Id\",\"roles\":[\"Admin\"]}"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Empty Groups Claims": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
"groups": []string{"new", "thing"},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Groups with Custom Claim": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: nil,
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "roles",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
"roles": []string{"new", "thing", "roles"},
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{"new", "thing", "roles"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Groups String Profile URL Response": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: nil,
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
"groups": "singleton",
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
Groups: []string{"singleton"},
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
"Missing Groups in both Claims and Profile URL": {
|
|
ExistingSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
EmailClaim: "email",
|
|
GroupsClaim: "groups",
|
|
ProfileJSON: map[string]interface{}{
|
|
"email": "new@thing.com",
|
|
},
|
|
ExpectedError: nil,
|
|
ExpectedSession: &sessions.SessionState{
|
|
User: "already",
|
|
Email: "already@populated.com",
|
|
IDToken: idToken,
|
|
AccessToken: accessToken,
|
|
RefreshToken: refreshToken,
|
|
},
|
|
},
|
|
}
|
|
for testName, tc := range testCases {
|
|
t.Run(testName, func(t *testing.T) {
|
|
jsonResp, err := json.Marshal(tc.ProfileJSON)
|
|
assert.NoError(t, err)
|
|
|
|
server, provider := newTestOIDCSetup(jsonResp)
|
|
provider.ProfileURL, err = url.Parse(server.URL)
|
|
assert.NoError(t, err)
|
|
|
|
provider.EmailClaim = tc.EmailClaim
|
|
provider.GroupsClaim = tc.GroupsClaim
|
|
defer server.Close()
|
|
|
|
err = provider.EnrichSession(context.Background(), tc.ExistingSession)
|
|
assert.Equal(t, tc.ExpectedError, err)
|
|
assert.Equal(t, *tc.ExpectedSession, *tc.ExistingSession)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestOIDCProviderRefreshSessionIfNeededWithoutIdToken(t *testing.T) {
|
|
|
|
idToken, _ := newSignedTestIDToken(defaultIDToken)
|
|
body, _ := json.Marshal(redeemTokenResponse{
|
|
AccessToken: accessToken,
|
|
ExpiresIn: 10,
|
|
TokenType: "Bearer",
|
|
RefreshToken: refreshToken,
|
|
})
|
|
|
|
server, provider := newTestOIDCSetup(body)
|
|
defer server.Close()
|
|
|
|
existingSession := &sessions.SessionState{
|
|
AccessToken: "changeit",
|
|
IDToken: idToken,
|
|
CreatedAt: nil,
|
|
ExpiresOn: nil,
|
|
RefreshToken: refreshToken,
|
|
Email: "janedoe@example.com",
|
|
User: "11223344",
|
|
}
|
|
|
|
refreshed, err := provider.RefreshSessionIfNeeded(context.Background(), existingSession)
|
|
assert.Equal(t, nil, err)
|
|
assert.Equal(t, refreshed, true)
|
|
assert.Equal(t, "janedoe@example.com", existingSession.Email)
|
|
assert.Equal(t, accessToken, existingSession.AccessToken)
|
|
assert.Equal(t, idToken, existingSession.IDToken)
|
|
assert.Equal(t, refreshToken, existingSession.RefreshToken)
|
|
assert.Equal(t, "11223344", existingSession.User)
|
|
}
|
|
|
|
func TestOIDCProviderRefreshSessionIfNeededWithIdToken(t *testing.T) {
|
|
|
|
idToken, _ := newSignedTestIDToken(defaultIDToken)
|
|
body, _ := json.Marshal(redeemTokenResponse{
|
|
AccessToken: accessToken,
|
|
ExpiresIn: 10,
|
|
TokenType: "Bearer",
|
|
RefreshToken: refreshToken,
|
|
IDToken: idToken,
|
|
})
|
|
|
|
server, provider := newTestOIDCSetup(body)
|
|
defer server.Close()
|
|
|
|
existingSession := &sessions.SessionState{
|
|
AccessToken: "changeit",
|
|
IDToken: "changeit",
|
|
CreatedAt: nil,
|
|
ExpiresOn: nil,
|
|
RefreshToken: refreshToken,
|
|
Email: "changeit",
|
|
User: "changeit",
|
|
}
|
|
refreshed, err := provider.RefreshSessionIfNeeded(context.Background(), existingSession)
|
|
assert.Equal(t, nil, err)
|
|
assert.Equal(t, refreshed, true)
|
|
assert.Equal(t, defaultIDToken.Email, existingSession.Email)
|
|
assert.Equal(t, defaultIDToken.Subject, existingSession.User)
|
|
assert.Equal(t, accessToken, existingSession.AccessToken)
|
|
assert.Equal(t, idToken, existingSession.IDToken)
|
|
assert.Equal(t, refreshToken, existingSession.RefreshToken)
|
|
}
|
|
|
|
func TestOIDCProviderCreateSessionFromToken(t *testing.T) {
|
|
testCases := map[string]struct {
|
|
IDToken idTokenClaims
|
|
GroupsClaim string
|
|
ExpectedUser string
|
|
ExpectedEmail string
|
|
ExpectedGroups []string
|
|
}{
|
|
"Default IDToken": {
|
|
IDToken: defaultIDToken,
|
|
GroupsClaim: "groups",
|
|
ExpectedUser: "123456789",
|
|
ExpectedEmail: "janed@me.com",
|
|
ExpectedGroups: []string{"test:a", "test:b"},
|
|
},
|
|
"Minimal IDToken with no email claim": {
|
|
IDToken: minimalIDToken,
|
|
GroupsClaim: "groups",
|
|
ExpectedUser: "123456789",
|
|
ExpectedEmail: "123456789",
|
|
ExpectedGroups: nil,
|
|
},
|
|
"Custom Groups Claim": {
|
|
IDToken: defaultIDToken,
|
|
GroupsClaim: "roles",
|
|
ExpectedUser: "123456789",
|
|
ExpectedEmail: "janed@me.com",
|
|
ExpectedGroups: []string{"test:c", "test:d"},
|
|
},
|
|
"Complex Groups Claim": {
|
|
IDToken: complexGroupsIDToken,
|
|
GroupsClaim: "groups",
|
|
ExpectedUser: "123456789",
|
|
ExpectedEmail: "complex@claims.com",
|
|
ExpectedGroups: []string{"{\"groupId\":\"Admin Group Id\",\"roles\":[\"Admin\"]}"},
|
|
},
|
|
}
|
|
for testName, tc := range testCases {
|
|
t.Run(testName, func(t *testing.T) {
|
|
server, provider := newTestOIDCSetup([]byte(`{}`))
|
|
provider.GroupsClaim = tc.GroupsClaim
|
|
defer server.Close()
|
|
|
|
rawIDToken, err := newSignedTestIDToken(tc.IDToken)
|
|
assert.NoError(t, err)
|
|
|
|
ss, err := provider.CreateSessionFromToken(context.Background(), rawIDToken)
|
|
assert.NoError(t, err)
|
|
|
|
assert.Equal(t, tc.ExpectedUser, ss.User)
|
|
assert.Equal(t, tc.ExpectedEmail, ss.Email)
|
|
assert.Equal(t, tc.ExpectedGroups, ss.Groups)
|
|
assert.Equal(t, rawIDToken, ss.IDToken)
|
|
assert.Equal(t, rawIDToken, ss.AccessToken)
|
|
assert.Equal(t, "", ss.RefreshToken)
|
|
})
|
|
}
|
|
}
|