Gin框架入门-JWT认证

本文最后更新于：1 年前

一、JWT

1、JSON Web Token

JSON Web Token 参考文档：https://jwt.io/introduction
JSON Web Token (JWT) 是一个开放标准 ( RFC 7519 )，它定义了一种紧凑且自包含的方式，用于在各方之间安全地传输信息作为 JSON 对象。此信息可以验证和信任，因为它是数字签名的。JWT 可以使用密钥（使用HMAC算法）或使用RSA或ECDSA的公钥/私钥对进行签名。

简而言之，它是一个签名的 JSON 对象，可以做一些有用的事情（例如，身份验证）。它通常用于BearerOauth 2 中的令牌。令牌由三部分组成，由 ( .) 分隔。前两部分是 JSON 对象，已经过base64url编码。最后一部分是签名，以同样的方式编码。

第一部分称为标题。它包含验证最后一部分签名的必要信息。例如，使用哪种加密方法进行签名以及使用了什么密钥。

中间的部分是有趣的部分。它称为声明，包含您关心的实际内容。有关保留密钥和添加自己的正确方法的信息

二、什么时候应该使用 JSON Web Tokens

以下是 JSON Web Tokens有用的一些场景：

  • 授权：这是使用 JWT 最常见的场景。用户登录后，每个后续请求都将包含 JWT，从而允许用户访问该令牌允许的路由、服务和资源。单点登录是当今广泛使用 JWT 的一项功能，因为它的开销很小并且能够在不同的域中轻松使用。

  • 信息交换：JSON Web 令牌是在各方之间安全传输信息的好方法。因为可以对 JWT 进行签名（例如，使用公钥/私钥对），所以您可以确定发件人就是他们所说的那个人。此外，由于使用标头和有效负载计算签名，您还可以验证内容没有被篡改。

三、JSON Web Token 结构

在其紧凑的形式中，JSON Web Tokens 由以点 ( .) 分隔的三部分组成，它们是：

  • 标题
  • 有效载荷
  • 签名

因此，JWT 通常如下所示。

xxxxx.yyyyy.zzzzz

1、标题

标头通常由两部分组成：令牌的类型，即 JWT，以及正在使用的签名算法，例如 HMAC SHA256 或 RSA。
例如：

1
2
3
4
{
  "alg": "HS256",
  "typ": "JWT"
}

然后，这个 JSON 被Base64Url编码以形成 JWT 的第一部分。

2、有效载荷

令牌的第二部分是有效负载，其中包含声明。声明是关于实体（通常是用户）和附加数据的陈述。声明分为三种类型：注册声明、公开声明和私人声明。

  • 注册声明：这些是一组预定义的声明，它们不是强制性的，但建议使用，以提供一组有用的、可互操作的声明。其中一些是： iss（发行人）、 exp（到期时间）、 sub（主题）、 aud（受众）等。
  • 公共声明：这些可以由使用 JWT 的人随意定义。但是为了避免冲突，它们应该在IANA JSON Web Token Registry中定义，或者定义为包含抗冲突命名空间的 URI。
  • 私人声明：这些是为在同意使用它们的各方之间共享信息而创建的自定义声明，既不是注册声明也不是公共声明。

一个示例有效载荷可能是：

1
2
3
4
5
{
  "sub": "1234567890",
  "name": "linzy",
  "admin": true
}

然后对有效负载进行Base64Url编码以形成 JSON Web 令牌的第二部分。

注意：对于已签名的令牌，此信息虽然受到保护以防篡改，但任何人都可以读取。除非已加密，否则请勿将机密信息放入 JWT 的有效负载或标头元素中。

3、签名

要创建签名部分，您必须获取编码的标头、编码的有效负载、秘密、标头中指定的算法，并对其进行签名。
例如，如果您想使用 HMAC SHA256 算法，签名将通过以下方式创建：

1
2
3
4
HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret)

签名用于验证消息在此过程中没有被更改，并且在使用私钥签名的令牌的情况下，它还可以验证 JWT 的发送者就是它所说的那个人。

如果您想玩 JWT 并将这些概念付诸实践，您可以使用 jwt.io Debugger 来解码、验证和生成 JWT。

四、JSON Web 令牌如何工作

在身份验证中，当用户使用其凭据成功登录时，将返回一个 JSON Web Token。由于令牌是凭据，因此必须非常小心以防止出现安全问题。通常，您不应将令牌保留超过所需的时间。

由于缺乏安全性，您也不应该在浏览器存储中存储敏感的会话数据。

每当用户想要访问受保护的路由或资源时，用户代理应该发送 JWT，通常在Authorization标头中使用Bearer模式。标头的内容应如下所示：

1
Authorization: Bearer <token>

在某些情况下，这可以是一种无状态授权机制。服务器的受保护路由将检查Authorization标头中是否存在有效的 JWT，如果存在，则允许用户访问受保护的资源。如果 JWT 包含必要的数据，则可能会减少查询数据库以进行某些操作的需要，尽管情况并非总是如此。

请注意，如果您通过 HTTP 标头发送 JWT 令牌，则应尽量防止它们变得太大。某些服务器不接受超过 8 KB 的标头。如果您试图在 JWT 令牌中嵌入太多信息，例如通过包含所有用户的权限，您可能需要替代解决方案，例如Auth0 Fine-Grained Authorization。

如果令牌在Authorization标头中发送，则跨域资源共享 (CORS) 不会成为问题，因为它不使用 cookie。

下图显示了如何获取 JWT 并将其用于访问 API 或资源：

  1. 应用程序或客户端向授权服务器请求授权。这是通过不同的授权流程之一执行的。例如，一个典型的符合OpenID Connect的Web 应用程序将使用授权代码流 /oauth/authorize 通过端点。
  2. 当授权被授予时，授权服务器向应用程序返回一个访问令牌。
  3. 应用程序使用访问令牌访问受保护的资源（如 API）。

五、JWT-GO

1、安装指南

  1. 使用以下命令将jwt-go其作为依赖项添加到您的 Go 程序中。
1
go get -u github.com/golang-jwt/jwt/v4
  1. 在您的代码中导入它：
1
import "github.com/golang-jwt/jwt/v4"

2、jwt-go简介

包 jwt 是 JSON Web Tokens 的 Go 实现
项目链接：https://github.com/golang-jwt/jwt

3、jwt-go例子

1）创建JWT

NewWithClaims使用指定的签名方法和声明创建一个新的令牌。

使用自定义声明类型创建令牌的示例。StandardClaim 嵌入在自定义类型中，以便于对标准声明进行编码、解析和验证。

代码示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
type MyClaims struct {
	UserName string `json:"user_name"`
	jwt.StandardClaims
}

func main() {
	//签名密钥
	mySignedKeys := []byte("woshilinzy")
	c := MyClaims{
		UserName: "linzy",
		StandardClaims: jwt.StandardClaims{
			//什么时间生效
			NotBefore: time.Now().Unix() - 60,
			//什么时间失效
			ExpiresAt: time.Now().Unix() + 5,
			//签发者
			Issuer:    "linzy",
		},
	}
	//NewWithClaims使用指定的签名方法和声明创建一个新的令牌。
	t := jwt.NewWithClaims(jwt.SigningMethodHS256, c)
	fmt.Println(t)
	// SignedString创建并返回一个完整的有符号的JWT。
	//使用令牌中指定的SigningMethod对令牌进行签名。
	s, err := t.SignedString(mySignedKeys)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(s)
}

2）解析JWT

ParseWithClaims 使用自定义声明类型创建令牌的示例。StandardClaim 嵌入在自定义类型中，以便于对标准声明进行编码、解析和验证。
token, err := jwt.ParseWithClaims(token, claims, func)

  1. token：我们拿到的token字符串
  2. claims：我们用那个claims结构体发送的，就传入那个claims结构体
  3. func：特殊的回调函数，需要固定接收 Token 类型指针，返回 interface{} 和 err，*interface{} 就是我们的密钥 mySignedKeys
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    type MyClaims struct {
    	UserName string `json:"user_name"`
    	jwt.StandardClaims
    }

    func main() {
    	mySignedKeys := []byte("woshilinzy")
    	
    	//刚刚加密的JWT
    	tokenString := "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJsaW56eSIsImV4cCI6MTY1NzYzNTY5MSwiaXNzIjoibGluenkiLCJuYmYiOjE2NTc2MzU2MjZ9.SJEAqz3BnJ_52kEQvwbIjWPa9KW6KU2yLINTQMk4FlA"
    	//解析JWT
    	token, err := jwt.ParseWithClaims(tokenString, &MyClaims{}, func(token *jwt.Token) (interface{}, error) {
    		return mySignedKeys, nil
    	})
    	//使用断言获取MyClaims结构体
    	fmt.Println(token.Claims.(*MyClaims))
    	fmt.Println(err)
    }

六、浅谈使用JWT的优点

让我们谈谈JSON Web Tokens (JWT)与Simple Web Tokens (SWT)和Security Assertion Markup Language Tokens (SAML)相比的优势。

由于 JSON 不像 XML 那样冗长，因此在对其进行编码时，它的大小也更小，这使得 JWT 比 SAML 更紧凑。这使得 JWT 成为在 HTML 和 HTTP 环境中传递的不错选择。

安全方面，SWT 只能通过使用 HMAC 算法的共享密钥进行对称签名。但是，JWT 和 SAML 令牌可以使用 X.509 证书形式的公钥/私钥对进行签名。与签署 JSON 的简单性相比，使用 XML 数字签名签署 XML 而不引入隐蔽的安全漏洞是非常困难的。

JSON 解析器在大多数编程语言中都很常见，因为它们直接映射到对象。相反，XML 没有自然的文档到对象映射。这使得使用 JWT 比使用 SAML 断言更容易。

关于使用，JWT 用于 Internet 规模。这突出了 JSON Web 令牌在多个平台（尤其是移动平台）上客户端处理的便利性。

Gin框架
#学习 #go #gin，json #JWT
Gin框架入门-JWT认证
https://gopherlinzy.github.io/2022/07/19/gin-JWT/
作者
孙禄毅
发布于
2022年7月19日
许可协议