PHP Velho Oeste 2024

random_int

(PHP 7, PHP 8)

random_int暗号学的にセキュアな方法で、等確率に出る整数を取得する

説明

random_int(int $min, int $max): int

指定された最小値と最大値の区間から、 等確率に選ばれるランダムな整数を生成します。

この関数が生成するランダムな値は、すべてのアプリケーションに対して適切です。 たとえば暗号化キーのような、長期間使うシークレットが挙げられます。

この関数が使う不規則性のソースは、優先度順に以下のとおりです:

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

パラメータ

min

返される最小値。

max

返される最大値。

戻り値

minmax の範囲で、 暗号学的にセキュアな方法で、 閉区間 [min, max] の中から等確率に出るよう選ばれた整数値を返します。 minmax  も返される値に含みます。

エラー / 例外

  • 適切な不規則性のソースが見つからない場合は Random\RandomException をスローします。
  • maxmin より小さい場合、 ValueError がスローされます。

変更履歴

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

例1 random_int() の例

<?php
var_dump
(random_int(100, 999));
var_dump(random_int(-1000, 0));
?>

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

int(248)
int(-898)

参考

add a note

User Contributed Notes 4 notes

up
13
s rotondo90 at gmail com
7 years ago
Here is a simple backporting function, it works for PHP >= 5.1

<?php
if (!function_exists('random_int')) {
function
random_int($min, $max) {
if (!
function_exists('mcrypt_create_iv')) {
trigger_error(
'mcrypt must be loaded for random_int to work',
E_USER_WARNING
);
return
null;
}

if (!
is_int($min) || !is_int($max)) {
trigger_error('$min and $max must be integer values', E_USER_NOTICE);
$min = (int)$min;
$max = (int)$max;
}

if (
$min > $max) {
trigger_error('$max can\'t be lesser than $min', E_USER_WARNING);
return
null;
}

$range = $counter = $max - $min;
$bits = 1;

while (
$counter >>= 1) {
++
$bits;
}

$bytes = (int)max(ceil($bits/8), 1);
$bitmask = pow(2, $bits) - 1;

if (
$bitmask >= PHP_INT_MAX) {
$bitmask = PHP_INT_MAX;
}

do {
$result = hexdec(
bin2hex(
mcrypt_create_iv($bytes, MCRYPT_DEV_URANDOM)
)
) &
$bitmask;
} while (
$result > $range);

return
$result + $min;
}
}
?>

Randomness test

<?php
$max
= 100; // number of random values
$test = 1000000;

$array = array_fill(0, $max, 0);

for (
$i = 0; $i < $test; ++$i) {
++
$array[random_int(0, $max-1)];
}

function
arrayFormatResult(&$item) {
global
$test, $max; // try to avoid this nowdays ;)

$perc = ($item/($test/$max))-1;
$item .= ' '. number_format($perc, 4, '.', '') .'%';
}

array_walk($array, 'arrayFormatResult');

print_r($array);
?>
up
3
bens at effortlessis dot com
3 years ago
On my system (5th gen i7) random_int() takes about 14x longer to do the same number of calculations than rand().

for ($i=0; $i<10000000; $i++)
$x = rand(1, PHP_INT_MAX);

Takes 0.86 seconds for rand(), 12.29 seconds for random_int(). So use random_int() somewhat sparingly.

If it's not really important to be truly random, use rand() instead, especially in a tight loop.
up
0
ccb_bc at hotmail dot com
4 years ago
<?php
// PHP >= 7
function str_rand(int $length = 16){
$x = '';
for(
$i = 1; $i <= $length; $i++){
$x .= dechex(random_int(0,255));
}
return
substr($x, 0, $length);
}
var_dump(str_rand());
?>
up
-1
Hayley Watson
5 months ago
A small function for generating version 4 GUIDs.

<?php
function v4uuid()
{
$a = str_pad(dechex(random_int(0x0000_0000, 0xffff_ffff)), '0', STR_PAD_LEFT);
$b = str_pad(dechex(random_int(0x0000, 0xffff)), '0', STR_PAD_LEFT);
$c = dechex(random_int(0x4000, 0x4fff));
$d = dechex(random_int(0x8000, 0xbfff));
$e = str_pad(dechex(random_int(0x0000_0000_0000, 0xffff_ffff_ffff)), '0', STR_PAD_LEFT);
return
"$a-$b-$c-$d-$e";
}
?>
To Top