<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.password.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.password-hash.php',
    1 => 'password_hash',
    2 => '创建密码的散列（hash）',
  ),
  'up' => 
  array (
    0 => 'ref.password.php',
    1 => '密码散列算法函数',
  ),
  'prev' => 
  array (
    0 => 'function.password-get-info.php',
    1 => 'password_get_info',
  ),
  'next' => 
  array (
    0 => 'function.password-needs-rehash.php',
    1 => 'password_needs_rehash',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/password/functions/password-hash.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.password-hash" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">password_hash</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.5.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">password_hash</span> &mdash; <span class="dc-title">创建密码的散列（hash）</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.password-hash-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>password_hash</strong></span>(<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>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span> <code class="parameter">$algo</code></span>, <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>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>password_hash()</strong></span> 使用足够强度的单向散列算法创建密码的散列（hash）。
  </p>
  <p class="simpara">
   当前支持的算法：
  </p>
  <p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="password.constants.php#constant.password-default">PASSWORD_DEFAULT</a></code></strong> - 使用 bcrypt 算法 (PHP 5.5.0 默认)。
      注意，该常量会随着 PHP 加入更新更高强度的算法而改变。
      所以，使用此常量生成结果的长度将在未来有变化。
      因此，数据库里储存结果的列可超过60个字节（最好是255个字节）。
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="password.constants.php#constant.password-bcrypt">PASSWORD_BCRYPT</a></code></strong> - 使用 bcrypt 算法创建散列。
      这将使用 <code class="literal">$2y$</code> 标识生成标准的 <span class="function"><a href="function.crypt.php" class="function">crypt()</a></span> 兼容散列。
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="password.constants.php#constant.password-argon2i">PASSWORD_ARGON2I</a></code></strong> - 使用 Argon2i 散列算法创建散列。
      只有在 PHP 编译时加入 Argon2 支持时才能使用该算法。
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="password.constants.php#constant.password-argon2id">PASSWORD_ARGON2ID</a></code></strong> - 使用 Argon2id 散列算法创建散列。
      只有在 PHP 编译时加入 Argon2 支持时才能使用该算法。
     </span>
    </li>
   </ul>
  </p>
  <p class="simpara">
      <strong><code><a href="password.constants.php#constant.password-bcrypt">PASSWORD_BCRYPT</a></code></strong> 支持的选项：
  </p>
  <p class="para">
   <ul class="itemizedlist">
      <li class="listitem">
       <p class="para">
        <code class="literal">salt</code>(<span class="type"><a href="language.types.string.php" class="type string">string</a></span>) - 手动提供散列密码的盐值（salt）。这将避免自动生成盐值（salt）。
       </p>
       <p class="para">
        省略此值后，<span class="function"><strong>password_hash()</strong></span> 会为每个密码散列自动生成随机的盐值。这种操作是有意的模式。
       </p>
       <div class="warning"><strong class="warning">警告</strong>
        <p class="para">
         盐值（salt）选项已废弃（deprecated）。
         现在最好仅选择使用默认产生的盐值。
         从 PHP 8.0.0 起，明确指定的 salt 值会被忽略。
        </p>
       </div>
      </li>
      <li class="listitem">
       <p class="para">
        <code class="literal">cost</code> (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>) - 代表算法使用的 cost。<span class="function"><a href="function.crypt.php" class="function">crypt()</a></span> 页面上有 cost 值的示例。
       </p>
       <p class="para">
        省略时，默认值是 <code class="literal">12</code>。
        这个 cost 是个不错的底线，但应根据使用的硬件进行调整。
       </p>
      </li>
     </ul>
  </p>
  <p class="simpara">
    <strong><code><a href="password.constants.php#constant.password-argon2i">PASSWORD_ARGON2I</a></code></strong> 和 <strong><code><a href="password.constants.php#constant.password-argon2id">PASSWORD_ARGON2ID</a></code></strong> 支持的选项：
  </p>
  <p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <p class="para">
      <code class="literal">memory_cost</code> (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>) - 计算 Argon2 散列时的最大内存（单位：KB）。默认值： <strong><code><a href="password.constants.php#constant.password-argon2-default-memory-cost">PASSWORD_ARGON2_DEFAULT_MEMORY_COST</a></code></strong>。
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">time_cost</code> (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>) - 计算 Argon2 散列时最多的时间。默认值： <strong><code><a href="password.constants.php#constant.password-argon2-default-time-cost">PASSWORD_ARGON2_DEFAULT_TIME_COST</a></code></strong>。
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">threads</code> (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>) - 计算 Argon2 散列时最多的线程数。默认值： <strong><code><a href="password.constants.php#constant.password-argon2-default-threads">PASSWORD_ARGON2_DEFAULT_THREADS</a></code></strong>。
     </p>
     <div class="warning"><strong class="warning">警告</strong>
      <p class="para">
       只有在 PHP 使用 libargon2 时可用；如果是 libsodium 的实现，则无法使用。
      </p>
     </div>
    </li>
   </ul>
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.password-hash-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">password</code></dt>
    <dd>
     <p class="para">
      用户的密码。
     </p>
      <div class="caution"><strong class="caution">警告</strong>
       <p class="para">
        使用 <strong><code><a href="password.constants.php#constant.password-bcrypt">PASSWORD_BCRYPT</a></code></strong> 做算法，将使 <code class="parameter">password</code> 参数最长为72个字节，超过会被截断。
       </p>
      </div>
    </dd>
   
   
    <dt><code class="parameter">algo</code></dt>
    <dd>
     <p class="para">
      一个用来在散列密码时指示算法的<a href="password.constants.php" class="link">密码算法常量</a>。
     </p>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <p class="para">
      一个包含有选项的关联数组。详细的参数说明，请参考文档 <a href="password.constants.php" class="link">密码算法常数</a>。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.password-hash-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   返回散列后的密码。
  </p>
  <p class="para">
   使用的算法、cost 和盐值作为散列的一部分返回。所以验证散列值的所有信息都已经包含在内。
   这使 <span class="function"><a href="function.password-verify.php" class="function">password_verify()</a></span> 函数验证的时候，不需要额外储存盐值或者算法的信息。
  </p>
 </div>

 
 
 <div class="refsect1 changelog" id="refsect1-function.password-hash-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.4.0</td>
       <td>
        <strong><code><a href="password.constants.php#constant.password-bcrypt">PASSWORD_BCRYPT</a></code></strong> 算法的 <code class="literal">cost</code> 选项的默认值从
        <code class="literal">10</code> 增加到 <code class="literal">12</code>。
       </td>
      </tr>

      <tr>
       <td>8.3.0</td>
       <td>
        当由于盐值生成失败而抛出 <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> 时，
        <span class="function"><strong>password_hash()</strong></span> 现在会将底层的
        <span class="exceptionname"><a href="class.random-randomexception.php" class="exceptionname">Random\RandomException</a></span> 作为
        <span class="property"><a href="class.exception.php#exception.props.previous">Exception::$previous</a></span> 异常。
       </td>
      </tr>

      <tr>
       <td>8.0.0</td>
       <td>
        失败时 <span class="function"><strong>password_hash()</strong></span> 不再返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>，如果密码散列算法无效，则会抛出
        <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>，如果密码散列因未知错误失败，则会抛出 <span class="classname"><a href="class.error.php" class="classname">Error</a></span>。
       </td>
      </tr>

      <tr>
       <td>8.0.0</td>
       <td>
        参数 <code class="parameter">algo</code> 可以为 null。
       </td>
      </tr>

      <tr>
       <td>7.4.0</td>
       <td>
        现在 <code class="parameter">algo</code> 参数可支持 <span class="type"><a href="language.types.string.php" class="type string">string</a></span> 类型，但为了向后兼容也支持
        <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> 类型。
       </td>
      </tr>

      <tr>
       <td>7.4.0</td>
       <td>
        扩展 sodium 提供了 Argon2 密码的替代实现。
       </td>
      </tr>

      <tr>
       <td>7.3.0</td>
       <td>
        增加 <strong><code><a href="password.constants.php#constant.password-argon2id">PASSWORD_ARGON2ID</a></code></strong>，支持 Argon2id 密码算法。
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        增加 <strong><code><a href="password.constants.php#constant.password-argon2i">PASSWORD_ARGON2I</a></code></strong>，支持 Argon2i 密码算法。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.password-hash-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>password_hash()</strong></span> 示例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">password_hash</span><span style="color: #007700">(</span><span style="color: #DD0000">"rasmuslerdorf"</span><span style="color: #007700">, </span><span style="color: #0000BB">PASSWORD_DEFAULT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>以上示例的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">$2y$12$4Umg0rCJwMswRw/l.SwHvuQV01coP0eWmGzd61QH2RvAOMANUBGC.</pre>
</div>
    </div>
   </div>
  </p> 
  <p class="para">
   <div class="example" id="example-2">
    <p><strong>示例 #2 <span class="function"><strong>password_hash()</strong></span> 手动设置 cost 的示例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$options </span><span style="color: #007700">= [<br />    </span><span style="color: #FF8000">// Increase the bcrypt cost from 12 to 13.<br />    </span><span style="color: #DD0000">'cost' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">13</span><span style="color: #007700">,<br />];<br />echo </span><span style="color: #0000BB">password_hash</span><span style="color: #007700">(</span><span style="color: #DD0000">"rasmuslerdorf"</span><span style="color: #007700">, </span><span style="color: #0000BB">PASSWORD_BCRYPT</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>以上示例的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">$2y$13$xeDfQumlmdm0Sco.4qmH1OGfUUmOcuRmfae0dPJhjX1Bq0yYhqbNi</pre>
</div>
    </div>
   </div>
  </p>
  
  <p class="para">
   <div class="example" id="example-3">
    <p><strong>示例 #3 寻找最佳 cost 的 <span class="function"><strong>password_hash()</strong></span> 示例</strong></p>
    <div class="example-contents"><p>
     该代码将会基准测试机器，来确定可以使用多高的 cost 而不会影响用户体验。
     建议设置最高的 cost，前提是不会减慢机器需要执行的其他操作。
     11 是一个不错的基线，如果机器足够快，更多的 cost 更好。
     下面的代码目标是 ≤ 350 毫秒的拉伸时间（stretching time），这是处理交互式登录的系统的适当延迟。
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$timeTarget </span><span style="color: #007700">= </span><span style="color: #0000BB">0.350</span><span style="color: #007700">; </span><span style="color: #FF8000">// 350 毫秒（milliseconds） <br /><br /></span><span style="color: #0000BB">$cost </span><span style="color: #007700">= </span><span style="color: #0000BB">11</span><span style="color: #007700">;<br />do {<br />    </span><span style="color: #0000BB">$cost</span><span style="color: #007700">++;<br />    </span><span style="color: #0000BB">$start </span><span style="color: #007700">= </span><span style="color: #0000BB">microtime</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">password_hash</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #0000BB">PASSWORD_BCRYPT</span><span style="color: #007700">, [</span><span style="color: #DD0000">"cost" </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">$cost</span><span style="color: #007700">]);<br />    </span><span style="color: #0000BB">$end </span><span style="color: #007700">= </span><span style="color: #0000BB">microtime</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br />} while ((</span><span style="color: #0000BB">$end </span><span style="color: #007700">- </span><span style="color: #0000BB">$start</span><span style="color: #007700">) &lt; </span><span style="color: #0000BB">$timeTarget</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Appropriate Cost Found: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$cost </span><span style="color: #007700">- </span><span style="color: #0000BB">1</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>以上示例的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Appropriate Cost Found: 13</pre>
</div>
    </div>
   </div>
  </p>
  <p class="para">
   <div class="example" id="example-4">
    <p><strong>示例 #4 使用 Argon2i 的 <span class="function"><strong>password_hash()</strong></span> 示例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'Argon2i hash: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">password_hash</span><span style="color: #007700">(</span><span style="color: #DD0000">'rasmuslerdorf'</span><span style="color: #007700">, </span><span style="color: #0000BB">PASSWORD_ARGON2I</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>以上示例的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Argon2i hash: $argon2i$v=19$m=1024,t=2,p=2$YzJBSzV4TUhkMzc3d3laeg$zqU/1IN0/AogfP4cmSJI1vc8lpXRW9/S0sYY2i2jHT0</pre>
</div>
    </div>
   </div>
  </p>
 </div>

 
 <div class="refsect1 notes" id="refsect1-function.password-hash-notes">
  <h3 class="title">注释</h3>
  <div class="caution"><strong class="caution">警告</strong>
   <p class="para">
    强烈建议不要为此函数提供显式的盐值（salt）。
    如果没有指定盐值（salt），将自动创建一个安全的盐值（salt）。
   </p>
   <p class="para">
    提供 <code class="literal">salt</code> 选项在 PHP 7.0.0 中会生成一个弃用（deprecated）警告。
    在 PHP 8.0.0 中，显式提供盐值（salt）的支持已被删除。
   </p>
  </div>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    建议在使用的机器上测试此函数，调整 cost 参数，使得函数执行时间小于 350 毫秒，适合交互式登录。
    上面示例中的脚本将帮助选择适合给定机器的 bcrypt cost。
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
    这个函数更新支持的算法时（或修改默认算法），必定会遵守以下规则：
   </span>
   <p class="para">
    <ul class="itemizedlist">
     <li class="listitem">
      <span class="simpara">
       任何内核中的新算法必须在经历一次 PHP 完整发行才能成为默认算法。
       比如，在 PHP 7.5.5 中添加的新算法，在 PHP 7.7 之前不能成为默认算法
       （由于 7.6 是第一个完整发行版）。
       但如果是在 7.6.0 里添加的不同算法，在 7.7.0 里也可以成为默认算法。
      </span>
     </li>
     <li class="listitem">
      <span class="simpara">
       仅仅允许在完整发行版中修改默认算法（比如 7.3.0, 8.0.0，等等），不能是在修订版。
       唯一的例外是：在当前默认算法里发现了紧急的安全威胁。
      </span>
     </li>
    </ul>
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.password-hash-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.password-verify.php" class="function" rel="rdfs-seeAlso">password_verify()</a> - 验证密码是否和散列值匹配</span></li>
    <li><span class="function"><a href="function.password-needs-rehash.php" class="function" rel="rdfs-seeAlso">password_needs_rehash()</a> - 检测散列值是否匹配指定的选项</span></li>
    <li><span class="function"><a href="function.crypt.php" class="function" rel="rdfs-seeAlso">crypt()</a> - 单向字符串散列</span></li>
    <li><span class="function"><a href="function.sodium-crypto-pwhash-str.php" class="function" rel="rdfs-seeAlso">sodium_crypto_pwhash_str()</a> - Get an ASCII-encoded hash</span></li>
   </ul>
  </p>
 </div>


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