soaprs-auth 0.5.0

Protocol-neutral authentication and authorization contracts for soaprs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! Typed asynchronous authentication ports.

use soaprs_core::{BoxFuture, SoapResult};

use crate::AuthorizationName;

/// Successful authentication through one named strategy.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Authentication<P> {
    strategy: AuthorizationName,
    principal: P,
}

impl<P> Authentication<P> {
    /// Wraps an authenticated principal and validated strategy identity.
    pub fn new(strategy: impl Into<String>, principal: P) -> SoapResult<Self> {
        Ok(Self {
            strategy: AuthorizationName::new(strategy)?,
            principal,
        })
    }

    /// Returns the strategy that authenticated the principal.
    pub const fn strategy(&self) -> &AuthorizationName {
        &self.strategy
    }

    /// Returns the authenticated principal.
    pub const fn principal(&self) -> &P {
        &self.principal
    }

    /// Consumes the authentication into its principal.
    pub fn into_principal(self) -> P {
        self.principal
    }
}

/// Verifies one typed credential and returns an authenticated principal.
pub trait Authenticator<C, P>: Send + Sync
where
    C: Send,
    P: Send,
{
    /// Authenticates a presented credential.
    fn authenticate(&self, credential: C) -> BoxFuture<'_, SoapResult<Authentication<P>>>;
}