La especificación del SDK AWS WAF móvil - AWS WAF, AWS Firewall Manager, y AWS Shield Advanced

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

La especificación del SDK AWS WAF móvil

En esta sección, se enumeran los objetos, las operaciones y los ajustes de configuración del SDK para la última versión disponible del SDK para móviles de AWS WAF . Para obtener información detallada sobre cómo funcionan el proveedor de tokens y las operaciones para las distintas combinaciones de ajustes de configuración, consulte Cómo funciona el SDK AWS WAF móvil.

WAFToken

Contiene un AWS WAF token.

getValue()

Recupera la representación String del valor WAFToken.

WAFTokenProvider

Administra los tokens en su aplicación para móviles. Implemente esto usando un objeto WAFConfiguration.

getToken()

Si la actualización en segundo plano está habilitada, devuelve el token almacenado en caché. Si la actualización en segundo plano está desactivada, se realiza una llamada síncrona y bloqueante AWS WAF a para recuperar un nuevo token.

onTokenReady(WAFTokenResultCallback)

Indica al proveedor de tokens que actualice el token e invoque la devolución de llamada proporcionada cuando haya un token activo listo. El proveedor de tokens invocará la devolución de llamada en un hilo en segundo plano cuando el token esté en caché y esté listo. Llame a esto cuando la aplicación se cargue por primera vez y también cuando vuelva a un estado activo. Para obtener más información sobre cómo volver a un estado activo, consulte Recuperación de un token tras la inactividad de la aplicación.

Para las aplicaciones de Android o iOS, puede configurar WAFTokenResultCallback en la operación que desee que el proveedor de tokens invoque cuando el token solicitado esté listo. Su implementación de WAFTokenResultCallback debe tomar los parámetros WAFToken, SdkError. Para las aplicaciones de iOS, también puede crear una función en línea.

storeTokenInCookieStorage(WAFToken)

Le indica WAFTokenProvider que almacene el AWS WAF token especificado en el administrador de cookies del SDK. De forma predeterminada, el token solo se agrega al almacén de cookies cuando se adquiere por primera vez y cuando se actualiza. Si la aplicación borra el almacén de cookies compartido por cualquier motivo, el SDK no volverá a añadir el AWS WAF token automáticamente hasta la próxima actualización.

WAFConfiguration

Contiene la configuración para la implementación de WAFTokenProvider. Al implementar esto, debe proporcionar la URL de integración de la ACL web, el nombre de dominio que se utilizará en el token y cualquier configuración no predeterminada que desee que utilice el proveedor de tokens.

La siguiente lista especifica los ajustes de configuración que puede administrar en el objeto WAFConfiguration.

applicationIntegrationUrl

La URL de integración de aplicaciones. Consíguelo desde la AWS WAF consola o mediante una llamada a la getWebACL API.

Obligatorio: sí

Tipo: URL específica de la aplicación. Para iOS, consulte URL de iOS. Para Android, consulte URL java.net.

backgroundRefreshEnabled

Indica si desea que el proveedor de tokens actualice el token en segundo plano. Si lo establece, el proveedor de tokens los actualiza en segundo plano de acuerdo con los ajustes de configuración que rigen las actividades de actualización automática de los tokens.

Obligatorio: no

Tipo: Boolean

Valor predeterminado: TRUE

domainName

El dominio que se utilizará en el token, que se utiliza para la adquisición de tokens y el almacenamiento de cookies. Por ejemplo, example.com o aws.amazon.com. Suele ser el dominio del host de su recurso que está asociado a la ACL web, al que enviará las solicitudes web. En el caso del grupo de reglas administrado de la ACFP, AWSManagedRulesACFPRuleSet, este suele ser un dominio único que coincide con el dominio de la ruta de creación de cuentas que proporcionó en la configuración del grupo de reglas. En el caso del grupo de reglas administrado de ATP, AWSManagedRulesATPRuleSet, este suele ser un dominio único que coincide con el dominio de la ruta de inicio de sesión que proporcionó en la configuración del grupo de reglas.

No se admiten sufijos públicos. Por ejemplo, no puede usar gov.au o co.uk como dominio de token.

El dominio debe ser uno que AWS WAF acepte, según el dominio host protegido y la lista de dominios simbólicos de la ACL web. Para obtener más información, consulte AWS WAF Configuración de la lista de dominios del token ACL web.

Obligatorio: sí

Tipo: String

maxErrorTokenRefreshDelayMsec

El tiempo máximo en milisegundos para esperar antes de repetir una actualización del token después de un intento fallido. Este valor se utiliza cuando la recuperación del token ha fallado y se ha vuelto a intentar maxRetryCount veces.

Obligatorio: no

Tipo: Integer

Valor predeterminado: 5000 (5 segundos)

Valor mínimo permitido: 1 (1 milisegundo)

Valor máximo permitido: 30000 (30 segundos)

maxRetryCount

El número máximo de reintentos que se pueden realizar con un retroceso exponencial cuando se solicita un token.

Obligatorio: no

Tipo: Integer

Valor predeterminado: si la actualización en segundo plano está habilitada, 5. De lo contrario, 3.

Valor mínimo permitido: 0

Valor máximo permitido: 10

setTokenCookie

Indique si desea que el administrador de cookies del SDK agregue una cookie de token en sus solicitudes. De forma predeterminada, esto añade una cookie de token a todas las solicitudes. El administrador de cookies agrega una cookie de token a cualquier solicitud cuya ruta esté por debajo de la ruta especificada en tokenCookiePath.

Obligatorio: no

Tipo: Boolean

Valor predeterminado: TRUE

tokenCookiePath

Se usa cuando setTokenCookie es TRUE. Indica la ruta de nivel superior en la que desea que el gestor de cookies del SDK añada una cookie de token. El administrador agrega una cookie de token a todas las solicitudes que envíe a esta ruta y a todas las rutas secundarias.

Por ejemplo, si lo establece en /web/login, el administrador incluirá la cookie de token para todo lo que se envíe a /web/login y para cualquiera de sus rutas secundarias, como /web/login/help. No incluye el token para las solicitudes enviadas a otras rutas, como /, /web o /web/order.

Obligatorio: no

Tipo: String

Valor predeterminado: /

tokenRefreshDelaySec

Se utiliza para la actualización en segundo plano. La cantidad máxima de tiempo en segundos entre las actualizaciones del token en segundo plano.

Obligatorio: no

Tipo: Integer

Valor predeterminado: 88

Valor mínimo permitido: 88

Valor máximo permitido: 300 (5 minutos)