-
Notifications
You must be signed in to change notification settings - Fork 342
/
tokeninfo.go
394 lines (346 loc) · 10.3 KB
/
tokeninfo.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
package auth
import (
"fmt"
"strings"
"time"
"github.com/opentracing/opentracing-go"
"github.com/zalando/skipper/filters"
)
const (
// Deprecated, use filters.OAuthTokeninfoAnyScopeName instead
OAuthTokeninfoAnyScopeName = filters.OAuthTokeninfoAnyScopeName
// Deprecated, use filters.OAuthTokeninfoAllScopeName instead
OAuthTokeninfoAllScopeName = filters.OAuthTokeninfoAllScopeName
// Deprecated, use filters.OAuthTokeninfoAnyKVName instead
OAuthTokeninfoAnyKVName = filters.OAuthTokeninfoAnyKVName
// Deprecated, use filters.OAuthTokeninfoAllKVName instead
OAuthTokeninfoAllKVName = filters.OAuthTokeninfoAllKVName
tokeninfoCacheKey = "tokeninfo"
)
type TokeninfoOptions struct {
URL string
Timeout time.Duration
MaxIdleConns int
Tracer opentracing.Tracer
// CacheSize configures the maximum number of cached tokens.
// The cache evicts least recently used items first.
// Zero value disables tokeninfo cache.
CacheSize int
// CacheTTL limits the lifetime of a cached tokeninfo.
// Tokeninfo is cached for the duration of "expires_in" field value seconds or
// for the duration of CacheTTL if it is not zero and less than "expires_in" value.
CacheTTL time.Duration
}
type (
tokeninfoSpec struct {
typ roleCheckType
options TokeninfoOptions
}
tokeninfoFilter struct {
typ roleCheckType
client tokeninfoClient
scopes []string
kv kv
}
)
var tokeninfoAuthClient map[string]tokeninfoClient = make(map[string]tokeninfoClient)
// getTokeninfoClient creates new or returns a cached instance of tokeninfoClient
func (o *TokeninfoOptions) getTokeninfoClient() (tokeninfoClient, error) {
if c, ok := tokeninfoAuthClient[o.URL]; ok {
return c, nil
}
c, err := o.newTokeninfoClient()
if err == nil {
tokeninfoAuthClient[o.URL] = c
}
return c, err
}
// newTokeninfoClient creates new instance of tokeninfoClient
func (o *TokeninfoOptions) newTokeninfoClient() (tokeninfoClient, error) {
var c tokeninfoClient
c, err := newAuthClient(o.URL, tokenInfoSpanName, o.Timeout, o.MaxIdleConns, o.Tracer)
if err != nil {
return nil, err
}
if o.CacheSize > 0 {
c = newTokeninfoCache(c, o.CacheSize, o.CacheTTL)
}
return c, nil
}
func NewOAuthTokeninfoAllScopeWithOptions(to TokeninfoOptions) filters.Spec {
return &tokeninfoSpec{
typ: checkOAuthTokeninfoAllScopes,
options: to,
}
}
// NewOAuthTokeninfoAllScope 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 all scopes.
func NewOAuthTokeninfoAllScope(oauthTokeninfoURL string, oauthTokeninfoTimeout time.Duration) filters.Spec {
return NewOAuthTokeninfoAllScopeWithOptions(TokeninfoOptions{
URL: oauthTokeninfoURL,
Timeout: oauthTokeninfoTimeout,
})
}
func NewOAuthTokeninfoAnyScopeWithOptions(to TokeninfoOptions) filters.Spec {
return &tokeninfoSpec{
typ: checkOAuthTokeninfoAnyScopes,
options: to,
}
}
// NewOAuthTokeninfoAnyScope 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 scope.
func NewOAuthTokeninfoAnyScope(OAuthTokeninfoURL string, OAuthTokeninfoTimeout time.Duration) filters.Spec {
return &tokeninfoSpec{
typ: checkOAuthTokeninfoAnyScopes,
options: TokeninfoOptions{
URL: OAuthTokeninfoURL,
Timeout: OAuthTokeninfoTimeout,
},
}
}
func NewOAuthTokeninfoAllKVWithOptions(to TokeninfoOptions) filters.Spec {
return &tokeninfoSpec{
typ: checkOAuthTokeninfoAllKV,
options: to,
}
}
// NewOAuthTokeninfoAllKV 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 all key value pairs provided.
func NewOAuthTokeninfoAllKV(OAuthTokeninfoURL string, OAuthTokeninfoTimeout time.Duration) filters.Spec {
return &tokeninfoSpec{
typ: checkOAuthTokeninfoAllKV,
options: TokeninfoOptions{
URL: OAuthTokeninfoURL,
Timeout: OAuthTokeninfoTimeout,
},
}
}
func NewOAuthTokeninfoAnyKVWithOptions(to TokeninfoOptions) filters.Spec {
return &tokeninfoSpec{
typ: checkOAuthTokeninfoAnyKV,
options: to,
}
}
// NewOAuthTokeninfoAnyKV 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.
func NewOAuthTokeninfoAnyKV(OAuthTokeninfoURL string, OAuthTokeninfoTimeout time.Duration) filters.Spec {
return &tokeninfoSpec{
typ: checkOAuthTokeninfoAnyKV,
options: TokeninfoOptions{
URL: OAuthTokeninfoURL,
Timeout: OAuthTokeninfoTimeout,
},
}
}
// TokeninfoWithOptions creates a new auth filter specification
// for token validation with additional settings to the mandatory
// tokeninfo URL and timeout.
//
// Use one of the base initializer functions as the first argument:
// NewOAuthTokeninfoAllScope, NewOAuthTokeninfoAnyScope,
// NewOAuthTokeninfoAllKV or NewOAuthTokeninfoAnyKV.
func TokeninfoWithOptions(create func(string, time.Duration) filters.Spec, o TokeninfoOptions) filters.Spec {
s := create(o.URL, o.Timeout)
ts, ok := s.(*tokeninfoSpec)
if !ok {
return s
}
ts.options = o
return ts
}
func (s *tokeninfoSpec) Name() string {
switch s.typ {
case checkOAuthTokeninfoAnyScopes:
return filters.OAuthTokeninfoAnyScopeName
case checkOAuthTokeninfoAllScopes:
return filters.OAuthTokeninfoAllScopeName
case checkOAuthTokeninfoAnyKV:
return filters.OAuthTokeninfoAnyKVName
case checkOAuthTokeninfoAllKV:
return filters.OAuthTokeninfoAllKVName
}
return AuthUnknown
}
// CreateFilter creates an auth filter. All arguments have to be
// strings. Depending on the variant of the auth tokeninfoFilter, the arguments
// represent scopes or key-value pairs to be checked in the tokeninfo
// response. How scopes or key value pairs are checked is based on the
// type. The shown example for checkOAuthTokeninfoAllScopes will grant
// access only to tokens, that have scopes read-x and write-y:
//
// s.CreateFilter("read-x", "write-y")
func (s *tokeninfoSpec) CreateFilter(args []interface{}) (filters.Filter, error) {
sargs, err := getStrings(args)
if err != nil {
return nil, err
}
if len(sargs) == 0 {
return nil, filters.ErrInvalidFilterParameters
}
ac, err := s.options.getTokeninfoClient()
if err != nil {
return nil, filters.ErrInvalidFilterParameters
}
f := &tokeninfoFilter{typ: s.typ, client: ac, kv: make(map[string][]string)}
switch f.typ {
// all scopes
case checkOAuthTokeninfoAllScopes:
fallthrough
case checkOAuthTokeninfoAnyScopes:
f.scopes = sargs[:]
// key value pairs
case checkOAuthTokeninfoAnyKV:
fallthrough
case checkOAuthTokeninfoAllKV:
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 tokeninfoFilter configuration based on the
// configuration and check used.
func (f *tokeninfoFilter) String() string {
switch f.typ {
case checkOAuthTokeninfoAnyScopes:
return fmt.Sprintf("%s(%s)", filters.OAuthTokeninfoAnyScopeName, strings.Join(f.scopes, ","))
case checkOAuthTokeninfoAllScopes:
return fmt.Sprintf("%s(%s)", filters.OAuthTokeninfoAllScopeName, strings.Join(f.scopes, ","))
case checkOAuthTokeninfoAnyKV:
return fmt.Sprintf("%s(%s)", filters.OAuthTokeninfoAnyKVName, f.kv)
case checkOAuthTokeninfoAllKV:
return fmt.Sprintf("%s(%s)", filters.OAuthTokeninfoAllKVName, f.kv)
}
return AuthUnknown
}
func (f *tokeninfoFilter) validateAnyScopes(h map[string]interface{}) bool {
if len(f.scopes) == 0 {
return true
}
vI, ok := h[scopeKey]
if !ok {
return false
}
v, ok := vI.([]interface{})
if !ok {
return false
}
var a []string
for i := range v {
s, ok := v[i].(string)
if !ok {
return false
}
a = append(a, s)
}
return intersect(f.scopes, a)
}
func (f *tokeninfoFilter) validateAllScopes(h map[string]interface{}) bool {
if len(f.scopes) == 0 {
return true
}
vI, ok := h[scopeKey]
if !ok {
return false
}
v, ok := vI.([]interface{})
if !ok {
return false
}
var a []string
for i := range v {
s, ok := v[i].(string)
if !ok {
return false
}
a = append(a, s)
}
return all(f.scopes, a)
}
func (f *tokeninfoFilter) validateAnyKV(h map[string]interface{}) bool {
for k, v := range f.kv {
for _, res := range v {
if v2, ok := h[k].(string); ok {
if res == v2 {
return true
}
}
}
}
return false
}
func (f *tokeninfoFilter) validateAllKV(h map[string]interface{}) bool {
if len(h) < len(f.kv) {
return false
}
for k, v := range f.kv {
for _, res := range v {
v2, ok := h[k].(string)
if !ok || res != v2 {
return false
}
}
}
return true
}
// Request handles authentication based on the defined auth type.
func (f *tokeninfoFilter) Request(ctx filters.FilterContext) {
r := ctx.Request()
var authMap map[string]interface{}
authMapTemp, ok := ctx.StateBag()[tokeninfoCacheKey]
if !ok {
token, ok := getToken(r)
if !ok || token == "" {
unauthorized(ctx, "", missingBearerToken, "", "")
return
}
var err error
authMap, err = f.client.getTokeninfo(token, ctx)
if err != nil {
reason := authServiceAccess
if err == errInvalidToken {
reason = invalidToken
} else {
ctx.Logger().Errorf("Error while calling tokeninfo: %v", err)
}
unauthorized(ctx, "", reason, "", "")
return
}
} else {
authMap = authMapTemp.(map[string]interface{})
}
uid, _ := authMap[uidKey].(string) // uid can be empty string, but if not we set the who for auditlogging
var allowed bool
switch f.typ {
case checkOAuthTokeninfoAnyScopes:
allowed = f.validateAnyScopes(authMap)
case checkOAuthTokeninfoAllScopes:
allowed = f.validateAllScopes(authMap)
case checkOAuthTokeninfoAnyKV:
allowed = f.validateAnyKV(authMap)
case checkOAuthTokeninfoAllKV:
allowed = f.validateAllKV(authMap)
default:
ctx.Logger().Errorf("Wrong tokeninfoFilter type: %s.", f)
}
if !allowed {
forbidden(ctx, uid, invalidScope, "")
return
}
authorized(ctx, uid)
ctx.StateBag()[tokeninfoCacheKey] = authMap
}
func (f *tokeninfoFilter) Response(filters.FilterContext) {}