-
Notifications
You must be signed in to change notification settings - Fork 3
/
jwt.go
200 lines (175 loc) · 5.54 KB
/
jwt.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
package middleware
import (
"context"
"net/http"
jwt2 "github.com/golang-jwt/jwt"
"github.com/pkg/errors"
"go.uber.org/zap"
"github.com/foomo/keel/jwt"
httputils "github.com/foomo/keel/utils/net/http"
)
type (
JWTOptions struct {
SetContext bool
TokenProvider TokenProvider
ClaimsProvider JWTClaimsProvider
ClaimsHandler JWTClaimsHandler
MissingTokenHandler JWTMissingTokenHandler
InvalidTokenHandler JWTInvalidTokenHandler
ErrorHandler JWTErrorHandler
}
JWTOption func(*JWTOptions)
JWTClaimsProvider func() jwt2.Claims
JWTClaimsHandler func(*zap.Logger, http.ResponseWriter, *http.Request, jwt2.Claims) bool
JWTErrorHandler func(*zap.Logger, http.ResponseWriter, *http.Request, error) bool
JWTMissingTokenHandler func(*zap.Logger, http.ResponseWriter, *http.Request) (jwt2.Claims, bool)
JWTInvalidTokenHandler func(*zap.Logger, http.ResponseWriter, *http.Request, *jwt2.Token) bool
)
// DefaultJWTErrorHandler function
func DefaultJWTErrorHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request, err error) bool {
httputils.InternalServerError(l, w, r, errors.Wrap(err, "failed parse claims"))
return false
}
// DefaultJWTMissingTokenHandler function
func DefaultJWTMissingTokenHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request) (jwt2.Claims, bool) {
return nil, true
}
// RequiredJWTMissingTokenHandler function
func RequiredJWTMissingTokenHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request) (jwt2.Claims, bool) {
httputils.BadRequestServerError(l, w, r, errors.New("missing jwt token"))
return nil, false
}
// DefaultJWTInvalidTokenHandler function
func DefaultJWTInvalidTokenHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request, token *jwt2.Token) bool {
httputils.BadRequestServerError(l, w, r, errors.New("invalid jwt token"))
return false
}
// DefaultJWTClaimsProvider function
func DefaultJWTClaimsProvider() jwt2.Claims {
return &jwt2.StandardClaims{}
}
// DefaultJWTClaimsHandler function
func DefaultJWTClaimsHandler(l *zap.Logger, w http.ResponseWriter, r *http.Request, claims jwt2.Claims) bool {
return true
}
// GetDefaultJWTOptions returns the default options
func GetDefaultJWTOptions() JWTOptions {
return JWTOptions{
SetContext: true,
TokenProvider: HeaderTokenProvider(),
ClaimsProvider: DefaultJWTClaimsProvider,
ClaimsHandler: DefaultJWTClaimsHandler,
ErrorHandler: DefaultJWTErrorHandler,
InvalidTokenHandler: DefaultJWTInvalidTokenHandler,
MissingTokenHandler: DefaultJWTMissingTokenHandler,
}
}
// JWTWithTokenProvider middleware option
func JWTWithTokenProvider(v TokenProvider) JWTOption {
return func(o *JWTOptions) {
o.TokenProvider = v
}
}
// JWTWithClaimsProvider middleware option
func JWTWithClaimsProvider(v JWTClaimsProvider) JWTOption {
return func(o *JWTOptions) {
o.ClaimsProvider = v
}
}
// JWTWithClaimsHandler middleware option
func JWTWithClaimsHandler(v JWTClaimsHandler) JWTOption {
return func(o *JWTOptions) {
o.ClaimsHandler = v
}
}
// JWTWithInvalidTokenHandler middleware option
func JWTWithInvalidTokenHandler(v JWTInvalidTokenHandler) JWTOption {
return func(o *JWTOptions) {
o.InvalidTokenHandler = v
}
}
// JWTWithMissingTokenHandler middleware option
func JWTWithMissingTokenHandler(v JWTMissingTokenHandler) JWTOption {
return func(o *JWTOptions) {
o.MissingTokenHandler = v
}
}
// JWTWithErrorHandler middleware option
func JWTWithErrorHandler(v JWTErrorHandler) JWTOption {
return func(o *JWTOptions) {
o.ErrorHandler = v
}
}
func JWTWithSetContext(v bool) JWTOption {
return func(o *JWTOptions) {
o.SetContext = v
}
}
// JWT middleware
func JWT(jwt *jwt.JWT, contextKey interface{}, opts ...JWTOption) Middleware {
options := GetDefaultJWTOptions()
for _, opt := range opts {
if opt != nil {
opt(&options)
}
}
return JWTWithOptions(jwt, contextKey, options)
}
// JWTWithOptions middleware
func JWTWithOptions(jwt *jwt.JWT, contextKey interface{}, opts JWTOptions) Middleware {
return func(l *zap.Logger, name string, next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
claims := opts.ClaimsProvider()
// check existing claims from context
if value := r.Context().Value(contextKey); value != nil {
next.ServeHTTP(w, r)
return
}
// retrieve token from provider
token, err := opts.TokenProvider(r)
if err != nil {
httputils.BadRequestServerError(l, w, r, errors.Wrap(err, "failed to retrieve token"))
return
}
// handle missing token
if token == "" {
if claims, resume := opts.MissingTokenHandler(l, w, r); claims != nil && resume && opts.SetContext {
next.ServeHTTP(w, r.WithContext(context.WithValue(r.Context(), contextKey, claims)))
return
} else if resume {
next.ServeHTTP(w, r)
return
} else {
return
}
}
// don't validate if not required
if !opts.SetContext {
next.ServeHTTP(w, r)
return
}
// handle existing token
jwtToken, err := jwt.ParseWithClaims(token, claims)
if err != nil {
if resume := opts.ErrorHandler(l, w, r, err); resume {
next.ServeHTTP(w, r)
return
} else {
return
}
} else if !jwtToken.Valid {
if resume := opts.InvalidTokenHandler(l, w, r, jwtToken); resume {
next.ServeHTTP(w, r)
return
} else {
return
}
} else if resume := opts.ClaimsHandler(l, w, r, claims); !resume {
return
} else {
next.ServeHTTP(w, r.WithContext(context.WithValue(r.Context(), contextKey, claims)))
return
}
})
}
}