Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jwt

package module

Go to main page

Versions in this module

v2

v2.9.3

Apr 16, 2023

v2.9.2

Apr 15, 2023

Changes in this version

+ var ErrEmptyAuthHeader = errors.New("auth header is empty")

+ var ErrEmptyCookieToken = errors.New("cookie token is empty")

+ var ErrEmptyParamToken = errors.New("parameter token is empty")

+ var ErrEmptyQueryToken = errors.New("query token is empty")

+ var ErrExpiredToken = errors.New("token is expired")

+ var ErrFailedAuthentication = errors.New("incorrect Username or Password")

+ var ErrFailedTokenCreation = errors.New("failed to create JWT Token")

+ var ErrForbidden = errors.New("you don't have permission to access this resource")

+ var ErrInvalidAuthHeader = errors.New("auth header is invalid")

+ var ErrInvalidPrivKey = errors.New("private key invalid")

+ var ErrInvalidPubKey = errors.New("public key invalid")

+ var ErrInvalidSigningAlgorithm = errors.New("invalid signing algorithm")

+ var ErrMissingAuthenticatorFunc = errors.New("ginJWTMiddleware.Authenticator func is undefined")

+ var ErrMissingExpField = errors.New("missing exp field")

+ var ErrMissingLoginValues = errors.New("missing Username or Password")

+ var ErrMissingSecretKey = errors.New("secret key is required")

+ var ErrNoPrivKeyFile = errors.New("private key file unreadable")

+ var ErrNoPubKeyFile = errors.New("public key file unreadable")

+ var ErrWrongFormatOfExp = errors.New("exp must be float64 format")

+ var IdentityKey = "identity"

+ func GetToken(c *gin.Context) string

+ type GinJWTMiddleware struct

+ Authenticator func(c *gin.Context) (interface{}, error)

+ Authorizator func(data interface{}, c *gin.Context) bool

+ CookieDomain string

+ CookieHTTPOnly bool

+ CookieMaxAge time.Duration

+ CookieName string

+ CookieSameSite http.SameSite

+ DisabledAbort bool

+ HTTPStatusMessageFunc func(e error, c *gin.Context) string

+ IdentityHandler func(*gin.Context) interface{}

+ IdentityKey string

+ Key []byte

+ KeyFunc func(token *jwt.Token) (interface{}, error)

+ LoginResponse func(c *gin.Context, code int, message string, time time.Time)

+ LogoutResponse func(c *gin.Context, code int)

+ MaxRefresh time.Duration

+ ParseOptions []jwt.ParserOption

+ PayloadFunc func(data interface{}) MapClaims

+ PrivKeyBytes []byte

+ PrivKeyFile string

+ PrivateKeyPassphrase string

+ PubKeyBytes []byte

+ PubKeyFile string

+ Realm string

+ RefreshResponse func(c *gin.Context, code int, message string, time time.Time)

+ RefreshTimeout time.Duration

+ SecureCookie bool

+ SendAuthorization bool

+ SendCookie bool

+ SigningAlgorithm string

+ TimeFunc func() time.Time

+ Timeout time.Duration

+ TokenHeadName string

+ TokenLookup string

+ Unauthorized func(c *gin.Context, code int, message string)

+ func New(m *GinJWTMiddleware) (*GinJWTMiddleware, error)

+ func (mw *GinJWTMiddleware) CheckIfTokenExpire(c *gin.Context) (jwt.MapClaims, error)

+ func (mw *GinJWTMiddleware) GetClaimsFromJWT(c *gin.Context) (MapClaims, error)

+ func (mw *GinJWTMiddleware) LoginHandler(c *gin.Context)

+ func (mw *GinJWTMiddleware) LogoutHandler(c *gin.Context)

+ func (mw *GinJWTMiddleware) MiddlewareFunc() gin.HandlerFunc

+ func (mw *GinJWTMiddleware) MiddlewareInit() error

+ func (mw *GinJWTMiddleware) ParseToken(c *gin.Context) (*jwt.Token, error)

+ func (mw *GinJWTMiddleware) ParseTokenString(token string) (*jwt.Token, error)

+ func (mw *GinJWTMiddleware) RefreshHandler(c *gin.Context)

+ func (mw *GinJWTMiddleware) RefreshToken(c *gin.Context) (string, time.Time, error)

+ func (mw *GinJWTMiddleware) TokenGenerator(data interface{}) (string, time.Time, error)

+ type MapClaims map[string]interface

+ func ExtractClaims(c *gin.Context) MapClaims

+ func ExtractClaimsFromToken(token *jwt.Token) MapClaims

v2.9.1-mod3

Apr 15, 2023