# password_hash

(PHP 5 >= 5.5.0, PHP 7)

password_hash — 创建密码的散列（hash）

### 说明

password_hash ( string `$password` , int `$algo` [, array `$options` ] ) : string

password_hash() 使用足够强度的单向散列算法创建密码的散列（hash）。 password_hash() 兼容 crypt()。 所以， crypt() 创建的密码散列也可用于 password_hash()。

当前支持的算法：

- `PASSWORD_DEFAULT` - 使用 bcrypt 算法 (PHP 5.5.0 默认)。 注意，该常量会随着 PHP 加入更新更高强度的算法而改变。 所以，使用此常量生成结果的长度将在未来有变化。 因此，数据库里储存结果的列可超过60个字符（最好是255个字符）。
- `PASSWORD_BCRYPT` - 使用 `CRYPT_BLOWFISH` 算法创建散列。 这会产生兼容使用 "$2y$" 的 crypt()。 结果将会是 60 个字符的字符串， 或者在失败时返回 `FALSE`。
- `PASSWORD_ARGON2I` - 使用 Argon2 散列算法创建散列。

`PASSWORD_BCRYPT` 支持的选项：

- salt(string) - 手动提供散列密码的盐值（salt）。这将避免自动生成盐值（salt）。

  省略此值后，password_hash() 会为每个密码散列自动生成随机的盐值。这种操作是有意的模式。

  Warning

  盐值（salt）选项从 PHP 7.0.0 开始被废弃（deprecated）了。 现在最好选择简单的使用默认产生的盐值。

- cost (integer) _ 代表算法使用的 cost。crypt() 页面上有 cost 值的例子。

  省略时，默认值是 10。 这个 cost 是个不错的底线，但也许可以根据自己硬件的情况，加大这个值。

`PASSWORD_ARGON2I` 支持的选项：

- memory_cost (integer) - 计算 Argon2 散列时的最大内存（单位：字节 byte）。默认值： `PASSWORD_ARGON2_DEFAULT_MEMORY_COST`。

- time_cost (integer) - 计算 Argon2 散列时最多的时间。默认值： `PASSWORD_ARGON2_DEFAULT_TIME_COST`。

- threads (integer) - 计算 Argon2 散列时最多的线程数。默认值： `PASSWORD_ARGON2_DEFAULT_THREADS`。

### 参数

`password`

  用户的密码。

  Caution

  使用`PASSWORD_BCRYPT` 做算法，将使 `password` 参数最长为72个字符，超过会被截断。

`algo`

  一个用来在散列密码时指示算法的密码算法常量。

`options`

  一个包含有选项的关联数组。目前支持两个选项：salt，在散列密码时加的盐（干扰字符串），以及cost，用来指明算法递归的层数。这两个值的例子可在 crypt() 页面找到。

  省略后，将使用随机盐值与默认 cost。

### 返回值

返回散列后的密码， 或者在失败时返回 `FALSE`。

使用的算法、cost 和盐值作为散列的一部分返回。所以验证散列值的所有信息都已经包含在内。 这使 password_verify() 函数验证的时候，不需要额外储存盐值或者算法的信息。

### 范例

Example #1 password_hash() 例子

    <?php
    /**
     * 我们想要使用默认算法散列密码
     * 当前是 BCRYPT，并会产生 60 个字符的结果。
     *
     * 请注意，随时间推移，默认算法可能会有变化，
     * 所以需要储存的空间能够超过 60 字（255字不错）
     */
    echo password_hash("rasmuslerdorf", PASSWORD_DEFAULT);
    ?>

以上例程的输出类似于：

    $2y$10$.vGA1O9wmRjrwAVXD98HNOgsNpDczlqm3Jq7KnEd1rVAGv3Fykk1a

Example #2 password_hash() 手动设置 cost 的例子

    <?php
    /**
     * 在这个案例里，我们为 BCRYPT 增加 cost 到 12。
     * 注意，我们已经切换到了，将始终产生 60 个字符。
     */
    $options = [
        'cost' => 12,
    ];
    echo password_hash("rasmuslerdorf", PASSWORD_BCRYPT, $options);
    ?>

以上例程的输出类似于：

    $2y$12$QjSH496pcT5CEbzjD/vtVeH03tfHKFy36d4J0Ltp3lRtee9HDxY3K

Example #3 password_hash() 手动设置盐值的例子

    <?php
    /**
     * 注意，这里的盐值是随机产生的。
     * 永远都不要使用固定盐值，或者不是随机生成的盐值。
     *
     * 绝大多数情况下，可以让 password_hash generate 为你自动产生随机盐值
     */
    $options = [
        'cost' => 11,
        'salt' => mcrypt_create_iv(22, MCRYPT_DEV_URANDOM),
    ];
    echo password_hash("rasmuslerdorf", PASSWORD_BCRYPT, $options);
    ?>

以上例程的输出类似于：

    $2y$11$q5MkhSBtlsJcNEVsYh64a.aCluzHnGog7TQAKVmQwO9C8xb.t89F.

Example #4 寻找最佳 cost 的 password_hash() 例子

    <?php
    /**
     * 这个例子对服务器做了基准测试（benchmark），检测服务器能承受多高的 cost
     * 在不明显拖慢服务器的情况下可以设置最高的值
     * 8-10 是个不错的底线，在服务器够快的情况下，越高越好。
     * 以下代码目标为  ≤ 50 毫秒（milliseconds），
     * 适合系统处理交互登录。
     */
    $timeTarget = 0.05; // 50 毫秒（milliseconds）

    $cost = 8;
    do {
        $cost++;
        $start = microtime(true);
        password_hash("test", PASSWORD_BCRYPT, ["cost" => $cost]);
        $end = microtime(true);
    } while (($end - $start) < $timeTarget);

    echo "Appropriate Cost Found: " . $cost;
    ?>

以上例程的输出类似于：

    Appropriate Cost Found: 10

Example #5 使用 Argon2 的password_hash()例子

    <?php
    echo 'Argon2 hash: ' . password_hash('rasmuslerdorf', PASSWORD_ARGON2I);
    ?>

以上例程的输出类似于：

    Argon2 hash: $argon2i$v=19$m=1024,t=2,p=2$YzJBSzV4TUhkMzc3d3laeg$zqU/1IN0/AogfP4cmSJI1vc8lpXRW9/S0sYY2i2jHT0

### 注释

Caution

强烈建议不要自己为这个函数生成盐值（salt）。只要不设置，它会自动创建安全的盐值。

就像以上提及的，在 PHP 7.0 提供 salt选项会导致废弃（deprecation）警告。 未来的 PHP 发行版里，手动提供盐值的功能可能会被删掉。

> Note:

> 在交互的系统上，推荐在自己的服务器上测试此函数，调整 cost 参数直至函数时间开销小于 100 毫秒（milliseconds）。 上面脚本的例子会帮助选择合适硬件的最佳 cost。

> Note: 这个函数更新支持的算法时（或修改默认算法），必定会遵守以下规则：

> - 任何内核中的新算法必须在经历一次 PHP 完整发行才能成为默认算法。 比如，在 PHP 7.5.5 中添加的新算法，在 PHP 7.7 之前不能成为默认算法 （由于 7.6 是第一个完整发行版）。 但如果是在 7.6.0 里添加的不同算法，在 7.7.0 里也可以成为默认算法。
> - 仅仅允许在完整发行版中修改默认算法（比如 7.3.0, 8.0.0，等等），不能是在修订版。 唯一的例外是：在当前默认算法里发现了紧急的安全威胁。

### 更新日志

版本 | 说明
--- | ---
7.2.0 | 添加 `PASSWORD_ARGON2I`，支持 Argon2 密码散列算法。

### 参见

- password_verify() - 验证密码是否和散列值匹配
- crypt() - 单向字符串散列
- » 用户的使用