PHP OpenID 認証。mixi でログイン。コードサンプル :【OpenID】

2010/11/14 : 更新しました
オリジナルのサンプルコードは少し使いづらいし、解りにくいと思うので
少し整理してみました。

ログインをどう設計するかによって使い方は変わると思いますが、
このほうがファイルが多くてもいろいろな仕様に対応しやすいと思います


※ このパッケージだけでは実行できません
( PHP OpenID library を使用しています )

OpenID を使用したログイン用のコードのサンプルです。

login.php と return.php は、サーバーの設定でエラーメッセージ
が出無い場合の対応の為に分割しています( nifty LaCoocan 等 )



共通
common.php
001.<?php
002.// *********************************************************
003.// デバッグ用ログファイルの位置
004.// ( コメントにすると、ログは出力されません )
005.// *********************************************************
006.$logfile = "./debug.log";
007.// *********************************************************
008.// 証明書の位置
009.// *********************************************************
010.$openid_pem = realpath("./cacert.pem");
011.// *********************************************************
012.// 作業ディレクトリの位置
013.// *********************************************************
014.$store_path = realpath("../") . DIRECTORY_SEPARATOR  . "_php_consumer_dir";
015.if (!file_exists($store_path) && !mkdir($store_path)) {
016.    print "保存用ディレクトリを作成できませんでした '$store_path'".
017.    " 書き込み権限をチェックして下さい";
018.    exit(0);
019.}
020. 
021.// *********************************************************
022.// OpenID 用 URL 文字列
023.// *********************************************************
024.$scheme = 'http';
025.if (isset($_SERVER['HTTPS']) and $_SERVER['HTTPS'] == 'on') {
026.    $scheme .= 's';
027.}
028. 
029.// 戻ってきた情報を受け取る場所
030.$return_to = "return.php";
031.$return_to =
032.    sprintf("%s://%s:%s%s/$return_to",
033.        $scheme, $_SERVER['SERVER_NAME'],
034.        $_SERVER['SERVER_PORT'],
035.        dirname($_SERVER['PHP_SELF'])
036.    );
037. 
038.// 呼び出し元のディレクトリ
039.$trust_root =
040.    sprintf("%s://%s:%s%s/",
041.        $scheme, $_SERVER['SERVER_NAME'],
042.        $_SERVER['SERVER_PORT'],
043.        dirname($_SERVER['PHP_SELF'])
044.    );
045. 
046.// *********************************************************
047.// HTTP ヘッダ
048.// *********************************************************
049.header( "Content-Type: text/html; Charset=shift_jis" );
050.header( "Expires: Wed, 31 May 2000 14:59:58 GMT" );
051. 
052.// *********************************************************
053.// デバッグログ開始位置
054.// *********************************************************
055.log_file("+++++++++++++++++++");
056.log_file("openid_pem=$openid_pem");
057.log_file("store_path=$store_path");
058.log_file("scheme=$scheme");
059.log_file("return_to=$return_to");
060.log_file("trust_root=$trust_root");
061. 
062.// *********************************************************
063.// Windows 環境とランダム要素(/dev/urandom)の対応
064.// *********************************************************
065.if ( substr( strtoupper( php_uname("s") ), 0, 7 ) == 'WINDOWS' ) {
066. 
067.    log_file("windowです");
068. 
069.    define('Auth_OpenID_RAND_SOURCE', NULL);
070.    if ( !extension_loaded( "curl" ) ) {
071.        log_file("php_curl.dll load");
072.//      dl("php_curl.dll"); 非推奨または定義されない関数
073.        exit("curl を使用できません");
074.    }
075.    if ( !extension_loaded( "openssl" ) ) {
076.        log_file("php_openssl.dll load");
077.//      dl("php_openssl.dll"); 非推奨または定義されない関数
078.        exit("openssl を使用できません");
079.    }
080.}
081.else {
082.    if ( @is_readable('/dev/urandom') ) {
083.    }
084.    else {
085.        define('Auth_OpenID_RAND_SOURCE', NULL);
086.    }
087.}
088. 
089.// *********************************************************
090.// include_path に、PHP OpenID Library の位置をセット
091.// *********************************************************
092.$path_extra = realpath("../openid2");
093.$path = ini_get('include_path');
094.$path = $path_extra . PATH_SEPARATOR . $path;
095.ini_set('include_path', $path);
096. 
097.// *********************************************************
098.// PHP OpenID Library ( 利用側 )
099.// *********************************************************
100.require_once "Auth/OpenID/Consumer.php";
101.require_once "Auth/OpenID/FileStore.php";
102.require_once "Auth/OpenID/SReg.php";
103.require_once "Auth/OpenID/PAPE.php";
104. 
105. 
106.// *********************************************************
107.// デバッグログ
108.// *********************************************************
109.function log_file($message) {
110.    if ( $GLOBALS['logfile'] != "" ) {
111.        error_log("$message\n", 3, $GLOBALS['logfile']);
112.    }
113.}
114. 
115.?>


mixi へ、リダイレクト前
ログイン済みのページは PHP 部分の先頭で以下の構成にする必要があります
( ログインされていない場合は、ログイン用のページを表示 )
index.php
01.<?
02.session_start();
03.header( "Content-Type: text/html; Charset=shift_jis" );
04.header( "Expires: Wed, 31 May 2000 14:59:58 GMT" );
05. 
06.if ( $_GET['logout'] != "" ) {
07.    $_SESSION['id'] = "";
08.    $_SESSION['nickname'] = "";
09.}
10. 
11.if ( $_SESSION['id'] == "" ) {
12.    // エラーメッセージを表示
13.    ini_set( 'display_errors', "1" );
14.     
15.    // ログインされていないので、ログインページを表示
16.    require_once( 'login_view.php' );
17. 
18. 
19.    exit();
20.}
21. 
22.?>
23.<HTML>
24.<HEAD>
25.<META http-equiv="Content-type" content="text/html; charset=shift_jis" />
26.<TITLE>ようこそ</TITLE>
27.<STYLE type="text/css">
28.* {
29.    font-size: 30px;
30.}
31.</STYLE>
32.<SCRIPT language="javascript" type="text/javascript">
33. 
34.</SCRIPT>
35.</HEAD>
36.<BODY>
37. 
38.<?
39.    if ( $_SESSION['nickname'] != '' ) {
40.        print "ようこそ {$_SESSION['nickname']} さん";
41.    }
42. 
43.?>
44.<br><br>
45.ID: <?= $_SESSION['id'] ?>
46. 
47.<FORM>
48.<INPUT type=submit name=logout value="ログアウト">
49.</FORM>
50.</BODY>
51.</HTML>
login_view.php
01.<HTML>
02.<HEAD>
03.<META http-equiv="Content-type" content="text/html; charset=shift_jis" />
04.<TITLE>ログイン</TITLE>
05.<STYLE type="text/css">
06.* {
07.    font-size: 16px;
08.}
09.</STYLE>
10.</HEAD>
11.<BODY>
12. 
13.<? if ( $_SESSION['id'] == "" ) { ?>
14.<A href="login.php?id=https%3A%2F%2Fmixi.jp"><IMG src="http://winofsql.jp/test/openid/openid_sample/login_btn002.gif" border=0></A>
15.<br><br>
16.<A href="login.php?id=https%3A%2F%2Fwww.google.com%2Faccounts%2Fo8%2Fid">Google でログイン</A>
17.<br><br>
18.<A href="login.php?id=https%3A%2F%2Fme.yahoo.co.jp">Yahoo でログイン</A>
19.<? } ?>
20. 
21.</BODY>
22.</HTML>
以下のページを login.php?id=https%3A%2F%2Fmixi.jp と指定して
リンクを作成できます。
( login.php 単独では何も表示されません。)

※ mixi 以外でも動くはずですので、実際は入力チェックが必要です
login.php
1.<?
2.session_start();
3.// エラーメッセージを表示
4.ini_set( 'display_errors', "1" );
5. 
6.// エラーメッセージ対象のコード
7.require_once( 'login_control.php' );
8.?>
login_control.php
01.<?php
02.require_once "common.php";
03. 
04.// *********************************************************
05.// 基本オブジェクト作成
06.// *********************************************************
07.$store = new Auth_OpenID_FileStore($store_path);
08.log_file(print_r($store,true));
09.$consumer = new Auth_OpenID_Consumer($store);
10.log_file(print_r($consumer,true));
11. 
12.// *********************************************************
13.// 対象
14.// *********************************************************
15.if ( $_GET['id'] != "" ) {
16.    $openid = $_GET['id'];
17.    log_file(print_r($openid,true));
18. 
19.    $error_message = "";
20.    $auth_request = $consumer->begin($openid);
21.    if (!$auth_request) {
22.        $error_message = "OpenID が正しくありません";
23.    }
24. 
25.    if ( $error_message == "" )  {
26.        // nickname 等が必要無い場合はここを実行する必要はない
27.        $sreg_request =
28.            Auth_OpenID_SRegRequest::build(
29.                // Required
30.                array('nickname'),
31.                // Optional
32.                array('fullname', 'email')
33.            );
34.        if ($sreg_request) {
35.            $auth_request->addExtension($sreg_request);
36.        }
37.        log_file(print_r($auth_request,true));
38.    }
39.     
40.    if ( $error_message == "" )  {
41.        if ($auth_request->shouldSendRedirect()) {
42.            $redirect_url =
43.                $auth_request->redirectURL( $trust_root, $return_to );
44. 
45.                if (Auth_OpenID::isFailure($redirect_url)) {
46.                    $error_message =
47.                        "サーバーにリダイレクトできません:"
48.                        . $redirect_url->message;
49.                }
50.                else {
51.                    log_file(print_r($redirect_url,true));
52.                    header("Location: ".$redirect_url);
53.                }
54.        }
55.        else {
56.            $form_id = 'openid_message';
57.            $form_html =
58.                $auth_request->htmlMarkup(
59.                    $trust_root, $return_to,
60.                    false,
61.                    array('id' => $form_id )
62.                );
63.         
64.            if (Auth_OpenID::isFailure($form_html)) {
65.                $error_message =
66.                    "サーバーにリダイレクトできません(HTML):"
67.                    . $form_html->message;
68.            }
69.            else {
70.                log_file(print_r($form_html,true));
71.                print $form_html;
72.            }
73.         
74.        }
75.    }
76.}
77. 
78.// リダイレクトされなかった場合の表示
79.require_once "login_view_message.php";
80. 
81.?>
JavaScript によってリダイレクトされるので以下のコードは
実際は必要ありません。しかし、「OpenID が正しくありません」
または、「サーバーにリダイレクトできません」を表示する必要
があるような場合は、使用すると良いでしょう。
login_view_message.pjp
01.<HTML>
02.<HEAD>
03.<META http-equiv="Content-type" content="text/html; charset=shift_jis" />
04.<TITLE>ログイン</TITLE>
05.<STYLE type="text/css">
06.* {
07.    font-size: 12px;
08.}
09.</STYLE>
10.</HEAD>
11.<BODY>
12. 
13.<?= $error_message ?>
14. 
15.</BODY>
16.</HTML>


mixi から戻って来てからの処理
return.php
1.<?
2.session_start();
3.// エラーメッセージを表示
4.ini_set( 'display_errors', "1" );
5. 
6.// エラーメッセージ対象のコード
7.require_once( 'return_control.php' );
8.?>
return_control.php
01.<?php
02.require_once "common.php";
03. 
04.// *********************************************************
05.// 基本オブジェクト作成
06.// *********************************************************
07.$store = new Auth_OpenID_FileStore($store_path);
08.log_file(print_r($store,true));
09.$consumer = new Auth_OpenID_Consumer($store);
10.log_file(print_r($consumer,true));
11. 
12.// *********************************************************
13.// 結果チェック
14.// *********************************************************
15.$error_message = "";
16.$response = $consumer->complete($return_to);
17.log_file(print_r($response,true));
18. 
19.if ($response->status == Auth_OpenID_CANCEL) {
20.    $error_message = 'キャンセルされました';
21.}
22.if ($response->status == Auth_OpenID_FAILURE) {
23.    $error_message = $response->message;
24.}
25.if ($response->status == Auth_OpenID_SUCCESS) {
26.    $start_message = "ログインされました";
27.    $_SESSION['id'] = $response->getDisplayIdentifier();
28. 
29.    $sreg_resp = Auth_OpenID_SRegResponse::fromSuccessResponse($response);
30.    log_file(print_r($sreg_resp,true));
31. 
32.    $sreg = $sreg_resp->contents();
33.    log_file(print_r($sreg,true));
34. 
35.    if (@$sreg['nickname']) {
36.        $_SESSION['nickname'] =
37.            mb_convert_encoding( $sreg['nickname'], "SHIFT_JIS", "UTF-8" );
38.    }
39. 
40.}
41. 
42. 
43.require_once "return_view.php";
44. 
45.?>
return_view.php
01.<HTML>
02.<HEAD>
03.<META http-equiv="Content-type" content="text/html; charset=shift_jis" />
04.<TITLE>ログイン</TITLE>
05.<STYLE type="text/css">
06.* {
07.    font-size: 12px;
08.}
09.</STYLE>
10.</HEAD>
11.<BODY>
12. 
13.<A href="login.php?id=https%3A%2F%2Fmixi.jp"><IMG src="http://winofsql.jp/test/openid/openid_sample/login_btn002.gif" border=0></A>
14.<br>
15.<B><?= $error_message ?></B>
16. 
17.<? if ( $error_message == '' ) { ?>
18.<SCRIPT type="text/javascript">
19.    window.location = "index.php";
20.</SCRIPT>
21.<? } ?>
22.</BODY>
23.</HTML>