clientapi

type AuthBody struct {
	Type        string       `json:"type"`
	AccessToken string       `json:"access_token,omitempty"`
	TfaType     string       `json:"tfa_type,omitempty"`
	Secret      string       `json:"secret,omitempty"`
	User        *UserPayload `json:"user,omitempty"`
}

type Deps struct {
	Log     *slog.Logger
	Config  *config.Config
	Store   *store.Store
	AEAD    *crypto.AEAD
	JWT     *auth.ClientJWT
	Hasher  *auth.Hasher
	Limiter auth.Limiter
	Metrics prometheus.Registerer
	// Telemetry counts logins, issued tokens and audit records (nil: none).
	Telemetry *metrics.Panel

	// LDAP authenticates corporate users when password authentication fails or user is unprovisioned.
	LDAP LDAPAuthenticator
	// TOTP verifies the second factor (default NoTOTP).
	TOTP TOTPVerifier
	// Email is the e-mail second factor (default NoEmailFactor).
	Email EmailFactor
	// Kicks delivers admin "disconnect" requests through heartbeats (default:
	// a private MemKickQueue; share one with the admin API).
	Kicks KickQueue
	// WebSessions resolves web client session ids ("web-…") to panel users
	// for connection rules (nil: web clients count as unknown controllers).
	WebSessions WebSessionResolver
	// Strategies supplies heartbeat strategies (optional).
	Strategies StrategyProvider
	// DeviceRate limits unauthenticated device calls per IP (zero value:
	// DefaultDeviceRate; Rate < 0 disables).
	DeviceRate RateConfig
	// Now is the clock (default time.Now).
	Now func() time.Time
}

type EmailFactor interface {
	// LoginFactorRequired reports whether u must enter an e-mailed code
	// (checked only for users without TOTP).
	LoginFactorRequired(ctx context.Context, u *store.User) (bool, error)
	// SendLoginCode e-mails a sign-in code to u. Errors implementing
	// RetryAfter() time.Duration are rate limits.
	SendLoginCode(ctx context.Context, u *store.User, ip string) error
	// VerifyLoginCode checks and consumes a code (limited attempts per code).
	VerifyLoginCode(ctx context.Context, userID int64, code string) (bool, error)
}

type KickQueue interface {
	// Kick asks device rustdeskID to close connections connIDs (the client's
	// conn ids, as reported in heartbeat "conns" and audit "conn_id"); with
	// no ids every live connection is closed. Requests expire if the device
	// does not heartbeat in time.
	Kick(rustdeskID string, connIDs ...int32)
	// Take removes and returns the connection ids to close, given the live
	// connection ids the device reported in its heartbeat.
	Take(rustdeskID string, live []int32) []int32
}

type LDAPAuthenticator interface {
	Authenticate(ctx context.Context, username, password string) (*store.User, error)
}

type LoginContext struct {
	// Method is store.LoginMethodPassword / LoginMethodOIDC / LoginMethodWebAuth.
	Method string
	// DeviceID and DeviceUUID are the client's RustDesk id and base64 uuid.
	DeviceID   string
	DeviceUUID string
	// Platform is deviceInfo.os; ClientKind is deviceInfo.type ("client", "browser").
	Platform   string
	ClientKind string
	IP         string
	UserAgent  string
}

type MemKickQueue struct {
	// contains filtered or unexported fields
}

type NoEmailFactor struct{}

type NoTOTP struct{}

type RateConfig struct {
	Rate  float64
	Burst int
}

type Strategy struct {
	// ModifiedAt identifies the strategy version (the client echoes it back).
	ModifiedAt    int64
	ConfigOptions map[string]string
	Extra         map[string]string
}

type StrategyProvider interface {
	StrategyFor(ctx context.Context, d *store.Device) (*Strategy, error)
}

type TOTPVerifier interface {
	// Enrolled reports whether userID has a confirmed second factor.
	Enrolled(ctx context.Context, userID int64) (bool, error)
	// Verify checks a TOTP or recovery code for userID, enforcing replay
	// protection, and reports whether it was accepted.
	Verify(ctx context.Context, userID int64, code string) (bool, error)
}

type TokenIssuer struct {
	// contains filtered or unexported fields
}

type UserInfo struct {
	EmailVerification      bool `json:"email_verification"`
	EmailAlarmNotification bool `json:"email_alarm_notification"`
}

type UserPayload struct {
	Name        string   `json:"name"`
	DisplayName string   `json:"display_name"`
	Avatar      string   `json:"avatar"`
	Email       string   `json:"email"`
	Note        string   `json:"note"`
	Status      int      `json:"status"`
	IsAdmin     bool     `json:"is_admin"`
	Info        UserInfo `json:"info"`
}

type WebSessionResolver interface {
	User(id string) (int64, bool)
}