PHP + Twitter API : 資格情報の確認とアプリケーションに割り当てられた My Access Token

目的

2010/05/29

1) JSON の結果を見やすくしました
2) HTTP のやりとりが解るように、debug.txt と ret_header.txt を出力するようにしました

これ自体、認証データが正しく使えるものかどうかチェックするのに使えますが、他の API のテストをする前に
これを単独でテストしておけば、問題をできる限り回避できると思います。

そもそも、認証プロセスを最初からテストしようとすると煩雑なので、
アプリケーションに最初から割り当てられている Access Token を利用します

このトークンは、使用すると自分のアカウントに登録されますが、解除するとアクセス
トークンはリセットされるので注意して下さい。

Twitter の画面の一番下
▼現在

▼以前の場合

ログインしている状態でページ上部
Twitter_mytoken2

自分のアプリケーションを選択
Twitter_mytoken3

右サイドバーに My Access Token
Twitter_mytoken4

登録済アクセストークン
Twitter_mytoken5

verify_credentials.php

Twitter のOAuth のライブラリはいくつか見ましたが、どれもクラス化されている為に、本来の仕様と照らしあわせるのが困難でした。内容としては非常に単純な手順であるのにも関わらず、ソースコードを追っていくのは結構面倒でした。

url_rfc3986　の内部関数にしても、今後結構重要なので裏付けも取りました。しっかりと仕様を原文で押さえてはいませんが、既存のコードやインターネット上の情報を総合するとPHP 5.3.x 以降では rawurlencode で問題無いものと思われます。

チルダの変換は実際両方で実行して比較しましたし、また、スペースが %20 になるのは元々で、既存のコードによっては、+ を %20 に変換していたものもありましたが、rawurlencodeでは無く、urlencode や http_build_query の場合に必要になるはずです。

この API を使うに当たって一番重要なのは、左辺と右辺は全て rfc3986 のパーセントエンコーディングが必要であるという事ですが、結果的に本来の状態に対して適用するものなので、QueryString や POST の本文内は2重にパーセントエンコーディングされる事になります。( この verify_credentials ではそのような対象文字列はありません )

<?
// **********************************************************
// 資格情報の確認 ( verify_credentials )
// **********************************************************
header( "Content-Type: text/html; Charset=utf-8" );
header( "pragma: no-cache" );
header( "Expires: Wed, 31 May 2000 14:59:58 GMT" );
header( "Cache-control: no-cache" );
 
// **********************************************************
// OAuth 用の urlencode 関数
// **********************************************************
function url_rfc3986( $str ) {
    // php 5.3.x ～ ではこの変換は必要無く、rawurlencode で OK
    return str_replace('%7E', '~', rawurlencode($str));
}
 
// **********************************************************
// API
// **********************************************************
$twitter_url = 'https://api.twitter.com/1/account/verify_credentials.json';
 
// **********************************************************
// 認証データ
// **********************************************************
$oauth_consumer_key = "Consumer key";
$oauth_consumer_secret = "Consumer secret";
$oauth_token = "Access Token";
$oauth_secret = "Access Token Secret";
 
// 毎回変化するランダムな文字列
$mt = microtime();
$rand = mt_rand();
$oauth_nonce = md5($mt . $rand);
 
$oauth_signature_method = "HMAC-SHA1";
$oauth_timestamp = mktime();
$oauth_version = "1.0";
 
// *********************************************************
// シグネチャ用ベース文字列作成
/*
  httpMethod + "&" +
  url_encode(  base_uri ) + "&" +
  sorted_query_params.each  { | k, v |
      url_encode ( k ) + "%3D" +
      url_encode ( v )
  }.join("%26")
*/
// *********************************************************
$base_string = "GET";
$base_string .= "&" . url_rfc3986($twitter_url);
$base_string .= "&";
 
$base_string .= url_rfc3986("oauth_consumer_key")."%3D".url_rfc3986($oauth_consumer_key)."%26";
$base_string .= url_rfc3986("oauth_nonce")."%3D".url_rfc3986($oauth_nonce)."%26";
$base_string .= url_rfc3986("oauth_signature_method")."%3D".url_rfc3986($oauth_signature_method)."%26";
$base_string .= url_rfc3986("oauth_timestamp")."%3D".url_rfc3986($oauth_timestamp)."%26";
$base_string .= url_rfc3986("oauth_token")."%3D".url_rfc3986($oauth_token)."%26";
$base_string .= url_rfc3986("oauth_version")."%3D".url_rfc3986($oauth_version);
 
// *********************************************************
// シグネチャ作成
/*
url_encode( consumer_secret ) + "&" +
url_encode( oauth_token_secret || nil )
*/
// *********************************************************
$oauth_signature = 
base64_encode( hash_hmac(
    "sha1",
    $base_string,
    url_rfc3986($oauth_consumer_secret) . "&" . url_rfc3986($oauth_secret),
    true
));
 
// *********************************************************
// curl 処理
// *********************************************************
$curl = curl_init();
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 30);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_BINARYTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $twitter_url);
 
// *********************************************************
// http ヘッダ作成
// *********************************************************
$header = array();
$header[] = 'Expect:';
$header[] = 'Authorization: OAuth '.
url_rfc3986("oauth_consumer_key")."=\"".url_rfc3986($oauth_consumer_key)."\",".
url_rfc3986("oauth_signature_method")."=\"".url_rfc3986($oauth_signature_method)."\",".
url_rfc3986("oauth_token")."=\"".url_rfc3986($oauth_token)."\",".
url_rfc3986("oauth_timestamp")."=\"".url_rfc3986($oauth_timestamp)."\",".
url_rfc3986("oauth_nonce")."=\"".url_rfc3986($oauth_nonce)."\",".
url_rfc3986("oauth_version")."=\"".url_rfc3986($oauth_version)."\",".
url_rfc3986("oauth_signature")."=\"".url_rfc3986($oauth_signature)."\"";
 
curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
 
// *********************************************************
// https 用
// *********************************************************
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 1);
 
// *********************************************************
// 送信
// *********************************************************
curl_setopt($curl, CURLOPT_VERBOSE, true);  // デバッグ
$handle = fopen("./debug.txt", "w");
curl_setopt($curl, CURLOPT_STDERR, $handle);
$handle2 = fopen("./ret_header.txt", "w");
curl_setopt($curl, CURLOPT_WRITEHEADER, $handle2);
$result = curl_exec($curl);
 
 
// *********************************************************
// 結果
// *********************************************************
print "<br>";
 
if($result === false) {
    $json = 'Curl error: ' . curl_error($curl);
}
else {
    echo 'Operation completed without any errors';
    $json = json_decode($result);
}
curl_close($curl);
fclose($handle2);
fclose($handle);
 
//print "<pre>";
//var_dump($json);
//print "</pre>";
 
print "<pre>";
print_r($json);
print "</pre>";
 
 
?>