Compliance Studio

漏洩したAPIキーへの対応

k-IDのAPIキーがソース管理、ログ、またはクライアントサイドのコードで公開されてしまった場合の対応手順です。

k-IDのAPIキーが公開されてしまった場合(リポジトリへのコミット、公開チャンネルへの貼り付け、ログへの出力、クライアントサイドのコードへの同梱など)は、できるだけ早くキーを削除して置き換えてください。キーを削除するまで、そのキーを持つ誰もがあなたのプロダクトとしてk-ID APIを呼び出せます。

コードからキーを取り除いたり、gitの履歴を書き換えたりするだけでは不十分です。フォーク、クローン、キャッシュ、CIログなどにすでにコピーが残っている可能性があります。漏洩したキーを無効にする唯一の方法は、Compliance Studioでキーを削除することです。

1. キーを特定する

キーがどのプロダクトのどの環境のものかを確認します。

現在のAPIキーは、環境を示すプレフィックスで始まります。

プレフィックス環境
kgs_live_本番
kgs_test_テスト

Compliance Studioでキーを探すには、対象となりうるプロダクトを開き、開発者設定タブでテストと本番を切り替えます。APIキーのセクションには各キーの先頭の文字が表示されるので、漏洩した値と照合してください。現在の形式より前に作成されたキーにはレガシーと表示され、表示される文字数が少なくなります。

本番キー

本番キーが漏洩すると、本番環境のデータにアクセスされる可能性があります。キーが公開の場所に出てしまった場合は、統合が一時的に利用できなくなるとしても、ただちにキーを削除し(手順3)、その後で置き換えてください。

2. 代わりのキーを作成する

1つのプロダクトでは環境ごとに複数のキーを同時に有効にできるため、通常はダウンタイムなしでキーを置き換えられます。

  1. 同じプロダクトの開発者設定タブで、同じ環境(テストまたは本番)を選択した状態でAPIキーを追加をクリックします。
  2. 置き換えるキーと区別できるように、新しいキーの説明を入力します。
  3. 新しいキーをコピーします。
  4. 古いキーを使用しているすべての場所を更新します。環境変数、シークレットマネージャー、CI/CDの変数、k-ID APIを呼び出すその他のサービスが対象です。
  5. 変更をデプロイし、新しいキーで統合が動作していることを確認します。

3. 漏洩したキーを削除する

  1. 開発者設定タブのAPIキーのセクションで、漏洩したキーを見つけます。
  2. キーの横にある削除(ゴミ箱)アイコンをクリックし、確認をクリックします。

削除は即座に反映されます。削除されたキーを使用したリクエストは401 Unauthorizedで拒否され、削除したキーは元に戻せません。

4. 漏洩した場所からキーを取り除く

削除したキーはもう使用できませんが、公開された箇所も整理してください。

  • ソース管理: コードからキーを取り除き、環境変数またはシークレットマネージャーに移します。リポジトリの履歴からも削除したい場合は、GitHubのガイドリポジトリからの機密データの削除を参照してください。
  • クライアントサイドのコード: キーがWebページ、モバイルアプリ、ゲームクライアントに含まれていた場合は、そのキーを使うk-ID APIの呼び出しをすべてサーバーに移してください。APIキーがエンドユーザーのデバイスに届いてはいけません。セキュリティの推奨事項を参照してください。
  • ログやメッセージ: キーが記載されたログ、チケット、チャットメッセージ、ドキュメントから、キーを削除または伏せ字にします。

5. 不審なアクティビティを確認する

  • プロダクトの履歴タブのアクティビティセクションで、心当たりのないAPIキーが追加されました、APIキーが編集されました、APIキーが削除されましたの記録がないか確認し、それぞれの変更を誰が行ったかを確認します。バージョン履歴とロールバックを参照してください。
  • キーが公開されていた期間について、自社のサーバーログや、プロダクトが受け取ったセッションと認証に想定外のものがないか確認します。

キーが悪用された可能性がある場合や、これらの手順で支援が必要な場合は、support@k-id.comまたはk-IDのアカウントマネージャーにお問い合わせください。プロダクト名、環境、キーがいつどこで公開されたかのおおよその情報を記載してください。キーそのものは記載しないでください。

漏洩を防ぐには

  • APIキーはサーバー上だけで、環境変数またはシークレットマネージャーに保管します。
  • キーをソース管理にコミットしないでください。.envなどシークレットを含むファイルは.gitignoreに追加します。
  • サービスやデプロイステージごとに個別のキーを用意し、使用場所がわかる説明を付けておくと、他に影響を与えずに1つのキーだけを削除できます。
  • リポジトリでGitHubのシークレットスキャンとプッシュ保護を有効にします。

キーの管理について詳しくは、開発者設定を参照してください。

On this page