Skip to content

Commit a862bf1

Browse files
EmyrkEmyrk
committed
test: implement unit tests for skipping oidc issuer checks
Unit tests build oidc config differently than production. These test verify the approach
1 parent ecc356f commit a862bf1

File tree

3 files changed

+182
-20
lines changed

3 files changed

+182
-20
lines changed

‎coderd/coderdtest/oidctest/idp.go

Lines changed: 61 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ type FakeIDP struct {
9797
deviceCode *syncmap.Map[string, deviceFlow]
9898

9999
// hooks
100+
// hookWellKnown allows mutating the returned .well-known/configuration JSON.
101+
// Using this can break the IDP configuration, so be careful.
102+
hookWellKnown func(r *http.Request, j *ProviderJSON) error
100103
// hookValidRedirectURL can be used to reject a redirect url from the
101104
// IDP -> Application. Almost all IDPs have the concept of
102105
// "Authorized Redirect URLs". This can be used to emulate that.
@@ -151,6 +154,12 @@ func WithMiddlewares(mws ...func(http.Handler) http.Handler) func(*FakeIDP) {
151154
}
152155
}
153156

157+
func WithHookWellKnown(hook func(r *http.Request, j *ProviderJSON) error) func(*FakeIDP) {
158+
return func(f *FakeIDP) {
159+
f.hookWellKnown = hook
160+
}
161+
}
162+
154163
// WithRefresh is called when a refresh token is used. The email is
155164
// the email of the user that is being refreshed assuming the claims are correct.
156165
func WithRefresh(hook func(email string) error) func(*FakeIDP) {
@@ -753,7 +762,16 @@ func (f *FakeIDP) httpHandler(t testing.TB) http.Handler {
753762
mux.Get("/.well-known/openid-configuration", func(rw http.ResponseWriter, r *http.Request) {
754763
f.logger.Info(r.Context(), "http OIDC config", slogRequestFields(r)...)
755764

756-
_ = json.NewEncoder(rw).Encode(f.provider)
765+
cpy := f.provider
766+
if f.hookWellKnown != nil {
767+
err := f.hookWellKnown(r, &cpy)
768+
if err != nil {
769+
http.Error(rw, err.Error(), http.StatusInternalServerError)
770+
return
771+
}
772+
}
773+
774+
_ = json.NewEncoder(rw).Encode(cpy)
757775
})
758776

759777
// Authorize is called when the user is redirected to the IDP to login.
@@ -1371,8 +1389,11 @@ func (f *FakeIDP) AppCredentials() (clientID string, clientSecret string) {
13711389
return f.clientID, f.clientSecret
13721390
}
13731391

1374-
// OIDCConfig returns the OIDC config to use for Coderd.
1375-
func (f *FakeIDP) OIDCConfig(t testing.TB, scopes []string, opts ...func(cfg *coderd.OIDCConfig)) *coderd.OIDCConfig {
1392+
func (f *FakeIDP) PublicKey() crypto.PublicKey {
1393+
return f.key.Public()
1394+
}
1395+
1396+
func (f *FakeIDP) OauthConfig(t testing.TB, scopes []string) *oauth2.Config {
13761397
t.Helper()
13771398

13781399
if len(scopes) == 0 {
@@ -1391,22 +1412,50 @@ func (f *FakeIDP) OIDCConfig(t testing.TB, scopes []string, opts ...func(cfg *co
13911412
RedirectURL: "https://redirect.com",
13921413
Scopes: scopes,
13931414
}
1415+
f.cfg = oauthCfg
13941416

1395-
ctx := oidc.ClientContext(context.Background(), f.HTTPClient(nil))
1417+
return oauthCfg
1418+
}
1419+
1420+
func (f *FakeIDP) OIDCConfigSkipIssuerChecks(t testing.TB, scopes []string, opts ...func(cfg *coderd.OIDCConfig)) *coderd.OIDCConfig {
1421+
ctx := oidc.InsecureIssuerURLContext(context.Background(), f.issuer)
1422+
1423+
return f.oidcConfig(ctx, t, scopes, func(config *oidc.Config) {
1424+
config.SkipIssuerCheck = true
1425+
}, opts...)
1426+
}
1427+
1428+
func (f *FakeIDP) OIDCConfig(t testing.TB, scopes []string, opts ...func(cfg *coderd.OIDCConfig)) *coderd.OIDCConfig {
1429+
return f.oidcConfig(context.Background(), t, scopes, nil, opts...)
1430+
}
1431+
1432+
// OIDCConfig returns the OIDC config to use for Coderd.
1433+
func (f *FakeIDP) oidcConfig(ctx context.Context, t testing.TB, scopes []string, verifierOpt func(config *oidc.Config), opts ...func(cfg *coderd.OIDCConfig)) *coderd.OIDCConfig {
1434+
t.Helper()
1435+
1436+
oauthCfg := f.OauthConfig(t, scopes)
1437+
1438+
ctx = oidc.ClientContext(ctx, f.HTTPClient(nil))
13961439
p, err := oidc.NewProvider(ctx, f.provider.Issuer)
13971440
require.NoError(t, err, "failed to create OIDC provider")
1441+
1442+
verifierConfig := &oidc.Config{
1443+
ClientID: oauthCfg.ClientID,
1444+
SupportedSigningAlgs: []string{
1445+
"RS256",
1446+
},
1447+
// Todo: add support for Now()
1448+
}
1449+
if verifierOpt != nil {
1450+
verifierOpt(verifierConfig)
1451+
}
1452+
13981453
cfg := &coderd.OIDCConfig{
13991454
OAuth2Config: oauthCfg,
14001455
Provider: p,
14011456
Verifier: oidc.NewVerifier(f.provider.Issuer, &oidc.StaticKeySet{
14021457
PublicKeys: []crypto.PublicKey{f.key.Public()},
1403-
}, &oidc.Config{
1404-
ClientID: oauthCfg.ClientID,
1405-
SupportedSigningAlgs: []string{
1406-
"RS256",
1407-
},
1408-
// Todo: add support for Now()
1409-
}),
1458+
}, verifierConfig),
14101459
UsernameField: "preferred_username",
14111460
EmailField: "email",
14121461
AuthURLParams: map[string]string{"access_type": "offline"},
@@ -1419,13 +1468,12 @@ func (f *FakeIDP) OIDCConfig(t testing.TB, scopes []string, opts ...func(cfg *co
14191468
opt(cfg)
14201469
}
14211470

1422-
f.cfg = oauthCfg
14231471
return cfg
14241472
}
14251473

14261474
func (f *FakeIDP) getClaims(m *syncmap.Map[string, jwt.MapClaims], key string) (jwt.MapClaims, bool) {
14271475
v, ok := m.Load(key)
1428-
if !ok {
1476+
if !ok || v == nil {
14291477
if f.defaultIDClaims != nil {
14301478
return f.defaultIDClaims, true
14311479
}

‎coderd/coderdtest/oidctest/idp_test.go

Lines changed: 85 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,22 @@ package oidctest_test
22

33
import (
44
"context"
5+
"crypto"
56
"net/http"
6-
"net/http/httptest"
77
"testing"
88
"time"
99

1010
"github.com/golang-jwt/jwt/v4"
1111
"github.com/stretchr/testify/assert"
12+
"golang.org/x/xerrors"
1213

1314
"github.com/coreos/go-oidc/v3/oidc"
1415
"github.com/stretchr/testify/require"
1516
"golang.org/x/oauth2"
1617

18+
"github.com/coder/coder/v2/coderd"
1719
"github.com/coder/coder/v2/coderd/coderdtest/oidctest"
20+
"github.com/coder/coder/v2/testutil"
1821
)
1922

2023
// TestFakeIDPBasicFlow tests the basic flow of the fake IDP.
@@ -27,12 +30,6 @@ func TestFakeIDPBasicFlow(t *testing.T) {
2730
oidctest.WithLogging(t, nil),
2831
)
2932

30-
var handler http.Handler
31-
srv := httptest.NewServer(http.Handler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
32-
handler.ServeHTTP(w, r)
33-
})))
34-
defer srv.Close()
35-
3633
cfg := fake.OIDCConfig(t, nil)
3734
cli := fake.HTTPClient(nil)
3835
ctx := oidc.ClientContext(context.Background(), cli)
@@ -71,3 +68,84 @@ func TestFakeIDPBasicFlow(t *testing.T) {
7168
require.NoError(t, err, "failed to refresh token")
7269
require.NotEmpty(t, refreshed.AccessToken, "access token is empty on refresh")
7370
}
71+
72+
// TestIDPIssuerMismatch emulates a situation where the IDP issuer url does
73+
// not match the one in the well-known config and claims.
74+
// This can happen in some edge cases and in some azure configurations.
75+
//
76+
// This test just makes sure a fake IDP can set up this scenario.
77+
func TestIDPIssuerMismatch(t *testing.T) {
78+
t.Parallel()
79+
80+
const proxyURL = "https://proxy.com"
81+
const primaryURL = "https://primary.com"
82+
83+
fake := oidctest.NewFakeIDP(t,
84+
oidctest.WithIssuer(proxyURL),
85+
oidctest.WithDefaultIDClaims(jwt.MapClaims{
86+
"iss": primaryURL,
87+
}),
88+
oidctest.WithHookWellKnown(func(r *http.Request, j *oidctest.ProviderJSON) error {
89+
// host should be proxy.com, but we return the primaryURL
90+
if r.Host != "proxy.com" {
91+
return xerrors.Errorf("unexpected host: %s", r.Host)
92+
}
93+
j.Issuer = primaryURL
94+
return nil
95+
}),
96+
oidctest.WithLogging(t, nil),
97+
)
98+
99+
ctx := testutil.Context(t, testutil.WaitMedium)
100+
// Do not use real network requests
101+
cli := fake.HTTPClient(nil)
102+
ctx = oidc.ClientContext(ctx, cli)
103+
104+
// Allow the issuer mismatch
105+
ctx = oidc.InsecureIssuerURLContext(ctx, "this field does not matter")
106+
p, err := oidc.NewProvider(ctx, "https://proxy.com")
107+
require.NoError(t, err, "failed to create OIDC provider")
108+
109+
oauthConfig := fake.OauthConfig(t, nil)
110+
cfg := &coderd.OIDCConfig{
111+
OAuth2Config: oauthConfig,
112+
Provider: p,
113+
Verifier: oidc.NewVerifier(fake.WellknownConfig().Issuer, &oidc.StaticKeySet{
114+
PublicKeys: []crypto.PublicKey{fake.PublicKey()},
115+
}, &oidc.Config{
116+
SkipIssuerCheck: true,
117+
ClientID: oauthConfig.ClientID,
118+
SupportedSigningAlgs: []string{
119+
"RS256",
120+
},
121+
}),
122+
UsernameField: "preferred_username",
123+
EmailField: "email",
124+
AuthURLParams: map[string]string{"access_type": "offline"},
125+
}
126+
127+
const expectedState = "random-state"
128+
var token *oauth2.Token
129+
130+
fake.SetCoderdCallbackHandler(func(w http.ResponseWriter, r *http.Request) {
131+
// Emulate OIDC flow
132+
code := r.URL.Query().Get("code")
133+
state := r.URL.Query().Get("state")
134+
assert.Equal(t, expectedState, state, "state mismatch")
135+
136+
oauthToken, err := cfg.Exchange(ctx, code)
137+
if assert.NoError(t, err, "failed to exchange code") {
138+
assert.NotEmpty(t, oauthToken.AccessToken, "access token is empty")
139+
assert.NotEmpty(t, oauthToken.RefreshToken, "refresh token is empty")
140+
}
141+
token = oauthToken
142+
})
143+
144+
//nolint:bodyclose
145+
resp := fake.OIDCCallback(t, expectedState, nil) // Use default claims
146+
require.Equal(t, http.StatusOK, resp.StatusCode)
147+
148+
idToken, err := cfg.Verifier.Verify(ctx, token.Extra("id_token").(string))
149+
require.NoError(t, err)
150+
require.Equal(t, primaryURL, idToken.Issuer)
151+
}

‎coderd/userauth_test.go

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1532,6 +1532,42 @@ func TestUserLogout(t *testing.T) {
15321532
}
15331533
}
15341534

1535+
// TestOIDCSkipIssuer verifies coderd can run without checking the issuer url
1536+
// in the OIDC exchange. This means the CODER_OIDC_ISSUER_URL does not need
1537+
// to match the id_token `iss` field, or the value returned in the well-known
1538+
// config.
1539+
func TestOIDCSkipIssuer(t *testing.T) {
1540+
t.Parallel()
1541+
const primaryURLString = "https://primary.com"
1542+
primaryURL := must(url.Parse(primaryURLString))
1543+
1544+
fake := oidctest.NewFakeIDP(t,
1545+
oidctest.WithServing(),
1546+
oidctest.WithDefaultIDClaims(jwt.MapClaims{}),
1547+
oidctest.WithHookWellKnown(func(r *http.Request, j *oidctest.ProviderJSON) error {
1548+
assert.NotEqual(t, r.URL.Host, primaryURL.Host, "request went to wrong host")
1549+
j.Issuer = primaryURLString
1550+
return nil
1551+
}),
1552+
)
1553+
1554+
owner := coderdtest.New(t, &coderdtest.Options{
1555+
OIDCConfig: fake.OIDCConfigSkipIssuerChecks(t, nil, func(cfg *coderd.OIDCConfig) {
1556+
cfg.AllowSignups = true
1557+
}),
1558+
})
1559+
1560+
// User can login and use their token.
1561+
ctx := testutil.Context(t, testutil.WaitShort)
1562+
userClient, _ := fake.Login(t, owner, jwt.MapClaims{
1563+
"iss": primaryURLString,
1564+
"email": "alice@coder.com",
1565+
})
1566+
found, err := userClient.User(ctx, "me")
1567+
require.NoError(t, err)
1568+
require.Equal(t, found.LoginType, codersdk.LoginTypeOIDC)
1569+
}
1570+
15351571
func oauth2Callback(t *testing.T, client *codersdk.Client) *http.Response {
15361572
client.HTTPClient.CheckRedirect = func(req *http.Request, via []*http.Request) error {
15371573
return http.ErrUseLastResponse

0 commit comments

Comments
 (0)