api

func Authenticator ¶

func Authenticator(r *ghttp.Request) (interface{}, error)

Authenticator is used to validate login parameters. It must return user data as user identifier, it will be stored in Claim Array. if your identityKey is 'id', your user data must have 'id' Check error (e) to determine the appropriate error message.

func GUserPing ¶

func GUserPing(r *ghttp.Request)

func IdentityHandler ¶

func IdentityHandler(r *ghttp.Request) interface{}

IdentityHandler get the identity from JWT and set the identity for every request Using this function, by r.GetParam("id") get identity

func LoginResponse ¶

func LoginResponse(r *ghttp.Request, code int, token string, expire time.Time)

LoginResponse is used to define customized login-successful callback function.

func LogoutResponse ¶

func LogoutResponse(r *ghttp.Request, code int)

LogoutResponse is used to set token blacklist.

func PayloadFunc ¶

func PayloadFunc(data interface{}) jwt.MapClaims

PayloadFunc is a callback function that will be called during login. Using this function it is possible to add additional payload data to the webtoken. The data is then made available during requests via c.Get("JWT_PAYLOAD"). Note that the payload is not encrypted. The attributes mentioned on jwt.io can't be used as keys for the map. Optional, by default no additional data will be set.

func RefreshResponse ¶

func RefreshResponse(r *ghttp.Request, code int, token string, expire time.Time)

RefreshResponse is used to get a new token no matter current token is expired or not.

func Unauthorized ¶

func Unauthorized(r *ghttp.Request, code int, message string)

Unauthorized is used to define customized Unauthorized callback function.