feat: add TimeFunc provides the current time. (#67)

* feat: add TimeFunc provides the current time.

* fix: example

* fix: update readme.

Author: appleboy

README.md

@@ -108,6 +108,9 @@ func main() {
 
 		// TokenHeadName is a string in the header. Default value is "Bearer"
 		TokenHeadName: "Bearer",
+
+		// TimeFunc provides the current time. You can override it to use another time value. This is useful for testing or if your server uses a different time zone than your tokens.
+		TimeFunc: time.Now,
 	}
 
 	r.POST("/login", authMiddleware.LoginHandler)

auth_jwt.go

@@ -70,6 +70,9 @@ type GinJWTMiddleware struct {
 
 	// TokenHeadName is a string in the header. Default value is "Bearer"
 	TokenHeadName string
+
+	// TimeFunc provides the current time. You can override it to use another time value. This is useful for testing or if your server uses a different time zone than your tokens.
+	TimeFunc func() time.Time
 }
 
 // Login form structure.
@@ -93,6 +96,10 @@ func (mw *GinJWTMiddleware) MiddlewareInit() error {
 		mw.Timeout = time.Hour
 	}
 
+	if mw.TimeFunc == nil {
+		mw.TimeFunc = time.Now
+	}
+
 	mw.TokenHeadName = strings.TrimSpace(mw.TokenHeadName)
 	if len(mw.TokenHeadName) == 0 {
 		mw.TokenHeadName = "Bearer"
@@ -207,10 +214,10 @@ func (mw *GinJWTMiddleware) LoginHandler(c *gin.Context) {
 		userID = loginVals.Username
 	}
 
-	expire := time.Now().Add(mw.Timeout)
+	expire := mw.TimeFunc().Add(mw.Timeout)
 	claims["id"] = userID
 	claims["exp"] = expire.Unix()
-	claims["orig_iat"] = time.Now().Unix()
+	claims["orig_iat"] = mw.TimeFunc().Unix()
 
 	tokenString, err := token.SignedString(mw.Key)
 
@@ -234,7 +241,7 @@ func (mw *GinJWTMiddleware) RefreshHandler(c *gin.Context) {
 
 	origIat := int64(claims["orig_iat"].(float64))
 
-	if origIat < time.Now().Add(-mw.MaxRefresh).Unix() {
+	if origIat < mw.TimeFunc().Add(-mw.MaxRefresh).Unix() {
 		mw.unauthorized(c, http.StatusUnauthorized, "Token is expired.")
 		return
 	}
@@ -247,7 +254,7 @@ func (mw *GinJWTMiddleware) RefreshHandler(c *gin.Context) {
 		newClaims[key] = claims[key]
 	}
 
-	expire := time.Now().Add(mw.Timeout)
+	expire := mw.TimeFunc().Add(mw.Timeout)
 	newClaims["id"] = claims["id"]
 	newClaims["exp"] = expire.Unix()
 	newClaims["orig_iat"] = origIat
@@ -290,8 +297,8 @@ func (mw *GinJWTMiddleware) TokenGenerator(userID string) string {
 	}
 
 	claims["id"] = userID
-	claims["exp"] = time.Now().Add(mw.Timeout).Unix()
-	claims["orig_iat"] = time.Now().Unix()
+	claims["exp"] = mw.TimeFunc().Add(mw.Timeout).Unix()
+	claims["orig_iat"] = mw.TimeFunc().Unix()
 
 	tokenString, _ := token.SignedString(mw.Key)
 

example/server.go

@@ -64,6 +64,9 @@ func main() {
 
 		// TokenHeadName is a string in the header. Default value is "Bearer"
 		TokenHeadName: "Bearer",
+
+		// TimeFunc provides the current time. You can override it to use another time value. This is useful for testing or if your server uses a different time zone than your tokens.
+		TimeFunc: time.Now,
 	}
 
 	r.POST("/login", authMiddleware.LoginHandler)