AWS WAF SDKspécification mobile - AWS WAF, AWS Firewall Manager, et AWS Shield Advanced

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWS WAF SDKspécification mobile

Cette section répertorie les SDK objets, les opérations et les paramètres de configuration de la dernière version disponible du AWS WAF mobileSDK. Pour des informations détaillées sur le fonctionnement du fournisseur de jetons et des opérations pour les différentes combinaisons de paramètres de configuration, consultezComment le AWS WAF SDKœuvres mobiles.

WAFToken

Détient un AWS WAF jeton.

getValue()

Récupère la String représentation du. WAFToken

WAFTokenProvider

Gère les jetons dans votre application mobile. Implémentez cela à l'aide d'un WAFConfiguration objet.

getToken()

Si l'actualisation en arrière-plan est activée, le jeton mis en cache est renvoyé. Si l'actualisation en arrière-plan est désactivée, cela lance un appel synchrone bloquant vers AWS WAF pour récupérer un nouveau jeton.

onTokenReady(WAFTokenResultCallback)

Demande au fournisseur de jetons d'actualiser le jeton et d'invoquer le rappel fourni lorsqu'un jeton actif est prêt. Le fournisseur de jetons invoquera votre rappel dans un fil d'arrière-plan lorsque le jeton sera mis en cache et prêt. Appelez cela lorsque votre application se charge pour la première fois et également lorsqu'elle revient à un état actif. Pour plus d'informations sur le retour à un état actif, consultezRécupération d'un jeton suite à l'inactivité d'une application.

Pour les applications Android ou iOS, vous pouvez WAFTokenResultCallback définir l'opération que vous souhaitez que le fournisseur de jetons appelle lorsqu'un jeton demandé est prêt. Votre implémentation de WAFTokenResultCallback doit prendre les paramètresWAFToken,SdkError. Pour les applications iOS, vous pouvez également créer une fonction intégrée.

storeTokenInCookieStorage(WAFToken)

Indique au de WAFTokenProvider stocker le fichier spécifié AWS WAF jeton dans le gestionnaire SDK de cookies. Par défaut, le jeton n'est ajouté au magasin de cookies que lorsqu'il est acquis pour la première fois et lorsqu'il est actualisé. Si l'application efface le magasin de cookies partagé pour une raison quelconque, SDK elle n'ajoute pas automatiquement le AWS WAF retour du jeton jusqu'à la prochaine actualisation.

WAFConfiguration

Détient la configuration pour la mise en œuvre duWAFTokenProvider. Lorsque vous l'implémentez, vous fournissez l'intégration ACL de votre site WebURL, le nom de domaine à utiliser dans le jeton et tous les paramètres autres que ceux par défaut que vous souhaitez que le fournisseur de jetons utilise.

La liste suivante indique les paramètres de configuration que vous pouvez gérer dans l'WAFConfigurationobjet.

applicationIntegrationUrl

L'intégration de l'applicationURL. Obtenez-le auprès du AWS WAF console ou via l'getWebACLAPIappel.

Obligatoire : oui

Type : spécifique à l'applicationURL. Pour iOS, voir iOS URL. Pour Android, consultez java.net. URL

backgroundRefreshEnabled

Indique si vous souhaitez que le fournisseur de jetons actualise le jeton en arrière-plan. Si vous définissez cette option, le fournisseur de jetons actualise vos jetons en arrière-plan conformément aux paramètres de configuration qui régissent les activités d'actualisation automatique des jetons.

Obligatoire : non

Type : Boolean

Valeur par défaut : TRUE

domainName

Le domaine à utiliser dans le jeton, qui est utilisé pour l'acquisition de jetons et le stockage des cookies. Par exemple, example.com ou aws.amazon.com. Il s'agit généralement du domaine hôte de votre ressource associé au WebACL, sur lequel vous allez envoyer des requêtes Web. Pour le groupe de règles ACFP géréAWSManagedRulesACFPRuleSet, il s'agit généralement d'un domaine unique qui correspond au domaine indiqué dans le chemin de création de compte que vous avez indiqué dans la configuration du groupe de règles. Pour le groupe de règles ATP géréAWSManagedRulesATPRuleSet, il s'agit généralement d'un domaine unique correspondant au domaine indiqué dans le chemin de connexion que vous avez indiqué dans la configuration du groupe de règles.

Les suffixes publics ne sont pas autorisés. Par exemple, vous ne pouvez pas utiliser gov.au ou co.uk comme domaine de jeton.

Le domaine doit être un domaine qui AWS WAF acceptera, en fonction du domaine hôte protégé et de la liste des domaines ACL de jetons du Web. Pour de plus amples informations, veuillez consulter AWS WAF configuration de la liste de domaines de ACL jetons Web.

Obligatoire : oui

Type : String

maxErrorTokenRefreshDelayMsec

Durée maximale en millisecondes d'attente avant de répéter l'actualisation d'un jeton après une tentative infructueuse. Cette valeur est utilisée après l'échec de la récupération du jeton et après plusieurs tentativesmaxRetryCount.

Obligatoire : non

Type : Integer

Valeur par défaut : 5000 (5 secondes)

Valeur minimale autorisée : 1 (1 milliseconde)

Valeur maximale autorisée : 30000 (30 secondes)

maxRetryCount

Nombre maximal de tentatives à effectuer avec un retard exponentiel lorsqu'un jeton est demandé.

Obligatoire : non

Type : Integer

Valeur par défaut : Si l'actualisation de l'arrière-plan est activée,5. Sinon la valeur est renvoy, 3.

Valeur minimale autorisée : 0

Valeur maximale autorisée : 10

setTokenCookie

Indique si vous souhaitez que le SDK gestionnaire de cookies ajoute un cookie symbolique à vos demandes. Par défaut, cela ajoute un cookie symbolique à toutes les demandes. Le gestionnaire de cookies ajoute un cookie jeton à toute demande dont le chemin est inférieur au chemin spécifié danstokenCookiePath.

Obligatoire : non

Type : Boolean

Valeur par défaut : TRUE

tokenCookiePath

Utilisé quand setTokenCookie c'est le casTRUE. Indique le chemin de niveau supérieur où vous souhaitez que le gestionnaire SDK de cookies ajoute un cookie jeton. Le gestionnaire ajoute un cookie symbolique à toutes les demandes que vous envoyez à ce chemin et à tous les chemins enfants.

Par exemple, si vous définissez ce paramètre sur/web/login, le gestionnaire inclut le cookie jeton pour tout ce qui est envoyé /web/login et pour tous ses chemins enfants, par exemple/web/login/help. Il n'inclut pas le jeton pour les demandes envoyées vers d'autres chemins/, comme/web, ou/web/order.

Obligatoire : non

Type : String

Valeur par défaut : /

tokenRefreshDelaySec

Utilisé pour rafraîchir l'arrière-plan. Durée maximale en secondes entre les actualisations du jeton d'arrière-plan.

Obligatoire : non

Type : Integer

Valeur par défaut : 88

Valeur minimale autorisée : 88

Valeur maximale autorisée : 300 (5 minutes)