Base for a static organization website

acl.php 4.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. <?php
  2. /**
  3. * This is the PHP base ACL configuration file.
  4. *
  5. * Use it to configure access control of your CakePHP application.
  6. *
  7. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8. * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  9. *
  10. * Licensed under The MIT License
  11. * For full copyright and license information, please see the LICENSE.txt
  12. * Redistributions of files must retain the above copyright notice.
  13. *
  14. * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  15. * @link http://cakephp.org CakePHP(tm) Project
  16. * @package app.Config
  17. * @since CakePHP(tm) v 2.1
  18. * @license http://www.opensource.org/licenses/mit-license.php MIT License
  19. */
  20. /**
  21. * Example
  22. * -------
  23. *
  24. * Assumptions:
  25. *
  26. * 1. In your application you created a User model with the following properties:
  27. * username, group_id, password, email, firstname, lastname and so on.
  28. * 2. You configured AuthComponent to authorize actions via
  29. * $this->Auth->authorize = array('Actions' => array('actionPath' => 'controllers/'),...)
  30. *
  31. * Now, when a user (i.e. jeff) authenticates successfully and requests a controller action (i.e. /invoices/delete)
  32. * that is not allowed by default (e.g. via $this->Auth->allow('edit') in the Invoices controller) then AuthComponent
  33. * will ask the configured ACL interface if access is granted. Under the assumptions 1. and 2. this will be
  34. * done via a call to Acl->check() with
  35. *
  36. * ```
  37. * array('User' => array('username' => 'jeff', 'group_id' => 4, ...))
  38. * ```
  39. *
  40. * as ARO and
  41. *
  42. * ```
  43. * '/controllers/invoices/delete'
  44. * ```
  45. *
  46. * as ACO.
  47. *
  48. * If the configured map looks like
  49. *
  50. * ```
  51. * $config['map'] = array(
  52. * 'User' => 'User/username',
  53. * 'Role' => 'User/group_id',
  54. * );
  55. * ```
  56. *
  57. * then PhpAcl will lookup if we defined a role like User/jeff. If that role is not found, PhpAcl will try to
  58. * find a definition for Role/4. If the definition isn't found then a default role (Role/default) will be used to
  59. * check rules for the given ACO. The search can be expanded by defining aliases in the alias configuration.
  60. * E.g. if you want to use a more readable name than Role/4 in your definitions you can define an alias like
  61. *
  62. * ```
  63. * $config['alias'] = array(
  64. * 'Role/4' => 'Role/editor',
  65. * );
  66. * ```
  67. *
  68. * In the roles configuration you can define roles on the lhs and inherited roles on the rhs:
  69. *
  70. * ```
  71. * $config['roles'] = array(
  72. * 'Role/admin' => null,
  73. * 'Role/accountant' => null,
  74. * 'Role/editor' => null,
  75. * 'Role/manager' => 'Role/editor, Role/accountant',
  76. * 'User/jeff' => 'Role/manager',
  77. * );
  78. * ```
  79. *
  80. * In this example manager inherits all rules from editor and accountant. Role/admin doesn't inherit from any role.
  81. * Lets define some rules:
  82. *
  83. * ```
  84. * $config['rules'] = array(
  85. * 'allow' => array(
  86. * '*' => 'Role/admin',
  87. * 'controllers/users/(dashboard|profile)' => 'Role/default',
  88. * 'controllers/invoices/*' => 'Role/accountant',
  89. * 'controllers/articles/*' => 'Role/editor',
  90. * 'controllers/users/*' => 'Role/manager',
  91. * 'controllers/invoices/delete' => 'Role/manager',
  92. * ),
  93. * 'deny' => array(
  94. * 'controllers/invoices/delete' => 'Role/accountant, User/jeff',
  95. * 'controllers/articles/(delete|publish)' => 'Role/editor',
  96. * ),
  97. * );
  98. * ```
  99. *
  100. * Ok, so as jeff inherits from Role/manager he's matched every rule that references User/jeff, Role/manager,
  101. * Role/editor, and Role/accountant. However, for jeff, rules for User/jeff are more specific than
  102. * rules for Role/manager, rules for Role/manager are more specific than rules for Role/editor and so on.
  103. * This is important when allow and deny rules match for a role. E.g. Role/accountant is allowed
  104. * controllers/invoices/* but at the same time controllers/invoices/delete is denied. But there is a more
  105. * specific rule defined for Role/manager which is allowed controllers/invoices/delete. However, the most specific
  106. * rule denies access to the delete action explicitly for User/jeff, so he'll be denied access to the resource.
  107. *
  108. * If we would remove the role definition for User/jeff, then jeff would be granted access as he would be resolved
  109. * to Role/manager and Role/manager has an allow rule.
  110. */
  111. /**
  112. * The role map defines how to resolve the user record from your application
  113. * to the roles you defined in the roles configuration.
  114. */
  115. $config['map'] = array(
  116. 'User' => 'User/username',
  117. 'Role' => 'User/group_id',
  118. );
  119. /**
  120. * define aliases to map your model information to
  121. * the roles defined in your role configuration.
  122. */
  123. $config['alias'] = array(
  124. 'Role/4' => 'Role/editor',
  125. );
  126. /**
  127. * role configuration
  128. */
  129. $config['roles'] = array(
  130. 'Role/admin' => null,
  131. );
  132. /**
  133. * rule configuration
  134. */
  135. $config['rules'] = array(
  136. 'allow' => array(
  137. '*' => 'Role/admin',
  138. ),
  139. 'deny' => array(),
  140. );