jwtauth

type GinJWTMiddleware[SessInf user.ISessionInfo] struct {
	// Realm name to display to the user. Required.
	Realm string

	// signing algorithm - possible values are HS256, HS384, HS512
	// Optional, default is HS256.
	SigningAlgorithm string

	// Secret key used for signing. Required.
	Key []byte

	// Duration that a jwt token is valid. Optional, defaults to one hour.
	Timeout time.Duration

	// This field allows clients to refresh their token until MaxRefresh has passed.
	// Note that clients can refresh their token in the last moment of MaxRefresh.
	// This means that the maximum validity timespan for a token is TokenTime + MaxRefresh.
	// Optional, defaults to 0 meaning not refreshable.
	MaxRefresh time.Duration

	// Callback function that should perform the authentication of the user based on login info.
	// Must return user data as user identifier, it will be stored in Claim Array. Required.
	// Check error (e) to determine the appropriate error message.
	Authenticator func(c *gin.Context) (interface{}, error)

	// Callback function that should perform the authorization of the authenticated user. Called
	// only after an authentication success. Must return true on success, false on failure.
	// Optional, default to success.
	Authorizator func(data interface{}, c *gin.Context) bool

	// 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.
	PayloadFunc func(data interface{}) MapClaims

	// User can define own Unauthorized func.
	Unauthorized func(*gin.Context, int, string)

	// User can define own LoginResponse func.
	LoginResponse func(*gin.Context, int, string, time.Time)

	// User can define own AntdLoginResponse func.
	AntdLoginResponse func(*gin.Context, int, string, time.Time)

	// User can define own RefreshResponse func.
	RefreshResponse func(*gin.Context, int, string, time.Time)

	// Set the identity handler function
	IdentityHandler func(*gin.Context) interface{}

	// 关键字段，用于存储用户信息
	// Set the identity key
	IdentityKey string
	// 用户名
	NiceKey string
	// 数据权限类型
	DataScopeKey string
	// role key
	RKey string
	// 角色id
	RoleIdKey string
	// 角色key
	RoleKey string
	// 角色名称
	RoleNameKey string

	// TokenLookup is a string in the form of "<source>:<name>" that is used
	// to extract token from the request.
	// Optional. Default value "header:Authorization".
	// Possible values:
	// - "header:<name>"
	// - "query:<name>"
	// - "cookie:<name>"
	TokenLookup string

	// TokenHeadName is a string in the header. Default value is "Bearer"
	TokenHeadName string

	// TimeFunc provides the current time. You can override it to use another time value. This is useful for testing or if your server uses a different time zone than your tokens.
	TimeFunc func() time.Time

	// HTTP Status messages for when something in the JWT middleware fails.
	// Check error (e) to determine the appropriate error message.
	HTTPStatusMessageFunc func(e error, c *gin.Context) string

	// Private key file for asymmetric algorithms
	PrivKeyFile string

	// Public key file for asymmetric algorithms
	PubKeyFile string

	// Optionally return the token as a cookie
	SendCookie bool

	// Allow insecure cookies for development over http
	SecureCookie bool

	// Allow cookies to be accessed client side for development
	CookieHTTPOnly bool

	// Allow cookie domain change for development
	CookieDomain string

	// SendAuthorization allow return authorization header for every request
	SendAuthorization bool

	// Disable abort() of context.
	DisabledAbort bool

	// CookieName allow cookie name change for development
	CookieName string

	SessionInfoConstructor func(map[string]string) (SessInf, error) // 会话信息构造函数
	// contains filtered or unexported fields
}

type GinSessionAuth struct {
	Storage   storage.AdapterCache // 缓存空间
	PrefixKey string               // 缓存key前缀
	Expired   int                  // 有效期(秒)

	GinCtxSessionKey string // gin上下文中的session key

	TokenName   string   // 获取token的key
	TokenLookup []string // 可以获取到token的位置 引文,分割   header,query,cookie

	SessionInfoConstructor func(map[string]string) (user.ISessionInfo, error) // 会话信息构造函数

	CustomLoginHandler IAuthLoginHandler
}

type GinSessionOption func(*GinSessionAuth)

type IAuth interface {
	// 会话验证
	MiddlewareFunc() gin.HandlerFunc

	// 登录处理
	LoginHandler(ctx *gin.Context)

	// 更新session信息
	// @return string token
	UpdateSession(info user.ISessionInfo, expiredAt time.Time) (string, error)

	// 获取当前用户会话信息
	GetSessionInfo(ctx *gin.Context) (user.ISessionInfo, error)

	// 删除会话
	DeleteSession(ctx *gin.Context) error
}

type IAuthLoginHandler func(ctx *gin.Context) (user.ISessionInfo, error)

type LoginResponse struct {
	Code   int                    `json:"code"`            // 状态码
	Token  string                 `json:"token"`           // token
	Msg    string                 `json:"msg"`             // 提示内容
	Expire int                    `json:"expire"`          // 过期时间戳
	Third  map[string]interface{} `json:"third,omitempty"` // 第三方登录信息
}

type MapClaims map[string]interface{}