ZF Zend Framework

Behind the Site

Programmer's Reference Guide

導入
Zend_Gdata
プログラマ向けリファレンスガイド

AuthSub による認証

AuthSub を使用すると、ウェブアプリケーションで Google Data サービスへのアクセスのための認証ができるようになります。 ユーザの認証情報を処理するコードを自分で書く必要はありません。

Google Data AuthSub 認証についての詳細は、 » http://code.google.com/apis/accounts/AuthForWebApps.html を参照ください。

Google のドキュメントでは、ClientLogin 方式は "インストールするアプリケーション" に適しており、一方 AuthSub は "ウェブアプリケーション" に適しているとされています。 これらの違いは、AuthSub はユーザとのやりとりが発生するということです。 ブラウザのインターフェイスを用いて、リクエストのリダイレクトを行います。 ClientLogin では PHP のコードでアカウント情報を提供します。 ユーザが直接認証情報を入力する必要がなくなります。

AuthSub の場合の認証情報は、ウェブアプリケーションのユーザが入力します。 つまり、認証情報をユーザが知っておく必要があります。

注意: 登録されたアプリケーション
 Zend_Gdata は、現在はセキュアなトークンの使用をサポートしていません。 なぜなら、デジタル証明書によるセキュアなトークンの取得を AuthSub 認証がサポートしていないからです。

AuthSub 認証済みの Http クライアントの作成

あなたの作成した PHP アプリケーションで、認証を行う Google URL へのハイパーリンクを提供しなければなりません。そのためには 静的関数 Zend_Gdata_AuthSub::getAuthSubTokenUri() を使用します。この関数の引数には、あなたの作成した PHP アプリケーションの URL を指定します。それにより、ユーザ認証の後に Google からもとの場所にリダイレクトされるようになります。

Google の認証サーバからアプリケーションに戻ってくる際に、 token という名前の GET パラメータが設定されます。 このパラメータの値は、認証されたアクセスに使用する single-use トークンとなります。 このトークンを multi-use トークンに変換し、セッションに保存します。

そしてそのトークンの値は使用して Zend_Gdata_AuthSub::getHttpClient() をコールします。この関数は Zend_Http_Client のインスタンスを返します。このインスタンスには適切なヘッダが設定されており、 後でこの Http クライアントを使用して送信したリクエストは認証済みのものとなります。

以下の例は、PHP のウェブアプリケーションのコードです。 Google Calendar サービスに対する認証を行い、 認証済みの Http クライアントを使用して Zend_Gdata クライアントオブジェクトを作成します。

  1. $my_calendar = 'http://www.google.com/calendar/feeds/default/private/full';
  2.  
  3. if (!isset($_SESSION['cal_token'])) {
  4.     if (isset($_GET['token'])) {
  5.         // single-use トークンをセッショントークンに変換します
  6.         $session_token =
  7.             Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
  8.         // セッショントークンをセッションに保存します
  9.         $_SESSION['cal_token'] = $session_token;
  10.     } else {
  11.         // single-use トークンを生成するためのリンクを表示します
  12.         $googleUri = Zend_Gdata_AuthSub::getAuthSubTokenUri(
  13.             'http://'. $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI'],
  14.             $my_calendar, 0, 1);
  15.         echo "<a href='$googleUri'>ここ</a> " .
  16.              "をクリックして認証を行います。";
  17.         exit();
  18.     }
  19. }
  20.  
  21. // Google とやり取りするための、認証済み HTTP クライアントを作成します
  22. $client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['cal_token']);
  23.  
  24. // 認証済み Http クライアントを使用して Gdata オブジェクトを作成します
  25. $cal = new Zend_Gdata_Calendar($client);

AuthSub 認証の解除

指定したトークンによる認証状態を終わらせるには、静的関数 Zend_Gdata_AuthSub::AuthSubRevokeToken() を使用します。そうしないと、このトークンはいつまでも有効なままになります。

  1. // アプリケーションのセキュリティ問題を避けるため、注意してこの値を作成します
  2. $php_self = htmlentities(substr($_SERVER['PHP_SELF'],
  3.                          0,
  4.                          strcspn($_SERVER['PHP_SELF'], "\n\r")),
  5.                          ENT_QUOTES);
  6.  
  7. if (isset($_GET['logout'])) {
  8.     Zend_Gdata_AuthSub::AuthSubRevokeToken($_SESSION['cal_token']);
  9.     unset($_SESSION['cal_token']);
  10.     header('Location: ' . $php_self);
  11.     exit();
  12. }

注意: セキュリティについて
 上の例における $php_self の扱い方は、 一般的なセキュリティ問題の対応法に従ったものです。 Zend_Gdata に固有のものではありません。 http ヘッダに出力する内容は、つねにフィルタリングするようにしましょう。
認証トークンの解除については、ユーザが Google Data セッションを終わらせたときに行うのがお勧めです。 だれかがトークンを盗んで悪用するという可能性は非常に小さいものです。 とは言え、サービスの利用が終わったら認証も終了させておくことは大切です。

導入
Zend_Gdata
プログラマ向けリファレンスガイド
blog comments powered by Disqus

Select a Version

Languages Available

Components

Search the Manual

    • Navigation