jwtauth

Documentation

Index

• type JWTAuth
  • func New(store Storer, opts ...Option) *JWTAuth
  • func (a *JWTAuth) DestroyToken(ctx context.Context, tokenString string) error
  • func (a *JWTAuth) GenerateToken(ctx context.Context, userUUID string) (auth.TokenInfo, error)
  • func (a *JWTAuth) ParseUserUUID(ctx context.Context, tokenString string) (string, error)
  • func (a *JWTAuth) Release() error
• type Option
  • func SetExpired(expired int) Option
  • func SetKeyfunc(keyFunc jwt.Keyfunc) Option
  • func SetSigningKey(key interface{}) Option
  • func SetSigningMethod(method jwt.SigningMethod) Option
• type Storer

Types

type JWTAuth

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

JWTAuth - jwt Authenticate

func New

func New(store Storer, opts ...Option) *JWTAuth

New - Create an authentication instance

func (*JWTAuth) DestroyToken

func (a *JWTAuth) DestroyToken(ctx context.Context, tokenString string) error

DestroyToken - Destroy token

func (*JWTAuth) GenerateToken

func (a *JWTAuth) GenerateToken(ctx context.Context, userUUID string) (auth.TokenInfo, error)

GenerateToken - Generate token

func (*JWTAuth) ParseUserUUID

func (a *JWTAuth) ParseUserUUID(ctx context.Context, tokenString string) (string, error)

ParseUserUUID - Resolve user UUID

func (*JWTAuth) Release

func (a *JWTAuth) Release() error

Release - Release resources

type Option

type Option func(*options)

Option - Defining parameter items

func SetExpired

func SetExpired(expired int) Option

SetExpired - Set the token expiration time (in seconds, default 7200)

func SetKeyfunc

func SetKeyfunc(keyFunc jwt.Keyfunc) Option

SetKeyfunc - Set the callback function of the verification key

func SetSigningKey

func SetSigningKey(key interface{}) Option

SetSigningKey - Set signature key

func SetSigningMethod

func SetSigningMethod(method jwt.SigningMethod) Option

SetSigningMethod - Set signature method

type Storer

type Storer interface {
	// Store token data and specify expiration time
	Set(ctx context.Context, tokenString string, expiration time.Duration) error
	// Check if the token exists
	Check(ctx context.Context, tokenString string) (bool, error)
	// Close storage
	Close() error
}

Storer - Token storage interface