authep

type AuthSvc interface {
	Login(ctx context.Context, req *LoginRequest) (*apiresource.User, *apierror.APIError)
	Register(ctx context.Context, req *RegisterRequest) (*apiresource.User, *apierror.APIError)
	MagicLogin(ctx context.Context, req *MagicLoginRequest) (*apiresource.User, *apierror.APIError)
	RefreshToken(ctx context.Context, req *RefreshTokenRequest) (*apiresource.EmptyResource, *apierror.APIError)
	RequestPasswordReset(ctx context.Context, req *RequestPasswordResetRequest) (*apiresource.EmptyResource, *apierror.APIError)
	ResetPassword(ctx context.Context, req *ResetPasswordRequest) (*apiresource.EmptyResource, *apierror.APIError)
	RevokeRefreshToken(ctx context.Context, req *RevokeRefreshTokenRequest) (*apiresource.EmptyResource, *apierror.APIError)
	UpdatePassword(ctx context.Context, req *UpdatePasswordRequest) (*apiresource.EmptyResource, *apierror.APIError)
	UpdateScannerPassword(ctx context.Context, req *UpdateScannerPasswordRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

type AuthSvcConfig struct {
	// AuthClient (required) is the auth-service gRPC client.
	AuthClient pb.AuthServiceClient

	// CoreClient (required) is the core-service gRPC client.
	CoreClient corepb.CoreServiceClient
}

type LoginEndpoint struct{}

type LoginRequest struct {
	// Username or email for authentication.
	Identifier string `json:"identifier" validate:"required,identifier"`
	// User password.
	Password string `json:"password" validate:"required,max=72" sensitive:"true"` // #nosec G117 - Struct field, not a hardcoded credential
}

type MagicLoginEndpoint struct{}

type MagicLoginRequest struct {
	// Magic login token taken from the `t` query parameter of the link in the "already registered" email.
	//
	// The token expires 15 minutes after the email is sent.
	Token string `json:"token" validate:"required" sensitive:"true"` // #nosec G117 - Struct field, not a hardcoded credential
}

type RefreshTokenEndpoint struct{}

type RefreshTokenRequest struct {
	// Refresh token, read from the `__Secure-openmrp.refresh-token` cookie.
	RefreshToken string `cookie:"__Secure-openmrp.refresh-token" validate:"required"` // #nosec G117 - Struct field, not a hardcoded credential
}

type RegisterEndpoint struct{}

type RegisterRequest struct {
	// Email address the user will sign in with.
	//
	// Must not already belong to a user; the request is rejected without revealing that the address is taken.
	Email string `json:"email" validate:"required,custom_email"`
	// Password the user will sign in with.
	Password string `json:"password" validate:"required,password" sensitive:"true"` // #nosec G117 - Struct field, not a hardcoded credential
	// Full name of the user, used to address them in emails.
	Name string `json:"name" validate:"required"`
	// Slug of the customer portal the user is registering from.
	//
	// Only affects the "already registered" email sent when the address is taken: it points the magic-login link back at that portal instead of the generic dashboard. Accounts with a verified custom portal domain use that domain in the link instead of the slug.
	AccountSlug field.Optional[string] `json:"account_slug,omitzero" validate:"omitempty"`
}

type RequestPasswordResetEndpoint struct{}

type RequestPasswordResetRequest struct {
	// Username or email of the user whose password should be reset.
	//
	// The reset link is always sent to the email address on file for the matched user, and no email is sent if that user has no address on file.
	Identifier string `json:"identifier" validate:"required,identifier"`
	// Slug of the customer portal the request came from.
	//
	// Scopes the emailed reset link to that portal so the user sets their new password there instead of on the generic dashboard. Accounts with a verified custom portal domain use that domain in the link instead of the slug.
	AccountSlug field.Optional[string] `json:"account_slug,omitzero"`
}

type ResetPasswordEndpoint struct{}

type ResetPasswordRequest struct {
	// Password reset token taken from the `t` query parameter of the link in the password reset email.
	//
	// The token expires 15 minutes after the email is sent; after that the user has to request a new reset email.
	Token string `json:"token" validate:"required" sensitive:"true"` // #nosec G117 - Struct field, not a hardcoded credential
	// New password to set for the user.
	Password string `json:"password" validate:"required,password" sensitive:"true"` // #nosec G117 - Struct field, not a hardcoded credential
}

type RevokeRefreshTokenEndpoint struct{}

type RevokeRefreshTokenRequest struct {
	// Refresh token to revoke, read from the `__Secure-openmrp.refresh-token` cookie.
	RefreshToken string `cookie:"__Secure-openmrp.refresh-token" validate:"required"` // #nosec G117 - Struct field, not a hardcoded credential
}

type UpdatePasswordEndpoint struct{}

type UpdatePasswordRequest struct {
	// Current password.
	OldPassword string `json:"old_password" validate:"required,password,max=255" sensitive:"true"`
	// New password.
	NewPassword string `json:"new_password" validate:"required,password,max=255" sensitive:"true"`
}

type UpdateScannerPasswordEndpoint struct{}

type UpdateScannerPasswordRequest struct {
	// ID of the account user whose password is being changed.
	//
	// Must belong to the caller's account and hold a scanner role; requests targeting any other user are rejected.
	AccountUserID string `json:"account_user_id" validate:"required"`
	// The caller's own current password, used to confirm the caller's identity before the scanner password is changed.
	RequesterPassword string `json:"requester_password" validate:"required,password,max=255" sensitive:"true"`
	// New password to set for the scanner user.
	NewPassword string `json:"new_password" validate:"required,password,max=255" sensitive:"true"`
}