Merge pull request #34 from appleboy/v2

Support jwt-go v3.

Author: appleboy

README.md

@@ -8,7 +8,23 @@ It uses [jwt-go](https://github.com/dgrijalva/jwt-go) to provide a jwt authentic
 
 ## Install
 
-Install gin-gwt [v1](http://gopkg.in/appleboy/gin-jwt.v1) version if `jwt-go` using [v2](http://gopkg.in/dgrijalva/jwt-go.v2) version. To get the package, execute:
+### v2 version
+
+Install gin-gwt [v2](http://gopkg.in/appleboy/gin-jwt.v2) version for `jwt-go` [v3](http://gopkg.in/dgrijalva/jwt-go.v3) version. To get the package, execute:
+
+```bash
+$ go get gopkg.in/appleboy/gin-jwt.v2
+```
+
+To import this package, add the following line to your code:
+
+```go
+import "gopkg.in/appleboy/gin-jwt.v2"
+```
+
+### v1 version
+
+Install gin-gwt [v1](http://gopkg.in/appleboy/gin-jwt.v1) version for `jwt-go` [v2](http://gopkg.in/dgrijalva/jwt-go.v2) version. To get the package, execute:
 
 ```bash
 $ go get gopkg.in/appleboy/gin-jwt.v1
@@ -28,7 +44,7 @@ Please see [server example file](example/server.go).
 package main
 
 import (
-  "gopkg.in/appleboy/gin-jwt.v1"
+  "gopkg.in/appleboy/gin-jwt.v2"
   "github.com/fvbock/endless"
   "github.com/gin-gonic/gin"
   "os"

auth_jwt.go

@@ -3,7 +3,7 @@ package jwt
 import (
 	"errors"
 	"github.com/gin-gonic/gin"
-	"gopkg.in/dgrijalva/jwt-go.v2"
+	"gopkg.in/dgrijalva/jwt-go.v3"
 	"log"
 	"net/http"
 	"strings"
@@ -123,8 +123,10 @@ func (mw *GinJWTMiddleware) middlewareImpl(c *gin.Context) {
 		return
 	}
 
-	id := token.Claims["id"].(string)
-	c.Set("JWT_PAYLOAD", token.Claims)
+	claims := token.Claims.(jwt.MapClaims)
+
+	id := claims["id"].(string)
+	c.Set("JWT_PAYLOAD", claims)
 	c.Set("userID", id)
 
 	if !mw.Authorizator(id, c) {
@@ -159,10 +161,11 @@ func (mw *GinJWTMiddleware) LoginHandler(c *gin.Context) {
 
 	// 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) {
-			token.Claims[key] = value
+			claims[key] = value
 		}
 	}
 
@@ -171,9 +174,9 @@ func (mw *GinJWTMiddleware) LoginHandler(c *gin.Context) {
 	}
 
 	expire := time.Now().Add(mw.Timeout)
-	token.Claims["id"] = userId
-	token.Claims["exp"] = expire.Unix()
-	token.Claims["orig_iat"] = time.Now().Unix()
+	claims["id"] = userId
+	claims["exp"] = expire.Unix()
+	claims["orig_iat"] = time.Now().Unix()
 
 	tokenString, err := token.SignedString(mw.Key)
 
@@ -193,8 +196,9 @@ func (mw *GinJWTMiddleware) LoginHandler(c *gin.Context) {
 // 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(token.Claims["orig_iat"].(float64))
+	origIat := int64(claims["orig_iat"].(float64))
 
 	if origIat < time.Now().Add(-mw.MaxRefresh).Unix() {
 		mw.unauthorized(c, http.StatusUnauthorized, "Token is expired.")
@@ -203,15 +207,16 @@ func (mw *GinJWTMiddleware) RefreshHandler(c *gin.Context) {
 
 	// Create the token
 	newToken := jwt.New(jwt.GetSigningMethod(mw.SigningAlgorithm))
+	newClaims := newToken.Claims.(jwt.MapClaims)
 
-	for key := range token.Claims {
-		newToken.Claims[key] = token.Claims[key]
+	for key := range claims {
+		newClaims[key] = claims[key]
 	}
 
 	expire := time.Now().Add(mw.Timeout)
-	newToken.Claims["id"] = token.Claims["id"]
-	newToken.Claims["exp"] = expire.Unix()
-	newToken.Claims["orig_iat"] = origIat
+	newClaims["id"] = claims["id"]
+	newClaims["exp"] = expire.Unix()
+	newClaims["orig_iat"] = origIat
 
 	tokenString, err := newToken.SignedString(mw.Key)
 
@@ -227,31 +232,32 @@ func (mw *GinJWTMiddleware) RefreshHandler(c *gin.Context) {
 }
 
 // ExtractClaims help to extract the JWT claims
-func ExtractClaims(c *gin.Context) map[string]interface{} {
+func ExtractClaims(c *gin.Context) jwt.MapClaims {
 
 	if _, exists := c.Get("JWT_PAYLOAD"); !exists {
-		emptyClaims := make(map[string]interface{})
+		emptyClaims := make(jwt.MapClaims)
 		return emptyClaims
 	}
 
 	jwtClaims, _ := c.Get("JWT_PAYLOAD")
 
-	return jwtClaims.(map[string]interface{})
+	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) {
-			token.Claims[key] = value
+			claims[key] = value
 		}
 	}
 
-	token.Claims["id"] = userID
-	token.Claims["exp"] = time.Now().Add(mw.Timeout).Unix()
-	token.Claims["orig_iat"] = time.Now().Unix()
+	claims["id"] = userID
+	claims["exp"] = time.Now().Add(mw.Timeout).Unix()
+	claims["orig_iat"] = time.Now().Unix()
 
 	tokenString, _ := token.SignedString(mw.Key)
 

auth_jwt_test.go

@@ -5,7 +5,7 @@ import (
 	"github.com/buger/jsonparser"
 	"github.com/gin-gonic/gin"
 	"github.com/stretchr/testify/assert"
-	"gopkg.in/dgrijalva/jwt-go.v2"
+	"gopkg.in/dgrijalva/jwt-go.v3"
 	"net/http"
 	"net/http/httptest"
 	"testing"
@@ -23,10 +23,12 @@ func makeTokenString(SigningAlgorithm string, username string) string {
 	}
 
 	token := jwt.New(jwt.GetSigningMethod(SigningAlgorithm))
-	token.Claims["id"] = username
-	token.Claims["exp"] = time.Now().Add(time.Hour).Unix()
-	token.Claims["orig_iat"] = time.Now().Unix()
+	claims := token.Claims.(jwt.MapClaims)
+	claims["id"] = username
+	claims["exp"] = time.Now().Add(time.Hour).Unix()
+	claims["orig_iat"] = time.Now().Unix()
 	tokenString, _ := token.SignedString(key)
+
 	return tokenString
 }
 
@@ -322,9 +324,10 @@ func TestExpriedTokenOnRefreshHandler(t *testing.T) {
 	r := gofight.New()
 
 	token := jwt.New(jwt.GetSigningMethod("HS256"))
-	token.Claims["id"] = "admin"
-	token.Claims["exp"] = time.Now().Add(time.Hour).Unix()
-	token.Claims["orig_iat"] = 0
+	claims := token.Claims.(jwt.MapClaims)
+	claims["id"] = "admin"
+	claims["exp"] = time.Now().Add(time.Hour).Unix()
+	claims["orig_iat"] = 0
 	tokenString, _ := token.SignedString(key)
 
 	r.GET("/auth/refresh_token").