/
tokeninfo.go
291 lines (259 loc) · 7.94 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
package auth
import (
"fmt"
"strings"
"time"
log "github.com/sirupsen/logrus"
"github.com/zalando/skipper/filters"
)
const (
OAuthTokeninfoAnyScopeName = "oauthTokeninfoAnyScope"
OAuthTokeninfoAllScopeName = "oauthTokeninfoAllScope"
OAuthTokeninfoAnyKVName = "oauthTokeninfoAnyKV"
OAuthTokeninfoAllKVName = "oauthTokeninfoAllKV"
tokeninfoCacheKey = "tokeninfo"
)
type (
tokeninfoSpec struct {
typ roleCheckType
tokeninfoURL string
tokenInfoTimeout time.Duration
}
tokeninfoFilter struct {
typ roleCheckType
authClient *authClient
scopes []string
kv kv
}
)
var tokeninfoAuthClient map[string]*authClient = make(map[string]*authClient)
// 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 &tokeninfoSpec{typ: checkOAuthTokeninfoAllScopes, tokeninfoURL: OAuthTokeninfoURL, tokenInfoTimeout: OAuthTokeninfoTimeout}
}
// 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, tokeninfoURL: OAuthTokeninfoURL, tokenInfoTimeout: OAuthTokeninfoTimeout}
}
// 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, tokeninfoURL: OAuthTokeninfoURL, tokenInfoTimeout: OAuthTokeninfoTimeout}
}
// 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, tokeninfoURL: OAuthTokeninfoURL, tokenInfoTimeout: OAuthTokeninfoTimeout}
}
func (s *tokeninfoSpec) Name() string {
switch s.typ {
case checkOAuthTokeninfoAnyScopes:
return OAuthTokeninfoAnyScopeName
case checkOAuthTokeninfoAllScopes:
return OAuthTokeninfoAllScopeName
case checkOAuthTokeninfoAnyKV:
return OAuthTokeninfoAnyKVName
case checkOAuthTokeninfoAllKV:
return 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
}
var ac *authClient
var ok bool
if ac, ok = tokeninfoAuthClient[s.tokeninfoURL]; !ok {
ac, err = newAuthClient(s.tokeninfoURL, s.tokenInfoTimeout)
if err != nil {
return nil, filters.ErrInvalidFilterParameters
}
tokeninfoAuthClient[s.tokeninfoURL] = ac
}
f := &tokeninfoFilter{typ: s.typ, authClient: 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)", OAuthTokeninfoAnyScopeName, strings.Join(f.scopes, ","))
case checkOAuthTokeninfoAllScopes:
return fmt.Sprintf("%s(%s)", OAuthTokeninfoAllScopeName, strings.Join(f.scopes, ","))
case checkOAuthTokeninfoAnyKV:
return fmt.Sprintf("%s(%s)", OAuthTokeninfoAnyKVName, f.kv)
case checkOAuthTokeninfoAllKV:
return fmt.Sprintf("%s(%s)", 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, err := getToken(r)
if err != nil {
unauthorized(ctx, "", missingBearerToken, f.authClient.url.Hostname())
return
}
if token == "" {
unauthorized(ctx, "", missingBearerToken, f.authClient.url.Hostname())
return
}
authMap, err = f.authClient.getTokeninfo(token, ctx)
if err != nil {
reason := authServiceAccess
if err == errInvalidToken {
reason = invalidToken
}
unauthorized(ctx, "", reason, f.authClient.url.Hostname())
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:
log.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) {}
// Close cleans-up the quit channel used for this spec
func (f *tokeninfoFilter) Close() {
if f.authClient != nil && f.authClient.quit != nil {
close(f.authClient.quit)
f.authClient.quit = nil
}
}