jwt

Documentation

Index

• Variables
• func CreateClaims(issuer string, inr time.Duration) jwt.Claims
• func LoadRSAPrivateKey(key []byte) (*rsa.PrivateKey, error)
• func LoadRSAPrivateKeyFromPEM(keyFile, passFile string) (*rsa.PrivateKey, error)
• func LoadRSAPublicKey(key []byte) (*rsa.PublicKey, error)
• func LoadRSAPublicKeyFromPEM(file string) (*rsa.PublicKey, error)
• func RS256SignJWT(claims jwt.Claims, key *rsa.PrivateKey) (string, error)
• func RS384SignJWT(claims jwt.Claims, key *rsa.PrivateKey) (string, error)
• func RS512SignJWT(claims jwt.Claims, key *rsa.PrivateKey) (string, error)
• func RSAVerifyCustomJWT(tokenString string, opt VerifyOption, claims Claims) (bool, error)
• func RSAVerifyJWT(tokenString string, opt VerifyOption) (bool, *jwt.StandardClaims, error)
• type Claims
• type GetPublicKeyFunc
• type StandardClaims
  • func (c *StandardClaims) GetExpiresAt() int64
  • func (c *StandardClaims) GetIssuedAt() int64
  • func (c *StandardClaims) GetIssuer() string
• type VerifyOption

Examples

• RSAVerifyCustomJWT

Variables

var (
	ErrParseClaimsFailed = errors.New("failed to parse not standard claims")
	ErrNoPublicKey       = errors.New("no public key to verify JWT")
	ErrEmptyToken        = errors.New("token is empty")
)

var (
	ErrInvalidPrivateKeyFile = errors.New("invalid private key file")
)

Functions

func CreateClaims

func CreateClaims(issuer string, inr time.Duration) jwt.Claims

CreateClaims 根据 issuer 与过期时间间隔创建一个 JWT Claims. 例如， issuer 可以是一个 APP ID.

func LoadRSAPrivateKey

func LoadRSAPrivateKey(key []byte) (*rsa.PrivateKey, error)

LoadRSAPrivateKey 从私钥的字节序列中加载 RSA 私钥

func LoadRSAPrivateKeyFromPEM

func LoadRSAPrivateKeyFromPEM(keyFile, passFile string) (*rsa.PrivateKey, error)

LoadRSAPrivateKeyFromPEM 从PEM私钥文件 keyFile 与密码文件 passFile 中加载 RSA 私钥

func LoadRSAPublicKey

func LoadRSAPublicKey(key []byte) (*rsa.PublicKey, error)

LoadRSAPublicKey 从字节序列中加载 RSA 公钥

func LoadRSAPublicKeyFromPEM

func LoadRSAPublicKeyFromPEM(file string) (*rsa.PublicKey, error)

LoadRSAPublicKeyFromPEM 从PEM公钥文件 file 中加载 RSA 公钥

func RS256SignJWT

func RS256SignJWT(claims jwt.Claims, key *rsa.PrivateKey) (string, error)

RS256SignJWT 使用 RS256 算法对 claims 进行签名

func RS384SignJWT

func RS384SignJWT(claims jwt.Claims, key *rsa.PrivateKey) (string, error)

RS384SignJWT 使用 RS84 算法对 claims 进行签名

func RS512SignJWT

func RS512SignJWT(claims jwt.Claims, key *rsa.PrivateKey) (string, error)

RS512SignJWT 使用 RS512 算法对 claims 进行签名

func RSAVerifyCustomJWT

func RSAVerifyCustomJWT(tokenString string, opt VerifyOption, claims Claims) (bool, error)

RSAVerifyCustomJWT 使用 RSA 算法（RS256/RS384/RS512) 对包含自定义 Claims 的 JWT Token 进行验证.

Example

package main

import (
	"crypto/rsa"
	"fmt"
	"time"

	"github.com/jinmukeji/plat-pkg/v2/auth/jwt"
)

func main() {
	// MyClaims is a custom claims
	type MyClaims struct {
		jwt.StandardClaims

		AccessToken string `json:"access_token"`
	}

	token := "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTQwNTMyMTQsImlhdCI6MTU5NDA1MjYxNCwiaXNzIjoiYXBwLXRlc3QxIn0.Xj2bALCrcIMHLHmeeI7ipRddoxU21MmigH3EBr9T_wygkZiZyzOOs-KU2VKuwMhnVsI0vU1iQKs0lCoHt8hSUGddHBjQ4oXcgfo9LWeKl0mluAeVzuBVsI-cZqDAapn5vKRrHvw2IsF-luJNB9th9-HY3_4Nif7OOKGc7DoYkzy-gazKl1lqOH76cy9jQBZ_FNYyKKh28_FgBECxoOogAfakyclPLfXjIxqvpAMMYYp3x0Gbeb1NtRToLNEHeJBEAs1W3vgCQ9i3DF2F1PP3XKHWifUp6MANMgt3w1ghPxxUK2MRHe1oX6wnu652GtspKQ0EJq5GnWMTie0KdRZCfw"
	key, err := jwt.LoadRSAPublicKeyFromPEM("public_key.pem")
	if err != nil {
		panic(err)
	}

	opt := jwt.VerifyOption{
		MaxExpInterval: 10 * time.Minute,
		GetPublicKeyFunc: func(iss string) *rsa.PublicKey {
			// ignore iss check

			return key
		},
	}

	claims := MyClaims{}

	valid, err := jwt.RSAVerifyCustomJWT(token, opt, &claims)
	fmt.Printf("IsValid: %v\n", valid)
	if err != nil {
		fmt.Printf("Validation Error: %v\n", err)
	}
	fmt.Println("Claims:", claims)
}

func RSAVerifyJWT

func RSAVerifyJWT(tokenString string, opt VerifyOption) (bool, *jwt.StandardClaims, error)

RSAVerifyJWT 使用 RSA 算法（RS256/RS384/RS512) 对 JWT Token 进行验证.

Types

type Claims

type Claims interface {
	jwt.Claims

	// GetIssuer 返回 iss
	GetIssuer() string
	// GetExpiresAt 返回 exp
	GetExpiresAt() int64
	// GetIssuedAt 返回 iat
	GetIssuedAt() int64
}

type GetPublicKeyFunc

type GetPublicKeyFunc func(iss string) *rsa.PublicKey

GetPublicKeyFunc 根据 iss 获取一个 rsa.PublicKey

type StandardClaims

type StandardClaims struct {
	jwt.StandardClaims
}

StandardClaims is a wrapper for jwt.StandardClaims.

func (*StandardClaims) GetExpiresAt

func (c *StandardClaims) GetExpiresAt() int64

func (*StandardClaims) GetIssuedAt

func (c *StandardClaims) GetIssuedAt() int64

func (*StandardClaims) GetIssuer

func (c *StandardClaims) GetIssuer() string

type VerifyOption

type VerifyOption struct {
	MaxExpInterval   time.Duration    // 最大过期时间间隔，单位为秒.
	GetPublicKeyFunc GetPublicKeyFunc // PublicKey 查找函数
}

VerifyOption 验证参数