git.iko.soy/typeable/oauth2-proxy
on master help sign in
typeable/oauth2-proxy/providers/azure_test.go
432 lines 15 kB history raw
1package providers
3import (
4 "context"
5 "encoding/base64"
6 "encoding/json"
7 "errors"
8 "fmt"
9 "net/http"
10 "net/http/httptest"
11 "net/url"
12 "strings"
13 "testing"
14 "time"
16 "github.com/coreos/go-oidc/v3/oidc"
17 "github.com/golang-jwt/jwt/v5"
18 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/options"
19 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
20 internaloidc "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/providers/oidc"
22 . "github.com/onsi/gomega"
23 "github.com/stretchr/testify/assert"
26type fakeAzureKeySetStub struct{}
28func (fakeAzureKeySetStub) VerifySignature(_ context.Context, jwt string) (payload []byte, err error) {
29 decodeString, err := base64.RawURLEncoding.DecodeString(strings.Split(jwt, ".")[1])
30 if err != nil {
31 return nil, err
32 }
33 return decodeString, nil
36type azureOAuthPayload struct {
37 AccessToken string `json:"access_token,omitempty"`
38 RefreshToken string `json:"refresh_token,omitempty"`
39 ExpiresOn int64 `json:"expires_on,omitempty,string"`
40 IDToken string `json:"id_token,omitempty"`
43func testAzureProvider(hostname string, opts options.AzureOptions) *AzureProvider {
44 verificationOptions := internaloidc.IDTokenVerificationOptions{
45 AudienceClaims: []string{"aud"},
46 ClientID: "cd6d4fae-f6a6-4a34-8454-2c6b598e9532",
47 }
48 p := NewAzureProvider(
49 &ProviderData{
50 ProviderName: "",
51 LoginURL: &url.URL{},
52 RedeemURL: &url.URL{},
53 ProfileURL: &url.URL{},
54 ValidateURL: &url.URL{},
55 ProtectedResource: &url.URL{},
56 Scope: "",
57 EmailClaim: "email",
58 GroupsClaim: "groups",
59 Verifier: internaloidc.NewVerifier(oidc.NewVerifier(
60 "https://issuer.example.com",
61 fakeAzureKeySetStub{},
62 &oidc.Config{
63 ClientID: "cd6d4fae-f6a6-4a34-8454-2c6b598e9532",
64 SkipClientIDCheck: true,
65 SkipIssuerCheck: true,
66 SkipExpiryCheck: true,
67 },
68 ), verificationOptions),
69 }, opts)
71 if hostname != "" {
72 updateURL(p.Data().LoginURL, hostname)
73 updateURL(p.Data().RedeemURL, hostname)
74 updateURL(p.Data().ProfileURL, hostname)
75 updateURL(p.Data().ValidateURL, hostname)
76 updateURL(p.Data().ProtectedResource, hostname)
77 }
78 return p
81func TestNewAzureProvider(t *testing.T) {
82 g := NewWithT(t)
84 // Test that defaults are set when calling for a new provider with nothing set
85 providerData := NewAzureProvider(&ProviderData{}, options.AzureOptions{}).Data()
86 g.Expect(providerData.ProviderName).To(Equal("Azure"))
87 g.Expect(providerData.LoginURL.String()).To(Equal("https://login.microsoftonline.com/common/oauth2/authorize"))
88 g.Expect(providerData.RedeemURL.String()).To(Equal("https://login.microsoftonline.com/common/oauth2/token"))
89 g.Expect(providerData.ProfileURL.String()).To(Equal("https://graph.microsoft.com/v1.0/me"))
90 g.Expect(providerData.ValidateURL.String()).To(Equal("https://graph.microsoft.com/v1.0/me"))
91 g.Expect(providerData.Scope).To(Equal("openid"))
94func TestAzureProviderOverrides(t *testing.T) {
95 p := NewAzureProvider(
96 &ProviderData{
97 LoginURL: &url.URL{
98 Scheme: "https",
99 Host: "example.com",
100 Path: "/oauth/auth"},
101 RedeemURL: &url.URL{
102 Scheme: "https",
103 Host: "example.com",
104 Path: "/oauth/token"},
105 ProfileURL: &url.URL{
106 Scheme: "https",
107 Host: "example.com",
108 Path: "/oauth/profile"},
109 ValidateURL: &url.URL{
110 Scheme: "https",
111 Host: "example.com",
112 Path: "/oauth/tokeninfo"},
113 ProtectedResource: &url.URL{
114 Scheme: "https",
115 Host: "example.com"},
116 Scope: "profile"},
117 options.AzureOptions{})
118 assert.NotEqual(t, nil, p)
119 assert.Equal(t, "Azure", p.Data().ProviderName)
120 assert.Equal(t, "https://example.com/oauth/auth",
121 p.Data().LoginURL.String())
122 assert.Equal(t, "https://example.com/oauth/token",
123 p.Data().RedeemURL.String())
124 assert.Equal(t, "https://example.com/oauth/profile",
125 p.Data().ProfileURL.String())
126 assert.Equal(t, "https://example.com/oauth/tokeninfo",
127 p.Data().ValidateURL.String())
128 assert.Equal(t, "https://example.com",
129 p.Data().ProtectedResource.String())
130 assert.Equal(t, "profile", p.Data().Scope)
133func TestAzureSetTenant(t *testing.T) {
134 p := testAzureProvider("", options.AzureOptions{Tenant: "example"})
135 assert.Equal(t, "Azure", p.Data().ProviderName)
136 assert.Equal(t, "example", p.Tenant)
137 assert.Equal(t, "https://login.microsoftonline.com/example/oauth2/authorize", p.Data().LoginURL.String())
138 assert.Equal(t, "https://login.microsoftonline.com/example/oauth2/token", p.Data().RedeemURL.String())
139 assert.Equal(t, "https://graph.microsoft.com/v1.0/me", p.Data().ProfileURL.String())
140 assert.Equal(t, "https://graph.microsoft.com/v1.0/me", p.Data().ValidateURL.String())
141 assert.Equal(t, "openid", p.Data().Scope)
144func testAzureBackend(payload string, accessToken, refreshToken string) *httptest.Server {
145 return testAzureBackendWithError(payload, accessToken, refreshToken, false)
148func testAzureBackendWithError(payload string, accessToken, refreshToken string, injectError bool) *httptest.Server {
149 path := "/v1.0/me"
150 pathGroups := path + "/transitiveMemberOf/microsoft.graph.group"
152 return httptest.NewServer(http.HandlerFunc(
153 func(w http.ResponseWriter, r *http.Request) {
154 if r.URL.Path == pathGroups && r.Method == http.MethodGet {
155 w.Write([]byte(`{
156 "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(displayName,id)",
157 "value": [
158 {
159 "displayName": "aa",
160 "id": "11111111-2222-3333-4444-555555555555"
161 },
162 {
163 "displayName": "bb",
164 "id": "555555555555-4444-3333-2222-11111111"
165 }
166 ]
167 }`))
168 } else if (r.URL.Path != path) && r.Method != http.MethodPost {
169 w.WriteHeader(404)
170 } else if r.Method == http.MethodPost && r.Body != nil {
171 if injectError {
172 w.WriteHeader(400)
173 } else {
174 w.WriteHeader(200)
175 }
176 w.Write([]byte(payload))
177 } else if !IsAuthorizedInHeaderWithToken(r.Header, accessToken) &&
178 !isAuthorizedRefreshInURLWithToken(r.URL, refreshToken) {
179 w.WriteHeader(403)
180 } else {
181 w.WriteHeader(200)
182 w.Write([]byte(payload))
183 }
184 }))
187func TestAzureProviderEnrichSession(t *testing.T) {
188 testCases := []struct {
189 Description string
190 Email string
191 PayloadFromAzureBackend string
192 ExpectedEmail string
193 ExpectedError error
194 }{
195 {
196 Description: "should return email using mail property from Azure backend",
197 PayloadFromAzureBackend: `{ "mail": "user@windows.net", "groups": ["aa", "bb"] }`,
198 ExpectedEmail: "user@windows.net",
199 },
200 {
201 Description: "should return email using otherMails property returned from Azure backend",
202 PayloadFromAzureBackend: `{ "mail": null, "otherMails": ["user@windows.net", "altuser@windows.net"] }`,
203 ExpectedEmail: "user@windows.net",
204 },
205 {
206 Description: "should return email using userPrincipalName from Azure backend",
207 PayloadFromAzureBackend: `{ "mail": null, "otherMails": [], "userPrincipalName": "user@windows.net" }`,
208 ExpectedEmail: "user@windows.net",
209 },
210 {
211 Description: "should return error when Azure backend doesn't return email information",
212 PayloadFromAzureBackend: `{ "mail": null, "otherMails": [], "userPrincipalName": null }`,
213 ExpectedError: fmt.Errorf("unable to get email address from profile URL: %v", errors.New("empty email address: type assertion to string failed")),
214 },
215 {
216 Description: "should return specific error when unable to get email",
217 PayloadFromAzureBackend: `{ "mail": null, "otherMails": [], "userPrincipalName": "" }`,
218 ExpectedError: errors.New("unable to get email address from profile URL: empty email address: <nil>"),
219 },
220 {
221 Description: "should return error when otherMails from Azure backend is not a valid type",
222 PayloadFromAzureBackend: `{ "mail": null, "otherMails": "", "userPrincipalName": null }`,
223 ExpectedError: fmt.Errorf("unable to get email address from profile URL: %v", errors.New("empty email address: type assertion to string failed")),
224 },
225 {
226 Description: "should not query profile api when email is already set in session",
227 Email: "user@windows.net",
228 ExpectedEmail: "user@windows.net",
229 },
230 }
232 for _, testCase := range testCases {
233 t.Run(testCase.Description, func(t *testing.T) {
234 var (
235 b *httptest.Server
236 host string
237 )
239 b = testAzureBackend(testCase.PayloadFromAzureBackend, authorizedAccessToken, "")
240 defer b.Close()
242 bURL, _ := url.Parse(b.URL)
243 host = bURL.Host
245 p := testAzureProvider(host, options.AzureOptions{})
246 session := CreateAuthorizedSession()
247 session.Email = testCase.Email
248 err := p.EnrichSession(context.Background(), session)
249 assert.Equal(t, testCase.ExpectedError, err)
250 assert.Equal(t, testCase.ExpectedEmail, session.Email)
251 })
252 }
255func TestAzureProviderRedeem(t *testing.T) {
256 testCases := []struct {
257 Name string
258 RefreshToken string
259 ExpiresOn time.Time
260 EmailFromIDToken string
261 EmailFromAccessToken string
262 IsIDTokenMalformed bool
263 InjectRedeemURLError bool
264 Groups []string
265 }{
266 {
267 Name: "with id_token returned",
268 EmailFromIDToken: "foo1@example.com",
269 RefreshToken: "some_refresh_token",
270 ExpiresOn: time.Now().Add(time.Hour),
271 Groups: []string{"aa", "bb"},
272 },
273 {
274 Name: "without id_token returned, fallback to access token",
275 EmailFromAccessToken: "foo2@example.com",
276 RefreshToken: "some_refresh_token",
277 ExpiresOn: time.Now().Add(time.Hour),
278 Groups: []string{"aa", "bb"},
279 },
280 {
281 Name: "id_token malformed, fallback to access token",
282 EmailFromAccessToken: "foo3@example.com",
283 RefreshToken: "some_refresh_token",
284 ExpiresOn: time.Now().Add(time.Hour),
285 IsIDTokenMalformed: true,
286 Groups: []string{"aa", "bb"},
287 },
288 {
289 Name: "both id_token and access tokens are valid, return email from id_token",
290 EmailFromIDToken: "foo1@example.com",
291 EmailFromAccessToken: "foo3@example.com",
292 RefreshToken: "some_refresh_token",
293 ExpiresOn: time.Now().Add(time.Hour),
294 Groups: []string{"aa", "bb"},
295 },
296 {
297 Name: "redeem URL failed, should return error",
298 EmailFromIDToken: "foo1@example.com",
299 EmailFromAccessToken: "foo3@example.com",
300 RefreshToken: "some_refresh_token",
301 ExpiresOn: time.Now().Add(time.Hour),
302 InjectRedeemURLError: true,
303 Groups: []string{"aa", "bb"},
304 },
305 }
307 for _, testCase := range testCases {
308 t.Run(testCase.Name, func(t *testing.T) {
309 idTokenString := ""
310 accessTokenString := ""
311 if testCase.EmailFromIDToken != "" {
312 var err error
313 token := idTokenClaims{
314 RegisteredClaims: jwt.RegisteredClaims{Audience: jwt.ClaimStrings{"cd6d4fae-f6a6-4a34-8454-2c6b598e9532"}},
315 Email: testCase.EmailFromIDToken,
316 Groups: []string{"aa", "bb"},
317 }
318 idTokenString, err = newSignedTestIDToken(token)
319 assert.NoError(t, err)
320 }
321 if testCase.EmailFromAccessToken != "" {
322 var err error
323 token := idTokenClaims{
324 RegisteredClaims: jwt.RegisteredClaims{Audience: jwt.ClaimStrings{"cd6d4fae-f6a6-4a34-8454-2c6b598e9532"}},
325 Email: testCase.EmailFromAccessToken,
326 Groups: []string{"aa", "bb"},
327 }
328 accessTokenString, err = newSignedTestIDToken(token)
329 assert.NoError(t, err)
330 }
331 if testCase.IsIDTokenMalformed {
332 idTokenString = "this is a malformed id_token"
333 }
334 payload := azureOAuthPayload{
335 IDToken: idTokenString,
336 RefreshToken: testCase.RefreshToken,
337 AccessToken: accessTokenString,
338 ExpiresOn: testCase.ExpiresOn.Unix(),
339 }
341 payloadBytes, err := json.Marshal(payload)
342 assert.NoError(t, err)
344 b := testAzureBackendWithError(string(payloadBytes), accessTokenString, testCase.RefreshToken, testCase.InjectRedeemURLError)
345 defer b.Close()
347 bURL, _ := url.Parse(b.URL)
348 p := testAzureProvider(bURL.Host, options.AzureOptions{})
349 p.Data().RedeemURL.Path = "/common/oauth2/token"
350 s, err := p.Redeem(context.Background(), "https://localhost", "1234", "123")
351 if testCase.InjectRedeemURLError {
352 assert.NotNil(t, err)
353 } else {
354 assert.NoError(t, err)
355 assert.Equal(t, idTokenString, s.IDToken)
356 assert.Equal(t, accessTokenString, s.AccessToken)
357 assert.Equal(t, testCase.ExpiresOn.Unix(), s.ExpiresOn.Unix())
358 assert.Equal(t, testCase.RefreshToken, s.RefreshToken)
359 assert.Equal(t, testCase.Groups, s.Groups)
360 if testCase.EmailFromIDToken != "" {
361 assert.Equal(t, testCase.EmailFromIDToken, s.Email)
362 } else {
363 assert.Equal(t, testCase.EmailFromAccessToken, s.Email)
364 }
365 }
366 })
367 }
370func TestAzureProviderProtectedResourceConfiguredOAuthV1(t *testing.T) {
371 p := testAzureProvider("", options.AzureOptions{})
372 p.ProtectedResource, _ = url.Parse("http://my.resource.test")
373 result := p.GetLoginURL("https://my.test.app/oauth", "", "", url.Values{})
374 assert.Contains(t, result, "resource="+url.QueryEscape("http://my.resource.test"))
377func TestAzureProviderProtectedResourceConfiguredOAuthV2(t *testing.T) {
378 p := testAzureProvider("", options.AzureOptions{})
379 testURL := "http://my.resource.test"
380 p.ProtectedResource, _ = url.Parse(testURL)
381 p.isV2Endpoint = true
382 result, _ := url.Parse(p.GetLoginURL("https://my.test.app/oauth", "", "", url.Values{}))
383 parsedQuery, _ := url.ParseQuery(result.RawQuery)
384 assert.NotContains(t, parsedQuery["scope"], " "+testURL)
385 assert.NotContains(t, result.RawQuery, "resource="+url.QueryEscape(testURL))
388func TestAzureProviderRefresh(t *testing.T) {
389 email := "foo@example.com"
390 subject := "foo"
391 idToken := idTokenClaims{
392 Email: email,
393 RegisteredClaims: jwt.RegisteredClaims{
394 Audience: jwt.ClaimStrings{"cd6d4fae-f6a6-4a34-8454-2c6b598e9532"},
395 Subject: subject,
396 },
397 }
398 idTokenString, err := newSignedTestIDToken(idToken)
399 assert.NoError(t, err)
401 timestamp, err := time.Parse(time.RFC3339, "3006-01-02T22:04:05Z")
402 assert.NoError(t, err)
404 newAccessToken := "new_some_access_token"
405 payload := azureOAuthPayload{
406 IDToken: idTokenString,
407 RefreshToken: "new_some_refresh_token",
408 AccessToken: newAccessToken,
409 ExpiresOn: timestamp.Unix(),
410 }
411 payloadBytes, err := json.Marshal(payload)
412 assert.NoError(t, err)
414 refreshToken := "some_refresh_token"
415 b := testAzureBackend(string(payloadBytes), newAccessToken, refreshToken)
416 defer b.Close()
417 bURL, _ := url.Parse(b.URL)
418 p := testAzureProvider(bURL.Host, options.AzureOptions{})
420 expires := time.Now().Add(time.Duration(-1) * time.Hour)
421 session := &sessions.SessionState{AccessToken: "some_access_token", RefreshToken: refreshToken, IDToken: "some_id_token", ExpiresOn: &expires}
423 refreshed, err := p.RefreshSession(context.Background(), session)
424 assert.Equal(t, nil, err)
425 assert.True(t, refreshed)
426 assert.NotEqual(t, session, nil)
427 assert.Equal(t, newAccessToken, session.AccessToken)
428 assert.Equal(t, "new_some_refresh_token", session.RefreshToken)
429 assert.Equal(t, idTokenString, session.IDToken)
430 assert.Equal(t, email, session.Email)
431 assert.Equal(t, timestamp, session.ExpiresOn.UTC())