Mengumpulkan log ForgeRock OpenAM

Versi Parser: 4.0

Didukung di:

Google SecOps SIEM

Dokumen ini menjelaskan cara menyerap log ForgeRock OpenAM ke Google Security Operations menggunakan agen Bindplane.

ForgeRock OpenAM adalah solusi pengelolaan akses yang menghasilkan pesan syslog untuk peristiwa autentikasi, keputusan kontrol akses, aktivitas sesi, dan perubahan konfigurasi. Parser mengekstrak kolom dari log audit berformat JSON dan memetakannya ke Unified Data Model (UDM).

Sebelum memulai

Pastikan Anda memiliki prasyarat berikut:

• Instance Google SecOps
• Windows Server 2016 atau yang lebih baru, atau host Linux dengan systemd
• Konektivitas jaringan antara agen Bindplane dan server ForgeRock OpenAM
• Jika beroperasi dari balik proxy, pastikan port firewall terbuka sesuai dengan persyaratan agen Bindplane
• Akses administrator ke konsol AM (misalnya, amAdmin)

Mendapatkan kredensial Google SecOps untuk agen Bindplane

Untuk mengautentikasi agen Bindplane ke Google SecOps, pilih salah satu metode berikut:

• Deployment baru: Gunakan Chronicle API (Opsi 1).
• Deployment lama: Terus menggunakan file autentikasi penyerapan (Opsi 2) hingga Ingestion API dihentikan pada 20 Juli 2027.

Opsi 1: Buat akun layanan untuk Chronicle API (direkomendasikan)

1. Login ke konsolGoogle Cloud dan pilih project Google Cloud yang ditautkan ke instance Google SecOps Anda.
2. Buka IAM & Admin > Service Accounts.
3. Klik Create service account.
4. Berikan detail konfigurasi berikut:
   • Nama akun layanan: Masukkan nama untuk akun (misalnya, bindplane-ingest).
   • Deskripsi akun layanan: Masukkan deskripsi (misalnya, Bindplane agent log ingestion).
5. Klik Create and continue.
6. Di bagian Grant this service account access to project, klik Select a role, lalu pilih Chronicle Editor.
7. Klik Continue lalu klik Done.
8. Klik akun layanan yang Anda buat, lalu buka tab Keys.
9. Klik Add key > Create new key.
10. Pilih JSON, lalu klik Create. File kunci akan didownload ke komputer Anda.
11. Simpan file kunci sebagai ingestion-auth.json di direktori pengumpul Bindplane (/opt/observiq-otel-collector/ingestion-auth.json di Linux atau C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json di Windows), atau perbarui creds_file_path di config.yaml agar cocok dengan jalur tempat Anda menyimpannya.
12. Buka IAM & Admin > Settings dan salin Project number. Anda akan memerlukannya untuk konfigurasi pengekspor.

Catatan: Kunci JSON adalah kredensial. Batasi akses ke file di host Bindplane dan ganti kunci sesuai dengan kebijakan organisasi Anda.

Opsi 2: Mendownload file autentikasi penyerapan (lama)

1. Login ke konsol Google SecOps.
2. Buka Setelan SIEM > Agen Pengumpulan.
3. Download file autentikasi penyerapan.
4. Simpan file dengan aman di sistem tempat agen BindPlane akan diinstal.

Catatan: File ini mengautentikasi agen ke Ingestion API lama (malachiteingestion-pa.googleapis.com), yang dijadwalkan Google untuk dihentikan pada 20 Juli 2027. Rencanakan untuk beralih ke Opsi 1 sebelum tanggal tersebut.

Mendapatkan ID pelanggan Google SecOps

1. Login ke konsol Google SecOps.
2. Buka Setelan SIEM > Profil.

3. Salin dan simpan ID Pelanggan dari bagian Detail Organisasi.

   Catatan: ID pelanggan diperlukan untuk mengonfigurasi pengekspor agen Bindplane.

Menginstal agen Bindplane

Instal agen Bindplane di sistem operasi Windows atau Linux Anda sesuai dengan petunjuk berikut.

Penginstalan Windows

1. Buka Command Prompt atau PowerShell sebagai administrator.

2. Jalankan perintah berikut:

   msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
   

3. Tunggu hingga penginstalan selesai.

4. Verifikasi penginstalan dengan menjalankan:

   sc query observiq-otel-collector
   

   Layanan akan ditampilkan sebagai RUNNING.

Penginstalan Linux

1. Buka terminal dengan hak istimewa root atau sudo.

2. Jalankan perintah berikut:

   sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
   

3. Tunggu hingga penginstalan selesai.

4. Verifikasi penginstalan dengan menjalankan:

   sudo systemctl status observiq-otel-collector
   

   Layanan akan ditampilkan sebagai active (running).

Referensi penginstalan tambahan

Untuk mengetahui opsi penginstalan dan pemecahan masalah tambahan, lihat Panduan penginstalan agen Bindplane.

Catatan: Konfigurasi pengekspor Chronicle API memerlukan pengumpul Bindplane v1.106.0 atau yang lebih baru. Perintah sebelumnya akan menginstal rilis terbaru. Jika Anda mengupdate penginstalan yang ada, upgrade kolektor sebelum mengubah konfigurasi.

Mengonfigurasi agen Bindplane untuk menyerap syslog dan mengirimkannya ke Google SecOps

Cari file konfigurasi

• Linux:

  sudo nano /opt/observiq-otel-collector/config.yaml
  

• Windows:

  notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
  

Mengedit file konfigurasi

• Ganti seluruh konten config.yaml dengan konfigurasi berikut:

  receivers:
    udplog:
      listen_address: "0.0.0.0:514"
  
  exporters:
    chronicle/openam:
      protocol: https
      # Region of your instance, for example us, europe, asia-southeast1
      location: <LOCATION>
      # Project number of the Google Cloud project linked to the instance
      project: '<PROJECT_NUMBER>'
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: OPENAM
      raw_log_field: body
  
  service:
    pipelines:
      logs/openam_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/openam
  

Parameter konfigurasi

Ganti placeholder berikut:

• Konfigurasi penerima:

  • listen_address: Alamat IP dan port untuk diproses:
    • 0.0.0.0 untuk memproses semua antarmuka (direkomendasikan)
    • Port 514 adalah port syslog standar (memerlukan root di Linux; gunakan 1514 untuk non-root)

• Konfigurasi pengekspor:

  • creds_file_path: Jalur lengkap ke file kunci JSON akun layanan (Opsi 1):
    • Linux: /opt/observiq-otel-collector/ingestion-auth.json
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • customer_id: ID Pelanggan yang disalin dari konsol Google SecOps
  • location: Ganti <LOCATION> dengan region instance Google SecOps Anda (misalnya, us, europe, atau asia-southeast1). Pengekspor mengawali chronicle.googleapis.com dengan nilai ini. Lihat Endpoint Regional untuk mengetahui daftar lengkapnya.
  • project: Ganti <PROJECT_NUMBER> dengan nomor project dari IAM & Admin > Settings.
  • endpoint: Tetap disetel ke chronicle.googleapis.com.

Pengekspor API penyerapan lama

• Jika Anda menggunakan file autentikasi penyerapan dari Opsi 2, ganti blok exporters dengan kode berikut. Tetapkan creds_file_path ke jalur ke file autentikasi penyerapan, dan jika instance Anda berada di luar AS, ganti malachiteingestion-pa.googleapis.com dengan endpoint regional Anda (misalnya, europe-malachiteingestion-pa.googleapis.com).

  exporters:
    chronicle/openam:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: OPENAM
      raw_log_field: body
  

Catatan: Pengekspor ini akan berhenti berfungsi saat Ingestion API dihentikan pada 20 Juli 2027.

Menyimpan file konfigurasi

• Setelah mengedit, simpan file:
  • Linux: Tekan Ctrl+O, lalu Enter, lalu Ctrl+X
  • Windows: Klik File > Simpan

Mulai ulang agen Bindplane untuk menerapkan perubahan

• Untuk memulai ulang agen Bindplane di Linux, jalankan perintah berikut:

  sudo systemctl restart observiq-otel-collector
  

  1. Pastikan layanan sedang berjalan:

     sudo systemctl status observiq-otel-collector
     

  2. Periksa log untuk mengetahui error:

     sudo journalctl -u observiq-otel-collector -f
     

• Untuk memulai ulang agen Bindplane di Windows, pilih salah satu opsi berikut:

  • Command Prompt atau PowerShell sebagai administrator:

    net stop observiq-otel-collector && net start observiq-otel-collector
    

  • Konsol layanan:

    1. Tekan Win+R, ketik services.msc, lalu tekan Enter.
    2. Cari observIQ OpenTelemetry Collector.
    3. Klik kanan, lalu pilih Restart.

    4. Pastikan layanan sedang berjalan:

       sc query observiq-otel-collector
       

    5. Periksa log untuk mengetahui error:

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
       

Mengonfigurasi handler syslog untuk ForgeRock OpenAM

1. Login ke konsol AM sebagai administrator (misalnya, amAdmin).
2. Untuk membuat pengendali peristiwa di konfigurasi global, buka Konfigurasi > Layanan Global > Logging Audit.
   • Untuk membuat pengendali peristiwa di realm, buka Realms > Realm Name > Services > Log Audit.
3. Klik Add a Secondary Configuration > Syslog.
4. Berikan detail konfigurasi berikut:
   • Name: Masukkan nama untuk pengendali peristiwa (misalnya, Syslog Event Handler).
   • Server hostname: Masukkan alamat IP agen Bindplane.
   • Server port: Masukkan nomor port agen Bindplane (misalnya, 514 untuk UDP).
   • Transport Protocol: Pilih UDP.
   • Waktu tunggu koneksi: Masukkan jumlah detik untuk menghubungkan (misalnya, 120).
   • Opsional: Aktifkan opsi Buffering.
5. Klik Create.
6. Di tab General Handler Configuration, pilih Enabled untuk mengaktifkan pengendali peristiwa.
7. Pilih topik untuk log audit:
   • Akses
   • Aktivitas
   • Autentikasi
   • Konfigurasi
8. Klik Simpan.
9. Di tab Syslog Configuration, berikan detail konfigurasi berikut:
   • Nama host server: Masukkan alamat IP Bindplane.
   • Server port: Masukkan nomor port Bindplane.
   • Waktu tunggu koneksi: Masukkan jumlah detik untuk terhubung (misalnya, 120).
   • Transport Protocol: Pilih UDP.
   • Fasilitas: Pilih Local0.
   • Semua topik menetapkan tingkat keparahan ke INFORMASI.
10. Klik Simpan.
11. Di tab Buffering, pilih Buffering Enabled untuk mengaktifkannya.
12. Klik Simpan.

Tabel pemetaan UDM

Kolom Log	Pemetaan UDM	Logika
client.ip	principal.ip	Alamat IP klien yang membuat permintaan.
client.ip	principal.asset.ip	Alamat IP aset klien yang membuat permintaan.
client.port	principal.port	Port yang digunakan oleh klien yang membuat permintaan.
entries[0].info.authLevel	principal.resource.resource_subtype	Tingkat autentikasi yang terkait dengan peristiwa. Diawali dengan "authLevel:".
entries[0].info.displayName	security_result.description	Nama deskriptif untuk node di hierarki autentikasi.
entries[0].info.ipAddress	principal.asset.ip	Alamat IP yang terkait dengan principal dalam peristiwa.
entries[0].info.ipAddress	principal.ip	Alamat IP yang terkait dengan principal dalam peristiwa.
entries[0].info.nodeId	principal.resource.id	ID unik node di hierarki autentikasi. Diawali dengan "nodeId:".
entries[0].info.nodeOutcome	principal.resource.attribute.labels.value	Hasil node di hierarki autentikasi.
entries[0].info.nodeType	principal.resource.type	Jenis node di hierarki autentikasi. Diawali dengan "nodeType:".
entries[0].info.treeName	principal.resource.name	Nama hierarki autentikasi. Diawali dengan "treeName:".
eventName	metadata.product_event_type	Nama peristiwa mentah dari log OpenAM.
http.request.headers.host[0]	target.asset.hostname	Nama host server target, yang diekstrak dari header host.
http.request.headers.host[0]	target.hostname	Nama host server target, yang diekstrak dari header host.
http.request.headers.user-agent[0]	network.http.user_agent	Agen pengguna permintaan HTTP.
http.request.method	network.http.method	Metode HTTP yang digunakan dalam permintaan.
http.request.path	target.url	Jalur URL permintaan HTTP.
info.failureReason	security_result.summary	Alasan kegagalan autentikasi. Diprogram secara permanen ke "SSO". Ditentukan oleh logika berdasarkan eventName dan kolom lainnya. Dapat berupa GENERIC_EVENT, USER_LOGIN, USER_LOGOUT, NETWORK_HTTP, atau STATUS_UPDATE. Dihardcode ke "OPENAM". Dihardcode ke "OpenAM". Dihardcode ke "ForgeRock".
principal	target.user.userid	ID pengguna yang terlibat dalam peristiwa, diekstrak dari kolom userId, principal, atau runAs.
result	security_result.action_details	Hasil peristiwa (misalnya, "SUCCESSFUL", "FAILED").
response.detail.reason	security_result.summary	Alasan kegagalan dalam peristiwa hasil akses.
response.status	security_result.action_details	Status respons dalam peristiwa hasil akses.
runAs	target.user.userid	ID pengguna yang terlibat dalam peristiwa, diekstrak dari kolom userId, principal, atau runAs.
security_result.action	security_result.action	Tindakan yang diambil sebagai akibat dari peristiwa keamanan (misalnya, "IZINKAN", "BLOKIR").
server.ip	target.asset.ip	Alamat IP server target.
server.ip	target.ip	Alamat IP server target.
server.port	target.port	Port server target.
timestamp	metadata.event_timestamp	Stempel waktu peristiwa.
trackingIds	metadata.product_log_id	ID pelacakan yang terkait dengan peristiwa.
transactionId	metadata.product_deployment_id	ID transaksi yang terkait dengan peristiwa.
userId	target.user.userid	ID pengguna yang terlibat dalam peristiwa, diekstrak dari kolom userId, principal, atau runAs.
userId	target.user.group_identifiers	ID grup yang terkait dengan pengguna.
am_group	target.user.group_identifiers	ID grup yang terkait dengan pengguna.
am_user	target.user.email_addresses	Alamat email pengguna, jika ada di kolom am_user.
loginID[0]	target.user.userid	ID login yang digunakan dalam peristiwa.
loginID[0]	target.user.email_addresses	Alamat email yang digunakan untuk login, jika ada di kolom loginID.
hostip	intermediary.hostname	Nama host perangkat perantara.
hostip	intermediary.ip	Alamat IP perangkat perantara.
src_ip	principal.asset.ip	Alamat IP sumber.
src_ip	principal.ip	Alamat IP sumber.
desc	metadata.description	Deskripsi peristiwa.
payload	metadata.description	Payload peristiwa.
http.request.headers.host.0	tatget.hostname	Dipetakan dari log perubahan
http.request.headers.user-agent.0	network.http.user_agent	Dipetakan dari log perubahan
extensions.auth.type	SSO	Dipetakan dari log perubahan

Log Perubahan

Melihat Log Perubahan untuk parser ini

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.