<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: e302f07943465892db7f72469e2ce9b42c4f763f Maintainer: takagi Status: ready -->

<!-- Credits: mumumu -->

<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>指定したハッシュがオプションにマッチするかどうかを調べる</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 class="union"><type>string</type><type>int</type><type>null</type></type><parameter>algo</parameter></methodparam>

<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>

</methodsynopsis>

<para>

指定したハッシュが、特定のアルゴリズムとオプションを満たしているかどうかを調べます。

満たしていない場合は、ハッシュを再計算する必要があるとみなします。

</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="returnvalues">

&reftitle.returnvalues;

<para>

指定した <parameter>algo</parameter> と <parameter>options</parameter>

にマッチするためにハッシュの再計算が必要な場合は &true;、

それ以外の場合は &false; を返します。

</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>7.4.0</entry>

<entry>

<parameter>algo</parameter> パラメータは &string; を期待するようになりました。

しかし、後方互換性のために &integer; も未だ受け入れています。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>password_needs_rehash</function> の使用例</title>

<programlisting role="php">

<![CDATA[

<?php

$password = 'rasmuslerdorf';

$hash = '$2y$12$4Umg0rCJwMswRw/l.SwHvuQV01coP0eWmGzd61QH2RvAOMANUBGC.';

$algorithm = PASSWORD_BCRYPT;

// bcrypt の cost パラメータは、ハードウェアの性能の向上にあわせて変えることができます

$options = ['cost' => 13];

// 格納されたハッシュを、平文のパスワードに対して検証します

if (password_verify($password, $hash)) {

// ハッシュアルゴリズムやオプションが変更されたかを確認します。

if (password_needs_rehash($hash, $algorithm, $options)) {

// 変更された場合は新しいハッシュを計算して、古いものを置き換えます

$newHash = password_hash($password, $algorithm, $options);

// ユーザーのレコードを $newHash で更新します

}

// ログイン

}

?>

]]>

</programlisting>

</example>

</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

-->