jwt

Documentation

Index

• Constants
• type Service
  • func New(algo, secretKey string, durations ...int) *Service
  • func (j *Service) GenerateToken(input *TokenInput, output *TokenOutput) error
  • func (j *Service) MWFunc() echo.MiddlewareFunc
  • func (j *Service) ParseToken(input string) (*jwt.Token, error)
  • func (j *Service) ParseTokenFromHeader(c echo.Context) (*jwt.Token, error)
• type TokenInput
• type TokenOutput

Constants

const (
	TypeTokenAccess  = "access_token"
	TypeTokenRefresh = "refresh_token"
)

const

Types

type Service

type Service struct {
	// Algo signing algorithm used for signing.
	Algo jwt.SigningMethod
	// SecretKey used for signing.
	SecretKey []byte
	// AccessKeyDuration duration (in seconds) for which the jwt access token is valid.
	AccessDuration time.Duration
	// RefreshDuration duration (in seconds) for which the jwt refresh token is valid.
	RefreshDuration time.Duration
}

Service provides a Json-Web-Token authentication implementation

func New

func New(algo, secretKey string, durations ...int) *Service

New generates new JWT service necessery for auth middleware

func (*Service) GenerateToken

func (j *Service) GenerateToken(input *TokenInput, output *TokenOutput) error

GenerateToken generates new Service token and populates it with user data

func (*Service) MWFunc

func (j *Service) MWFunc() echo.MiddlewareFunc

MWFunc makes JWT implement the Middleware interface.

func (*Service) ParseToken

func (j *Service) ParseToken(input string) (*jwt.Token, error)

ParseToken parses token from string

func (*Service) ParseTokenFromHeader

func (j *Service) ParseTokenFromHeader(c echo.Context) (*jwt.Token, error)

ParseTokenFromHeader parses token from Authorization header

type TokenInput

type TokenInput struct {
	Type   string                 `json:"type"` // refresh_token or access_token
	Claims map[string]interface{} `json:"claims"`
}

TokenInput represents the input of a token request

type TokenOutput

type TokenOutput struct {
	Token     string `json:"token"`
	ExpiresIn int    `json:"expires_in"`
}

TokenOutput represents the output of a token request