Merge pull request #21 from arieslee/master

update goframe version to v2

Author: mingzaily

README.md

@@ -1,7 +1,7 @@
 # gf-jwt
 GF jwt plugin
 
-This plugin is forked [https://github.com/appleboy/gin-jwt](https://github.com/appleboy/gin-jwt) plugin, modified to [https://github.com/gogf/gf](https://github.com/gogf/gf) plugin.
+This plugin is forked [https://github.com/gogf/gf-jwt](https://github.com/gogf/gf-jwt) plugin, modified to [https://github.com/gogf/gf/v2](https://github.com/gogf/gf) plugin.
 
 
 [英文](README.md) [中文](README_zh.md)

README_zh.md

@@ -1,7 +1,7 @@
 # gf-jwt
 gf 的 jwt 插件。
 
-这个插件是 fork 了 [https://github.com/appleboy/gin-jwt](https://github.com/appleboy/gin-jwt) 插件,修改为 [https://github.com/gogf/gf](https://github.com/gogf/gf) 插件.
+这个插件是 fork 了 [https://github.com/gogf/gf-jwt](https://github.com/gogf/gf-jwt) 插件,修改为 [https://github.com/gogf/gf/v2](https://github.com/gogf/gf/v2) 插件.
 
 
 [英文](README.md) [中文](README_zh.md)

auth_error.go

@@ -3,6 +3,9 @@ package jwt
 import "errors"
 
 var (
+	// ErrMissingContext indicates Context is required
+	ErrMissingContext = errors.New("context is required")
+
 	// ErrMissingSecretKey indicates Secret key is required
 	ErrMissingSecretKey = errors.New("secret key is required")
 

auth_jwt.go

@@ -1,17 +1,18 @@
 package jwt
 
 import (
+	"context"
 	"crypto/rsa"
+	"github.com/gogf/gf/v2/crypto/gmd5"
+	"github.com/gogf/gf/v2/frame/g"
+	"github.com/gogf/gf/v2/net/ghttp"
+	"github.com/gogf/gf/v2/os/gcache"
 	"io/ioutil"
 	"net/http"
 	"strings"
 	"time"
-	
+
 	"github.com/dgrijalva/jwt-go"
-	"github.com/gogf/gf/crypto/gmd5"
-	"github.com/gogf/gf/frame/g"
-	"github.com/gogf/gf/net/ghttp"
-	"github.com/gogf/gf/os/gcache"
 )
 
 // MapClaims type that uses the map[string]interface{} for JSON decoding
@@ -133,6 +134,8 @@ type GfJWTMiddleware struct {
 
 	// CacheAdapter
 	CacheAdapter gcache.Adapter
+	// context
+	Ctx context.Context
 }
 
 var (
@@ -154,7 +157,10 @@ func New(m *GfJWTMiddleware) (*GfJWTMiddleware, error) {
 
 	return m, nil
 }
-
+func (mw *GfJWTMiddleware) SetCtx(ctx context.Context) *GfJWTMiddleware {
+	mw.Ctx = ctx
+	return mw
+}
 func (mw *GfJWTMiddleware) readKeys() error {
 	err := mw.privateKey()
 	if err != nil {
@@ -203,7 +209,9 @@ func (mw *GfJWTMiddleware) usingPublicKeyAlgo() bool {
 
 // MiddlewareInit initialize jwt configs.
 func (mw *GfJWTMiddleware) MiddlewareInit() error {
-
+	if mw.Ctx == nil {
+		return ErrMissingContext
+	}
 	if mw.TokenLookup == "" {
 		mw.TokenLookup = "header:Authorization"
 	}
@@ -373,7 +381,7 @@ func (mw *GfJWTMiddleware) GetClaimsFromJWT(r *ghttp.Request) (MapClaims, string
 	}
 
 	if mw.SendAuthorization {
-		token := r.GetString(TokenKey)
+		token := r.Get(TokenKey).String()
 		if len(token) > 0 {
 			r.Header.Set("Authorization", mw.TokenHeadName+" "+token)
 		}
@@ -594,7 +602,7 @@ func (mw *GfJWTMiddleware) jwtFromHeader(r *ghttp.Request, key string) (string,
 }
 
 func (mw *GfJWTMiddleware) jwtFromQuery(r *ghttp.Request, key string) (string, error) {
-	token := r.GetString(key)
+	token := r.Get(key).String()
 
 	if token == "" {
 		return "", ErrEmptyQueryToken
@@ -604,7 +612,7 @@ func (mw *GfJWTMiddleware) jwtFromQuery(r *ghttp.Request, key string) (string, e
 }
 
 func (mw *GfJWTMiddleware) jwtFromCookie(r *ghttp.Request, key string) (string, error) {
-	cookie := r.Cookie.Get(key)
+	cookie := r.Cookie.Get(key).String()
 
 	if cookie == "" {
 		return "", ErrEmptyCookieToken
@@ -614,7 +622,7 @@ func (mw *GfJWTMiddleware) jwtFromCookie(r *ghttp.Request, key string) (string,
 }
 
 func (mw *GfJWTMiddleware) jwtFromParam(r *ghttp.Request, key string) (string, error) {
-	token := r.GetString(key)
+	token := r.Get(key).String()
 	if token == "" {
 		return "", ErrEmptyParamToken
 	}
@@ -689,7 +697,7 @@ func (mw *GfJWTMiddleware) setBlacklist(token string, claims jwt.MapClaims) erro
 	duration := time.Unix(exp, 0).Add(mw.MaxRefresh).Sub(mw.TimeFunc()).Truncate(time.Second)
 
 	// global gcache
-	err = blacklist.Set(token, true, duration)
+	err = blacklist.Set(mw.Ctx, token, true, duration)
 
 	if err != nil {
 		return err
@@ -707,7 +715,7 @@ func (mw *GfJWTMiddleware) inBlacklist(token string) (bool, error) {
 	}
 
 	// Global gcache
-	if in, err := blacklist.Contains(tokenRaw); err != nil {
+	if in, err := blacklist.Contains(mw.Ctx, tokenRaw); err != nil {
 		return false, nil
 	} else {
 		return in, nil
@@ -716,16 +724,15 @@ func (mw *GfJWTMiddleware) inBlacklist(token string) (bool, error) {
 
 // ExtractClaims help to extract the JWT claims
 func ExtractClaims(r *ghttp.Request) MapClaims {
-	claims := r.GetParam(PayloadKey)
+	claims := r.GetParam(PayloadKey).Interface()
 	return claims.(MapClaims)
 }
 
 // GetToken help to get the JWT token string
 func GetToken(r *ghttp.Request) string {
-	token := r.GetString(TokenKey)
+	token := r.Get(TokenKey).String()
 	if len(token) == 0 {
 		return ""
 	}
-
 	return token
 }

example/api/auth.go

@@ -4,16 +4,17 @@ import (
 	jwt "github.com/gogf/gf-jwt"
 	"github.com/gogf/gf-jwt/example/model"
 	"github.com/gogf/gf-jwt/example/service"
-	"github.com/gogf/gf/frame/g"
-	"github.com/gogf/gf/net/ghttp"
-	"github.com/gogf/gf/os/glog"
-	"github.com/gogf/gf/util/gconv"
+	"github.com/gogf/gf/v2/frame/g"
+	"github.com/gogf/gf/v2/net/ghttp"
+	"github.com/gogf/gf/v2/os/gctx"
+	"github.com/gogf/gf/v2/os/glog"
+	"github.com/gogf/gf/v2/util/gconv"
 	"net/http"
 	"time"
 )
 
 var (
-	// The underlying JWT middleware.
+	// Auth The underlying JWT middleware.
 	Auth *jwt.GfJWTMiddleware
 )
 
@@ -36,9 +37,10 @@ func init() {
 		Unauthorized:    Unauthorized,
 		PayloadFunc:     PayloadFunc,
 		IdentityHandler: IdentityHandler,
+		Ctx:             gctx.New(),
 	})
 	if err != nil {
-		glog.Fatal("JWT Error:" + err.Error())
+		glog.Fatal(authMiddleware.Ctx, "JWT Error:"+err.Error())
 	}
 	Auth = authMiddleware
 }

example/api/work.go

@@ -1,15 +1,15 @@
 package api
 
 import (
-	"github.com/gogf/gf/frame/g"
-	"github.com/gogf/gf/net/ghttp"
+	"github.com/gogf/gf/v2/frame/g"
+	"github.com/gogf/gf/v2/net/ghttp"
 )
 
 var Work = new(workApi)
 
 type workApi struct{}
 
-// works is the default router handler for web server.
+// Works works is the default router handler for web server.
 func (a *workApi) Works(r *ghttp.Request) {
 	data := g.Map{
 		"message": "It works!",

example/main.go

@@ -3,8 +3,8 @@ package main
 import (
 	"github.com/gogf/gf-jwt/example/api"
 	"github.com/gogf/gf-jwt/example/service"
-	"github.com/gogf/gf/frame/g"
-	"github.com/gogf/gf/net/ghttp"
+	"github.com/gogf/gf/v2/frame/g"
+	"github.com/gogf/gf/v2/net/ghttp"
 )
 
 // authHook is the HOOK function implements JWT logistics.

example/service/middleware.go

@@ -1,12 +1,10 @@
 package service
 
-import (
-	"github.com/gogf/gf/net/ghttp"
-)
+import "github.com/gogf/gf/v2/net/ghttp"
 
 var Middleware = new(middlewareService)
 
-type middlewareService struct {}
+type middlewareService struct{}
 
 func (s *middlewareService) CORS(r *ghttp.Request) {
 	r.Response.CORSDefault()

example/service/user.go

@@ -2,7 +2,7 @@ package service
 
 import (
 	"github.com/gogf/gf-jwt/example/model"
-	"github.com/gogf/gf/frame/g"
+	"github.com/gogf/gf/v2/frame/g"
 )
 
 var User = new(userService)

go.mod

@@ -2,8 +2,8 @@ module github.com/gogf/gf-jwt
 
 require (
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
-	github.com/gogf/gf v1.15.3
+	github.com/gogf/gf/v2 v2.0.0-rc2.0.20220217150450-7812f41b4395
 	github.com/mattn/go-runewidth v0.0.12 // indirect
 )
 
-go 1.10
+go 1.15