golang原生实现JWT的示例代码

 更新时间:2023年05月05日 11:23:47   作者:coderDreams  
在Go中实现JWT验证,可以通过标准库crypto/hmac、crypto/sha256和encoding/base64来编写自己的JWT,本文就详细的来介绍一下,感兴趣的可以了解下

JWT(JSON Web Token)是一种基于JSON的安全令牌,可以用于在不同系统之间传输认证信息。在Go中实现JWT验证,可以通过标准库crypto/hmaccrypto/sha256encoding/base64来编写自己的JWT。

获取Token

我们在此封装一个JWT的struct结构体(由于除了Payload,其他很大可能不会在其他地方用到,所以不公开)

type JWT struct {
    header    string
    Payload   string
    signature string
}

将base64的编码封装一下方便使用

func encodeBase64(data string) string {
	return base64.RawURLEncoding.EncodeToString([]byte(data))
}

我们封装一个用来生成签名的方法

func generateSignature(key []byte, data []byte) (string, error) {
	// 创建一个哈希对象
	hash := hmac.New(sha256.New, key)
	// 将要签名的信息写入哈希对象中 hash.Write(data)
	_, err := hash.Write(data)
	if err != nil {
		return "", err
	}
	// hash.Sum()计算签名,在这里会返回签名内容
	// 将签名经过base64编码生成字符串形式返回。
	return encodeBase64(string(hash.Sum(nil))), nil
}

我们封装一个CreateToken用于生成Token(该方法的参数key为(生成签名所使用的密钥))

func CreateToken(key []byte, payloadData any) (string, error) {
    // 标准头部
	header := `{"alg":"HS256","typ":"JWT"}`
    // 将负载的数据转换为json
	payload, jsonErr := json.Marshal(payloadData)
	if jsonErr != nil {
		return "", fmt.Errorf("负载json解析错误")
	}
    // 将头部和负载通过base64编码,并使用.作为分隔进行连接
	encodedHeader := encodeBase64(header)
	encodedPayload := encodeBase64(string(payload))
	HeaderAndPayload := encodedHeader + "." + encodedPayload
    // 使用签名使用的key将传入的头部和负载连接所得的数据进行签名
	signature, err := generateSignature(key, []byte(HeaderAndPayload))
	if err != nil {
		return "", err
	}
    // 将token的三个部分使用.进行连接并返回
	return HeaderAndPayload + "." + signature, nil
}

解析Token

我们封装一个解析token的方法

func ParseJwt(token string, key []byte) (*JWT, error) {
    // 分解规定,我们使用.进行分隔,所以我们通过.进行分隔成三个字符串的数组
	jwtParts := strings.Split(token, ".")
    // 数据数组长度不是3就说明token在格式上就不合法
	if len(jwtParts) != 3 {
		return nil, fmt.Errorf("非法token")
	}
	// 分别拿出
	encodedHeader := jwtParts[0]
	encodedPayload := jwtParts[1]
	signature := jwtParts[2]
	// 使用key将token中的头部和负载用.连接后进行签名
    // 这个签名应该个token中第三部分的签名一致
	confirmSignature, err := generateSignature(key, []byte(encodedHeader+"."+encodedPayload))
	if err != nil {
		return nil, fmt.Errorf("生成签名错误")
	}
    // 如果不一致
	if signature != confirmSignature {
		return nil, fmt.Errorf("token验证失败")
	}
	// 将payload解base64编码
	dstPayload, _ := base64.RawURLEncoding.DecodeString(encodedPayload)
    // 返回我们的JWT对象以供后续使用
	return &JWT{encodedHeader, string(dstPayload), signature}, nil
}

实际使用

我们构造一个用户的结构体

type UserInfo struct {
	Name     string `json:"name"`
	Password string `json:"password"`
}

我们这次使用123456作为密钥简单的验证一下

var Key []byte = []byte("12346")

在此我们构造一个验证的中间件

func jwtConfirm(context *gin.Context) {
	// 登录不需要token
	if context.Request.RequestURI == "/login" {
		return
	}
	// 拿出token
	token := context.GetHeader("Token")
    // 进行解析验证
	jwt, err := utils.ParseJwt(token, Key)
	if err != nil {
		context.JSON(200, gin.H{
			"msg": err.Error(),
		})
        // 有问题就流产掉(我也不知道怎么翻译好了,香蕉猫.jpg)
		context.Abort()
	}
    // 验证通过就将负载返回回去
	context.JSON(200, gin.H{
		"payload": jwt.Payload,
	})
}

我们在此基础上就可以使用了,这边使用gin框架简单的测试一下

func main() {
    // 使用默认路由
	router := gin.Default()
    // 注册中间件
	router.Use(jwtConfirm)
    // 简单做两个服务
	router.POST("/login", func(context *gin.Context) {
		// 接收用户参数
		var userInfo UserInfo = UserInfo{}
        // 使用jsonbind接收
		bindErr := context.ShouldBindJSON(&userInfo)
		if bindErr != nil {
			context.JSON(200, gin.H{
				"msg": bindErr.Error(),
			})
		}
		// 使用密钥做出token
		jwt, err := utils.CreateJwt(Key, userInfo)
		if err != nil {
			fmt.Println(err)
		}
         // 我们将token直接返回用于测试
		context.JSON(200, gin.H{
			"token": jwt,
		})
	})
	router.GET("/doing")
	router.Run()
}

测试结果

image-20230429184039413.png

我们拿到了token

我们现在去试一下如果不带token的结果

image-20230429184135724.png

我们试一下携带错误token的情况

image-20230429184233619.png

我们最后测试一下正确的token

image-20230429184635149.png

结语

在实际环境中会使用更复杂的情况进行使用(例如密钥会更加复杂,会在pyload中设置失效时间等等),但是生成token和解析token的操作和上述的操作差别不大

到此这篇关于golang原生实现JWT的示例代码的文章就介绍到这了,更多相关golang原生实现JWT内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • go语言 全局变量和局部变量实例

    go语言 全局变量和局部变量实例

    这篇文章主要介绍了go语言 全局变量和局部变量实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Go语言数据结构之二叉树必会知识点总结

    Go语言数据结构之二叉树必会知识点总结

    如果你是一个开发人员,或多或少对树型结构都有一定的认识。二叉树作为树的一种,是一种重要的数据结构,也是面试官经常考的东西。本文为大家总结了一些二叉树必会知识点,需要的可以参考一下
    2022-08-08
  • go-zero使用goctl生成mongodb的操作使用方法

    go-zero使用goctl生成mongodb的操作使用方法

    mongodb是一种高性能、开源、文档型的nosql数据库,被广泛应用于web应用、大数据以及云计算领域,goctl model 为 goctl 提供的数据库模型代码生成指令,目前支持 MySQL、PostgreSQL、Mongo 的代码生成,本文给大家介绍了go-zero使用goctl生成mongodb的操作使用方法
    2024-06-06
  • 使用gopkg.in/yaml.v3 解析YAML数据详解

    使用gopkg.in/yaml.v3 解析YAML数据详解

    这篇文章主要为大家介绍了使用gopkg.in/yaml.v3 解析YAML数据示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • Go单例模式与Once源码实现

    Go单例模式与Once源码实现

    这篇文章主要介绍了Go单例模式与Once源码实现,本文结合示例代码给大家讲解的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-12-12
  • 详解Go语言如何解析带注释的json

    详解Go语言如何解析带注释的json

    标准的json格式是不带注释,但是有时候为了方便理解json中各字段的含义,需要支持带注释的json,这篇文章主要介绍了Go语言解析带注释json的相关方法,希望对大家有所帮助
    2024-03-03
  • GO项目部署Linux服务器的实现示例

    GO项目部署Linux服务器的实现示例

    本文主要介绍了GO项目部署Linux服务器的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-06-06
  • Go工具链之代码测试神器go test详解

    Go工具链之代码测试神器go test详解

    这篇文章主要给大家介绍Go 工具链go test,go test 是 Go 工具链中的一个命令,用于编译和运行按照要求编写的 Golang 测试代码,并生成测试报告,感兴趣的同学跟着小编一起来看看本文吧
    2023-07-07
  • go语言定义零值可用的类型学习教程

    go语言定义零值可用的类型学习教程

    这篇文章主要为大家介绍了go语言定义零值可用的类型教程学习,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06
  • 使用Go实现TLS服务器和客户端的示例

    使用Go实现TLS服务器和客户端的示例

    本文主要介绍了Go实现TLS服务器和客户端的示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12

最新评论