Casbin

Açıklama

Casbin, çok çeşitli erişim kontrol modellerini destekleyen güçlü ve verimli bir açık kaynak erişim kontrol framework'üdür.

Proje Adresi

https://github.com/teamones-open/casbin

Kurulum

composer require teamones/casbin

Casbin Resmi Web Sitesi

Detaylı kullanım için resmi Türkçe dokümana göz atabilirsiniz, burada yalnızca webman'de nasıl yapılandırılacağını anlatacağız.

https://casbin.org/docs/tr-CN/overview

Dizin Yapısı

.
├── config                        Yapılandırma dizini
│   ├── casbin-restful-model.conf Kullanılan izin modeli yapılandırma dosyası
│   ├── casbin.php                casbin yapılandırması
......
├── database                      Veritabanı dosyaları
│   ├── migrations                Göç (migration) dosyaları
│   │   └── 20210218074218_create_rule_table.php
......

Veritabanı Göç Dosyası

<?php

use Phinx\Migration\AbstractMigration;

class CreateRuleTable extends AbstractMigration
{
    /**
     * Change Method.
     *
     * Bu yöntemi kullanarak tersine çevrilebilen göçlerinizi yazın.
     *
     * Göç yazma hakkında daha fazla bilgi için buraya bakabilirsiniz:
     * http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
     *
     * Aşağıdaki komutlar bu yöntemde kullanılabilir ve Phinx
     * geri alma işlemi sırasında bunları otomatik olarak tersine çevirecektir:
     *
     *    createTable
     *    renameTable
     *    addColumn
     *    addCustomColumn
     *    renameColumn
     *    addIndex
     *    addForeignKey
     *
     * Diğer tahrip edici değişiklikler, göçü geri almaya çalışırken bir hata ile sonuçlanır.
     *
     * Table sınıfıyla çalışırken "create()" veya "update()" çağırmayı
     * unutmayın ve "save()" kullanmayın.
     */
    public function change()
    {
        $table = $this->table('rule', ['id' => false, 'primary_key' => ['id'], 'engine' => 'InnoDB', 'collation' => 'utf8mb4_general_ci', 'comment' => 'Kural Tablosu']);

        // Veri alanlarını ekleme
        $table->addColumn('id', 'integer', ['identity' => true, 'signed' => false, 'limit' => 11, 'comment' => 'Anahtar ID'])
            ->addColumn('ptype', 'char', ['default' => '', 'limit' => 8, 'comment' => 'Kural tipi'])
            ->addColumn('v0', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v1', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v2', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v3', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v4', 'string', ['default' => '', 'limit' => 128])
            ->addColumn('v5', 'string', ['default' => '', 'limit' => 128]);

        // Oluşturmayı gerçekleştir
        $table->create();
    }
}

Casbin Yapılandırması

İzin kuralı model yapılandırma söz dizimini görmek için: https://casbin.org/docs/tr-CN/syntax-for-models

<?php

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // İzin kuralı model yapılandırma dosyası
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model veya adapter
            'class' => \app\model\Rule::class,
        ],
    ],
    // Birden fazla izin modelini yapılandırabilirsiniz
    'rbac' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-rbac-model.conf', // İzin kuralı model yapılandırma dosyası
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model veya adapter
            'class' => \app\model\RBACRule::class,
        ],
    ],
];

Adaptör

Mevcut composer paketi think-orm'un model yöntemini desteklemektedir, diğer ORM'ler için vendor/teamones/src/adapters/DatabaseAdapter.php dosyasına bakabilirsiniz.

Sonrasında yapılandırmayı değiştirin.

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // İzin kuralı model yapılandırma dosyası
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'adapter', // Burada türü adaptör modu olarak ayarlayın
            'class' => \app\adapter\DatabaseAdapter::class,
        ],
    ],
];

Kullanım Talimatları

Dahil Etme

# Dahil etme
use teamones\casbin\Enforcer;

İki Kullanım Şekli

# 1. Varsayılan olarak default yapılandırmasını kullanma
Enforcer::addPermissionForUser('user1', '/user', 'read');

# 1. Özel rbac yapılandırmasını kullanma
Enforcer::instance('rbac')->addPermissionForUser('user1', '/user', 'read');

Yaygın API'lerin Tanıtımı

Daha fazla API kullanımına göz atmak için resmi belgeleri ziyaret edebilirsiniz.

• Yönetim API'si: https://casbin.org/docs/tr-CN/management-api
• RBAC API'si: https://casbin.org/docs/tr-CN/rbac-api

# Kullanıcıya izin ekleme

Enforcer::addPermissionForUser('user1', '/user', 'read');

# Bir kullanıcının iznini kaldırma

Enforcer::deletePermissionForUser('user1', '/user', 'read');

# Kullanıcının tüm izinlerini alma

Enforcer::getPermissionsForUser('user1'); 

# Kullanıcıya rol ekleme

Enforcer::addRoleForUser('user1', 'role1');

# Role izin ekleme

Enforcer::addPermissionForUser('role1', '/user', 'edit');

# Tüm rolleri alma

Enforcer::getAllRoles();

# Kullanıcının tüm rollerini alma

Enforcer::getRolesForUser('user1');

# Role göre kullanıcıları alma

Enforcer::getUsersForRole('role1');

# Kullanıcının bir role ait olup olmadığını kontrol etme

Enforcer::hasRoleForUser('use1', 'role1');

# Kullanıcı rolünü silme

Enforcer::deleteRoleForUser('use1', 'role1');

# Kullanıcının tüm rollerini silme

Enforcer::deleteRolesForUser('use1');

# Rol silme

Enforcer::deleteRole('role1');

# İzin silme

Enforcer::deletePermission('/user', 'read');

# Kullanıcı veya rolün tüm izinlerini silme

Enforcer::deletePermissionsForUser('user1');
Enforcer::deletePermissionsForUser('role1');

# İzni kontrol etme, true veya false döner

Enforcer::enforce("user1", "/user", "edit");