Zend_Auth_Adapter_Http.xml 13 KB

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