Zend_Acl | Zend_Acl Programmer's Reference Guide | Refining Access Controls

# Introduction

Zend_Acl provides a lightweight and flexible access control list (ACL) implementation for privileges management. In general, an application may utilize such ACL's to control access to certain protected objects by other requesting objects.

For the purposes of this documentation:

- a resource is an object to which access is controlled.

- a role is an object that may request access to a Resource.

Put simply, roles request access to resources. For example, if a parking attendant requests access to a car, then the parking attendant is the requesting role, and the car is the resource, since access to the car may not be granted to everyone.

Through the specification and use of an ACL, an application may control how roles are granted access to resources.

# Resources

Creating a resource in Zend_Acl is very simple. Zend_Acl provides the resource, Zend_Acl_Resource_Interface, to facilitate creating resources in an application. A class need only implement this interface, which consists of a single method, getResourceId(), for Zend_Acl to recognize the object as a resource. Additionally, Zend_Acl_Resource is provided by Zend_Acl as a basic resource implementation for developers to extend as needed.

Zend_Acl provides a tree structure to which multiple resources can be added. Since resources are stored in such a tree structure, they can be organized from the general (toward the tree root) to the specific (toward the tree leaves). Queries on a specific resource will automatically search the resource's hierarchy for rules assigned to ancestor resources, allowing for simple inheritance of rules. For example, if a default rule is to be applied to each building in a city, one would simply assign the rule to the city, instead of assigning the same rule to each building. Some buildings may require exceptions to such a rule, however, and this can be achieved in Zend_Acl by assigning such exception rules to each building that requires such an exception. A resource may inherit from only one parent resource, though this parent resource can have its own parent resource, etc.

Zend_Acl also supports privileges on resources (e.g., "create", "read", "update", "delete"), so the developer can assign rules that affect all privileges or specific privileges on one or more resources.

# Roles

As with resources, creating a role is also very simple. All roles must implement Zend_Acl_Role_Interface. This interface consists of a single method, getRoleId(), Additionally, Zend_Acl_Role is provided by Zend_Acl as a basic role implementation for developers to extend as needed.

In Zend_Acl, a role may inherit from one or more roles. This is to support inheritance of rules among roles. For example, a user role, such as "sally", may belong to one or more parent roles, such as "editor" and "administrator". The developer can assign rules to "editor" and "administrator" separately, and "sally" would inherit such rules from both, without having to assign rules directly to "sally".

Though the ability to inherit from multiple roles is very useful, multiple inheritance also introduces some degree of complexity. The following example illustrates the ambiguity condition and how Zend_Acl solves it.

Example #1 Multiple Inheritance among Roles

The following code defines three base roles - "guest", "member", and "admin" - from which other roles may inherit. Then, a role identified by "someUser" is established and inherits from the three other roles. The order in which these roles appear in the $parents array is important. When necessary, Zend_Acl searches for access rules defined not only for the queried role (herein, "someUser"), but also upon the roles from which the queried role inherits (herein, "guest", "member", and "admin"):

1. $acl = new Zend_Acl();
3. $acl->addRole(new Zend_Acl_Role('guest'))
4. ->addRole(new Zend_Acl_Role('member'))
5. ->addRole(new Zend_Acl_Role('admin'));
7. $parents = array ('guest', 'member', 'admin');
8. $acl->addRole(new Zend_Acl_Role('someUser'), $parents);
10. $acl->add(new Zend_Acl_Resource('someResource'));
12. $acl->deny('guest', 'someResource');
13. $acl->allow('member', 'someResource');
15. echo $acl->isAllowed('someUser', 'someResource') ? 'allowed' : 'denied';

Since there is no rule specifically defined for the "someUser" role and "someResource", Zend_Acl must search for rules that may be defined for roles that "someUser" inherits. First, the "admin" role is visited, and there is no access rule defined for it. Next, the "member" role is visited, and Zend_Acl finds that there is a rule specifying that "member" is allowed access to "someResource".

If Zend_Acl were to continue examining the rules defined for other parent roles, however, it would find that "guest" is denied access to "someResource". This fact introduces an ambiguity because now "someUser" is both denied and allowed access to "someResource", by reason of having inherited conflicting rules from different parent roles.

Zend_Acl resolves this ambiguity by completing a query when it finds the first rule that is directly applicable to the query. In this case, since the "member" role is examined before the "guest" role, the example code would print "allowed".

> Note: When specifying multiple parents for a role, keep in mind that the last parent listed is the first one searched for rules applicable to an authorization query.

# Creating the Access Control List

An Access Control List (ACL) can represent any set of physical or virtual objects that you wish. For the purposes of demonstration, however, we will create a basic Content Management System (CMS) ACL that maintains several tiers of groups over a wide variety of areas. To create a new ACL object, we instantiate the ACL with no parameters:

1. $acl = new Zend_Acl();

> Note: Until a developer specifies an "allow" rule, Zend_Acl denies access to every privilege upon every resource by every role.

# Registering Roles

CMS's will nearly always require a hierarchy of permissions to determine the authoring capabilities of its users. There may be a 'Guest' group to allow limited access for demonstrations, a 'Staff' group for the majority of CMS users who perform most of the day-to-day operations, an 'Editor' group for those responsible for publishing, reviewing, archiving and deleting content, and finally an 'Administrator' group whose tasks may include all of those of the other groups as well as maintenance of sensitive information, user management, back-end configuration data, backup and export. This set of permissions can be represented in a role registry, allowing each group to inherit privileges from 'parent' groups, as well as providing distinct privileges for their unique group only. The permissions may be expressed as follows:

Access Controls for an Example CMS
Name | Unique Permissions | Inherit Permissions From
--- | --- | ---
Guest | View | N/A
Staff | Edit, Submit, Revise | Guest
Editor | Publish, Archive, Delete | Staff
Administrator | (Granted all access) | N/A

For this example, Zend_Acl_Role is used, but any object that implements Zend_Acl_Role_Interface is acceptable. These groups can be added to the role registry as follows:

1. $acl = new Zend_Acl();
3. // Add groups to the Role registry using Zend_Acl_Role
4. // Guest does not inherit access controls
5. $roleGuest = new Zend_Acl_Role('guest');
6. $acl->addRole($roleGuest);
8. // Staff inherits from guest
9. $acl->addRole(new Zend_Acl_Role('staff'), $roleGuest);
11. /*
12. Alternatively, the above could be written:
13. $acl->addRole(new Zend_Acl_Role('staff'), 'guest');
14. */
16. // Editor inherits from staff
17. $acl->addRole(new Zend_Acl_Role('editor'), 'staff');
19. // Administrator does not inherit access controls
20. $acl->addRole(new Zend_Acl_Role('administrator'));

# Defining Access Controls

Now that the ACL contains the relevant roles, rules can be established that define how resources may be accessed by roles. You may have noticed that we have not defined any particular resources for this example, which is simplified to illustrate that the rules apply to all resources. Zend_Acl provides an implementation whereby rules need only be assigned from general to specific, minimizing the number of rules needed, because resources and roles inherit rules that are defined upon their ancestors.

> Note: In general, Zend_Acl obeys a given rule if and only if a more specific rule does not apply.

Consequently, we can define a reasonably complex set of rules with a minimum amount of code. To apply the base permissions as defined above:

1. $acl = new Zend_Acl();
3. $roleGuest = new Zend_Acl_Role('guest');
4. $acl->addRole($roleGuest);
5. $acl->addRole(new Zend_Acl_Role('staff'), $roleGuest);
6. $acl->addRole(new Zend_Acl_Role('editor'), 'staff');
7. $acl->addRole(new Zend_Acl_Role('administrator'));
9. // Guest may only view content
10. $acl->allow($roleGuest, null, 'view');
12. /*
13. Alternatively, the above could be written:
14. $acl->allow('guest', null, 'view');
15. //*/
17. // Staff inherits view privilege from guest, but also needs additional
18. // privileges
19. $acl->allow('staff', null, array ('edit', 'submit', 'revise'));
21. // Editor inherits view, edit, submit, and revise privileges from
22. // staff, but also needs additional privileges
23. $acl->allow('editor', null, array ('publish', 'archive', 'delete'));
25. // Administrator inherits nothing, but is allowed all privileges
26. $acl->allow('administrator');

The `NULL` values in the above allow() calls are used to indicate that the allow rules apply to all resources.

# Querying an ACL

We now have a flexible ACL that can be used to determine whether requesters have permission to perform functions throughout the web application. Performing queries is quite simple using the isAllowed() method:

1. echo $acl->isAllowed('guest', null, 'view') ?
2. "allowed" : "denied";
3. // allowed
5. echo $acl->isAllowed('staff', null, 'publish') ?
6. "allowed" : "denied";
7. // denied
9. echo $acl->isAllowed('staff', null, 'revise') ?
10. "allowed" : "denied";
11. // allowed
13. echo $acl->isAllowed('editor', null, 'view') ?
14. "allowed" : "denied";
15. // allowed because of inheritance from guest
17. echo $acl->isAllowed('editor', null, 'update') ?
18. "allowed" : "denied";
19. // denied because no allow rule for 'update'
21. echo $acl->isAllowed('administrator', null, 'view') ?
22. "allowed" : "denied";
23. // allowed because administrator is allowed all privileges
25. echo $acl->isAllowed('administrator') ?
26. "allowed" : "denied";
27. // allowed because administrator is allowed all privileges
29. echo $acl->isAllowed('administrator', null, 'update') ?
30. "allowed" : "denied";
31. // allowed because administrator is allowed all privileges

Zend_Acl | Zend_Acl Programmer's Reference Guide | Refining Access Controls