ベース URL は、クエリ文字列やハッシュパラメータを除いた、リクエストの送信先となる URL です。ここで正しいプロトコルを使用することが重要なため、URL の「https://」の部分が、API に送信される実際のリクエストと一致していることを確認してください。
次に、リクエストに含まれるすべてのパラメータを収集します。これらの追加パラメータには 2 つの格納場所があり、URL (クエリ文字列の一部) とリクエストボディです。サンプルリクエストでは、両方の場所にそれぞれ 1 つのパラメータが含まれています。
oauth_* パラメータを署名に含める必要があるため、それらも収集します。以下は、リクエストの認可 からのパラメータです。
これらの値は 1 つの文字列にエンコードされ、後で使用します。文字列を構築する手順は非常に厳密に決められています。
- 署名対象となるすべてのキーと値を パーセントエンコード します。
- エンコード済みのキーでアルファベット順に [1] パラメータのリストをソートします [2]。
- 各キー/値ペアについて:
- エンコード済みキーを出力文字列の末尾に追加します。
- 文字 ‘=’ を出力文字列の末尾に追加します。
- エンコード済み値を出力文字列の末尾に追加します。
- まだ残りのキー/値ペアがある場合は、文字 ‘&’ を出力文字列の末尾に追加します。
これまでに収集した 3 つの値を結合して 1 つの文字列にし、その文字列から署名を生成します。OAuth 仕様では、この文字列を signature base string (署名ベース文字列) と呼びます。
HTTP メソッド、ベース URL、およびパラメーター文字列を 1 つの文字列にエンコードするには、次の手順に従います。
- HTTP メソッドを大文字に変換し、その値を出力文字列とします。
- 出力文字列に ‘&’ 文字を追加します。
- URL をパーセントエンコードし、出力文字列に追加します。
- 出力文字列に ‘&’ 文字を追加します。
- パラメーター文字列をパーセントエンコードし、出力文字列に追加します。
& 文字がちょうど 2 つだけ含まれている必要があります。パラメーター文字列内のパーセント % 文字は、signature base string 内では %25 にエンコードされている必要があります。
最後に収集するデータは、リクエストを行っている X app を識別するシークレットと、そのリクエストが代行しているユーザーを識別するシークレットです。これらの値は非常に機密性が高く、絶対に他人と共有してはいけないことに注意してください。
X 上であなたの App を識別する値は consumer secret と呼ばれ、Developer Console の app details page で確認できます。これは、あなたの X App が送信するすべてのリクエストで同じ値になります。
アプリケーションがどのアカウントの代わりに動作しているかを識別する値は OAuth token secret と呼ばれます。この値は複数の方法で取得でき、そのすべてが obtaining access tokens で説明されています。
繰り返しになりますが、これらの値はアプリケーション固有の秘密として厳重に管理する必要があります。値が漏洩した疑いがある場合は、トークンを再生成してください (このページに記載されているトークンは、実際のリクエストでは無効として扱われます) 。
これら 2 つの値は組み合わせて signing key を構成し、署名の生成に使用されます。signing key は単に、percent encoded されたトークンシークレットです。
request token を取得する場合など、一部のフローではトークンシークレットがまだ分からないことがあります。この場合、signing key は、percent encoded された consumer secret の後ろにアンパサンド文字「&」を連結したものになります。
最後に、シグネチャはシグネチャベース文字列と署名キーを HMAC-SHA1 ハッシュアルゴリズムに渡して計算します。アルゴリズムの詳細は、hash_hmac 関数の説明を参照してください。
HMAC 署名関数の出力はバイナリ文字列です。これを base64 でエンコードして、シグネチャ文字列を生成する必要があります。たとえば、このページで示したシグネチャベース文字列と署名キーを入力すると、出力は 2E CF 77 84 98 99 6D 0D DA 90 5D C7 17 7C 75 07 3F 3F CD 4E となります。この値を base64 に変換したものが、このリクエストの OAuth シグネチャです。