百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程字典 > 正文

使用 JWT 保护 Go REST API

toyiye 2024-06-21 11:59 15 浏览 0 评论


JWT,或者更正式地称为 JSON Web 令牌,是一种紧凑的、URL 安全的方式,用于表示要在两方之间传输的声明。这本质上是一种令人困惑的说法,即 JWT 允许您以无状态但安全的方式将信息从客户端传输到服务器。

先决条件

在您阅读本文之前,您需要以下内容:

  • 您需要在开发机器上安装 Go 版本 1.11+。

介绍

JWT 标准使用 HMAC 算法的密钥或使用 RSA 或 ECDSA 的公钥/私钥对。

注意 -如果您对 JWT 的正式定义感兴趣,那么我建议您查看 RFC: RFC-7519

这些在单页应用程序 (SPA) 中间被大量用作安全通信的手段,因为它们允许我们做两件关键的事情:

  • 身份验证- 最常用的做法。一旦用户登录到您的应用程序或以某种方式进行身份验证,然后代表用户从客户端发送的每个请求都将包含 JWT。
  • 信息交换——JWT 的第二个用途是在不同系统之间安全地传输信息。这些 JWT 可以使用公钥/私钥对其进行签名,因此您可以以安全的方式验证此事务中的每个系统,并且 JWT 包含防篡改机制,因为它们是基于标头和有效负载进行签名的。

因此,如果您现在还没有猜到,在本教程中,我们将确切了解构建使用 JSON Web 令牌进行通信的基于 Go 的安全 REST API 需要什么!


一个简单的 REST API

因此,我们将使用我的另一篇文章中的代码, 在 Go 中创建一个简单的 REST API,让我们开始。这将具有一个非常简单的Hello World样式端点,它将在端口 8081 上运行。

package main

import (
    "fmt"
    "log"
    "net/http"
)

func homePage(w http.ResponseWriter, r *http.Request){
    fmt.Fprintf(w, "Hello World")
    fmt.Println("Endpoint Hit: homePage")
}

func handleRequests() {
    http.HandleFunc("/", homePage)
    log.Fatal(http.ListenAndServe(":8081", nil))
}

func main() {
    handleRequests()
}

当我们尝试访问我们的主页时,运行 on http://localhost:8081/,我们应该Hello World在浏览器中看到该消息。

智威汤逊认证

所以,既然我们有了一个简单的选择 API,我们现在可以使用签名的 JWT 令牌来保护它,让我们构建一个客户端 API,它将尝试从这个原始 API 请求数据。

为此,我们可以使用已使用安全密钥签名的 JWT,我们的客户端和服务器都将知道该密钥。让我们来看看它是如何工作的:

  1. 我们的客户将根据我们的共享密码生成一个签名的 JWT。
  2. 当我们的客户端访问我们的服务器 API 时,它将包含这个 JWT 作为请求的一部分。
  3. 我们的服务器将能够读取此消息 JWT 并未使用相同的密码验证令牌。
  4. 如果 JWT 有效,则将高度机密的 hello world消息返回给客户端,否则将返回 not authorized.

我们的架构图最终看起来有点像这样:

我们的服务器

所以,让我们看看它的实际效果,让我们创建一个非常简单的服务器:

package main

import (
    "fmt"
    "log"
    "net/http"

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

var mySigningKey = []byte("captainjacksparrowsayshi")

func homePage(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "Hello World")
    fmt.Println("Endpoint Hit: homePage")

}

func isAuthorized(endpoint func(http.ResponseWriter, *http.Request)) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

        if r.Header["Token"] != nil {

            token, err := jwt.Parse(r.Header["Token"][0], func(token *jwt.Token) (interface{}, error) {
                if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
                    return nil, fmt.Errorf("There was an error")
                }
                return mySigningKey, nil
            })

            if err != nil {
                fmt.Fprintf(w, err.Error())
            }

            if token.Valid {
                endpoint(w, r)
            }
        } else {

            fmt.Fprintf(w, "Not Authorized")
        }
    })
}

func handleRequests() {
    http.Handle("/", isAuthorized(homePage))
    log.Fatal(http.ListenAndServe(":9000", nil))
}

func main() {
    handleRequests()
}


让我们分解一下。我们创建了一个非常简单的 API,它具有一个单独的端点,它受到我们的isAuthorized中间件装饰器的保护。在此 isAuthorized函数中,我们检查传入请求是否包含请求中的 Token标头,然后我们随后根据我们的 private 检查令牌是否有效mySigningKey。

如果这是一个有效的令牌,我们就会为受保护的端点提供服务。

注意 -这个例子使用了装饰器,如果你对 Go 中装饰器的概念不满意,那么我建议你在这里查看我的另一篇文章: Go 中的装饰器入门

我们的客户

现在我们有了一个具有 JWT 安全端点的服务器,让我们构建一些可以与之交互的东西。

我们将构建一个简单的客户端应用程序,它将尝试调用/ 我们服务器的端点。

package main

import (
    "fmt"
    "io/ioutil"
    "log"
    "net/http"
    "time"

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

var mySigningKey = []byte("captainjacksparrowsayshi")

func homePage(w http.ResponseWriter, r *http.Request) {
    validToken, err := GenerateJWT()
    if err != nil {
        fmt.Println("Failed to generate token")
    }

    client := &http.Client{}
    req, _ := http.NewRequest("GET", "http://localhost:9000/", nil)
    req.Header.Set("Token", validToken)
    res, err := client.Do(req)
    if err != nil {
        fmt.Fprintf(w, "Error: %s", err.Error())
    }

    body, err := ioutil.ReadAll(res.Body)
    if err != nil {
        fmt.Println(err)
    }
    fmt.Fprintf(w, string(body))
}

func GenerateJWT() (string, error) {
    token := jwt.New(jwt.SigningMethodHS256)

    claims := token.Claims.(jwt.MapClaims)

    claims["authorized"] = true
    claims["client"] = "Elliot Forbes"
    claims["exp"] = time.Now().Add(time.Minute * 30).Unix()

    tokenString, err := token.SignedString(mySigningKey)

    if err != nil {
        fmt.Errorf("Something Went Wrong: %s", err.Error())
        return "", err
    }

    return tokenString, nil
}

func handleRequests() {
    http.HandleFunc("/", homePage)

    log.Fatal(http.ListenAndServe(":9001", nil))
}

func main() {
    handleRequests()
}

让我们分解上面代码中发生的事情。同样,我们定义了一个非常简单的 API,它具有单个端点。此端点在触发时使用我们的 secure 生成一个新的 JWT mySigningKey,然后它创建一个新的 http 客户端并将Token标头设置为等于我们刚刚生成的 JWT 字符串。

然后它会尝试使用这个签名的 JWT 令牌访问我们server正在运行的应用程序 http://localhost:9000。然后我们的服务器验证我们在客户端生成的令牌并继续为我们提供超级机密Hello World消息。

结论

希望本教程有助于揭开使用 JSON Web 令牌保护 Go 应用程序和 REST API 的神秘面纱。写这篇文章很有趣,我希望它对你有用 Go 开发之旅有所帮助。

如果您喜欢本教程,请在下面的评论部分告诉我,或者在社交媒体上分享这篇文章,它真的对我和我的网站有帮助!


延伸阅读

如果您想阅读更多关于 JSON Web Tokens 及其使用方式的信息,那么我可以彻底推荐以下文章:

  • RFC-7519 - https://tools.ietf.org/html/rfc7519
  • JWT 介绍- https://jwt.io/introduction/

相关推荐

为何越来越多的编程语言使用JSON(为什么编程)

JSON是JavascriptObjectNotation的缩写,意思是Javascript对象表示法,是一种易于人类阅读和对编程友好的文本数据传递方法,是JavaScript语言规范定义的一个子...

何时在数据库中使用 JSON(数据库用json格式存储)

在本文中,您将了解何时应考虑将JSON数据类型添加到表中以及何时应避免使用它们。每天?分享?最新?软件?开发?,Devops,敏捷?,测试?以及?项目?管理?最新?,最热门?的?文章?,每天?花?...

MySQL 从零开始:05 数据类型(mysql数据类型有哪些,并举例)

前面的讲解中已经接触到了表的创建,表的创建是对字段的声明,比如:上述语句声明了字段的名称、类型、所占空间、默认值和是否可以为空等信息。其中的int、varchar、char和decimal都...

JSON对象花样进阶(json格式对象)

一、引言在现代Web开发中,JSON(JavaScriptObjectNotation)已经成为数据交换的标准格式。无论是从前端向后端发送数据,还是从后端接收数据,JSON都是不可或缺的一部分。...

深入理解 JSON 和 Form-data(json和formdata提交区别)

在讨论现代网络开发与API设计的语境下,理解客户端和服务器间如何有效且可靠地交换数据变得尤为关键。这里,特别值得关注的是两种主流数据格式:...

JSON 语法(json 语法 priority)

JSON语法是JavaScript语法的子集。JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔花括号保存对象方括号保存数组JS...

JSON语法详解(json的语法规则)

JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔大括号保存对象中括号保存数组注意:json的key是字符串,且必须是双引号,不能是单引号...

MySQL JSON数据类型操作(mysql的json)

概述mysql自5.7.8版本开始,就支持了json结构的数据存储和查询,这表明了mysql也在不断的学习和增加nosql数据库的有点。但mysql毕竟是关系型数据库,在处理json这种非结构化的数据...

JSON的数据模式(json数据格式示例)

像XML模式一样,JSON数据格式也有Schema,这是一个基于JSON格式的规范。JSON模式也以JSON格式编写。它用于验证JSON数据。JSON模式示例以下代码显示了基本的JSON模式。{"...

前端学习——JSON格式详解(后端json格式)

JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScriptProgrammingLa...

什么是 JSON:详解 JSON 及其优势(什么叫json)

现在程序员还有谁不知道JSON吗?无论对于前端还是后端,JSON都是一种常见的数据格式。那么JSON到底是什么呢?JSON的定义...

PostgreSQL JSON 类型:处理结构化数据

PostgreSQL提供JSON类型,以存储结构化数据。JSON是一种开放的数据格式,可用于存储各种类型的值。什么是JSON类型?JSON类型表示JSON(JavaScriptO...

JavaScript:JSON、三种包装类(javascript 包)

JOSN:我们希望可以将一个对象在不同的语言中进行传递,以达到通信的目的,最佳方式就是将一个对象转换为字符串的形式JSON(JavaScriptObjectNotation)-JS的对象表示法...

Python数据分析 只要1分钟 教你玩转JSON 全程干货

Json简介:Json,全名JavaScriptObjectNotation,JSON(JavaScriptObjectNotation(记号、标记))是一种轻量级的数据交换格式。它基于J...

比较一下JSON与XML两种数据格式?(json和xml哪个好)

JSON(JavaScriptObjectNotation)和XML(eXtensibleMarkupLanguage)是在日常开发中比较常用的两种数据格式,它们主要的作用就是用来进行数据的传...

取消回复欢迎 发表评论:

请填写验证码