• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

gtoken: 基于gf框架的token插件,通过服务端验证方式实现token认证;已完全可以支撑线 ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

gtoken

开源软件地址:

https://gitee.com/goflyfox/gtoken

开源软件介绍:

gtoken

介绍

基于GoFrame框架的token插件,通过服务端验证方式实现token认证;已完全可以支撑线上token认证,通过Redis支持集群模式;使用简单,大家可以放心使用;

全面适配GoFrame v2.0.0 ; GoFrame v1.X.X 请使用gtoken v1.4.X相关版本;

gtoken优势

  1. gtoken支撑单点应用测试使用内存存储,支持个人项目文件存储,也支持企业集群使用redis存储;完全适用于企业生产级使用;
  2. 有效的避免了jwt服务端无法退出问题;
  3. 解决jwt无法作废已颁布的令牌,只能等到令牌过期问题;
  4. 通过用户扩展信息存储在服务端,有效规避了jwt携带大量用户扩展信息导致降低传输效率问题;
  5. 有效避免jwt需要客户端实现续签功能,增加客户端复杂度;支持服务端自动续期,客户端不需要关心续签逻辑;

特性说明

  1. 支持token认证,不强依赖于session和cookie,适用jwt和session认证所有场景;
  2. 支持单机gcache和集群gredis模式;
# 缓存模式 1 gcache 2 gredis 3 fileCacheCacheMode = 2
  1. 支持服务端缓存自动续期功能
// 注:通过MaxRefresh,默认当用户第五天访问时,自动续期// 超时时间 默认10天Timeout int// 缓存刷新时间 默认为超时时间的一半MaxRefresh int
  1. 支持分组拦截、全局拦截、深度路径拦截,便于根据个人需求定制拦截器;建议使用分组拦截方式;
  2. 框架使用简单,只需要设置登录验证方法以及登录、登出路径即可;
  3. gtoken v1.4.0版本开始支持分组中间件方式实现,但依然兼容全局和深度中间件实现方式;
  4. gtoken v1.5.0全面适配GoFrame v2.0.0 ; GoFrame v1.X.X 请使用GfToken v1.4.X相关版本;

安装教程

  • gopath模式: go get github.com/goflyfox/gtoken
  • 或者 使用go.mod添加 :require github.com/goflyfox/gtoken latest

分组中间件实现

GoFrame官方推荐使用Group方式实现路由和中间件;

使用说明

推荐使用分组方式实现

	// 启动gtoken	gfToken := &gtoken.GfToken{		LoginPath:        "/login",		LoginBeforeFunc:  loginFunc,		LogoutPath:       "/user/logout",	}	s.Group("/admin", func(group *ghttp.RouterGroup) {		group.Middleware(CORS)		gfToken.Middleware(group)		group.ALL("/system/user", func(r *ghttp.Request) {			r.Response.WriteJson(gtoken.Succ("system user"))		})		………………	})

登录方法实现,通过username返回空或者r.ExitAll()\r.Exit()处理认证失败;

特别提示:这里注册的路径严格按照GF group方式,所以注册的路径是/admin/login/admin/user/logout

func Login(r *ghttp.Request) (string, interface{}) {	username := r.GetPostString("username")	passwd := r.GetPostString("passwd")	// TODO 进行登录校验	if username == "" || passwd == "" {		r.Response.WriteJson(gtoken.Fail("账号或密码错误."))		r.ExitAll()	}		// 第一个字段是用户唯一标识,第二个字段是扩展参数user data	return username, ""}

通过gtoken.GetTokenData(r)获取登录信息

路径拦截规则

    AuthExcludePaths: g.SliceStr{"/user/info", "/system/user/*"}, // 不拦截路径  /user/info,/system/user/info,/system/user,
  1. 分组中间件实现,不需要设置AuthPaths认证路径,设置也没有作用,需要认证路径为该分组下所有路由
  2. 使用分组拦截的是通过GoFrame的group.Middleware(authMiddleware)方法,对该分组下的所有路由进行拦截;
  3. 对登录接口路径loginPath和登出接口路径logoutPath做拦截认证放行,登出放行是为了避免认证过期无法登出情况;
  4. 严格按照GoFrame分组中间件拦截优先级;如果使用跨域中间件,建议放在跨域中间件之后;
  5. 如果配置AuthExcludePaths路径,会将配置的不拦截路径排除;

逻辑测试

参考sample项目,先运行main.go,然后可运行api_test.go进行测试并查看结果;验证逻辑说明:

  1. 访问用户信息,提示未携带token
  2. 调用登录后,携带token访问正常
  3. 调用登出提示成功
  4. 携带之前token访问,提示未登录
=== RUN   TestAdminSystemUser    api_admin_test.go:22: 1. not login and visit user    api_admin_test.go:29: {"code":-401,"msg":"请求错误或登录超时","data":""}    api_admin_test.go:42: 2. execute login and visit user    api_admin_test.go:45: {"code":0,"msg":"success","data":"system user"}    api_admin_test.go:51: 3. execute logout    api_admin_test.go:54: {"code":0,"msg":"success","data":"Logout success"}    api_admin_test.go:60: 4. visit user    api_admin_test.go:65: {"code":-401,"msg":"请求错误或登录超时","data":""}

全局中间件实现

使用说明

只需要配置登录路径、登出路径、拦截路径以及登录校验实现即可

	// 启动gtoken	gtoken := &gtoken.GfToken{		LoginPath:       "/login",		LoginBeforeFunc: loginFunc,		LogoutPath:      "/user/logout",		AuthPaths:        g.SliceStr{"/user", "/system"}, // 这里是按照前缀拦截,拦截/user /user/list /user/add ...		GlobalMiddleware: true,                           // 开启全局拦截,默认关闭	}	gtoken.Start()

登录方法实现,通过username返回空或者r.ExitAll()\r.Exit()处理认证失败;

func Login(r *ghttp.Request) (string, interface{}) {	username := r.GetPostString("username")	passwd := r.GetPostString("passwd")	// TODO 进行登录校验	if username == "" || passwd == "" {		r.Response.WriteJson(gtoken.Fail("账号或密码错误."))		r.ExitAll()	}		// 第一个字段是用户唯一标识,第二个字段是扩展参数user data	return username, ""}

通过gtoken.GetTokenData(r)获取登录信息

路径拦截规则

    AuthPaths:        g.SliceStr{"/user", "/system"},             // 这里是按照前缀拦截,拦截/user /user/list /user/add ...    AuthExcludePaths: g.SliceStr{"/user/info", "/system/user/*"}, // 不拦截路径  /user/info,/system/user/info,/system/user,    GlobalMiddleware: true,                           // 开启全局拦截,默认关闭
  1. GlobalMiddleware:true全局拦截的是通过GF的BindMiddleware方法创建拦截/*
  2. GlobalMiddleware:false路径拦截的是通过GF的BindMiddleware方法创建拦截/user*和/system/*
  3. 按照中间件优先级路径拦截优先级很高;如果先实现部分中间件在认证前处理需要切换成全局拦截器,严格按照注册顺序即可;
  4. 程序先处理认证路径,如果满足;再排除不拦截路径;
  5. 如果只想用排除路径功能,将拦截路径设置为/*即可;

逻辑测试

参考sample1项目,先运行main.go,然后可运行api_test.go进行测试并查看结果;验证逻辑说明:

  1. 访问用户信息,提示未携带token
  2. 调用登录后,携带token访问正常
  3. 调用登出提示成功
  4. 携带之前token访问,提示未登录
=== RUN   TestSystemUser    api_test.go:43: 1. not login and visit user    api_test.go:50: {"code":-401,"msg":"请求错误或登录超时","data":""}    api_test.go:63: 2. execute login and visit user    api_test.go:66: {"code":0,"msg":"success","data":"system user"}    api_test.go:72: 3. execute logout    api_test.go:75: {"code":0,"msg":"success","data":"Logout success"}    api_test.go:81: 4. visit user    api_test.go:86: {"code":-401,"msg":"请求错误或登录超时","data":""}

返回码及配置项

  1. 正常操作成功返回0
  2. 未登录访问需要登录资源返回401
  3. 程序异常返回-99,如编解码错误等
SUCCESS      = 0  // 正常FAIL         = -1  // 失败ERROR        = -99  // 异常UNAUTHORIZED = -401  // 未认证

配置项说明

具体可参考GfToken结构体,字段解释如下:

名称配置字段说明分组中间件全局中间件
服务名ServerName默认空即可支持支持
缓存模式CacheMode1 gcache 2 gredis 3 fileCache 默认1支持支持
缓存keyCacheKey默认缓存前缀GToken:支持支持
超时时间Timeout默认10天(毫秒)支持支持
缓存刷新时间MaxRefresh默认为超时时间的一半(毫秒)支持支持
Token分隔符TokenDelimiter默认_支持支持
Token加密keyEncryptKey默认12345678912345678912345678912345支持支持
认证失败提示AuthFailMsg默认请求错误或登录超时支持支持
是否支持多端登录MultiLogin默认false支持支持
中间件类型MiddlewareType1、Group 2、Bind 3 、Global;
使用分组模式不需要设置
支持支持
登录路径LoginPath登录接口路径支持支持
登录验证方法LoginBeforeFunc登录验证需要用户实现方法支持支持
登录返回方法LoginAfterFunc登录完成后调用支持支持
登出地址LogoutPath登出接口路径支持支持
登出验证方法LogoutBeforeFunc登出接口前调用支持支持
登出返回方法LogoutAfterFunc登出接口完成后调用支持支持
拦截地址AuthPaths此路径列表进行认证不需要支持
拦截排除地址AuthExcludePaths此路径列表不进行认证支持支持
认证验证方法AuthBeforeFunc拦截认证前后调用支持支持
认证返回方法AuthAfterFunc拦截认证完成后调用支持支持

文档

https://goframe.org/pages/viewpage.action?pageId=1115974

感谢

  1. gf框架 https://github.com/gogf/gf

项目支持

jflyfox


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap