Mengumpulkan log Zix Email Encryption

Didukung di:

Google SecOps SIEM

Dokumen ini menjelaskan cara menyerap log Zix Email Encryption ke Google Security Operations menggunakan agen Bindplane.

Zix Email Encryption (sekarang OpenText ZixEncrypt) adalah platform enkripsi email dan DLP untuk komunikasi email yang aman dan kepatuhan. ZixGateway akan membuat log transaksi SMTP dan log peristiwa enkripsi di appliance ZixGateway.

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 perangkat Zix Email Encryption
• Jika beroperasi dari balik proxy, pastikan port firewall terbuka sesuai dengan persyaratan agen Bindplane
• Akses istimewa ke perangkat Zix Email Encryption (ZixGateway) dengan izin administrator
• Akses ke file log Zix Email Encryption (log transaksi SMTP, log peristiwa enkripsi)

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 akan 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 ganti 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. Rencanakan untuk 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 opsi pemasangan dan pemecahan masalah tambahan, lihat Panduan pemasangan agen BindPlane.

Catatan: Konfigurasi pengekspor Chronicle API memerlukan Bindplane collector v1.106.0 atau yang lebih baru. Perintah sebelumnya akan menginstal rilis terbaru. Jika Anda mengupdate penginstalan yang ada, upgrade pengumpul 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:
    filelog:
      include:
        - /var/log/zix/*.log
        - /opt/zix/logs/*.log
      start_at: beginning
  
  exporters:
    chronicle/zix_email:
      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: ZIX_EMAIL_ENCRYPTION
      raw_log_field: body
      ingestion_labels:
        env: production
  
  service:
    pipelines:
      logs/zix_to_chronicle:
        receivers:
          - filelog
        exporters:
          - chronicle/zix_email
  

Parameter konfigurasi

Ganti placeholder berikut:

• Konfigurasi penerima:

  • filelog: Jenis penerima untuk mengumpulkan file log dari disk
  • include: Daftar jalur file atau pola glob yang akan dipantau:
    • Linux: /var/log/zix/*.log atau /opt/zix/logs/*.log
    • Windows: C:\Program Files\Zix\logs\*.log
    • Sesuaikan jalur agar cocok dengan lokasi file log ZixGateway Anda
  • start_at: Setel ke beginning untuk membaca file log yang ada dari awal, atau end untuk hanya membaca entri baru

• Konfigurasi pengekspor:

  • zix_email: Nama deskriptif untuk 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 dari langkah sebelumnya
  • location: Ganti <LOCATION> dengan region instance Google SecOps Anda (misalnya, us, europe, atau asia-southeast1). Pengekspor akan menambahkan awalan 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.
  • ZIX_EMAIL_ENCRYPTION: Jenis log persis seperti yang muncul di Chronicle
  • ingestion_labels: Label opsional dalam format YAML (misalnya, env: production)

• Konfigurasi pipeline:

  • zix_to_chronicle: Nama deskriptif untuk pipeline

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/zix_email:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: ZIX_EMAIL_ENCRYPTION
      raw_log_field: body
      ingestion_labels:
        env: production
  

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

Simpan 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 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 pengumpulan log Zix Email Encryption

Agen Bindplane mengumpulkan file log langsung dari sistem file perangkat ZixGateway.

Memverifikasi lokasi file log

1. Login ke konsol pengelolaan ZixGateway.
2. Buka Monitoring > Logs.

3. Verifikasi direktori file log:

   • Linux: /var/log/zix/ atau /opt/zix/logs/
   • Windows: C:\Program Files\Zix\logs\
   Catatan: Lihat Panduan Administrasi ZixGateway untuk mengetahui jalur direktori log spesifik Anda. Pastikan agen Bindplane memiliki akses baca ke direktori log.

4. Pastikan log transaksi SMTP dan log peristiwa enkripsi ditulis ke lokasi yang diharapkan.

5. Perbarui jalur include di config.yaml agen Bindplane jika direktori log berbeda dari default.

Tabel pemetaan UDM

Kolom Log	Pemetaan UDM	Logika
perantara	perantara	Digabungkan dari perantara
relay_host	intermediary.hostname	Nilai disalin langsung dari relay_host
relay_ip	intermediary.ip	Digabungkan dari relay_ip
relay_port	intermediary.port	Nilai dari relay_port dikonversi menjadi bilangan bulat
message_details	metadata.description	Nilai yang disalin langsung dari message_details di blok smtp, smtpd, cleanup, atau error
principal_hostname, sender_email	metadata.event_type	Setel ke "EMAIL_TRANSACTION" jika principal_hostname dan sender_email tidak kosong, atau "NETWORK_CONNECTION" jika principal_hostname dan (target_host atau target_ip) tidak kosong, atau "STATUS_UPDATE" jika principal_hostname tidak kosong dan (target_host atau target_ip) kosong, atau "GENERIC_EVENT"
	metadata.product_name	Setel ke "Zix Email Encryption"
	metadata.vendor_name	Ditetapkan ke "Zix"
pesan	network.application_protocol	Tetapkan ke "SMTP" jika pesan cocok dengan smtp atau smtpd
sender_email	network.email.from	Nilai disalin langsung jika sender_email cocok dengan ekspresi reguler email
subject	network.email.subject	Digabungkan dari subjek
recipient_email	network.email.to	Digabungkan dari recipient_email jika cocok dengan regex email
data_size	network.received_bytes	Nilai dari data_size yang dikonversi menjadi uinteger
tls_cipher	network.tls.cipher	Nilai disalin langsung dari tls_cipher
cert_data	network.tls.client.certificate.issuer	Nilai yang disalin langsung dari cert_data
daemon	principal.application	Nilai disalin langsung dari daemon
principal_hostname	principal.hostname	Nilai disalin langsung dari principal_hostname
file	principal.process.file.full_path	Nilai disalin langsung dari file
pid	principal.process.pid	Nilai disalin langsung dari pid
	principal.resource.type	Disetel ke "CLEANUP_MESSAGE_ID" jika daemon sedang membersihkan
sender_email	principal.user.user_display_name	Nilai disalin secara langsung jika sender_email tidak cocok dengan ekspresi reguler email
user_id	principal.user.userid	Nilai dari user_id jika tidak kosong, jika tidak, dari user_id di blok else
security_result	security_result	Digabungkan dari security_result
security_action	security_result.action	Digabungkan dari security_action
failure_reason	security_result.description	Nilai disalin langsung dari failure_reason
security_summary	security_result.summary	Nilai disalin langsung dari security_summary
file	target.file.full_path	Nilai disalin langsung dari file
target_host	target.hostname	Nilai yang disalin langsung dari target_host
target_ip	target.ip	Digabungkan dari target_ip
target_port	target.port	Nilai dari target_port dikonversi menjadi bilangan bulat
message_id	target.resource.name	Nilai disalin langsung dari message_id
recipient_email	target.user.user_display_name	Nilai disalin secara langsung jika recipient_email tidak cocok dengan ekspresi reguler email

Log Perubahan

Melihat Log Perubahan untuk parser ini

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