Zend_Auth_Adapter_Http.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.auth.adapter.http">
  4. <title>Adaptador de Autenticación HTTP</title>
  5. <sect2 id="zend.auth.adapter.http.introduction">
  6. <title>Introducción</title>
  7. <para>
  8. <classname>Zend_Auth_Adapter_Http</classname> proporciona una implementación compatible con
  9. <ulink url="http://tools.ietf.org/html/rfc2617">RFC-2617</ulink>,
  10. <ulink url="http://en.wikipedia.org/wiki/Basic_authentication_scheme">Basic</ulink> y
  11. <ulink url="http://en.wikipedia.org/wiki/Digest_access_authentication">Digest</ulink> Autenticación HTTP.
  12. La autenticación "Digest" es un método de autenticación HTTP que mejora la autenticación básica proporcionando
  13. una manera de autenticar sin tener que transmitir la contraseña de manera clara en un texto a través de la red.
  14. </para>
  15. <para>
  16. <emphasis role="strong">Características Principales:</emphasis>
  17. <itemizedlist>
  18. <listitem>
  19. <para>
  20. Soporta tanto Autenticación "Digest" como Básica.
  21. </para>
  22. </listitem>
  23. <listitem>
  24. <para>
  25. Establece retos en todos los proyectos soportados, por lo que el cliente puede responder con cualquier
  26. proyecto que soporte.
  27. </para>
  28. </listitem>
  29. <listitem>
  30. <para>
  31. Soporta autenticación proxy.
  32. </para>
  33. </listitem>
  34. <listitem>
  35. <para>
  36. Incluye soporte para la autenticación contra archivos de texto y proporciona una interfaz para
  37. autenticar contra otras fuentes, tales como bases de datos.
  38. </para>
  39. </listitem>
  40. </itemizedlist>
  41. </para>
  42. <para>
  43. Hay algunas características notables del RFC-2617 no implementadas todavía:
  44. <itemizedlist>
  45. <listitem>
  46. <para>
  47. Seguimiento "nonce", que permitiría un gran apoyo, y un aumento de la protección de repetidos
  48. ataques.
  49. </para>
  50. </listitem>
  51. <listitem>
  52. <para>
  53. Autenticación con comprobación de integridad, o "auth-int".
  54. </para>
  55. </listitem>
  56. <listitem>
  57. <para>
  58. Cabecera de información de la autenticación HTTP.
  59. </para>
  60. </listitem>
  61. </itemizedlist>
  62. </para>
  63. </sect2>
  64. <sect2 id="zend.auth.adapter.design_overview">
  65. <title>Descripción del diseño</title>
  66. <para>
  67. Este adaptador consiste en dos sub-componentes, la propia clase autenticación HTTP, y el llamado "Resolvers".
  68. La clase autenticación HTTP encapsula la lógica para llevar a cabo tanto la autenticación basica y la "Digest".
  69. Utiliza un Resolver para buscar la identidad de un cliente en los datos almacenados (por defecto, archivos de texto),
  70. y recuperar las credenciales de los datos almacenados. Las credenciales del "Resolved" se comparan con los valores
  71. presentados por el cliente para determinar si la autenticación es satisfactoria.
  72. </para>
  73. </sect2>
  74. <sect2 id="zend.auth.adapter.configuration_options">
  75. <title>Opciones de Configuración</title>
  76. <para>
  77. La clase <classname>Zend_Auth_Adapter_Http</classname> requiere un array configurado que pasará a su constructor.
  78. Hay varias opciones de configuración disponibles, y algunas son obligatorias:
  79. <table id="zend.auth.adapter.configuration_options.table">
  80. <title>Opciones de Configuración</title>
  81. <tgroup cols="3">
  82. <thead>
  83. <row>
  84. <entry>Nombre de Opción</entry>
  85. <entry>Obligatoria</entry>
  86. <entry>Descripción</entry>
  87. </row>
  88. </thead>
  89. <tbody>
  90. <row>
  91. <entry><code>accept_schemes</code></entry>
  92. <entry>Si</entry>
  93. <entry>
  94. Determina que tareas de autenticación acepta el adaptador del cliente.
  95. Debe ser una lista separada por espacios que contengo <code>'basic'</code> y/o <code>'digest'</code>.
  96. </entry>
  97. </row>
  98. <row>
  99. <entry><code>realm</code></entry>
  100. <entry>Si</entry>
  101. <entry>
  102. Establece el realm de autenticación; usernames debe ser único dentro de un determinado realm.
  103. </entry>
  104. </row>
  105. <row>
  106. <entry><code>digest_domains</code></entry>
  107. <entry>Si, cuando <code>'accept_schemes'</code> contiene <code>'digest'</code></entry>
  108. <entry>
  109. Lista de URIs separadas por espacios para las cuales la misma información de autenticación es válida.
  110. No es necesario que todas las URIs apunten al mismo oservidor.
  111. </entry>
  112. </row>
  113. <row>
  114. <entry><code>nonce_timeout</code></entry>
  115. <entry>Si, cuando <code>'accept_schemes'</code> contiene <code>'digest'</code></entry>
  116. <entry>
  117. Establece el número de segundos para los cuales el "nonce" es válido.
  118. Ver notas de abajo.
  119. </entry>
  120. </row>
  121. <row>
  122. <entry><code>proxy_auth</code></entry>
  123. <entry>No</entry>
  124. <entry>
  125. Deshabilitado por defecto. Permite llevar a cabo la autenticación del Proxy, en lugar
  126. de la autenticación normal del servidor.
  127. </entry>
  128. </row>
  129. </tbody>
  130. </tgroup>
  131. </table>
  132. </para>
  133. <note>
  134. <para>
  135. La implementación actual del <code>nonce_timeout</code> tiene algunos efectos colaterales interesantes. Este
  136. ajuste es supuesto para determinar la vida util válida para un determinado "nonce", o de manera efectiva el tiempo
  137. que una información de autenticación del cliente es aceptada. Actualmente, si se establece en 3600 (por ejemplo),
  138. hará que el adaptador indique al cliente las nuevas credenciales cada hora, a la hora en punto.
  139. </para>
  140. </note>
  141. </sect2>
  142. <sect2 id="zend.auth.adapter.http.resolvers">
  143. <title>Resolvers</title>
  144. <para>
  145. El trabajo del "Resolver" es tener un username y un realm, y devolver algún valor de tipo credencial. La autenticación
  146. básica espera recibir la versión codificada en Base64 de la contraseña del usuario. La autenticación "Digest" espera
  147. recibir un hash del username del usuario, un realm, y su contraseña (separados por coma). Actualmente, sólo se admite el
  148. algoritmo de hash MD5.
  149. </para>
  150. <para>
  151. <classname>Zend_Auth_Adapter_Http</classname> se basa en la implementación de objetos
  152. <classname>Zend_Auth_Adapter_Http_Resolver_Interface</classname>. Un archivo de texto de la clase "Resolve" se incluye
  153. con este adaptador, pero cualquier otro tipo de "resolver" puede ser creado simplemente implementando la interfaz del
  154. "resolver".
  155. </para>
  156. <sect3 id="zend.auth.adapter.http.resolvers.file">
  157. <title>Archivo Resolver</title>
  158. <para>
  159. El archivo "resolver" es una clase muy simple. Tiene una única propiedad que especifique un nombre de archivo,
  160. que también puede ser pasado al constructor. Su método <code>resolve()</code> recorre el archivo de texto,
  161. buscando una linea con el correspondiente username y realm. El formato del archivo de texto es similar a los
  162. archivos htpasswd de Apache:
  163. <programlisting><![CDATA[
  164. <username>:<realm>:<credentials>\n
  165. ]]></programlisting>
  166. Cada linea consta de tres campos -username, realm, y credenciales - cada uno separados por dos puntos. El campo
  167. credenciales es opaco al archivo "resolver"; simplemente devuelve el valor tal como és al llamador. Por lo tanto,
  168. este formato de archivo sirve tanto de autenticación básica como "Digest". En la autenticación básica, el campo
  169. credenciales debe ser escrito en texto claro. En la autenticación "Digest", debería ser en hash MD5 descrito
  170. anteriormente.
  171. </para>
  172. <para>
  173. Hay dos formas igualmente fácil de crear un archivo de "resolver":
  174. <programlisting role="php"><![CDATA[
  175. $path = 'files/passwd.txt';
  176. $resolver = new Zend_Auth_Adapter_Http_Resolver_File($path);
  177. ]]></programlisting>
  178. o
  179. <programlisting role="php"><![CDATA[
  180. $path = 'files/passwd.txt';
  181. $resolver = new Zend_Auth_Adapter_Http_Resolver_File();
  182. $resolver->setFile($path);
  183. ]]></programlisting>
  184. Si la ruta está vacía o no se puede leer, se lanza una excepción.
  185. </para>
  186. </sect3>
  187. </sect2>
  188. <sect2 id="zend.auth.adapter.http.basic_usage">
  189. <title>Uso Básico</title>
  190. <para>
  191. En primer lugar, establecemos un array con los valores de configuración obligatorios:
  192. <programlisting role="php"><![CDATA[
  193. $config = array(
  194. 'accept_schemes' => 'basic digest',
  195. 'realm' => 'My Web Site',
  196. 'digest_domains' => '/members_only /my_account',
  197. 'nonce_timeout' => 3600,
  198. );
  199. ]]></programlisting>
  200. Este array hará que el adaptador acepte la autenticación básica o "Digest", y requerirá un acceso autenticado
  201. a todas las áreas del sitio en <code>/members_only</code> y <code>/my_account</code>. El valor realm es normalmente
  202. mostrado por el navegador en el cuadro de dialogo contraseña. El <code>nonce_timeout</code>, por supuesto, se
  203. comporta como se ha descrito anteriormente.
  204. </para>
  205. <para>
  206. A continuación, creamos el objeto Zend_Auth_Adapter_Http:
  207. <programlisting role="php"><![CDATA[
  208. $adapter = new Zend_Auth_Adapter_Http($config);
  209. ]]></programlisting>
  210. </para>
  211. <para>
  212. Ya que estamos soportando tanto la autenticación básica como la "Digest", necesitamos dos objetos diferentes
  213. resolver. Tenga en cuenta que esto podría ser facilmente dos clases diferentes:
  214. <programlisting role="php"><![CDATA[
  215. $basicResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  216. $basicResolver->setFile('files/basicPasswd.txt');
  217. $digestResolver = new Zend_Auth_Adapter_Http_Resolver_File();
  218. $digestResolver->setFile('files/digestPasswd.txt');
  219. $adapter->setBasicResolver($basicResolver);
  220. $adapter->setDigestResolver($digestResolver);
  221. ]]></programlisting>
  222. </para>
  223. <para>
  224. Por último, realizamos la autenticación. El adaptador necesita una referencia a ambos objetos solicitud y
  225. respuesta para hacer su trabajo:
  226. <programlisting role="php"><![CDATA[
  227. assert($request instanceof Zend_Controller_Request_Http);
  228. assert($response instanceof Zend_Controller_Response_Http);
  229. $adapter->setRequest($request);
  230. $adapter->setResponse($response);
  231. $result = $adapter->authenticate();
  232. if (!$result->isValid()) {
  233. // Bad userame/password, or canceled password prompt
  234. }
  235. ]]></programlisting>
  236. </para>
  237. </sect2>
  238. </sect1>
  239. <!--
  240. vim:se ts=4 sw=4 et:
  241. -->