はじめに

インストール

Go

go get github.com/casbin/casbin/v2

Java

For Maven:

<!-- https://mvnrepository.com/artifact/org.casbin/jcasbin -->
<dependency>
    <groupId>org.casbin</groupId>
    <artifactId>jcasbin</artifactId>
    <version>1.x.y</version>
</dependency>

Node.js

# NPM
npm install casbin --save

# Yarn
yarn add casbin

PHP

Require this package in the composer.json of your project to download the package:

composer require casbin/casbin

Python

pip install casbin

.NET

dotnet add package Casbin.NET

C++

# Download source
git clone https://github.com/casbin/casbin-cpp.git

# Generate project files
cd casbin-cpp && mkdir build && cd build && cmake .. -DCMAKE_BUILD_TYPE=Release

# Build and install casbin
cmake --build . --config Release --target casbin install -j 10

Rust

cargo install cargo-edit
cargo add casbin

// If you use async-std as async executor
cargo add async-std

// If you use tokio as async executor, make sure you activate its `macros` feature
cargo add tokio

Delphi

Casbin4Dはパッケージ(現在はDelphi 10.3 Rio用) 内にあり、IDEにインストールできます。 ただし、ビジュアルコンポーネントはないため、パッケージから独立した形でそのユニットを使用します。 プロジェクトにユニットをインポートするだけです(数字を気にしないと仮定します)。

Lua

luarocks install casbin  

If you receive an error message: "Your user does not have write permissions in /usr/local/lib/luarocks/rocks", you may want to run the command as a privileged user or use your local tree with --local. To fix the error, you can add --local behind your command like this:

luarocks install casbin --local

Casbin Enforcerを作成する

Casbin uses configuration files to define the access control model.

There are two configuration files: model.conf and policy.csv. model.conf stores the access model, while policy.csv stores the specific user permission configuration. The usage of Casbin is very straightforward. We only need to create one main structure: enforcer. この構造体を構築するとき、 model.conf と policy.csv がロードされます。

In other words, to create a Casbin enforcer, you need to provide a Model and an Adapter.

Casbin provides a FileAdapter that you can use. See Adapter for more information.

• Example of using the Model file and the default FileAdapter:

Go

import "github.com/casbin/casbin/v2"

e, err := casbin.NewEnforcer("path/to/model.conf", "path/to/policy.csv")

Java

import org.casbin.jcasbin.main.Enforcer;

Enforcer e = new Enforcer("path/to/model.conf", "path/to/policy.csv");

Node.js

import { newEnforcer } from 'casbin';

const e = await newEnforcer('path/to/model.conf', 'path/to/policy.csv');

PHP

require_once './vendor/autoload.php';

use Casbin\Enforcer;

$e = new Enforcer("path/to/model.conf", "path/to/policy.csv");

Python

import casbin

e = casbin.Enforcer("path/to/model.conf", "path/to/policy.csv")

.NET

using NetCasbin; 

var e = new Enforcer("path/to/model.conf", "path/to/policy.csv");

C++

#include <iostream>
#include <casbin/casbin.h>

int main() {
    // Create an Enforcer
    casbin::Enforcer e("path/to/model.conf", "path/to/policy.csv");

    // your code ..
}

Delphi

var
  casbin: ICasbin;
begin
  casbin := TCasbin.Create('path/to/model.conf', 'path/to/policy.csv');
  ...
end

Rust

use casbin::prelude::*;

// If you use async_td as async executor
#[cfg(feature = "runtime-async-std")]
#[async_std::main]
async fn main() -> Result<()> {
    let mut e = Enforcer::new("path/to/model.conf", "path/to/policy.csv").await?;
    Ok(())
}

// If you use tokio as async executor
#[cfg(feature = "runtime-tokio")]
#[tokio::main]
async fn main() -> Result<()> {
    let mut e = Enforcer::new("path/to/model.conf", "path/to/policy.csv").await?;
    Ok(())
}

Lua

local Enforcer = require("casbin")
local e = Enforcer:new("path/to/model.conf", "path/to/policy.csv") -- The Casbin Enforcer

• 他のAdapterとともにModelテキストを使用する:

Go

import (
    "log"

    "github.com/casbin/casbin/v2"
    "github.com/casbin/casbin/v2/model"
    xormadapter "github.com/casbin/xorm-adapter/v2"
    _ "github.com/go-sql-driver/mysql"
)

// Initialize a Xorm adapter with MySQL database.
a, err := xormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/")
if err != nil {
    log.Fatalf("error: adapter: %s", err)
}

m, err := model.NewModelFromString(`
[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

[policy_effect]
e = some(where (p.eft == allow))

[matchers]
m = r.sub == p.sub && r.obj == p.obj && r.act == p.act
`)
if err != nil {
    log.Fatalf("error: model: %s", err)
}

e, err := casbin.NewEnforcer(m, a)
if err != nil {
    log.Fatalf("error: enforcer: %s", err)
}

Python

import casbin
import casbin_sqlalchemy_adapter


# Use SQLAlchemy Casbin adapter with SQLLite DB
adapter = casbin_sqlalchemy_adapter.Adapter('sqlite:///test.db')

# Create a config model policy
with open("rbac_example_model.conf", "w") as f:
    f.write("""
    [request_definition]
    r = sub, obj, act

    [policy_definition]
    p = sub, obj, act

    [policy_effect]
    e = some(where (p.eft == allow))

    [matchers]
    m = r.sub == p.sub && r.obj == p.obj && r.act == p.act
    """)

# Create enforcer from adapter and config policy
e = casbin.Enforcer('rbac_example_model.conf', adapter)

権限のチェックする

アクセスが発生する直前のコードにEnforcementフックを追加する:

Go

sub := "alice" // リソースにアクセスしたいユーザ
obj := "data1" // アクセスされるリソース
act := "read" // ユーザーがリソースに対して実行する操作

ok, err := e.Enforce(sub, obj, act)

if err != nil {
    // エラーハンドリング
}

if ok == true {
    // aliceがdata1を閲覧することを許可する
} else {
    // リクエストを拒否し、エラーを表示する
}

// 複数のリクエストを一括で処理するのに BatchEnforce() を使用することも可能です。
// このメソッドはboolのsliceを返却します。このsliceのインデックスは2次元配列の行のインデックスに対応しています。
// e.g. results[0] is the result of {"alice", "data1", "read"}
results, err := e.BatchEnforce([][]interface{}{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"jack", "data3", "read"}})

Java

String sub = "alice"; // リソースにアクセスしたいユーザ
String obj = "data1"; // アクセスされるリソース
String act = "read"; // ユーザーがリソースに対して実行する操作

if (e.enforce(sub, obj, act) == true) {
    // aliceがdata1を閲覧することを許可する
} else {
    // リクエストを拒否し、エラーを表示する
}

Node.js

const sub = 'alice'; // リソースにアクセスしたいユーザ
const obj = 'data1'; // アクセスされるリソース
const act = 'read'; // ユーザーがリソースに対して実行する操作

if ((await e.enforce(sub, obj, act)) === true) {
    // aliceがdata1を閲覧することを許可する
} else {
    // リクエストを拒否し、エラーを表示する
}

PHP

$sub = "alice"; // リソースにアクセスしたいユーザ
$obj = "data1"; // アクセスされるリソース
$act = "read"; // ユーザーがリソースに対して実行する操作

if ($e->enforce($sub, $obj, $act) === true) {
    // aliceがdata1を閲覧することを許可する
} else {
    // リクエストを拒否し、エラーを表示する
}

Python

sub = "alice" # リソースにアクセスしたいユーザ
obj = "data1" # アクセスされるリソース
act = "read" # ユーザーがリソースに対して実行する操作

if e.enforce(sub, obj, act):
    # aliceがdata1を閲覧することを許可する
    pass
else:
    # リクエストを拒否し、エラーを表示する
    pass

.NET

var sub = "alice"; # リソースにアクセスしたいユーザ
var obj = "data1"; # アクセスされるリソース
var act = "read"; # ユーザがリソースに対して実行する操作

if (await e.EnforceAsync(sub, obj, act)) 
{
    // aliceがdata1を閲覧することを許可する
}
else
{
    // リクエストを拒否し、エラーを表示する
}

C++

    casbin::Enforcer e("../assets/model.conf", "../assets/policy.csv");

    if (e.Enforce({"alice", "/alice_data/hello", "GET"})) {
        std::cout << "Enforce OK" << std::endl;
    } else {
        std::cout << "Enforce NOT Good" << std::endl;
    }

    if (e.Enforce({"alice", "/alice_data/hello", "POST"})) {
        std::cout << "Enforce OK" << std::endl;
    } else {
        std::cout << "Enforce NOT Good" << std::endl;
    }

Delphi

if casbin.enforce(['alice,data1,read']) then
  // Alice is super happy as she can read data1
else
  // Alice is sad

Rust

  let sub = "alice"; // リソースにアクセスしたいユーザ
  let obj = "data1"; // アクセスされるリソース
  let act = "read"; // ユーザーがリソースに対して実行する操作

  if e.enforce((sub, obj, act)).await? {
      // aliceがdata1を閲覧することを許可する
  } else {
      // エラーが発生
  }

Lua

if e:enforce("alice", "data1", "read") then
   --  aliceがdata1を閲覧することを許可する
else
   -- リクエストを拒否し、エラーを表示する
end

Casbinは実行時の権限管理用のAPIも提供しています。 例えば、ユーザーに割り当てられたすべてのロールを以下のように取得できます。

Go

roles, err := e.GetRolesForUser("alice")

Java

List<String> roles = e.getRolesForUser("alice");

Node.js

const roles = await e.getRolesForUser('alice');

PHP

$roles = $e->getRolesForUser("alice");

Python

roles = e.get_roles_for_user("alice")

.NET

var roles = e.GetRolesForUser("alice");

Delphi

roles = e.rolesForEntity("alice")

Rust

let roles = e.get_roles_for_user("alice");

Lua

local roles = e:GetRolesForUser("alice")

詳細については、 Management API および RBAC API を参照してください。

その他の詳細はテストケースも参照してみてください。