password-needs-rehash.xml

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

<refentry xml:id="function.password-needs-rehash" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>password_needs_rehash</refname>
  <refpurpose>Comprueba si el hash facilitado coincide con las opciones proporcionadas</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>password_needs_rehash</methodname>
   <methodparam><type>string</type><parameter>hash</parameter></methodparam>
   <methodparam><type>int</type><parameter>algo</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Esta función comprueba si el hash facilitado implementa el algoritmo
   y opciones proporcionadas. Si no, asume que el hash necesita
   volver a ser generado.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>hash</parameter></term>
    <listitem>
     <para>
      &password.parameter.hash;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>algo</parameter></term>
    <listitem>
     <para>
      &password.parameter.algo;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      &password.parameter.options;
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Empleo de <function>password_needs_rehash</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$password = 'rasmuslerdorf';
$hash = '$2y$10$YCFsG6elYca568hBi2pZ0.3LDL5wjgxct1N8w/oLR/jfHsiQwCqTS';

// El parámetro cost puede cambiar con el tiempo al mejorar el hardware
$options = array('cost' => 11);

// Verificar el hash almacenado con la contraseña en texto plano
if (password_verify($password, $hash)) {
    // Comprobar hay un nuevo algoritmo de hash
    // o ha cambiado el coste
    if (password_needs_rehash($hash, PASSWORD_DEFAULT, $options)) {
        // Si es así, crear un nuevo hash y reemplazar el antiguo
        $newHash = password_hash($password, PASSWORD_DEFAULT, $options);
    }

    // Identificar al usuario
}
?>
]]>
    </programlisting>
   </example>
  </para> 
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve &true; si el hash debe ser generado de nuevo para coincidir con la información pasada a
   <parameter>algo</parameter> y <parameter>options</parameter>, o &false;
   en cualquier otro caso.
  </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
indent-tabs-mode:nil
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
-->