Skip to main content

TokenAuthenticator

Struct TokenAuthenticator 

Source
pub struct TokenAuthenticator { /* private fields */ }
Expand description

Token-based WebSocket authenticator

§Examples

use reinhardt_websockets::auth::{TokenAuthenticator, WebSocketAuthenticator, SimpleAuthUser};
use reinhardt_websockets::WebSocketConnection;
use tokio::sync::mpsc;
use std::sync::Arc;

let authenticator = TokenAuthenticator::new(vec![
    ("valid_token".to_string(), SimpleAuthUser::new(
        "user_1".to_string(),
        "alice".to_string(),
        vec!["chat.read".to_string()],
    )),
]);

let (tx, _rx) = mpsc::unbounded_channel();
let conn = Arc::new(WebSocketConnection::new("conn_1".to_string(), tx));

let user = authenticator.authenticate(&conn, "valid_token").await.unwrap();
assert_eq!(user.username(), "alice");

Implementations§

Source§

impl TokenAuthenticator

Source

pub fn new(tokens: Vec<(String, SimpleAuthUser)>) -> Self

Create a new token authenticator with predefined tokens

Source

pub fn add_token(&mut self, token: String, user: SimpleAuthUser)

Add a token to the authenticator

Source

pub fn remove_token(&mut self, token: &str) -> Option<SimpleAuthUser>

Remove a token from the authenticator

Trait Implementations§

Source§

impl WebSocketAuthenticator for TokenAuthenticator

Source§

fn authenticate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _connection: &'life1 Arc<WebSocketConnection>, credentials: &'life2 str, ) -> Pin<Box<dyn Future<Output = AuthResult<Box<dyn AuthUser>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Authenticate a WebSocket connection Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V