auth

type AppOrgsRequest struct {
	// AppCode the app code
	AppCode string `binding:"required" json:"appCode"`
}

type AuthServer interface {
	// AppOrgs Use this API to get app login orgs
	// (POST /login/app-orgs)
	AppOrgs(*gin.Context, *AppOrgsRequest) ([]*Domain, error)
	// BindFingerprint Use this API to enable fingerprint login
	// (POST /login/bind-fingerprint)
	BindFingerprint(*gin.Context, *BindFingerprintRequest) (bool, error)
	// 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)
	// CheckDevice Check whether the device needs verification.
	// (POST /login/check-device)
	CheckDevice(*gin.Context, *CheckDeviceRequest) (*CheckDeviceResponse, error)
	// CreateSpm create spm key.
	// (POST /spm/create)
	CreateSpm(*gin.Context) (string, error)
	// FingerprintLogin Use this API to fingerprint login
	// (POST /login/fingerprint)
	FingerprintLogin(*gin.Context, *FingerprintLoginRequest) (*LoginResponse, 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)
	// GetDomain Use this API to get domain
	// (GET /org/domain)
	GetDomain(*gin.Context, *GetDomainRequest) (*Domain, error)
	// GetPreSignUrl return the temporary authorization access url
	// (POST /oss/presignurl)
	GetPreSignUrl(*gin.Context, *GetPreSignUrlRequest) (*GetPreSignUrlResponse, error)
	// GetSTS return temporary credentials by aws sts
	// (POST /oss/sts)
	GetSTS(*gin.Context, *GetSTSRequest) (*GetSTSResponse, 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
	// OldFingerprintLogin Use this API to fingerprint login
	// (POST /login/old-fingerprint)
	OldFingerprintLogin(*gin.Context, *OldFingerprintLoginRequest) (*LoginResponse, error)
	// OldLoginForApp use this API to compatible old app login
	// (POST /login/old-auth)
	OldLoginForApp(*gin.Context, *OldLoginForAppRequest) (*LoginResponse, error)
	// PasswordPolicy Use this API to get pwd policy
	// (GET /pwd/policy)
	PasswordPolicy(*gin.Context) (*UserPasswordPolicy, 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)
	// Token return access token for oauth2 flow
	// (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)
	// VerifyDevice verify the device login with the verification code.
	// (POST /login/verify-device)
	VerifyDevice(*gin.Context, *VerifyDeviceRequest) (*LoginResponse, error)
	// VerifyDeviceSendEmail the captcha code is sent to the login device.
	// (POST /login/device-captcha)
	VerifyDeviceSendEmail(*gin.Context, *VerifyDeviceSendEmailRequest) (string, 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 BindFingerprintRequest struct {
	// UserPassword the userPassword
	UserPassword string `binding:"required" json:"userPassword"`
}

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 CheckDeviceRequest struct {
	// DeviceInfo device info
	DeviceInfo DeviceInfo `json:"deviceInfo"`
}

type CheckDeviceResponse struct {
	// StateToken use the state token to request callback_url
	StateToken   string             `json:"stateToken,omitempty"`
	Verifies     []*ForgetPwdVerify `json:"verifies,omitempty"`
	VerifyDevice bool               `json:"verifyDevice,omitempty"`
}

type DeviceInfo struct {
	AppVersion    string `json:"appVersion,omitempty"`
	Comments      string `json:"comments,omitempty"`
	DeviceModel   string `json:"deviceModel,omitempty"`
	DeviceName    string `json:"deviceName,omitempty"`
	DeviceUid     string `json:"deviceUid,omitempty"`
	SystemName    string `json:"systemName,omitempty"`
	SystemVersion string `json:"systemVersion,omitempty"`
}

type Domain struct {
	ID             int    `json:"id,omitempty"`
	LocalCurrency  string `json:"local_currency,omitempty"`
	Name           string `json:"name,omitempty"`
	ParentCurrency string `json:"parent_currency,omitempty"`
	// ParentID the top-level parent domain id
	ParentID int `json:"parent_id,omitempty"`
	// ParentName the top-level parent domain name
	ParentName string `json:"parent_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 FingerprintLoginRequest struct {
	// RefreshToken the refreshToken
	RefreshToken string `binding:"required" json:"refreshToken"`
}

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  ForgetPwdVerifyKind `binding:"omitempty,oneof=email mfa" 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 ForgetPwdVerifyKind string

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

type GetDomainRequest struct {
	OrgID int `binding:"required" form:"orgID"`
}

type GetPreSignUrlRequest struct {
	// Bucket do not use the default identity,must be used with endpoint
	Bucket string `json:"bucket,omitempty"`
	// Endpoint do not use the default identity,must be used with bucket
	Endpoint string `json:"endpoint,omitempty"`
	// URL the url of file
	URL string `binding:"required" json:"url"`
}

type GetPreSignUrlResponse struct {
	URL string `json:"url,omitempty"`
}

type GetSTSRequest struct {
	Bucket   string `json:"bucket,omitempty"`
	Endpoint string `json:"endpoint,omitempty"`
}

type GetSTSResponse struct {
	AccessKeyID     string    `json:"access_key_id,omitempty"`
	Expiration      time.Time `json:"expiration,omitempty" time_format:"2006-01-02T15:04:05Z07:00"`
	SecretAccessKey string    `json:"secret_access_key,omitempty"`
	SessionToken    string    `json:"session_token,omitempty"`
}

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

type GrantType string

type Kind string

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"`
	// DeviceId device id,app verify the login device.
	DeviceId string `json:"deviceId,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 OldFingerprintLoginRequest struct {
	AppCode  string `binding:"required" json:"appCode"`
	Password string `binding:"required" json:"password"`
	Username string `binding:"required" json:"username"`
}

type OldLoginForAppRequest struct {
	// AppCode app code,verify login permissions
	AppCode string `binding:"required" json:"appCode"`
	// OtpToken mfa random code
	OtpToken string `binding:"required" json:"otpToken"`
	// Password hashed password
	Password string `binding:"required" json:"password"`
	// Username username or email
	Username string `binding:"required" json:"username"`
}

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
	VerifyDeviceParams struct {
		DefaultBound    bool     `json:"defaultBound"`    // The device is bound by default when logging in for the first time
		ExcludeAccounts []string `json:"excludeAccounts"` // exclude accounts
	} `json:"verifyDeviceParams"`
	JWT struct {
		SigningMethod   string        `json:"signingMethod"`
		SigningKey      string        `json:"signingKey"`
		PrivateKey      string        `json:"privateKey"`
		TokenTTL        time.Duration `json:"tokenTTL"`
		RefreshTokenTTL time.Duration `json:"refreshTokenTTL"`
	} `json:"jwt"`
	PwdPolicy OptionsPwdPolicy `json:"pwdPolicy"`
}

type OptionsPwdPolicy struct {
	// 密码最短长度，长度应在6-32位之间
	Length int32 `json:"length"`
	// 必须包含的元素，异或：1-小写字母，2-大写字母，4-数字，8-符号
	IncludeElement int32 `json:"includeElement"`
	// 最少包含的不同字符数，最多8个，0代表不限制
	IncludeChar int32 `json:"includeChar"`
	// 是否允许包含用户名
	AllowIncludeUserName bool `json:"allowIncludeUserName"`
	// 有效天数，最大1095天，0代表不过期
	InvalidDay int32 `json:"invalidDay"`
	// 过期后是否限制登录
	InvalidLoginLimit bool `json:"invalidLoginLimit"`
	// 一小时内密码错误最多尝试次数，最大32次，0代表不限次数
	Retry int32 `json:"retry"`
	// 密码错误多少次出现验证码，最大5次，0代表不出现验证码
	CaptchaTimes int32 `json:"captchaTimes"`
}

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 Server struct {
	// contains filtered or unexported fields
}

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    GrantType `binding:"required,oneof=client_credentials" 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 {
	Avatar      string    `json:"avatar,omitempty"`
	DisplayName string    `json:"displayName,omitempty"`
	Domains     []*Domain `json:"domains,omitempty"`
	ID          int       `json:"id,omitempty"`
}

type UserPasswordPolicy struct {
	AllowIncludeUserName bool `json:"allowIncludeUserName,omitempty"`
	CaptchaTimes         int  `json:"captchaTimes,omitempty"`
	IncludeChar          int  `json:"includeChar,omitempty"`
	IncludeElement       int  `json:"includeElement,omitempty"`
	InvalidDay           int  `json:"invalidDay,omitempty"`
	InvalidLoginLimit    bool `json:"invalidLoginLimit,omitempty"`
	Length               int  `json:"length,omitempty"`
	Retry                int  `json:"retry,omitempty"`
}

type VerifyDeviceRequest struct {
	Captcha   string `json:"captcha,omitempty"`
	CaptchaId string `json:"captchaId,omitempty"`
	// DeviceInfo device info
	DeviceInfo DeviceInfo `json:"deviceInfo,omitempty"`
	Kind       Kind       `binding:"required,oneof=email mfa" json:"kind"`
	OtpToken   string     `json:"otpToken,omitempty"`
	StateToken string     `binding:"required" json:"stateToken"`
}

type VerifyDeviceSendEmailRequest struct {
	Email      string `binding:"required" json:"email"`
	StateToken string `json:"stateToken,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"`
}