Zend_Auth_Adapter_Http.xml 11 KB

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