token

Documentation

Index

• Variables
• type AccessTokenProvider
• type CreditGenerator
  • func NewCreditGenerator(accessSecret string, accessTokenExpSec int64, refreshSecret string, ...) *CreditGenerator
  • func NewCreditGeneratorFromConfig(tokenConfig *config.JWTConfig) (*CreditGenerator, error)
  • func (c *CreditGenerator) AccessTokenMiddleware() echo.MiddlewareFunc
  • func (c *CreditGenerator) CreateAccessToken(user usersource.UserProvider) (accessToken string, exp int64, err error)
  • func (c *CreditGenerator) CreateRefreshToken(user usersource.UserProvider) (freshToken string, exp int64, err error)
  • func (c *CreditGenerator) ParseAccessToken(accessToken any) (*JwtCustomClaims, error)
  • func (c *CreditGenerator) ParseRefreshToken(refreshToken any) (claims *JwtCustomRefreshClaims, err error)
• type JwtCustomClaims
• type JwtCustomRefreshClaims
• type RefreshTokenProvider

Variables

var Module = fx.Module("token",
	fx.Provide(
		func(appConfig *config.AppConfig) *config.JWTConfig {
			return &appConfig.JWT
		},
		NewCreditGeneratorFromConfig,
		func(generator *CreditGenerator) AccessTokenProvider {
			return generator
		},
		func(generator *CreditGenerator) RefreshTokenProvider {
			return generator
		},
	),
)

Types

type AccessTokenProvider

type AccessTokenProvider interface {
	CreateAccessToken(user usersource.UserProvider) (accessToken string, exp int64, err error)
	ParseAccessToken(accessToken any) (claims *JwtCustomClaims, err error)
	AccessTokenMiddleware() echo.MiddlewareFunc
}

type CreditGenerator

type CreditGenerator struct {
	// contains filtered or unexported fields
}

func NewCreditGenerator

func NewCreditGenerator(
	accessSecret string,
	accessTokenExpSec int64,
	refreshSecret string,
	refreshTokenExpSec int64) *CreditGenerator

func NewCreditGeneratorFromConfig

func NewCreditGeneratorFromConfig(tokenConfig *config.JWTConfig) (*CreditGenerator, error)

func (*CreditGenerator) AccessTokenMiddleware

func (c *CreditGenerator) AccessTokenMiddleware() echo.MiddlewareFunc

func (*CreditGenerator) CreateAccessToken

func (c *CreditGenerator) CreateAccessToken(user usersource.UserProvider) (accessToken string, exp int64, err error)

func (*CreditGenerator) CreateRefreshToken

func (c *CreditGenerator) CreateRefreshToken(user usersource.UserProvider) (freshToken string, exp int64, err error)

func (*CreditGenerator) ParseAccessToken

func (c *CreditGenerator) ParseAccessToken(accessToken any) (*JwtCustomClaims, error)

func (*CreditGenerator) ParseRefreshToken

func (c *CreditGenerator) ParseRefreshToken(refreshToken any) (claims *JwtCustomRefreshClaims, err error)

type JwtCustomClaims

type JwtCustomClaims struct {
	Name string `json:"name,omitempty"`
	ID   any    `json:"id,omitempty"`
	jwt.RegisteredClaims
}

type JwtCustomRefreshClaims

type JwtCustomRefreshClaims struct {
	ID any `json:"id,omitempty"`
	jwt.RegisteredClaims
}

type RefreshTokenProvider

type RefreshTokenProvider interface {
	CreateRefreshToken(user usersource.UserProvider) (freshToken string, exp int64, err error)
	ParseRefreshToken(refreshToken any) (claims *JwtCustomRefreshClaims, err error)
}