Documentation

導入 - Zend_Auth

導入

Zend_Auth は、認証のための API を提供します。 また、一般的な使用例に対応する具象認証アダプタも用意しています。

Zend_Auth が扱うのはあくまでも 認証 (authentication) であり、承認 (authorization) ではありません。 認証 (authentication) とはつまり、あるエンティティが何者であるのかを示す (識別する) ことです。これを、なんらかの条件にもとづいて行います。 承認 (authorization) とは、あるエンティティが他のエンティティに対して アクセスしたり何らかの操作をしたりする権限があるかどうかを判定する処理です。 これは Zend_Auth の対象外となります。 Zend Framework における認証やアクセス制御の詳細については、 Zend_Acl を参照ください。

Note: Zend_Auth クラスはシングルトンパターン (クラスのインスタンスは常にひとつだけ) を実装しており、静的メソッド getInstance() でそれを使用します。 つまり、new 演算子や clone キーワードは Zend_Auth クラスでは動作しないということです。そのかわりに Zend_Auth::getInstance() を使用します。

アダプタ

Zend_Auth アダプタの使用目的は、 LDAPRDBMS あるいはファイル のような特定の型の認証サービスに対する認証を行うことです。 アダプタによってそのオプションや挙動は大きくことなるでしょうが、 いくつかの基本処理は、あらゆる認証アダプタで共通となります。 たとえば認証条件 (いわゆる ID) を受け取り、 認証サービスに対する問い合わせを行い、 結果を返すという処理は、すべての Zend_Auth アダプタで共通です。

Zend_Auth アダプタクラスは、Zend_Auth_Adapter_Interface を実装しています。このインターフェイスで定義されているメソッドが authenticate() で、アダプタクラスは 認証クエリを実行するためにこれを実装する必要があります。 各アダプタクラスは、 authenticate() をコールする前に準備を済ませておく必要があります。 つまり、アダプタ側で用意しなければならない機能としては 認証条件 (ユーザ名およびパスワードなど) の取得や アダプタ固有のオプションの設定 (データベースのテーブルを使用するアダプタならデータベースへの接続設定など) があるということです。

以下にあげるのは認証アダプタのサンプルで、 これはユーザ名とパスワードを受け取って認証を行います。 その他の詳細、例えば認証サービスへの実際の問い合わせなどは、 例を簡潔にするため省略しています。

  1. class MyAuthAdapter implements Zend_Auth_Adapter_Interface
  2. {
  3.     /**
  4.      * 認証用のユーザ名とパスワードを設定します
  5.      *
  6.      * @return void
  7.      */
  8.     public function __construct($username, $password)
  9.     {
  10.         // ...
  11.     }
  12.  
  13.     /**
  14.      * 認証を試みます
  15.      *
  16.      * @throws Zend_Auth_Adapter_Exception が、認証処理をできなかった場合に発生します
  17.      * @return Zend_Auth_Result
  18.      */
  19.     public function authenticate()
  20.     {
  21.         // ...
  22.     }
  23. }

docblock コメントで説明しているとおり、 authenticate()Zend_Auth_Result (あるいは Zend_Auth_Result の派生クラス) のインスタンスを返す必要があります。何らかの理由で認証の問い合わせができなかった場合は、 authenticate()Zend_Auth_Adapter_Exception から派生した例外をスローしなければなりません。

結果

Zend_Auth アダプタは、 authenticate() の結果として Zend_Auth_Result のインスタンスを返します。 これにより、認証を試みた結果を表します。アダプタのインスタンスを作成した際に Zend_Auth_Result オブジェクトが作成され、 以下の 4 つのメソッドで Zend_Auth アダプタの結果に対する共通の操作ができます。

  • isValid() - その結果が 認証の成功を表している場合にのみ TRUE を返します。

  • getCode() - Zend_Auth_Result の定数を返します。 これは、認証に失敗したのか成功したのかを表すものです。 これを使用する場面としては、認証の結果をいくつかの結果から区別したい場合などがあります。 これにより、たとえば認証結果について、より詳細な情報を管理することができるようになります。 別の使用法としては、ユーザに示すメッセージを変更し、より詳細な情報を伝えられるようにすることなどがあります。 しかし、一般的な「認証失敗」メッセージではなく ユーザに対して詳細な情報を示す際には、そのリスクを知っておくべきです。 詳細な情報は、以下の注意を参照ください。

  • getIdentity() - 認証を試みた ID 情報を返します。

  • getMessages() - 認証に失敗した場合に、 関連するメッセージの配列を返します。

認証の結果によって処理を分岐させ、より決め細やかな処理を行いたいこともあるでしょう。 有用な処理としては、たとえば間違ったパスワードを繰り返し入力したアカウントをロックしたり、 存在しない ID を何度も入力した IP アドレスに印をつけたり、 ユーザに対してよりわかりやすいメッセージを返したりといったことがあります。 次の結果コードが使用可能です。

  1. Zend_Auth_Result::SUCCESS
  2. Zend_Auth_Result::FAILURE
  3. Zend_Auth_Result::FAILURE_IDENTITY_NOT_FOUND
  4. Zend_Auth_Result::FAILURE_IDENTITY_AMBIGUOUS
  5. Zend_Auth_Result::FAILURE_CREDENTIAL_INVALID
  6. Zend_Auth_Result::FAILURE_UNCATEGORIZED

次の例は、結果コードを処理する方法を示すものです。

  1. // AuthController / loginAction の中の処理
  2. $result = $this->_auth->authenticate($adapter);
  3.  
  4. switch ($result->getCode()) {
  5.  
  6.     case Zend_Auth_Result::FAILURE_IDENTITY_NOT_FOUND:
  7.         /** ID が存在しない場合の処理 **/
  8.         break;
  9.  
  10.     case Zend_Auth_Result::FAILURE_CREDENTIAL_INVALID:
  11.         /** 認証に失敗した場合の処理 **/
  12.         break;
  13.  
  14.     case Zend_Auth_Result::SUCCESS:
  15.         /** 認証に成功した場合の処理 **/
  16.         break;
  17.  
  18.     default:
  19.         /** その他の原因で失敗した場合の処理 **/
  20.         break;
  21. }

ID の永続性

認証情報 (パスワードなど) を含む認証を要求するのは便利なものですが、 リクエストごとにいちいち認証情報を引き回すのではなく、 認証済みの ID を保持し続けることも重要です。

HTTP はステートレスなプロトコルです。しかし、 クッキーやセッションといった技術によって、 サーバサイドのウェブアプリケーションでも 複数リクエスト間でステート (状態) を保持し続けられるようになりました。

PHP セッションにおけるデフォルトの持続性

デフォルトでは、Zend_Auth は、 認証に成功した際の ID 情報を PHP のセッションを使用して保存します。 認証に成功すると、 Zend_Auth::authenticate() は認証結果を持続ストレージに保存します。何も指定しなければ、 Zend_Auth が使用するストレージクラスは Zend_Auth_Storage_Session となります。これは Zend_Session を使用しています。 独自のクラスを使用するには、Zend_Auth_Storage_Interface を実装したクラスのオブジェクトを Zend_Auth::setStorage() で設定します。

Note: もし ID が自動的に持続ストレージに保存されるのが気に入らない場合は、 Zend_Auth クラスをまるごと使用するのを控え、 アダプタクラスを直接使用します。

Example #1 セッション名前空間の変更

Zend_Auth_Storage_Session は、セッション名前空間として 'Zend_Auth' を使用します。これを変更するには、別の値を Zend_Auth_Storage_Session のコンストラクタで指定します。 この値が、内部で Zend_Session_Namespace のコンストラクタに渡されます。これは認証を試みる前に行う必要があります。 なぜなら、 Zend_Auth::authenticate() は ID を自動的に保存するからです。

  1. // Zend_Auth のシングルトンインスタンスへの参照を保存します
  2. $auth = Zend_Auth::getInstance();
  3.  
  4. // 'Zend_Auth' のかわりに 'someNamespace' を使用します
  5. $auth->setStorage(new Zend_Auth_Storage_Session('someNamespace'));
  6.  
  7. /**
  8. * @todo 認証アダプタ $authAdapter を設定します
  9. */
  10.  
  11. // 認証と結果の保存、そして成功時に ID を持続させます
  12. $result = $auth->authenticate($authAdapter);

独自のストレージの実装

Zend_Auth_Storage_Session とは異なる形式で、 ID を持続させたくなることもあるでしょう。そのような場合は、 Zend_Auth_Storage_Interface を実装したクラスのインスタンスを Zend_Auth::setStorage() で設定します。

Example #2 独自のストレージクラスの使用法

ID を持続させるストレージクラスを Zend_Auth_Storage_Session の代わりに使用するには、 Zend_Auth_Storage_Interface を実装します。

  1. class MyStorage implements Zend_Auth_Storage_Interface
  2. {
  3.     /**
  4.      * ストレージが空の場合にのみ true を返す
  5.      *
  6.      * @throws Zend_Auth_Storage_Exception 空かどうか判断できないとき
  7.      * @return boolean
  8.      */
  9.     public function isEmpty()
  10.     {
  11.         /**
  12.          * @todo 実装が必要
  13.          */
  14.     }
  15.  
  16.     /**
  17.      * ストレージの中身を返す
  18.      *
  19.      * ストレージが空の場合に挙動は未定義
  20.      *
  21.      * @throws Zend_Auth_Storage_Exception ストレージの中身を読み込めない場合
  22.      * @return mixed
  23.      */
  24.     public function read()
  25.     {
  26.         /**
  27.          * @todo 実装が必要
  28.          */
  29.     }
  30.  
  31.     /**
  32.      * $contents をストレージに書き込む
  33.      *
  34.      * @param  mixed $contents
  35.      * @throws Zend_Auth_Storage_Exception $contents をストレージに書き込めない場合
  36.      * @return void
  37.      */
  38.     public function write($contents)
  39.     {
  40.         /**
  41.          * @todo 実装が必要
  42.          */
  43.     }
  44.  
  45.     /**
  46.      * ストレージの中身を消去する
  47.      *
  48.      * @throws Zend_Auth_Storage_Exception ストレージの中身を消去できない場合
  49.      * @return void
  50.      */
  51.     public function clear()
  52.     {
  53.         /**
  54.          * @todo 実装が必要
  55.          */
  56.     }
  57. }

このストレージクラスを使用するには、認証クエリの前に Zend_Auth::setStorage() を実行します。

  1. // Zend_Auth に、独自のストレージクラスを使うよう指示します
  2. Zend_Auth::getInstance()->setStorage(new MyStorage());
  3.  
  4. /**
  5. * @todo 認証アダプタ $authAdapter を設定します
  6. */
  7.  
  8. // 認証と結果の保存、そして成功時に ID を持続させます
  9. $result = Zend_Auth::getInstance()->authenticate($authAdapter);

使用法

Zend_Auth の使用法には、次の二通りがあります。

  1. 間接的に Zend_Auth::authenticate() 経由で使用する

  2. 直接、アダプタの authenticate() メソッドを使用する

次の例は、Zend_Auth アダプタを間接的に Zend_Auth クラスから使用するものです。

  1. // Zend_Auth のシングルトンインスタンスへの参照を取得します
  2. $auth = Zend_Auth::getInstance();
  3.  
  4. // 認証アダプタを設定します
  5. $authAdapter = new MyAuthAdapter($username, $password);
  6.  
  7. // 認証を試み、その結果を取得します
  8. $result = $auth->authenticate($authAdapter);
  9.  
  10. if (!$result->isValid()) {
  11.     // 認証に失敗したので、原因を表示します
  12.     foreach ($result->getMessages() as $message) {
  13.         echo "$message\n";
  14.     }
  15. } else {
  16.     // 認証に成功しました。ID ($username) がセッションに保存されます
  17.     // $result->getIdentity() === $auth->getIdentity()
  18.     // $result->getIdentity() === $username
  19. }

上の例においてリクエスト内で認証が行われると、 認証に成功した際にその ID を取得するのは簡単なことです。

  1. $auth = Zend_Auth::getInstance();
  2. if ($auth->hasIdentity()) {
  3.     // ID があるのでそれを取得します
  4.     $identity = $auth->getIdentity();
  5. }

永続ストレージから認証 ID を削除するには、単純に clearIdentity() メソッドを使用します。 これは、アプリケーションの "ログアウト" 処理を実装するためのものです。

  1. Zend_Auth::getInstance()->clearIdentity();

自動的に永続ストレージが用いられるのがまずい場合もあるでしょう。 そんな場合は、Zend_Auth クラスをバイパスして アダプタクラスを直接使用します。 アダプタクラスを直接使用するとは、アダプタオブジェクトの設定と準備を行い、 その authenticate() メソッドをコールするということです。 アダプタ固有の詳細情報については、各アダプタのドキュメントで説明します。 以下の例は、MyAuthAdapter を直接使用するものです。

  1. // 認証アダプタを設定します
  2. $authAdapter = new MyAuthAdapter($username, $password);
  3.  
  4. // 認証を試み、その結果を取得します
  5. $result = $authAdapter->authenticate();
  6.  
  7. if (!$result->isValid()) {
  8.     // 認証に失敗したので、原因を表示します
  9.     foreach ($result->getMessages() as $message) {
  10.         echo "$message\n";
  11.     }
  12. } else {
  13.     // 認証に成功しました
  14.     // $result->getIdentity() === $username
  15. }

Copyright

© 2006-2021 by Zend by Perforce. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts