ginjwt

README

Jwt Authentication middleware for gin framework

---

base on lestrrat-go/jwx module

Documentation

Index

• Constants
• Variables
• type JwtAuthMiddleware
• type JwtAuthentication
  • func (ja *JwtAuthentication) AuthenticationMiddleware() gin.HandlerFunc
  • func (ja *JwtAuthentication) LoginHandler(c *gin.Context)
  • func (ja *JwtAuthentication) LoginRequiredMiddleware() gin.HandlerFunc
• type TokenLookup

Constants

const (
	Header fetchType = iota
	Cookie
)

Variables

var (
	ErrorUnauthorized = fmt.Errorf("login required")
)

Types

type JwtAuthMiddleware

type JwtAuthMiddleware interface {
	AuthenticationMiddleware() gin.HandlerFunc
	LoginRequiredMiddleware() gin.HandlerFunc
	LoginHandler()
	// contains filtered or unexported methods
}

type JwtAuthentication

type JwtAuthentication struct {
	Authenticator func(c *gin.Context) (interface{}, error)
	Authorizator  func(data interface{}) (interface{}, error)
	SecretKey     interface{}
	Algorithm     jwa.SignatureAlgorithm
	IdentityKey   string
	TokenLookup   TokenLookup
	TokenHeadName string
}

func (*JwtAuthentication) AuthenticationMiddleware

func (ja *JwtAuthentication) AuthenticationMiddleware() gin.HandlerFunc

func (*JwtAuthentication) LoginHandler

func (ja *JwtAuthentication) LoginHandler(c *gin.Context)

func (*JwtAuthentication) LoginRequiredMiddleware

func (ja *JwtAuthentication) LoginRequiredMiddleware() gin.HandlerFunc

type TokenLookup

type TokenLookup struct {
	From fetchType
	Name string
}