Especificación del SDK para móviles de AWS WAF

Recupera la representación String del valor WAFToken.

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 a AWS WAF para recuperar un nuevo token.

Carga el token especificado en elWAFTokenProvider, reemplazando cualquier token que el proveedor administraba. El proveedor de tokens toma posesión del token nuevo y continúa administrando su actualización. Esta operación también actualiza el token en el almacén de cookies si setTokenCookie está habilitado en el WAFConfiguration.

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.

Indica al WAFTokenProvider que almacene el token de AWS WAF 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 agregar el token de AWS WAF automáticamente hasta la próxima actualización.

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

Obligatorio: sí

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

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

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. Por lo general, este es el dominio host del recurso asociado con el paquete de protección (ACL web), hacia el cual enviará solicitudes web. En el caso del grupo de reglas administradas 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 administradas 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 del token del paquete de protección (ACL web). Para obtener más información, consulte Configuración de la lista de dominios de tokens del paquete de protección (ACL web) de AWS WAF.

Obligatorio: sí

Tipo:: String

El tiempo máximo en milisegundos para esperar antes de repetir una actualización del token después de un intento fallido. En cada reintento automático tras un intento fallido, se añade un retroceso exponencial hasta alcanzar el tiempo de demora especificado. 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)

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: #: Infinity

Valor mínimo permitido: 0

Valor máximo permitido: 100

Indica si desea que el administrador de cookies del SDK agregue una cookie de token en las solicitudes y en otras áreas.

Con un valor TRUE:

Obligatorio: no

Tipo:: Boolean

Valor predeterminado: #: TRUE

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: #: /

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)

Este error se devuelve cuando el servidor de tokens devuelve datos de desafío no válidos o cuando un atacante altera la respuesta.

Este error se devuelve cuando el servidor de tokens envía un código de respuesta no exitoso al cliente o cuando ocurre un error de red.

Este error se devuelve cuando ocurre un error al obtener el aws-waf-token de la respuesta de verificación del servidor AWS WAF, o cuando la respuesta del servidor fue manipulada.

Este error se devuelve cuando el cliente recibe una respuesta incorrecta del servidor AWS WAF o cuando ocurre un error de red durante la verificación del desafío resuelto.

Este error se devuelve ante cualquier otro error que pueda ocurrir dentro del propio SDK.