Zend_Auth_Adapter_Http.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 15617 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.auth.adapter.http">
  5. <title>Adaptateur d'authentification HTTP</title>
  6. <sect2 id="zend.auth.adapter.http.introduction">
  7. <title>Introduction</title>
  8. <para>
  9. <classname>Zend_Auth_Adapter_Http</classname> fournit une implémentation des
  10. authentifications HTTP
  11. <ulink url="http://en.wikipedia.org/wiki/Basic_authentication_scheme">Basic</ulink>et
  12. <ulink url="http://en.wikipedia.org/wiki/Digest_access_authentication">Digest</ulink>,
  13. au regard de la norme
  14. <ulink url="http://tools.ietf.org/html/rfc2617">RFC-2617</ulink>. Digest est une
  15. méthode d'authentification HTTP basée sur Basic, mais qui augmente la sécurité en
  16. fournissant un moyen d'authentification sans transmettre le mot de passe en clair, sur
  17. le réseau.
  18. </para>
  19. <para>
  20. <emphasis>Caractéristiques principales&#160;:</emphasis>
  21. <itemizedlist>
  22. <listitem>
  23. <para>Support des méthodes Basic et Digest&#160;;</para>
  24. </listitem>
  25. <listitem>
  26. <para>
  27. Propose tous les des schémas de challenge, le client peut répondre avec
  28. le schéma qu'il supporte&#160;;
  29. </para>
  30. </listitem>
  31. <listitem>
  32. <para>Support de l'authentification Proxy&#160;;</para>
  33. </listitem>
  34. <listitem>
  35. <para>
  36. Inclus le support d'authentification de type fichier, et fournit une
  37. interface pour créer son propre support, comme une base de données.
  38. </para>
  39. </listitem>
  40. </itemizedlist>
  41. </para>
  42. <para>
  43. Il y a quelques caractéristiques de la RFC-2617 qui ne sont pas encore
  44. supportées&#160;:
  45. <itemizedlist>
  46. <listitem>
  47. <para>
  48. Le "Nonce tracking", mécanisme qui évite les attaques par
  49. répétitions&#160;;
  50. </para>
  51. </listitem>
  52. <listitem>
  53. <para>Authentification avec vérification d'intégrité ("auth-int")&#160;;</para>
  54. </listitem>
  55. <listitem>
  56. <para>En-tête HTTP "Authentication-Info".</para>
  57. </listitem>
  58. </itemizedlist>
  59. </para>
  60. </sect2>
  61. <sect2 id="zend.auth.adapter.design_overview">
  62. <title>Fonctionnement</title>
  63. <para>
  64. Cette adaptateur utilise 2 sous-composants, la classe d'authentification HTTP
  65. elle-même et des "Résolveurs." La classe d'authentification HTTP encapsule la logique
  66. de commande des authentifications Basic et Digest. Elle utilise aussi un résolveur pour
  67. chercher les identifiants sur un disque (fichier texte par défaut), et les analyser.
  68. Ils sont alors comparés aux valeurs envoyées par le client pour déterminer une
  69. éventuelle correspondance.
  70. </para>
  71. </sect2>
  72. <sect2 id="zend.auth.adapter.configuration_options">
  73. <title>Options de configuration</title>
  74. <para>
  75. La classe <classname>Zend_Auth_Adapter_Http</classname> requière un tableau de
  76. configuration lors de sa construction. Il y a plusieurs options de configuration
  77. disponibles, dont certaines requises&#160;:
  78. <table id="zend.auth.adapter.configuration_options.table">
  79. <title>Liste des options de configuration</title>
  80. <tgroup cols="3">
  81. <thead>
  82. <row>
  83. <entry>Nom</entry>
  84. <entry>Requise (?)</entry>
  85. <entry>Description</entry>
  86. </row>
  87. </thead>
  88. <tbody>
  89. <row>
  90. <entry><code>accept_schemes</code></entry>
  91. <entry>Oui</entry>
  92. <entry>
  93. Détermine les schémas d'authentification que l'adaptateur va
  94. accepter du client. Ce doit être une liste séparée par des espaces,
  95. contenant <code>'basic'</code> et/ou <code>'digest'</code>.
  96. </entry>
  97. </row>
  98. <row>
  99. <entry><code>realm</code></entry>
  100. <entry>Oui</entry>
  101. <entry>
  102. Fournit le nom de l'authentification (<code>realm</code>)&#160;;
  103. chaque nom d'utilisateur doit être unique, par nom
  104. d'authentification.
  105. </entry>
  106. </row>
  107. <row>
  108. <entry><code>digest_domains</code></entry>
  109. <entry>
  110. Oui lorsque<code> "accept_schemes"</code> contient
  111. <code>"digest"</code>
  112. </entry>
  113. <entry>
  114. Liste d'URI, séparées d'espace, pour lesquelles la même information
  115. d'authentification est valide. Elles peuvent pointer vers
  116. différents serveurs.
  117. </entry>
  118. </row>
  119. <row>
  120. <entry><code>nonce_timeout</code></entry>
  121. <entry>
  122. Oui lorsque <code>"accept_schemes"</code> contient
  123. <code>"digest"</code>
  124. </entry>
  125. <entry>
  126. Nombre de seconde pour la validité du jeton d'authentification.
  127. Voyez les notes ci-dessous.
  128. </entry>
  129. </row>
  130. <row>
  131. <entry><code>proxy_auth</code></entry>
  132. <entry>Non</entry>
  133. <entry>
  134. Désactivé par défaut. Activez le pour effectuer une
  135. authentification via un Proxy.
  136. </entry>
  137. </row>
  138. </tbody>
  139. </tgroup>
  140. </table>
  141. </para>
  142. <note>
  143. <para>
  144. L'implémentation actuelle du <code>nonce_timeout</code> a des effets
  145. intéressants. Ce paramètre doit déterminer le temps de validité d'un jeton,
  146. autrement dit : le temps d'acceptation d'un client. Par exemple, une valeur de 3600
  147. aura pour effet de commander à l'adaptateur le rappel des informations
  148. d'identification du client, toutes les heures. Ce comportement sera changé lorsque
  149. le paramètre "nonce tracking" sera supporté.
  150. </para>
  151. </note>
  152. </sect2>
  153. <sect2 id="zend.auth.adapter.http.resolvers">
  154. <title>Résolveurs</title>
  155. <para>
  156. Le travail du résolveur consiste à récupérer un nom d'utilisateur
  157. (<code>username</code>) et un nom d'authentification (<code>realm</code>) et retourner
  158. des identifiants. L'authentification Basic s'attend à recevoir une version encodée
  159. Base64 du mot de passe (<code>password</code>). L'authentification Digest, elle, attend
  160. un hash du <code>username</code>, du <code>realm</code>, et du <code>password</code>
  161. (séparés par des deux-points). Actuellement le seul algorithme de hash supporté est
  162. MD5.
  163. </para>
  164. <para>
  165. <classname>Zend_Auth_Adapter_Http</classname> se fie a des objets implémentant
  166. <classname>Zend_Auth_Adapter_Http_Resolver_Interface</classname>. Une classe de
  167. résolution de fichier texte est inclue avec cet adaptateur, mais n'importe quelle
  168. classe peut être écrite, grâce à l'interface.
  169. </para>
  170. <sect3 id="zend.auth.adapter.http.resolvers.file">
  171. <title>Résolveur fichiers</title>
  172. <para>
  173. Cette classe est très simple. Son constructeur ne prend qu'un paramètre qui
  174. définit le nom du fichier cible. Un accesseur existe aussi. Sa méthode
  175. <code>resolve()</code> traverse le fichier texte à la recherche de la ligne qui
  176. correspond au <code>username</code> et au <code>realm</code>. La syntaxe est
  177. similaire aux fichiers <code>htpasswd</code> d'Apache&#160;:
  178. <programlisting><![CDATA[
  179. <username>:<realm>:<credentials>\n
  180. ]]></programlisting>
  181. Chaque ligne se décompose en 3 champs - <code>username</code>, <code>realm</code>,
  182. et <code>credentials</code> - séparés par des deux-points. Le résolveur ne fait que
  183. retourner la valeur de "<code>credentials</code>". Ainsi, avec Basic cette valeur
  184. devra être le mot de passe en clair de l'utilisateur identifié par
  185. <code>username</code>. En mode Digest, la valeur MD5 de toute la chaîne
  186. <code>username:realm:password</code> (avec les deux-points).
  187. </para>
  188. <para>
  189. Pour créer des résolveurs de fichiers séparés, utilisez&#160;:
  190. <programlisting language="php"><![CDATA[
  191. $path = 'files/passwd.txt';
  192. $resolver = new Zend_Auth_Adapter_Http_Resolver_File($path);
  193. ]]></programlisting>
  194. ou
  195. <programlisting language="php"><![CDATA[
  196. $path = 'files/passwd.txt';
  197. $resolver = new Zend_Auth_Adapter_Http_Resolver_File();
  198. $resolver->setFile($path);
  199. ]]></programlisting>
  200. Si le chemin donné n'est pas lisible, une exception est envoyée.
  201. </para>
  202. </sect3>
  203. </sect2>
  204. <sect2 id="zend.auth.adapter.http.basic_usage">
  205. <title>Usage général&#160;:</title>
  206. <para>
  207. Tout d'abord, créez un tableau de configuration avec les options requises&#160;:
  208. <programlisting language="php"><![CDATA[
  209. $config = array(
  210. 'accept_schemes' => 'basic digest',
  211. 'realm' => 'My Web Site',
  212. 'digest_domains' => '/members_only /my_account',
  213. 'nonce_timeout' => 3600,
  214. );
  215. ]]></programlisting>
  216. Ce tableau va permettre d'accepter les modes Basic ou Digest et demandera une
  217. authentification pour les zones du site situées sous <code>/members_only</code> et
  218. <code>/my_account</code>. La valeur du <code>realm</code> est en général affichée par
  219. le navigateur dans la boite de dialogue. Le paramètre <code>nonce_timeout</code>,
  220. fonctionne comme expliqué plus haut.
  221. </para>
  222. <para>
  223. Ensuite, créez un objet de <classname>Zend_Auth_Adapter_Http</classname>&#160;:
  224. <programlisting language="php"><![CDATA[
  225. $adapter = new Zend_Auth_Adapter_Http($config);
  226. ]]></programlisting>
  227. </para>
  228. <para>
  229. Comme nous supportons les 2 modes Basic et Digest, nous avons besoin de deux
  230. résolveurs différents&#160;:
  231. <programlisting language="php"><![CDATA[
  232. $basicResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  233. $basicResolver->setFile('files/basicPasswd.txt');
  234. $digestResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  235. $digestResolver->setFile('files/digestPasswd.txt');
  236. $adapter->setBasicResolver($basicResolver);
  237. $adapter->setDigestResolver($digestResolver);
  238. ]]></programlisting>
  239. </para>
  240. <para>
  241. Enfin, nous procédons à la demande d'authentification. L'adaptateur a besoin de
  242. deux objets <code>Request</code> et <code>Response</code>&#160;:
  243. <programlisting language="php"><![CDATA[
  244. assert($request instanceof Zend_Controller_Request_Http);
  245. assert($response instanceof Zend_Controller_Response_Http);
  246. $adapter->setRequest($request);
  247. $adapter->setResponse($response);
  248. $result = $adapter->authenticate();
  249. if (!$result->isValid()) {
  250. // Mauvais username/password, ou action annulée
  251. }
  252. ]]></programlisting>
  253. </para>
  254. </sect2>
  255. </sect1>