<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.hash.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.hash-pbkdf2.php',
    1 => 'hash_pbkdf2',
    2 => '生成所提供密码的 PBKDF2 密钥导出',
  ),
  'up' => 
  array (
    0 => 'ref.hash.php',
    1 => 'Hash 函数',
  ),
  'prev' => 
  array (
    0 => 'function.hash-init.php',
    1 => 'hash_init',
  ),
  'next' => 
  array (
    0 => 'function.hash-update.php',
    1 => 'hash_update',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/hash/functions/hash-pbkdf2.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.hash-pbkdf2" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">hash_pbkdf2</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.5.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">hash_pbkdf2</span> &mdash; <span class="dc-title">生成所提供密码的 PBKDF2 密钥导出</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.hash-pbkdf2-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>hash_pbkdf2</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$algo</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="attribute"><a href="class.sensitiveparameter.php">#[\SensitiveParameter]</a> </span><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$password</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$salt</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$iterations</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$binary</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = []</span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.hash-pbkdf2-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">algo</code></dt>
     <dd>
      <p class="para">
       要使用的散列算法的名称（例如：<code class="literal">“sha256”</code>）。
       可以在 <span class="function"><a href="function.hash-hmac-algos.php" class="function">hash_hmac_algos()</a></span> 中查看当前支持的算法。
      </p>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        不允许使用非加密哈希函数。
       </p>
      </p></blockquote>
     </dd>
    
    
     <dt><code class="parameter">password</code></dt>
     <dd>
      <p class="para">
       要进行导出的密码。
      </p>
     </dd>
    
    
     <dt><code class="parameter">salt</code></dt>
     <dd>
      <p class="para">
       进行导出时所使用的“盐”，这个值应该是随机生成的。
      </p>
     </dd>
    
    
     <dt><code class="parameter">iterations</code></dt>
     <dd>
      <p class="para">
       进行导出时的迭代次数。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       密钥导出数据的长度。如果 <code class="parameter">binary</code> 为 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>，
       此参数为密钥导出数据的字节长度。如果 <code class="parameter">binary</code> 为 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>，
       此参数为密钥导出数据的字节长度的 2 倍，因为 1 个字节数据对应的 2 个 16 进制的字符。
      </p>
      <p class="para">
       如果传入 <code class="literal">0</code>，则使用所选算法的完整输出大小。
      </p>
     </dd>
    
    
     <dt><code class="parameter">binary</code></dt>
     <dd>
      <p class="para">
       设置为 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> 输出原始二进制数据，
       设置为 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> 输出小写 16 进制字符串。
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       各种散列算法的一系列选项数组。
       目前 MurmurHash 算法仅支持 <code class="literal">“seed”</code> 参数。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.hash-pbkdf2-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   如果 <code class="parameter">binary</code> 设置为 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>， 
   则返回原始二进制数据表示的信息摘要，
   否则返回 16 进制小写字符串格式表示的信息摘要。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.hash-pbkdf2-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   在以下情况下会抛出 <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> 异常：算法未知，<code class="parameter">iterations</code>
   小于等于 <code class="literal">0</code>，<code class="parameter">length</code> 小于等于 <code class="literal">0</code> 或者
   <code class="parameter">salt</code> 过长（大于 <strong><code>INT_MAX</code></strong><code class="literal"> - 4</code>）。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.hash-pbkdf2-changelog">
  <h3 class="title">更新日志</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>版本</th>
       <th>说明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.0.0</td>
       <td>
        现在错误时将抛出 <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> 异常。之前返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>
        并发出 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> 消息。
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>不再支持非加密的散列函数（adler32、crc32、crc32b、fnv132、fnv1a32、fnv164、fnv1a64、joaat）。</td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>

 
 <div class="refsect1 examples" id="refsect1-function.hash-pbkdf2-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>hash_pbkdf2()</strong></span> 示例，基础用法</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$password </span><span style="color: #007700">= </span><span style="color: #DD0000">"password"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$iterations </span><span style="color: #007700">= </span><span style="color: #0000BB">600000</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// 使用 random_bytes() 生成一个加密安全的随机盐。<br /></span><span style="color: #0000BB">$salt </span><span style="color: #007700">= </span><span style="color: #0000BB">random_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">16</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$hash </span><span style="color: #007700">= </span><span style="color: #0000BB">hash_pbkdf2</span><span style="color: #007700">(</span><span style="color: #DD0000">"sha256"</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$salt</span><span style="color: #007700">, </span><span style="color: #0000BB">$iterations</span><span style="color: #007700">, </span><span style="color: #0000BB">20</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$hash</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// 对于原始二进制，$length 需要减半以获得相同的结果<br /></span><span style="color: #0000BB">$hash </span><span style="color: #007700">= </span><span style="color: #0000BB">hash_pbkdf2</span><span style="color: #007700">(</span><span style="color: #DD0000">"sha256"</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$salt</span><span style="color: #007700">, </span><span style="color: #0000BB">$iterations</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">bin2hex</span><span style="color: #007700">(</span><span style="color: #0000BB">$hash</span><span style="color: #007700">));</span><span style="color: #0000BB">?&gt;<br /></span>?&gt;</span></code></div>
    </div>

    <div class="example-contents"><p>以上示例的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">string(20) &quot;120fb6cffcf8b32c43e7&quot;
string(20) &quot;120fb6cffcf8b32c43e7&quot;</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.hash-pbkdf2-notes">
  <h3 class="title">注释</h3>
  <div class="caution"><strong class="caution">警告</strong>
   <p class="para">
    为了安全起见，可以使用 PBKDF2 方法对密码明文进行散列运算后再存储。但是更好的方案是使用
    <span class="function"><a href="function.password-hash.php" class="function">password_hash()</a></span> 函数或者使用 <strong><code><a href="string.constants.php#constant.crypt-blowfish">CRYPT_BLOWFISH</a></code></strong> 算法调用 
    <span class="function"><a href="function.crypt.php" class="function">crypt()</a></span> 函数。
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.hash-pbkdf2-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.password-hash.php" class="function" rel="rdfs-seeAlso">password_hash()</a> - 创建密码的散列（hash）</span></li>
    <li><span class="function"><a href="function.hash-hkdf.php" class="function" rel="rdfs-seeAlso">hash_hkdf()</a> - Generate a HKDF key derivation of a supplied key input</span></li>
    <li><span class="function"><a href="function.sodium-crypto-pwhash.php" class="function" rel="rdfs-seeAlso">sodium_crypto_pwhash()</a> - Derive a key from a password, using Argon2</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>