Auth Secret とは?
Auth Secret は、Workspace をスコープとする Auth Key と Auth Secret のペアのうち非公開の要素であり、安全な自動化のためのパスワードに似たものです。機密性を保つ必要があり、漏えいした場合は再生成できます。また、1 つの Workspace で複数の有効なキーペアを保持できます。
Auth Secret の仕組み
Auth Secret は、信頼できるコードが自身の Workspace のリクエスト署名を生成するために使う秘密情報です。サービスは、この認証情報を通常のリクエストデータとして送信しなくても、署名を検証できます。そのため、対になる公開情報の Auth Key や、クライアントに渡す短期間有効な署名付きパラメーターとは区別し、サーバー側のシークレットストアに保管します。Webhook に使うシークレットの選択方法は、Assembly の再実行に伴うものも含む初回の Notification と、Notification の再送とで異なります。後者では、過去のキーを使うか、再送を呼び出した側のシークレットにフォールバックできます。Webhook 検証仕様に従い、想定する Workspace と Assembly に対応する信頼できるサーバー側の設定から、適切なシークレットを選択してください。未検証のペイロードのフィールドから選択してはいけません。ローテーションは、署名を生成する側と Webhook を受信する側で連携して行う必要があります。
要点
- シークレットをブラウザーの JavaScript やモバイルアプリのバイナリに埋め込むと、抽出される可能性があります。クライアントからのアップロードには、代わりにサーバーで生成した署名付きリクエスト情報を渡してください。
- 既存のシークレットを再生成すると、以前の値で作成した署名が無効になります。計画的にローテーションする場合は、別のキーペアを追加し、署名を生成する側を移行してください。古いペアを廃止する前に、まだ有効な署名付きリクエストと URL を考慮し、そのシークレットが引き続き必要になる可能性のある初回および再送の Notification に対応するよう、Webhook の受信側を更新してください。必要な場合は、署名付き Smart CDN URL 内も含め、
auth_keyでペアを識別してください。 - ソースコードに問題がなくても、診断情報の意図しない記録によって認証情報が漏えいする可能性があるため、ログ、エラーレポート、オブザーバビリティのペイロードでは機密情報をマスキングする必要があります。
Auth Secret が重要になる場面
Auth Secret は信頼できるサーバー上に保管し、ブラウザーやモバイルクライアントに公開せずに、リクエストへの署名に使用してください。Webhook の検証では、Webhook 検証仕様に従い、信頼できるサーバー側の設定から適切なシークレットを選択してください。シークレットが漏えいした場合は、速やかにローテーションし、依存するすべての連携を更新してください。