Validasi kepatuhan token API memverifikasi JSON Web Token (JWT) pada request yang masuk berdasarkan konfigurasi token yang Anda tentukan. Anda dapat menambahkan JWT kustom, mengaitkannya dengan API yang memerlukan validasi, dan memungkinkan Edge Security Acceleration (ESA) memvalidasi request yang masuk untuk mengamankan API bisnis Anda.
Batasan
Batasan berikut berlaku untuk validasi kepatuhan token API:
Jenis token yang didukung: Saat ini hanya JSON Web Token (JWT) yang didukung.
Format kunci publik: Hanya format JWK yang didukung. Kunci publik JWT harus menyertakan bidang
kiddanalg.Algoritma signature: Algoritma signature berikut saat ini didukung:
ES256(ECDSA dengan SHA-256) danRS256(RSA dengan SHA-256).
Mengonfigurasi aturan token API
Untuk mengaktifkan validasi kepatuhan token API, selesaikan dua tahap berikut secara berurutan: pertama, tambahkan konfigurasi token; kedua, buat aturan API untuk menerapkan konfigurasi tersebut ke API Anda.
Menambahkan konfigurasi token
Masuk ke Konsol ESA.
Di Konsol ESA, pilih Websites, lalu pada kolom Website, klik situs target.
Di panel navigasi kiri, pilih Security > API Security.
Pada halaman API Security, pilih tab API Rules, lalu klik Token Configuration.
Pada halaman pengaturan, klik Add untuk menambahkan informasi token.
Tentukan parameter token berikut sesuai kebutuhan bisnis Anda:
Name: Masukkan nama token kustom, misalnya
JWT-Demo.Token Location: Pilih lokasi token dalam request. Anda dapat memilih bidang Header atau Cookie, lalu masukkan kunci yang sesuai. Untuk mengakomodasi JWT yang berada di berbagai lokasi, klik Or untuk membuat kondisi logis
OR. Anda dapat mengevaluasi hingga empat lokasi token secara bersamaan.Secret Key: Tambahkan kunci token dengan memasukkannya secara manual atau mengunggah file JSON. Untuk persyaratan kunci, lihat Bidang JWK. Jika Anda mengonfigurasi beberapa kunci, ESA akan memilih kunci berdasarkan bidang
kiduntuk validasi. Validasi dianggap berhasil jika salah satu kunci berhasil memvalidasi token.
Klik OK.
Membuat aturan API
Kembali ke tab API Rules dan klik Add Rule.
Konfigurasikan parameter validasi token sesuai kebutuhan bisnis Anda:
Rule Name: Masukkan nama aturan kustom, misalnya
rule-jwt-demo.Validate API: Dari daftar drop-down, pilih catatan host yang memerlukan validasi kepatuhan token. ESA kemudian menampilkan daftar API di bawah catatan host yang dipilih. Tinjau daftar tersebut dan pilih API yang ingin divalidasi.
Select Token Configuration: Pilih satu atau lebih token untuk divalidasi. Jika Anda memilih beberapa token, pilih salah satu opsi berikut:
Validasi setidaknya satu konfigurasi: Request harus sesuai dengan setidaknya satu konfigurasi token. Jika tidak, request dianggap tidak patuh.
Validate all: Request harus sesuai dengan semua konfigurasi token. Jika tidak, request dianggap tidak patuh.
Secara default, request tanpa token ditandai sebagai tidak patuh. Jika Anda memiliki persyaratan khusus, buka kolom If No Token di sebelah kanan token dan pilih Ignore dari daftar drop-down.
Execute: Pilih aksi yang akan diterapkan pada request yang gagal dalam validasi token:
Monitor: Izinkan request yang tidak patuh dan catat log. Anda dapat melihat detailnya di Analisis event.
Block: Blokir request yang tidak patuh dan catat log pemblokiran. Anda dapat melihat detailnya di Analisis event.
Hasil perlindungan
Setelah membuat aturan API, pilih Security > Events di panel navigasi kiri. Pada halaman analisis event, gunakan filter untuk memilih API Rules sebagai aturan perlindungan. Kemudian, gulir ke bawah ke area Sampling Logs untuk melihat log perlindungan secara rinci.
Bidang JWK
Kunci yang Anda kirimkan tidak boleh berisi komentar.
Kunci publik JWK mencakup bidang-bidang berikut:
kty: Jenis kunci. Misalnya,ECmenunjukkan kunci elliptic curve;RSAmenunjukkan kunci RSA.use: Tujuan penggunaan kunci publik. Misalnya,sigmenunjukkan bahwa kunci digunakan untuk signature digital.crv: Jenis elliptic curve. Misalnya,P-256menunjukkan elliptic curve P-256 yang didefinisikan oleh NIST.kid: Pengenal kunci kustom, misalnyaesa. JWK harus menyertakan bidangkidyang digunakan untuk memilih kunci. Demikian pula, klaim dalam JWT dari request juga harus menyertakan bidangkid. Anda dapat menggunakan bidang ini untuk merotasi kunci token.n: Modulus dari kunci RSA.e: Eksponen publik dari kunci RSA.x: Koordinat x dari kunci publik elliptic curve.y: Koordinat y dari kunci publik elliptic curve.alg: Pengenal algoritma. Nilai-nilai berikut saat ini didukung:ES256(ECDSA dengan SHA-256) danRS256(RSA dengan SHA-256).
Contoh
Contoh berikut menunjukkan kunci publik JWK dalam bentuk RSA. Saat menggunakan kunci RSA, biarkan bidang crv, x, dan y sebagai string kosong.
{
"kty": "RSA",
"use": "sig",
"kid": "esa",
"n": "wR8LJDq2pM1uPD5KfmMaasmV20nwgVYnDlsxRjmryLStQeqW-3fe-ELV1tlYHq2-hl8HNNxz5eud8olmqxtrgpihPN9c_pbLY-Jc04_tdpWs10ms1vgoz0S11JEVCK6q9EJ_QCTAxO6GBCdI9t0oUTpBz6QuQCIJAOQdW2k7gZr8CmCn_ianTU1nTxBzAoBxO_r32kl7lx9RTFCZHBJsm8twJ7o0ZXpUjbjhOY2LgdDx3t09YDDOMDYzEOZ86NVzm8qXSekBJFf5-FGNe0Lkht1lsMlBnqlfmWz8q5zUkPZ6XslpgyVqqSaw4DGxXV8aGWRFcOB0Ac2bush6McBAhQ",
"e": "AQAB",
"alg": "RS256",
"crv": "",
"x": "",
"y": ""
}