Mengumpulkan log switch Ubiquiti Unifi

Didukung di:

Dokumen ini menjelaskan cara menyerap log switch Ubiquiti Unifi ke Google Security Operations menggunakan Bindplane. Parser mengekstrak kolom dari pesan syslog menggunakan pola grok, sehingga mengonversi data log mentah menjadi format terstruktur yang sesuai dengan Model Data Terpadu (UDM). Parser ini menangani berbagai format log, mengekstrak informasi penting seperti stempel waktu, nama host, deskripsi, dan detail jaringan, serta memperkaya data dengan konteks tambahan sebelum menggabungkannya ke dalam peristiwa UDM akhir.

Sebelum memulai

Pastikan Anda memiliki prasyarat berikut:

  • Instance Google SecOps
  • Host Windows 2016 atau yang lebih baru atau Linux dengan systemd
  • Jika beroperasi dari balik proxy, pastikan port firewall terbuka sesuai dengan persyaratan agen BindPlane
  • Akses istimewa ke UI Ubiquiti Controller

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.
  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).
    • Service account description: 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 dan klik Create. File kunci akan didownload ke komputer Anda.
  11. Simpan file kunci sebagai ingestion-auth.json di direktori kolektor 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 sesuai dengan jalur tempat Anda menyimpannya.
  12. Buka IAM & Admin > Settings dan salin Project number. Anda akan memerlukannya untuk konfigurasi pengekspor.

Opsi 2: Mendownload file autentikasi penyerapan (lama)

  1. Login ke konsol Google SecOps.
  2. Buka Settings > Data Management > Collection Agents. Jika Anda menggunakan platform khusus SIEM, buka Settings > Collection Agents.
  3. Download file autentikasi penyerapan.
  4. Simpan file dengan aman di sistem tempat agen Bindplane akan diinstal.

Mendapatkan ID pelanggan Google SecOps

  1. Login ke konsol Google SecOps.
  2. Buka Setelan > Administrasi > Profil. Jika Anda menggunakan platform khusus SIEM, buka Settings > Profile.
  3. Salin dan simpan ID Pelanggan dari bagian Detail Organisasi.

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
    

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
    

Referensi penginstalan tambahan

Mengonfigurasi agen Bindplane untuk menyerap Syslog dan mengirimkannya ke Google SecOps

  1. Akses file konfigurasi:

    1. Cari file config.yaml. Biasanya, file ini berada di direktori /opt/observiq-otel-collector/ di Linux atau di direktori penginstalan di Windows.
    2. Buka file menggunakan editor teks (misalnya, nano, vi, atau Notepad).
  2. Edit file config.yaml sebagai berikut:

    receivers:
      udplog:
        # Replace the port and IP address as required
        listen_address: "0.0.0.0:514"
    
    exporters:
      chronicle/chronicle_w_labels:
        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
        # Adjust the path to the credentials file you downloaded in Step 1
        creds_file_path: '/path/to/ingestion-authentication-file.json'
        # Replace with your actual customer ID from Step 2
        customer_id: <CUSTOMER_ID>
        endpoint: chronicle.googleapis.com
        # Add optional ingestion labels for better organization
        log_type: 'UBIQUITI_SWITCH'
        raw_log_field: body
        ingestion_labels:
    
    service:
      pipelines:
        logs/source0__chronicle_w_labels-0:
          receivers:
            - udplog
          exporters:
            - chronicle/chronicle_w_labels
    
    • Ganti port dan alamat IP sesuai kebutuhan di infrastruktur Anda.
    • Ganti <LOCATION> dengan region instance Google SecOps Anda (misalnya, us, europe, atau asia-southeast1). Pengekspor akan mengawali chronicle.googleapis.com dengan nilai ini.
    • Ganti <PROJECT_NUMBER> dengan nomor project dari IAM & Admin > Settings.
    • Ganti <CUSTOMER_ID> dengan ID pelanggan yang sebenarnya.
    • Ganti /path/to/ingestion-authentication-file.json dengan jalur tempat file kunci akun layanan (Opsi 1) disimpan di bagian Mendapatkan kredensial Google SecOps untuk agen Bindplane.

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/chronicle_w_labels:
        compression: gzip
        # Adjust the path to the credentials file you downloaded in Step 1
        creds_file_path: '/path/to/ingestion-authentication-file.json'
        # Replace with your actual customer ID from Step 2
        customer_id: <CUSTOMER_ID>
        endpoint: malachiteingestion-pa.googleapis.com
        # Add optional ingestion labels for better organization
        log_type: 'UBIQUITI_SWITCH'
        raw_log_field: body
        ingestion_labels:
    

Mulai ulang agen Bindplane untuk menerapkan perubahan

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

    sudo systemctl restart observiq-otel-collector
    
  • Untuk memulai ulang agen Bindplane di Windows, Anda dapat menggunakan konsol Services atau memasukkan perintah berikut:

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

Mengonfigurasi tombol Ubquiti untuk mengirim Syslog Bidang Kontrol

  1. Login ke UI Unifi Controller.
  2. Buka Unifi Network.
  3. Buka Settings > Control Plane > tab Integrations.
  4. Temukan bagian Logging Aktivitas (Syslog).
  5. Aktifkan opsi SIEM Server.
  6. Berikan detail konfigurasi berikut:
    • Klik Edit kategori dan tambahkan kategori log yang diperlukan.
    • Server Address: Masukkan alamat IP agen Bindplane.
    • Port: Masukkan nomor port agen Bindplane (UDP diperlukan).
  7. Klik Apply Changes.

Mengonfigurasi tombol Ubquiti untuk mengirim Syslog CyberSecure

  1. Login ke UI Unifi Controller.
  2. Buka Unifi Network.
  3. Buka Settings > CyberSecure > tab Traffic Logging.
  4. Temukan bagian Logging Aktivitas (Syslog).
  5. Aktifkan opsi SIEM Server.
  6. Berikan detail konfigurasi berikut:
    • Klik Edit kategori dan tambahkan kategori log yang diperlukan.
    • Server Address: Masukkan alamat IP agen Bindplane.
    • Port: Masukkan nomor port agen Bindplane (UDP diperlukan).
    • Nonaktifkan Log Debug.
  7. Klik Apply Changes.

Tabel Pemetaan UDM

Kolom log pemetaan UDM Logika
anomalies security_result.detection_fields[].key: "anomalies"
security_result.detection_fields[].value: anomalies nilai dari log
Dipetakan langsung dari kolom anomalies di log mentah.
application observer.application Dipetakan langsung dari kolom application di log mentah.
assoc_status security_result.detection_fields[].key: "assoc_status"
security_result.detection_fields[].value: Nilai assoc_status dari log
Dipetakan langsung dari kolom assoc_status di log mentah.
asset_details observer.asset.product_object_id: Diekstrak menggunakan pola grok %{GREEDYDATA:asset_id},%{GREEDYDATA:asset_version}
asset_software.version: Diekstrak menggunakan pola grok %{GREEDYDATA:asset_id},%{GREEDYDATA:asset_version}
Kolom asset_details diuraikan menggunakan pola grok untuk mengekstrak asset_id dan asset_version.
asset_id observer.asset.product_object_id Dipetakan langsung dari kolom asset_id yang diekstrak dari asset_details.
asset_version observer.asset.software.version Dipetakan langsung dari kolom asset_version yang diekstrak dari asset_details.
bssid principal.mac Dipetakan langsung dari kolom bssid di log mentah.
description metadata.description Dipetakan langsung dari kolom description di log mentah.
device metadata.product_name Dipetakan langsung dari kolom device di log mentah. Jika device tidak ada, nilai "UBIQUITI_SWITCH" akan digunakan.
dns_resp_seen security_result.detection_fields[].key: "dns_resp_seen"
security_result.detection_fields[].value: Nilai dns_resp_seen dari log
Dipetakan langsung dari kolom dns_resp_seen di log mentah.
DST target.ip Dipetakan langsung dari kolom DST di log mentah.
DPT principal.port Dipetakan langsung dari kolom DPT di log mentah setelah mengonversinya menjadi bilangan bulat.
event_type security_result.detection_fields[].key: "event_type"
security_result.detection_fields[].value: Nilai event_type dari log
Dipetakan langsung dari kolom event_type di log mentah.
host principal.hostname Dipetakan langsung dari kolom host di log mentah.
ID additional.fields[].key: "ID"
additional.fields[].value.string_value: Nilai ID dari log
Dipetakan langsung dari kolom ID di log mentah.
IN additional.fields[].key: "IN"
additional.fields[].value.string_value: Nilai IN dari log
Dipetakan langsung dari kolom IN di log mentah.
interface additional.fields[].key: "interface"
additional.fields[].value.string_value: nilai interface dari log
Dipetakan langsung dari kolom interface di log mentah.
LEN additional.fields[].key: "LEN"
additional.fields[].value.string_value: Nilai LEN dari log
Dipetakan langsung dari kolom LEN di log mentah.
mac principal.mac Dipetakan langsung dari kolom mac di log mentah.
metadata.event_type metadata.event_type Diperoleh dari logika parser. Tetapkan ke "STATUS_SHUTDOWN" jika state adalah "Down", "STATUS_STARTUP" jika state adalah "Up", "STATUS_UPDATE" jika kv_msg dan DST ada atau principal_present benar, dan "GENERIC_EVENT" jika tidak.
metadata.log_type metadata.log_type: "UBIQUITI_SWITCH" Nilai konstan yang ditetapkan oleh parser.
metadata.vendor_name metadata.vendor_name: "UBIQUITI" Nilai konstan yang ditetapkan oleh parser.
principal_ip principal.ip Dipetakan langsung dari kolom principal_ip di log mentah.
process_id observer.process.pid Dipetakan langsung dari kolom process_id di log mentah.
product_event_type metadata.product_event_type Dipetakan langsung dari kolom product_event_type di log mentah.
PROTO network.ip_protocol Dipetakan langsung dari kolom PROTO di log mentah. Jika PROTO adalah "ICMPv6", nilainya akan diubah menjadi "ICMP".
query_1 target.administrative_domain Dipetakan langsung dari kolom query_1 di log mentah.
query_server_1 target.ip Dipetakan langsung dari kolom query_server_1 di log mentah.
radio security_result.detection_fields[].key: "radio"
security_result.detection_fields[].value: Nilai radio dari log
Dipetakan langsung dari kolom radio di log mentah.
satisfaction_now security_result.detection_fields[].key: "satisfaction_now"
security_result.detection_fields[].value: nilai satisfaction_now dari log
Dipetakan langsung dari kolom satisfaction_now di log mentah.
source_port principal.port Dipetakan langsung dari kolom source_port di log mentah setelah mengonversinya menjadi bilangan bulat.
SPT target.port Dipetakan langsung dari kolom SPT di log mentah setelah mengonversinya menjadi bilangan bulat.
SRC principal.ip, principal.hostname Dipetakan langsung dari kolom SRC di log mentah.
sta principal.mac Dipetakan langsung dari kolom sta di log mentah.
state additional.fields[].key: "state"
additional.fields[].value.string_value: nilai state dari log
Dipetakan langsung dari kolom state di log mentah.
timestamp metadata.event_timestamp Dipetakan langsung dari kolom timestamp di log mentah setelah diurai oleh filter tanggal.
TTL additional.fields[].key: "TTL"
additional.fields[].value.string_value: Nilai TTL dari log
Dipetakan langsung dari kolom TTL di log mentah.
vap metadata.ingestion_labels[].key: "Vap"
metadata.ingestion_labels[].value: Nilai vap dari log
Dipetakan langsung dari kolom vap di log mentah.
version metadata.product_version Dipetakan langsung dari kolom version di log mentah.

Log Perubahan

Melihat Log Perubahan untuk parser ini

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