forked from TykTechnologies/tyk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmw_external_oauth_test.go
418 lines (347 loc) · 12.3 KB
/
mw_external_oauth_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
package gateway
import (
"encoding/base64"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/golang-jwt/jwt/v4"
"github.com/stretchr/testify/assert"
"github.com/TykTechnologies/tyk/apidef"
"github.com/TykTechnologies/tyk/test"
)
func TestExternalOAuth_JWT(t *testing.T) {
ts := StartTest(nil)
defer ts.Close()
t.Run("JWT HMAC", func(t *testing.T) {
spec := BuildAPI(func(spec *APISpec) {
spec.UseKeylessAccess = false
spec.ExternalOAuth = apidef.ExternalOAuth{
Enabled: true,
Providers: []apidef.Provider{
{
JWT: apidef.JWTValidation{
Enabled: true,
SigningMethod: HMACSign,
Source: base64.StdEncoding.EncodeToString([]byte(jwtSecret)),
},
},
},
}
spec.Proxy.ListenPath = "/"
})[0]
_ = ts.Gw.LoadAPI(spec)
t.Run("base64 encoded static secret - success", func(t *testing.T) {
jwtToken := createJWKTokenHMAC(func(t *jwt.Token) {
t.Claims.(jwt.MapClaims)["sub"] = "bar"
t.Claims.(jwt.MapClaims)["exp"] = time.Now().Add(time.Hour * 72).Unix()
})
authHeaders := map[string]string{"authorization": jwtToken}
_, _ = ts.Run(t, test.TestCase{
Headers: authHeaders, Code: http.StatusOK,
})
})
t.Run("base64 encoded static secret - failure", func(t *testing.T) {
jwtToken := createJWKTokenHMAC(func(t *jwt.Token) {
t.Claims.(jwt.MapClaims)["sub"] = "bar"
t.Claims.(jwt.MapClaims)["exp"] = time.Now().Add(time.Hour * 72).Unix()
})
t.Run("invalid signature", func(t *testing.T) {
token := jwtToken + "blah"
authHeaders := map[string]string{"authorization": token}
_, _ = ts.Run(t, test.TestCase{
Headers: authHeaders, Code: http.StatusUnauthorized,
})
})
t.Run("invalid token", func(t *testing.T) {
token := "blah"
authHeaders := map[string]string{"authorization": token}
_, _ = ts.Run(t, test.TestCase{
Headers: authHeaders, Code: http.StatusUnauthorized,
})
})
t.Run("configured HMAC, signed RSA", func(t *testing.T) {
token := CreateJWKToken(func(t *jwt.Token) {
t.Claims.(jwt.MapClaims)["foo"] = "bar"
t.Claims.(jwt.MapClaims)["user_id"] = "user"
})
authHeaders := map[string]string{"authorization": token}
_, _ = ts.Run(t, test.TestCase{
Headers: authHeaders, Code: http.StatusInternalServerError,
})
})
})
})
t.Run("JWT RSA with JWK", func(t *testing.T) {
ts := StartTest(nil)
defer ts.Close()
spec := BuildAPI(func(spec *APISpec) {
spec.UseKeylessAccess = false
spec.ExternalOAuth = apidef.ExternalOAuth{
Enabled: true,
Providers: []apidef.Provider{
{
JWT: apidef.JWTValidation{
Enabled: true,
SigningMethod: RSASign,
Source: base64.StdEncoding.EncodeToString([]byte(jwtRSAPubKey)),
IdentityBaseField: "user_id",
},
},
},
}
spec.Proxy.ListenPath = "/"
})[0]
t.Run("with skew", func(t *testing.T) {
t.Run("expires at", func(t *testing.T) {
jwtAuthHeaderGen := func(skew time.Duration) map[string]string {
jwtToken := CreateJWKToken(func(t *jwt.Token) {
t.Claims.(jwt.MapClaims)["user_id"] = "user123"
t.Claims.(jwt.MapClaims)["exp"] = time.Now().Add(skew).Unix()
})
return map[string]string{"authorization": jwtToken}
}
t.Run("after now - add skew", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.ExpiresAtValidationSkew = 1
_ = ts.Gw.LoadAPI(spec)
_, _ = ts.Run(t, test.TestCase{
Headers: jwtAuthHeaderGen(+time.Second), Code: http.StatusOK,
})
})
t.Run("before now - invalid jwt", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.ExpiresAtValidationSkew = 0
_ = ts.Gw.LoadAPI(spec)
_, _ = ts.Run(t, test.TestCase{
Headers: jwtAuthHeaderGen(-time.Second),
Code: http.StatusUnauthorized,
BodyMatch: "key not authorized: token has expired",
})
})
})
t.Run("issued at", func(t *testing.T) {
jwtAuthHeaderGen := func(skew time.Duration) map[string]string {
jwtToken := CreateJWKToken(func(t *jwt.Token) {
t.Claims.(jwt.MapClaims)["user_id"] = "user123"
t.Claims.(jwt.MapClaims)["iat"] = time.Now().Add(skew).Unix()
})
return map[string]string{"authorization": jwtToken}
}
t.Run("after now, no skew - invalid jwt", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.IssuedAtValidationSkew = 1
_ = ts.Gw.LoadAPI(spec)
_, _ = ts.Run(t, test.TestCase{
Headers: jwtAuthHeaderGen(+time.Minute),
Code: http.StatusUnauthorized,
BodyMatch: "key not authorized: token used before issued",
})
})
t.Run("before now, add skew - valid jwt", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.IssuedAtValidationSkew = 2
_ = ts.Gw.LoadAPI(spec)
_, _ = ts.Run(t, test.TestCase{
Headers: jwtAuthHeaderGen(-3 * time.Second), Code: http.StatusOK,
})
})
})
t.Run("not before", func(t *testing.T) {
jwtAuthHeaderGen := func(skew time.Duration) map[string]string {
jwtToken := CreateJWKToken(func(t *jwt.Token) {
t.Claims.(jwt.MapClaims)["user_id"] = "user123"
t.Claims.(jwt.MapClaims)["nbf"] = time.Now().Add(skew).Unix()
})
return map[string]string{"authorization": jwtToken}
}
t.Run("after now - invalid jwt", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.NotBeforeValidationSkew = 1
_ = ts.Gw.LoadAPI(spec)
_, _ = ts.Run(t, test.TestCase{
Headers: jwtAuthHeaderGen(+time.Minute),
Code: http.StatusUnauthorized,
BodyMatch: "key not authorized: token is not valid yet",
})
})
t.Run("after now, add skew - valid jwt", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.NotBeforeValidationSkew = 1
_ = ts.Gw.LoadAPI(spec)
_, _ = ts.Run(t, test.TestCase{
Headers: jwtAuthHeaderGen(+time.Second), Code: http.StatusOK,
})
})
})
})
jwtToken := CreateJWKToken(func(t *jwt.Token) {
t.Header["kid"] = "12345"
t.Claims.(jwt.MapClaims)["foo"] = "bar"
t.Claims.(jwt.MapClaims)["user_id"] = "user"
t.Claims.(jwt.MapClaims)["exp"] = time.Now().Add(time.Hour * 72).Unix()
})
authHeaders := map[string]string{"authorization": jwtToken}
flush := func() {
if externalOAuthJWKCache != nil {
externalOAuthJWKCache.Flush()
}
}
t.Run("Direct JWK URL", func(t *testing.T) {
t.Run("valid jwk url", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.Source = testHttpJWK
_ = ts.Gw.LoadAPI(spec)
t.Run("empty cache", func(t *testing.T) {
flush()
_, _ = ts.Run(t, test.TestCase{
Headers: authHeaders, Code: http.StatusOK,
})
})
t.Run("with cache", func(t *testing.T) {
_, _ = ts.Run(t, test.TestCase{
Headers: authHeaders, Code: http.StatusOK,
})
})
})
})
})
}
func TestGetSecretFromJWKOrConfig(t *testing.T) {
ts := StartTest(nil)
defer ts.Close()
spec := BuildAPI(func(spec *APISpec) {
spec.UseKeylessAccess = false
spec.ExternalOAuth = apidef.ExternalOAuth{
Enabled: true,
Providers: []apidef.Provider{
{
JWT: apidef.JWTValidation{
Enabled: true,
IdentityBaseField: "user_id",
},
},
},
}
spec.Proxy.ListenPath = "/"
})[0]
k := ExternalOAuthMiddleware{
BaseMiddleware{
Gw: ts.Gw,
Spec: spec,
},
}
t.Run("kid is not a string", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.SigningMethod = RSASign
spec.ExternalOAuth.Providers[0].JWT.Source = testHttpJWK
_, err := k.getSecretFromJWKOrConfig(23, spec.ExternalOAuth.Providers[0].JWT)
assert.ErrorIs(t, err, ErrKIDNotAString)
})
t.Run("from config", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.SigningMethod = HMACSign
spec.ExternalOAuth.Providers[0].JWT.Source = base64.StdEncoding.EncodeToString([]byte(jwtSecret))
secret, err := k.getSecretFromJWKOrConfig(nil, spec.ExternalOAuth.Providers[0].JWT)
assert.NoError(t, err)
assert.Equal(t, jwtSecret, string(secret.([]byte)))
})
t.Run("invalid base64 encoded secret", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.SigningMethod = HMACSign
spec.ExternalOAuth.Providers[0].JWT.Source = "invalid-secret"
_, err := k.getSecretFromJWKOrConfig(nil, spec.ExternalOAuth.Providers[0].JWT)
assert.Error(t, err)
})
t.Run("direct jwk url", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.Source = testHttpJWK
spec.ExternalOAuth.Providers[0].JWT.SigningMethod = RSASign
_, err := k.getSecretFromJWKOrConfig("12345", spec.ExternalOAuth.Providers[0].JWT)
assert.NoError(t, err)
})
t.Run("base64 encoded jwk url", func(t *testing.T) {
spec.ExternalOAuth.Providers[0].JWT.SigningMethod = HMACSign
spec.ExternalOAuth.Providers[0].JWT.Source = base64.StdEncoding.EncodeToString([]byte(testHttpJWK))
_, err := k.getSecretFromJWKOrConfig("12345", spec.ExternalOAuth.Providers[0].JWT)
assert.NoError(t, err)
})
}
func TestExternalOAuthMiddleware_introspection(t *testing.T) {
ts := StartTest(nil)
defer ts.Close()
const (
testClientID = "test-client-id"
testClientSecret = "test-client-secret"
testAccessToken = "test-access-token"
user = "[email protected]"
)
accessTokenActive := true
exp := time.Now().Add(3 * time.Minute).Unix()
introspectionServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
assert.Equal(t, testAccessToken, r.FormValue("token"))
assert.Equal(t, testClientID, r.FormValue("client_id"))
assert.Equal(t, testClientSecret, r.FormValue("client_secret"))
_, _ = w.Write([]byte(fmt.Sprintf(`{"active": %t,"username": "%s", "exp":%d}`, accessTokenActive, user, exp)))
}))
api := ts.Gw.BuildAndLoadAPI(func(spec *APISpec) {
spec.Proxy.ListenPath = "/"
spec.UseKeylessAccess = false
spec.ExternalOAuth.Enabled = true
spec.ExternalOAuth.Providers = []apidef.Provider{
{
Introspection: apidef.Introspection{
Enabled: true,
URL: introspectionServer.URL,
ClientID: testClientID,
ClientSecret: testClientSecret,
IdentityBaseField: "username",
},
},
}
})[0]
headers := map[string]string{
"Authorization": testAccessToken,
}
_, _ = ts.Run(t, []test.TestCase{
{Path: "/get", BodyMatch: "authorization field missing", Code: http.StatusBadRequest},
{Path: "/get", Headers: headers, BodyMatch: "/get", Code: http.StatusOK},
}...)
// deactivated access token should not be validated
accessTokenActive = false
_, _ = ts.Run(t, []test.TestCase{
{Path: "/get", Headers: headers, BodyMatch: "access token is not valid", Code: http.StatusUnauthorized},
}...)
t.Run("cache", func(t *testing.T) {
api.ExternalOAuth.Providers[0].Introspection.Cache.Enabled = true
api.ExternalOAuth.Providers[0].Introspection.Cache.Timeout = 0
ts.Gw.LoadAPI(api)
accessTokenActive = true
_, _ = ts.Run(t, []test.TestCase{
{Path: "/get", Headers: headers, BodyMatch: "/get", Code: http.StatusOK},
}...)
accessTokenActive = false
_, _ = ts.Run(t, []test.TestCase{
{Path: "/get", Headers: headers, BodyMatch: "/get", Code: http.StatusOK},
}...)
// invalidate cache
externalOAuthIntrospectionCache.DeleteAllKeys()
_, _ = ts.Run(t, []test.TestCase{
{Path: "/get", Headers: headers, BodyMatch: "access token is not valid", Code: http.StatusUnauthorized},
}...)
t.Run("expired", func(t *testing.T) {
externalOAuthIntrospectionCache.DeleteAllKeys()
// normally for expired token, the introspection returns active false
// this is to get rid of putting delay to wait until expiration
accessTokenActive = true
exp = time.Now().Add(-3 * time.Minute).Unix()
_, _ = ts.Run(t, []test.TestCase{
{Path: "/get", Headers: headers, BodyMatch: "/get", Code: http.StatusOK},
{Path: "/get", Headers: headers, BodyMatch: jwt.ErrTokenExpired.Error(), Code: http.StatusUnauthorized},
}...)
})
})
}
func Test_isExpired(t *testing.T) {
assert.False(t, isExpired(jwt.MapClaims{}))
assert.False(t, isExpired(jwt.MapClaims{"exp": "not integer"}))
claimsBuilder := func(d time.Duration) jwt.MapClaims {
claimsStr := fmt.Sprintf(`{"exp":%d}`, time.Now().Add(d).Unix())
var claims jwt.MapClaims
_ = json.Unmarshal([]byte(claimsStr), &claims)
return claims
}
assert.False(t, isExpired(claimsBuilder(10*time.Minute)))
assert.True(t, isExpired(claimsBuilder(-10*time.Minute)))
}