Mengumpulkan log Citrix Receiver

Versi Parser: 1.0

Didukung di:

Dokumen ini menjelaskan cara menyerap log Citrix Receiver ke Google Security Operations menggunakan agen Bindplane.

Citrix Receiver (sekarang aplikasi Citrix Workspace) adalah aplikasi sisi klien yang menyediakan akses ke desktop virtual, aplikasi, dan data dari lingkungan Citrix Virtual Apps and Desktops. Log ini mencatat peristiwa sesi, autentikasi, dan aktivitas sisi klien.

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 host Citrix Receiver
  • Jika beroperasi dari balik proxy, pastikan port firewall terbuka sesuai dengan persyaratan agen Bindplane
  • Akses istimewa ke lingkungan Citrix dengan izin administrator
  • Akses ke file log Citrix Receiver di sistem file server atau klien

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
    
  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.

Mengonfigurasi agen Bindplane untuk menyerap log 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:
          - 'C:\Users\*\AppData\Local\Citrix\Receiver\*.log'
        start_at: beginning
        poll_interval: 5s
    
    exporters:
      chronicle/citrix_rx:
        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: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: chronicle.googleapis.com
        log_type: CSG_CITRIX_RX
        raw_log_field: body
        ingestion_labels:
          env: production
    
    service:
      pipelines:
        logs/citrix_rx_to_chronicle:
          receivers:
            - filelog
          exporters:
            - chronicle/citrix_rx
    

Parameter konfigurasi

Ganti placeholder berikut:

  • Konfigurasi penerima:

    • include: Jalur ke file log Citrix Receiver:
      • Windows: C:\Users\*\AppData\Local\Citrix\Receiver\*.log
      • Pengumpulan terpusat: Sesuaikan jalur jika log dikumpulkan ke berbagi terpusat
    • start_at: Tetapkan ke beginning untuk membaca log yang ada, atau end untuk hanya membaca entri baru
    • poll_interval: Seberapa sering memeriksa data log baru (default: 5s)
  • Konfigurasi pengekspor:

    • citrix_rx: 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 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.
    • CSG_CITRIX_RX: Jenis log persis seperti yang muncul di Chronicle
    • ingestion_labels: Label opsional dalam format YAML (misalnya, env: production)
  • Konfigurasi pipeline:

    • citrix_rx_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/citrix_rx:
        compression: gzip
        creds_file_path: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: CSG_CITRIX_RX
        raw_log_field: body
        ingestion_labels:
          env: production
    

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 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"
        

Mengaktifkan logging Citrix Receiver dan mengonfigurasi pengumpulan log

Logging dinonaktifkan secara default di Citrix Receiver. Anda harus mengaktifkannya menggunakan entri registry sebelum file log dibuat.

Mengaktifkan logging di Windows

  1. Buka Registry Editor (regedit) sebagai administrator di mesin klien Citrix Receiver.
  2. Buka HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\Receiver.
  3. Buat Nilai String baru bernama EnableTracing dan tetapkan ke true.
  4. Buat Nilai String baru bernama TracePath untuk menentukan jalur output log. Contoh:

    • C:\CitrixLogs\
    • Atau, gunakan jalur default: %USERPROFILE%\AppData\Local\Citrix\Receiver\
  5. Mulai ulang aplikasi Citrix Receiver agar perubahan diterapkan.

Memverifikasi pembuatan file log

  1. Setelah mengaktifkan logging, buka Citrix Receiver dan hubungkan ke resource yang dipublikasikan.
  2. Buka direktori log:
    • Jalur default: %USERPROFILE%\AppData\Local\Citrix\Receiver\
    • Jalur kustom: Jalur yang ditentukan dalam nilai registry TracePath.
  3. Pastikan file .log dibuat dan berisi data peristiwa sesi.
  4. Pastikan agen Bindplane memiliki izin baca pada direktori dan file log.

Tabel pemetaan UDM

Kolom Log Pemetaan UDM Logika
creationTime metadata.event_timestamp Diurai sebagai dd/M/yyyy HH:mm:ss
timestamp metadata.event_timestamp Diurai sebagai MMM d HH:mm:ss
has_principal metadata.event_type Dipetakan: true → NETWORK_CONNECTION
has_user metadata.event_type Dipetakan: true → USER_UNCATEGORIZED
logId metadata.product_log_id Dipetakan secara langsung
srcip principal.asset.ip Digabung
srcip principal.ip Digabung
userId principal.user.userid Dipetakan secara langsung
application target.application Dipetakan secara langsung
targetip target.asset.ip Digabung
targetip target.ip Digabung
resourcename target.resource.name Dipetakan secara langsung
T/A metadata.event_type Konstanta: NETWORK_CONNECTION
T/A metadata.product_name Konstanta: CSG Citrix RX
T/A metadata.vendor_name Konstanta: CSG Citrix RX
logId event.idm.read_only_udm.metadata.product_log_id Dipetakan dari log perubahan
application event.idm.read_only_udm.target.application Dipetakan dari log perubahan
resourcename event.idm.read_only_udm.target.resource.name Dipetakan dari log perubahan
srcip event.idm.read_only_udm.principal.ip Dipetakan dari log perubahan
target event.idm.read_only_udm.principal.asset.ip Dipetakan dari log perubahan
creationTime event.idm.read_only_udm.target.resource.attribute.creation_time Dipetakan dari log perubahan
user event.idm.read_only_udm.principal.user.user Dipetakan dari log perubahan
targetip event.idm.read_only_udm.target.ip Dipetakan dari log perubahan
timestamp event.idm.read_only_udm.metadata.timestamp Dipetakan dari log perubahan

Log Perubahan

Melihat Log Perubahan untuk parser ini

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