PHP Conference Japan 2024

random_bytes

(PHP 7, PHP 8)

random_bytes获取密码学安全的随机字节

描述

random_bytes(int $length): string

生成一个包含根据请求的 length 均匀选择的随机字节的字符串。

由于返回的字节是完全随机选择的,因此生成的字符串可能包含不可打印字符或无效的 UTF-8 序列。在传输或显示之前可能需要对其进行编码。

此函数生成的随机性适用于所有应用程序,包括生成长期密钥,例如加密密钥。

随机性的来源按优先级顺序如下:

  • Linux: » getrandom(), /dev/urandom

  • FreeBSD >= 12 (PHP >= 7.3): » getrandom(), /dev/urandom

  • Windows (PHP >= 7.2): » CNG-API

    Windows: » CryptGenRandom

  • macOS (PHP >= 8.2; >= 8.1.9; >= 8.0.22 如果编译时可用 CCRandomGenerateBytes): CCRandomGenerateBytes()

    macOS (PHP >= 8.1; >= 8.0.2): arc4random_buf(), /dev/urandom

  • NetBSD >= 7 (PHP >= 7.1; >= 7.0.1): arc4random_buf(), /dev/urandom

  • OpenBSD >= 5.5 (PHP >= 7.1; >= 7.0.1): arc4random_buf(), /dev/urandom

  • DragonflyBSD (PHP >= 8.1): » getrandom(), /dev/urandom

  • Solaris (PHP >= 8.1): » getrandom(), /dev/urandom

  • 任何未提及的操作系统和 PHP 版本组合:/dev/urandom
  • 如果没有可用的来源或所有来源都无法生成随机性,则会抛出 Random\RandomException

注意: 尽管此函数在 PHP 7.0 中添加到 PHP,但 » 用户空间实现 可用于 PHP 5.2 到 5.6(含)。

参数

length

应返回的随机字符串的长度(以字节为单位);必须为 1 或更大。

返回值

包含请求数量的密码学安全随机字节的字符串。

错误/异常

变更日志

版本 描述
8.2.0 如果 CSPRNG 失败,此函数现在将抛出 Random\RandomException。以前会抛出普通的 Exception

示例

示例 #1 random_bytes() 示例

<?php
$bytes
= random_bytes(5);
var_dump(bin2hex($bytes));
?>

以上示例将输出类似于以下内容:

string(10) "385e33f741"

参见

添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top