Spécification du SDK AWS WAF mobile

Cette section répertorie les objets du SDK, les opérations et les paramètres de configuration de la dernière version disponible du SDK AWS WAF mobile. 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, consultezFonctionnement du SDK AWS WAF mobile.

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, un appel synchrone bloquant est lancé 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 WAFTokenProvider de stocker le AWS WAF jeton spécifié dans le gestionnaire de cookies du SDK. 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, le SDK n'ajoute pas automatiquement le AWS WAF jeton avant la prochaine actualisation.

WAFConfiguration

Détient la configuration pour la mise en œuvre duWAFTokenProvider. Lorsque vous implémentez cela, vous fournissez l'URL d'intégration de votre ACL Web, 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

URL d'intégration de l'application. Obtenez-le depuis la AWS WAF console ou via l'appel getWebACL d'API.

Obligatoire : oui

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

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é à l'ACL Web, dans lequel vous allez envoyer des requêtes Web. Pour le groupe de règles géré par l'ACFPAWSManagedRulesACFPRuleSet, il s'agit généralement d'un domaine unique correspondant 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 géré par ATPAWSManagedRulesATPRuleSet, 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 accepté, sur la base du domaine hôte protégé et de la liste des domaines de jetons de l'ACL Web. AWS WAF Pour plus d’informations, consultez AWS WAF configuration de la liste de domaines du jeton ACL 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 gestionnaire de cookies du SDK ajoute un cookie jeton à 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 de cookies du SDK 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 le rafraîchissement de 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)