APIキーとは

APIキーとは、サービスの呼び出しを許可されたことを示す、長い合言葉です。OWASPとMITRE CWEの資料をもとに、仕組み、これだけに頼ってはいけない理由、URLに載せない、コードに直書きしないといった扱い方を説明します。

執筆: 神崎 澪(セキュリティアナリスト(AI))監修: 千葉圭介更新日

APIキーとは、サービスの呼び出しを許可されたことを示す、長い合言葉です。APIとは、アプリやサービス同士が機能を呼び合う入口のことで、その入口へ要求を出すときに、キーを添えます。OWASPは、制限のない公開APIが使われすぎて費用が膨らむ危険を抑えるために使う、と説明しています。

APIキーはどんな仕組み?

会員番号入りの入館パスを、取引先に渡す場面を考えてください。パスを見せた人だけが、受付を通れます。APIキーも、サービスを使う側に渡し、呼び出しのたびに添えてもらいます。

OWASPの手引きによると、保護したい入口では、要求のたびにキーを求めます。要求が多すぎる相手には、429(要求が多すぎる)というエラーを返します。決まりに違反した相手のキーは、取り消します。

キーを相手ごとに分けて発行すれば、使いすぎを相手ごとに抑えやすくなる、という使い道が考えられます。同じ「秘密の文字列」でも、利用者本人のログインとは役割が違います。ログイン後に渡される一時的な通行証は、アクセストークンの説明にあります。API認証の失敗例は、API認証の不備にまとめました。

なぜAPIキーが大事なのですか?

APIキーが漏れると、持ち主以外にもAPIを呼べてしまいます。OWASPは、重要な資源を守るために、APIキーだけに頼らないよう述べています。第三者へ渡したキーは、比較的たやすく漏れる、とも書いています。

漏れる経路の代表が、コードへの直書きです。MITREのCWE-798は、パスワードや暗号鍵のような認証情報を、製品の中に固定で埋め込む弱点として整理しています。実際の漏れの例は、認証用の鍵の漏えいで説明しています。キーを扱うときの基本は、次のとおりです。

  • URLに載せません。サーバーのログに残るためで、OWASPも、?apiKey=のような渡し方を良くない例にしています。
  • 取得の要求(GET)では、HTTPのヘッダーで送ります。
  • ソースコードや共有のリポジトリに、直接書きません。
  • 漏れたと分かったら、すぐ取り消して作り直します。
  • 重要な操作は、キーだけで許さず、別の確認も重ねます。
  • キーを渡した相手と用途は、一覧にして残します。

関連する言葉

  • アクセストークン:ログイン後に発行される、一時的な通行証のようなものです。
  • JWT:ログインした証明を持ち運べる形にした書類です。
  • 暗号化の不備:守るべき情報の暗号化が不十分な不備です。
  • OAuth:パスワードを渡さずに、別のアプリへ許可を与える仕組みです。

次の一手

APIの認証の失敗例はAPI認証の不備に、キーの漏れた事例と対応は認証用の鍵の漏えいにあります。自社の外から見える入口は無料URLチェックで確かめられ、キーの扱いの見直しは無料相談で相談できます。

よくある質問

APIキーだけで、APIを守れますか?

それだけでは足りません。OWASPは、機微な情報や重要な資源を守るために、APIキーだけに頼らないよう述べています。第三者に渡したキーは、比較的たやすく漏れるためです。利用者の認証や、権限の確認も、別に重ねてください。

APIキーをURLに入れてはいけないのは、なぜですか?

URLの内容は、Webサーバーのログに残るためです。OWASPは、機微な情報をURLに載せないよう述べ、?apiKey=のような渡し方を良くない例にしています。取得の要求では、HTTPのヘッダーで送る方法が挙げられています。

よくある質問

APIキーだけで、APIを守れますか?

それだけでは足りません。OWASPは、機微な情報や重要な資源を守るために、APIキーだけに頼らないよう述べています。第三者に渡したキーは、比較的たやすく漏れるためです。利用者の認証や、権限の確認も、別に重ねてください。

APIキーをURLに入れてはいけないのは、なぜですか?

URLの内容は、Webサーバーのログに残るためです。OWASPは、機微な情報をURLに載せないよう述べ、?apiKey=のような渡し方を良くない例にしています。取得の要求では、HTTPのヘッダーで送る方法が挙げられています。

外から見える穴を、今日のうちに確かめませんか

無料のURLチェックは数十秒で結果が出ます。費用の見当や進め方は、無料相談でご説明します。