Struct FormLoginHandler 

pub struct FormLoginHandler { /* private fields */ }

Form login handler for processing login/logout requests.

Spring Security Equivalent

Similar to UsernamePasswordAuthenticationFilter in Spring Security.

Example

use actix_security_core::http::security::form_login::{FormLoginHandler, FormLoginConfig, LoginForm};
use actix_security_core::http::security::session::SessionConfig;

let handler = FormLoginHandler::new(
    FormLoginConfig::new(),
    SessionConfig::new(),
);

// In your login route handler
async fn login(
    session: Session,
    form: Form<LoginForm>,
    authenticator: Data<MemoryAuthenticator>,
    handler: Data<FormLoginHandler>,
) -> impl Responder {
    // Validate credentials
    if let Some(user) = authenticator.verify_credentials(&form.username, &form.password) {
        handler.on_authentication_success(&session, &user, None)
    } else {
        handler.on_authentication_failure()
    }
}

Implementations

impl FormLoginHandler

pub fn new( config: FormLoginConfig, session_config: SessionConfig, ) -> FormLoginHandler

Create a new form login handler.

pub fn on_authentication_success( &self, session: &Session, user: &User, saved_url: Option<String>, ) -> HttpResponse

Handle successful authentication.

This method:

1. Stores user in session
2. Redirects to saved request URL or default success URL

Arguments

• session - The actix session
• user - The authenticated user
• saved_url - Optional saved URL from before login redirect

pub fn on_authentication_failure(&self) -> HttpResponse

Handle failed authentication.

Redirects to the failure URL.

pub fn on_logout(&self, session: &Session) -> HttpResponse

Handle logout.

This method:

1. Removes user from session
2. Redirects to logout success URL

pub fn save_request(&self, session: &Session, url: &str)

Save the current request URL for redirect after login.

Call this before redirecting to the login page.

pub fn login_page_url(&self) -> &str

Get the login page URL.

pub fn login_processing_url(&self) -> &str

Get the login processing URL.

pub fn logout_url(&self) -> &str

Get the logout URL.

pub fn is_login_page(&self, url: &str) -> bool

Check if a URL is the login page.

pub fn is_login_processing_url(&self, url: &str) -> bool

Check if a URL is the login processing URL.

pub fn is_logout_url(&self, url: &str) -> bool

Check if a URL is the logout URL.

pub fn config(&self) -> &FormLoginConfig

Get the form login configuration.

pub fn session_config(&self) -> &SessionConfig

Get the session configuration.

Trait Implementations

impl Clone for FormLoginHandler

fn clone(&self) -> FormLoginHandler

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.