Zend_Acl.xml 17 KB

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