API キーは、デフォルトではどこからでも使えます。許可リストは、キーを実際にコードを動かしている場所に結び付けます。
仕組み
API のエッジは、各リクエストの送信元 IP をリストと照合します。アドレスがリストにあるか、登録した範囲に含まれていれば、通常のキー確認に進みます。そうでなければ拒否されます。
範囲は CIDR 表記で書きます。アドレス、スラッシュ、プレフィックス長の順です。RFC 4632 によると、プレフィックス長は先頭から固定されるビット数です。IPv4 の例は次のとおりです。
| エントリ | 対象 |
|---|---|
203.0.113.7 |
1 アドレス |
198.51.100.0/24 |
256 アドレス、198.51.100.0 ~ 198.51.100.255 |
10.0.0.0/16 |
65,536 アドレス |
IPv6 も考え方は同じで、2001:db8::/48 のように 128 ビットのアドレスを使います。
重要なのは**送信元(egress)**の IP、つまりサーバーのトラフィックが出ていくときのパブリックアドレスです。NAT、ロードバランサー、社内プロキシの背後では、マシン自身が表示するアドレスとは違うことがよくあります。
なぜ重要か
API キーはベアラートークンで、持っている人なら誰でも使えます。キーはコミット、ログ、スクリーンショット、ノート PC から漏れます。許可リストがあれば、盗まれたキーは攻撃者のネットワークからは使えず、漏えいが課金事故ではなく何も起きない出来事で済みます。たとえば GitHub は、Web のサインインに加えて API 呼び出しや個人用アクセストークンにも許可リストを適用しています。
代わりに運用の手間がかかります。サーバー、リージョン、CI ランナーを増やすたびに送信元 IP の追加が必要で、動的 IP には固定の送信経路が必要です。
BroadNet Inference の場合
アカウントページで、IPv4 または IPv6 のアドレスか CIDR 範囲を 1 行に 1 つずつ、最大 32 件まで追加します。リストが空なら制限はありません。新しいキーはアカウントのリストを引き継ぎます。キーごとの allowed_ips を指定すると、そのキーについてはアカウントのリストを置き換えます。
curl -X POST https://inference.broadnet.ai/portal/keys \
-H "Authorization: Bearer $BROADNET_PORTAL_CREDENTIAL" \
-H "Content-Type: application/json" \
-d '{"label":"worker-1","allowed_ips":["203.0.113.7","198.51.100.0/24"]}'
他のアドレスからのリクエストには 403 が返ります。変更やキーの失効の後、新しいリクエストは 5 秒以内に止まります。詳しい手順は API キーと IP 許可リストに、エラー一覧はエラーコードとリトライにあります。データ保護の全体像については ZDR チェックリストを参照してください。
よくある間違い
- パブリックな送信元 IP ではなく、
10.x.x.xのようなサーバーのプライベートアドレスを登録する。 - エラーを消すために非常に広い範囲を指定する。
/8は 1,600 万を超えるアドレスを含みます。