forked from appleboy/gin-jwt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
auth_jwt.go
295 lines (229 loc) · 7.9 KB
/
auth_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
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
package jwt
import (
"errors"
"github.com/gin-gonic/gin"
"gopkg.in/dgrijalva/jwt-go.v3"
"log"
"net/http"
"strings"
"time"
)
// GinJWTMiddleware provides a Json-Web-Token authentication implementation. On failure, a 401 HTTP response
// is returned. On success, the wrapped middleware is called, and the userId is made available as
// c.Get("userId").(string).
// Users can get a token by posting a json request to LoginHandler. The token then needs to be passed in
// the Authentication header. Example: Authorization:Bearer XXX_TOKEN_XXX#!/usr/bin/env
type GinJWTMiddleware struct {
// Realm name to display to the user. Required.
Realm string
// signing algorithm - possible values are HS256, HS384, HS512
// Optional, default is HS256.
SigningAlgorithm string
// Secret key used for signing. Required.
Key []byte
// Duration that a jwt token is valid. Optional, defaults to one hour.
Timeout time.Duration
// This field allows clients to refresh their token until MaxRefresh has passed.
// Note that clients can refresh their token in the last moment of MaxRefresh.
// This means that the maximum validity timespan for a token is MaxRefresh + Timeout.
// Optional, defaults to 0 meaning not refreshable.
MaxRefresh time.Duration
// Callback function that should perform the authentication of the user based on userId and
// password. Must return true on success, false on failure. Required.
// Option return user id, if so, user id will be stored in Claim Array.
Authenticator func(userId string, password string, c *gin.Context) (string, bool)
// Callback function that should perform the authorization of the authenticated user. Called
// only after an authentication success. Must return true on success, false on failure.
// Optional, default to success.
Authorizator func(userId string, c *gin.Context) bool
// Callback function that will be called during login.
// Using this function it is possible to add additional payload data to the webtoken.
// The data is then made available during requests via c.Get("JWT_PAYLOAD").
// Note that the payload is not encrypted.
// The attributes mentioned on jwt.io can't be used as keys for the map.
// Optional, by default no additional data will be set.
PayloadFunc func(userId string) map[string]interface{}
// User can define own Unauthorized func.
Unauthorized func(*gin.Context, int, string)
}
// Login form structure.
type Login struct {
Username string `form:"username" json:"username" binding:"required"`
Password string `form:"password" json:"password" binding:"required"`
}
// MiddlewareInit initialize jwt configs.
func (mw *GinJWTMiddleware) MiddlewareInit() error {
if mw.Realm == "" {
return errors.New("Realm is required")
}
if mw.Authenticator == nil {
return errors.New("Authenticator is required")
}
if mw.Key == nil {
return errors.New("Key is required")
}
if mw.SigningAlgorithm == "" {
mw.SigningAlgorithm = "HS256"
}
if mw.Timeout == 0 {
mw.Timeout = time.Hour
}
if mw.Authorizator == nil {
mw.Authorizator = func(userId string, c *gin.Context) bool {
return true
}
}
if mw.Unauthorized == nil {
mw.Unauthorized = func(c *gin.Context, code int, message string) {
c.JSON(code, gin.H{
"code": code,
"message": message,
})
}
}
return nil
}
// MiddlewareFunc makes GinJWTMiddleware implement the Middleware interface.
func (mw *GinJWTMiddleware) MiddlewareFunc() gin.HandlerFunc {
if err := mw.MiddlewareInit(); err != nil {
log.Fatal(err.Error())
}
return func(c *gin.Context) {
mw.middlewareImpl(c)
return
}
}
func (mw *GinJWTMiddleware) middlewareImpl(c *gin.Context) {
token, err := mw.parseToken(c)
if err != nil {
mw.unauthorized(c, http.StatusUnauthorized, err.Error())
return
}
claims := token.Claims.(jwt.MapClaims)
id := claims["id"].(string)
c.Set("JWT_PAYLOAD", claims)
c.Set("userID", id)
if !mw.Authorizator(id, c) {
mw.unauthorized(c, http.StatusForbidden, "You don't have permission to access.")
return
}
c.Next()
}
// LoginHandler can be used by clients to get a jwt token.
// Payload needs to be json in the form of {"username": "USERNAME", "password": "PASSWORD"}.
// Reply will be of the form {"token": "TOKEN"}.
func (mw *GinJWTMiddleware) LoginHandler(c *gin.Context) {
// Initial middleware default setting.
mw.MiddlewareInit()
var loginVals Login
if c.BindJSON(&loginVals) != nil {
mw.unauthorized(c, http.StatusBadRequest, "Missing Username or Password")
return
}
userId, ok := mw.Authenticator(loginVals.Username, loginVals.Password, c)
if !ok {
mw.unauthorized(c, http.StatusUnauthorized, "Incorrect Username / Password")
return
}
// Create the token
token := jwt.New(jwt.GetSigningMethod(mw.SigningAlgorithm))
claims := token.Claims.(jwt.MapClaims)
if mw.PayloadFunc != nil {
for key, value := range mw.PayloadFunc(loginVals.Username) {
claims[key] = value
}
}
if userId == "" {
userId = loginVals.Username
}
expire := time.Now().Add(mw.Timeout)
claims["id"] = userId
claims["exp"] = expire.Unix()
claims["orig_iat"] = time.Now().Unix()
tokenString, err := token.SignedString(mw.Key)
if err != nil {
mw.unauthorized(c, http.StatusUnauthorized, "Create JWT Token faild")
return
}
c.JSON(http.StatusOK, gin.H{
"token": tokenString,
"expire": expire.Format(time.RFC3339),
})
}
// RefreshHandler can be used to refresh a token. The token still needs to be valid on refresh.
// Shall be put under an endpoint that is using the GinJWTMiddleware.
// Reply will be of the form {"token": "TOKEN"}.
func (mw *GinJWTMiddleware) RefreshHandler(c *gin.Context) {
token, _ := mw.parseToken(c)
claims := token.Claims.(jwt.MapClaims)
origIat := int64(claims["orig_iat"].(float64))
if origIat < time.Now().Add(-mw.MaxRefresh).Unix() {
mw.unauthorized(c, http.StatusUnauthorized, "Token is expired.")
return
}
// Create the token
newToken := jwt.New(jwt.GetSigningMethod(mw.SigningAlgorithm))
newClaims := newToken.Claims.(jwt.MapClaims)
for key := range claims {
newClaims[key] = claims[key]
}
expire := time.Now().Add(mw.Timeout)
newClaims["id"] = claims["id"]
newClaims["exp"] = expire.Unix()
newClaims["orig_iat"] = origIat
tokenString, err := newToken.SignedString(mw.Key)
if err != nil {
mw.unauthorized(c, http.StatusUnauthorized, "Create JWT Token faild")
return
}
c.JSON(http.StatusOK, gin.H{
"token": tokenString,
"expire": expire.Format(time.RFC3339),
})
}
// ExtractClaims help to extract the JWT claims
func ExtractClaims(c *gin.Context) jwt.MapClaims {
if _, exists := c.Get("JWT_PAYLOAD"); !exists {
emptyClaims := make(jwt.MapClaims)
return emptyClaims
}
jwtClaims, _ := c.Get("JWT_PAYLOAD")
return jwtClaims.(jwt.MapClaims)
}
// TokenGenerator handler that clients can use to get a jwt token.
func (mw *GinJWTMiddleware) TokenGenerator(userID string) string {
token := jwt.New(jwt.GetSigningMethod(mw.SigningAlgorithm))
claims := token.Claims.(jwt.MapClaims)
if mw.PayloadFunc != nil {
for key, value := range mw.PayloadFunc(userID) {
claims[key] = value
}
}
claims["id"] = userID
claims["exp"] = time.Now().Add(mw.Timeout).Unix()
claims["orig_iat"] = time.Now().Unix()
tokenString, _ := token.SignedString(mw.Key)
return tokenString
}
func (mw *GinJWTMiddleware) parseToken(c *gin.Context) (*jwt.Token, error) {
authHeader := c.Request.Header.Get("Authorization")
if authHeader == "" {
return nil, errors.New("Auth header empty")
}
parts := strings.SplitN(authHeader, " ", 2)
if !(len(parts) == 2 && parts[0] == "Bearer") {
return nil, errors.New("Invalid auth header")
}
return jwt.Parse(parts[1], func(token *jwt.Token) (interface{}, error) {
if jwt.GetSigningMethod(mw.SigningAlgorithm) != token.Method {
return nil, errors.New("Invalid signing algorithm")
}
return mw.Key, nil
})
}
func (mw *GinJWTMiddleware) unauthorized(c *gin.Context, code int, message string) {
c.Header("WWW-Authenticate", "JWT realm="+mw.Realm)
c.Abort()
mw.Unauthorized(c, code, message)
return
}