Struct WebSocketAuthExtractor

pub struct WebSocketAuthExtractor { /* private fields */ }

WebSocket authentication extractor

Implementations

impl WebSocketAuthExtractor

pub fn new(config: WebSocketAuthConfig) -> Self

Create a new WebSocket authentication extractor

pub fn default() -> Self

Create with default configuration

pub fn has_handshake_auth(&self, request: &TransportRequest) -> bool

Check if WebSocket handshake contains authentication

Trait Implementations

impl AuthExtractor for WebSocketAuthExtractor

fn extract_auth<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 TransportRequest, ) -> Pin<Box<dyn Future<Output = AuthExtractionResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Extract authentication from a transport request

fn transport_type(&self) -> TransportType

Get the transport type this extractor handles

fn can_handle(&self, request: &TransportRequest) -> bool

Check if this extractor can handle the given request

fn validate_auth<'life0, 'life1, 'async_trait>( &'life0 self, context: &'life1 TransportAuthContext, ) -> Pin<Box<dyn Future<Output = Result<(), TransportAuthError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Validate the extracted authentication (optional hook)