Zend_Auth_Adapter_Http.xml 13 KB

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