Crypt クラス

Crypt クラスにより文字列を暗号化や複号が可能になります。例えば、 Sessions クラスにおいても Crypt クラスが内部で使用されています。

PHPSecLib により提供される暗号化とハッシング関数が使われているため、 mcrypt のような外部モジュールに依存していません。

使用法

Crypt は 2 通りの方法で使用できます： Crypt クラスの静的な使用と、 Crypt::forge() または Crypt::instance() メソッドが返す Crypt オブジェクトです。 このセクションでは、 設定で指定された構成を使用して、デフォルトのインスタンスで常に動作する静的な使用法をカバーしています。

Crypt オブジェクトの使い方、 Crypt::instance() および Crypt::forge() は高度な使用法セクションで説明されています。

encode($value, $key = false)

encode メソッドは文字列を暗号化します。オプションとして暗号キーが設定できます。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$value 必須 エンコードする文字列。
$key 
false
 エンコードに使われる任意のキー。false の場合、設定値である 'crypto_key' が適用されます。
返り値 string
例 
// カスタムキーにより変数をエンコードする
		$value = Crypt::encode($value, 'R@nd0mK~Y');

decode($value, $key = false)

decode メソッドは文字列を複号します。オプションとして暗号キーが設定できます。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$value 必須 デコードされる文字列。
$key 
false
 デコードに使われる任意のキー。false の場合、設定値である 'crypto_key' が適用される。
返り値 mixed - デコードされた文字列か、デコードできなかった場合は false を返します。
例 
// カスタムキーにより変数をデコードする
$value = Crypt::decode($value, 'R@nd0mK~Y');