helper

Documentation

Overview

Package helper contains helper functions

Package helper provides helper functions

Index

• func GetClaimsFromRefreshToken(refreshToken string) (jwt.MapClaims, error)
• func GetEchoJWTConfig() echojwt.Config
• func GetJWTPublicKey() interface{}
• func GetJWTRefreshSigningKey() interface{}
• func GetJWTSigningKey() interface{}
• func StrPtr2Str(str *string) string
• type JwtClaims
  • func GetClaimsFromContext(c echo.Context) *JwtClaims
• type TokenDetails
  • func GenerateToken(claims *JwtClaims, t time.Time) (*TokenDetails, error)
• type Validator
  • func NewValidator() *Validator
  • func (v *Validator) Validate(i interface{}) error

Functions

func GetClaimsFromRefreshToken

func GetClaimsFromRefreshToken(refreshToken string) (jwt.MapClaims, error)

GetClaimsFromRefreshToken gets the claims from the refresh token

func GetEchoJWTConfig

func GetEchoJWTConfig() echojwt.Config

GetEchoJWTConfig returns the echo JWT config

func GetJWTPublicKey

func GetJWTPublicKey() interface{}

GetJWTPublicKey gets the JWT public key

func GetJWTRefreshSigningKey

func GetJWTRefreshSigningKey() interface{}

GetJWTRefreshSigningKey gets the JWT refresh signing key

func GetJWTSigningKey

func GetJWTSigningKey() interface{}

GetJWTSigningKey gets the JWT signing key

func StrPtr2Str

func StrPtr2Str(str *string) string

Types

type JwtClaims

type JwtClaims struct {
	UserId      int32  `json:"user_id"`
	Username    string `json:"username"`
	RefreshUUID string `json:"refresh_uuid"` // If 2FA is enabled, this will be false until the user has authenticated with TOTP
	jwt.RegisteredClaims
}

JwtClaims defines the default claims for JWT

func GetClaimsFromContext

func GetClaimsFromContext(c echo.Context) *JwtClaims

GetClaimsFromContext gets the JWT claims from the echo context

type TokenDetails

type TokenDetails struct {
	AccessToken  string
	RefreshToken string
	RefreshUUID  string
	AtExpires    *jwt.NumericDate
	RtExpires    *jwt.NumericDate
}

TokenDetails defines the details of the tokens

func GenerateToken

func GenerateToken(claims *JwtClaims, t time.Time) (*TokenDetails, error)

GenerateToken generates a JWT token

type Validator

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

Validator is a wrapper around the validator package

func NewValidator

func NewValidator() *Validator

NewValidator returns a new Validator

func (*Validator) Validate

func (v *Validator) Validate(i interface{}) error

Validate validates a struct based on the tags