2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

OAuth2 クライアント資格情報フローにおける認証方式の違い詳解

Posted at

OAuth2 クライアント資格情報フローとは?

OAuth2の「クライアント資格情報フロー」(Client Credentials Flow)は、アプリケーション自身が自分の権限でリソースにアクセスするための認可フローです。ユーザーの関与なしに、マシン同士(M2M)の認証・認可シナリオで使われます。具体的には、あるサービスが自分自身(クライアント)のIDとシークレットを使って認可サーバからアクセストークンを直接取得し、そのトークンでAPIを呼び出す場面を指します。たとえばバックエンド同士の通信やバッチ処理、マイクロサービス間の認可など、クライアント自身がリソースオーナーとして振る舞うケースで利用されます (RFC 6749: The OAuth 2.0 Authorization Framework) このフローではリフレッシュトークンを発行しない(アクセストークン有効期限切れ時は再度資格情報で取得する)実装も多く、構成がシンプルなのが特徴です。

流れとしては、クライアントアプリケーションがトークンエンドポイント(認可サーバのエンドポイント)に対してHTTP POSTリクエストを行い、リクエスト内で自分のクライアントIDとクライアントシークレット(いわば「クライアントのユーザー名・パスワード」)を提示します。認可サーバはそれを検証し、有効であればアクセストークン(場合によっては併せてスコープや有効期限など)を応答として返します。その後クライアントは取得したアクセストークンを使って保護リソースへアクセスします。
このようにユーザーの介在しないフローであるため、クライアントには信頼できる環境で管理される機密情報(client_secret)が必要です。サーバ間通信などで広く使われる基本的なフローですが、その認証情報(クライアントID・シークレット)の送り方に複数の方式が存在します。本記事では特に「Basic認証ヘッダ方式」と「リクエストボディ方式」の違いに焦点を当てて解説します。

Basic認証ヘッダ方式 vs リクエストボディ方式

クライアント資格情報フローでクライアントを認証する方法として、主にHTTP Basic認証ヘッダを使う方法リクエストボディに含める方法の2通りがあります。それぞれリクエストの構造が異なるため、サンプルのcurlコードを交えて見てみましょう。

Basic認証ヘッダ方式

Basic認証ヘッダ方式では、その名の通りHTTPのAuthorizationヘッダにクライアント資格情報を載せて送信します。具体的には、"<client_id>:<client_secret>"を文字列結合してBase64エンコードし、その値をAuthorization: Basic <base64>ヘッダとして付加します (OAuth2 client credentials flow | Ory) これによりサーバはHTTP標準のBasic Authとしてクライアントを認証できます。リクエストボディには認可サーバが必要とする通常のパラメータ(例: grant_type=client_credentialsscope など)だけを入れ、クライアントID・シークレット自体はボディに含めません。

例: Basic認証ヘッダ方式のcurlリクエスト

curl -X POST https://auth.example.com/oauth/token \
  -H "Authorization: Basic $(echo -n 'CLIENT_ID:CLIENT_SECRET' | base64)" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&scope=read:data"

上記の例では、CLIENT_IDCLIENT_SECRET:で連結しBase64エンコードした結果をAuthorizationヘッダに設定しています(curlでは簡潔に-u CLIENT_ID:CLIENT_SECRETと指定することでも同様のBasic認証ヘッダを付与できます)。ボディにはgrant_typeや必要に応じてscope等をフォームエンコードで詰めています。

リクエストボディ方式

リクエストボディ方式では、クライアントIDとシークレットをHTTPリクエストのボディ内のフォームパラメータとして送信します (OAuth2 client credentials flow | Ory) Authorizationヘッダは使わず、代わりに例えばclient_id=CLIENT_ID&client_secret=CLIENT_SECRETという形で他のパラメータと一緒にPOSTボディに含めます。認可サーバは受け取ったボディの中からクライアント認証情報を取り出して検証を行います。

例: リクエストボディ方式のcurlリクエスト

curl -X POST https://auth.example.com/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=CLIENT_ID&client_secret=CLIENT_SECRET&scope=read:data"

この例では、クライアントIDとシークレットがそれぞれclient_idおよびclient_secretというフィールドとしてリクエストボディに含まれています。Authorizationヘッダは付与していない点がBasic方式との違いです。

両方式の仕組みの違いとセキュリティ面の考慮

仕組み上の違いとして、Basic認証ヘッダ方式はHTTP標準の認証ヘッダを利用するため、多くのHTTPサーバやライブラリで一貫して扱われます。認可サーバ側ではこのヘッダを自動的にデコードしてクライアントID/シークレットを取り出す処理が一般化されています。一方、ボディ方式では認可サーバのトークンエンドポイント実装がリクエストボディからclient_idclient_secretをパースして処理します。見た目はどちらも最終的にクライアントIDとシークレットをサーバに提示している点で同じですが、その伝達経路(ヘッダ vs ボディ)が異なります。

セキュリティや利便性の違いもいくつか指摘されています。Basic方式では、資格情報がHTTPヘッダに乗るため、Webサーバやプロキシなどインフラ層でその情報を**適切に扱いやすい(例えばログに残さない等)**という利点があります (authentication - Why does the OAuth2 spec recommend that client credentials not be passed in the request body? - Information Security Stack Exchange) (oauth 2.0 - Why does Oauth2.0 says, "Client Password in request body not recommended"? - Stack Overflow) 多くのHTTPサーバや中間プロキシはAuthorizationヘッダが含まれるリクエストを検知すると、キャッシュやログに特別な配慮をする仕様になっています (authentication - Why does the OAuth2 spec recommend that client credentials not be passed in the request body? - Information Security Stack Exchange) 一方で、クライアントID・シークレットをボディに入れる方式では、それらは通常のPOSTフォームデータとして扱われるため、アプリケーションのログに記録されてしまうリスクが高まります (oauth 2.0 - Why does Oauth2.0 says, "Client Password in request body not recommended"? - Stack Overflow) 実際、Hans Z.氏による指摘では「OAuth2固有のPOSTパラメータはアプリケーションのログなど上位レイヤーに残り得るが、HTTP Basic認証はより下位のインフラ層で処理されるため、そういった上位レイヤーやログファイルに機密情報が現れにくい」ことが利点とされています (oauth 2.0 - Why does Oauth2.0 says, "Client Password in request body not recommended"? - Stack Overflow)

なお、どちらの方式であっても通信路の暗号化 (TLS) は必須です。アクセストークン取得の通信が平文で盗聴されればヘッダだろうとボディだろうと資格情報が漏洩してしまうため、OAuth2ではトークンエンドポイントへの通信はTLSで保護することが求められています(RFCでも明示されています)。また、クライアントシークレット自体の管理も重要です。サーバ間通信とはいえコード上に平文で埋め込まれるケースも多いため、環境変数やシークレットマネージャーを使う、リポジトリに誤ってコミットしない、といった基本的な対策は両方式共通で必要になります。

OAuth2 RFCの推奨事項とセキュリティの観点

OAuth2の公式仕様であるRFC 6749では、クライアントの認証方法について明確な推奨が示されています。RFC 6749の2.3.1項において、クライアントIDとシークレットをリクエストボディに含める方法は「推奨されない (NOT RECOMMENDED)」とされており、*“この方法はHTTP Basic認証スキーム(または他のパスワードベースのHTTP認証)を直接利用できないクライアントに限定すべき”*と記載されています (RFC 6749: The OAuth 2.0 Authorization Framework) つまり、AuthorizationヘッダによるBasic認証が技術的に利用不可能な特殊な場合を除き、基本はBasic認証方式を使うべきだというのがRFCのスタンスです。

ではなぜこのようにBasic認証ヘッダ方式が推奨されているのでしょうか? いくつか理由がありますが、大きなポイントの一つは前述したセキュリティ上の扱いやすさです。HTTPのAuthorizationヘッダは歴史的にも機密情報を運ぶものとして扱われてきた経緯があり、各種ミドルウェアが特別な配慮をしています (authentication - Why does the OAuth2 spec recommend that client credentials not be passed in the request body? - Information Security Stack Exchange) OAuth2のセキュリティに関する拡張仕様であるRFC 6819でも、Authorizationヘッダを用いることで「認証情報が含まれたリクエストがプロキシやサーバによって特別に扱われ、漏洩や意図しない保存の可能性を下げられる」ことが言及されています (authentication - Why does the OAuth2 spec recommend that client credentials not be passed in the request body? - Information Security Stack Exchange) 逆に言えば、リクエストボディに資格情報を含めてしまうと、そのリクエストは一見ただのフォーム送信なので、ミドルウェアやアプリケーションログによって平文のまま記録されたり、他のデバッグ情報に紛れて漏れてしまうリスクが増すわけです。

もう一つの理由は実装の一貫性と相互運用性です (authentication - Why does the OAuth2 spec recommend that client credentials not be passed in the request body? - Information Security Stack Exchange) OAuth2策定当初、既存の実装にはヘッダ方式とボディ方式の両方が存在していたため、仕様上どちらも「使用可能 (MAY)」とされました。しかし認可サーバ実装はBasic認証のサポートが必須と定められたため(前述の通り、できるクライアントはBasicを使う想定)、あえて「ボディ方式は非推奨」と付記することでみんながなるべく同じ方法(Basic)を使うよう促したと考えられます (authentication - Why does the OAuth2 spec recommend that client credentials not be passed in the request body? - Information Security Stack Exchange) 実際問題として、クライアント開発者が方式の違いを意識せずに済めば相互運用性が高まりますし、ドキュメント上も「基本はヘッダで送ってね」と統一できた方がシンプルです。将来的にボディ方式を廃止するという話ではありませんが、互換性のために残している程度の位置付けと言えるでしょう。

まとめると、Basic認証ヘッダ方式はセキュリティ面と相互運用性の面で優れているため、OAuth2仕様として公式に推奨されているわけです。逆にリクエストボディ方式を使う場合は「やむを得ない特殊な事情」がある場合に限られるべき、というのがRFCの立場になります (RFC 6749: The OAuth 2.0 Authorization Framework)

具体的なセキュリティ上の注意点としては、資格情報を絶対にURLクエリパラメータに含めないことも重要です。RFC 6749では、クライアントID・シークレットのパラメータはリクエストURI(URL)に含めてはならない(MUST NOT)と明記されています (RFC 6749: The OAuth 2.0 Authorization Framework) GETリクエストのクエリに認証情報を入れてしまうと、ブラウザ履歴やリファラ、プロキシのアクセスログなどあらゆるところに残ってしまい極めて危険です。そのためトークンエンドポイントは必ずPOSTで呼び出し、認証情報はヘッダかボディの中に入れる形にする必要があります。これは稀なケースではありますが、誤ってGETでトークンエンドポイントを叩かないようにしましょう。

Logtoの仕様と公式ドキュメントの立場

では、実際の認可サーバ実装ではBasic方式とボディ方式のどちらが使われているのでしょうか。その一例として、Logtoというオープンソースの認証基盤(OIDCサーバ)のケースを見てみます。LogtoはOAuth2/OIDC準拠のサービスで、クライアント資格情報フローにも対応していますが、公式ドキュメント上ではBasic認証ヘッダ方式を使うよう強調されています。【Logto公式ドキュメントのM2M向けチュートリアルより】: 「トークンエンドポイントへのリクエストでは、アプリケーションの資格情報をBasic認証形式でAuthorizationヘッダに含める」 と記載されています (Machine-to-machine: Auth with Logto | Logto docs) 実際、そのガイドではアクセストークン取得リクエストの例として、Authorization: Basic ... ヘッダ付きのHTTPリクエストが紹介されています (Machine-to-machine: Auth with Logto | Logto docs)

一方で、OAuth2の仕様上はLogtoもクライアントID・シークレットのボディ送信を受け付け可能と思われます。事実、LogtoのAPIリファレンスにはclient_idclient_secretをフォームデータとして含める例も掲載されています (
Authentication | Logto API references documentation (dev)
) ただし公式のチュートリアルやベストプラクティスではこのボディ方式についてほとんど触れられていません。むしろ、「従来型のWebアプリケーションでは、トークンリクエストのヘッダにclient_idとclient_secretを入れないと401のinvalid_clientエラーになる」という注意書きがあるほどで、Basic認証ヘッダを使うことが前提になっています (User impersonation | Logto docs) 裏を返せば、Logtoの現在の実装では**Authorizationヘッダに正しい認証情報がないリクエストは認可しない(=ボディに入れてもエラーになる)**可能性が高いということです。

以上から、Logtoに関して言えば公式ドキュメント上はBasic認証方式一択と考えておいた方が無難です。OIDCのメタデータ(.well-known/openid-configurationtoken_endpoint_auth_methods_supportedなど)を確認すれば厳密なサポート状況が分かりますが、少なくともドキュメントのスタンスとしてはBasic方式を推奨しているようです。仮にLogtoサーバが内部的にボディ方式も許容していたとしても、ドキュメントと齟齬があるため実装者が混乱する恐れがあります。実際、「ドキュメントに無いがボディに入れても通ってしまった/エラーになった」といったケースは他の認証基盤でも報告例があり、仕様と実装の食い違いによるバグの温床になりかねません。

結論として、Logtoを含む多くの実装においても基本的にはBasic認証ヘッダ方式を使うのが安全策です。公式ドキュメントに従っておけば間違いありませんし、仮に何らかの理由でボディ方式を使いたい場合でも、まずはその実装がそれを正式サポートしているか(ドキュメントや設定でclient_secret_postが有効になっているか)を確認する必要があります。

実装時のベストプラクティスと落とし穴

最後に、クライアント資格情報フローを実装する際のベストプラクティスと、ハマりがちな落とし穴についてまとめます。

基本的なベストプラクティス:

  • 可能な限りBasic認証ヘッダ方式を使うこと: 前述の通りセキュリティと互換性の面で優れるため、特段の事情がなければこちらを採用します。例えばOAuthクライアントライブラリやHTTPクライアントの設定で「クライアント認証をヘッダに送るかボディに送るか」を選べる場合、ヘッダ送信(Basic)を選びましょう。
  • HTTPS通信の徹底: OAuth2トークンエンドポイントへの通信はTLS必須です。自己署名証明書を使う開発環境などでは証明書検証を無効にしてテストしがちですが、本番では決して平文通信を行わないようにしましょう。Basic方式の場合でも平文通信ではAuthorizationヘッダが漏れてしまいます。
  • 信頼できるライブラリの活用: 低レベルから自前実装するのではなく、実績のあるOAuth2クライアントライブラリやHTTPライブラリに任せるのが安全です。ライブラリは仕様に従って適切な方式(デフォルトでBasicを使うものが多い)でリクエストを組み立ててくれます (OAuth2 client credentials flow | Ory) 自前で実装する場合でも、せめてBase64エンコード部分などは標準ライブラリを使いましょう(バグで誤ったヘッダを生成すると認証失敗や情報漏洩に繋がります)。

よくある落とし穴:

  • 「invalid_client エラー」の原因: トークンエンドポイントから{"error": "invalid_client"}と返された場合、クライアントID/シークレットの認証に失敗しています。単純なID・秘密の間違いのほか、認証情報の送り方を間違えているケースが多いです。例えばBasicを期待しているサーバに対しボディに入れてしまった、あるいはAuthorizationヘッダのフォーマットが誤っている(「Basic xxxx」のスペースや大小文字が違う、Base64エンコードが正しくない等)と認証されません。このエラーが出たらまず方式とフォーマットを見直しましょう。
  • ツールのデフォルト設定に注意: OAuth2クライアントツール(例えばPostmanなど)では「クライアント認証をヘッダにするかボディにするか」設定がある場合があります。Postmanではリクエスト作成時に "Client Authentication" の設定で "Send as Basic Auth header""Send client credentials in body" を選択できます。ここで誤った方(例えばサーバはBasic必須なのにBodyを選択)を選ぶと認証失敗します。ツールのデフォルト挙動を把握し、必要に応じて設定を変更してください。
  • Authorizationヘッダが消失する問題: 一部の環境では、プロキシやサーバ設定によってAuthorizationヘッダが勝手に落とされることがあります。企業内ネットワークのプロキシや、一部の古いアプリケーションサーバがセキュリティのためにAuthorizationヘッダを通さない設定になっていると、クライアントから正しく送っても認可サーバに届きません。この場合、ボディ方式なら動くかもしれませんが、根本的にはヘッダが通るよう設定を調整すべきです。やむを得ずボディ方式に切り替える場合も、その変更が他に影響しないか注意が必要です。
  • ログやデバッグ情報への露出: 開発中にリクエスト内容をログ出力するとき、クライアントシークレットが含まれていないか確認しましょう。Basic方式でも誤ってAuthorizationヘッダをそのままログに出せばBase64とはいえシークレットが露出しますし、ボディ方式であればなおさら平文で残ります。デバッグには十分注意し、必要ならマスキング処理を入れるなど対策してください。
  • パラメータ名のタイプミス: 単純ですが見落としがちなのはパラメータ名のスペルミスです。例えばclient_secretclient_secrectと書いてしまったり、grant_type=client_credentialsを忘れるといったケースです。特にボディ方式では自分で全部書くためミスが起きやすいです(Basic方式でもgrant_typeは必要なので注意)。認可サーバによってはエラーメッセージが曖昧な場合もあるため、タイポには気をつけましょう。

以上の点を踏まえて実装すれば、大きな問題なくクライアント資格情報フローを扱えるはずです。要は**「正しい情報を、正しい場所に載せて送る」**—これに尽きます。

どちらを選ぶべきかの結論と推奨

結論として、基本的にはいつでもBasic認証ヘッダ方式を選ぶのが無難であり推奨です。OAuth2の仕様策定者もそれを望んでいますし (RFC 6749: The OAuth 2.0 Authorization Framework) 実際のプロバイダ(Auth0やAWS Cognito、Logtoなど)もドキュメントでヘッダ方式を案内することがほとんどです。ヘッダ方式であればまず間違いなく認可サーバ側で受け付けられますし、実装上の資料やサンプルも豊富です。セキュリティ面でもアプリケーションログに残りにくい利点がある以上、敢えてボディ方式を選ぶメリットは多くありません。

例外的にボディ認証を使うべき場面はごく限られます。例えば、「どうしてもAuthorizationヘッダを付与できないクライアント環境」で動かす必要がある場合です。現在では考えにくいですが、極端な例としてハードウェア的な制約でヘッダを差し替えられない場合や、レガシーな仕組み上Basic Authに対応していないHTTPクライアントしか使えない、といったケースがもしあるならボディ方式を検討する余地はあります。その際でも、利用する認可サーバがclient_secret_post(ボディ方式)を正式にサポートしていることを確認し、TLSやネットワーク構成にも一層注意を払う必要があります。

しかし繰り返しになりますが、現在の一般的なWeb/サーバサイド開発環境において、Basic認証ヘッダを利用できないケースはほぼ皆無と言ってよいでしょう。言い換えれば、ほとんど全ての状況でBasic方式を選択すれば間違いありません。ボディ方式は仕様上存在はしていますが、実務では「知識として知っておく」程度で充分で、実際に使う場面はそうそう無いはずです。

まとめると、OAuth2クライアント資格情報フローのクライアント認証はBasic認証ヘッダ方式一択と考えて差し支えありません。その上で、実装時には今回挙げたベストプラクティスに沿って進めれば、セキュアでスムーズな認証実装ができるでしょう。「なるほど、こういうことか」と思っていただけたなら幸いです。参考になれば幸いです!

2
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?