Struct actix_web_grants::GrantsMiddleware

pub struct GrantsMiddleware<T> where
    T: AuthoritiesExtractor,  { /* fields omitted */ }

Built-in middleware for extracting user authority.

Examples

use actix_web::dev::ServiceRequest;
use actix_web::{get, App, Error, HttpResponse, HttpServer, Responder};

use actix_web_grants::authorities::{AuthDetails, AuthoritiesCheck};
use actix_web_grants::{proc_macro::has_authorities, GrantsMiddleware};
use std::sync::Arc;

fn main() {
    HttpServer::new(|| {
        let auth = GrantsMiddleware::fn_extractor(extract);
        App::new()
            .wrap(auth)
            .service(you_service)
    });
}

async fn extract(_req: Arc<ServiceRequest>) -> Result<Vec<String>, Error> {
   // Here is a place for your code to get user authorities/grants/permissions from a request
   // For example from a token or database

   // Stub example
   Ok(vec!["ROLE_ADMIN".to_string()])
}

// `has_authorities` is one of options to validate authorities.
#[get("/admin")]
#[has_authorities("ROLE_ADMIN")]
async fn you_service() -> impl Responder {
    HttpResponse::Ok().finish()
}

Implementations

impl<T> GrantsMiddleware<T> where
    T: AuthoritiesExtractor, 

pub fn with_extractor(extractor: T) -> GrantsMiddleware<T>

impl<F, O> GrantsMiddleware<FnAuthoritiesExtractor<F, O>> where
    F: Fn(Arc<ServiceRequest>) -> O,
    O: Future<Output = Result<Vec<String>, Error>>, 

pub fn fn_extractor(
    extract_fn: F
) -> GrantsMiddleware<FnAuthoritiesExtractor<F, O>>

Trait Implementations

impl<S, B, T> Transform<S> for GrantsMiddleware<T> where
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
    T: AuthoritiesExtractor + 'static, 

type Request = ServiceRequest

Requests handled by the service.

type Response = ServiceResponse<B>

Responses given by the service.

type Error = Error

Errors produced by the service.

type Transform = GrantsService<S, T>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<Self::Transform, Self::InitError>>

The future response value.

pub fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

pub fn map_init_err<F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E> where
    F: Fn(Self::InitError) -> E + Clone, 

Map this transforms's factory error to a different error, returning a new transform service factory.