Zend_Acl.xml 17 KB

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