Casbin

说明

Casbin هو إطار قوي وفعال ومفتوح المصدر للتحكم في الوصول، الذي يدعم آليات إدارة الأذونات باستخدام نماذج متعددة للتحكم في الوصول.

مشروع العنوان

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

التثبيت

composer require teamones/casbin

الموقع الرسمي لـ Casbin

يمكنك الاطلاع على الوثائق الرسمية باللغة الصينية لاستخدامها بالتفصيل، هنا فقط سنوضح كيفية تكوينها واستخدامها في webman.

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

هيكل الدليل

.
├── config                        دليل التكوين
│   ├── casbin-restful-model.conf ملف تكوين نموذج الأذونات المستخدم
│   ├── casbin.php                تكوين casbin
......
├── database                      ملف قاعدة البيانات
│   ├── migrations                ملفات الترحيل
│   │   └── 20210218074218_create_rule_table.php
......

ملفات ترحيل قاعدة البيانات

<?php

use Phinx\Migration\AbstractMigration;

class CreateRuleTable extends AbstractMigration
{
    /**
     * طريقة تغيير.
     *
     * اكتب عمليات الترحيل القابلة للعكس باستخدام هذه الطريقة.
     *
     * مزيد من المعلومات حول كتابة الترحيلات متاحة هنا:
     * http://docs.phinx.org/en/latest/migrations.html#the-abstractmigration-class
     *
     * يمكن استخدام الأوامر التالية في هذه الطريقة وسيرجعها Phinx تلقائيًا عند التراجع:
     *
     *    createTable
     *    renameTable
     *    addColumn
     *    addCustomColumn
     *    renameColumn
     *    addIndex
     *    addForeignKey
     *
     * سيسفر أي تغييرات مدمرة أخرى عن خطأ عند محاولة التراجع عن الترحيل.
     *
     * تذكر استدعاء "create()" أو "update()" وليس "save()" عند العمل مع
     * فئة الجدول.
     */
    public function change()
    {
        $table = $this->table('rule', ['id' => false, 'primary_key' => ['id'], 'engine' => 'InnoDB', 'collation' => 'utf8mb4_general_ci', 'comment' => 'جدول القواعد']);

        // إضافة حقول البيانات
        $table->addColumn('id', 'integer', ['identity' => true, 'signed' => false, 'limit' => 11, 'comment' => 'معرف المفتاح الأساسي'])
            ->addColumn('ptype', 'char', ['default' => '', 'limit' => 8, 'comment' => 'نوع القاعدة'])
            ->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]);

        // تنفيذ الإنشاء
        $table->create();
    }
}

تكوين casbin

يرجى الاطلاع على بناء جملة تكوين نموذج قواعد الأذونات هنا: https://casbin.org/docs/zh-CN/syntax-for-models


<?php

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // ملف نموذج قواعد الأذونات
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model أو adapter
            'class' => \app\model\Rule::class,
        ],
    ],
    // يمكن تكوين نماذج أذونات متعددة
    'rbac' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-rbac-model.conf', // ملف نموذج قواعد الأذونات
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'model', // model أو adapter
            'class' => \app\model\RBACRule::class,
        ],
    ],
];

المحولات

تدعم حزمة composer الحالية طريقة model الخاصة بـ think-orm، يرجى الاطلاع على vendor/teamones/src/adapters/DatabaseAdapter.php لمحولات أخرى.

ثم تعديل التكوين

return [
    'default' => [
        'model' => [
            'config_type' => 'file',
            'config_file_path' => config_path() . '/casbin-restful-model.conf', // ملف نموذج قواعد الأذونات
            'config_text' => '',
        ],
        'adapter' => [
            'type' => 'adapter', // هنا يتم تكوين النوع في وضع المحول
            'class' => \app\adapter\DatabaseAdapter::class,
        ],
    ],
];

إرشادات الاستخدام

الاستيراد

# الاستيراد
use teamones\casbin\Enforcer;

طريقتان للاستخدام

# 1. استخدام الإعداد الافتراضي
Enforcer::addPermissionForUser('user1', '/user', 'read');

# 2. استخدام تكوين rbac المخصص
Enforcer::instance('rbac')->addPermissionForUser('user1', '/user', 'read');

مقدمة إلى APIs المستخدمة بشكل شائع

للمزيد من استخدامات API، يرجى مراجعة الوثائق الرسمية.

# إضافة إذن لمستخدم

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

# حذف إذن مستخدم واحد

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

# الحصول على جميع الأذونات للمستخدم

Enforcer::getPermissionsForUser('user1'); 

# إضافة دور لمستخدم

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

# إضافة إذن لدور

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

# الحصول على جميع الأدوار

Enforcer::getAllRoles();

# الحصول على جميع الأدوار للمستخدم

Enforcer::getRolesForUser('user1');

# الحصول على المستخدمين باستخدام الدور

Enforcer::getUsersForRole('role1');

# التحقق مما إذا كان المستخدم ينتمي إلى الدور

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

# حذف مستخدم الدور

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

# حذف جميع أدوار المستخدم

Enforcer::deleteRolesForUser('use1');

# حذف الدور

Enforcer::deleteRole('role1');

# حذف الإذن

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

# حذف جميع الأذونات لمستخدم أو دور

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

# التحقق من الإذن، يرتجع true أو false

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