Zend_Auth_Adapter_Http.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  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 welche die Basis Authentifizierung erweitert
  15. indem ein Weg angeboten wird um sich zu Authentifizieren ohne dass das Passwort im
  16. Klartext ü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 Proxy 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 <acronym>RFC-2617</acronym> die bis jetzt
  48. nicht implementiert 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><property>accept_schemes</property></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><property>realm</property></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><property>digest_domains</property></emphasis></entry>
  120. <entry>
  121. Ja, wenn <property>accept_schemes</property>
  122. <emphasis>digest</emphasis> enthält
  123. </entry>
  124. <entry>
  125. Leerzeichen-getrennte Liste von <acronym>URI</acronym>s für welche die
  126. gleichen Authentifizierungs Informationen gültig sind. Die
  127. <acronym>URI</acronym>s müssen nicht alle auf den gleichen Server
  128. zeigen.
  129. </entry>
  130. </row>
  131. <row>
  132. <entry><emphasis><property>nonce_timeout</property></emphasis></entry>
  133. <entry>
  134. Ja, wenn <property>accept_schemes</property>
  135. <emphasis>digest</emphasis> enthält
  136. </entry>
  137. <entry>
  138. Setzt die Anzahl an Sekunden für welche die Verfolgung gültig ist.
  139. Siehe die Notizen anbei.
  140. </entry>
  141. </row>
  142. <row>
  143. <entry><emphasis><property>proxy_auth</property></emphasis></entry>
  144. <entry>Nein</entry>
  145. <entry>
  146. Standardmäßig ausgeschaltet. Einschalten um Proxi Authentifizierung
  147. durchzuführen statt normaler originaler Server Authentifizierung.
  148. </entry>
  149. </row>
  150. </tbody>
  151. </tgroup>
  152. </table>
  153. <note>
  154. <para>
  155. Die aktuelle Implementation von <property>nonce_timeout</property> hat einige
  156. interessante Nebeneffekte. Diese Einstellung soll die gültige Lebenszeit einer
  157. gegebenen Verfolgung ermitteln, oder effektiv, wie lange die Authentifizierungs
  158. Information eines Klienten akzeptiert wird. Aktuell ist es auf 3600 (zum Beispiel)
  159. gesetzt, und führt dazu das der Klient jede Stunde um neue Zeugnisse gebeten wird.
  160. Das wird in einem zukünftigen Release behoben werden, sobald Verfolgung und "stale"
  161. Support implementiert werden.
  162. </para>
  163. </note>
  164. </sect2>
  165. <sect2 id="zend.auth.adapter.http.resolvers">
  166. <title>Auflöser</title>
  167. <para>
  168. Der Job des Auflösers ist es einen Benutzernamen und einen Bereich, und gibt eine Art
  169. von Zeugnisswert zurück. Basis Authentifizierung erwartet einen Hash des Benutzernamens,
  170. des Bereichs, und dessen Passwörter (jedes seperiert durch ein Komma). Aktuell ist der
  171. einzige unterstützte Hash Algorithmus <acronym>MD5</acronym>.
  172. </para>
  173. <para>
  174. <classname>Zend_Auth_Adapter_Http</classname> ist darauf angewiesen das Objekte
  175. <classname>Zend_Auth_Adapter_Http_Resolver_Interface</classname> implementieren. Eine
  176. Textdatei Auflöser Klasse ist mit diesem Adapter inkludiert, aber jede Art von Auflöser
  177. kann einfach erstellt werden indem das Resolver Interface implementiert wird.
  178. </para>
  179. <sect3 id="zend.auth.adapter.http.resolvers.file">
  180. <title>Datei Auflöser</title>
  181. <para>
  182. Der Datei Auflöser ist eine sehr einfache Klasse. Sie hat eine einzelne Eigenschaft
  183. die einen Dateinamen spezifiziert, welcher auch dem Konstruktor übergeben werden
  184. kann. Ihre <methodname>resolve()</methodname> Methode geht durch die Textdatei, und
  185. sucht nach einer Zeile mit einem entsprechenden Benutzernamen und Bereich. Das
  186. Format der Textdatei ist ähnlich dem von Apache htpasswd Dateien:
  187. </para>
  188. <programlisting language="txt"><![CDATA[
  189. <benutzername>:<bereich>:<zeugnisse>\n
  190. ]]></programlisting>
  191. <para>
  192. Jede Zeile besteht aus drei Feldern - Benutzername, Bereich und Zeugnisse - jede
  193. abgeteilt durch einen Doppelpunkt. Das Zeugnis Feld ist für den Datei Auflöser nicht
  194. sichtbar; es gibt den Wert einfach, wie er ist, an den Aufrufer zurück. Deswegen
  195. kann dieses Dateiformat sowohl Basis als auch Digest Authentifizierung behandeln. In
  196. der Basis Authentifizierung sollte das Zeugnis Feld im Klartext stehen. In der
  197. Digest Authentifizierung sollte es der oben beschriebene <acronym>MD5</acronym> Hash
  198. sein.
  199. </para>
  200. <para>
  201. Es gibt zwei gleiche einfache Wege um einen Datei Auflöser zu erstellen:
  202. </para>
  203. <programlisting language="php"><![CDATA[
  204. $path = 'files/passwd.txt';
  205. $resolver = new Zend_Auth_Adapter_Http_Resolver_File($path);
  206. ]]></programlisting>
  207. <para>
  208. oder
  209. </para>
  210. <programlisting language="php"><![CDATA[
  211. $path = 'files/passwd.txt';
  212. $resolver = new Zend_Auth_Adapter_Http_Resolver_File();
  213. $resolver->setFile($path);
  214. ]]></programlisting>
  215. <para>
  216. Wenn der angegebene Pfad leer oder nicht lesbar ist, wird eine Ausnahme geworfen.
  217. </para>
  218. </sect3>
  219. </sect2>
  220. <sect2 id="zend.auth.adapter.http.basic_usage">
  221. <title>Grundsätzliche Verwendung</title>
  222. <para>
  223. Zuerst muß ein Array mit den benötigen Konfigurationswerten gesetzt werden:
  224. </para>
  225. <programlisting language="php"><![CDATA[
  226. $config = array(
  227. 'accept_schemes' => 'basic digest',
  228. 'realm' => 'My Web Site',
  229. 'digest_domains' => '/members_only /my_account',
  230. 'nonce_timeout' => 3600,
  231. );
  232. ]]></programlisting>
  233. <para>
  234. Dieses Array bringt den Adapter dazu entwedet Basis oder Digest Authentifizierung zu
  235. akzeptieren, und benötigt einen authentifizierten Zugriff auf alle Areale der Site
  236. unter <filename>/members_only</filename> und <filename>/my_account</filename>. Der
  237. Bereichs Wert wird normalerweise durch den Browser in der Passwort Dialog Box
  238. angezeigt. <property>nonce_timeout</property> verhält sich natürlich so wie oben
  239. beschrieben.
  240. </para>
  241. <para>
  242. Dann wird ein <classname>Zend_Auth_Adapter_Http</classname> Objekt erstellt:
  243. </para>
  244. <programlisting language="php"><![CDATA[
  245. $adapter = new Zend_Auth_Adapter_Http($config);
  246. ]]></programlisting>
  247. <para>
  248. Da beides, Basis und Digest Authentifizierung, unterstützt werden, werden zwei
  249. unterschiedliche Auflösungs-Objekte benötigt. Man könnte das auch einfach durch die
  250. Verwendung von zwei unterschiedlichen Klassen bewerkstelligen:
  251. </para>
  252. <programlisting language="php"><![CDATA[
  253. $basicResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  254. $basicResolver->setFile('files/basicPasswd.txt');
  255. $digestResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  256. $digestResolver->setFile('files/digestPasswd.txt');
  257. $adapter->setBasicResolver($basicResolver);
  258. $adapter->setDigestResolver($digestResolver);
  259. ]]></programlisting>
  260. <para>
  261. Letztendlich führen wir die Authentifizierung durch. Der Adapter benötigt eine Referenz
  262. zu beidem, dem Anfrage und Antwort Objekten um seinen Job durchführen zu können:
  263. </para>
  264. <programlisting language="php"><![CDATA[
  265. assert($request instanceof Zend_Controller_Request_Http);
  266. assert($response instanceof Zend_Controller_Response_Http);
  267. $adapter->setRequest($request);
  268. $adapter->setResponse($response);
  269. $result = $adapter->authenticate();
  270. if (!$result->isValid()) {
  271. // Schlechter Benutzername/Passwort, oder abgebrochener Passwort Prompt
  272. }
  273. ]]></programlisting>
  274. </sect2>
  275. </sect1>