Le specifiche SDK AWS WAF per dispositivi mobili

Questa sezione elenca gli oggetti SDK, le operazioni e le impostazioni di configurazione per l'ultima versione disponibile dell'SDK AWS WAF mobile. Per informazioni dettagliate su come funzionano il provider di token e le operazioni per le varie combinazioni di impostazioni di configurazione, consulta. Come funziona l'SDK AWS WAF per dispositivi mobili

WAFToken

Detiene un AWS WAF token.

getValue()

Recupera la String rappresentazione di. WAFToken

WAFTokenProvider

Gestisce i token nella tua app mobile. Implementalo usando un WAFConfiguration oggetto.

getToken()

Se l'aggiornamento in background è abilitato, restituisce il token memorizzato nella cache. Se l'aggiornamento in background è disabilitato, viene effettuata una chiamata sincrona e bloccante AWS WAF a per recuperare un nuovo token.

onTokenReady(WAFTokenResultCallback)

Indica al fornitore del token di aggiornare il token e di richiamare il callback fornito quando un token attivo è pronto. Il fornitore del token invocherà il callback in un thread in background quando il token è memorizzato nella cache e pronto. Chiamalo quando l'app viene caricata per la prima volta e anche quando torna allo stato attivo. Per ulteriori informazioni sul ritorno a uno stato attivo, consultaRecupero di un token dopo l'inattività dell'app.

Per le app Android o iOS, puoi WAFTokenResultCallback impostare l'operazione che desideri venga richiamata dal provider del token quando un token richiesto è pronto. La tua implementazione di WAFTokenResultCallback deve accettare i parametriWAFToken,SdkError. Per le app iOS, puoi creare alternativamente una funzione in linea.

storeTokenInCookieStorage(WAFToken)

Indica WAFTokenProvider a memorizzare il AWS WAF token specificato nel gestore dei cookie dell'SDK. Per impostazione predefinita, il token viene aggiunto all'archivio dei cookie solo quando viene acquisito per la prima volta e quando viene aggiornato. Se l'applicazione cancella l'archivio di cookie condiviso per qualsiasi motivo, l'SDK non aggiunge automaticamente il AWS WAF token fino al prossimo aggiornamento.

WAFConfiguration

Contiene la configurazione per l'implementazione di. WAFTokenProvider Quando lo implementate, fornite l'URL di integrazione dell'ACL Web, il nome di dominio da utilizzare nel token e tutte le impostazioni non predefinite che desiderate che il provider del token utilizzi.

L'elenco seguente specifica le impostazioni di configurazione che è possibile gestire nell'oggetto. WAFConfiguration

applicationIntegrationUrl

L'URL di integrazione dell'applicazione. Scaricalo dalla AWS WAF console o tramite la chiamata getWebACL API.

Campo obbligatorio: sì

Tipo: URL specifico dell'app. Per iOS, vedi URL iOS. Per Android, vedi l'URL java.net.

backgroundRefreshEnabled

Indica se desideri che il fornitore del token aggiorni il token in background. Se si imposta questa impostazione, il provider di token aggiorna i token in background in base alle impostazioni di configurazione che regolano le attività di aggiornamento automatico dei token.

Campo obbligatorio: no

Tipo: Boolean

Valore predefinito: TRUE

domainName

Il dominio da utilizzare nel token, utilizzato per l'acquisizione dei token e l'archiviazione dei cookie. Ad esempio example.com o aws.amazon.com. Di solito si tratta del dominio host della risorsa associato all'ACL web, a cui invierai le richieste web. Per il gruppo di regole gestito ACFPAWSManagedRulesACFPRuleSet, in genere si tratta di un singolo dominio che corrisponde al dominio nel percorso di creazione dell'account fornito nella configurazione del gruppo di regole. Per il gruppo di regole gestito ATPAWSManagedRulesATPRuleSet, in genere si tratta di un singolo dominio che corrisponde al dominio nel percorso di accesso fornito nella configurazione del gruppo di regole.

I suffissi pubblici non sono consentiti. Ad esempio, non puoi usare gov.au or co.uk come dominio del token.

Il dominio deve essere accettato, in base al dominio host protetto e all'elenco di domini token dell'ACL Web. AWS WAF Per ulteriori informazioni, consulta AWS WAF configurazione dell'elenco di domini con token ACL web.

Campo obbligatorio: sì

Tipo: String

maxErrorTokenRefreshDelayMsec

Il tempo massimo di attesa in millisecondi prima di ripetere un aggiornamento del token dopo un tentativo fallito. Questo valore viene utilizzato dopo che il recupero del token non è riuscito ed è stato ripetuto più volte. maxRetryCount

Campo obbligatorio: no

Tipo: Integer

Valore predefinito: 5000 (5 secondi)

Valore minimo consentito: 1 (1 millisecondo)

Valore massimo consentito: 30000 (30 secondi)

maxRetryCount

Il numero massimo di tentativi da eseguire con backoff esponenziale quando viene richiesto un token.

Campo obbligatorio: no

Tipo: Integer

Valore predefinito: se l'aggiornamento in background è abilitato,. 5 In caso contrario, 3.

Valore minimo consentito: 0

Valore massimo consentito: 10

setTokenCookie

Indica se desideri che il gestore dei cookie dell'SDK aggiunga un cookie token nelle tue richieste. Per impostazione predefinita, questo aggiunge un cookie token a tutte le richieste. Il gestore dei cookie aggiunge un cookie token a qualsiasi richiesta il cui percorso si trova nel percorso specificato intokenCookiePath.

Campo obbligatorio: no

Tipo: Boolean

Valore predefinito: TRUE

tokenCookiePath

Usato quando setTokenCookie èTRUE. Indica il percorso di primo livello in cui desideri che il gestore dei cookie dell'SDK aggiunga un cookie token. Il gestore aggiunge un cookie token a tutte le richieste inviate a questo percorso e a tutti i percorsi secondari.

Ad esempio, se lo imposti su/web/login, il gestore include il cookie token per tutto ciò che viene inviato /web/login e per tutti i relativi percorsi secondari, ad esempio/web/login/help. Non include il token per le richieste inviate ad altri percorsi, come //web, o/web/order.

Campo obbligatorio: no

Tipo: String

Valore predefinito: /

tokenRefreshDelaySec

Utilizzato per l'aggiornamento dello sfondo. La quantità massima di tempo in secondi tra gli aggiornamenti dei token in background.

Campo obbligatorio: no

Tipo: Integer

Valore predefinito: 88

Valore minimo consentito: 88

Valore massimo consentito: 300 (5 minuti)