random_bytes

(PHP 7, PHP 8)

random_bytes — 暗号学的にセキュアな、ランダムなバイト列を生成する

function 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 5.2 から 5.6 までのバージョンで使える » ユーザーランドの実装も公開されています。

暗号学的にセキュアなランダムなバイト列を含んだ文字列を返します。

バージョン	説明
8.2.0	CSPRNG が失敗した場合に、 Random\RandomException をスローするようになりました。これより前のバージョンでは、Exception をスローしていました。

例1 random_bytes() の例

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

上の例の出力は、たとえば以下のようになります。

string(10) "385e33f741"

There are no user contributed notes for this page.