README

基于属性的访问控制实现库

介绍

此库旨在在您的PHP应用程序中实现ABAC的概念。

该概念是通过使用属性来管理访问控制：从用户、资源和环境。

它允许我们根据用户对象的属性以及可选的访问对象的属性来定义规则。

这些规则将在您的应用程序中进行检查，以确定用户是否被允许执行操作。

以下链接解释了ABAC是什么

安装

使用composer

composer require craftcamp/php-abac

然后您需要配置应用程序的属性和规则。

有关此方面的更多详细信息，请参阅专用文档

文档

使用示例

仅定义规则中的用户属性示例

在这个示例中，有一个对象，代表当前用户。

此对象有属性，有getter方法来访问值。

例如，我们可以编写

<?php

use PhpAbac\AbacFactory;

class User{
    protected $id;

    protected $isBanned;

    public function getId() {
        return $this->id;
    }

    public function setIsBanned($isBanned) {
        $this->isBanned = $isBanned;

        return $this;
    }

    public function getIsBanned() {
        return $this->isBanned;
    }
}

$user = new User();
$user->setIsBanned(true);

$abac = AbacFactory::getAbac([
    'policy_rule_configuration.yml'
]);
$abac->enforce('create-group', $user);

规则检查的属性可以是

具有用户和对象属性的示例

use PhpAbac\AbacFactory;

$abac = AbacFactory::getAbac([
    'policy_rule_configuration.yml'
]);
$check = $abac->enforce('read-public-group', $user, $group);

检查的属性可以是

具有动态属性的示例

<?php

use PhpAbac\AbacFactory;

$abac = AbacFactory::getAbac([
    'policy_rule_configuration.yml'
]);
$check = $abac->enforce('edit-group', $user, $group, [
    'dynamic-attributes' => [
        'group-owner' => $user->getId()
    ]
]);

具有引用属性的示例

配置应如下所示

attributes:
    group:
        class: MyApp\Model\Group
        type: resource
        fields:
            author.id:
                name: Author ID
    app_user:
        class: MyApp\Model\User
        type: user
        fields:
            id:
                name: User ID

rules:
    remove-group:
        attributes:
            app_user.id:
                comparison: object
                comparison_type: isFieldEqual
                value: group.author.id

然后代码

<?php

use PhpAbac\AbacFactory;

$abac = AbacFactory::getAbac([
    'policy_rule_configuration.yml'
]);
$check = $abac->enforce('remove-group', $user, $group);

具有缓存的示例

$check = $abac->enforce('edit-group', $user, $group, [
    'cache_result' => true,
    'cache_ttl' => 3600, // Time To Live in seconds
    'cache_driver' => 'memory' // memory is the default driver, you can avoid this option
]);

具有唯一规则（ruleSet）的多个规则（规则集）示例。每个规则都会被测试，并且当ruleSet中的第一个规则允许访问时，处理将停止。

配置应如下所示（alcoolaw.yml）

attributes:
    main_user:
        class: PhpAbac\Example\User
        type: user
        fields:
            age:
                name: Age
            country:
                name: Code ISO du pays
rules:
    alcoollaw:
        -
            attributes:
                main_user.age:
                    comparison_type: numeric
                    comparison: isGreaterThan
                    value: 18
                main_user.country:
                    comparison_type: string
                    comparison: isEqual
                    value: FR
        -
            attributes:
                main_user.age:
                    comparison_type: numeric
                    comparison: isGreaterThan
                    value: 21
                main_user.country:
                    comparison_type: string
                    comparison: isNotEqual
                    value: FR

然后代码

<?php

use PhpAbac\AbacFactory;

$abac = AbacFactory::getAbac([
    'alcoollaw.yml'
]);
$check = $abac->enforce('alcoollaw', $user);

将规则根目录传递给Abac类的示例。此功能允许将策略定义规则目录路径直接传递给Abac类，而无需添加到所有文件。

假设我们有3个yaml文件

rest/conf/policy/user_def.yml
rest/conf/policy/gunlaw.yml

PHP代码可以是

<?php

use PhpAbac\AbacFactory;

$abac = AbacFactory::getAbac([
    'user_def.yml',
    'gunlaw.yml',
],[],'rest/conf/policy/');
$check = $abac->enforce('gunlaw', $user);

贡献

如果您想贡献，请不要犹豫，将该库分支并提交Pull Requests。

您还可以报告问题、提出改进建议、自由地提出建议和关于此库的反馈。

它尚未完成，还有许多要实现的功能以使其更好。如果您想成为此库改进的一部分，请告诉我们！

另请参阅

支持此库的Symfony捆绑包

andrii-hrechyn / php-abac

维护者

详细信息

README

基于属性的访问控制实现库

介绍

安装

文档

使用示例

贡献

另请参阅