Kit SecureRandomダウンロード - Kit SecureRandomソースコードのダウンロード

Kit SecureRandom

その他のカテゴリー

Version 1.3.1

ダウンロード

安全なランダムジェネレーター

SecureRandomは、安全な乱数を生成し、配列のシャッフルやパスワードなどの文字列シーケンスの生成などの一般的なランダム化操作にそれらを使用するための PHP ライブラリです。バージョン 7.0 より前の PHP には安全なランダム関数が組み込まれていませんでしたが、安全なランダム値を生成するためにさまざまな乱数ソースを使用することは可能でした。したがって、このライブラリには 2 つの主な目的があります。

さまざまなプラットフォームや PHP バージョンにわたる安全なランダム性のさまざまなソースに共通のインターフェイスを提供するため
乱数のソースを適切に使用して乱数値を生成したり、一般的なランダム配列操作を実行したりすることが容易になります。

このライブラリは、追加の安全なランダムバイトジェネレーターを提供しません。拡張機能または内部的に PHP で利用できるバイトジェネレーターを使用するだけです。 PHP で一般的に利用できる 4 つのジェネレーターは次のとおりです。

PHP 7.0 が提供する CSPRNG 関数
ランダムデバイス/dev/(u)randomからの読み取り
mcrypt_create_iv()関数の呼び出し
openssl_random_pseudo_bytes()関数の呼び出し

このライブラリによって生成されるランダム性のセキュリティは、基礎となるランダムバイトジェネレーターに完全に依存しています。ライブラリは、乱数の均等な分布を生成するために必要な正規化以外に、バイトに対して追加の変換を行いません。

API ドキュメントは http://kit.riimu.net/api/securerandom/ から入手できます。

要件

サポートされる最小 PHP バージョンは 5.6 です
ライブラリは次の PHP 拡張機能に依存します。
- OpenSSL (OpenSSQL ジェネレーターを使用する場合)
- Mcrypt (Mcrypt ジェネレーターを使用するため)
Random リーダージェネレーターを使用するには、 /dev/urandom読み取り可能である必要があります。

インストール

Composer を使用したインストール

このライブラリをインストールする最も簡単な方法は、Composer を使用して依存関係を処理することです。 Composer 経由でこのライブラリをインストールするには、次の 2 つの手順に従ってください。

プロジェクトルートで Composer コマンドラインインストールを実行して、 composer.pharを取得します。
インストールスクリプトを実行すると、 composer.pharファイルがプロジェクトルートに存在し、次のコマンドを実行できるようになります。
```
 php composer.phar require "riimu/kit-securerandom:^1.3"
```

Composer 経由でこのライブラリをインストールした後、インストール中に Composer によって生成されたvendor/autoload.phpファイルを含めることでライブラリをロードできます。

ライブラリを依存関係として追加する

Composer の使用方法にすでに慣れている場合は、次のcomposer.jsonファイルをプロジェクトに追加し、 composer installコマンドを実行することで、ライブラリを依存関係として追加することもできます。

{
    "require" : {
        "riimu/kit-securerandom" : " ^1.3 "
    }
}

手動インストール

Composer を使用してライブラリをロードしたくない場合は、最新リリースをダウンロードし、 srcフォルダーをプロジェクトに抽出することで、ライブラリを手動でダウンロードすることもできます。次に、提供されたsrc/autoload.phpファイルをインクルードして、ライブラリクラスをロードできます。

使用法

ライブラリの使い方はとても簡単です。 SecureRandomのインスタンスを作成し、いずれかのメソッドを呼び出してランダムな値を生成するだけです。例えば：

 <?php

require ' vendor/autoload.php ' ;
$ rng = new  Riimu  Kit  SecureRandom  SecureRandom ();

var_dump ( base64_encode ( $ rng -> getBytes ( 32 )));     // Returns a random byte string
var_dump ( $ rng -> getInteger ( 100 , 1000 ));           // Returns a random integer between 100 and 1000
var_dump ( $ rng -> getFloat ());                      // Returns a random float between 0 and 1
var_dump ( $ rng -> getRandom ());                     // Returns a random float between 0 and 1 (not including 1)
var_dump ( $ rng -> getArray ( range ( 0 , 100 ), 5 ));      // Returns 5 randomly selected elements from the array
var_dump ( $ rng -> choose ( range ( 0 , 100 )));           // Returns one randomly chosen value from the array
var_dump ( $ rng -> shuffle ( range ( 0 , 9 )));            // Returns the array in random order
var_dump ( $ rng -> getSequence ( ' 01 ' , 32 ));           // Returns a random sequence of 0s and 1s with length of 32
var_dump ( $ rng -> getSequence ([ ' a ' , ' b ' , ' c ' ], 5 )); // Returns an array with 5 elements randomly chosen from 'a', 'b', and 'c'
var_dump ( $ rng -> getUuid ());                       // Returns a random version UUID, e.g. '00056a74-036b-47c5-ab35-6f34a41a70ae'

ランダムな方法

SecureRandomでは、ランダム性を取得するために次のメソッドを使用できます。

getBytes($count) $count に等しい長さのランダムなバイトの文字列を返します。
getInteger($min, $max)指定された 2 つの正の整数 (両端を含む) の間のランダムな整数を返します。
getFloat() 0 と 1 (両端を含む) の間のランダムな浮動小数点値を返します。
getRandom() 52 ビットの精度を持つ 0 から 1 までのランダムな浮動小数点値を返します。そのため、戻り値は常に 1 未満になります。 getFloat()と比較して、値の分布はより均一であり、 PHP_INT_MAXに依存しません。
getArray(array $array, $count)指定された配列からランダムな要素の数を返します。要素の順序はランダムですが、キーは保持されます。
choose(array $array)配列から選択されたランダムな値を返します。
shuffle(array $array)ランダムな順序で配列を返します。キーは保存されます。
getSequence($choices, $length)値または文字のランダムなシーケンスを返します。選択肢は文字列または配列として指定できます。戻り値の型は、選択肢の型によって異なります。
getUuid()ランダムなバージョン 4 の普遍的に一意の識別子を返します。 UUID は、ランダムかつ独立して生成できる一意の識別子であり、衝突の可能性は非常に低いです。 UUID の例は00056a74-036b-47c5-ab35-6f34a41a70aeです。

/dev/random に関する注意事項

このライブラリによって提供されるジェネレーターは、デフォルトで/dev/urandomランダム性ソースとして使用します。 /dev/randomからの読み取りは、一般的な PHP Web アプリケーションに追加のセキュリティを提供するものではなく、ブロックする性質があるため、そのような目的には非常に適していません。

代わりに/dev/randomから読み取る必要がある正当なケースはほとんどありません。これは主に、 /dev/urandomがまだ適切にシードされていないことが懸念される場合に当てはまります。ただし、これはシステムの起動時にのみ問題が発生する傾向があるため、Web アプリケーションの場合は通常は当てはまりません。

/dev/randomから読み取る必要があることが絶対にわかっている場合は、コンストラクターパラメーターを false に設定し、コンストラクターでSecureRandomにジェネレーターを提供することにより、代わりにランダムソースとして使用するようにRandomReaderとMcrypt設定することができます。例えば：

 <?php

require ' vendor/autoload.php ' ;
$ generator = new  Riimu  Kit  SecureRandom  Generator  RandomReader ( false );
$ rng = new  Riimu  Kit  SecureRandom  SecureRandom ( $ generator );

利用可能なランダムジェネレータ

SecureRandomが作成されると、現在のプラットフォームでサポートされているものに応じて、利用可能な安全なランダムジェネレーターの 1 つを使用しようとします。次のランダムソースが利用可能で、次の順序で試行されます。

GeneratorInternal PHP 7.0 で利用可能な内部関数を使用します。
GeneratorRandomReaderランダムなデバイス/dev/urandomからバイトを読み取るだけです。
GeneratorMcrypt mcrypt_create_iv()使用して、 MCRYPT_DEV_URANDOMをソースとしてランダムバイトを生成します。
GeneratorOpenSSL openssl_random_pseudo_bytes()使用してランダムなバイトを生成します。

OpenSSL で使用されるアルゴリズムが実際に暗号的に強力であるかどうかについては、いくつかの議論があります。ただし、それに対する具体的な証拠が不足していることと、PHP マニュアルでその強度が示唆されているため、このライブラリは、さまざまなプラットフォーム間でより良い互換性を実現するために、デフォルトで OpenSSL を最後のフォールバックとして使用します。

バイトジェネレーターを明示的に定義したい場合は、それをSecureRandomのコンストラクターパラメーターとして指定できます。例えば：

 <?php

require ' vendor/autoload.php ' ;
$ rng = new  Riimu  Kit  SecureRandom  SecureRandom (
    new  Riimu  Kit  SecureRandom  Generator  Mcrypt ()
);