Enum WebSocketSecurityError 

pub enum WebSocketSecurityError {
    Unauthorized,
    MissingOrigin,
    InvalidOrigin {
        origin: String,
    },
    MissingRole {
        role: String,
    },
    MissingAuthority {
        authority: String,
    },
}

Errors that can occur during WebSocket security validation.

Variants

Unauthorized

The user is not authenticated.

Returned when a WebSocket upgrade request is made without valid authentication and require_authentication is enabled.

MissingOrigin

The Origin header is missing.

For security, browsers always send an Origin header with WebSocket requests. A missing Origin header suggests a non-browser client or a security issue.

InvalidOrigin

The Origin header value is not in the allowed origins list.

This prevents Cross-Site WebSocket Hijacking (CSWSH) attacks where a malicious website tries to establish a WebSocket connection to your server using the victim’s cookies.

Fields

origin: String

The origin that was rejected

MissingRole

The user does not have the required role.

Fields

role: String

The role that was required

MissingAuthority

The user does not have the required authority.

Fields

authority: String

The authority that was required

Trait Implementations

impl Debug for WebSocketSecurityError

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

Formats the value using the given formatter.

impl Display for WebSocketSecurityError

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

Formats the value using the given formatter.

impl Error for WebSocketSecurityError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl ResponseError for WebSocketSecurityError

fn status_code(&self) -> StatusCode

Returns appropriate status code for error.

fn error_response(&self) -> HttpResponse

Creates full response for error.