API キーは、プログラムにとってのパスワードのようなものです。同時に支払いの権限でもあり、キーを持っている人は誰でも残高を使えます。
しくみ
LLM API はキーを Bearer トークンとして扱います。クライアントはすべてのリクエストでキーを送ります。
curl https://inference.broadnet.ai/v1/models \
-H "Authorization: Bearer $BROADNET_API_KEY"
RFC 6750 は、Bearer トークンを「any party in possession of the token」(訳:トークンを所持するあらゆる当事者)が使えるトークンと定義しています。第二要素はありません。そのため同じ RFC は、クライアントは Bearer トークンを常に TLS(https://)で送らなければならないとしています。
プロバイダーはキーを照合してアカウントを特定し、制限とポリシーを確認したうえで、リクエストを処理するか拒否します。キーがない、または誤っている場合は通常 401、IP 許可リストなどのポリシーでキーが拒否された場合は通常 403 が返ります。
なぜ重要か
キーの漏洩は、API の請求額が膨らむ最も多い原因の 1 つです。ボットが公開コードからシークレットを探しているためです。キーがアカウント情報を返すエンドポイントに届けば、データが漏れるおそれもあります。OWASP のシークレット管理の指針に沿った対策は次のとおりです。
- キーは環境変数かシークレットマネージャーから読み込んでください。コミットしたり、コンテナイメージに焼き込んだりしないでください。
- アプリやエージェントごとに別のキーを使い、1 つを無効化してもすべてが止まらないようにしてください。
- キーは定期的に、また漏洩が疑われたら直ちにローテーションしてください。
- サーバーの IP の許可リストなどで、キーが使える場所を制限してください。
BroadNet Inference の場合
BroadNet は 2 種類の認証情報を分けています。推論キーは /v1/* でモデルを呼び出します。ポータル認証情報はアカウントの操作(キー、許可 IP、購入)を自動化します。後者はアカウント全体の権限として扱ってください。
どちらも表示されるのは 1 回だけです。BroadNet は SHA-256 のハッシュしか保存しないため、キーを再表示できません。従量課金のキーの有効期間は 1 年で、1 アカウントにつき有効なキーを最大 10 個まで持てます。キーごとに許可 IP のリストを設定できます。無効化や許可リストの変更後、新しいリクエストは 5 秒以内に止まります。
定額プランのプランのキーは別枠で、残高を使うことはありません。設定手順は API キーと IP 許可リストに、ステータスコードはエラーと再試行にあります。
よくある間違い
- リクエストヘッダーをすべてログに記録すること。キーがログに書き込まれます。
- チームで 1 つのキーを共有すること。1 人分のアクセスだけを無効化できなくなります。
- キーをサポートに送ること。代わりに
X-Request-IDヘッダーの値を送ってください。