AWS WAF モバイル SDK の仕様

WAFToken の String 表現を取得します。

バックグラウンド更新が有効になっている場合、キャッシュされたトークンが返されます。バックグラウンド更新が無効になっている場合、AWS WAF に同期的にブロックする呼び出しを行って新しいトークンを取得します。

指定されたトークンを WAFTokenProvider にロードし、プロバイダーが管理していたトークンを置き換えます。トークンプロバイダーは新しいトークンの所有権を取得し、今後の更新を処理します。このオペレーションでは、WAFConfiguration で setTokenCookie が有効になっている場合、Cookie ストアのトークンも更新されます。

アクティブなトークンの準備ができたら、トークンを更新し、指定されたコールバックを呼び出すようにトークンプロバイダーに指示します。トークンプロバイダーは、トークンがキャッシュされて準備ができたときに、バックグラウンドスレッドでコールバックを呼び出します。アプリケーションが最初にロードされたときや、アクティブ状態に戻ったときにこれを呼び出します。アクティブ状態に戻ることの詳細については、「アプリケーションが非アクティブ状態になった後のトークンの取得」を参照してください。

Android または iOS アプリケーションの場合、WAFTokenResultCallback を、リクエストされたトークンの準備ができたときにトークンプロバイダーが呼び出すオペレーションに設定できます。WAFTokenResultCallback の実装では、パラメータ WAFToken、SdkError を取得する必要があります。iOS アプリケーションでは、代わりにインライン関数を作成できます。

指定された AWS WAF トークンを SDK の Cookie マネージャに保存するように WAFTokenProvider に指示します。デフォルトでは、トークンは最初に取得されたときと更新されたときのみ、Cookie ストアに追加されます。アプリケーションが何らかの理由で共有 Cookie ストアをクリアしても、SDK は次回の更新まで AWS WAF トークンを自動的に追加しません。

アプリケーション統合 URL。これは、AWS WAF コンソールで、または getWebACL API コールを通じて取得します。

必須: はい

タイプ: アプリケーション固有の URL。iOS の場合は、「iOS URL」を参照してください。Android の場合は、「java.net URL」を参照してください。

トークンプロバイダーがバックグラウンドでトークンを更新するかどうかを示します。これを設定すると、トークンプロバイダーは、自動トークン更新アクティビティを管理する構成設定に従って、バックグラウンドでトークンを更新します。

必須: いいえ

タイプ: Boolean

デフォルト値: TRUE

トークンで使用するドメインは、トークン取得とクッキーの保存に使用されます。例えば、example.com、aws.amazon.com です。これは通常、保護パック (ウェブ ACL) に関連付けられているリソースのホストドメインであり、ウェブリクエストの送信先です。ACFP マネージドルールグループ AWSManagedRulesACFPRuleSet の場合、通常はルールグループ設定で指定したアカウント作成パスのドメインと一致する単一のドメインになります。ATP マネージドルールグループ AWSManagedRulesATPRuleSet の場合、通常はルールグループ設定で指定したログインパスのドメインと一致する単一のドメインになります。

パブリックサフィックスは許可されません。たとえば、gov.au または co.uk をトークンドメインとして使用することはできません。

ドメインは、保護されたホストドメインおよび保護パック (ウェブ ACL) のトークンドメインリストに基き、AWS WAF が受け入れるものでなければなりません。詳細については、「AWS WAF 保護パック (ウェブ ACL) トークンドメインリストの設定」を参照してください。

必須: はい

タイプ: String

失敗した試行後にトークンの更新を繰り返すまでの待機時間の最大値 (ミリ秒)。失敗した試行の自動再試行ごとに、指定された入力遅延時間までエクスポネンシャルバックオフが追加されます。この値は、トークンの取得が失敗し、maxRetryCount 回再試行された後に使用されます。

必須: いいえ

タイプ: Integer

デフォルト値: 5000 (5 秒)

許容される最小値: 1 (1 ミリ秒)

許容される最大値: 30000 (30 秒)

トークンがリクエストされたときに、エクスポネンシャルバックオフで実行する最大再試行回数。

必須: いいえ

タイプ: Integer

デフォルト値: Infinity

許容される最小値: 0

許容される最大値: 100

SDK の Cookie マネージャーがリクエストに、およびその他のエリアにトークン Cookie を追加するかどうかを示します。

TRUE 値の場合:

必須: いいえ

タイプ: Boolean

デフォルト値: TRUE

setTokenCookie が TRUE の場合に使用されます。SDK の cookie マネージャーでトークン cookie を追加する最上位レベルのパスを示します。マネージャーは、このパスに送信するすべてのリクエストとすべての子パスにトークン cookie を追加します。

例えば、これを /web/login に設定すると、マネージャーには、/web/login に送信されるすべてのトークン cookie と、その子パスのいずれかが含まれます (/web/login/help など)。/、/web、/web/order などの他のパスに送信されたリクエストのトークンは含まれません。

必須: いいえ

タイプ: String

デフォルト値: /

バックグラウンドの更新に使用されます。バックグラウンドトークンが更新されるまでの最大時間 (秒)。

必須: いいえ

タイプ: Integer

デフォルト値: 88

許容される最小値: 88

許容される最大値: 300 (5 分)

このエラーは、トークンサーバーが無効なチャレンジデータを返すか、レスポンス BLOB が攻撃者によって変更された場合に返されます。

このエラーは、トークンサーバーが成功しないレスポンスコードをクライアントに返すか、ネットワークエラーが発生したときに返されます。

このエラーは、AWS WAF サーバーの検証レスポンスから aws-waf-token を取得する際にエラーが発生したとき、またはサーバーレスポンスが改ざんされたときに返されます。

このエラーは、クライアントが AWS WAF サーバーから不正な応答を受け取ったとき、または解決されたチャレンジを検証するときにネットワークエラーを受け取ったときに返されます。

このエラーは、SDK 自体の内部で発生する可能性のある他のすべてのエラーに対して返されます。