Zend_Auth_Adapter_Http.xml 13 KB

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