pub struct PagesAuthenticator<B>where
B: SessionBackend,{ /* private fields */ }Available on crate feature
websockets-pages and non-WebAssembly only.Expand description
Authenticator that integrates with reinhardt-pages’ Cookie/session authentication
This authenticator extracts session information from WebSocket handshake cookies and validates them against reinhardt-pages’ session store.
§Type Parameters
B- The session backend type (e.g.,InMemorySessionBackend)
§Example
ⓘ
use reinhardt_websockets::integration::pages::PagesAuthenticator;
use reinhardt_auth::sessions::InMemorySessionBackend;
let backend = InMemorySessionBackend::new();
let authenticator = PagesAuthenticator::new(backend);
// During WebSocket handshake, extract cookies from HTTP headers
let cookie_header = "sessionid=abc123; csrftoken=xyz789";
let user = authenticator.authenticate_from_cookies(cookie_header).await?;Implementations§
Source§impl<B> PagesAuthenticator<B>where
B: SessionBackend,
impl<B> PagesAuthenticator<B>where
B: SessionBackend,
Sourcepub fn new(session_backend: B) -> PagesAuthenticator<B>
pub fn new(session_backend: B) -> PagesAuthenticator<B>
Create a new PagesAuthenticator with the given session backend
Uses default settings:
- Cookie name: “sessionid”
- Timeout: 30 minutes (1800 seconds)
§Arguments
session_backend- The session backend to use for session validation
§Example
ⓘ
use reinhardt_websockets::integration::pages::PagesAuthenticator;
use reinhardt_auth::sessions::InMemorySessionBackend;
let backend = InMemorySessionBackend::new();
let authenticator = PagesAuthenticator::new(backend);Set a custom cookie name for session ID extraction
§Arguments
name- The cookie name to use (e.g., “my_session_id”)
§Example
ⓘ
use reinhardt_websockets::integration::pages::PagesAuthenticator;
use reinhardt_auth::sessions::InMemorySessionBackend;
let backend = InMemorySessionBackend::new();
let authenticator = PagesAuthenticator::new(backend)
.with_cookie_name("my_session_id");Sourcepub fn with_timeout(self, timeout: Option<u64>) -> PagesAuthenticator<B>
pub fn with_timeout(self, timeout: Option<u64>) -> PagesAuthenticator<B>
Set a custom session timeout
§Arguments
timeout- Timeout in seconds, orNoneto disable timeout validation
§Example
ⓘ
use reinhardt_websockets::integration::pages::PagesAuthenticator;
use reinhardt_auth::sessions::InMemorySessionBackend;
let backend = InMemorySessionBackend::new();
let authenticator = PagesAuthenticator::new(backend)
.with_timeout(Some(3600)); // 1 hour timeoutAuthenticate a user from Cookie header string
This method extracts the session ID from the Cookie header and validates it against the session store to retrieve user information.
§Arguments
cookies- Cookie header string (e.g., “sessionid=abc123; csrftoken=xyz789”)
§Returns
Returns the authenticated user on success, or an error if:
- Session ID is missing or invalid
- Session has expired
- User ID is not found in session
§Errors
AuthError::AuthenticationFailed- Session ID not found in cookiesAuthError::TokenExpired- Session has timed outAuthError::AuthenticationFailed- Session store error or missing user ID
§Example
ⓘ
use reinhardt_websockets::integration::pages::PagesAuthenticator;
use reinhardt_auth::sessions::InMemorySessionBackend;
let backend = InMemorySessionBackend::new();
let authenticator = PagesAuthenticator::new(backend);
let cookies = "sessionid=valid_session_id; csrftoken=xyz789";
let user = authenticator.authenticate_from_cookies(cookies).await?;
println!("User {} authenticated", user.username());Trait Implementations§
Source§impl<B> WebSocketAuthenticator for PagesAuthenticator<B>where
B: SessionBackend + 'static,
impl<B> WebSocketAuthenticator for PagesAuthenticator<B>where
B: SessionBackend + 'static,
Source§fn authenticate<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_connection: &'life1 Arc<WebSocketConnection>,
credentials: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<Box<dyn AuthUser>, AuthError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PagesAuthenticator<B>: 'async_trait,
fn authenticate<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_connection: &'life1 Arc<WebSocketConnection>,
credentials: &'life2 str,
) -> Pin<Box<dyn Future<Output = Result<Box<dyn AuthUser>, AuthError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
PagesAuthenticator<B>: 'async_trait,
Authenticate a WebSocket connection Read more
Auto Trait Implementations§
impl<B> Freeze for PagesAuthenticator<B>where
B: Freeze,
impl<B> RefUnwindSafe for PagesAuthenticator<B>where
B: RefUnwindSafe,
impl<B> Send for PagesAuthenticator<B>
impl<B> Sync for PagesAuthenticator<B>
impl<B> Unpin for PagesAuthenticator<B>where
B: Unpin,
impl<B> UnsafeUnpin for PagesAuthenticator<B>where
B: UnsafeUnpin,
impl<B> UnwindSafe for PagesAuthenticator<B>where
B: UnwindSafe,
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
type Err = Infallible
fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>
Creates a shared type from an unshared type.
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.