Zend_Auth_Adapter_Http.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.auth.adapter.http">
  5. <title>HTTP Authentication Adapter</title>
  6. <sect2 id="zend.auth.adapter.http.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Auth_Adapter_Http</classname> bietet die am meisten entsprechende Implementation von
  10. <ulink url="http://tools.ietf.org/html/rfc2617">RFC-2617</ulink>,
  11. <ulink url="http://en.wikipedia.org/wiki/Basic_authentication_scheme">Basis</ulink> und
  12. <ulink url="http://en.wikipedia.org/wiki/Digest_access_authentication">Digest</ulink> HTTP
  13. Authentifizierung. Digest Authentifizierung ist eine Methode der HTTP Authentifikation die die
  14. Basis Authentifizierung erweitert indem ein Weg angeboten wird um sich zu authentifizieren ohne
  15. das das Passwort im Klartext über das netzwerk geschickt werden muß.
  16. </para>
  17. <para>
  18. <emphasis role="strong">Hauptsächliche Features:</emphasis>
  19. <itemizedlist>
  20. <listitem>
  21. <para>
  22. Unterstützt sowohl Basis als auch Digest Authentifizierung.
  23. </para>
  24. </listitem>
  25. <listitem>
  26. <para>
  27. Enthält Aufrufe für alle unterstützten Schemas, damit Klienten mit jedem unterstützten
  28. Schema arbeiten können.
  29. </para>
  30. </listitem>
  31. <listitem>
  32. <para>
  33. Bietet Proxi Authentifizierung.
  34. </para>
  35. </listitem>
  36. <listitem>
  37. <para>
  38. Enthält Unterstützung für die Authentifizierung gegenüber Textdateien und bietet ein
  39. Interface für die Authentifizierung gegenüber anderen Quellen, wie z.B. Datenbanken.
  40. </para>
  41. </listitem>
  42. </itemizedlist>
  43. </para>
  44. <para>
  45. Es gibt ein paar nennenswerte Features von RFC-2617 die bis jetzt nicht implementiert wurden:
  46. <itemizedlist>
  47. <listitem>
  48. <para>
  49. Einstweilige Verfolgung, welche "stale" Support erlaubt und die Unterstützung bei
  50. wiederholenden Attacken erhöht.
  51. </para>
  52. </listitem>
  53. <listitem>
  54. <para>
  55. Authentifizierung mit Integritäts-Prüfung, oder "auth-int".
  56. </para>
  57. </listitem>
  58. <listitem>
  59. <para>
  60. Authentifizierungs-Info HTTP Header.
  61. </para>
  62. </listitem>
  63. </itemizedlist>
  64. </para>
  65. </sect2>
  66. <sect2 id="zend.auth.adapter.design_overview">
  67. <title>Design Übersicht</title>
  68. <para>
  69. Dieser Adapter besteht aus zwei Sub-Komponenten, die HTTP Authentifizierungs Klasse selbst, und
  70. den sogenannten "Auflöser". Die HTTP Authentifizierungs Klasse kapselt die Logik für die Ausführung
  71. beider, sowohl der Basis als auch der Digest Authentifizierung. Sie verwendet einen Auflöser um
  72. die Identität eines Klienten in Datenspeichern nachzusehen (standardmäßig eine Textdatei),
  73. und die Zeugnisse vom Datenspeicher zu empfangen. Die "aufgelösten" Zeugnisse werden dann
  74. mit den Werten verglichen die vom Klienten übermittelt wurden um zu eruieren ob die Authentifizierung
  75. erfolgreich war.
  76. </para>
  77. </sect2>
  78. <sect2 id="zend.auth.adapter.configuration_options">
  79. <title>Konfigurations Optionen</title>
  80. <para>
  81. Die <classname>Zend_Auth_Adapter_Http</classname> Klasse benötigt ein Konfigurations Array das Ihrem
  82. Konstruktor übergeben werden muß. Es sind verschiedene Konfigurations Optionen vorhanden, und einige
  83. davon werden benötigt:
  84. <table id="zend.auth.adapter.configuration_options.table">
  85. <title>Konfigurations Optionen</title>
  86. <tgroup cols="3">
  87. <thead>
  88. <row>
  89. <entry>Options Name</entry>
  90. <entry>Benötigt</entry>
  91. <entry>Beschreibung</entry>
  92. </row>
  93. </thead>
  94. <tbody>
  95. <row>
  96. <entry><code>accept_schemes</code></entry>
  97. <entry>Ja</entry>
  98. <entry>
  99. Ermittelt welches Authentifizierungs Schema der Adapter vom Klienten akzeptiert.
  100. Muß eine Leerzeichen-getrennte Liste sein, die <code>'basic'</code> und/oder
  101. <code>'digest'</code> enthält.
  102. </entry>
  103. </row>
  104. <row>
  105. <entry><code>realm</code></entry>
  106. <entry>Ja</entry>
  107. <entry>
  108. Setzt das Authentifizierungs-Bereich; Benutzernamen sollten im angegebenen
  109. Bereich einmalig sein.
  110. </entry>
  111. </row>
  112. <row>
  113. <entry><code>digest_domains</code></entry>
  114. <entry>Ja, wenn <code>'accept_schemes'</code> <code>'digest'</code> enthält</entry>
  115. <entry>
  116. Leerzeichen-getrennte Liste von URIs für die die gleichen Authentifizierungs
  117. Informationen gültig sind. Die URIs müssen nicht alle auf den gleichen Server
  118. zeigen.
  119. </entry>
  120. </row>
  121. <row>
  122. <entry><code>nonce_timeout</code></entry>
  123. <entry>Ja, wenn <code>'accept_schemes'</code> <code>'digest'</code> enthält</entry>
  124. <entry>
  125. Setzt die Anzahl an Sekunden für die die Verfolgung gültig ist. Siehe
  126. die Notizen anbei.
  127. </entry>
  128. </row>
  129. <row>
  130. <entry><code>proxy_auth</code></entry>
  131. <entry>Nein</entry>
  132. <entry>
  133. Standardmäßig ausgeschaltet. Einschalten um Proxi Authentifizierung durchzuführen
  134. statt normaler originaler Server Authentifizierung.
  135. </entry>
  136. </row>
  137. </tbody>
  138. </tgroup>
  139. </table>
  140. </para>
  141. <note>
  142. <para>
  143. Die aktuelle Implementation von <code>nonce_timeout</code> hat einige interessante Nebeneffekte.
  144. Diese Einstellung soll die gültige Lebenszeit einer gegebenen Verfolgung ermitteln, oder
  145. effektiv, wie lange die Authentifizierungs Information eines Klienten akzeptiert wird. Aktuell
  146. ist es auf 3600 (zum Beispiel) gesetzt, und führt dazu das der Klient jede Stunde um neue
  147. Zeugnisse gebeten wird. Das wird in einem zukünftigen Release behoben werden, sobald
  148. Verfolgung und "stale" Support implementiert werden.
  149. </para>
  150. </note>
  151. </sect2>
  152. <sect2 id="zend.auth.adapter.http.resolvers">
  153. <title>Auflöser</title>
  154. <para>
  155. Der Job des Auflösers ist es einen Benutzernamen und einen Bereich, und gibt eine Art von
  156. Zeugnisswert zurück. Basis Authentifizierung erwartet einen Hash des Benutzernamens, des Bereichs,
  157. und dessen Passwörter (jedes seperiert durch ein Komma). Aktuell ist der einzige unterstützte
  158. Hash Algorithmus MD5.
  159. </para>
  160. <para>
  161. <classname>Zend_Auth_Adapter_Http</classname> ist darauf angewiesen das Objekte
  162. <classname>Zend_Auth_Adapter_Http_Resolver_Interface</classname> implementieren. Eine Textdatei Auflöser Klasse
  163. ist mit diesem Adapter inkludiert, aber jede Art von Auflöser kann einfach erstellt werden indem
  164. das Resolver Interface implementiert wird.
  165. </para>
  166. <sect3 id="zend.auth.adapter.http.resolvers.file">
  167. <title>Datei Auflöser</title>
  168. <para>
  169. Der Datei Auflöser ist eine sehr einfache Klasse. Sie hat eine einzelne Eigenschaft die einen
  170. Dateinamen spezifiziert, welcher auch dem Konstruktor übergeben werden kann. Ihre
  171. <code>resolve()</code> Methode geht durch die Textdatei, und sucht nach einer Zeile mit einem
  172. entsprechenden Benutzernamen und Bereich. Das Format der Textdatei ist ähnlich dem von Apache
  173. htpasswd Dateien:
  174. <programlisting><![CDATA[
  175. <benutzername>:<bereich>:<zeugnisse>\n
  176. ]]>
  177. </programlisting>
  178. Jede Zeile besteht aus drei Feldern - Benutzername, Bereich und Zeugnisse - jede abgeteilt
  179. durch einen Doppelpunkt. Das Zeugnis Feld ist für den Datei Auflöser nicht sichtbar; es gibt
  180. den Wert einfach, wie er ist, an den Aufrufer zurück. Deswegen kann dieses Dateiformat sowohl
  181. Basis als auch Digest Authentifizierung behandeln. In der Basis Authentifizierung sollte
  182. das Zeugnis Feld im Klartext stehen. In der Digest Authentifizierung
  183. sollte es der oben beschriebene MD5 Hash sein.
  184. </para>
  185. <para>
  186. Es gibt zwei gleiche einfache Wege um einen Datei Auflöser zu erstellen:
  187. <programlisting role="php"><![CDATA[
  188. $path = 'files/passwd.txt';
  189. $resolver = new Zend_Auth_Adapter_Http_Resolver_File($path);
  190. ]]></programlisting>
  191. oder
  192. <programlisting role="php"><![CDATA[
  193. $path = 'files/passwd.txt';
  194. $resolver = new Zend_Auth_Adapter_Http_Resolver_File();
  195. $resolver->setFile($path);
  196. ]]></programlisting>
  197. Wenn der angegebene Pfad leer oder nicht lesbar ist, wird eine Ausnahme geworfen.
  198. </para>
  199. </sect3>
  200. </sect2>
  201. <sect2 id="zend.auth.adapter.http.basic_usage">
  202. <title>Grundsätzliche Verwendung</title>
  203. <para>
  204. Zuerst muß ein Array mit den benötigen Konfigurationswerten gesetzt werden:
  205. <programlisting role="php"><![CDATA[
  206. $config = array(
  207. 'accept_schemes' => 'basic digest',
  208. 'realm' => 'My Web Site',
  209. 'digest_domains' => '/members_only /my_account',
  210. 'nonce_timeout' => 3600,
  211. );
  212. ]]></programlisting>
  213. Dieses Array bringt den Adapter dazu entwedet Basis oder Digest Authentifizierung zu akzeptieren,
  214. und benötigt einen authentifizierten Zugriff auf alle Areale der Site unter <code>/members_only</code>
  215. und <code>/my_account</code>. Der Bereichs Wert wird normalerweise durch den Browser in der
  216. Passwort Dialog Box angezeigt. <code>nonce_timeout</code> verhält sich natürlich so wie oben
  217. beschrieben.
  218. </para>
  219. <para>
  220. Dann wird ein Zend_Auth_Adapter_Http Objekt erstellt:
  221. <programlisting role="php"><![CDATA[
  222. $adapter = new Zend_Auth_Adapter_Http($config);
  223. ]]></programlisting>
  224. </para>
  225. <para>
  226. Da beides, Basis und Digest Authentifizierung, unterstützt werden, werden zwei unterschiedliche
  227. Auflösungs-Objekte benötigt. Man könnte das auch einfach durch die Verwendung von zwei
  228. unterschiedlichen Klassen bewerkstelligen:
  229. <programlisting role="php"><![CDATA[
  230. $basicResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  231. $basicResolver->setFile('files/basicPasswd.txt');
  232. $digestResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  233. $digestResolver->setFile('files/digestPasswd.txt');
  234. $adapter->setBasicResolver($basicResolver);
  235. $adapter->setDigestResolver($digestResolver);
  236. ]]></programlisting>
  237. </para>
  238. <para>
  239. Letztendlich führen wir die Authentifizierung durch. Der Adapter benötigt eine Referenz zu beidem,
  240. dem Anfrage und Antwort Objekten um seinen Job durchführen zu können:
  241. <programlisting role="php"><![CDATA[
  242. assert($request instanceof Zend_Controller_Request_Http);
  243. assert($response instanceof Zend_Controller_Response_Http);
  244. $adapter->setRequest($request);
  245. $adapter->setResponse($response);
  246. $result = $adapter->authenticate();
  247. if (!$result->isValid()) {
  248. // Schlechter Benutzername/Passwort, oder abgebrochener Passwort Prompt
  249. }
  250. ]]></programlisting>
  251. </para>
  252. </sect2>
  253. </sect1>
  254. <!--
  255. vim:se ts=4 sw=4 et:
  256. -->