A AWS WAF especificação do SDK móvel

Esta seção lista os objetos, as operações e as configurações de SDK para a versão mais recente disponível do SDK móvel do AWS WAF . Para obter informações detalhadas sobre como o provedor de token e as operações funcionam para as várias combinações de configurações, consulte Como o SDK AWS WAF móvel funciona.

WAFToken

Guarda uma AWS WAF ficha.

getValue()

Recupera a representação String de WAFToken.

WAFTokenProvider

Gerencia tokens em seu aplicativo móvel. Implemente isso usando um objeto WAFConfiguration.

getToken()

Se a atualização em segundo plano estiver ativada, isso retornará o token em cache. Se a atualização em segundo plano estiver desativada, isso fará uma chamada síncrona e bloqueadora AWS WAF para recuperar um novo token.

onTokenReady(WAFTokenResultCallback)

Instrui o provedor de token a atualizar o token e invocar o retorno de chamada fornecido quando um token ativo estiver pronto. O provedor do token invocará seu retorno de chamada em um thread em segundo plano quando o token estiver armazenado em cache e pronto. Chame isso quando seu aplicativo for carregado pela primeira vez e também quando ele voltar ao estado ativo. Para obter mais informações sobre como retornar a um estado ativo, consulte Recuperação de um token após a inatividade do aplicativo.

Para aplicativos Android ou iOS, você pode definir WAFTokenResultCallback para a operação que deseja que o provedor de token invoque quando um token solicitado estiver pronto. Sua implementação do WAFTokenResultCallback deve seguir os parâmetros WAFToken, SdkError. Para aplicativos iOS, você pode criar alternadamente uma função embutida.

storeTokenInCookieStorage(WAFToken)

Instrui o WAFTokenProvider a armazenar o AWS WAF token especificado no gerenciador de cookies do SDK. Por padrão, o token só é adicionado ao armazenamento de cookies quando é adquirido pela primeira vez e quando é atualizado. Se o aplicativo limpar o armazenamento de cookies compartilhado por qualquer motivo, o SDK não adicionará automaticamente o AWS WAF token de volta até a próxima atualização.

WAFConfiguration

Mantém a configuração para a implementação do WAFTokenProvider. Ao implementar isso, você fornece o URL de integração da sua web ACL, o nome de domínio a ser usado no token e todas as configurações não padrão que você deseja que o provedor de token use.

A lista a seguir especifica as configurações que você pode gerenciar no objeto WAFConfiguration.

applicationIntegrationUrl

O URL de integração do aplicativo. Obtenha isso no AWS WAF console ou por meio da chamada de getWebACL API.

Obrigatório: Sim

Tipo: URL específico do aplicativo. Para iOS, consulte o URL do iOS. Para Android, consulte o URL do java.net.

backgroundRefreshEnabled

Indica se você deseja que o provedor de token atualize o token em segundo plano. Se você definir isso, o provedor de token atualizará seus tokens em segundo plano de acordo com as configurações que regem as atividades de atualização automática de tokens.

Obrigatório: não

Tipo: Boolean

Valor padrão: TRUE

domainName

O domínio a ser usado no token, que é usado na aquisição e armazenamento de cookies. Por exemplo, o example.com ou o aws.amazon.com. Geralmente, esse é o domínio do host do seu recurso associado à web ACL, para onde você enviará solicitações da web. Para o grupo de regras gerenciadas do ACFP, AWSManagedRulesACFPRuleSet, geralmente será um único domínio que corresponde ao domínio no caminho de criação da conta que você forneceu na configuração do grupo de regras. Para o grupo de regras gerenciadas do ATP, AWSManagedRulesATPRuleSet, geralmente será um único domínio que corresponde ao domínio no caminho de login fornecido na configuração do grupo de regras.

Não são permitidos sufixos públicos. Por exemplo, você não pode usar gov.au ou co.uk como domínio do token.

O domínio deve ser aceito, com base no domínio do host protegido e na lista de domínios de tokens da ACL da web. AWS WAF Para ter mais informações, consulte Configurando a lista de domínios de tokens da web ACL.

Obrigatório: Sim

Tipo: String

maxErrorTokenRefreshDelayMsec

O tempo máximo em milissegundos a se esperar antes de repetir uma atualização de token após uma tentativa malsucedida. Esse valor é usado depois que a recuperação do token falhou e foi repetida maxRetryCount vezes.

Obrigatório: não

Tipo: Integer

Valor padrão: 5000 (5 segundos)

Valor mínimo permitido: 1 (1 milissegundo)

Valor máximo permitido: 30000 (30 segundos)

maxRetryCount

O número máximo de novas tentativas a serem executadas com recuo exponencial quando um token é solicitado.

Obrigatório: não

Tipo: Integer

Valor padrão: se a atualização em segundo plano estiver ativada, 5. Caso contrário, 3.

Valor mínimo permitido: 0

Valor máximo permitido: 10

setTokenCookie

Indica se você deseja que o gerenciador de cookies do SDK adicione um cookie de token às suas solicitações. Por padrão, isso adiciona um cookie de token a todas as solicitações. O gerenciador de cookies adiciona um cookie de token a qualquer solicitação cujo caminho esteja abaixo do caminho especificado em tokenCookiePath.

Obrigatório: não

Tipo: Boolean

Valor padrão: TRUE

tokenCookiePath

Usado quando setTokenCookie é TRUE. Indica o caminho de nível superior em que você deseja que o gerenciador de cookies do SDK adicione um cookie de token. O gerente adiciona um cookie de token a todas as solicitações que você envia para esse caminho e para todos os caminhos secundários.

Por exemplo, se você definir isso como /web/login, o gerenciador incluirá o cookie de token para tudo o que é enviado para /web/login e para qualquer um de seus caminhos secundários, como /web/login/help. Ele não inclui o token para solicitações enviadas para outros caminhos, como /, /web ou /web/order.

Obrigatório: não

Tipo: String

Valor padrão: /

tokenRefreshDelaySec

Usado para atualização em segundo plano. O tempo máximo em segundos entre as atualizações do token em segundo plano.

Obrigatório: não

Tipo: Integer

Valor padrão: 88

Valor mínimo permitido: 88

Valor máximo permitido: 300 (5 minutos)