Go Gin 系列五：使用 JWT 进行身份校验

最新推荐文章于 2024-07-22 23:52:51 发布
最新推荐文章于 2024-07-22 23:52:51 发布
阅读量1.2k 收藏 3
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/EDDYCJY/article/details/106740812
版权

涉及知识点

  • JWT

本文目标

在前面几节中，我们已经基本的完成了 API's 的编写，但是，还存在一些非常严重的问题，例如，我们现在的 API 是可以随意调用的，这显然还不安全全，在本文中我们通过 jwt-go （GoDoc）的方式来简单解决这个问题。

下载依赖包

首先，我们下载 jwt-go 的依赖包，如下：

go get -u github.com/dgrijalva/jwt-go

编写 jwt 工具包

我们需要编写一个jwt的工具包，我们在pkg下的util目录新建jwt.go，写入文件内容：

package util


import (
	"time"


	jwt "github.com/dgrijalva/jwt-go"


	"github.com/EDDYCJY/go-gin-example/pkg/setting"
)


var jwtSecret = []byte(setting.JwtSecret)


type Claims struct {
	Username string `json:"username"`
	Password string `json:"password"`
	jwt.StandardClaims
}


func GenerateToken(username, password string) (string, error) {
	nowTime := time.Now()
	expireTime := nowTime.Add(3 * time.Hour)


	claims := Claims{
		username,
		password,
		jwt.StandardClaims {
			ExpiresAt : expireTime.Unix(),
			Issuer : "gin-blog",
		},
	}


	tokenClaims := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
	token, err := tokenClaims.SignedString(jwtSecret)


	return token, err
}


func ParseToken(token string) (*Claims, error) {
	tokenClaims, err := jwt.ParseWithClaims(token, &Claims{}, func(token *jwt.Token) (interface{}, error) {
		return jwtSecret, nil
	})


	if tokenClaims != nil {
		if claims, ok := tokenClaims.Claims.(*Claims); ok && tokenClaims.Valid {
			return claims, nil
		}
	}


	return nil, err
}

在这个工具包，我们涉及到

  • NewWithClaims(method SigningMethod, claims Claims)，method对应着SigningMethodHMAC struct{}，其包含SigningMethodHS256、SigningMethodHS384、SigningMethodHS512三种crypto.Hash方案

  • func (t *Token) SignedString(key interface{}) 该方法内部生成签名字符串，再用于获取完整、已签名的token

  • func (p *Parser) ParseWithClaims 用于解析鉴权的声明，方法内部主要是具体的解码和校验的过程，最终返回*Token

  • func (m MapClaims) Valid() 验证基于时间的声明exp, iat, nbf，注意如果没有任何声明在令牌中，仍然会被认为是有效的。并且对于时区偏差没有计算方法

有了jwt工具包，接下来我们要编写要用于Gin的中间件，我们在middleware下新建jwt目录，新建jwt.go文件，写入内容：

package jwt


import (
	"time"
	"net/http"


	"github.com/gin-gonic/gin"


	"github.com/EDDYCJY/go-gin-example/pkg/util"
	"github.com/EDDYCJY/go-gin-example/pkg/e"
)


func JWT() gin.HandlerFunc {
	return func(c *gin.Context) {
		var code int
		var data interface{}


		code = e.SUCCESS
		token := c.Query("token")
		if token == "" {
			code = e.INVALID_PARAMS
		} else {
			claims, err := util.ParseToken(token)
			if err != nil {
				code = e.ERROR_AUTH_CHECK_TOKEN_FAIL
			} else if time.Now().Unix() > claims.ExpiresAt {
				code = e.ERROR_AUTH_CHECK_TOKEN_TIMEOUT
			}
		}


		if code != e.SUCCESS {
			c.JSON(http.StatusUnauthorized, gin.H{
		        "code" : code,
		        "msg" : e.GetMsg(code),
		        "data" : data,
		    })


		    c.Abort()
		    return
		}


		c.Next()
	}
}

如何获取Token

那么我们如何调用它呢，我们还要获取Token呢？

1、 我们要新增一个获取Token的 API

在models下新建auth.go文件，写入内容：

package models


type Auth struct {
	ID int `gorm:"primary_key" json:"id"`
	Username string `json:"username"`
	Password string `json:"password"`
}


func CheckAuth(username, password string) bool {
	var auth Auth
	db.Select("id").Where(Auth{Username : username, Password : password}).First(&auth)
	if auth.ID > 0 {
		return true
	}


	return false
}

在routers下的api目录新建auth.go文件，写入内容：

package api


import (
	"log"
	"net/http"


	"github.com/gin-gonic/gin"
	"github.com/astaxie/beego/validation"


	"github.com/EDDYCJY/go-gin-example/pkg/e"
	"github.com/EDDYCJY/go-gin-example/pkg/util"
	"github.com/EDDYCJY/go-gin-example/models"
)


type auth struct {
	Username string `valid:"Required; MaxSize(50)"`
	Password string `valid:"Required; MaxSize(50)"`
}


func GetAuth(c *gin.Context) {
	username := c.Query("username")
	password := c.Query("password")


	valid := validation.Validation{}
	a := auth{Username: username, Password: password}
	ok, _ := valid.Valid(&a)


	data := make(map[string]interface{})
	code := e.INVALID_PARAMS
	if ok {
		isExist := models.CheckAuth(username, password)
		if isExist {
			token, err := util.GenerateToken(username, password)
			if err != nil {
				code = e.ERROR_AUTH_TOKEN
			} else {
				data["token"] = token


				code = e.SUCCESS
			}


		} else {
			code = e.ERROR_AUTH
		}
	} else {
		for _, err := range valid.Errors {
            log.Println(err.Key, err.Message)
        }
	}


	c.JSON(http.StatusOK, gin.H{
        "code" : code,
        "msg" : e.GetMsg(code),
        "data" : data,
    })
}

我们打开routers目录下的router.go文件，修改文件内容（新增获取 token 的方法）：

package routers


import (
    "github.com/gin-gonic/gin"


    "github.com/EDDYCJY/go-gin-example/routers/api"
    "github.com/EDDYCJY/go-gin-example/routers/api/v1"
    "github.com/EDDYCJY/go-gin-example/pkg/setting"
)


func InitRouter() *gin.Engine {
    r := gin.New()


    r.Use(gin.Logger())


    r.Use(gin.Recovery())


    gin.SetMode(setting.RunMode)


    r.GET("/auth", api.GetAuth)


    apiv1 := r.Group("/api/v1")
    {
        ...
    }


    return r
}

验证Token

获取token的 API 方法就到这里啦，让我们来测试下是否可以正常使用吧！

重启服务后，用GET方式访问http://127.0.0.1:8000/auth?username=test&password=test123456，查看返回值是否正确

{
  "code": 200,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJwYXNzd29yZCI6InRlc3QxMjM0NTYiLCJleHAiOjE1MTg3MjAwMzcsImlzcyI6Imdpbi1ibG9nIn0.-kK0V9E06qTHOzupQM_gHXAGDB3EJtJS4H5TTCyWwW8"
  },
  "msg": "ok"
}

我们有了token的 API，也调用成功了

将中间件接入Gin

2、 接下来我们将中间件接入到Gin的访问流程中

我们打开routers目录下的router.go文件，修改文件内容（新增引用包和中间件引用）

package routers


import (
    "github.com/gin-gonic/gin"


    "github.com/EDDYCJY/go-gin-example/routers/api"
    "github.com/EDDYCJY/go-gin-example/routers/api/v1"
    "github.com/EDDYCJY/go-gin-example/pkg/setting"
    "github.com/EDDYCJY/go-gin-example/middleware/jwt"
)


func InitRouter() *gin.Engine {
    r := gin.New()


    r.Use(gin.Logger())


    r.Use(gin.Recovery())


    gin.SetMode(setting.RunMode)


    r.GET("/auth", api.GetAuth)


    apiv1 := r.Group("/api/v1")
    apiv1.Use(jwt.JWT())
    {
        ...
    }


    return r
}

当前目录结构：

go-gin-example/
├── conf
│   └── app.ini
├── main.go
├── middleware
│   └── jwt
│       └── jwt.go
├── models
│   ├── article.go
│   ├── auth.go
│   ├── models.go
│   └── tag.go
├── pkg
│   ├── e
│   │   ├── code.go
│   │   └── msg.go
│   ├── setting
│   │   └── setting.go
│   └── util
│       ├── jwt.go
│       └── pagination.go
├── routers
│   ├── api
│   │   ├── auth.go
│   │   └── v1
│   │       ├── article.go
│   │       └── tag.go
│   └── router.go
├── runtime

到这里，我们的JWT编写就完成啦！

验证功能

我们来测试一下，再次访问

  • http://127.0.0.1:8000/api/v1/articles

  • http://127.0.0.1:8000/api/v1/articles?token=23131

正确的反馈应该是

{
  "code": 400,
  "data": null,
  "msg": "请求参数错误"
}


{
  "code": 20001,
  "data": null,
  "msg": "Token鉴权失败"
}

我们需要访问http://127.0.0.1:8000/auth?username=test&password=test123456，得到token

{
  "code": 200,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJwYXNzd29yZCI6InRlc3QxMjM0NTYiLCJleHAiOjE1MTg3MjQ2OTMsImlzcyI6Imdpbi1ibG9nIn0.KSBY6TeavV_30kfmP7HWLRYKP5TPEDgHtABe9HCsic4"
  },
  "msg": "ok"
}

再用包含token的 URL 参数去访问我们的应用 API，

访问http://127.0.0.1:8000/api/v1/articles?token=eyJhbGci...，检查接口返回值

{
  "code": 200,
  "data": {
    "lists": [
      {
        "id": 2,
        "created_on": 1518700920,
        "modified_on": 0,
        "tag_id": 1,
        "tag": {
          "id": 1,
          "created_on": 1518684200,
          "modified_on": 0,
          "name": "tag1",
          "created_by": "",
          "modified_by": "",
          "state": 0
        },
        "content": "test-content",
        "created_by": "test-created",
        "modified_by": "",
        "state": 0
      }
    ],
    "total": 1
  },
  "msg": "ok"
}

返回正确，至此我们的jwt-go在Gin中的验证就完成了！

参考

本系列示例代码

  • go-gin-example

我的公众号

煎鱼（EDDYCJY）
关注
12、Go Gin使用JWT实现认证机制
qq_39335595的博客
05-15 2062
JWT是JSON Web Token的缩写，是一种跨域认证的解决方案。import ("log"return nil//密钥Username: "小明",Gender: "男",if err!= nil {log.Fatal("签署JET时错误", err)在自定义结构中使用JWT标准中定义的字段*jwt.StandardClaims//标准字段。
在Gin中使用JWT做认证以及JWT的续签方案
Monkey_D_Newdun的博客
01-31 2844
记录了一下在Gin中简单的使用JWT，并且想了一个简单的Token续签方案，不需要服务端保存Token的状态，前端也不需要过多的配合
Gin jwt
JunChow
04-23 320
在线解析Token：https://jwt.io/ JWT(JSON Web Token)是为了在网路应用环境之间传递声明而执行的一种基于JSON的开放标准(RFC7519)JWT是一个非常轻巧的规范，该规范允许使用Token在客户端和服务端之间传递安全可靠的信息。 JWT的Token被设计为紧凑且安全的，因此特别适用于分布式站点的单点登录(SSO)场景。JWT的Token可直接被用于认证，...
go语言Gin框架的学习路线(九)
最新发布
juzihuaile的博客
07-22 1256
期末放假在家自学Gin框架,希望我们可以一起学习!
go/gin使用jwt
01-12 757
1、安装拓展包 $ go get -u github.com/dgrijalva/jwt-go 2、发放token func ReleaseToken(user *model.User) (tokenString string,err error) { expire := time.Now().Add(7 * 24 * time.Hour) claims := &Claims{ UserId: user.ID, StandardClaims: jwt.StandardClaim
Go Gin 中使用 JWT
u013302168的博客
08-08 1126
提供一个回调函数用于提供要选择的秘钥, 回调函数里面的token参数,是已经解析但未验证的,可以根据token里面的值做一些逻辑, 如判断kid来选用不同的secret。jwt.NewWithClaims(jwt.SigningMethodHS256, a)声明了一个签名对象, 并且指定了HS256的哈希算法。当系统接收到TOKEN时, 拿出Header和Payload的字符串用.拼接在一起之后, 用Header里面指定的哈希方法通过公式。typ则表示当前token的类型, 而JWT的类型则为jwt。
【搞定Go语言】第3天13：在gin框架中使用JWT
就叫一片白纸的博客
02-16 663
JWT全称JSON Web Token是一种跨域认证解决方案，属于一个开放的标准，它规定了一种Token实现方式，目前多用于前后端分离项目和OAuth2.0业务场景下。 什么是JWT？ JWT全称JSON Web Token是一种跨域认证解决方案，属于一个开放的标准，它规定了一种Token实现方式，目前多用于前后端分离项目和OAuth2.0业务场景下。 为什么需要JWT？ 在之前的一些web项目中，我们通常使用的是Cookie-Session模式实现用户认证。相关流程大致如下： 用户在浏览器端填写用户名和密
Gin(十二):JWT使用
代码猎奇站
08-09 1198
在前后端分离的项目中，越来越多的项目采用 JWT 代替传统的 cookie ，这里我们来使用 JWT 结合 Gin 来作为一个登录授权和权限校验。
Golang：BasicAuth + JWT 校验用户权限
HTK217的博客
03-09 1976
为什么需要权限 在平常浏览网页中，大多数网站对用户分为游客和普通用户，还有会员，那么游客浏览一些网页需要登录才能看到，普通用户查看一些帖子需要积分，而会员则像是开了一条绿色通道，什么都能访问，这就是权限的作用 使用 BasicAuth 认证 BasicAuth 是开放平台的认证方式，每次访问 API 都会携带 用户的 username 和 password 认证，那么 BasicAuth 会对 u...
Gin(十五):JWT使用续
代码猎奇站
11-04 828
原文首发 https://youngxhui.top Gin 教程叕来了（说好的大结局呢？），这次主要是来说明 JWT 存在的一些问题和解决方案。如果你还不知道 JWT 是什么，建议了解一下，也可以翻翻前面的文章看看。 ????问题所在 上次写 JWT 的时候，和群里的小伙伴讨论，有小伙伴提出了一些问题，用户修改密码或者注销账户怎么办？ 是啊，怎么办？ 我们都知道 JWT 是否有效，靠的是失效时间，而且...
Go-Gin-使用jwt进行token登录校验Vue
qq_53481873的博客
10-22 1176
go
go gin
qq_34103387的博客
02-01 202
gin类似java 的springmvc,接收请求 1.参考野中文文档 https://www.kancloud.cn/shuangdeyu/gin_book/949413 2. 添加引用 github.com/gin-gonic/gin 3.样例 func main() { // Disable Console Color // gin.DisableConsoleColor() // 使用默认中间件创建一个gin路由器 // logger and recovery (crash-free
Go: Gin
Huntinux
03-29 547
0. 简介 Gin是一个使用golang编写的HTTP web框架，主页在此： https://github.com/gin-gonic/gin 1. 使用记录 1.1 POST binding tag 加入太多tab会有问题，目前只加一个空格没有什么问题，就是格式上有点丑，尚不清楚原因。 1.2 Database http://www.01happy.co...
go--gin
Yu的博客
01-17 768
1.下载与安装:$ go get github.com/gin-gonic/gin2.导入：     import "github.com/gin-gonic/gin"3.  请求方式：GET、POST、PUT、PATCH、DELETE、OPTIONS4.得到默认路由：   router := gin.Default()5.路径上的参数：router.GET("/user/:name") fu
Go的Gin框架拦截器实现登录认证结合JWT实现会话记录
个人学习笔记库，一篇一篇记录成长的足迹
04-17 2380
jwt会话技术替代session技术，go语言的演示及代码编写，使用gin web框架完成。
Go语言gin框架+gorm框架项目：使用jwt发放token，使用中间件实现用户认证以及以及封装http返回格式
pyscl01的博客
04-19 2525
Go语言gin框架项目：使用jwt发放token，使用中间件实现用户认证以及封装http返回
GO语言gin框架实战-02-Jwt和登录认证
运维玄德公
10-24 1651
1. 相关函数 2. router对其调用 3. 其他接口身份验证 4. postman 测试 4.1 测试登录接口 4.2 postman设置Cookies 4.3 其他接口调用身份验证测试
go使用gin结合jwt做登录功能
anxiaoxiao61的博客
07-23 1016
【代码】go使用gin结合jwt做登录功能。
[GO] Gin入门
Q先生
12-09 1720
[GO] Gin入门
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值