-
Notifications
You must be signed in to change notification settings - Fork 9
/
jwt_token_service.go
490 lines (418 loc) · 12.7 KB
/
jwt_token_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
package service
import (
"crypto/sha1"
"crypto/x509"
"encoding/base64"
"errors"
"fmt"
"strings"
jwt "github.com/form3tech-oss/jwt-go"
ijwt "github.com/madappgang/identifo/jwt"
jwtValidator "github.com/madappgang/identifo/jwt/validator"
"github.com/madappgang/identifo/model"
)
var (
// ErrCreatingToken is a token creation error.
ErrCreatingToken = errors.New("Error creating token")
// ErrSavingToken is a token saving error.
ErrSavingToken = errors.New("Error saving token")
// ErrInvalidApp is when the application is not eligible to obtain the token
ErrInvalidApp = errors.New("Application is not eligible to obtain the token")
// ErrInvalidOfflineScope is when the requested scope does not have an offline value.
ErrInvalidOfflineScope = errors.New("Requested scope don't have offline value")
// ErrInvalidUser is when the user cannot obtain the new token.
ErrInvalidUser = errors.New("The user cannot obtain the new token")
// TokenLifespan is a token expiration time, one week.
TokenLifespan = int64(604800) // int64(1*7*24*60*60)
// InviteTokenLifespan is an invite token expiration time, one hour.
InviteTokenLifespan = int64(3600) // int64(1*60*60)
// RefreshTokenLifespan is a default expiration time for refresh tokens, one year.
RefreshTokenLifespan = int64(31536000) // int(365*24*60*60)
)
const (
// PayloadName is a JWT token payload "name".
PayloadName = "name"
)
// NewJWTokenService returns new JWT token service.
// Arguments:
// - privateKeyPath - the path to the private key in pem format. Please keep it in a secret place.
// - publicKeyPath - the path to the public key.
func NewJWTokenService(keys *model.JWTKeys, issuer string, tokenStorage model.TokenStorage, appStorage model.AppStorage, userStorage model.UserStorage, options ...func(TokenService) error) (TokenService, error) {
if keys == nil || keys.Private == nil || keys.Public == nil {
return nil, fmt.Errorf("One of the keys is empty, or both")
}
tokenServiceAlg, ok := keys.Algorithm.(ijwt.TokenSignatureAlgorithm)
if !ok || tokenServiceAlg == ijwt.TokenSignatureAlgorithmAuto {
return nil, fmt.Errorf("Unknown token service algorithm %s ", keys.Algorithm)
}
t := &JWTokenService{
issuer: issuer,
tokenStorage: tokenStorage,
appStorage: appStorage,
userStorage: userStorage,
resetTokenLifespan: int64(2 * 60 * 60), // 2 hours is a default expiration time for refresh tokens.
webCookieTokenLifespan: int64(2 * 24 * 60 * 60), // 2 days is a default default expiration time for access tokens.
algorithm: tokenServiceAlg,
privateKey: keys.Private,
publicKey: keys.Public,
}
// Apply options.
for _, option := range options {
if err := option(t); err != nil {
return nil, err
}
}
return t, nil
}
// JWTokenService is a JWT token service.
type JWTokenService struct {
privateKey interface{} // *ecdsa.PrivateKey, or *rsa.PrivateKey
publicKey interface{} // *ecdsa.PublicKey, or *rsa.PublicKey
tokenStorage model.TokenStorage
appStorage model.AppStorage
userStorage model.UserStorage
algorithm ijwt.TokenSignatureAlgorithm
issuer string
resetTokenLifespan int64
webCookieTokenLifespan int64
}
// Issuer returns token issuer name.
func (ts *JWTokenService) Issuer() string {
return ts.issuer
}
// Algorithm returns signature algorithm.
func (ts *JWTokenService) Algorithm() string {
switch ts.algorithm {
case ijwt.TokenSignatureAlgorithmES256:
return "ES256"
case ijwt.TokenSignatureAlgorithmRS256:
return "RS256"
default:
return ""
}
}
// PublicKey returns public key.
func (ts *JWTokenService) PublicKey() interface{} {
return ts.publicKey
}
// KeyID returns public key ID, using SHA-1 fingerprint.
func (ts *JWTokenService) KeyID() string {
if der, err := x509.MarshalPKIXPublicKey(ts.publicKey); err == nil {
s := sha1.Sum(der)
return base64.RawURLEncoding.EncodeToString(s[:]) // slice from [20]byte
}
return ""
}
// WebCookieTokenLifespan return auth token lifespan
func (ts *JWTokenService) WebCookieTokenLifespan() int64 {
return ts.webCookieTokenLifespan
}
// Parse parses token data from the string representation.
func (ts *JWTokenService) Parse(s string) (ijwt.Token, error) {
tokenString := strings.TrimSpace(s)
token, err := jwt.ParseWithClaims(tokenString, &ijwt.Claims{}, func(token *jwt.Token) (interface{}, error) {
// since we only use the one private key to sign the tokens,
// we also only use its public counterpart to verify them.
return ts.publicKey, nil
})
if err != nil {
return nil, err
}
return &ijwt.JWToken{JWT: token}, nil
}
// ValidateTokenString parses token and validates it.
func (ts *JWTokenService) ValidateTokenString(tstr string, v jwtValidator.Validator, tokenType string) (ijwt.Token, error) {
token, err := ts.Parse(tstr)
if err != nil {
return nil, err
}
if err := v.Validate(token); err != nil {
return nil, err
}
if token.Type() != tokenType {
return nil, err
}
return token, nil
}
// NewAccessToken creates new access token for user.
func (ts *JWTokenService) NewAccessToken(u model.User, scopes []string, app model.AppData, requireTFA bool, tokenPayload map[string]interface{}) (ijwt.Token, error) {
if !app.Active {
return nil, ErrInvalidApp
}
if !u.Active {
return nil, ErrInvalidUser
}
payload := make(map[string]interface{})
if contains(app.TokenPayload, PayloadName) {
payload[PayloadName] = u.Username
}
tokenType := model.TokenTypeAccess
if requireTFA {
scopes = []string{model.TokenTFAPreauthScope}
}
if len(tokenPayload) > 0 {
for k, v := range tokenPayload {
payload[k] = v
}
}
now := ijwt.TimeFunc().Unix()
lifespan := app.TokenLifespan
if lifespan == 0 {
lifespan = TokenLifespan
}
claims := ijwt.Claims{
Scopes: strings.Join(scopes, " "),
Payload: payload,
Type: tokenType,
StandardClaims: jwt.StandardClaims{
ExpiresAt: (now + lifespan),
Issuer: ts.issuer,
Subject: u.ID,
Audience: []string{app.ID},
IssuedAt: now,
},
}
var sm jwt.SigningMethod
switch ts.algorithm {
case ijwt.TokenSignatureAlgorithmES256:
sm = jwt.SigningMethodES256
case ijwt.TokenSignatureAlgorithmRS256:
sm = jwt.SigningMethodRS256
default:
return nil, ijwt.ErrWrongSignatureAlgorithm
}
token := ijwt.NewTokenWithClaims(sm, ts.KeyID(), claims)
if token == nil {
return nil, ErrCreatingToken
}
return &ijwt.JWToken{JWT: token, New: true}, nil
}
// NewRefreshToken creates new refresh token.
func (ts *JWTokenService) NewRefreshToken(u model.User, scopes []string, app model.AppData) (ijwt.Token, error) {
if !app.Active || !app.Offline {
return nil, ErrInvalidApp
}
// no offline request
if !contains(scopes, OfflineScope) {
return nil, ErrInvalidOfflineScope
}
if !u.Active {
return nil, ErrInvalidUser
}
payload := make(map[string]interface{})
if contains(app.TokenPayload, PayloadName) {
payload[PayloadName] = u.Username
}
now := ijwt.TimeFunc().Unix()
lifespan := app.RefreshTokenLifespan
if lifespan == 0 {
lifespan = RefreshTokenLifespan
}
claims := ijwt.Claims{
Scopes: strings.Join(scopes, " "),
Payload: payload,
Type: model.TokenTypeRefresh,
StandardClaims: jwt.StandardClaims{
ExpiresAt: (now + lifespan),
Issuer: ts.issuer,
Subject: u.ID,
Audience: []string{app.ID},
IssuedAt: now,
},
}
var sm jwt.SigningMethod
switch ts.algorithm {
case ijwt.TokenSignatureAlgorithmES256:
sm = jwt.SigningMethodES256
case ijwt.TokenSignatureAlgorithmRS256:
sm = jwt.SigningMethodRS256
default:
return nil, ijwt.ErrWrongSignatureAlgorithm
}
token := ijwt.NewTokenWithClaims(sm, ts.KeyID(), claims)
if token == nil {
return nil, ErrCreatingToken
}
t := &ijwt.JWToken{JWT: token, New: true}
tokenString, err := ts.String(t)
if err != nil {
return nil, ErrSavingToken
}
if err := ts.tokenStorage.SaveToken(tokenString); err != nil {
return nil, ErrSavingToken
}
return t, nil
}
// RefreshAccessToken issues new access token for provided refresh token.
func (ts *JWTokenService) RefreshAccessToken(refreshToken ijwt.Token) (ijwt.Token, error) {
rt, ok := refreshToken.(*ijwt.JWToken)
if !ok || rt == nil {
return nil, ijwt.ErrTokenInvalid
}
if err := rt.Validate(); err != nil {
return nil, err
}
claims, ok := rt.JWT.Claims.(*ijwt.Claims)
if !ok || claims == nil {
return nil, ijwt.ErrTokenInvalid
}
app, err := ts.appStorage.AppByID(claims.Audience[0])
if err != nil || !app.Offline {
return nil, ErrInvalidApp
}
user, err := ts.userStorage.UserByID(claims.Subject)
if err != nil || !user.Active {
return nil, ErrInvalidUser
}
token, err := ts.NewAccessToken(user, strings.Split(claims.Scopes, " "), app, false, nil)
if err != nil {
return nil, err
}
tokenString, err := ts.String(token)
if err != nil {
return nil, ErrSavingToken
}
if err := ts.tokenStorage.SaveToken(tokenString); err != nil {
return nil, ErrSavingToken
}
return token, nil
}
// NewInviteToken creates new invite token.
func (ts *JWTokenService) NewInviteToken(email, role string) (ijwt.Token, error) {
payload := make(map[string]interface{})
// add payload data here
if email != "" {
payload["email"] = email
}
if role != "" {
payload["role"] = role
}
now := ijwt.TimeFunc().Unix()
lifespan := InviteTokenLifespan
claims := &ijwt.Claims{
Payload: payload,
Type: model.TokenTypeInvite,
StandardClaims: jwt.StandardClaims{
ExpiresAt: now + lifespan,
Issuer: ts.issuer,
// Subject: u.ID(),
Audience: []string{"identifo"},
IssuedAt: now,
},
}
var sm jwt.SigningMethod
switch ts.algorithm {
case ijwt.TokenSignatureAlgorithmES256:
sm = jwt.SigningMethodES256
case ijwt.TokenSignatureAlgorithmRS256:
sm = jwt.SigningMethodRS256
default:
return nil, ijwt.ErrWrongSignatureAlgorithm
}
token := ijwt.NewTokenWithClaims(sm, ts.KeyID(), claims)
if token == nil {
return nil, ErrCreatingToken
}
return &ijwt.JWToken{JWT: token, New: true}, nil
}
// NewResetToken creates new token for password resetting.
func (ts *JWTokenService) NewResetToken(userID string) (ijwt.Token, error) {
now := ijwt.TimeFunc().Unix()
lifespan := ts.resetTokenLifespan
claims := ijwt.Claims{
Type: model.TokenTypeReset,
StandardClaims: jwt.StandardClaims{
ExpiresAt: (now + lifespan),
Issuer: ts.issuer,
Subject: userID,
Audience: []string{"identifo"},
IssuedAt: now,
},
}
var sm jwt.SigningMethod
switch ts.algorithm {
case ijwt.TokenSignatureAlgorithmES256:
sm = jwt.SigningMethodES256
case ijwt.TokenSignatureAlgorithmRS256:
sm = jwt.SigningMethodRS256
default:
return nil, ijwt.ErrWrongSignatureAlgorithm
}
token := ijwt.NewTokenWithClaims(sm, ts.KeyID(), claims)
if token == nil {
return nil, ErrCreatingToken
}
return &ijwt.JWToken{JWT: token, New: true}, nil
}
// NewWebCookieToken creates new web cookie token.
func (ts *JWTokenService) NewWebCookieToken(u model.User) (ijwt.Token, error) {
if !u.Active {
return nil, ErrInvalidUser
}
now := ijwt.TimeFunc().Unix()
lifespan := ts.resetTokenLifespan
claims := ijwt.Claims{
Type: model.TokenTypeWebCookie,
StandardClaims: jwt.StandardClaims{
ExpiresAt: (now + lifespan),
Issuer: ts.issuer,
Subject: u.ID,
Audience: []string{"identifo"},
IssuedAt: now,
},
}
var sm jwt.SigningMethod
switch ts.algorithm {
case ijwt.TokenSignatureAlgorithmES256:
sm = jwt.SigningMethodES256
case ijwt.TokenSignatureAlgorithmRS256:
sm = jwt.SigningMethodRS256
default:
return nil, ijwt.ErrWrongSignatureAlgorithm
}
token := ijwt.NewTokenWithClaims(sm, ts.KeyID(), claims)
if token == nil {
return nil, ErrCreatingToken
}
return &ijwt.JWToken{JWT: token, New: true}, nil
}
// String returns string representation of a token.
func (ts *JWTokenService) String(t ijwt.Token) (string, error) {
token, ok := t.(*ijwt.JWToken)
if !ok {
return "", ijwt.ErrTokenInvalid
}
if err := t.Validate(); err != nil {
return "", err
}
if !token.New && !token.JWT.Valid {
return "", ijwt.ErrTokenInvalid
}
str, err := token.JWT.SignedString(ts.privateKey)
if err != nil {
return "", err
}
return str, nil
}
// ResetTokenLifespan sets custom lifespan in seconds for the reset token
func ResetTokenLifespan(lifespan int64) func(*JWTokenService) error {
return func(ts *JWTokenService) error {
ts.resetTokenLifespan = lifespan
return nil
}
}
// WebCookieTokenLifespan sets custom lifespan in seconds for the web cookie token
func WebCookieTokenLifespan(lifespan int64) func(*JWTokenService) error {
return func(ts *JWTokenService) error {
ts.webCookieTokenLifespan = lifespan
return nil
}
}
func contains(s []string, e string) bool {
for _, a := range s {
if strings.TrimSpace(strings.ToLower(a)) == strings.TrimSpace(strings.ToLower(e)) {
return true
}
}
return false
}