apache/casbin-sqlx-adapter

README

Apache Casbin SQLx Adapter (Incubating)

Apache Casbin (Incubating) is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

casbin-sqlx-adapter is the SQLx adapter for casbin-rs. With this library, Casbin can load policy from a SQLx-supported database or save policy to it with fully asynchronous support.

Based on SQLx, the current supported databases are:

Notice

In order to unify the database table name in Casbin ecosystem, we decide to use casbin_rule instead of casbin_rules from version 0.4.0. If you are using old version sqlx-adapter in your production environment, please use following command and update sqlx-adapter version:

# MySQL & PostgreSQL & SQLite
ALTER TABLE casbin_rules RENAME TO casbin_rule;

Install

Requires Rust 1.94 or newer (the minimum supported by SQLx 0.9). The snippets below track the latest 1.x release; the exact version is on the crates.io badge above.

Add the following to Cargo.toml:

For MySQL:

casbin-sqlx-adapter = { version = "1.9", default-features = false, features = ["mysql", "runtime-tokio", "tls-native-tls"]}
tokio = { version = "1.1.1", features = ["macros"] }

For PostgreSQL:

casbin-sqlx-adapter = { version = "1.9", default-features = false, features = ["postgres", "runtime-tokio", "tls-native-tls"]}
tokio = { version = "1.1.1", features = ["macros"] }

For SQLite:

casbin-sqlx-adapter = { version = "1.9", default-features = false, features = ["sqlite", "runtime-tokio", "tls-native-tls"]}
tokio = { version = "1.1.1", features = ["macros"] }

Starting with 1.9.0, the registry package name changes from sqlx-adapter to casbin-sqlx-adapter. Replace the dependency key in Cargo.toml as shown above. The library name remains sqlx_adapter, so existing Rust imports and the SqlxAdapter type do not change. Existing versions of sqlx-adapter remain available. Release candidates are for review and are not published to crates.io; the new package and documentation links become available after release approval and publication.

Warning: tokio v1.0 or later is supported from sqlx-adapter v0.4.0, we recommend that you upgrade the relevant components to ensure that they work properly. The last version that supports tokio v0.2 is sqlx-adapter v0.3.0 , you can choose according to your needs.

Configure

No database is needed to build this crate. All queries are executed at runtime, so cargo build works offline and you never have to set DATABASE_URL or run cargo sqlx prepare in your own project. The steps below are only about the database your application talks to at runtime (and about running this repository's own test suite).

Set up database environment

One convenient option is using docker to get your database environment ready:

#!/bin/bash

DIS=$(lsb_release -is)

command -v docker > /dev/null 2>&1 || {
    echo "Please install docker before running this script." && exit 1;
}

if [ $DIS == "Ubuntu" ] || [ $DIS == "LinuxMint" ]; then
    sudo apt install -y \
        libpq-dev \
        libmysqlclient-dev \
        postgresql-client \
        mysql-client-core;

elif [ $DIS == "Deepin" ]; then
    sudo apt install -y \
        libpq-dev \
        libmysql++-dev \
        mysql-client \
        postgresql-client;
elif [ $DIS == "ArchLinux" ] || [ $DIS == "ManjaroLinux" ]; then
    sudo pacman -S libmysqlclient \
        postgresql-libs \
        mysql-clients \;
else
    echo "Unsupported system: $DIS" && exit 1;
fi

docker run -itd \
    --restart always \
    -e POSTGRES_USER=casbin_rs \
    -e POSTGRES_PASSWORD=casbin_rs \
    -e POSTGRES_DB=casbin \
    -p 5432:5432 \
    -v /srv/docker/postgresql:/var/lib/postgresql \
    postgres:11;

docker run -itd \
    --restart always \
    -e MYSQL_ALLOW_EMPTY_PASSWORD=yes \
    -e MYSQL_USER=casbin_rs \
    -e MYSQL_PASSWORD=casbin_rs \
    -e MYSQL_DATABASE=casbin \
    -p 3306:3306 \
    -v /srv/docker/mysql:/var/lib/mysql \
    mysql:8 \
    --default-authentication-plugin=mysql_native_password;

Create table casbin_rule

SqlxAdapter issues CREATE TABLE IF NOT EXISTS on startup, so this is optional — do it yourself only if your database user is not allowed to create tables.

# PostgreSQL
psql postgres://casbin_rs:casbin_rs@127.0.0.1:5432/casbin -c "CREATE TABLE IF NOT EXISTS casbin_rule (
    id SERIAL PRIMARY KEY,
    ptype VARCHAR NOT NULL,
    v0 VARCHAR NOT NULL,
    v1 VARCHAR NOT NULL,
    v2 VARCHAR NOT NULL,
    v3 VARCHAR NOT NULL,
    v4 VARCHAR NOT NULL,
    v5 VARCHAR NOT NULL,
    CONSTRAINT unique_key_sqlx_adapter UNIQUE(ptype, v0, v1, v2, v3, v4, v5)
    );"

# MySQL
mysql -h 127.0.0.1 -u casbin_rs -pcasbin_rs casbin 

CREATE TABLE IF NOT EXISTS casbin_rule (
    id INT NOT NULL AUTO_INCREMENT,
    ptype VARCHAR(12) NOT NULL,
    v0 VARCHAR(128) NOT NULL,
    v1 VARCHAR(128) NOT NULL,
    v2 VARCHAR(128) NOT NULL,
    v3 VARCHAR(128) NOT NULL,
    v4 VARCHAR(128) NOT NULL,
    v5 VARCHAR(128) NOT NULL,
    PRIMARY KEY(id),
    CONSTRAINT unique_key_sqlx_adapter UNIQUE(ptype, v0, v1, v2, v3, v4, v5)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

# SQLite
touch casbin.db

sqlite3 casbin.db -cmd "CREATE TABLE IF NOT EXISTS casbin_rule (
   id INTEGER PRIMARY KEY,
   ptype VARCHAR(12) NOT NULL,
   v0 VARCHAR(128) NOT NULL,
   v1 VARCHAR(128) NOT NULL,
   v2 VARCHAR(128) NOT NULL,
   v3 VARCHAR(128) NOT NULL,
   v4 VARCHAR(128) NOT NULL,
   v5 VARCHAR(128) NOT NULL,
   CONSTRAINT unique_key_sqlx_adapter UNIQUE(ptype, v0, v1, v2, v3, v4, v5)
   );"

Configure env (only needed to run this repository's tests)

Rename sample.env to .env and put DATABASE_URL, POOL_SIZE inside

DATABASE_URL=postgres://casbin_rs:casbin_rs@localhost:5432/casbin
# DATABASE_URL=mysql://casbin_rs:casbin_rs@localhost:3306/casbin
# DATABASE_URL=sqlite:casbin.db
POOL_SIZE=8

Or you can export DATABASE_URL, POOL_SIZE

export DATABASE_URL=postgres://casbin_rs:casbin_rs@localhost:5432/casbin
export POOL_SIZE=8

Example

use sqlx_adapter::casbin::prelude::*;
use sqlx_adapter::casbin::Result;
use sqlx_adapter::SqlxAdapter;

#[tokio::main]
async fn main() -> Result<()> {
    let m = DefaultModel::from_file("examples/rbac_model.conf").await?;
    
    let a = SqlxAdapter::new("postgres://casbin_rs:casbin_rs@127.0.0.1:5432/casbin", 8).await?;
    let mut e = Enforcer::new(m, a).await?;
    
    Ok(())
}

Features

postgres
mysql
sqlite
runtime-tokio
runtime-async-std
tls-native-tls
tls-rustls

The legacy combined runtime/TLS features remain available as backward-compatible aliases:

runtime-tokio-native-tls
runtime-tokio-rustls
runtime-async-std-native-tls
runtime-async-std-rustls

Attention: postgres, mysql, sqlite are mutual exclusive which means that you can only activate one of them.

README