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

# random_int

(PHP 7, PHP 8)

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

### 説明

function 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`

  返される最大値。

### 戻り値

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

### エラー / 例外

- 適切な不規則性のソースが見つからない場合は Random\RandomException をスローします。
- `max` が `min` より小さい場合、 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)

### 参考

- Random\Randomizer::getInt() - 等確率に選ばれる整数を取得する
- random_bytes() - 暗号学的にセキュアな、ランダムなバイト列を生成する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open