jwttoken

Documentation

Index

• Constants
• Variables
• type Config
• type JwtToken
• type SessionUserClaims
• type TokenDuration
  • func (receiver *TokenDuration) UnmarshalText(text []byte) error

Constants

const (
	DefaultAccessTokenDuration  = time.Hour * 24
	DefaultRefreshTokenDuration = time.Hour * 24 * 30
)

Variables

var (
	ErrUnsupportedSigningMethod = errors.New("unsupported signing method")
	ErrTokenInvalid             = errors.New("the token has an invalid")

	ErrTokenInvalidUID   = errors.New("token has invalid UID")
	ErrTokenInvalidEmail = errors.New("token has invalid email")
)

Types

type Config

type Config struct {
	JwtSecretKey     string `env:"JWT_SECRET_KEY"`
	JwtSigningMethod string `env:"JWT_SIGNING_METHOD" envDefault:"HS512"`

	// default: 15 minutes
	JwtAccessTokenDurationInSeconds  TokenDuration `env:"JWT_ACCESS_TOKEN_DURATION" envDefault:"86400"`
	JwtRefreshTokenDurationInSeconds TokenDuration `env:"JWT_REFRESH_TOKEN_DURATION" envDefault:"2592000"`
}

type JwtToken

type JwtToken interface {
	SetSecretKey(secretKey []byte, signMethod jwt.SigningMethod)

	CreateAccessToken(context.Context, model.SessionUser) (string, *time.Time, error)
	CreateRefreshToken(context.Context, model.SessionUser) (string, *time.Time, error)
	CreateTokenCustomDuration(context.Context, model.SessionUser, time.Duration) (string, *time.Time, error)

	Parse(ctx context.Context, tokenString string) (*model.SessionUser, error)
}

type SessionUserClaims

type SessionUserClaims struct {
	UID   uuid.UUID `json:"uid,omitempty"`
	Email string    `json:"email,omitempty"`

	jwt.RegisteredClaims
}

type TokenDuration

type TokenDuration time.Duration

func (*TokenDuration) UnmarshalText

func (receiver *TokenDuration) UnmarshalText(text []byte) error