jwt

README

gin_jwt

Documentation

Index

• Constants
• func FromAuthHeader(ctx *gin.Context) (string, error)
• func OnError(ctx *gin.Context, err string)
• type Config
• type Middleware
  • func New(cfg ...Config) *Middleware
  • func (m *Middleware) CheckJWT(ctx *gin.Context) error
  • func (m *Middleware) Get(ctx *gin.Context) (*jwt.Token, error)
  • func (m *Middleware) Serve(ctx *gin.Context)
• type TokenExtractor
  • func FromFirst(extractors ...TokenExtractor) TokenExtractor
  • func FromParameter(param string) TokenExtractor

Constants

const (
	//DefaultContextKey jwt
	DefaultContextKey = "jwt"
)

Functions

func FromAuthHeader

func FromAuthHeader(ctx *gin.Context) (string, error)

FromAuthHeader is a "TokenExtractor" that takes a give context and extracts the JWT token from the Authorization header.

func OnError

func OnError(ctx *gin.Context, err string)

OnError default error handler

Types

type Config

type Config struct {
	// The function that will return the Key to validate the JWT.
	// It can be either a shared secret or a public key.
	// Default value: nil
	ValidationKeyGetter jwt.Keyfunc
	// The name of the property in the request where the user (&token) information
	// from the JWT will be stored.
	// Default value: "jwt"
	ContextKey string
	// The function that will be called when there's an error validating the token
	// Default value:
	ErrorHandler errorHandler
	// A boolean indicating if the credentials are required or not
	// Default value: false
	CredentialsOptional bool
	// A function that extracts the token from the request
	// Default: FromAuthHeader (i.e., from Authorization header as bearer token)
	Extractor TokenExtractor
	// Debug flag turns on debugging output
	// Default: false
	Debug bool
	// When set, all requests with the OPTIONS method will use authentication
	// if you enable this option you should register your route with iris.Options(...) also
	// Default: false
	EnableAuthOnOptions bool
	// When set, the middelware verifies that tokens are signed with the specific signing algorithm
	// If the signing method is not constant the ValidationKeyGetter callback can be used to implement additional checks
	// Important to avoid security issues described here: https://auth0.com/blog/2015/03/31/critical-vulnerabilities-in-json-web-token-libraries/
	// Default: nil
	SigningMethod jwt.SigningMethod
	// When set, the expiration time of token will be check every time
	// if the token was expired, expiration error will be returned
	// Default: false
	Expiration bool
}

Config is a struct for specifying configuration options for the jwt middleware.

type Middleware

type Middleware struct {
	Config Config
}

Middleware the middleware for JSON Web tokens authentication method

func New

func New(cfg ...Config) *Middleware

New constructs a new Secure instance with supplied options.

func (*Middleware) CheckJWT

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

CheckJWT the main functionality, checks for token

func (*Middleware) Get

func (m *Middleware) Get(ctx *gin.Context) (*jwt.Token, error)

func (*Middleware) Serve

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

Serve the middleware's action

type TokenExtractor

type TokenExtractor func(*gin.Context) (string, error)

TokenExtractor is a function that takes a context as input and returns either a token or an error. An error should only be returned if an attempt to specify a token was found, but the information was somehow incorrectly formed. In the case where a token is simply not present, this should not be treated as an error. An empty string should be returned in that case.

func FromFirst

func FromFirst(extractors ...TokenExtractor) TokenExtractor

FromFirst returns a function that runs multiple token extractors and takes the first token it finds

func FromParameter

func FromParameter(param string) TokenExtractor

FromParameter returns a function that extracts the token from the specified query string parameter