authn_jwt

Documentation

Index

• Variables
• func Client(keyProvider jwt.Keyfunc, opts ...Option) middleware.Middleware
• func Server(opts ...Option) middleware.Middleware
• type Option
  • func WithClaims(f func() jwt.Claims) Option
  • func WithPublicKeyPath(p string) Option
  • func WithSigningMethod(method jwt.SigningMethod) Option
  • func WithTokenHeader(header map[string]interface{}) Option

Variables

var (
	ErrMissingJwtToken        = errors.Unauthorized(reason, "JWT token is missing")
	ErrMissingKeyFunc         = errors.Unauthorized(reason, "keyFunc is missing")
	ErrTokenInvalid           = errors.Unauthorized(reason, "Token is invalid")
	ErrTokenExpired           = errors.Unauthorized(reason, "JWT token has expired")
	ErrTokenParseFail         = errors.Unauthorized(reason, "Fail to parse JWT token ")
	ErrUnSupportSigningMethod = errors.Unauthorized(reason, "Wrong signing method")
	ErrWrongContext           = errors.Unauthorized(reason, "Wrong context for middleware")
	ErrNeedTokenProvider      = errors.Unauthorized(reason, "Token provider is missing")
	ErrSignToken              = errors.Unauthorized(reason, "Can not sign token.Is the key correct?")
	ErrGetKey                 = errors.Unauthorized(reason, "Can not get key while signing token")
)

Functions

func Client

func Client(keyProvider jwt.Keyfunc, opts ...Option) middleware.Middleware

Client is a client jwt middleware.

func Server

func Server(

	opts ...Option) middleware.Middleware

use rsa Server is a server auth middleware. Check the token and extract the info from token.

Types

type Option

type Option func(*options)

Option is jwt option.

func WithClaims

func WithClaims(f func() jwt.Claims) Option

WithClaims with customer claim If you use it in Server, f needs to return a new jwt.Claims object each time to avoid concurrent write problems If you use it in Client, f only needs to return a single object to provide performance

func WithPublicKeyPath

func WithPublicKeyPath(p string) Option

func WithSigningMethod

func WithSigningMethod(method jwt.SigningMethod) Option

WithSigningMethod with signing method option.

func WithTokenHeader

func WithTokenHeader(header map[string]interface{}) Option

WithTokenHeader withe customer tokenHeader for client side