try_auth.phpとcommon.php

try_auth.phpとcommon.php

　try_auth.phpの基本となるファクションは、run()です。とてもシンプルに書かれており、機能としては図3-1のようになります。つまり「openid_identifierを取得して、いくつかリクエストを追加して、リダイレクトをする」といった基本的な動きが記述されています。それ以外のエラー処理ももちろん入っています。

　すぐにわかると思いますが、ディスカバリーや第3回で説明したアソシエーションといったコアな機能は、try_auth.phpの中には書かれておらず、Auth以下のファイルに入っています。今回はAuth以下の説明は割愛します。

　なお、Auth以下のファイルをカスタマイズする場合、デフォルトではエラーメッセージがすべて英語になるため、日本語に変更したり、sregやpapeなどの追加リクエストの部分を削除するとよいでしょう。

　次に、common.phpを見てみます。

　ファイルの前半のdoIncludes()という機能で、Auth以下のファイルをインクルードしています。中盤の&getStoreという機能で、OpenIDの情報をストアするためのファイルを指定します。デフォルトは以下のようになっています。もしストアする場所を変えたい場合はここをカスタマイズします。もちろんデータベースにストアすることもできます。

$store_path = "/tmp/_php_consumer_test";

　最後の2つの機能で、OPからリダイレクトバックされるパスと、Trust Rootを指定します。まず、getReturnTo()ですが、デフォルトで図3-2のようになっています。

　通常ポート番号は指定する必要がないためコメントアウトしたり、ファイル名を任意のファイル名に変更します。成功後ページのファイルを別のディレクトリに置いている場合はディレクトリ名も変えます。例として、ポートをコメントアウトして、ファイル名を変更した例を図3-3に示します。

　次にTrust Rootですが、これはPRのルートURLです。OpenID 2.0ではRealmという用語が使われています。これも必要に応じてポート番号をコメントアウトします。
 

finish_auth.php

　最後は、finish_auth.phpです。これは、認証が成功した後の処理、成功しない場合の処理が書いてあります。デフォルトでは成功すると下記のようなメッセージが表示されます。

You have successfully verified https://me.yahoo.co.jp/a/SaIt.ggdaZ5IxP0BGRk.rorg3rvNqHLMJZEJ81xY.DoupN-- as your identity.

　ここもカスタマイズすれば、メッセージの内容を変更したり、メッセージを日本語化したりすることができます。デフォルトでは、$successという変数にメッセージを追加して、最後にindex.phpをインクルードしてその中でメッセージとしてまとめて表示しています。よって、index.phpではなくて、別のファイルをインクルードすれば成功後の見え方をカスタマイズすることができます。

　ここまで、サンプルコードのカスタマイズについて説明しましたが、実際は、新規登録とログインの処理もかかわってきますし、OpenIDを利用しない一般ユーザーのシナリオも考えなければいけません。それについてはまた別の機会で考えたいと思います。

　さて、4回にわたってOpenIDの概要について紹介してきましたが、いかがでしたでしょうか。エンジニアでセキュリティーに詳しい方にとっては物足りなかったかもしれませんが、初めての方にも理解してもらいやすいようになるべく平易に書いたつもりです。導入を考えている方は、まずはサンプルコードで遊んで見ることをお勧めします。