auth

Documentation

Index

• Constants
• Variables
• func GinJwtAuth(function gin.HandlerFunc, selfAccess, optional bool, roles ...string) gin.HandlerFunc
• func Init(secret string, expTime int64) error
• type UserClaims
  • func GetClaimFromContext(ctx *gin.Context) *UserClaims
  • func ValidateToken(tokenString string) (*UserClaims, error)
  • func (u *UserClaims) CheckRoles(roles ...string) bool
  • func (u *UserClaims) GenerateToken() (*string, error)

Constants

const (
	UserRoleAdmin        = "ADMIN"
	InternalServicesRole = "INTERNAL_SERVICES"
	SuperUserRole        = "SUPER_USER"
)

Variables

var (
	SecretKey []byte
	ExpTime   int64
)

Functions

func GinJwtAuth

func GinJwtAuth(function gin.HandlerFunc, selfAccess, optional bool, roles ...string) gin.HandlerFunc

GinJwtAuth gin middleware for authentication jwt token

func Init

func Init(secret string, expTime int64) error

Init manual

Types

type UserClaims

type UserClaims struct {
	jwt.StandardClaims
	UserID   interface{} `json:"uid"`
	Username *string     `json:"username,omitempty"`
	AppID    *string     `json:"app_id,omitempty"`
	Email    *string     `json:"email,omitempty"`
	Status   *string     `json:"status,omitempty"`
	Roles    []string    `json:"roles"`
}

UserClaims struct

func GetClaimFromContext

func GetClaimFromContext(ctx *gin.Context) *UserClaims

GetClaimFromContext get claim from gin context

func ValidateToken

func ValidateToken(tokenString string) (*UserClaims, error)

ValidateToken validate token

func (*UserClaims) CheckRoles

func (u *UserClaims) CheckRoles(roles ...string) bool

CheckRoles check access roles

func (*UserClaims) GenerateToken

func (u *UserClaims) GenerateToken() (*string, error)

GenerateToken generate jwt token