Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/rbac-db
yiisoft/db adapter for RBAC.
https://github.com/yiisoft/rbac-db
access-control db hacktoberfest rbac yii3
Last synced: 3 months ago
JSON representation
yiisoft/db adapter for RBAC.
- Host: GitHub
- URL: https://github.com/yiisoft/rbac-db
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-04-12T09:10:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T10:54:32.000Z (10 months ago)
- Last Synced: 2024-04-14T10:26:50.173Z (9 months ago)
- Topics: access-control, db, hacktoberfest, rbac, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 185 KB
- Stars: 15
- Watchers: 18
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii RBAC Database
[](https://packagist.org/packages/yiisoft/rbac-db)
[](https://packagist.org/packages/yiisoft/rbac-db)
[](https://github.com/yiisoft/rbac-db/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/rbac-db)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/rbac-db/master)
[](https://github.com/yiisoft/rbac-db/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/rbac-db)
The package provides [Yii Database](https://github.com/yiisoft/db) storage for
[Yii RBAC](https://github.com/yiisoft/rbac).
Detailed build statuses:
| RDBMS | Status |
|-------|--------|
| SQLite | [](https://github.com/yiisoft/rbac-db/actions?query=workflow%3Asqlite) |
| MySQL | [](https://github.com/yiisoft/rbac-db/actions?query=workflow%3Amysql) |
| PostgreSQL | [](https://github.com/yiisoft/rbac-db/actions?query=workflow%3Apgsql) |
| Microsoft SQL Server | [](https://github.com/yiisoft/rbac-db/actions?query=workflow%3Amssql) |
| Oracle | [](https://github.com/yiisoft/rbac-db/actions?query=workflow%3Aoracle) |
## Requirements
- PHP 8.1 or higher.
- `PDO` PHP extension.
- One of the following drivers:
- [SQLite](https://github.com/yiisoft/db-sqlite) (minimal required version is 3.8.3)
- [MySQL](https://github.com/yiisoft/db-mysql)
- [PostgreSQL](https://github.com/yiisoft/db-pgsql)
- [Microsoft SQL Server](https://github.com/yiisoft/db-mssql)
- [Oracle](https://github.com/yiisoft/db-oracle)
- `PDO` PHP extension for the selected driver.
- In the case of using with SQL Server, a minimal required version of PDO is 5.11.1.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/rbac-db
```
## General usage
### Configuring database connection
Configuration depends on a selected driver. Here is an example for PostgreSQL:
```php
use Yiisoft\Cache\ArrayCache; // Requires https://github.com/yiisoft/cache
use Yiisoft\Db\Cache\SchemaCache;
use Yiisoft\Db\Pgsql\Connection;
use Yiisoft\Db\Pgsql\Driver;
$pdoDriver = new Driver('pgsql:host=127.0.0.1;dbname=yiitest;port=5432', 'user', 'password');
$pdoDriver->charset('UTF8');
$connection = Connection(
$pdoDriver,
new SchemaCache(
new ArrayCache(), // Any other PSR-16 compatible cache can be used.
)
);
```
More comprehensive examples can be found at
[Yii Database docs](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md#prerequisites).
### Working with migrations
This package uses [Yii DB Migration](https://github.com/yiisoft/db-migration) for managing database tables required for
storages. There are three tables in total (`yii_rbac_` prefix is used).
Items storage:
- `yii_rbac_item`.
- `yii_rbac_item_child`.
Assignments storage:
- `yii_rbac_assignment`.
#### Configuring migrations
Make sure to include these directories as source paths:
- [migrations/items](./migrations/items);
- [migrations/assignments](./migrations/assignments).
When using [Yii Console](https://github.com/yiisoft/yii-console), add this to `config/params.php`:
```php
'yiisoft/db-migration' => [
// ...
'sourcePaths' => [
dirname(__DIR__) . '/vendor/yiisoft/rbac-db/migrations/items',
dirname(__DIR__) . '/vendor/yiisoft/rbac-db/migrations/assignments',
],
],
```
and database connection configuration from [previous section](#configuring-database-connection) to DI container
`config/common/db.php`:
```php
use Yiisoft\Db\Connection\ConnectionInterface;
use Yiisoft\Db\Pgsql\Connection as PgsqlConnection;
return [
ConnectionInterface::class => [
'class' => PgsqlConnection::class,
'__construct()' => [
// ...
],
]
];
```
Because item and assignment storages are completely independent, migrations are separated as well to prevent the
creation of unused tables. So, for example, if you only want to use assignment storage, add only
[migrations/assignments](./migrations/assignments) to source paths.
Other ways of using migrations are covered [here](https://github.com/yiisoft/db-migration#usage).
#### Applying migrations
Using with [Yii Console](https://github.com/yiisoft/yii-console):
```shell
./yii migrate:up
```
Other ways of using migrations are covered [here](https://github.com/yiisoft/db-migration#usage).
#### Reverting migrations
Using with [Yii Console](https://github.com/yiisoft/yii-console):
```shell
./yii migrate:down --limit=2
```
Other ways of using migrations are covered [here](https://github.com/yiisoft/db-migration#usage).
### Using storages
The storages are not intended to be used directly. Instead, use them with `Manager` from
[Yii RBAC](https://github.com/yiisoft/rbac) package:
```php
use Yiisoft\Db\Connection\ConnectionInterface;
use Yiisoft\Rbac\Db\AssignmentsStorage;
use Yiisoft\Rbac\Db\ItemsStorage;
use Yiisoft\Rbac\Db\TransactionalManagerDecorator;
use Yiisoft\Rbac\Manager;
use Yiisoft\Rbac\Permission;
use Yiisoft\Rbac\RuleFactoryInterface;
/** @var ConnectionInterface $database */
$itemsStorage = new ItemsStorage($database);
$assignmentsStorage = new AssignmentsStorage($database);
/** @var RuleFactoryInterface $rulesContainer */
$manager = new TransactionalManagerDecorator(
new Manager(
itemsStorage: $itemsStorage,
assignmentsStorage: $assignmentsStorage,
// Requires https://github.com/yiisoft/rbac-rules-container or another compatible factory.
ruleFactory: $rulesContainer,
),
);
$manager->addPermission(new Permission('posts.create'));
```
> Note wrapping manager with decorator—it additionally provides database transactions to guarantee data integrity.
> Note that it's not necessary to use both DB storages. Combining different implementations is possible. A quite popular
> case is to manage items via [PHP files](https://github.com/yiisoft/rbac-php) while storing assignments in a database.
More examples can be found in [Yii RBAC](https://github.com/yiisoft/rbac) documentation.
### Syncing storages manually
The storages stay synced thanks to manager, but there can be situations where you need to sync them manually. One of
them is using combination with PHP file based storage and
[editing it manually](https://github.com/yiisoft/rbac-php/?tab=readme-ov-file#file-structure).
Let's say PHP file is used for items, while database - for assignments, and some items were deleted:
```diff
return [
[
'name' => 'posts.admin',
'type' => 'role',
'created_at' => 1683707079,
'updated_at' => 1683707079,
'children' => [
'posts.redactor',
'posts.delete',
'posts.update.all',
],
],
- [
- 'name' => 'posts.redactor',
- 'type' => 'role',
- 'created_at' => 1683707079,
- 'updated_at' => 1683707079,
- 'children' => [
- 'posts.viewer',
- 'posts.create',
- 'posts.update',
- ],
- ],
[
'name' => 'posts.viewer',
'type' => 'role',
'created_at' => 1683707079,
'updated_at' => 1683707079,
'children' => [
'posts.view',
],
],
[
'name' => 'posts.view',
'type' => 'permission',
'created_at' => 1683707079,
'updated_at' => 1683707079,
],
[
'name' => 'posts.create',
'type' => 'permission',
'created_at' => 1683707079,
'updated_at' => 1683707079,
],
- [
- 'name' => 'posts.update',
- 'rule_name' => 'is_author',
- 'type' => 'permission',
- 'created_at' => 1683707079,
- 'updated_at' => 1683707079,
- ],
[
'name' => 'posts.delete',
'type' => 'permission',
'created_at' => 1683707079,
'updated_at' => 1683707079,
],
[
'name' => 'posts.update.all',
'type' => 'permission',
'created_at' => 1683707079,
'updated_at' => 1683707079,
],
];
```
Then related entries in other storage needs to be deleted as well. This can be done within a migration:
```php
use Yiisoft\Db\Migration\MigrationBuilder;
use Yiisoft\Db\Migration\RevertibleMigrationInterface;
use Yiisoft\Db\Migration\TransactionalMigrationInterface;
final class M240229184400DeletePostUpdateItems implements RevertibleMigrationInterface, TransactionalMigrationInterface
{
private const TABLE_PREFIX = 'yii_rbac_';
private const ASSIGNMENTS_TABLE = self::TABLE_PREFIX . 'assignment';
public function up(MigrationBuilder $b): void
{
$b
->getDb()
->createCommand()
->delete(self::ASSIGNMENTS_TABLE, ['item_name' => ['posts.redactor', 'posts.update']])
->execute();
}
public function down(MigrationBuilder $b): void;
{
}
}
```
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place
for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii RBAC Database is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)