Die AWS WAF mobile SDK-Spezifikation

In diesem Abschnitt werden die SDK-Objekte, -Operationen und -Konfigurationseinstellungen für die neueste verfügbare Version des SDK für AWS WAF Mobilgeräte aufgeführt. Ausführliche Informationen darüber, wie der Token-Anbieter und die Operationen für die verschiedenen Kombinationen von Konfigurationseinstellungen funktionieren, finden Sie unter So funktioniert das SDK AWS WAF für Mobilgeräte.

WAFToken

Enthält ein AWS WAF Token.

getValue()

Ruft die String-Darstellung des WAFToken auf.

WAFTokenProvider

Verwaltet Token in Ihrer mobilen App. Implementieren Sie dies mit einem WAFConfiguration-Objekt.

getToken()

Wenn die Hintergrundaktualisierung aktiviert ist, wird das zwischengespeicherte Token zurückgegeben. Wenn die Aktualisierung im Hintergrund deaktiviert ist, wird ein synchroner, blockierender Aufruf AWS WAF zum Abrufen eines neuen Tokens ausgeführt.

onTokenReady(WAFTokenResultCallback)

Dadurch wird der Token-Anbieter angewiesen, das Token zu aktualisieren und das bereitgestellte Callback aufzurufen, wenn ein aktives Token bereit ist. Der Token-Anbieter ruft das Callback in einem Hintergrund-Thread auf, wenn das Token zwischengespeichert und bereit ist. Rufen Sie dies auf, wenn Ihre App zum ersten Mal geladen wird und wenn sie wieder in einen aktiven Zustand zurückversetzt wird. Weitere Informationen zum Zurückversetzen in einen aktiven Zustand finden Sie unter Abrufen eines Tokens nach App-Inaktivität.

Für Android- oder iOS-Apps können Sie WAFTokenResultCallback auf die Operation festlegen, die der Token-Anbieter ausführen soll, wenn ein angefordertes Token bereit ist. Bei Ihrer Implementierung von WAFTokenResultCallback müssen die Parameter WAFToken und SdkError übernommen werden. Für iOS-Apps können Sie alternativ eine Inline-Funktion erstellen.

storeTokenInCookieStorage(WAFToken)

Weist den WAFTokenProvider an, das angegebene AWS WAF Token im Cookie-Manager des SDK zu speichern. Standardmäßig wird das Token dem Cookie-Speicher nur hinzugefügt, wenn es zum ersten Mal abgerufen und aktualisiert wird. Wenn die Anwendung den gemeinsamen Cookie-Speicher aus irgendeinem Grund löscht, fügt das SDK das AWS WAF Token erst bei der nächsten Aktualisierung automatisch wieder hinzu.

WAFConfiguration

Enthält die Konfiguration für die Implementierung des WAFTokenProvider. Wenn Sie dies implementieren, geben Sie die Integrations-URL Ihrer Web-ACL, den Domainnamen, der im Token verwendet werden soll, und alle nicht standardmäßigen Einstellungen an, die der Token-Anbieter verwenden soll.

In der folgenden Liste sind die Konfigurationseinstellungen aufgeführt, die Sie im WAFConfiguration-Objekt verwalten.

applicationIntegrationUrl

Die URL der Anwendungsintegration. Rufen Sie dies von der AWS WAF Konsole oder über den getWebACL API-Aufruf ab.

Erforderlich: Ja

Typ: App-spezifische URL. Informationen zu iOS finden Sie unter iOS URL (iOS-URL). Informationen zu Android finden Sie unter java.net URL (java.net-URL).

backgroundRefreshEnabled

Gibt an, ob der Token-Anbieter das Token im Hintergrund aktualisieren soll. Wenn Sie dies festlegen, aktualisiert der Token-Anbieter im Hintergrund Ihre Token gemäß den Konfigurationseinstellungen, die die Aktivitäten zur automatischen Token-Aktualisierung regeln.

Erforderlich: Nein

Typ: Boolean

Standardwert: TRUE

domainName

Die im Token zu verwendende Domain, die bei der Token-Erfassung und Speicherung von Cookies verwendet wird. Zum Beispiel example.com oder aws.amazon.com. Dies ist normalerweise die Hostdomäne Ihrer Ressource, die mit der Web-ACL verknüpft ist, an die Sie Webanfragen senden werden. Für die verwaltete ACFP-Regelgruppe ist dies normalerweise eine einzelne DomäneAWSManagedRulesACFPRuleSet, die der Domäne im Kontoerstellungspfad entspricht, den Sie in der Regelgruppenkonfiguration angegeben haben. Bei der von ATP verwalteten Regelgruppe AWSManagedRulesATPRuleSet handelt es sich in der Regel um eine einzelne Domäne, die der Domäne in dem Anmeldepfad entspricht, den Sie in der Regelgruppenkonfiguration angegeben haben.

Öffentliche Suffixe sind nicht zulässig. Beispielsweise können Sie gov.au oder nicht co.uk als Token-Domain verwenden.

Die Domain muss akzeptiert AWS WAF werden, basierend auf der geschützten Host-Domain und der Token-Domainliste der Web-ACL. Weitere Informationen finden Sie unter Konfiguration der Domainliste für Web-ACL-Tokens.

Erforderlich: Ja

Typ: String

maxErrorTokenRefreshDelayMsec

Maximale Wartezeit in Millisekunden, bevor eine Token-Aktualisierung nach einem fehlgeschlagenen Versuch wiederholt wird. Dieser Wert wird verwendet, nachdem der Token-Abruf fehlgeschlagen ist und maxRetryCount-mal erneut versucht wurde.

Erforderlich: Nein

Typ: Integer

Standardwert: 5000 (5 Sekunden)

Zulässiger Mindestwert: 1 (1 Millisekunde)

Zulässiger Höchstwert: 30000 (30 Sekunden)

maxRetryCount

Die maximale Anzahl von Wiederholungen, die mit exponentiellem Backoff ausgeführt werden sollen, wenn ein Token angefordert wird.

Erforderlich: Nein

Typ: Integer

Standardwert: Wenn die Hintergrundaktualisierung aktiviert ist, 5. Andernfalls 3.

Zulässiger Mindestwert: 0

Zulässiger Höchstwert: 10

setTokenCookie

Gibt an, ob der Cookie-Manager des SDK Ihren Anforderungen ein Token-Cookie hinzufügen soll. Standardmäßig wird allen Anforderungen ein Token-Cookie hinzugefügt. Der Cookie-Manager fügt jeder Anforderung ein Token-Cookie hinzu, deren Pfad unter dem in tokenCookiePath angegebenen liegt.

Erforderlich: Nein

Typ: Boolean

Standardwert: TRUE

tokenCookiePath

Wird verwendet wenn setTokenCookie TRUE ist. Gibt den obersten Pfad an, auf dem der Cookie-Manager des SDK ein Token-Cookie hinzufügen soll. Der Manager fügt allen Anforderungen, die Sie an diesen Pfad und an alle untergeordneten Pfade senden, ein Token-Cookie hinzu.

Wenn Sie hierfür beispielsweise /web/login festlegen, schließt der Manager das Token-Cookie für alles ein, was an /web/login und sämtliche untergeordneten Pfade, etwa /web/login/help, gesendet wird. Nicht enthalten ist das Token für Anforderungen, die an andere Pfade gesendet werden, etwa /, /web oder /web/order.

Erforderlich: Nein

Typ: String

Standardwert: /

tokenRefreshDelaySec

Wird für die Hintergrundaktualisierung verwendet. Die maximale Zeitspanne in Sekunden zwischen den Hintergrundaktualisierungen des Tokens wird angezeigt.

Erforderlich: Nein

Typ: Integer

Standardwert: 88

Zulässiger Mindestwert: 88

Zulässiger Höchstwert: 300 (5 Minuten)