#poem #authz #security #grants #permissions


Authorization extension for poem to validate user permissions

3 releases

1.0.0-beta.3 Jun 19, 2023
1.0.0-beta.2 Apr 2, 2023
1.0.0-beta.1 Feb 19, 2022

#250 in Authentication


261 lines



Extension for poem to validate user permissions.

CI Crates.io Downloads Badge crates.io Documentation dependency status Apache 2.0 or MIT licensed

To check user access to specific services, you can use built-in proc-macro, PermissionGuard or manual.

The library can also be integrated with third-party solutions or your custom middlewares (like jwt-auth example).

Provides a complete analogue of the actix-web-grants.

NOTE: Even under beta flag it's ready-to-use library. However, I'm going to prepare large update of whole *-grants ecosystem with additional features soon.

How to use

  1. Declare your own permission extractor

The easiest way is to declare a function with the following signature (trait is already implemented for such Fn):

// You can use custom type instead of String
async fn extract(req: &poem::Request) -> poem::Result<Vec<String>>
  1. Add middleware to your application using the extractor defined in step 1
    .at("/endpoint", your_endpoint)

Steps 1 and 2 can be replaced by custom middleware or integration with another libraries. Take a look at an jwt-auth example

  1. Protect your endpoints in any convenient way from the examples below:

Example of proc-macro way protection

use poem::{Response, http::StatusCode};

async fn macro_secured() -> Response {

Or for poem-openapi:

use poem_openapi::{OpenApi, payload::PlainText};

struct Api;

#[poem_grants::open_api] // It's important to keep above of `OpenApi`
impl Api {
    #[oai(path = "/admin", method = "get")]
    async fn macro_secured(&self) -> PlainText<String> {
Example of ABAC-like protection and custom permission type

Here is an example using the type and secure attributes. But these are independent features.

secure allows you to include some checks in the macro based on function params.

type allows you to use a custom type for the roles and permissions (then the middleware needs to be configured). Take a look at an enum-role example

use poem::{Response, http::StatusCode, web};
use enums::Role::{self, ADMIN};
use dto::User;

#[poem_grants::has_role("ADMIN", type = "Role", secure = "*user_id == user.id")]
async fn macro_secured(user_id: web::Path<i32>, user: web::Data<User>) -> Response {
    Response::builder().status(StatusCode::OK).body("some secured response")

Example of manual way protection

use poem::{Response, http::StatusCode};
use poem_grants::permissions::{AuthDetails, PermissionsCheck};

async fn manual_secure(details: AuthDetails) -> Response {
    if details.has_permission("ROLE_ADMIN") {
        return Response::builder().status(StatusCode::OK).body("ADMIN_RESPONSE");

You can find more examples in the git repository folder and documentation.

Supported poem versions

  • For poem-grants: 1.* supported version of poem is 1.*


~353K SLoC