Halaman ini berlaku untuk Apigee dan Apigee hybrid.
Lihat Dokumentasi Apigee Edge.
Tampilan Laporan Keamanan memungkinkan Anda membuat laporan untuk mengidentifikasi ancaman keamanan terhadap API Anda. Untuk membuat laporan, Apigee memindai Data traffic API selama interval waktu yang ditentukan dan penelusuran pola traffic yang tidak biasa yang mungkin disebabkan oleh agen berbahaya. Apigee kemudian menampilkan laporan yang menampilkan semua aktivitas yang mencurigakan. Dengan menggunakan informasi ini, Anda kemudian dapat mengambil tindakan untuk memblokir serangan terhadap API Anda.
Anda dapat membuat laporan keamanan di UI Apigee, seperti yang dijelaskan di bawah, atau menggunakan Security reports API. Jika Anda menggunakan UI, data untuk laporan dibatasi berdasarkan lingkungan yang Anda pilih. Namun, menggunakan API, Anda juga dapat membuat laporan untuk grup lingkungan.
Lihat Peran wajib untuk laporan keamanan bagi peran yang diperlukan untuk menjalankan tugas laporan keamanan.
Untuk menggunakan fitur ini, Anda harus mengaktifkan add-on. Jika Anda adalah pelanggan Langganan, Anda dapat mengaktifkan add-on untuk organisasi Anda. Lihat Kelola Keamanan API Lanjutan untuk organisasi Langganan guna mengetahui detail selengkapnya. Jika Anda adalah pelanggan Bayar sesuai penggunaan, Anda dapat mengaktifkan add-on di lingkungan yang memenuhi syarat. Untuk informasi selengkapnya, lihat Kelola add-on Advanced API Security.
Deteksi bot
Salah satu ancaman paling serius terhadap keamanan API berasal dari bot: otomatis skrip yang mengirim permintaan berbahaya ke API. Penelusuran Advanced API Security untuk pola traffic API tertentu, yang disebut aturan deteksi, yang didasarkan pada analisis data API asli, untuk mendeteksi bot.
Keterlambatan data laporan keamanan
Data yang mengalir ke pipeline Apigee Analytics mengalami keterlambatan hingga 15 hingga 20 menit. Akibatnya, laporan keamanan dengan waktu berakhir kurang dari 20 menit sebelumnya mungkin mengembalikan hasil yang salah.
Buka tampilan Laporan keamanan
Untuk membuka tampilan Laporan keamanan:
- Jika Anda menggunakan UI Apigee di Konsol Cloud: Pilih Keamanan API tingkat lanjut > Laporan keamanan.
- Jika Anda menggunakan UI Apigee klasik: Pilih Analisis > Keamanan API > Laporan Keamanan. Nama dan perilaku kolom mungkin berbeda agak di UI Apigee klasik versus UI Apigee di Konsol Cloud.
Tindakan ini akan menampilkan tampilan Laporan keamanan utama:
Di bagian atas halaman, Anda dapat memilih:
- Lingkungan tempat Anda ingin membuat laporan.
- Filter Jenis laporan. Opsinya adalah:
- Semua
- Aktif
- Gagal
- Sudah berakhir
Di bawah opsi tersebut, laporan keamanan ditampilkan dalam baris tabel. Setiap baris menampilkan detail laporan berikut:
- Nama Laporan. Klik nama laporan untuk melihat laporan.
- Status laporan, yang dapat berupa salah satu dari hal berikut:
- berjalan: Laporan sedang berjalan dan belum dapat dilihat.
- selesai: Laporan selesai dan dapat dilihat atau diekspor.
- masa berlaku telah habis: Laporan telah habis masa berlakunya dan tidak dapat lagi dilihat atau diekspor di UI. Untuk melihat laporan setelah tanggal habis masa berlaku, Anda harus mengekspornya sebelum tanggal tersebut. Setelah 30 hari, laporan tersebut akan dihapus dari daftar laporan yang tersedia.
Waktu mulai dan Waktu berakhir menampilkan tanggal dan waktu mulai dan akhir untuk laporan.
- Tanggal dikirim: Tanggal dan waktu permintaan laporan dikirimkan.
- Waktu habis masa berlaku: Tanggal dan waktu saat laporan berakhir dan tidak dapat dilihat lagi di UI Apigee. Tanggal habis masa berlaku adalah 7 hari setelah Anda membuat laporan. Setelah 30 hari, laporan akan dihapus dari daftar laporan yang tersedia. Anda tidak dapat melihat atau mengekspor laporan di UI setelah tanggal habis masa berlakunya.
- Ukuran file: Ukuran file laporan. Anda mungkin perlu mengubah kriteria laporan secara berurutan untuk membuat laporan dengan ukuran file di bawah ukuran file maksimum. Lihat Batasan laporan keamanan untuk informasi ukuran file maksimum dan cara spesifik untuk mengurangi ukuran file.
- Ekspor: Mengekspor/mendownload laporan dalam bentuk file ZIP. Ekspor hanya tersedia jika status laporan selesai.
Buat laporan keamanan baru
Untuk membuat laporan keamanan baru, mulai dengan mengklik +Buat di tampilan Laporan keamanan. Tindakan ini akan membuka Buat Tugas Laporan Keamanan tempat Anda dapat mengonfigurasi opsi untuk laporan seperti yang dijelaskan di bagian berikutnya.
Opsi laporan keamanan
Anda dapat menentukan opsi berikut untuk laporan keamanan:
- Nama Laporan: Nama untuk laporan.
- Rentang Tanggal Laporan: Waktu mulai dan waktu berakhir untuk laporan.
Catatan: Waktu mulai dan berakhir laporan harus berada di waktu lampau dan maksimal satu tahun yang lalu saat laporan dibuat.
- Metrik: Metrik untuk laporan. Anda dapat memilih dari opsi berikut
metrik dan fungsi agregasi—fungsi yang menghitung
statistik untuk metrik.
Metrik Deskripsi Fungsi agregasi bot Jumlah alamat IP yang berbeda untuk bot yang terdeteksi dalam interval satu menit. count_distinct bot_traffic Jumlah pesan dari alamat IP bot yang terdeteksi dalam interval satu menit. jumlah message_count Jumlah total panggilan API yang diproses oleh Apigee dalam interval satu menit.
Catatan: message_count tidak dapat digunakan dengan metrik lain, atau dengan bot_reason dalam laporan yang sama.
jumlah response_size Ukuran payload respons yang ditampilkan dalam byte. jumlah, rata-rata, min, maks Dimensi: Dimensi memungkinkan Anda mengelompokkan nilai metrik berdasarkan dimensi yang terkait {i>subset <i}data. Tabel berikut menjelaskan dimensi yang spesifik tentang Laporan Keamanan API Lanjutan.
Dimensi Deskripsi bot_reason
incident_id
(pratinjau)security_action
(pratinjau)Jenis tindakan keamanan. Kemungkinan nilai adalah ALLOW, DENY, dan FLAG. security_action_name
Nama tindakan keamanan. security_action_headers
Header dilampirkan ke permintaan untuk tindakan ALLOW. Catatan: Dimensi bot_reason, yang khusus untuk Advanced API Keamanan, dapat berupa kombinasi dari aturan deteksi. Saat bot terdeteksi, bot_reason terdiri dari subset aturan deteksi individual traffic bot cocok saat terdeteksi.
Catatan: bot_reason dan incident_id hanya berfungsi dengan hal berikut metrik:
- bot
- bot_traffic
- response_size
Lihat dimensi untuk dimensi lain yang didukung oleh laporan Keamanan API Lanjutan.
Untuk menambahkan beberapa dimensi, cukup klik +Tambahkan Dimensi untuk setiap dimensi yang ingin ditambahkan. Anda juga dapat mengubah urutan kemunculan dimensi dalam laporan dengan mengklik panah atas atau bawah di sebelah kanan kolom dimensi.
- Filter: Filter memungkinkan Anda membatasi hasil pada metrik dengan nilai tertentu. Untuk membuat
filter, tetapkan kolom berikut:
- Pilih nama untuk filter.
- Pilih operator perbandingan.
- Pilih nilai.
Lihat Filter.
Setelah Anda memilih semua opsi laporan, klik Buat untuk membuat tugas laporan.
Melihat laporan yang sudah selesai
Setelah selesai, laporan akan ditampilkan dalam tabel seperti yang ditunjukkan di bawah:
Untuk melihat laporan, Anda dapat menggunakan salah satu cara berikut:
- Klik nama laporan.
- Klik Ekspor di baris untuk laporan tersebut.
Contoh: laporan alamat IP bot
Contoh berikut membuat laporan yang menunjukkan alamat IP bot yang terdeteksi. Untuk membuat laporan, gunakan konfigurasi berikut:
- Metrik: bot, jumlah alamat IP berbeda yang diidentifikasi sebagai sumber bot.
- Fungsi agregasi: count_distinct
- Dimensi: IP Klien Terselesaikan
Laporan yang telah selesai ditampilkan di bawah ini:
Perhatikan bahwa tabel di bagian bawah laporan mencantumkan alamat IP yang dikaitkan dengan Advanced API Security diidentifikasi sebagai {i>bot<i}.
Contoh: laporan traffic bot menurut alasan bot
Contoh berikutnya membuat laporan traffic bot, yaitu jumlah permintaan dari alamat IP yang telah diidentifikasi sebagai sumber bot—oleh bot_reason—kumpulan aturan pendeteksian yang menyebabkan bot terdeteksi. Untuk membuat laporan, gunakan konfigurasi berikut:
- Metrik: bot_traffic
- Fungsi agregasi: sum
- Dimensi: bot_reason
Laporan yang telah selesai ditampilkan di bawah ini:
Setiap bot_reason terdiri dari subset individu aturan deteksi. Seperti yang terlihat dalam grafik, Aturan deteksi yang berkontribusi pada jumlah traffic bot terbesar adalah serangkaian aturan berikut:
- Banjir
- Tebakan Kasar
- Robot Pelaku Penyalahgunaan
Contoh: laporan traffic bot
Contoh berikutnya akan membuat laporan yang tidak dikelompokkan menurut dimensi. Jika tidak ingin mengelompokkan data menurut dimensi, Anda dapat menetapkan Dimensi ke lingkungan. Karena data selalu dibatasi untuk lingkungan yang dipilih, ini menghasilkan laporan yang memiliki tidak ada pengelompokan data.
- Metrik: traffic bot
- Fungsi agregasi: sum
- Dimensi: environment
Laporan menampilkan total traffic dari alamat IP yang teridentifikasi sebagai bot, untuk setiap interval satu menit selama rentang waktu laporan. Catatan bahwa tidak ada pengelompokan.
Contoh laporan keamanan lainnya
Tabel berikut mencantumkan beberapa contoh keamanan laporan yang dapat Anda buat menggunakan berbagai metrik dan dimensi:
Laporan | Metrik | Dimensi |
---|---|---|
Semua Lalu Lintas Bot & Laporan Jumlah Bot untuk per lingkungan | bot, bot_traffic | environment |
Lalu Lintas Bot & Laporan Jumlah Bot karena berbagai alasan bot | bot, bot_traffic | bot_reason |
Lalu Lintas Bot & Laporan Jumlah Bot untuk berbagai Negara | bot, bot_traffic | ax_geo_country |
Lalu Lintas Bot & Laporan Jumlah Bot untuk ISP yang berbeda | bot, bot_traffic | ax_isp |
Laporan Deteksi Bot (Tampilan Daftar Mendetail) | bot_traffic | IP Klien Terselesaikan, ax_isp, bot_reason, request_uri, client_id |
Traffic bot per Token Akses | bot_traffic | access_token |
Traffic bot per proxy API | bot_traffic | apiproxy |
Traffic bot per Kelompok Agen | bot_traffic | ax_ua_agent_family |
Traffic bot per Agen Pengguna | bot_traffic | useragent |
Traffic bot per Jenis Agen | bot_traffic | ax_ua_agent_type |
Traffic bot per Kategori Perangkat | bot_traffic | ax_ua_device_category |
Traffic bot per kelompok OS | bot_traffic | ax_ua_os_family |
Traffic bot per Client-ID | bot_traffic | client_id |
Traffic bot per Jalur Dasar Proxy | bot_traffic | proxy_basepath |
Traffic bot per Akhiran Jalur Proxy | bot_traffic | proxy_pathsuffix |
Traffic bot per URI Permintaan | bot_traffic | request_uri |
Traffic Bot per Verb Permintaan | bot_traffic | request_verb |
Traffic Bot per Kode Status Respons | bot_traffic | response_status_code |
Batasan laporan keamanan
Laporan keamanan memiliki batasan berikut:
- Data yang mengalir ke pipeline Apigee Analytics mengalami penundaan maksimal 15 hingga 20 menit pada rata-rata. Akibatnya, pembuatan laporan dengan Waktu Berakhir yang lebih singkat dari 20 menit sebelumnya mungkin menampilkan hasil yang salah.
- Rentang waktu maksimum untuk laporan bot adalah 1 tahun.
- Jumlah maksimum metrik yang dapat Anda gunakan di laporan adalah 25, dan jumlah maksimum yang dapat Anda gunakan adalah 25.
- Seperti halnya dengan
laporan kustom asinkron
API, ada batas 31 MB data untuk laporan. Jika Anda
menemukan batas ukuran laporan, Anda dapat:
- Kurangi rentang waktu laporan.
- Bagi data menjadi {i>subset<i} yang lebih kecil dengan memfilter sekumpulan nilai, lalu membuat beberapa laporan, satu laporan untuk setiap subkumpulan.
- Dimensi IP Klien Terselesaikan tidak dapat dicantumkan dalam laporan yang sama dengan dimensi ax_geo_city atau ax_geo_country, karena masalah privasi.
- Metrik berikut hanya tersedia melalui Security Reports API, tetapi tidak ada di UI: bot_first_detected (min) dan bot_last_detected (max).