Documentation
¶
Index ¶
- Constants
- func DeleteToken(jwtToken string) bool
- func ExtractToken(c *core.Ctx) string
- func GetUserByToken(jwtToken string) *model.User
- func IsBlockedToken(jwtToken string) (bool, error)
- func IsValidRefreshToken(refreshToken string) bool
- func New(excludes ...string) core.MiddlewareHandler
- func SignOut(jwtToken string) error
- func SignUp(signUp *dto.SignUp) (*model.User, error)
- type TokenMetadata
- type Tokens
Constants ¶
const ( // User model User string = "__jwt_user__" )
Keep user ID. c.SetData(constants.UserID, claims.UserID.String())
Variables ¶
This section is empty.
Functions ¶
func DeleteToken ¶ added in v1.0.2
DeleteToken add jwtToken to blacklist
func ExtractToken ¶ added in v1.0.2
ExtractToken func to get JWT from header.
func GetUserByToken ¶
GetUserByToken returns User by JWT token
func IsBlockedToken ¶ added in v1.0.2
IsBlockedToken Check if jwtToken is locked or not
func IsValidRefreshToken ¶
IsValidRefreshToken func for parse second argument from refresh token. A refresh token is valid is not expired.
func New ¶
func New(excludes ...string) core.MiddlewareHandler
New an HTTP middleware that process login via JWT token.
Use:
app.Use(jwt.New( prefixAPI+"/info", prefixAPI+"/auth/signin", prefixAPI+"/auth/refresh", ))
func SignOut ¶
SignOut function takes in jwtToken string, utils.ExtractTokenMetadata extract access token metadata to get a userID which is the key that store refresh token in the Redis Caching then delete refresh token from the Redis and DeleteToken will delete access token by send it to black-list (middleware will handle invalid token in blacklist).
Types ¶
type TokenMetadata ¶
TokenMetadata struct to describe metadata in JWT.
func ExtractTokenMetadata ¶
func ExtractTokenMetadata(tokenString string) (*TokenMetadata, error)
ExtractTokenMetadata func to extract metadata from JWT.
type Tokens ¶
Tokens struct to describe tokens object.
func GenerateTokens ¶
GenerateTokens func for generate a new Access & Refresh tokens.
func RefreshToken ¶ added in v1.0.2
RefreshToken function to refresh JWT token from user.