jwt

Documentation

Overview

Package jwt provides the hiboot starter for injectable jwt dependency

Index

• Constants
• type Controller
  • func (c *Controller) JwtProperties() (propMap map[string]interface{}, ok bool)
  • func (c *Controller) JwtPropertiesString() (propMap map[string]string, ok bool)
  • func (c *Controller) JwtProperty(propName string) (propVal string)
  • func (c *Controller) ParseToken(claims jwt.MapClaims, prop string) (retVal string)
• type Map
• type Middleware
  • func NewJwtMiddleware(cfg ...mwjwt.Config) *Middleware
  • func (m *Middleware) CheckJWT(ctx context.Context) error
  • func (m *Middleware) Serve(ctx context.Context)
• type Properties
• type Token
  • func NewJwtToken(p *Properties) (token Token)

Constants

const (
	// Profile is the profile of jwt, it should be as same as the package name
	Profile = "jwt"
)

Types

type Controller

type Controller struct {
	at.JwtRestController
	web.Controller
}

Controller is the base web controller that enabled JWT

func (*Controller) JwtProperties

func (c *Controller) JwtProperties() (propMap map[string]interface{}, ok bool)

JwtProperties is an util that parsing JWT token and return all properties from jwt.MapClaims

func (*Controller) JwtPropertiesString

func (c *Controller) JwtPropertiesString() (propMap map[string]string, ok bool)

JwtPropertiesString is an util that parsing JWT token and return all properties in string from jwt.MapClaims

func (*Controller) JwtProperty

func (c *Controller) JwtProperty(propName string) (propVal string)

JwtProperty is an util that parsing JWT token and return single property from jwt.MapClaims

func (*Controller) ParseToken

func (c *Controller) ParseToken(claims jwt.MapClaims, prop string) (retVal string)

ParseToken is an util that parsing JWT token from jwt.MapClaims

type Map

type Map map[string]interface{}

Map is the JWT map

type Middleware

type Middleware struct {
	mwjwt.Middleware
}

Middleware derived from github.com/iris-contrib/middleware/jwt/Middleware

func NewJwtMiddleware

func NewJwtMiddleware(cfg ...mwjwt.Config) *Middleware

NewJwtMiddleware New constructs a new Secure instance with supplied options.

func (*Middleware) CheckJWT

func (m *Middleware) CheckJWT(ctx context.Context) error

CheckJWT the main functionality, checks for token

func (*Middleware) Serve

func (m *Middleware) Serve(ctx context.Context)

Serve the middleware's action

type Properties

type Properties struct {
	PrivateKeyPath string `json:"private_key_path" default:"config/ssl/app.rsa"`
	PublicKeyPath  string `json:"public_key_path" default:"config/ssl/app.rsa.pub"`
}

Properties the jwt properties

type Token

type Token interface {
	Generate(payload Map, expired int64, unit time.Duration) (string, error)
	VerifyKey() *rsa.PublicKey
}

Token is the token interface

func NewJwtToken

func NewJwtToken(p *Properties) (token Token)

NewJwtToken create new jwt token