jwt

README

GO JWT Validate

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Installation
• Usage
• Contributing
• License

About The Project

This is a simple gin middleware to validate JWT tokens with a given public key.

It is mostly inspired by gin-jwt.

Built With

• Golang
• gin-gonic

Getting Started

Briefly describe how a new developer can run the project and get started.

Installation

go get  ...

Usage

See example.go

Roadmap

Describe or link to any planned work for this project.:w

Contributing

Contributions are welcomed and appreciated 😊.

License

MIT. Seee LICENSE for more information.

Documentation

Index

• Variables
• func GetToken(c *gin.Context) string
• type JWTMiddleware
  • func NewJWTValidationMiddleware(jwtm *JWTMiddleware) (*JWTMiddleware, error)
  • func (jwtm *JWTMiddleware) GetClaimsFromJWT(c *gin.Context) (MapClaims, error)
  • func (jwtm *JWTMiddleware) TokenValidationMiddleware() gin.HandlerFunc
  • func (jwtm *JWTMiddleware) VerifyToken(c *gin.Context) (*jwt.Token, error)
• type MapClaims
  • func ExtractClaims(c *gin.Context) MapClaims
  • func ExtractClaimsFromToken(token *jwt.Token) MapClaims

Variables

var (
	// ErrEmptyAuthHeader can be thrown if authing with a HTTP header, the Auth header needs to be set
	ErrEmptyAuthHeader = errors.New("middleware header is empty")

	// ErrInvalidAuthHeader indicates middleware header is invalid, could for example have the wrong Realm name
	ErrInvalidAuthHeader = errors.New("middleware header is invalid")

	ErrInvalidKeyPath = errors.New("middleware pub key path is invalid")
)

Functions

func GetToken

func GetToken(c *gin.Context) string

GetToken help to get the JWT token string

Types

type JWTMiddleware

type JWTMiddleware struct {
	PubKeyPath string

	HeaderName   string
	HeaderPrefix string
	// contains filtered or unexported fields
}

func NewJWTValidationMiddleware

func NewJWTValidationMiddleware(jwtm *JWTMiddleware) (*JWTMiddleware, error)

func (*JWTMiddleware) GetClaimsFromJWT

func (jwtm *JWTMiddleware) GetClaimsFromJWT(c *gin.Context) (MapClaims, error)

GetClaimsFromJWT get claims from JWT token

func (*JWTMiddleware) TokenValidationMiddleware

func (jwtm *JWTMiddleware) TokenValidationMiddleware() gin.HandlerFunc

func (*JWTMiddleware) VerifyToken

func (jwtm *JWTMiddleware) VerifyToken(c *gin.Context) (*jwt.Token, error)

VerifyToken verifies the token is valid and signed with the correct key

type MapClaims

type MapClaims = map[string]interface{}

func ExtractClaims

func ExtractClaims(c *gin.Context) MapClaims

ExtractClaims help to extract the JWT claims

func ExtractClaimsFromToken

func ExtractClaimsFromToken(token *jwt.Token) MapClaims

ExtractClaimsFromToken help to extract the JWT claims from token