Edit

Management API

The primitive API that provides full support for Casbin policy management.

Reference

global variable e is Enforcer instance.

Go

Node.js

PHP

e := NewEnforcer("examples/rbac_model.conf", "examples/rbac_policy.csv")

const e = await newEnforcer('examples/rbac_model.conf', 'examples/rbac_policy.csv')

$e = new Enforcer('examples/rbac_model.conf', 'examples/rbac_policy.csv');

GetAllSubjects()

GetAllSubjects gets the list of subjects that show up in the current policy.

For example:

Go

Node.js

PHP

allSubjects := e.GetAllSubjects()

const allSubjects = e.getAllSubjects()

$allSubjects = $e->getAllSubjects();

GetAllNamedSubjects()

GetAllNamedSubjects gets the list of subjects that show up in the current named policy.

For example:

Go

Node.js

PHP

allNamedSubjects := e.GetAllNamedSubjects("p")

const allNamedSubjects = e.getAllNamedSubjects('p')

$allNamedSubjects = $e->getAllNamedSubjects("p");

GetAllObjects()

GetAllObjects gets the list of objects that show up in the current policy.

For example:

Go

Node.js

PHP

allObjects := e.GetAllObjects()

const allObjects = e.getAllObjects()

$allObjects = $e->getAllObjects();

GetAllNamedObjects()

GetAllNamedObjects gets the list of objects that show up in the current named policy.

For example:

Go

Node.js

PHP

allNamedObjects := e.GetAllNamedObjects("p")

const allNamedObjects = e.getAllNamedObjects('p')

$allNamedObjects = $e->getAllNamedObjects("p");

GetAllActions()

GetAllActions gets the list of actions that show up in the current policy.

For example:

Go

Node.js

PHP

allActions := e.GetAllActions()

const allActions = e.getAllActions()

$allActions = $e->getAllActions();

GetAllNamedActions()

GetAllNamedActions gets the list of actions that show up in the current named policy.

For example:

Go

Node.js

PHP

allNamedActions := e.GetAllNamedActions("p")

const allNamedActions = e.getAllNamedActions('p')

$allNamedActions = $e->getAllNamedActions("p");

GetAllRoles()

GetAllRoles gets the list of roles that show up in the current policy.

For example:

Go

Node.js

PHP

allRoles = e.GetAllRoles()

const allRoles = e.getAllRoles()

$allRoles = $e->getAllRoles();

GetAllNamedRoles()

GetAllNamedRoles gets the list of roles that show up in the current named policy.

For example:

Go

Node.js

PHP

allNamedRoles := e.GetAllNamedRoles("g")

const allNamedRoles = e.getAllNamedRoles('g')

$allNamedRoles = $e->getAllNamedRoles('g');

GetPolicy()

GetPolicy gets all the authorization rules in the policy.

For example:

Go

Node.js

PHP

policy = e.GetPolicy()

const policy = e.getPolicy()

$policy = $e->getPolicy();

GetFilteredPolicy()

GetFilteredPolicy gets all the authorization rules in the policy, field filters can be specified.

For example:

Go

Node.js

PHP

filteredPolicy := e.GetFilteredPolicy(0, "alice")

const filteredPolicy = e.getFilteredPolicy(0, 'alice')

$filteredPolicy = $e->getFilteredPolicy(0, "alice");

GetNamedPolicy()

GetNamedPolicy gets all the authorization rules in the named policy.

For example:

Go

Node.js

PHP

namedPolicy := e.GetNamedPolicy("p")

const namedPolicy = e.getNamedPolicy('p')

$namedPolicy = $e->getNamedPolicy("p");

GetFilteredNamedPolicy()

GetFilteredNamedPolicy gets all the authorization rules in the named policy, field filters can be specified.

For example:

Go

Node.js

PHP

filteredNamedPolicy = e.GetFilteredNamedPolicy("p", 0, "bob")

const filteredNamedPolicy = e.getFilteredNamedPolicy('p', 0, 'bob')

$filteredNamedPolicy = $e->getFilteredNamedPolicy("p", 0, "bob");

GetGroupingPolicy()

GetGroupingPolicy gets all the role inheritance rules in the policy.

For example:

Go

Node.js

PHP

groupingPolicy := e.GetGroupingPolicy()

const groupingPolicy = e.getGroupingPolicy()

$groupingPolicy = $e->getGroupingPolicy();

GetFilteredGroupingPolicy()

GetFilteredGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.

For example:

Go

Node.js

Go

filteredGroupingPolicy := e.GetFilteredGroupingPolicy(0, "alice")

const filteredGroupingPolicy = e.getFilteredGroupingPolicy(0, 'alice')

$filteredGroupingPolicy = $e->getFilteredGroupingPolicy(0, "alice");

GetNamedGroupingPolicy()

GetNamedGroupingPolicy gets all the role inheritance rules in the policy.

For example:

Go

Node.js

PHP

namedGroupingPolicy := e.GetNamedGroupingPolicy("g")

const namedGroupingPolicy = e.getNamedGroupingPolicy('g')

$namedGroupingPolicy = $e->getNamedGroupingPolicy("g");

GetFilteredNamedGroupingPolicy()

GetFilteredNamedGroupingPolicy gets all the role inheritance rules in the policy.

For example:

Go

Node.js

PHP

namedGroupingPolicy := e.GetFilteredNamedGroupingPolicy("g", 0, "alice")

const namedGroupingPolicy = e.getFilteredNamedGroupingPolicy('g', 0, 'alice')

$namedGroupingPolicy = $e->getFilteredNamedGroupingPolicy("g", 0, "alice");

HasPolicy()

HasPolicy determines whether an authorization rule exists.

For example:

Go

Node.js

PHP

hasPolicy := e.HasPolicy("data2_admin", "data2", "read")

const hasPolicy = e.hasPolicy('data2_admin', 'data2', 'read')

$hasPolicy = $e->hasPolicy('data2_admin', 'data2', 'read');

HasNamedPolicy()

HasNamedPolicy determines whether a named authorization rule exists.

For example:

Go

Node.js

PHP

hasNamedPolicy := e.HasNamedPolicy("p", "data2_admin", "data2", "read")

const hasNamedPolicy = e.hasNamedPolicy('p', 'data2_admin', 'data2', 'read')

$hasNamedPolicy = $e->hasNamedPolicy("p", "data2_admin", "data2", "read");

AddPolicy()

AddPolicy adds an authorization rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

For example:

Go

Node.js

PHP

added := e.AddPolicy("eve", "data3", "read")

const p = ['eve', 'data3', 'read']
const added = await e.addPolicy(...p)

$added = $e->addPolicy('eve', 'data3', 'read');

AddNamedPolicy()

AddNamedPolicy adds an authorization rule to the current named policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

For example:

Go

Node.js

PHP

added := e.AddNamedPolicy("p", "eve", "data3", "read")

const p = ['eve', 'data3', 'read']
const added = await e.addNamedPolicy('p', ...p)

$added = $e->addNamedPolicy("p", "eve", "data3", "read");

RemovePolicy()

RemovePolicy removes an authorization rule from the current policy.

For example:

Go

Node.js

PHP

removed := e.RemovePolicy("alice", "data1", "read")

const p = ['alice', 'data1', 'read']
const removed = await e.removePolicy(...p)

$removed = $e->removePolicy("alice", "data1", "read");

RemoveFilteredPolicy()

RemoveFilteredPolicy removes an authorization rule from the current policy, field filters can be specified. RemovePolicy removes an authorization rule from the current policy.

For example:

Go

Node.js

PHP

removed := e.RemoveFilteredPolicy(0, "alice", "data1", "read")

const p = ['alice', 'data1', 'read']
const removed = await e.removeFilteredPolicy(0, ...p)

$removed = $e->removeFilteredPolicy(0, "alice", "data1", "read");

RemoveNamedPolicy()

RemoveNamedPolicy removes an authorization rule from the current named policy.

For example:

Go

Node.js

PHP

removed := e.RemoveNamedPolicy("p", "alice", "data1", "read")

const p = ['alice', 'data1', 'read']
const removed = await e.removeNamedPolicy('p', ...p)

$removed = $e->removeNamedPolicy("p", "alice", "data1", "read");

RemoveFilteredNamedPolicy()

RemoveFilteredNamedPolicy removes an authorization rule from the current named policy, field filters can be specified.

For example:

Go

Node.js

PHP

removed := e.RemoveFilteredNamedPolicy("p", 0, "alice", "data1", "read")

const p = ['alice', 'data1', 'read']
const removed = await e.removeFilteredNamedPolicy('p', 0, ...p)

$removed = $e->removeFilteredNamedPolicy("p", 0, "alice", "data1", "read");

HasGroupingPolicy()

HasGroupingPolicy determines whether a role inheritance rule exists.

For example:

Go

Node.js

PHP

has := e.HasGroupingPolicy("alice", "data2_admin")

const has = e.hasGroupingPolicy('alice', 'data2_admin')

$has = $e->hasGroupingPolicy("alice", "data2_admin");

HasNamedGroupingPolicy()

HasNamedGroupingPolicy determines whether a named role inheritance rule exists.

For example:

Go

Node.js

PHP

has := e.HasNamedGroupingPolicy("g", "alice", "data2_admin")

const has = e.hasNamedGroupingPolicy('g', 'alice', 'data2_admin')

$has = $e->hasNamedGroupingPolicy("g", "alice", "data2_admin");

AddGroupingPolicy()

AddGroupingPolicy adds a role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

For example:

Go

Node.js

PHP

added := e.AddGroupingPolicy("group1", "data2_admin")

const added = await e.addGroupingPolicy('group1', 'data2_admin')

$added = $e->addGroupingPolicy("group1", "data2_admin");

AddNamedGroupingPolicy()

AddNamedGroupingPolicy adds a named role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

For example:

Go

Node.js

PHP

added := e.AddNamedGroupingPolicy("g", "group1", "data2_admin")

const added = await e.addNamedGroupingPolicy('g', 'group1', 'data2_admin')

$added = $e->addNamedGroupingPolicy("g", "group1", "data2_admin");

RemoveGroupingPolicy()

RemoveGroupingPolicy removes a role inheritance rule from the current policy.

For example:

Go

Node.js

PHP

removed := e.RemoveGroupingPolicy("alice", "data2_admin")

const removed = await e.removeGroupingPolicy('alice', 'data2_admin')

$removed = $e->removeGroupingPolicy("alice", "data2_admin");

RemoveFilteredGroupingPolicy()

RemoveFilteredGroupingPolicy removes a role inheritance rule from the current policy, field filters can be specified.

For example:

Go

Node.js

PHP

removed := e.RemoveFilteredGroupingPolicy(0, "alice")

const removed = await e.removeFilteredGroupingPolicy(0, 'alice')

$removed = $e->removeFilteredGroupingPolicy(0, "alice");

RemoveNamedGroupingPolicy()

RemoveNamedGroupingPolicy removes a role inheritance rule from the current named policy.

For example:

Go

Node.js

PHP

removed := e.RemoveNamedGroupingPolicy("g", "alice")

const removed = await e.removeNamedGroupingPolicy('g', 'alice')

$removed = $e->removeNamedGroupingPolicy("g", "alice");

RemoveFilteredNamedGroupingPolicy()

RemoveFilteredNamedGroupingPolicy removes a role inheritance rule from the current named policy, field filters can be specified.

For example:

Go

Node.js

PHP

removed := e.RemoveFilteredNamedGroupingPolicy("g", 0, "alice")

const removed = await e.removeFilteredNamedGroupingPolicy('g', 0, 'alice')

$removed = $e->removeFilteredNamedGroupingPolicy("g", 0, "alice");

AddFunction()

AddFunction adds a customized function.

For example:

Go

Node.js

PHP

func CustomFunction(key1 string, key2 string) bool {
    if key1 == "/alice_data2/myid/using/res_id" && key2 == "/alice_data/:resource" {
        return true
    } else if key1 == "/alice_data2/myid/using/res_id" && key2 == "/alice_data2/:id/using/:resId" {
        return true
    } else {
        return false
    }
}

func CustomFunctionWrapper(args ...interface{}) (interface{}, error) {
    key1 := args[0].(string)
    key2 := args[1].(string)

    return bool(CustomFunction(key1, key2)), nil
}

e.AddFunction("keyMatchCustom", CustomFunctionWrapper)

Method is not implemented

func customFunction($key1, $key2) {
    if ($key1 == "/alice_data2/myid/using/res_id" && $key2 == "/alice_data/:resource") {
        return true;
    } elseif ($key1 == "/alice_data2/myid/using/res_id" && $key2 == "/alice_data2/:id/using/:resId") {
        return true;
    } else {
        return false;
    }
}

func customFunctionWrapper(...$args){
    $key1 := $args[0];
    $key2 := $args[1];

    return customFunction($key1, $key2);
}

$e->addFunction("keyMatchCustom", customFunctionWrapper);