Mengumpulkan log firewall OPNsense

Didukung di:

Google SecOps SIEM

Dokumen ini menjelaskan cara menyerap log firewall OPNsense ke Google Security Operations menggunakan agen Bindplane.

OPNsense adalah platform perutean dan firewall open source yang menghasilkan pesan syslog untuk kecocokan aturan firewall, koneksi jaringan, dan peristiwa sistem. Parser mengekstrak kolom dari pesan filterlog berformat CSV menggunakan penguraian grok dan CSV, lalu memetakannya ke Model Data Terpadu (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 firewall OPNsense
• Jika beroperasi dari balik proxy, pastikan port firewall terbuka sesuai dengan persyaratan agen Bindplane
• Akses administratif ke antarmuka web OPNsense

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 gunakan file autentikasi penyerapan (Opsi 2) hingga Ingestion API dihentikan pada 20 Juli 2027.

Opsi 1: Membuat 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:
   • Service account name: Masukkan nama 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 didownload ke komputer Anda.
11. Simpan file kunci sebagai ingestion-auth.json di direktori Bindplane collector (/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 sesuai 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 rotasikan kunci sesuai dengan kebijakan organisasi Anda.

Opsi 2: Mendownload file autentikasi penyerapan (lama)

1. Login ke konsol Google SecOps.
2. Buka SIEM Settings > Collection Agents.
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. Berencana beralih ke Opsi 1 sebelum tanggal tersebut.

Mendapatkan ID pelanggan Google SecOps

1. Login ke konsol Google SecOps.
2. Buka SIEM Settings > Profile.

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

Menemukan 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/opnsense:
      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: OPNSENSE
      raw_log_field: body
  
  service:
    pipelines:
      logs/opnsense_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/opnsense
  

Parameter konfigurasi

Ganti placeholder berikut:

• Konfigurasi penerima:

  • listen_address: Alamat IP dan port untuk diproses:
    • 0.0.0.0 untuk mendengarkan di 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 tetapkan 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/opnsense:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: OPNSENSE
      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 > Save

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 Services:

    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"
       

Menambahkan konfigurasi server syslog ke OPNsense

1. Login ke antarmuka web OPNsense.
2. Buka System > Settings > Logging.
3. Di bagian Remote Logging, aktifkan Send logs to remote syslog server dengan mencentang kotaknya.
4. Di kolom Remote Syslog Servers, masukkan alamat IP server syslog, termasuk port (misalnya, 10.10.10.10:514).
5. Pilih Local0 sebagai fasilitas syslog.
6. Tetapkan tingkat syslog sebagai Alert.
7. Klik Save untuk menerapkan perubahan.

Tabel pemetaan UDM

Kolom Log	Pemetaan UDM	Logika
column1	security_result.rule_id	Dipetakan langsung dari column1.
column10	additional.fields[].key: "tos" additional.fields[].value.string_value: Nilai column10	Dipetakan langsung dari column10, bertingkat di bawah additional.fields dengan kunci "tos".
column12	additional.fields[].key: "ttl" additional.fields[].value.string_value: Nilai column12	Dipetakan langsung dari column12, bertingkat di bawah additional.fields dengan kunci "ttl".
column13	additional.fields[].key: "Id" additional.fields[].value.string_value: Nilai column13	Dipetakan langsung dari column13, bertingkat di bawah additional.fields dengan kunci "Id".
column14	additional.fields[].key: "offset" additional.fields[].value.string_value: Nilai column14	Dipetakan langsung dari column14, bertingkat di bawah additional.fields dengan kunci "offset".
column15	additional.fields[].key: "flags" additional.fields[].value.string_value: Nilai column15	Dipetakan langsung dari column15, bertingkat di bawah additional.fields dengan kunci "flags".
column17	network.ip_protocol	Dipetakan langsung dari column17 setelah dikonversi ke huruf besar.
column18	network.received_bytes	Dipetakan langsung dari column18 setelah dikonversi ke bilangan bulat tanpa tanda tangan.
column19	principal.ip	Dipetakan langsung dari column19.
column20	target.ip	Dipetakan langsung dari column20.
column21	principal.port (jika column17 adalah TCP atau UDP) additional.fields[].key: "data_length" additional.fields[].value.string_value: Nilai yang diekstrak (jika column17 adalah ICMP, GRE, ESP, atau IGMP)	Jika column17 adalah TCP/UDP, dipetakan langsung dari column21 dan dikonversi menjadi bilangan bulat. Jika tidak, nilai "datalength" diekstrak menggunakan grok dan ditempatkan di additional.fields dengan kunci "data_length".
column22	target.port	Dipetakan langsung dari column22 jika column17 adalah TCP atau UDP, dan dikonversi menjadi bilangan bulat.
column24	additional.fields[].key: "tcp_flags" additional.fields[].value.string_value: Nilai column24	Dipetakan langsung dari column24 jika column17 adalah TCP, bertingkat di bawah additional.fields dengan kunci "tcp_flags".
column29	additional.fields[].key: "tcp_options" additional.fields[].value.string_value: Nilai column29	Dipetakan langsung dari column29 jika column17 adalah TCP, bertingkat di bawah additional.fields dengan kunci "tcp_options".
column4	additional.fields[].key: "tracker" additional.fields[].value.string_value: Nilai column4	Dipetakan langsung dari column4, bertingkat di bawah additional.fields dengan kunci "tracker".
column5	additional.fields[].key: "interface" additional.fields[].value.string_value: Nilai column5	Dipetakan langsung dari column5, bertingkat di bawah additional.fields dengan kunci "interface".
column6	security_result.rule_type	Dipetakan langsung dari column6.
column7	security_result.action	Dipetakan dari column7. Jika "block", dikonversi menjadi huruf besar "BLOCK". Jika "pass", tetapkan ke "ALLOW".
column8	network.direction	Dipetakan dari column8. Jika "in", tetapkan ke "INBOUND". Jika "out", tetapkan ke "OUTBOUND".
domain	principal.administrative_domain	Dipetakan langsung dari domain yang diekstrak grok. Ditetapkan ke "NETWORK_CONNECTION" jika alamat IP utama dan target ada, jika tidak "GENERIC_EVENT". Diprogram secara permanen ke "OPNSENSE". Diprogram secara permanen ke "OPNSENSE".
message	Berbagai kolom	Diuraikan menggunakan filter grok dan csv untuk mengekstrak berbagai kolom. Lihat baris lain untuk pemetaan tertentu.
ts	metadata.event_timestamp.seconds, timestamp.seconds	Diurai dari kolom pesan menggunakan grok, lalu dikonversi menjadi stempel waktu. Nilai detik digunakan untuk mengisi metadata.event_timestamp.seconds dan timestamp.seconds.
application	principal.application	Dipetakan langsung dari application yang diekstrak grok.
column27	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column2	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column3	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column11	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column26	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column28	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column25	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column16	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan
column9	event.idm.read_only_udm.additional.fields	Dipetakan dari log perubahan

Log Perubahan

Melihat Log Perubahan untuk parser ini

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