claims.go

// SPDX-License-Identifier: MIT

package token

import (
	"time"

	gojwt "github.com/golang-jwt/jwt/v4"
	"github.com/issue9/middleware/v6/jwt"
	"github.com/issue9/unique"
)

// Claims 自定义 Claims 需要实现的接口
type Claims interface {
	jwt.Claims

	// UserID 获取用户的唯一编号
	//
	// 可以关联某一用户的所有登录令牌。
	UserID() string

	// BaseToken 关联的基础令牌
	//
	// 仅在刷新令牌中，此值不为空。
	BaseToken() string
}

type defaultClaims struct {
	User    string `json:"iss"`
	Expires int64  `json:"exp"` // 过期时间
	Claims  string `json:"clm"` // 原始令牌，如果为刷新令牌，此值为关联的令牌，否则为空。
	ID      string `json:"jti"` // 当用户快速更换令牌时，此值可以保证令牌的唯一性。
}

func NewClaims(uid string) Claims {
	return &defaultClaims{User: uid, ID: unique.Number().String()}
}

func BuildClaims() Claims { return &defaultClaims{} }

func (c *defaultClaims) Valid() error {
	if time.Now().After(time.Unix(c.Expires, 0)) {
		return gojwt.NewValidationError("exp 已过期", gojwt.ValidationErrorExpired)
	}
	return nil
}

func (c *defaultClaims) UserID() string { return c.User }

func (c *defaultClaims) SetExpired(t time.Duration) {
	c.Expires = time.Now().Add(t).Unix()
}

func (c *defaultClaims) BaseToken() string { return c.Claims }

func (c *defaultClaims) BuildRefresh(token string) jwt.Claims {
	return &defaultClaims{
		User:   c.User,
		Claims: token,
		ID:     c.ID,
	}
}