JS キャプチャ API の API キーの管理 - AWS WAF、 AWS Firewall Manager、および AWS Shield Advanced

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

JS キャプチャ API の API キーの管理

JavaScript API を使用して AWS WAF CAPTCHA をクライアントアプリケーションに統合するには、CAPTCHA パズルを実行するクライアントドメインの JavaScript API 統合タグと暗号化された API キーが必要です。

CAPTCHA JavaScript アプリケーション統合用は、暗号化された API キーを使用して、クライアントアプリケーションドメインに CAPTCHA API を使用する権限があることを確認します。 AWS WAF クライアントから CAPTCHA API を呼び出すときは、 JavaScript 現在のクライアントのドメインを含むドメインリストを含む API キーを指定します。1 つの暗号化キーに最大 5 つのドメインを一覧表示できます。

API キー要件

CAPTCHA 統合で使用する API キーには、そのキーを使用するクライアントに適用されるドメインが含まれている必要があります。

  • クライアントのインテリジェントな脅威に対応した統合で window.awsWafCookieDomainList を指定する場合、API キーの少なくとも 1 つのドメインが window.awsWafCookieDomainList のトークンドメインの 1 つと完全一致するか、いずれかのトークンドメインの apex ドメインである必要があります。

    例えば、トークンドメイン mySubdomain.myApex.com の場合、API キー mySubdomain.myApex.com は完全に一致し、API キー myApex.com は apex ドメインです。どちらかのキーがトークンドメインに一致します。

    トークンドメインリストの設定については、「トークンで使用するドメインの提供」を参照してください。

  • それ以外の場合は、現在のドメインが API キーに含まれている必要があります。現在のドメインは、ブラウザのアドレスバーで確認できるドメインです。

使用するドメインは、保護対象ホストドメインとウェブ ACL 用に設定されたトークンドメインリストに基づいて、受け入れられるドメインでなければなりません。 AWS WAF 詳細については、「AWS WAF ウェブ ACL トークンドメインリストの設定」を参照してください。

API キーのリージョンの選択方法

AWS WAF AWS WAF 利用可能なすべてのリージョンで CAPTCHA API キーを生成できます。

原則として、CAPTCHA API キーにはウェブ ACL と同じリージョンを使用する必要があります。ただし、リージョンのウェブ ACL に全世界のユーザーがいることが予想される場合は、スコープが CAPTCHA JavaScript CloudFront 統合タグとスコープ指定された API キーを入手して CloudFront、リージョナルウェブ ACL で使用することができます。このアプローチにより、クライアントは自分に最も近いリージョンから CAPTCHA パズルを読み込むことができるため、レイテンシーが短縮されます。

CAPTCHA API キーのスコープが、それ以外のリージョンに設定されている場合 CloudFront 、複数のリージョンでの使用はサポートされていません。スコープが指定されたリージョンでのみ使用できます。

クライアントドメインの API キーを生成するには

統合 URL を取得し、API キーを生成して取得するには、コンソールを使用します。

  1. AWS Management Console にサインインし、https://console.aws.amazon.com/wafv2/ AWS WAF のコンソールを開きます。

  2. ナビゲーションペインで、[Application integration] (アプリケーション統合) を選択します。

  3. [アプリケーション統合が有効になっている Web ACL] ペインで、API キーに使用するリージョンを選択します。CAPTCHA インテグレーションタブの API キーペインでリージョンを選択することもできます。

  4. タブ [CAPTCHA 統合] を選択します。このタブには、 JavaScript インテグレーションで使用できる CAPTCHA インテグレーションタグと API キーのリストが表示されます。どちらも選択したリージョンを対象としています。

  5. [API キー] ペインで、[キーを生成] を選択します。[キー生成] ダイアログが表示されます。

  6. キーに含めるクライアントドメインを入力します。最大 5 つまで入力できます。完了したら、[キーを生成] を選択します。インターフェイスが CAPTCHA 統合タブに戻り、新しいキーが一覧表示されます。

    一度作成された API キーは、イミュータブルです。キーを変更する必要がある場合は、新しいキーを生成し、代わりにそれを使用します。

  7. (オプション) 新しく生成されたキーをコピーして、統合で使用します。

この作業には、REST API または言語固有の AWS SDK を使用することもできます。REST API 呼び出しは CreateApiKey と ListApiKeys です。

API キーを削除するには

API キーを削除するには、REST API または言語固有の AWS SDK を使用する必要があります。REST API 呼び出しは DeleteApiKey です。コンソールを使用してキーを削除することはできません。

キーを削除した後、 AWS WAF すべての地域でそのキーの使用が禁止されるまでに最大 24 時間かかることがあります。