-
Notifications
You must be signed in to change notification settings - Fork 3
/
service.go
543 lines (444 loc) · 13.6 KB
/
service.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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
package token
import (
"context"
"database/sql"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"net/http"
"strings"
"time"
"github.com/dgrijalva/jwt-go"
"github.com/go-kit/kit/log"
"github.com/go-kit/kit/log/level"
redislib "github.com/go-redis/redis/v8"
"github.com/oklog/ulid/v2"
auth "github.com/fmitra/authenticator"
"github.com/fmitra/authenticator/internal/crypto"
)
const (
clientIDLen = 40
refreshTokenLen = 40
)
const (
// ClientIDCookie is the cookie name used to set the token's
// ClientID value on a client.
ClientIDCookie = "CLIENTID"
// RefreshTokenCookie is the cookie name used to set the refresh
// token value on a client.
RefreshTokenCookie = "REFRESHTOKEN"
)
// RefreshToken is a token capable of refreshing an expired
// JWT token.
type RefreshToken struct {
Code string `json:"code"`
ExpiresAt int64 `json:"expires_at"`
}
// rediser is an interface to go-redis.
type rediser interface {
Get(ctx context.Context, key string) *redislib.StringCmd
Set(ctx context.Context, key string, value interface{}, expiration time.Duration) *redislib.StatusCmd
Close() error
}
// WithOTPDeliveryMethod sets a delivery method (e.g. email, phone)
// to be used as a channel for sending OTP codes related to a JWT token.
func WithOTPDeliveryMethod(method auth.DeliveryMethod) auth.TokenOption {
return func(conf *auth.TokenConfiguration) {
conf.DeliveryMethod = method
}
}
// WithOTPAddress sets an address to receive a randomly generated
// OTP code. If a delivery method is configured on the token without
// a corresponding address, we will deliver the OTP code to the user's
// default sending address.
func WithOTPAddress(address string) auth.TokenOption {
return func(conf *auth.TokenConfiguration) {
conf.DeliveryAddress = address
}
}
// WithRefreshableToken uses an older JWT token as a basis for creating
// a new token. ClientID hashes and the token ID will be carried over
// to the new token with an updated expiry time.
func WithRefreshableToken(token *auth.Token) auth.TokenOption {
return func(conf *auth.TokenConfiguration) {
conf.RefreshableToken = token
}
}
// service is an implementation of auth.TokenService
// backed by redis.
type service struct {
logger log.Logger
tokenExpiry time.Duration
refreshTokenExpiry time.Duration
entropy io.Reader
secret []byte
issuer string
db rediser
repoMngr auth.RepositoryManager
otp auth.OTPService
cookieMaxAge int
cookieDomain string
}
// Create creates a new, unsigned JWT token for a User
// with optional configuration settings.
func (s *service) Create(ctx context.Context, user *auth.User, state auth.TokenState, options ...auth.TokenOption) (*auth.Token, error) {
conf := &auth.TokenConfiguration{}
for _, opt := range options {
opt(conf)
}
tokenULID, err := s.genULID(conf)
if err != nil {
return nil, err
}
clientID, clientIDHash, err := s.genClientIDAndHash(conf)
if err != nil {
return nil, err
}
code, codeHash, err := s.genOTPAndHash(conf, user)
if err != nil {
return nil, err
}
refreshToken, refreshTokenHash, err := s.genRefreshTokenAndHash(conf)
if err != nil {
return nil, err
}
expiresAt := time.Now().Add(s.tokenExpiry).Unix()
tfaOptions := s.genTFAOptions(user)
token := auth.Token{
StandardClaims: jwt.StandardClaims{
IssuedAt: time.Now().Unix(),
ExpiresAt: expiresAt,
Id: tokenULID,
Issuer: s.issuer,
},
Code: code,
CodeHash: codeHash,
RefreshToken: refreshToken,
RefreshTokenHash: refreshTokenHash,
UserID: user.ID,
Email: user.Email.String,
Phone: user.Phone.String,
ClientID: clientID,
ClientIDHash: clientIDHash,
State: state,
TFAOptions: tfaOptions,
DefaultTFA: user.DefaultTFA(),
}
if err = s.invalidateOldTokens(ctx, conf, &token); err != nil {
return nil, fmt.Errorf("cannot invalidate old tokens: %w", err)
}
return &token, nil
}
// Sign creates a signed JWT token string from a token struct.
func (s *service) Sign(ctx context.Context, token *auth.Token) (string, error) {
jwtUnsigned := jwt.NewWithClaims(jwt.SigningMethodHS512, token)
jwtSigned, err := jwtUnsigned.SignedString(s.secret)
if err != nil {
return "", fmt.Errorf("failed to sign JWT token: %w", err)
}
return jwtSigned, nil
}
// Validate checks that a JWT token is signed by us, unexpired, unrevoked
// and originating from a valid client. On success it will return the unpacked
// Token struct.
func (s *service) Validate(ctx context.Context, signedToken string, clientID string) (*auth.Token, error) {
if !strings.HasPrefix(signedToken, "Bearer ") {
return nil, auth.ErrInvalidToken("bearer token expected")
}
tokenParser := func(token *jwt.Token) (interface{}, error) {
if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, fmt.Errorf("unexpected signing method %v", token.Header["alg"])
}
return s.secret, nil
}
signedToken = strings.TrimPrefix(signedToken, "Bearer ")
unpackedToken, err := jwt.Parse(signedToken, tokenParser)
if err != nil {
return nil, fmt.Errorf("%v: %w", err, auth.ErrInvalidToken("token is invalid"))
}
claims, ok := unpackedToken.Claims.(jwt.MapClaims)
if !ok || !unpackedToken.Valid {
return nil, fmt.Errorf("token claims unavailable")
}
var token auth.Token
{
b, err := json.Marshal(claims)
if err != nil {
return nil, fmt.Errorf("cannot marshal token to JSON: %w", err)
}
err = json.Unmarshal(b, &token)
if err != nil {
return nil, fmt.Errorf("cannot unmarshall token to struct: %w", err)
}
}
if token.UserID == "" {
return nil, auth.ErrInvalidToken("token is not associated with user")
}
decoded, err := base64.RawURLEncoding.DecodeString(clientID)
if err != nil {
return nil, fmt.Errorf("cannot decode client ID: %w", err)
}
if !isHashValid(string(decoded), token.ClientIDHash) {
return nil, auth.ErrInvalidToken("token source is invalid")
}
if err := s.checkRevocation(ctx, &token); err != nil {
return nil, err
}
if err := s.checkInvalidation(ctx, &token); err != nil {
return nil, err
}
return &token, nil
}
// Revoke revokes a JWT token by its ID for a specified duration.
func (s *service) Revoke(ctx context.Context, tokenID string) error {
_, err := s.repoMngr.LoginHistory().ByTokenID(ctx, tokenID)
if err == sql.ErrNoRows {
return fmt.Errorf("%v: %w", err, auth.ErrBadRequest("invalid token ID"))
}
if err != nil {
return err
}
tx, err := s.repoMngr.NewWithTransaction(ctx)
if err != nil {
return fmt.Errorf("cannot start transaction: %w", err)
}
_, err = tx.WithAtomic(func() (interface{}, error) {
lh, err := tx.LoginHistory().GetForUpdate(ctx, tokenID)
if err != nil {
return nil, err
}
lh.IsRevoked = true
if err = tx.LoginHistory().Update(ctx, lh); err != nil {
return nil, err
}
return lh, nil
})
if err != nil {
return fmt.Errorf("failed to invalidate login history record: %w", err)
}
return s.db.Set(ctx, revocationKey(tokenID), true, s.tokenExpiry).Err()
}
// Cookies returns a secure cookies to accompany a token.
func (s *service) Cookies(ctx context.Context, token *auth.Token) []*http.Cookie {
cookies := []*http.Cookie{
{
Name: ClientIDCookie,
Value: token.ClientID,
MaxAge: s.cookieMaxAge,
Domain: s.cookieDomain,
Path: "/",
Secure: true,
HttpOnly: true,
},
{
Name: RefreshTokenCookie,
Value: token.RefreshToken,
MaxAge: s.cookieMaxAge,
Domain: s.cookieDomain,
Path: "/",
Secure: true,
HttpOnly: true,
},
}
return cookies
}
// Refreshable checks if a provided token can be refreshed.
func (s *service) Refreshable(ctx context.Context, token *auth.Token, refreshToken string) error {
_, err := unpackRefreshToken(refreshToken, token.RefreshTokenHash)
if err != nil {
return err
}
lh, err := s.repoMngr.LoginHistory().ByTokenID(ctx, token.Id)
if err != nil {
return fmt.Errorf("failed to retrieve login history record: %w", err)
}
if lh.IsRevoked {
return auth.ErrInvalidToken("token is revoked")
}
return nil
}
// RefreshableTill returns the last validity time of a refresh token.
func (s *service) RefreshableTill(ctx context.Context, token *auth.Token, refreshToken string) time.Time {
r, err := unpackRefreshToken(refreshToken, token.RefreshTokenHash)
if err != nil {
return time.Time{}
}
return time.Unix(r.ExpiresAt, 0)
}
func (s *service) genTFAOptions(user *auth.User) []auth.TFAOptions {
options := []auth.TFAOptions{}
if user.IsPhoneOTPAllowed {
options = append(options, auth.OTPPhone)
}
if user.IsEmailOTPAllowed {
options = append(options, auth.OTPEmail)
}
if user.IsTOTPAllowed {
options = append(options, auth.TOTP)
}
if user.IsDeviceAllowed {
options = append(options, auth.FIDODevice)
}
return options
}
func (s *service) genULID(conf *auth.TokenConfiguration) (string, error) {
if conf.RefreshableToken != nil {
return conf.RefreshableToken.StandardClaims.Id, nil
}
tokenULID, err := ulid.New(ulid.Now(), s.entropy)
if err != nil {
return "", fmt.Errorf("cannot generate unique token ID: %w", err)
}
return tokenULID.String(), nil
}
func (s *service) genClientIDAndHash(conf *auth.TokenConfiguration) (string, string, error) {
if conf.RefreshableToken != nil {
return "", conf.RefreshableToken.ClientIDHash, nil
}
clientID, err := crypto.String(clientIDLen)
if err != nil {
return "", "", fmt.Errorf("failed to generate client ID: %w", err)
}
clientIDHash, err := crypto.Hash(clientID)
if err != nil {
return "", "", fmt.Errorf("failed to hash client ID: %w", err)
}
encodedID := base64.RawURLEncoding.EncodeToString([]byte(clientID))
return encodedID, clientIDHash, nil
}
func (s *service) genOTPAndHash(conf *auth.TokenConfiguration, user *auth.User) (string, string, error) {
if conf.DeliveryMethod == "" {
return "", "", nil
}
address := conf.DeliveryAddress
sendToDefaultAddress := address == ""
usePhoneNumber := conf.DeliveryMethod == auth.Phone &&
user.IsPhoneOTPAllowed &&
sendToDefaultAddress
useEmailAddress := conf.DeliveryMethod == auth.Email &&
user.IsEmailOTPAllowed &&
sendToDefaultAddress
if usePhoneNumber {
address = user.Phone.String
}
if useEmailAddress {
address = user.Email.String
}
if address == "" {
return "", "", auth.ErrInvalidField("delivery address is not valid")
}
code, codeHash, err := s.otp.OTPCode(address, conf.DeliveryMethod)
if err != nil {
return "", "", fmt.Errorf("failed to generate OTP code: %w", err)
}
return code, codeHash, nil
}
func (s *service) genRefreshTokenAndHash(conf *auth.TokenConfiguration) (string, string, error) {
if conf.RefreshableToken != nil {
return "", conf.RefreshableToken.RefreshTokenHash, nil
}
code, err := crypto.String(refreshTokenLen)
if err != nil {
return "", "", err
}
expiresAt := time.Now().Add(s.refreshTokenExpiry).Unix()
token := &RefreshToken{
Code: code,
ExpiresAt: expiresAt,
}
b, err := json.Marshal(token)
if err != nil {
return "", "", err
}
h, err := crypto.Hash(string(b))
if err != nil {
return "", "", err
}
encodedToken := base64.RawURLEncoding.EncodeToString(b)
return encodedToken, h, nil
}
func (s *service) invalidateOldTokens(ctx context.Context, conf *auth.TokenConfiguration, token *auth.Token) error {
proceed := conf.RefreshableToken != nil &&
conf.DeliveryMethod != "" &&
conf.DeliveryAddress != ""
if !proceed {
return nil
}
key := invalidationKey(token.Id)
latestValidTimestamp := token.IssuedAt
return s.db.Set(ctx, key, latestValidTimestamp, s.tokenExpiry).Err()
}
func (s *service) checkRevocation(ctx context.Context, token *auth.Token) error {
key := revocationKey(token.Id)
err := s.db.Get(ctx, key).Err()
if err == nil {
return auth.ErrInvalidToken("token is revoked")
}
if err == redislib.Nil {
return nil
}
return fmt.Errorf("cannot lookup token revocation history: %w", err)
}
func (s *service) checkInvalidation(ctx context.Context, token *auth.Token) error {
// Tokens containing an OTP code hash are checked for timestamp invalidation
// to ensure an OTP code cannot be used after a newer code is generated.
// If an OTP code was not generated for the token we can skip this.
if token.CodeHash == "" {
return nil
}
key := invalidationKey(token.Id)
ts, err := s.db.Get(ctx, key).Int64()
level.Info(s.logger).Log(
"source", "TokenService.checkInvalidation",
"message", "invalidation check",
"invalidation_ts", ts,
"token_ts", token.IssuedAt,
"err", err,
)
if err == nil {
if token.IssuedAt >= ts {
return nil
}
return auth.ErrInvalidToken("token is revoked")
}
if err == redislib.Nil {
return nil
}
return fmt.Errorf("cannot lookup token invalidation history: %w", err)
}
func invalidationKey(tokenID string) string {
return fmt.Sprintf("%s_invalid_after", tokenID)
}
func revocationKey(tokenID string) string {
return fmt.Sprintf("%s_is_revoked", tokenID)
}
func isHashValid(str, hash string) bool {
h, err := crypto.Hash(str)
if err != nil {
return false
}
if h != hash {
return false
}
return true
}
func unpackRefreshToken(refreshToken, refreshTokenHash string) (*RefreshToken, error) {
decoded, err := base64.RawURLEncoding.DecodeString(refreshToken)
if err != nil {
return nil, fmt.Errorf("cannot decode refresh token: %w", err)
}
if !isHashValid(string(decoded), refreshTokenHash) {
return nil, auth.ErrInvalidToken("refresh token is invalid")
}
var t RefreshToken
err = json.Unmarshal(decoded, &t)
if err != nil {
return nil, fmt.Errorf("invalid refresh token format: %w", err)
}
now := time.Now().Unix()
if now >= t.ExpiresAt {
return nil, auth.ErrInvalidToken("refresh token is expired")
}
return &t, nil
}