Zend_Acl.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: 20763 -->
  4. <sect1 id="zend.acl.introduction">
  5. <title>Einführung</title>
  6. <para>
  7. <classname>Zend_Acl</classname> stellt eine Implementation von leichtgewichtigen und
  8. flexiblen Zugriffskontrolllisten (englisch "access control list",
  9. <acronym>ACL</acronym>) für die Rechteverwaltung bereit. Im Allgemeinen kann eine Anwendung
  10. derartige <acronym>ACL</acronym>s verwenden, um den Zugriff auf bestimmte, geschützte
  11. Objekte durch andere anfordernde Objekte zu kontrollieren.
  12. </para>
  13. <para>
  14. In dieser Dokumentation:
  15. </para>
  16. <itemizedlist>
  17. <listitem>
  18. <para>
  19. ist eine <emphasis>Ressource</emphasis> ein Objekt, auf das der
  20. Zugriff kontrolliert wird.
  21. </para>
  22. </listitem>
  23. <listitem>
  24. <para>
  25. ist eine <emphasis>Rolle</emphasis> ein Objekt, das den Zugriff
  26. auf eine Ressource anfordern kann.
  27. </para>
  28. </listitem>
  29. </itemizedlist>
  30. <para>
  31. Einfach ausgedrückt <emphasis>fordern Rollen den Zugriff auf Ressourcen
  32. an</emphasis>. Wenn z.B. ein Parkplatzwächter den Zugriff auf ein Auto anfordert, ist der
  33. Parkplatzwächter die anfordernde Rolle und das Auto die Ressource, weil der Zugriff auf das
  34. Auto nicht jedem erlaubt ist.
  35. </para>
  36. <para>
  37. Durch die Spezifikation und die Verwendung einer <acronym>ACL</acronym> kann eine Anwendung
  38. kontrollieren, wie Rollen den Zugriff auf Ressourcen eingeräumt bekommen.
  39. </para>
  40. <sect2 id="zend.acl.introduction.resources">
  41. <title>Ressourcen</title>
  42. <para>
  43. Das Erstellen einer Ressource ist in <classname>Zend_Acl</classname> sehr einfach.
  44. <classname>Zend_Acl</classname> stellt die Ressource
  45. <classname>Zend_Acl_Resource_Interface</classname> bereit, um das Erstellen von
  46. Ressourcen in Anwendungen zu ermöglichen. Eine Klasse muss nur dieses Interface
  47. implementieren, das nur aus einer einzelnen Methode
  48. <methodname>getResourceId()</methodname> besteht, damit <classname>Zend_Acl</classname>
  49. das Objekt als Ressource erkennen kann. Zusätzlich ist
  50. <classname>Zend_Acl_Resource</classname> in <classname>Zend_Acl</classname> als einfache
  51. Ressourcen-Implementation enthalten, damit Entwickler sie wenn nötig erweitern können.
  52. </para>
  53. <para>
  54. <classname>Zend_Acl</classname> stellt eine Baumstruktur bereit, in die mehrere
  55. Ressourcen aufgenommen werden können. Weil Ressourcen in solch einer Baumstruktur
  56. abgelegt werden, können sie vom Allgemeinen (von der Baumwurzel) bis zum Speziellen (zu
  57. den Baumblättern) organisiert werden. Abfragen auf einer bestimmten Ressource
  58. durchsuchen automatisch die Ressourcenhierarchie nach Regeln, die einer übergeordneten
  59. Ressource zugeordnet wurden, um die einfache Vererbung von Regeln zu ermöglichen. Wenn
  60. zum Beispiel eine Standardregel für jedes Gebäude einer Stadt gelten soll, würde man
  61. diese Regel einfach der Stadt zuordnen, anstatt die selbe Regel jedem Gebäude
  62. zuzuordnen. Einige Gebäude können dennoch Ausnahmen zu solch einer Regel erfordern, und
  63. dies kann in <classname>Zend_Acl</classname> einfach durch die Zuordnung solcher
  64. Ausnahmeregeln zu jedem der Gebäude erreicht werden, die eine Ausnahme erfordern. Eine
  65. Ressource kann nur von einer einzigen übergeordneten Ressource erben, obwohl diese
  66. übergeordnete Ressource ihre eigenen übergeordneten Ressourcen haben kann, und so
  67. weiter.
  68. </para>
  69. <para>
  70. <classname>Zend_Acl</classname> unterstützt außerdem Rechte auf Ressourcen (z.B.
  71. "erstellen", "lesen", "aktualisieren", "löschen"), damit der Entwickler Regeln zuordnen
  72. kann, die alle Rechte oder bestimmte Rechte von einer oder mehreren Ressourcen
  73. beeinflussen.
  74. </para>
  75. </sect2>
  76. <sect2 id="zend.acl.introduction.roles">
  77. <title>Rollen</title>
  78. <para>
  79. Wie bei den Ressourcen ist auch das Erstellen einer Rolle sehr einfach. Alle Rollen
  80. müssen <classname>Zend_Acl_Role_Interface</classname> implementieren. Dieses Interface
  81. besteht aus einer einzelnen Methode, <methodname>getRoleId()</methodname>, zusätzlich
  82. wird <classname>Zend_Acl_Role</classname> von <classname>Zend_Acl</classname> als
  83. einfache Rollen Implementation angeboten, damit Entwickler sie bei Bedarf erweitern
  84. können.
  85. </para>
  86. <para>
  87. In <classname>Zend_Acl</classname> kann eine Rolle von einer oder mehreren Rollen
  88. erben. Dies soll die Vererbung von Regeln zwischen den Rollen ermöglichen. Zum Beispiel
  89. kann eine Benutzerrolle, wie "Sally" zu einer oder mehreren übergeordneten Rollen
  90. gehören, wie "Editor" und "Administrator". Der Entwickler kann zu "Editor" und
  91. "Administrator" getrennt Regeln zuordnen und "Sally" würde diese Regeln von beiden
  92. erben, ohne dass "Sally" direkt Regeln zugeordnet werden müssen.
  93. </para>
  94. <para>
  95. Auch wenn die Möglichkeit der Vererbung von verschiedenen Rollen sehr nützlich ist,
  96. führt die mehrfache Vererbung auch einen gewissen Grad an Komplexität ein. Das folgende
  97. Beispiel illustriert die mehrdeutigen Bedingungen und wie
  98. <classname>Zend_Acl</classname> sie auflöst.
  99. </para>
  100. <example id="zend.acl.introduction.roles.example.multiple_inheritance">
  101. <title>Mehrfache Vererbung zwischen Rollen</title>
  102. <para>
  103. Der folgende Code definiert drei Basisrollen - "guest", "member" und "admin" - von
  104. denen andere Rollen erben können. Dann wird eine Rolle "someUser" eingerichtet, die
  105. von den drei anderen Rollen erbt. Die Reihenfolge, in der diese Rollen im
  106. <varname>$parents</varname> Array erscheinen, ist wichtig. Wenn notwendig, sucht
  107. <classname>Zend_Acl</classname> nach Zugriffsregeln nicht nur für die abgefragte
  108. Rolle (hier "someUser"), sondern auch für die Rollen, von denen die abgefragte
  109. Rolle erbt (hier "guest", "member" und "admin"):
  110. </para>
  111. <programlisting language="php"><![CDATA[
  112. $acl = new Zend_Acl();
  113. $acl->addRole(new Zend_Acl_Role('guest'))
  114. ->addRole(new Zend_Acl_Role('member'))
  115. ->addRole(new Zend_Acl_Role('admin'));
  116. $parents = array('guest', 'member', 'admin');
  117. $acl->addRole(new Zend_Acl_Role('someUser'), $parents);
  118. $acl->add(new Zend_Acl_Resource('someResource'));
  119. $acl->deny('guest', 'someResource');
  120. $acl->allow('member', 'someResource');
  121. echo $acl->isAllowed('someUser', 'someResource') ? 'allowed' : 'denied';
  122. ]]></programlisting>
  123. <para>
  124. Da keine Regel speziell für die Rolle "someUser" und "someResource" definiert
  125. wurde, muss <classname>Zend_Acl</classname> nach Regeln suchen, die für Rollen
  126. definiert wurden, von denen "someUser" erbt. Zuerst wird die "admin"-Rolle besucht,
  127. aber dort ist keine Zugriffsregel definiert. Als nächste wird die "member"-Rolle
  128. besucht und <classname>Zend_Acl</classname> findet hier eine Regel, die angibt,
  129. dass "member" der Zugriff auf "someResource" erlaubt ist.
  130. </para>
  131. <para>
  132. Wenn <classname>Zend_Acl</classname> fortfahren würde, die für weitere
  133. übergeordnete Rollen definierten Regeln zu untersuchen, würde herausgefunden
  134. werden, dass "guest" der Zugriff auf "someResource" verboten ist.
  135. Diese Tatsache führt eine Mehrdeutigkeit ein, weil nun "someUser" der Zugriff auf
  136. "someResource" sowohl verboten als auch erlaubt ist, aufgrund der vererbten Regeln
  137. von verschiedenen übergeordnete Rollen, die miteinander im Konflikt stehen.
  138. </para>
  139. <para>
  140. <classname>Zend_Acl</classname> löst diese Mehrdeutigkeit dadurch auf, dass eine
  141. Abfrage beendet wird, wenn die erste Regel gefunden wird, die direkt auf die
  142. Abfrage passt. In diesem Fall würde der Beispiel Code "allowed"
  143. ausgeben, weil die "member"-Rolle vor der "guest"-Rolle untersucht wird.
  144. </para>
  145. </example>
  146. <note>
  147. <para>
  148. Wenn man mehrere übergeordnete Rollen angibt, sollte man beachten, dass die zuletzt
  149. gelistete Rolle als erstes nach Regeln durchsucht wird, die auf die
  150. Autorisierungsabfrage passen.
  151. </para>
  152. </note>
  153. </sect2>
  154. <sect2 id="zend.acl.introduction.creating">
  155. <title>Erstellen einer Zugriffskontrollliste</title>
  156. <para>
  157. Eine Zugriffskontrollliste (<acronym>ACL</acronym>) kann jeden gewünschten Satz von
  158. körperlichen oder virtuellen Objekten repräsentieren. Zu Demonstrationszwecken werden
  159. wir eine grundlegende <acronym>ACL</acronym> für ein Redaktionssystem
  160. (<acronym>CMS</acronym>) erstellen, die mehrere Schichten von Gruppen über eine
  161. Vielzahl von Bereichen verwaltet soll. Um ein <acronym>ACL</acronym>-Objekt zu
  162. erstellen, instanzieren wir die <acronym>ACL</acronym> ohne Parameter:
  163. </para>
  164. <programlisting language="php"><![CDATA[
  165. $acl = new Zend_Acl();
  166. ]]></programlisting>
  167. <note>
  168. <para>
  169. Solange der Entwickler keine "allow"-Regel spezifiziert, verweigert
  170. <classname>Zend_Acl</classname> den Zugriff auf jegliche Rechte für jede Ressource
  171. durch jede Rolle.
  172. </para>
  173. </note>
  174. </sect2>
  175. <sect2 id="zend.acl.introduction.role_registry">
  176. <title>Rollen registrieren</title>
  177. <para>
  178. <acronym>CMS</acronym> brauchen fast immer eine Hierarchie von Genehmigungen, um die
  179. Autorenfähigkeiten seiner Benutzer festzulegen. Es kann eine 'Guest'-Gruppe geben, um
  180. beschränkten Zugriff zur Demonstration zu ermöglichen, eine 'Staff'-Gruppe für die
  181. Mehrheit der <acronym>CMS</acronym> Nutzer, welche die meisten der alltäglichen
  182. Aufgaben erledigen, eine 'Editor'-Gruppe für diejenigen, die für das Veröffentlichen,
  183. Überprüfen, Archivieren und Löschen von Inhalten zuständig sind, sowie eine
  184. 'Administrator'-Gruppe, dessen Aufgaben alle der anderen Gruppen sowie die
  185. Pflege sensibler Informationen, die Benutzerverwaltung, die
  186. Backend-Konfigurationsdaten, die Datensicherung und den Export beinhalten. Diese
  187. Genehmigungen können durch eine Rollenregistrierung repräsentiert werden, die es jeder
  188. Gruppe erlaubt, die Rechte von 'übergeordneten' Gruppen zu erben sowie eindeutige
  189. Rechte nur für deren Gruppe bereit zu stellen. Diese Genehmigungen können wie folgt
  190. ausgedrückt werden:
  191. </para>
  192. <table id="zend.acl.introduction.role_registry.table.example_cms_access_controls">
  193. <title>Zugangsbeschränkung für ein Beispiel-CMS</title>
  194. <tgroup cols="3">
  195. <thead>
  196. <row>
  197. <entry>Name</entry>
  198. <entry>Eindeutige Genehmigung</entry>
  199. <entry>Erbe Genehmigungen von</entry>
  200. </row>
  201. </thead>
  202. <tbody>
  203. <row>
  204. <entry>Guest</entry>
  205. <entry>View</entry>
  206. <entry>N/A</entry>
  207. </row>
  208. <row>
  209. <entry>Staff</entry>
  210. <entry>Edit, Submit, Revise</entry>
  211. <entry>Guest</entry>
  212. </row>
  213. <row>
  214. <entry>Editor</entry>
  215. <entry>Publish, Archive, Delete</entry>
  216. <entry>Staff</entry>
  217. </row>
  218. <row>
  219. <entry>Administrator</entry>
  220. <entry>(bekommt kompletten Zugriff gewährt)</entry>
  221. <entry>N/A</entry>
  222. </row>
  223. </tbody>
  224. </tgroup>
  225. </table>
  226. <para>
  227. Für dieses Beispiel wird <classname>Zend_Acl_Role</classname> verwendet, aber jedes
  228. Objekt wird akzeptiert, das <classname>Zend_Acl_Role_Interface</classname>
  229. implementiert. Diese Gruppen können zur Rollenregistrierung wie folgt hinzugefügt
  230. werden:
  231. </para>
  232. <programlisting language="php"><![CDATA[
  233. $acl = new Zend_Acl();
  234. // Fügt Gruppen zur Rollenregistrierung hinzu unter Verwendung von Zend_Acl_Role
  235. // Gast erbt keine Zugriffsrechte
  236. $roleGuest = new Zend_Acl_Role('guest');
  237. $acl->addRole($roleGuest);
  238. // Mitarbeiter erbt von Gast
  239. $acl->addRole(new Zend_Acl_Role('staff'), $roleGuest);
  240. /*
  241. Alternativ kann das obige wie folgt geschrieben werden:
  242. $acl->addRole(new Zend_Acl_Role('staff'), 'guest');
  243. */
  244. // Redakteur erbt von Mitarbeiter
  245. $acl->addRole(new Zend_Acl_Role('editor'), 'staff');
  246. // Administrator erbt keine Zugriffsrechte
  247. $acl->addRole(new Zend_Acl_Role('administrator'));
  248. ]]></programlisting>
  249. </sect2>
  250. <sect2 id="zend.acl.introduction.defining">
  251. <title>Zugangsbeschränkung definieren</title>
  252. <para>
  253. Nun, da die <acronym>ACL</acronym> die relevanten Rollen enthält, können Regeln
  254. eingerichtet werden, die definieren, wie auf Ressourcen durch Rollen zugegriffen werden
  255. darf. Es ist zu beachten, dass wir keine bestimmten Ressourcen in diesem Beispiel
  256. definiert haben, das vereinfacht wurde, um zu illustrieren, dass die Regeln für alle
  257. Ressourcen gelten. <classname>Zend_Acl</classname> stellt eine Implementation bereit,
  258. bei der Regeln nur vom Allgemeinen zum Speziellen definiert werden müssen, um die
  259. Anzahl der benötigten Regeln zu minimieren, weil Ressourcen und Rollen die Regeln
  260. erben, die in ihren Vorfahren definiert worden sind.
  261. </para>
  262. <note>
  263. <para>
  264. Generell wendet <classname>Zend_Acl</classname> eine angegebene Regel dann und nur
  265. dann an, wenn eine speziellere Regel nicht passt.
  266. </para>
  267. </note>
  268. <para>
  269. Folglich können wir einen einigermaßen komplexen Regelsatz mit sehr wenig Code
  270. definieren. Um die grundlegenden Genehmigungen von oben anzugeben:
  271. </para>
  272. <programlisting language="php"><![CDATA[
  273. $acl = new Zend_Acl();
  274. $roleGuest = new Zend_Acl_Role('guest');
  275. $acl->addRole($roleGuest);
  276. $acl->addRole(new Zend_Acl_Role('staff'), $roleGuest);
  277. $acl->addRole(new Zend_Acl_Role('editor'), 'staff');
  278. $acl->addRole(new Zend_Acl_Role('administrator'));
  279. // Gäste dürfen Inhalte nur sehen
  280. $acl->allow($roleGuest, null, 'view');
  281. /*
  282. Alternativ kann das obige wie folgt geschrieben werden:
  283. $acl->allow('guest', null, 'view');
  284. */
  285. // Mitarbeiter erbt 'ansehen' Rechte von Gast, benötigt aber zusätzliche Rechte
  286. $acl->allow('staff', null, array('edit', 'submit', 'revise'));
  287. // Redakteuer erbt 'ansehen', 'bearbeiten', 'absenden' und die 'revidieren'
  288. // Rechte vom Mitarbeiter, benötigt aber zusätzliche Rechte
  289. $acl->allow('editor', null, array('publish', 'archive', 'delete'));
  290. // Administrator erbt gar nichts, aber erhält alle Rechte
  291. $acl->allow('administrator');
  292. ]]></programlisting>
  293. <para>
  294. Die <constant>NULL</constant>-Werte in obigen <methodname>allow()</methodname>-Aufrufen
  295. werden verwendet, um anzugeben, dass diese Regeln für alle Ressourcen gelten.
  296. </para>
  297. </sect2>
  298. <sect2 id="zend.acl.introduction.querying">
  299. <title>Abfragen einer ACL</title>
  300. <para>
  301. Wir haben nun eine flexible <acronym>ACL</acronym>, die in der gesamten Anwendung
  302. verwendet werden kann, um zu ermitteln, ob Anfragende die Genehmigung haben, Funktionen
  303. auszuführen. Abfragen durchzuführen ist recht einfach mit Hilfe der
  304. <methodname>isAllowed()</methodname>-Methode:
  305. </para>
  306. <programlisting language="php"><![CDATA[
  307. echo $acl->isAllowed('guest', null, 'view') ?
  308. "allowed" : "denied";
  309. // erlaubt
  310. echo $acl->isAllowed('staff', null, 'publish') ?
  311. "allowed" : "denied";
  312. // verweigert
  313. echo $acl->isAllowed('staff', null, 'revise') ?
  314. "allowed" : "denied";
  315. // erlaubt
  316. echo $acl->isAllowed('editor', null, 'view') ?
  317. "allowed" : "denied";
  318. // erlaubt wegen der Vererbung von Gast
  319. echo $acl->isAllowed('editor', null, 'update') ?
  320. "allowed" : "denied";
  321. // verweigert, weil es keine erlaubte Regel für 'update' gibt
  322. echo $acl->isAllowed('administrator', null, 'view') ?
  323. "allowed" : "denied";
  324. // erlaubt, weil Administrator alle Rechte haben
  325. echo $acl->isAllowed('administrator') ?
  326. "allowed" : "denied";
  327. // erlaubt, weil Administrator alle Rechte haben
  328. echo $acl->isAllowed('administrator', null, 'update') ?
  329. "allowed" : "denied";
  330. // erlaubt, weil Administrator alle Rechte haben
  331. ]]></programlisting>
  332. </sect2>
  333. </sect1>