-
Notifications
You must be signed in to change notification settings - Fork 350
/
tokenintrospection.go
481 lines (424 loc) · 15.2 KB
/
tokenintrospection.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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
package auth
import (
"encoding/json"
"fmt"
"net/http"
"net/url"
"os"
"strings"
"time"
"github.com/opentracing/opentracing-go"
log "github.com/sirupsen/logrus"
"github.com/zalando/skipper/filters"
)
const (
OAuthTokenintrospectionAnyClaimsName = "oauthTokenintrospectionAnyClaims"
OAuthTokenintrospectionAllClaimsName = "oauthTokenintrospectionAllClaims"
OAuthTokenintrospectionAnyKVName = "oauthTokenintrospectionAnyKV"
OAuthTokenintrospectionAllKVName = "oauthTokenintrospectionAllKV"
SecureOAuthTokenintrospectionAnyClaimsName = "secureOauthTokenintrospectionAnyClaims"
SecureOAuthTokenintrospectionAllClaimsName = "secureOauthTokenintrospectionAllClaims"
SecureOAuthTokenintrospectionAnyKVName = "secureOauthTokenintrospectionAnyKV"
SecureOAuthTokenintrospectionAllKVName = "secureOauthTokenintrospectionAllKV"
tokenintrospectionCacheKey = "tokenintrospection"
TokenIntrospectionConfigPath = "/.well-known/openid-configuration"
)
type TokenintrospectionOptions struct {
Timeout time.Duration
Tracer opentracing.Tracer
MaxIdleConns int
}
type (
tokenIntrospectionSpec struct {
typ roleCheckType
options TokenintrospectionOptions
secure bool
}
tokenIntrospectionInfo map[string]interface{}
tokenintrospectFilter struct {
typ roleCheckType
authClient *authClient
claims []string
kv kv
}
openIDConfig struct {
Issuer string `json:"issuer"`
AuthorizationEndpoint string `json:"authorization_endpoint"`
TokenEndpoint string `json:"token_endpoint"`
UserinfoEndpoint string `json:"userinfo_endpoint"`
RevocationEndpoint string `json:"revocation_endpoint"`
JwksURI string `json:"jwks_uri"`
RegistrationEndpoint string `json:"registration_endpoint"`
IntrospectionEndpoint string `json:"introspection_endpoint"`
ResponseTypesSupported []string `json:"response_types_supported"`
SubjectTypesSupported []string `json:"subject_types_supported"`
IDTokenSigningAlgValuesSupported []string `json:"id_token_signing_alg_values_supported"`
TokenEndpointAuthMethodsSupported []string `json:"token_endpoint_auth_methods_supported"`
ClaimsSupported []string `json:"claims_supported"`
ScopesSupported []string `json:"scopes_supported"`
CodeChallengeMethodsSupported []string `json:"code_challenge_methods_supported"`
}
)
var issuerAuthClient map[string]*authClient = make(map[string]*authClient)
// Active returns token introspection response, which is true if token
// is not revoked and in the time frame of
// validity. https://tools.ietf.org/html/rfc7662#section-2.2
func (tii tokenIntrospectionInfo) Active() bool {
return tii.getBoolValue("active")
}
func (tii tokenIntrospectionInfo) Sub() (string, error) {
return tii.getStringValue("sub")
}
func (tii tokenIntrospectionInfo) getBoolValue(k string) bool {
if active, ok := tii[k].(bool); ok {
return active
}
return false
}
func (tii tokenIntrospectionInfo) getStringValue(k string) (string, error) {
s, ok := tii[k].(string)
if !ok {
return "", errInvalidTokenintrospectionData
}
return s, nil
}
// NewOAuthTokenintrospectionAnyKV creates a new auth filter specification
// to validate authorization for requests. Current implementation uses
// Bearer tokens to authorize requests and checks that the token
// contains at least one key value pair provided.
//
// This is implementing RFC 7662 compliant implementation. It uses
// POST requests to call introspection_endpoint to get the information
// of the token validity.
//
// It uses /.well-known/openid-configuration path to the passed
// oauthIssuerURL to find introspection_endpoint as defined in draft
// https://tools.ietf.org/html/draft-ietf-oauth-discovery-06, if
// oauthIntrospectionURL is a non empty string, it will set
// IntrospectionEndpoint to the given oauthIntrospectionURL.
func NewOAuthTokenintrospectionAnyKV(timeout time.Duration) filters.Spec {
return newOAuthTokenintrospectionFilter(checkOAuthTokenintrospectionAnyKV, timeout)
}
// NewOAuthTokenintrospectionAllKV creates a new auth filter specification
// to validate authorization for requests. Current implementation uses
// Bearer tokens to authorize requests and checks that the token
// contains at least one key value pair provided.
//
// This is implementing RFC 7662 compliant implementation. It uses
// POST requests to call introspection_endpoint to get the information
// of the token validity.
//
// It uses /.well-known/openid-configuration path to the passed
// oauthIssuerURL to find introspection_endpoint as defined in draft
// https://tools.ietf.org/html/draft-ietf-oauth-discovery-06, if
// oauthIntrospectionURL is a non empty string, it will set
// IntrospectionEndpoint to the given oauthIntrospectionURL.
func NewOAuthTokenintrospectionAllKV(timeout time.Duration) filters.Spec {
return newOAuthTokenintrospectionFilter(checkOAuthTokenintrospectionAllKV, timeout)
}
func NewOAuthTokenintrospectionAnyClaims(timeout time.Duration) filters.Spec {
return newOAuthTokenintrospectionFilter(checkOAuthTokenintrospectionAnyClaims, timeout)
}
func NewOAuthTokenintrospectionAllClaims(timeout time.Duration) filters.Spec {
return newOAuthTokenintrospectionFilter(checkOAuthTokenintrospectionAllClaims, timeout)
}
//Secure Introspection Point
func NewSecureOAuthTokenintrospectionAnyKV(timeout time.Duration) filters.Spec {
return newSecureOAuthTokenintrospectionFilter(checkSecureOAuthTokenintrospectionAnyKV, timeout)
}
func NewSecureOAuthTokenintrospectionAllKV(timeout time.Duration) filters.Spec {
return newSecureOAuthTokenintrospectionFilter(checkSecureOAuthTokenintrospectionAllKV, timeout)
}
func NewSecureOAuthTokenintrospectionAnyClaims(timeout time.Duration) filters.Spec {
return newSecureOAuthTokenintrospectionFilter(checkSecureOAuthTokenintrospectionAnyClaims, timeout)
}
func NewSecureOAuthTokenintrospectionAllClaims(timeout time.Duration) filters.Spec {
return newSecureOAuthTokenintrospectionFilter(checkSecureOAuthTokenintrospectionAllClaims, timeout)
}
// TokenintrospectionWithOptions create a new auth filter specification
// for validating authorization requests with additional options to the
// mandatory timeout parameter.
//
// Use one of the base initializer functions as the first argument:
// NewOAuthTokenintrospectionAnyKV, NewOAuthTokenintrospectionAllKV,
// NewOAuthTokenintrospectionAnyClaims, NewOAuthTokenintrospectionAllClaims,
// NewSecureOAuthTokenintrospectionAnyKV, NewSecureOAuthTokenintrospectionAllKV,
// NewSecureOAuthTokenintrospectionAnyClaims, NewSecureOAuthTokenintrospectionAllClaims,
// pass opentracing.Tracer and other options in TokenintrospectionOptions.
func TokenintrospectionWithOptions(
create func(time.Duration) filters.Spec,
o TokenintrospectionOptions,
) filters.Spec {
s := create(o.Timeout)
ts, ok := s.(*tokenIntrospectionSpec)
if !ok {
return s
}
ts.options = o
return ts
}
func newOAuthTokenintrospectionFilter(typ roleCheckType, timeout time.Duration) filters.Spec {
return &tokenIntrospectionSpec{
typ: typ,
options: TokenintrospectionOptions{
Timeout: timeout,
Tracer: opentracing.NoopTracer{},
},
secure: false,
}
}
func newSecureOAuthTokenintrospectionFilter(typ roleCheckType, timeout time.Duration) filters.Spec {
return &tokenIntrospectionSpec{
typ: typ,
options: TokenintrospectionOptions{
Timeout: timeout,
Tracer: opentracing.NoopTracer{},
},
secure: true,
}
}
func getOpenIDConfig(issuerURL string) (*openIDConfig, error) {
u, err := url.Parse(issuerURL + TokenIntrospectionConfigPath)
if err != nil {
return nil, err
}
rsp, err := http.Get(u.String())
if err != nil {
return nil, err
}
defer rsp.Body.Close()
if rsp.StatusCode != 200 {
return nil, errInvalidToken
}
d := json.NewDecoder(rsp.Body)
var cfg openIDConfig
err = d.Decode(&cfg)
return &cfg, err
}
func (s *tokenIntrospectionSpec) Name() string {
switch s.typ {
case checkOAuthTokenintrospectionAnyClaims:
return OAuthTokenintrospectionAnyClaimsName
case checkOAuthTokenintrospectionAllClaims:
return OAuthTokenintrospectionAllClaimsName
case checkOAuthTokenintrospectionAnyKV:
return OAuthTokenintrospectionAnyKVName
case checkOAuthTokenintrospectionAllKV:
return OAuthTokenintrospectionAllKVName
case checkSecureOAuthTokenintrospectionAnyClaims:
return SecureOAuthTokenintrospectionAnyClaimsName
case checkSecureOAuthTokenintrospectionAllClaims:
return SecureOAuthTokenintrospectionAllClaimsName
case checkSecureOAuthTokenintrospectionAnyKV:
return SecureOAuthTokenintrospectionAnyKVName
case checkSecureOAuthTokenintrospectionAllKV:
return SecureOAuthTokenintrospectionAllKVName
}
return AuthUnknown
}
func (s *tokenIntrospectionSpec) CreateFilter(args []interface{}) (filters.Filter, error) {
sargs, err := getStrings(args)
if err != nil {
return nil, err
}
if s.secure && len(sargs) < 4 || !s.secure && len(sargs) < 2 {
return nil, filters.ErrInvalidFilterParameters
}
issuerURL := sargs[0]
var clientId, clientSecret string
if s.secure {
clientId = sargs[1]
clientSecret = sargs[2]
sargs = sargs[3:]
if clientId == "" {
clientId, _ = os.LookupEnv("OAUTH_CLIENT_ID")
}
if clientSecret == "" {
clientSecret, _ = os.LookupEnv("OAUTH_CLIENT_SECRET")
}
} else {
sargs = sargs[1:]
}
cfg, err := getOpenIDConfig(issuerURL)
if err != nil {
return nil, err
}
var ac *authClient
var ok bool
if ac, ok = issuerAuthClient[issuerURL]; !ok {
ac, err = newAuthClient(cfg.IntrospectionEndpoint, tokenIntrospectionSpanName, s.options.Timeout, s.options.MaxIdleConns, s.options.Tracer)
if err != nil {
return nil, filters.ErrInvalidFilterParameters
}
issuerAuthClient[issuerURL] = ac
}
if s.secure && clientId != "" && clientSecret != "" {
ac.url.User = url.UserPassword(clientId, clientSecret)
} else {
ac.url.User = nil
}
f := &tokenintrospectFilter{
typ: s.typ,
authClient: ac,
kv: make(map[string][]string),
}
switch f.typ {
case checkOAuthTokenintrospectionAllClaims:
fallthrough
case checkSecureOAuthTokenintrospectionAllClaims:
fallthrough
case checkSecureOAuthTokenintrospectionAnyClaims:
fallthrough
case checkOAuthTokenintrospectionAnyClaims:
f.claims = sargs
if !all(f.claims, cfg.ClaimsSupported) {
return nil, fmt.Errorf("%v: %s, supported Claims: %v", errUnsupportedClaimSpecified, strings.Join(f.claims, ","), cfg.ClaimsSupported)
}
// key value pairs
case checkOAuthTokenintrospectionAllKV:
fallthrough
case checkSecureOAuthTokenintrospectionAllKV:
fallthrough
case checkSecureOAuthTokenintrospectionAnyKV:
fallthrough
case checkOAuthTokenintrospectionAnyKV:
for i := 0; i+1 < len(sargs); i += 2 {
f.kv[sargs[i]] = append(f.kv[sargs[i]], sargs[i+1])
}
if len(sargs) == 0 || len(sargs)%2 != 0 {
return nil, filters.ErrInvalidFilterParameters
}
default:
return nil, filters.ErrInvalidFilterParameters
}
return f, nil
}
// String prints nicely the tokenintrospectFilter configuration based on the
// configuration and check used.
func (f *tokenintrospectFilter) String() string {
switch f.typ {
case checkOAuthTokenintrospectionAnyClaims:
return fmt.Sprintf("%s(%s)", OAuthTokenintrospectionAnyClaimsName, strings.Join(f.claims, ","))
case checkOAuthTokenintrospectionAllClaims:
return fmt.Sprintf("%s(%s)", OAuthTokenintrospectionAllClaimsName, strings.Join(f.claims, ","))
case checkOAuthTokenintrospectionAnyKV:
return fmt.Sprintf("%s(%s)", OAuthTokenintrospectionAnyKVName, f.kv)
case checkOAuthTokenintrospectionAllKV:
return fmt.Sprintf("%s(%s)", OAuthTokenintrospectionAllKVName, f.kv)
case checkSecureOAuthTokenintrospectionAnyClaims:
return fmt.Sprintf("%s(%s)", SecureOAuthTokenintrospectionAnyClaimsName, strings.Join(f.claims, ","))
case checkSecureOAuthTokenintrospectionAllClaims:
return fmt.Sprintf("%s(%s)", SecureOAuthTokenintrospectionAllClaimsName, strings.Join(f.claims, ","))
case checkSecureOAuthTokenintrospectionAnyKV:
return fmt.Sprintf("%s(%s)", SecureOAuthTokenintrospectionAnyKVName, f.kv)
case checkSecureOAuthTokenintrospectionAllKV:
return fmt.Sprintf("%s(%s)", SecureOAuthTokenintrospectionAllKVName, f.kv)
}
return AuthUnknown
}
func (f *tokenintrospectFilter) validateAnyClaims(info tokenIntrospectionInfo) bool {
for _, wantedClaim := range f.claims {
if claims, ok := info["claims"].(map[string]interface{}); ok {
if _, ok2 := claims[wantedClaim]; ok2 {
return true
}
}
}
return false
}
func (f *tokenintrospectFilter) validateAllClaims(info tokenIntrospectionInfo) bool {
for _, v := range f.claims {
if claims, ok := info["claims"].(map[string]interface{}); !ok {
return false
} else {
if _, ok := claims[v]; !ok {
return false
}
}
}
return true
}
func (f *tokenintrospectFilter) validateAllKV(info tokenIntrospectionInfo) bool {
for k, v := range f.kv {
for _, res := range v {
v2, ok := info[k].(string)
if !ok || res != v2 {
return false
}
}
}
return true
}
func (f *tokenintrospectFilter) validateAnyKV(info tokenIntrospectionInfo) bool {
for k, v := range f.kv {
for _, res := range v {
v2, ok := info[k].(string)
if ok && res == v2 {
return true
}
}
}
return false
}
func (f *tokenintrospectFilter) Request(ctx filters.FilterContext) {
r := ctx.Request()
var info tokenIntrospectionInfo
infoTemp, ok := ctx.StateBag()[tokenintrospectionCacheKey]
if !ok {
token, ok := getToken(r)
if !ok || token == "" {
unauthorized(ctx, "", missingToken, f.authClient.url.Hostname(), "")
return
}
var err error
info, err = f.authClient.getTokenintrospect(token, ctx)
if err != nil {
reason := authServiceAccess
if err == errInvalidToken {
reason = invalidToken
} else {
log.Errorf("Error while calling token introspection: %v.", err)
}
unauthorized(ctx, "", reason, f.authClient.url.Hostname(), "")
return
}
} else {
info = infoTemp.(tokenIntrospectionInfo)
}
sub, err := info.Sub()
if err != nil {
if err != errInvalidTokenintrospectionData {
log.Errorf("Error while reading token: %v.", err)
}
unauthorized(ctx, sub, invalidSub, f.authClient.url.Hostname(), "")
return
}
if !info.Active() {
unauthorized(ctx, sub, inactiveToken, f.authClient.url.Hostname(), "")
return
}
var allowed bool
switch f.typ {
case checkOAuthTokenintrospectionAnyClaims, checkSecureOAuthTokenintrospectionAnyClaims:
allowed = f.validateAnyClaims(info)
case checkOAuthTokenintrospectionAnyKV, checkSecureOAuthTokenintrospectionAnyKV:
allowed = f.validateAnyKV(info)
case checkOAuthTokenintrospectionAllClaims, checkSecureOAuthTokenintrospectionAllClaims:
allowed = f.validateAllClaims(info)
case checkOAuthTokenintrospectionAllKV, checkSecureOAuthTokenintrospectionAllKV:
allowed = f.validateAllKV(info)
default:
log.Errorf("Wrong tokenintrospectionFilter type: %s.", f)
}
if !allowed {
unauthorized(ctx, sub, invalidClaim, f.authClient.url.Hostname(), "")
return
}
authorized(ctx, sub)
ctx.StateBag()[tokenintrospectionCacheKey] = info
}
func (f *tokenintrospectFilter) Response(filters.FilterContext) {}
// Close cleans-up the authClient
func (f *tokenintrospectFilter) Close() {
f.authClient.Close()
}