https://github.com/casbin-rs/rocket-authz

Casbin Rocket access control middleware
https://github.com/casbin-rs/rocket-authz

abac acl auth authentication authorization casbin casbin-rs middleware permissions rbac rocket rust

Last synced: 2 months ago
JSON representation

Casbin Rocket access control middleware

• Host: GitHub
• URL: https://github.com/casbin-rs/rocket-authz
• Owner: casbin-rs
• License: apache-2.0
• Created: 2020-05-19T15:40:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-08T05:44:46.000Z (over 1 year ago)
• Last Synced: 2024-09-26T20:45:42.474Z (3 months ago)
• Topics: abac, acl, auth, authentication, authorization, casbin, casbin-rs, middleware, permissions, rbac, rocket, rust
• Language: Rust
• Homepage:
• Size: 22.5 KB
• Stars: 4
• Watchers: 6
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rocket Casbin Middleware

[![Crates.io](https://img.shields.io/crates/d/rocket-authz)](https://crates.io/crates/rocket-authz)

[![Docs](https://docs.rs/rocket-authz/badge.svg)](https://docs.rs/rocket-authz)

[![CI](https://github.com/casbin-rs/rocket-authz/workflows/CI/badge.svg)](https://github.com/casbin-rs/rocket-authz/actions)

[![codecov](https://codecov.io/gh/casbin-rs/rocket-authz/branch/master/graph/badge.svg)](https://codecov.io/gh/casbin-rs/rocket-authz)

[Casbin](https://github.com/casbin/casbin-rs) access control middleware for [Rocket](https://github.com/SergioBenitez/Rocket) framework

## Install

Add it to `Cargo.toml`

```rust

rocket-authz = "0.1.0"

```

## Requirement

**Casbin only takes charge of permission control**, so you need to implement an `Authentication Middleware` to identify user.

You need to put `rocket_authz::CasbinVals` which contains `subject` and `domain`(optional) into `reqeust.local_cache()` through an `Authentication Middleware`. You could see an example of using rocket-authz in [Example](#example).

## Example

```rust

#![feature(proc_macro_hygiene, decl_macro)]

use casbin::{DefaultModel, FileAdapter};

use rocket::{

    fairing::{Fairing, Info, Kind},

    get,

    request::Request,

    routes, Data,

};

use rocket_authz;

struct FakeAuthFairing;

impl Fairing for FakeAuthFairing {

    fn info(&self) -> Info {

        Info {

            name: "Fake Auth Fairing",

            kind: Kind::Request | Kind::Response,

        }

    }

    fn on_request(&self, request: &mut Request, _data: &Data) {

        request.local_cache(|| rocket_authz::CasbinVals::new(Some("alice".to_string()), None));

    }

}

#[get("/data1")]

fn data1(_g: rocket_authz::CasbinGuard) -> &'static str {

    "data1"

}

#[get("/data2")]

fn data2(_g: rocket_authz::CasbinGuard) -> &'static str {

    "data2"

}

fn rocket() -> rocket::Rocket {

    let rt = tokio::runtime::Runtime::new().unwrap();

    let m = match rt.block_on(DefaultModel::from_file(

        "examples/rbac_with_pattern_model.conf",

    )) {

        Ok(m) => m,

        Err(_) => panic!(""),

    };

    let a = FileAdapter::new("examples/rbac_with_pattern_policy.csv");

    let casbin_fairing = match rt.block_on(rocket_authz::CasbinFairing::new(m, a)) {

        Ok(f) => f,

        Err(_) => panic!(""),

    };

    let fake_auth_fairing = FakeAuthFairing;

    rocket::ignite()

        .attach(fake_auth_fairing)

        .attach(casbin_fairing)

        .mount("/", routes![data1, data2])

}

```

## License

This project is licensed under

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))