Struct WebSocketUser 

pub struct WebSocketUser(/* private fields */);

Wrapper for extracting an authenticated user during WebSocket upgrade.

This is a convenience wrapper that extracts the User from the HttpRequest extensions during the WebSocket handshake phase.

Spring Security Equivalent

@AuthenticationPrincipal in a WebSocket handler

Example

use actix_web::{get, web, HttpRequest, HttpResponse};
use actix_security::http::security::websocket::WebSocketUser;

#[get("/ws")]
async fn ws_handler(
    req: HttpRequest,
    stream: web::Payload,
) -> Result<HttpResponse, actix_web::Error> {
    // Extract user - returns error if not authenticated
    let user = WebSocketUser::extract(&req)?;

    // Pass user to WebSocket actor
    let resp = actix_ws::start(MyActor::new(user.into_inner()), &req, stream)?;
    Ok(resp)
}

Implementations

impl WebSocketUser

pub fn extract(req: &HttpRequest) -> Result<Self, WebSocketSecurityError>

Extracts the authenticated user from the request.

Errors

Returns WebSocketSecurityError::Unauthorized if no user is present.

pub fn try_extract(req: &HttpRequest) -> Option<Self>

Extracts the user if present, otherwise returns None.

pub fn into_inner(self) -> User

Returns the inner User.

pub fn as_user(&self) -> &User

Returns a reference to the inner User.

pub fn has_role(&self, role: &str) -> bool

Checks if the user has the specified role.

pub fn has_any_role(&self, roles: &[&str]) -> bool

Checks if the user has any of the specified roles.

pub fn has_authority(&self, authority: &str) -> bool

Checks if the user has the specified authority.

pub fn has_any_authority(&self, authorities: &[&str]) -> bool

Checks if the user has any of the specified authorities.

pub fn get_username(&self) -> &str

Returns the username.

pub fn require_role(self, role: &str) -> Result<Self, WebSocketSecurityError>

Requires the user to have the specified role.

Errors

Returns WebSocketSecurityError::MissingRole if the user doesn’t have the role.

pub fn require_any_role( self, roles: &[&str], ) -> Result<Self, WebSocketSecurityError>

Requires the user to have any of the specified roles.

Errors

Returns WebSocketSecurityError::MissingRole if the user doesn’t have any of the roles.

pub fn require_authority( self, authority: &str, ) -> Result<Self, WebSocketSecurityError>

Requires the user to have the specified authority.

Errors

Returns WebSocketSecurityError::MissingAuthority if the user doesn’t have the authority.

pub fn require_any_authority( self, authorities: &[&str], ) -> Result<Self, WebSocketSecurityError>

Requires the user to have any of the specified authorities.

Errors

Returns WebSocketSecurityError::MissingAuthority if the user doesn’t have any of the authorities.

Methods from Deref<Target = User>

pub fn get_username(&self) -> &str

Returns the username.

pub fn get_password(&self) -> &str

Returns the password (for authentication checks).

pub fn get_roles(&self) -> &[String]

Returns the user’s roles.

pub fn get_authorities(&self) -> &[String]

Returns the user’s authorities.

pub fn has_role(&self, role: &str) -> bool

Checks if the user has a specific role.

pub fn has_any_role(&self, roles: &[&str]) -> bool

Checks if the user has ANY of the specified roles (OR logic).

pub fn has_all_roles(&self, roles: &[&str]) -> bool

Checks if the user has ALL of the specified roles (AND logic).

pub fn has_authority(&self, authority: &str) -> bool

Checks if the user has a specific authority.

pub fn has_any_authority(&self, authorities: &[&str]) -> bool

Checks if the user has ANY of the specified authorities (OR logic).

pub fn has_all_authorities(&self, authorities: &[&str]) -> bool

Checks if the user has ALL of the specified authorities (AND logic).

pub fn has_roles(&self, roles: &[String]) -> bool

Checks if the user has ANY of the specified roles (legacy).

Trait Implementations

impl Clone for WebSocketUser

fn clone(&self) -> WebSocketUser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketUser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for WebSocketUser

type Target = User

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<WebSocketUser> for User

fn from(ws_user: WebSocketUser) -> Self

Converts to this type from the input type.