PHP 8.1.15 Released!

random_int

(PHP 7, PHP 8)

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

説明

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

ポーカーゲームやカードデッキのシャッフルのような、 偏りがない結果が重要になる用途に合う、 暗号学的にランダムな整数を生成します。

この関数が使う不規則性のソースは次のとおりです。

  • Windows では、常に » CryptGenRandom() を使います。PHP 7.2.0 以降は、常に » CNG-API を使うようになりました。
  • Linux では、システムコール » getrandom(2) があればそれを使います。
  • その他のプラットフォームでは、 /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 3 notes

up
14
s rotondo90 at gmail com
6 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
7
ccb_bc at hotmail dot com
3 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
3
bens at effortlessis dot com
2 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.
To Top