auth

type AuthServer interface {
	// BindMfa Verify a one-time password (OTP) value to binding MFA.
	// (POST /mfa/bind)
	BindMfa(*gin.Context, *BindMfaRequest) (bool, error)
	// BindMfaPrepare Use this api to get the temporary MFA secret key.
	// (POST /mfa/bind-prepare)
	BindMfaPrepare(*gin.Context) (*Mfa, error)
	// Captcha Use this API to get captcha
	// (GET /captcha)
	Captcha(*gin.Context, *CaptchaRequest) (*Captcha, error)
	// CreateSpm create spm key.
	// (POST /spm/create)
	CreateSpm(*gin.Context) (string, error)
	// ForgetPwdBegin start the process of forgetting your password by verifying your account.
	// (POST /forget-pwd/begin)
	ForgetPwdBegin(*gin.Context, *ForgetPwdBeginRequest) (*ForgetPwdBeginResponse, error)
	// ForgetPwdReset reset-password.
	// (POST /forget-pwd/reset)
	ForgetPwdReset(*gin.Context, *ForgetPwdResetRequest) (bool, error)
	// ForgetPwdSendEmail send an email to get the verify code.
	// (POST /forget-pwd/send-email)
	ForgetPwdSendEmail(*gin.Context, *ForgetPwdSendEmailRequest) (string, error)
	// ForgetPwdVerifyEmail verify the email to reset-password.
	// (POST /forget-pwd/verify-email)
	ForgetPwdVerifyEmail(*gin.Context, *ForgetPwdVerifyEmailRequest) (*ForgetPwdBeginResponse, error)
	// ForgetPwdVerifyMfa verify the email to reset-password.
	// (POST /forget-pwd/verify-mfa)
	ForgetPwdVerifyMfa(*gin.Context, *ForgetPwdVerifyMfaRequest) (*ForgetPwdBeginResponse, error)
	// GetSpmAuth get auth data by spm.
	// (POST /spm/auth)
	GetSpmAuth(*gin.Context, *GetSpmAuthRequest) (*LoginResponse, error)
	// Login Use this API to Login
	// (POST /login/auth)
	Login(*gin.Context, *LoginRequest) (*LoginResponse, error)
	// Logout log out a user
	// (POST /logout)
	Logout(*gin.Context) error
	// RefreshToken Use this API to refresh token
	// (POST /login/refresh-token)
	RefreshToken(*gin.Context, *RefreshTokenRequest) (*LoginResponse, error)
	// ResetPassword if login profile demand change password. use this API to reset password.
	// (POST /login/reset-password)
	ResetPassword(*gin.Context, *ResetPasswordRequest) (*LoginResponse, error)
	// (POST /token)
	Token(*gin.Context, *TokenRequest) (*TokenResponse, error)
	// UnBindMfa Verify a one-time password (OTP) value to unBind MFA.
	// (POST /mfa/unbind)
	UnBindMfa(*gin.Context, *UnBindMfaRequest) (bool, error)
	// VerifyFactor Verify a one-time password (OTP) value, provided for a second factor, when multi-factor authentication (MFA) is required.
	// (POST /login/verify-factor)
	VerifyFactor(*gin.Context, *VerifyFactorRequest) (*LoginResponse, error)
}

type BindMfaRequest struct {
	OtpToken   string `binding:"required" json:"otpToken"`
	StateToken string `binding:"required" json:"stateToken"`
}

type Captcha struct {
	CaptchaId    string `json:"captchaId,omitempty"`
	CaptchaImage string `json:"captchaImage,omitempty"`
}

type CaptchaRequest struct {
	// W width of captcha
	W *int `form:"w"`
	// H height of captcha
	H *int `form:"h"`
}

type Domain struct {
	ID   int    `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type Error struct {
	Code    int    `json:"code,omitempty"`
	Details string `json:"details,omitempty"`
	Message string `json:"message,omitempty"`
}

type ErrorResponse struct {
	Errors []*Error `json:"errors,omitempty"`
}

type ForgetPwdBeginRequest struct {
	Captcha   string `binding:"required" json:"captcha"`
	CaptchaId string `binding:"required" json:"captchaId"`
	Username  string `binding:"required" json:"username"`
}

type ForgetPwdBeginResponse struct {
	StateToken    string             `json:"stateToken,omitempty"`
	StateTokenTTL float64            `json:"stateTokenTTL,omitempty"`
	Verifies      []*ForgetPwdVerify `json:"verifies,omitempty"`
}

type ForgetPwdResetRequest struct {
	NewPassword string `binding:"required" json:"newPassword"`
	// StateToken from verify-mfa or verify-email
	StateToken string `binding:"required" json:"stateToken"`
}

type ForgetPwdSendEmailRequest struct {
	// StateToken form begin
	StateToken string `binding:"required" json:"stateToken"`
}

type ForgetPwdVerify struct {
	Kind  string `json:"kind,omitempty"`
	Value string `json:"value,omitempty"`
}

type ForgetPwdVerifyEmailRequest struct {
	// Captcha the email verify code
	Captcha string `binding:"required" json:"captcha"`
	// CaptchaId the email verify code
	CaptchaId string `binding:"required" json:"captchaId"`
	// StateToken form begin
	StateToken string `binding:"required" json:"stateToken"`
}

type ForgetPwdVerifyMfaRequest struct {
	// OtpToken the email verify code
	OtpToken string `binding:"required" json:"otpToken"`
	// StateToken form begin
	StateToken string `binding:"required" json:"stateToken"`
}

type GetSpmAuthRequest struct {
	// Spm the spm key to get auth data
	Spm string `binding:"required" json:"spm"`
}

type LoginRequest struct {
	// Captcha captcha code,if login fail 3 times, the login profile will demand captcha.
	Captcha string `json:"captcha,omitempty"`
	// CaptchaId captcha id,if login fail 3 times, the login profile will demand captcha.
	CaptchaId string `json:"captchaId,omitempty"`
	// Password hashed password
	Password string `binding:"required" json:"password"`
	// Username username or email
	Username string `binding:"required" json:"username"`
}

type LoginResponse struct {
	AccessToken  string `json:"accessToken,omitempty"`
	CallbackUrl  string `json:"callbackUrl,omitempty"`
	ExpiresIn    int    `json:"expiresIn,omitempty"`
	RefreshToken string `json:"refreshToken,omitempty"`
	// StateToken when need MFA or Change PWD. use the state token to request callback_url
	StateToken string `json:"stateToken,omitempty"`
	User       *User  `json:"user,omitempty"`
}

type Mfa struct {
	PrincipalName string `json:"principalName,omitempty"`
	QrCodeUri     string `json:"qrCodeUri,omitempty"`
	Secret        string `json:"secret,omitempty"`
	// StateToken when need MFA or Change PWD. use the state token to request callback_url
	StateToken    string  `json:"stateToken,omitempty"`
	StateTokenTTL float64 `json:"stateTokenTTL,omitempty"`
}

type Options struct {
	// the path key of cache config, default `redis`
	CacheDriverName   string        `json:"cacheDriverName"`
	CaptchaCollectNum int           `json:"captchaCollectNum"` // captcha memory store collect num
	CaptchaExpire     time.Duration `json:"captchaExpire"`     // captcha expire time
	CaptchaLength     int           `json:"captchaLength"`     // captcha length
	CaptchaTimes      int           `json:"captchaTimes"`      // if login fail times, captcha will force show
	CaptchaTTL        time.Duration `json:"captchaTTL"`        // captcha ttl
	LoginFailTimes    int           `json:"loginFailTimes"`    // if login fail times, captcha will force show
	LoginFailLockTime time.Duration `json:"loginFailLockTime"` // lock time while login upper to max fail times
	StateTokenTTL     time.Duration `json:"stateTokenTTL"`     // state token ttl
	StateTokenSecret  string        `json:"stateTokenSecret"`  // state token secret
	SpmTTL            time.Duration `json:"spmTTL"`            // spm ttl
	JWT               struct {
		SigningMethod   string        `json:"signingMethod"`
		SigningKey      string        `json:"signingKey"`
		TokenTTL        time.Duration `json:"tokenTTL"`
		RefreshTokenTTL time.Duration `json:"refreshTokenTTL"`
	} `json:"jwt"`
}

type RefreshTokenRequest struct {
	// RefreshToken the refreshToken
	RefreshToken string `binding:"required" json:"refreshToken"`
}

type ResetPasswordRequest struct {
	NewPassword string `binding:"required" json:"newPassword"`
	StateToken  string `binding:"required" json:"stateToken"`
}

type ServerImpl struct {
	Options

	LogoutHandler func(*gin.Context)
	// contains filtered or unexported fields
}

type TokenRequest struct {
	ClientID     string `binding:"required" form:"client_id"`
	ClientSecret string `binding:"required" form:"client_secret"`
	GrantType    string `binding:"required" form:"grant_type"`
}

type TokenResponse struct {
	AccessToken string `json:"access_token,omitempty"`
	ExpiresIn   int    `json:"expires_in,omitempty"`
}

type UnBindMfaRequest struct {
	OtpToken string `binding:"required" json:"otpToken"`
}

type UnimplementedAuthServer struct {
}

type User struct {
	AvatarFileId int       `json:"avatarFileId,omitempty"`
	DisplayName  string    `json:"displayName,omitempty"`
	Domains      []*Domain `json:"domains,omitempty"`
	ID           int       `json:"id,omitempty"`
}

type VerifyFactorRequest struct {
	// DeviceId provide the MFA deviceId. the deviceId is register by MFA setting.
	DeviceId   string `binding:"required" json:"deviceId"`
	OtpToken   string `binding:"required" json:"otpToken"`
	StateToken string `binding:"required" json:"stateToken"`
}