Struct actix_web_grants::GrantsMiddleware

pub struct GrantsMiddleware<T> where
    T: PermissionsExtractor<'a>,  { /* fields omitted */ }

Built-in middleware for extracting user permission.

Examples

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

use actix_web_grants::permissions::{AuthDetails, PermissionsCheck};
use actix_web_grants::{proc_macro::has_permissions, GrantsMiddleware};

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

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

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

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

Implementations

impl<T> GrantsMiddleware<T> where
    T: PermissionsExtractor<'a>, 

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

Create middleware by PermissionsExtractor.

You can use a built-in implementation for async fn with a suitable signature (see example below). Or you can define your own implementation of trait.

Example of function with implementation of PermissionsExtractor

use actix_web::dev::ServiceRequest;
use actix_web::Error;

async fn extract(_req: &ServiceRequest) -> Result<Vec<String>, Error> {
    // Here is a place for your code to get user permissions/grants/permissions from a request
     // For example from a token or database
    Ok(vec!["WRITE_ACCESS".to_string()])
}

Trait Implementations

impl<S, B, T> Transform<S> for GrantsMiddleware<T> where
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
    T: PermissionsExtractor<'a> + '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.

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.