archived-doc-es/reference/mongo/mongodb/authenticate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8a4640c71cd1b8b6ad42f5c58ba0daacfea739c4 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="mongodb.authenticate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoDB::authenticate</refname>
  <refpurpose>Iniciar sesión en esta base de datos</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>MongoDB::authenticate</methodname>
   <methodparam><type>string</type><parameter>username</parameter></methodparam>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
  </methodsynopsis>
  <para>
   Este método hace que esta conexión sea autenticada. Si el servidor de bases de datos
   tiene la autenticación habilitada (de forma predeterminada, no lo está), deberá
   iniciar sesión antes de poder hacer cualquier cosa.
  </para>
  <para>
   En general, deberá se recomienda utilizar la autenticación que incorpora
   <function>MongoClient::__construct</function> antes que este método.
   Si se autentica sobre la conexión, y la conexión se cae y se reconecta
   durante la sesión, automáticamente será re-autenticado. Si se autentica
   manualmente usando este método, y la conexión se cae, deberá llamar a este
   método de nuevo cuando la conexión vuelva.
  </para>
  <para>
   Este método es equivalente a ejecutar:
   <programlisting role="php">
<![CDATA[
<?php

$salted = "${username}:mongo:${password}";
$hash = md5($salted);

$nonce = $db->command(array("getnonce" => 1));

$saltedHash = md5($nonce["nonce"]."${username}${hash}");

$result = $db->command(array("authenticate" => 1,
    "user" => $username,
    "nonce" => $nonce["nonce"],
    "key" => $saltedHash
));

?>
]]>
   </programlisting>
  </para>
  <para>
   Una vez que una conexión ha sido autenticada, sólo puede ser des-autenticada mediante
   el comando de base de datos "logout":
   <programlisting role="php">
<![CDATA[
<?php

$db->command(array("logout" => 1));

?>
]]>
   </programlisting>
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>username</parameter>
     </term>
     <listitem>
      <para>
       Nombre de usuario.
      </para>
     </listitem>
    </varlistentry>   
    <varlistentry>
     <term>
      <parameter>password</parameter>
     </term>
     <listitem>
      <para>
       La contraseña (en texto plano).
      </para>
     </listitem>
    </varlistentry>   
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;  
  <para>
   Devuelve la respuesta de la base de datos. Si el inicio de sesión tuvo éxito, devolverá:
   <programlisting role="php">
<![CDATA[
<?php
array("ok" => 1);
?>
]]>
   </programlisting>
   Si algo fue mal, devolverá:
   <programlisting role="php">
<![CDATA[
<?php
array("ok" => 0, "errmsg" => "auth fails");
?>
]]>
   </programlisting>
   ("auth fails" puede ser otro mensaje, dependiendo de la versión de la base de datos y de
   qué fuera mal).
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   Documentación de MongoDB sobre <link xlink:href="&url.mongodb.dochub.authenticate;">autenticación</link>.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>1.2.11</entry>
       <entry>
        Emite un error de nivel <constant>E_DEPRECATED</constant> cuando se usa.
        Por favor, pase los detalles de autenticación al constructor.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->