Struct OriginValidator 

pub struct OriginValidator { /* private fields */ }

Validates the Origin header of WebSocket upgrade requests.

Spring Security Equivalent

Spring’s StompSubProtocolErrorHandler combined with AllowedOriginPatterns

Example

use actix_security::http::security::websocket::OriginValidator;

let validator = OriginValidator::new(&["https://myapp.com"]);

#[get("/ws")]
async fn ws_handler(req: HttpRequest) -> Result<HttpResponse, Error> {
    validator.validate(&req)?;
    // ... upgrade to WebSocket
}

Implementations

impl OriginValidator

pub fn new(origins: &[&str]) -> Self

Creates a new OriginValidator with the specified allowed origins.

Arguments

• origins - List of allowed origin URLs (e.g., “https://myapp.com”)

Example

let validator = OriginValidator::new(&["https://myapp.com", "https://api.myapp.com"]);

pub fn builder() -> OriginValidatorBuilder

Creates a builder for more complex configuration.

pub fn allow_any() -> Self

Creates a validator that allows any origin.

Warning

This is dangerous and should only be used for development or when you have other authentication mechanisms in place.

pub fn validate(&self, req: &HttpRequest) -> Result<(), WebSocketSecurityError>

Validates the Origin header of the request.

Errors

• WebSocketSecurityError::MissingOrigin - If Origin header is missing and allow_missing is false
• WebSocketSecurityError::InvalidOrigin - If Origin is not in the allowed list

Trait Implementations

impl Clone for OriginValidator

fn clone(&self) -> OriginValidator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OriginValidator

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

Formats the value using the given formatter.

impl Default for OriginValidator

fn default() -> OriginValidator

Returns the “default value” for a type.