Spesifikasi SDK AWS WAF seluler

Bagian ini mencantumkan objek SDK, operasi, dan pengaturan konfigurasi untuk versi SDK AWS WAF seluler terbaru yang tersedia. Untuk informasi terperinci tentang cara kerja penyedia token dan operasi untuk berbagai kombinasi pengaturan konfigurasi, lihatCara kerja SDK AWS WAF seluler.

WAFToken

Memegang AWS WAF token.

getValue()

Mengambil String representasi dari. WAFToken

WAFTokenProvider

Mengelola token di aplikasi seluler Anda. Terapkan ini menggunakan WAFConfiguration objek.

getToken()

Jika penyegaran latar belakang diaktifkan, ini mengembalikan token yang di-cache. Jika penyegaran latar belakang dinonaktifkan, ini membuat panggilan pemblokiran sinkron AWS WAF untuk mengambil token baru.

onTokenReady(WAFTokenResultCallback)

Menginstruksikan penyedia token untuk menyegarkan token dan memanggil panggilan balik yang disediakan saat token aktif siap. Penyedia token akan memanggil panggilan balik Anda di utas latar belakang saat token di-cache dan siap. Panggil ini saat aplikasi Anda pertama kali dimuat dan juga saat kembali ke status aktif. Untuk informasi selengkapnya tentang kembali ke status aktif, lihatMengambil token setelah aplikasi tidak aktif.

Untuk aplikasi Android atau iOS, Anda dapat mengatur WAFTokenResultCallback ke operasi yang ingin dijalankan oleh penyedia token saat token yang diminta sudah siap. Implementasi Anda WAFTokenResultCallback harus mengambil parameterWAFToken,SdkError. Untuk aplikasi iOS, Anda dapat membuat fungsi inline secara bergantian.

storeTokenInCookieStorage(WAFToken)

Menginstruksikan WAFTokenProvider untuk menyimpan AWS WAF token yang ditentukan ke dalam manajer cookie SDK. Secara default, token hanya ditambahkan ke toko cookie saat pertama kali diperoleh dan saat di-refresh. Jika aplikasi menghapus penyimpanan cookie bersama karena alasan apa pun, SDK tidak secara otomatis menambahkan AWS WAF token kembali hingga penyegaran berikutnya.

WAFConfiguration

Memegang konfigurasi untuk implementasiWAFTokenProvider. Saat Anda menerapkan ini, Anda memberikan URL integrasi ACL web Anda, nama domain yang akan digunakan dalam token, dan pengaturan non-default apa pun yang Anda inginkan untuk digunakan oleh penyedia token.

Daftar berikut menentukan pengaturan konfigurasi yang dapat Anda kelola dalam WAFConfiguration objek.

applicationIntegrationUrl

URL integrasi aplikasi. Dapatkan ini dari AWS WAF konsol atau melalui panggilan getWebACL API.

Diperlukan: Ya

Jenis: URL khusus aplikasi. Untuk iOS, lihat URL iOS. Untuk Android, lihat URL java.net.

backgroundRefreshEnabled

Menunjukkan apakah Anda ingin penyedia token menyegarkan token di latar belakang. Jika Anda menyetel ini, penyedia token akan menyegarkan token Anda di latar belakang sesuai dengan pengaturan konfigurasi yang mengatur aktivitas penyegaran token otomatis.

Diperlukan: Tidak

Tipe: Boolean

Nilai default: TRUE

domainName

Domain yang akan digunakan dalam token, yang digunakan dalam akuisisi token dan penyimpanan cookie. Misalnya, example.com atau aws.amazon.com. Ini biasanya domain host dari sumber daya Anda yang terkait dengan ACL web, tempat Anda akan mengirim permintaan web. Untuk grup aturan terkelola ACFPAWSManagedRulesACFPRuleSet, ini biasanya akan menjadi domain tunggal yang cocok dengan domain di jalur pembuatan akun yang Anda berikan dalam konfigurasi grup aturan. Untuk grup aturan terkelola ATPAWSManagedRulesATPRuleSet, ini biasanya akan menjadi domain tunggal yang cocok dengan domain di jalur login yang Anda berikan dalam konfigurasi grup aturan.

Sufiks publik tidak diizinkan. Misalnya, Anda tidak dapat menggunakan gov.au atau co.uk sebagai domain token.

Domain harus menjadi salah satu yang AWS WAF akan menerima, berdasarkan domain host yang dilindungi dan daftar domain token ACL web. Untuk informasi selengkapnya, lihat Mengkonfigurasi daftar domain token ACL web.

Diperlukan: Ya

Tipe: String

maxErrorTokenRefreshDelayMsec

Waktu maksimum dalam milidetik untuk menunggu sebelum mengulangi penyegaran token setelah upaya gagal. Nilai ini digunakan setelah pengambilan token gagal dan berulang kali dicobamaxRetryCount.

Diperlukan: Tidak

Tipe: Integer

Nilai default: 5000 (5 detik)

Nilai minimum yang diizinkan: 1 (1 milidetik)

Nilai maksimum yang diizinkan: 30000 (30 detik)

maxRetryCount

Jumlah maksimum percobaan ulang untuk dilakukan dengan backoff eksponensial ketika token diminta.

Diperlukan: Tidak

Tipe: Integer

Nilai default: Jika penyegaran latar belakang diaktifkan,5. Atau, 3.

Nilai minimum yang diizinkan: 0

Nilai maksimum yang diizinkan: 10

setTokenCookie

Menunjukkan apakah Anda ingin pengelola cookie SDK menambahkan cookie token dalam permintaan Anda. Secara default, ini menambahkan cookie token ke semua permintaan. Manajer cookie menambahkan cookie token ke permintaan apa pun yang jalurnya berada di bawah jalur yang ditentukan dalamtokenCookiePath.

Diperlukan: Tidak

Tipe: Boolean

Nilai default: TRUE

tokenCookiePath

Digunakan kapan setTokenCookieTRUE. Menunjukkan jalur tingkat atas tempat Anda ingin pengelola cookie SDK menambahkan cookie token. Manajer menambahkan cookie token ke semua permintaan yang Anda kirim ke jalur ini dan ke semua jalur anak.

Misalnya, jika Anda menyetel ini/web/login, maka manajer menyertakan cookie token untuk semua yang dikirim ke /web/login dan jalur turunannya, seperti/web/login/help. Itu tidak termasuk token untuk permintaan yang dikirim ke jalur lain, seperti/,/web, atau/web/order.

Diperlukan: Tidak

Tipe: String

Nilai default: /

tokenRefreshDelaySec

Digunakan untuk penyegaran latar belakang. Jumlah waktu maksimum dalam hitungan detik antara token latar belakang menyegarkan.

Diperlukan: Tidak

Tipe: Integer

Nilai default: 88

Nilai minimum yang diizinkan: 88

Nilai maksimum yang diizinkan: 300 (5 menit)