jwt

README

jwt

Generate and parse token based on jwt library.

Example of use

Example 1: common fields jwt

    import "github.com/18721889353/sunshine/pkg/jwt"

	jwt.Init(
		// jwt.WithSigningKey("123456"),   // key
		// jwt.WithExpire(time.Hour), // expiry time
		// jwt.WithSigningMethod(jwt.HS512), // encryption method, default is HS256, can be set to HS384, HS512
	)

	uid := "123"
	name := "admin"

	// generate token
	token, err := jwt.GenerateToken(uid, name)
	// handle err

	// parse token
	claims, err := jwt.ParseToken(token)
	// handle err

	// verify
	if claims.Uid != uid || claims.Name != name {
		print("verify failed")
	    return
	}

Example 2: custom fields jwt

    import "github.com/18721889353/sunshine/pkg/jwt"

	jwt.Init(
		// jwt.WithSigningKey("123456"),   // key
		// jwt.WithExpire(time.Hour), // expiry time
		// jwt.WithSigningMethod(jwt.HS512), // encryption method, default is HS256, can be set to HS384, HS512
	)

	fields := jwt.KV{"id": 123, "foo": "bar"}

	// generate token
	token, err := jwt.GenerateCustomToken(fields)
	// handle err

	// parse token
	claims, err := jwt.ParseCustomToken(token)
	// handle err

	// verify
	id, isExist1 := claims.Get("id")
	foo, isExist2 := claims.Get("foo")
	if !isExist1 || !isExist2 || int(id.(float64)) != fields["id"].(int) || foo.(string) != fields["foo"].(string) {
	    print("verify failed")
	    return
	}

Documentation

Overview

Package jwt is token generation and validation.

Index

• Variables
• func GenerateCustomToken(kv map[string]interface{}) (string, error)
• func GenerateToken(uid string, name ...string) (string, error)
• func Init(opts ...Option)
• func RefreshCustomToken(tokenString string) (string, error)
• func RefreshToken(tokenString string) (string, error)
• type Claims
  • func ParseToken(tokenString string) (*Claims, error)
• type CustomClaims
  • func ParseCustomToken(tokenString string) (*CustomClaims, error)
  • func (c *CustomClaims) Get(key string) (val interface{}, isExist bool)
  • func (c *CustomClaims) GetInt(key string) (int, bool)
  • func (c *CustomClaims) GetString(key string) (string, bool)
  • func (c *CustomClaims) GetUint64(key string) (uint64, bool)
• type KV
• type Option
  • func WithExpire(d time.Duration) Option
  • func WithIssuer(issuer string) Option
  • func WithSigningKey(key string) Option
  • func WithSigningMethod(sm *jwt.SigningMethodHMAC) Option

Variables

var (
	// HS256 Method
	HS256 = jwt.SigningMethodHS256
	// HS384 Method
	HS384 = jwt.SigningMethodHS384
	// HS512 Method
	HS512 = jwt.SigningMethodHS512
)

var ErrTokenExpired = jwt.ErrTokenExpired

ErrTokenExpired expired

Functions

func GenerateCustomToken

func GenerateCustomToken(kv map[string]interface{}) (string, error)

GenerateCustomToken generate token by custom fields, use CustomClaims

func GenerateToken

func GenerateToken(uid string, name ...string) (string, error)

GenerateToken generate token by uid and name, use universal Claims

func Init

func Init(opts ...Option)

Init initialize jwt

func RefreshCustomToken

func RefreshCustomToken(tokenString string) (string, error)

RefreshCustomToken refresh custom token

func RefreshToken

func RefreshToken(tokenString string) (string, error)

RefreshToken refresh token

Types

type Claims

type Claims struct {
	UID  string `json:"uid"`
	Name string `json:"name"`
	jwt.RegisteredClaims
}

Claims standard claims, include uid, name, and RegisteredClaims

func ParseToken

func ParseToken(tokenString string) (*Claims, error)

ParseToken parse token, return universal Claims

type CustomClaims

type CustomClaims struct {
	Fields KV `json:"fields"`
	jwt.RegisteredClaims
}

CustomClaims custom fields claims

func ParseCustomToken

func ParseCustomToken(tokenString string) (*CustomClaims, error)

ParseCustomToken parse token, return CustomClaims

func (*CustomClaims) Get

func (c *CustomClaims) Get(key string) (val interface{}, isExist bool)

Get custom field value by key, if not found, return false

func (*CustomClaims) GetInt

func (c *CustomClaims) GetInt(key string) (int, bool)

GetInt custom field value by key, if not found, return false

func (*CustomClaims) GetString

func (c *CustomClaims) GetString(key string) (string, bool)

GetString custom field value by key, if not found, return false

func (*CustomClaims) GetUint64

func (c *CustomClaims) GetUint64(key string) (uint64, bool)

GetUint64 custom field value by key, if not found, return false

type KV

type KV = map[string]interface{}

KV map type

type Option

type Option func(*options)

Option set the jwt options.

func WithExpire

func WithExpire(d time.Duration) Option

WithExpire set expire value

func WithIssuer

func WithIssuer(issuer string) Option

WithIssuer set issuer value

func WithSigningKey

func WithSigningKey(key string) Option

WithSigningKey set signing key value

func WithSigningMethod

func WithSigningMethod(sm *jwt.SigningMethodHMAC) Option

WithSigningMethod set signing method value