oxide-auth 0.6.1

A OAuth2 library for common web servers, featuring a set of configurable and pluggable backends.
Documentation
use std::fmt;
use std::sync::Arc;

use super::{AuthorizationAddon, AccessTokenAddon, AddonResult, ClientCredentialsAddon};
use crate::code_grant::accesstoken::{Extension as AccessTokenExtension, Request};
use crate::code_grant::authorization::{Extension as AuthorizationExtension, Request as AuthRequest};
use crate::code_grant::client_credentials::{
    Extension as ClientCredentialsExtension, Request as ClientCredentialsRequest,
};
use crate::endpoint::Extension;
use crate::primitives::grant::{Extensions, GrantExtension};

/// A simple list of loosely related authorization and access addons.
///
/// The owning representation of access extensions can be switched out to `Box<_>`, `Rc<_>` or
/// other types.
#[derive(Clone)]
pub struct AddonList {
    /// Extension to be applied on authorize. This field is `pub` for `oxide-auth-async` be able to
    /// implement async version of some traits.
    pub authorization: Vec<Arc<dyn AuthorizationAddon + Send + Sync + 'static>>,

    /// Extension to be applied on get token. This field is `pub` for `oxide-auth-async` be able to
    /// implement async version of some traits.
    pub access_token: Vec<Arc<dyn AccessTokenAddon + Send + Sync + 'static>>,

    /// Extension to be applied on get token. This field is `pub` for `oxide-auth-async` be able to
    /// implement async version of some traits.
    pub client_credentials: Vec<Arc<dyn ClientCredentialsAddon + Send + Sync + 'static>>,
}

impl AddonList {
    /// Create an empty extension system.
    pub fn new() -> Self {
        AddonList {
            authorization: vec![],
            access_token: vec![],
            client_credentials: vec![],
        }
    }

    /// Add an addon that only applies to authorization.
    pub fn push_authorization<A>(&mut self, addon: A)
    where
        A: AuthorizationAddon + Send + Sync + 'static,
    {
        self.authorization.push(Arc::new(addon))
    }

    /// Add an addon that only applies to access_token.
    pub fn push_access_token<A>(&mut self, addon: A)
    where
        A: AccessTokenAddon + Send + Sync + 'static,
    {
        self.access_token.push(Arc::new(addon))
    }

    /// Add an addon that only applies to client_credentials.
    pub fn push_client_credentials<A>(&mut self, addon: A)
    where
        A: ClientCredentialsAddon + Send + Sync + 'static,
    {
        self.client_credentials.push(Arc::new(addon))
    }

    /// Add an addon that applies to the whole code grant flow.
    ///
    /// The addon gets added both the authorization and access token addons.
    pub fn push_code<A>(&mut self, addon: A)
    where
        A: AuthorizationAddon + AccessTokenAddon + Send + Sync + 'static,
    {
        let arc = Arc::new(addon);
        self.authorization.push(arc.clone());
        self.access_token.push(arc)
    }
}

impl Default for AddonList {
    fn default() -> Self {
        AddonList::new()
    }
}

impl Extension for AddonList {
    fn authorization(&mut self) -> Option<&mut dyn AuthorizationExtension> {
        Some(self)
    }

    fn access_token(&mut self) -> Option<&mut dyn AccessTokenExtension> {
        Some(self)
    }

    fn client_credentials(&mut self) -> Option<&mut dyn ClientCredentialsExtension> {
        Some(self)
    }
}

impl Extension for &mut AddonList {
    fn authorization(&mut self) -> Option<&mut dyn AuthorizationExtension> {
        Some(self)
    }

    fn access_token(&mut self) -> Option<&mut dyn AccessTokenExtension> {
        Some(self)
    }

    fn client_credentials(&mut self) -> Option<&mut dyn ClientCredentialsExtension> {
        Some(self)
    }
}

impl AccessTokenExtension for AddonList {
    fn extend(
        &mut self, request: &dyn Request, mut data: Extensions,
    ) -> std::result::Result<Extensions, ()> {
        let mut result_data = Extensions::new();

        for ext in self.access_token.iter() {
            let ext_data = data.remove(ext);
            let result = ext.execute(request, ext_data);

            match result {
                AddonResult::Ok => (),
                AddonResult::Data(data) => result_data.set(ext, data),
                AddonResult::Err => return Err(()),
            }
        }

        Ok(result_data)
    }
}

impl AccessTokenExtension for &mut AddonList {
    fn extend(&mut self, request: &dyn Request, data: Extensions) -> Result<Extensions, ()> {
        AccessTokenExtension::extend(*self, request, data)
    }
}

impl AuthorizationExtension for AddonList {
    fn extend(&mut self, request: &dyn AuthRequest) -> Result<Extensions, ()> {
        let mut result_data = Extensions::new();

        for ext in self.authorization.iter() {
            let result = ext.execute(request);

            match result {
                AddonResult::Ok => (),
                AddonResult::Data(data) => result_data.set(ext, data),
                AddonResult::Err => return Err(()),
            }
        }

        Ok(result_data)
    }
}

impl AuthorizationExtension for &mut AddonList {
    fn extend(&mut self, request: &dyn AuthRequest) -> Result<Extensions, ()> {
        AuthorizationExtension::extend(*self, request)
    }
}

impl ClientCredentialsExtension for AddonList {
    fn extend(&mut self, request: &dyn ClientCredentialsRequest) -> Result<Extensions, ()> {
        let mut result_data = Extensions::new();

        for ext in self.client_credentials.iter() {
            let result = ext.execute(request);

            match result {
                AddonResult::Ok => (),
                AddonResult::Data(data) => result_data.set(ext, data),
                AddonResult::Err => return Err(()),
            }
        }

        Ok(result_data)
    }
}

impl ClientCredentialsExtension for &mut AddonList {
    fn extend(&mut self, request: &dyn ClientCredentialsRequest) -> Result<Extensions, ()> {
        ClientCredentialsExtension::extend(*self, request)
    }
}

impl fmt::Debug for AddonList {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        use std::slice::Iter;
        struct ExtIter<'a, T: GrantExtension + 'a>(Iter<'a, T>);

        impl<'a, T: GrantExtension> fmt::Debug for ExtIter<'a, T> {
            fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                f.debug_list().entries(self.0.clone().map(T::identifier)).finish()
            }
        }

        f.debug_struct("AddonList")
            .field("authorization", &ExtIter(self.authorization.iter()))
            .field("access_token", &ExtIter(self.access_token.iter()))
            .field("client_credentials", &ExtIter(self.client_credentials.iter()))
            .finish()
    }
}