首页
/ 开源项目 `gbrlsnchs/jwt` 使用教程

开源项目 `gbrlsnchs/jwt` 使用教程

2024-08-16 15:56:17作者:牧宁李

1. 项目的目录结构及介绍

gbrlsnchs/jwt/
├── LICENSE
├── README.md
├── go.mod
├── go.sum
├── jwt.go
├── jwt_test.go
├── payload.go
├── payload_test.go
├── rs.go
├── rs_test.go
├── hs.go
├── hs_test.go
├── es.go
├── es_test.go
├── ps.go
├── ps_test.go
└── example/
    ├── example.go
    └── example_test.go
  • LICENSE: 项目许可证文件。
  • README.md: 项目说明文档。
  • go.modgo.sum: Go 模块文件,用于管理项目依赖。
  • jwt.go: 主文件,包含 JWT 的核心功能。
  • jwt_test.go: 主文件的测试代码。
  • payload.go: 处理 JWT 负载的文件。
  • payload_test.go: 负载处理文件的测试代码。
  • rs.go, hs.go, es.go, ps.go: 分别处理 RSA、HMAC、ECDSA 和 PSS 签名算法的文件。
  • rs_test.go, hs_test.go, es_test.go, ps_test.go: 对应签名算法的测试代码。
  • example/: 示例代码目录,包含如何使用该库的示例。

2. 项目的启动文件介绍

项目的启动文件主要是 example/example.go,它展示了如何使用 gbrlsnchs/jwt 库来生成和验证 JWT。

package main

import (
	"fmt"
	"time"

	"github.com/gbrlsnchs/jwt/v3"
)

type CustomPayload struct {
	jwt.Payload
	Foo string `json:"foo,omitempty"`
	Bar int    `json:"bar,omitempty"`
}

func main() {
	hs := jwt.NewHS256([]byte("secret"))
	now := time.Now()
	pl := CustomPayload{
		Payload: jwt.Payload{
			Issuer:         "gbrlsnchs",
			Subject:        "someone",
			Audience:       jwt.Audience{"https://golang.org", "https://jwt.io"},
			ExpirationTime: jwt.NumericDate(now.Add(24 * time.Hour)),
			NotBefore:      jwt.NumericDate(now.Add(30 * time.Minute)),
			IssuedAt:       jwt.NumericDate(now),
			JWTID:          "foobar",
		},
		Foo: "foo",
		Bar: 1337,
	}
	token, err := jwt.Sign(pl, hs)
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(string(token))
}

3. 项目的配置文件介绍

该项目主要通过代码进行配置,没有独立的配置文件。配置主要通过 jwt.NewHS256, jwt.NewRS256, jwt.NewES256 等函数进行,这些函数接受密钥或证书作为参数,并返回一个签名器实例。

例如:

hs := jwt.NewHS256([]byte("secret"))

这段代码创建了一个使用 HMAC-SHA256 算法的签名器,密钥为 "secret"


以上是 gbrlsnchs/jwt 项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置方法。希望对你有所帮助!

登录后查看全文
热门项目推荐