/
authmanager.go
464 lines (406 loc) · 13.8 KB
/
authmanager.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
package application
import (
"context"
"encoding/gob"
"errors"
"fmt"
"log"
"net/http"
"net/http/httputil"
"os"
"runtime/debug"
"flamingo.me/flamingo/v3/core/auth/oauth"
"flamingo.me/flamingo/v3/core/oauth/domain"
"flamingo.me/flamingo/v3/framework/config"
"flamingo.me/flamingo/v3/framework/flamingo"
"flamingo.me/flamingo/v3/framework/web"
"github.com/coreos/go-oidc/v3/oidc"
"golang.org/x/oauth2"
)
const (
// keyToken defines where the authentication token is saved
keyToken = "auth.token"
// keyRawIDToken defines where the raw ID token is saved
keyRawIDToken = "auth.rawidtoken"
// keyAuthstate defines the current internal authentication state
keyAuthstate = "auth.state"
// keyToken defines where the authentication token extras are saved
keyTokenExtras = "auth.token.extras"
)
func init() {
gob.Register(oauth2.Token{})
gob.Register(domain.TokenExtras{})
}
type (
// AuthManager handles authentication related operations
// Deprecated: use core/auth instead
AuthManager struct {
server string
secret string
clientID string
disableOfflineToken bool
scopes config.Slice
idTokenMapping config.Slice
userInfoMapping config.Slice
logger flamingo.Logger
router *web.Router
openIDProvider *oidc.Provider
tokenExtras config.Slice
AuthCodeOptions []oauth2.AuthCodeOption
}
loggingRoundTripper struct {
originalTransport http.RoundTripper
}
)
// RoundTrip implements RoundTripper interface and adds logging
func (f *loggingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
if req == nil {
return nil, errors.New("no request given")
}
b, err := httputil.DumpRequest(req, true)
log.Println()
log.Println("############### OAUTH REQUEST:")
log.Printf("%v %v ", string(b), err)
res, err := f.originalTransport.RoundTrip(req)
b, _ = httputil.DumpResponse(res, true)
log.Println("############### OAUTH RESPONSE:")
log.Printf("%v %v ", string(b), err)
log.Println("############### OAUTH Call Stack:")
log.Println()
debug.PrintStack()
return res, err
}
// Inject authManager dependencies
func (am *AuthManager) Inject(logger flamingo.Logger, router *web.Router, config *struct {
Server string `inject:"config:core.oauth.server"`
Secret string `inject:"config:core.oauth.secret"`
ClientID string `inject:"config:core.oauth.clientid"`
DisableOfflineToken bool `inject:"config:core.oauth.disableOfflineToken"`
Scopes config.Slice `inject:"config:core.oauth.scopes"`
IDTokenMapping config.Slice `inject:"config:core.oauth.claims.idToken"`
UserInfoMapping config.Slice `inject:"config:core.oauth.claims.userInfo"`
TokenExtras config.Slice `inject:"config:core.oauth.tokenExtras"`
DebugMode bool `inject:"config:flamingo.debug.mode"`
Enabled bool `inject:"config:core.oauth.enabled"`
OverrideIssuerURL string `inject:"config:core.oauth.overrideIssuerURL"`
}) {
am.logger = logger.WithField(flamingo.LogKeyModule, "oauth")
am.router = router
if config != nil {
am.server = config.Server
am.secret = config.Secret
am.clientID = config.ClientID
am.disableOfflineToken = config.DisableOfflineToken
am.scopes = config.Scopes
am.idTokenMapping = config.IDTokenMapping
am.userInfoMapping = config.UserInfoMapping
am.tokenExtras = config.TokenExtras
if !config.Enabled {
am.logger.Info("OIDC is disabled. Modules depending on OAuth features cannot work properly")
return
}
ctx := context.Background()
if config.OverrideIssuerURL != "" {
ctx = oidc.InsecureIssuerURLContext(ctx, config.OverrideIssuerURL)
}
var err error
am.openIDProvider, err = oidc.NewProvider(ctx, config.Server)
if err != nil {
if config.DebugMode {
am.logger.Error(err)
} else {
// panic on err since we really expect a valid authmanager state and application is in a failed state otherwise
panic(err)
}
}
}
}
// Auth tries to retrieve the authentication context for a active session - this is used to pass Authentication to services
// - if the stored token for the Auth is not valid anymore it will refresh the token before
func (am *AuthManager) Auth(c context.Context, session *web.Session) (domain.Auth, error) {
c = am.OAuthCtx(c)
currentToken, err := am.OAuth2Token(session)
if err != nil {
am.logger.WithContext(c).Debug(err)
return domain.Auth{}, err
}
if !currentToken.Valid() {
err := am.refreshTokenAndUpdateStore(c, session)
if err != nil {
am.logger.WithContext(c).Debug(err)
return domain.Auth{}, err
}
}
ts, err := am.TokenSource(c, session)
if err != nil {
am.logger.WithContext(c).Error(err)
return domain.Auth{}, err
}
idToken, err := am.IDToken(c, session)
if err != nil {
am.logger.WithContext(c).Error(err)
return domain.Auth{}, err
}
return domain.Auth{
TokenSource: ts,
IDToken: idToken,
}, nil
}
// OpenIDProvider is a lazy initialized OID provider
func (am *AuthManager) OpenIDProvider() *oidc.Provider {
return am.openIDProvider
}
// OAuthCtx - returns ctx that should be used to pass to oauth2 lib - it enables logging for Debug reasons
func (am *AuthManager) OAuthCtx(ctx context.Context) context.Context {
if os.Getenv("OAUTHDEBUG") == "1" {
oauthHTTPClient := &http.Client{
Transport: &loggingRoundTripper{
originalTransport: http.DefaultTransport,
},
}
return context.WithValue(ctx, oauth2.HTTPClient, oauthHTTPClient)
}
return ctx
}
// OAuth2Config is lazy setup oauth2config
func (am *AuthManager) OAuth2Config(_ context.Context, req *web.Request) *oauth2.Config {
var redirectURL string
if req != nil {
callbackURL, _ := am.router.Absolute(req, "auth.callback", nil)
redirectURL = callbackURL.String()
}
var scopes []string
err := am.scopes.MapInto(&scopes)
if err != nil {
am.logger.WithField(flamingo.LogKeyCategory, "auth").Error("could not parse scopes from config", am.scopes, err)
}
scopes = append([]string{oidc.ScopeOpenID}, scopes...)
if !am.disableOfflineToken {
scopes = append(scopes, oidc.ScopeOfflineAccess)
}
claimset := am.getClaimsRequestParameter()
if claimset.HasClaims() {
authCodeOption, err := am.getClaimsRequestParameter().AuthCodeOption()
if err != nil {
am.logger.WithField(flamingo.LogKeyCategory, "auth").Error("could not map configuration", err)
} else {
am.AuthCodeOptions = append(am.AuthCodeOptions, authCodeOption)
}
}
oauth2Config := &oauth2.Config{
ClientID: am.clientID,
ClientSecret: am.secret,
RedirectURL: redirectURL,
// "openid" is a required scope for OpenID Connect flows.
Scopes: scopes,
}
if am.OpenIDProvider() != nil {
oauth2Config.Endpoint = am.OpenIDProvider().Endpoint()
}
am.logger.WithField(flamingo.LogKeyCategory, "auth").Debug("am.oauth2Config", oauth2Config)
return oauth2Config
}
// Verifier creates an OID verifier
func (am *AuthManager) Verifier() *oidc.IDTokenVerifier {
return am.OpenIDProvider().Verifier(&oidc.Config{ClientID: am.clientID})
}
// OAuth2Token retrieves the oauth2 token from the session
func (am *AuthManager) OAuth2Token(session *web.Session) (*oauth2.Token, error) {
if _, ok := session.Load(keyToken); !ok {
return nil, errors.New("no token")
}
value, _ := session.Load(keyToken)
oauth2Token, ok := value.(oauth2.Token)
if !ok {
am.DeleteTokenDetails(session)
return nil, fmt.Errorf("invalid token in session %#v", value)
}
return &oauth2Token, nil
}
// IDToken retrieves and validates the ID Token from the session
func (am *AuthManager) IDToken(c context.Context, session *web.Session) (*oidc.IDToken, error) {
token, _, err := am.getIDToken(c, session)
return token, err
}
// GetRawIDToken gets the raw IDToken from session
func (am *AuthManager) GetRawIDToken(c context.Context, session *web.Session) (string, error) {
_, raw, err := am.getIDToken(c, session)
return raw, err
}
// IDToken retrieves and validates the ID Token from the session
func (am *AuthManager) getIDToken(c context.Context, session *web.Session) (*oidc.IDToken, string, error) {
if am.OpenIDProvider() == nil {
return nil, "", errors.New("oauth not available")
}
c = am.OAuthCtx(c)
if session == nil {
return nil, "", errors.New("no session configured")
}
if token, ok := session.Load(keyRawIDToken); ok {
idtoken, err := am.Verifier().Verify(c, token.(string))
if err == nil {
return idtoken, token.(string), nil
}
am.logger.WithContext(c).Debug("keyRawIDToken not verified (anymore)")
err = am.refreshTokenAndUpdateStore(c, session)
if err != nil {
return nil, "", err
}
token, ok = session.Load(keyRawIDToken)
if !ok {
return nil, "", errors.New("no token after refreshToken")
}
idtoken, err = am.Verifier().Verify(c, token.(string))
if err != nil {
return nil, "", errors.New("no verified id token after refreshToken")
}
return idtoken, token.(string), nil
}
return nil, "", errors.New("no id token in session")
}
// refreshTokenAndUpdateStore
func (am *AuthManager) refreshTokenAndUpdateStore(c context.Context, session *web.Session) error {
c = am.OAuthCtx(c)
tokenSource, err := am.TokenSource(c, session)
if err != nil {
return fmt.Errorf("error retrieving tokenSource: %w", err)
}
token, err := tokenSource.Token()
if err != nil {
return fmt.Errorf("error retrieving token: %w", err)
}
err = am.StoreTokenDetails(c, session, token)
if err != nil {
return fmt.Errorf("error storing token: %w", err)
}
return nil
}
func (am *AuthManager) getClaimsRequestParameter() *oauth.ClaimSet {
var claimSet *oauth.ClaimSet
claimSet = am.createClaimSetFromMapping(oauth.TopLevelClaimIDToken, am.idTokenMapping, claimSet)
claimSet = am.createClaimSetFromMapping(oauth.TopLevelClaimUserInfo, am.userInfoMapping, claimSet)
return claimSet
}
func (am *AuthManager) createClaimSetFromMapping(topLevelName string, configuration config.Slice, claimSet *oauth.ClaimSet) *oauth.ClaimSet {
var mapping []string
err := configuration.MapInto(&mapping)
if err != nil {
am.logger.WithField(flamingo.LogKeyCategory, "auth").Error("could not map configuration", err)
}
for _, name := range mapping {
if name == "" {
continue
}
if claimSet == nil {
claimSet = &oauth.ClaimSet{}
}
claimSet.AddVoluntaryClaim(topLevelName, name)
}
return claimSet
}
// AccessToken - used to get access token
func (am *AuthManager) AccessToken(ctx context.Context, session *web.Session) (string, error) {
auth, err := am.Auth(ctx, session)
if err != nil {
return "", err
}
token, err := auth.TokenSource.Token()
if err != nil {
return "", err
}
return token.AccessToken, nil
}
// ExtractRawIDToken from the provided (fresh) oatuh2token
func (am *AuthManager) ExtractRawIDToken(oauth2Token *oauth2.Token) (string, error) {
// Extract the ID Token from OAuth2 token.
rawIDToken, ok := oauth2Token.Extra("id_token").(string)
if !ok {
return "", fmt.Errorf("no id token %T / %v", oauth2Token.Extra("id_token"), oauth2Token.Extra("id_token"))
}
return rawIDToken, nil
}
// TokenSource - return oauth2.TokenSource initialized with the Refreshtoken stored in the
// to be used in situations where you need it
func (am *AuthManager) TokenSource(c context.Context, session *web.Session) (oauth2.TokenSource, error) {
oauth2Token, err := am.OAuth2Token(session)
if err != nil {
return nil, err
}
return am.OAuth2Config(c, nil).TokenSource(c, oauth2Token), nil
}
// HTTPClient to retrieve a client with automatic tokensource
func (am *AuthManager) HTTPClient(c context.Context, session *web.Session) (*http.Client, error) {
ts, err := am.TokenSource(c, session)
if err != nil {
return nil, err
}
return oauth2.NewClient(c, ts), nil
}
// StoreTokenDetails stores all token related data into session
func (am *AuthManager) StoreTokenDetails(ctx context.Context, session *web.Session, oauth2Token *oauth2.Token) error {
if oauth2Token == nil {
err := errors.New("StoreTokenDetails got no token")
am.logger.WithContext(ctx).Error(err)
return err
}
if oauth2Token.AccessToken == "" {
err := errors.New("StoreTokenDetails got token without accesstoken")
am.logger.WithContext(ctx).Error(err)
return err
}
if !oauth2Token.Valid() {
am.logger.WithContext(ctx).Warn("StoreTokenDetails got already invalid token")
}
var rawToken string
// load old token first
if token, ok := session.Load(keyRawIDToken); ok {
rawToken = token.(string)
}
// check if we have a newer token
if newRawToken, err := am.ExtractRawIDToken(oauth2Token); err == nil && newRawToken != "" {
rawToken = newRawToken
}
if rawToken == "" {
return fmt.Errorf("StoreTokenDetails has no ID token available")
}
var extras []string
err := am.tokenExtras.MapInto(&extras)
if err != nil {
return err
}
tokenExtras := domain.TokenExtras{}
for _, extra := range extras {
value := oauth2Token.Extra(extra)
parsed, ok := value.(string)
if !ok {
am.logger.Error("core.auth.callback invalid type for extras", value)
continue
}
tokenExtras.Add(extra, parsed)
}
token := *oauth2Token
session.Store(keyToken, token)
session.Store(keyRawIDToken, rawToken)
session.Store(keyTokenExtras, tokenExtras)
return nil
}
// DeleteTokenDetails deletes all token related data from session
func (am *AuthManager) DeleteTokenDetails(session *web.Session) {
session.Delete(keyToken)
session.Delete(keyRawIDToken)
session.Delete(keyTokenExtras)
}
// StoreAuthState stores auth state into session, used to connect passed state id in auth callback with the one stored in session
func (am *AuthManager) StoreAuthState(session *web.Session, state string) {
session.Store(keyAuthstate, state)
}
// LoadAuthState loads auth state from session
func (am *AuthManager) LoadAuthState(session *web.Session) (string, bool) {
value, _ := session.Load(keyAuthstate)
state, ok := value.(string)
return state, ok
}
// DeleteAuthState deletes auth state from session
func (am *AuthManager) DeleteAuthState(session *web.Session) {
session.Delete(keyAuthstate)
}