Mengumpulkan log TeamViewer
Dokumen ini menjelaskan cara menyerap log TeamViewer ke Google Security Operations menggunakan Google Cloud Storage. Parser mengekstrak peristiwa audit dari log berformat JSON. Aturan ini melakukan iterasi melalui detail peristiwa, memetakan properti tertentu ke kolom Model Data Terpadu (UDM), menangani informasi peserta dan penyaji, serta mengategorikan peristiwa berdasarkan aktivitas pengguna. Parser juga melakukan transformasi data, seperti menggabungkan label dan mengonversi stempel waktu ke format standar.
Sebelum memulai
Pastikan Anda memiliki prasyarat berikut:
- Instance Google SecOps
- Project Google Cloud dengan Cloud Storage API diaktifkan
- Izin untuk membuat dan mengelola bucket Cloud Storage
- Izin untuk mengelola kebijakan IAM di bucket Cloud Storage
- Izin untuk membuat layanan Cloud Run, topik Pub/Sub, dan tugas Cloud Scheduler
- Akses istimewa ke TeamViewer Management Console
- Lisensi TeamViewer Business, Premium, Corporate, atau Tensor (diperlukan untuk akses API)
Membuat bucket Google Cloud Storage
- Buka Konsol Google Cloud.
- Pilih project Anda atau buat project baru.
- Di menu navigasi, buka Cloud Storage > Buckets.
- Klik Create bucket.
Berikan detail konfigurasi berikut:
Setelan Nilai Memberi nama bucket Anda Masukkan nama yang unik secara global (misalnya, teamviewer-logs)Location type Pilih sesuai kebutuhan Anda (Region, Dual-region, Multi-region) Location Pilih lokasi (misalnya, us-central1)Storage class Standard (direkomendasikan untuk log yang sering diakses) Kontrol akses Seragam (direkomendasikan) Alat perlindungan Opsional: Mengaktifkan pembuatan versi objek atau kebijakan retensi Klik Create.
Mendapatkan prasyarat TeamViewer
- Login ke TeamViewer Management Console di https://login.teamviewer.com/.
- Klik ikon pengguna di pojok kanan atas, lalu pilih Edit profil.
- Pilih Aplikasi.
- Klik Buat token skrip.
- Berikan detail konfigurasi berikut:
- Token name: Masukkan nama deskriptif (misalnya,
Google SecOps Integration). - Permissions: Pilih izin berikut:
- Pengelolaan akun > Lihat data akun
- Pengelolaan sesi > Lihat data sesi
- Pelaporan koneksi > Melihat laporan koneksi
- Token name: Masukkan nama deskriptif (misalnya,
- Klik Create.
Salin dan simpan token skrip yang dihasilkan di lokasi yang aman.
Catat URL Dasar TeamViewer API Anda:
https://webapi.teamviewer.com/api/v1
Memverifikasi izin
Untuk memverifikasi bahwa akun memiliki izin yang diperlukan:
- Login ke TeamViewer Management Console.
- Buka Edit profil > Aplikasi.
- Temukan token skrip Anda dalam daftar.
- Pastikan Pelaporan koneksi > Lihat laporan koneksi diaktifkan.
- Jika izin ini tidak diaktifkan, edit token dan tambahkan izin yang diperlukan.
Menguji akses API
Uji kredensial Anda sebelum melanjutkan integrasi:
# Replace with your actual script token SCRIPT_TOKEN="your-script-token" API_BASE="https://webapi.teamviewer.com/api/v1" # Test API access curl -v -X POST -H "Authorization: Bearer ${SCRIPT_TOKEN}" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"StartDate": "2024-01-01T00:00:00Z", "EndDate": "2024-01-01T01:00:00Z"}' \ "${API_BASE}/EventLogging"
Jika Anda menerima respons 200 dengan data JSON, kredensial Anda telah dikonfigurasi dengan benar.
Membuat akun layanan untuk fungsi Cloud Run
Fungsi Cloud Run memerlukan akun layanan dengan izin untuk menulis ke bucket Cloud Storage dan dipanggil oleh Pub/Sub.
Membuat akun layanan
- Di Google Cloud konsol, buka IAM & Admin > Service Accounts.
- Klik Create Service Account.
- Berikan detail konfigurasi berikut:
- Service account name: Masukkan
teamviewer-collector-sa. - Service account description: Masukkan
Service account for Cloud Run function to collect TeamViewer logs.
- Service account name: Masukkan
- Klik Create and Continue.
- Di bagian Grant this service account access to project, tambahkan peran berikut:
- Klik Pilih peran.
- Telusuri dan pilih Storage Object Admin.
- Klik + Add another role.
- Telusuri dan pilih Cloud Run Invoker.
- Klik + Add another role.
- Telusuri dan pilih Cloud Functions Invoker.
- Klik Lanjutkan.
- Klik Done.
Peran ini diperlukan untuk:
- Storage Object Admin: Menulis log ke bucket Cloud Storage dan mengelola state file
- Cloud Run Invoker: Mengizinkan Pub/Sub memanggil fungsi
- Cloud Functions Invoker: Mengizinkan pemanggilan fungsi
Memberikan izin IAM pada bucket Cloud Storage
Beri akun layanan izin tulis di bucket Cloud Storage:
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda (misalnya,
teamviewer-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan entitas: Masukkan email akun layanan (misalnya,
teamviewer-collector-sa@PROJECT_ID.iam.gserviceaccount.com). - Assign roles: Pilih Storage Object Admin.
- Tambahkan entitas: Masukkan email akun layanan (misalnya,
- Klik Simpan.
Membuat topik Pub/Sub
Buat topik Pub/Sub yang akan dipublikasikan oleh Cloud Scheduler dan di-subscribe oleh fungsi Cloud Run.
- Di Google Cloud konsol, buka Pub/Sub > Topics.
- Klik Create topic.
- Berikan detail konfigurasi berikut:
- ID Topik: Masukkan
teamviewer-logs-trigger. - Biarkan setelan lainnya sesuai default.
- ID Topik: Masukkan
- Klik Create.
Membuat fungsi Cloud Run untuk mengumpulkan log
Fungsi Cloud Run dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil log dari TeamViewer API dan menulisnya ke Cloud Storage.
- Di konsolGoogle Cloud , buka Cloud Run.
- Klik Create service.
- Pilih Function (gunakan editor inline untuk membuat fungsi).
Di bagian Configure, berikan detail konfigurasi berikut:
Setelan Nilai Nama layanan teamviewer-logs-collectorRegion Pilih region yang cocok dengan bucket Cloud Storage Anda (misalnya, us-central1)Runtime Pilih Python 3.12 atau yang lebih baru Di bagian Trigger (optional):
- Klik + Tambahkan pemicu.
- Pilih Cloud Pub/Sub.
- Di Select a Cloud Pub/Sub topic, pilih topik Pub/Sub (
teamviewer-logs-trigger). - Klik Simpan.
Di bagian Authentication:
- Pilih Wajibkan autentikasi.
- Periksa Identity and Access Management (IAM).
Buka dan luaskan Containers, Networking, Security.
Buka tab Keamanan:
- Service account: Pilih akun layanan (
teamviewer-collector-sa).
- Service account: Pilih akun layanan (
Buka tab Penampung:
- Klik Variables & Secrets.
- Klik + Add variable untuk setiap variabel lingkungan:
Nama Variabel Nilai Contoh GCS_BUCKETteamviewer-logsGCS_PREFIXteamviewer/audit/STATE_KEYteamviewer/audit/state.jsonWINDOW_SECONDS3600HTTP_TIMEOUT60MAX_RETRIES3USER_AGENTteamviewer-to-gcs/1.0SCRIPT_TOKENyour-script-token(dari prasyarat TeamViewer)API_BASE_URLhttps://webapi.teamviewer.com/api/v1Di bagian Variables & Secrets, buka Requests:
- Request timeout: Masukkan
600detik (10 menit).
- Request timeout: Masukkan
Buka tab Setelan:
- Di bagian Resources:
- Memory: Pilih 512 MiB atau lebih tinggi.
- CPU: Pilih 1.
- Di bagian Resources:
Di bagian Revision scaling:
- Minimum number of instances: Masukkan
0. - Maximum number of instances: Masukkan
100(atau sesuaikan berdasarkan beban yang diharapkan).
- Minimum number of instances: Masukkan
Klik Create.
Tunggu hingga layanan dibuat (1-2 menit).
Setelah layanan dibuat, editor kode inline akan otomatis terbuka.
Menambahkan kode fungsi
- Masukkan main di Function entry point
Di editor kode inline, buat dua file:
- File pertama: main.py:
import functions_framework from google.cloud import storage import json import os import urllib.request import urllib.parse import urllib.error from datetime import datetime, timezone import time import uuid # Initialize Storage client storage_client = storage.Client() @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch TeamViewer audit logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ # Get environment variables bucket_name = os.environ.get('GCS_BUCKET') prefix = os.environ.get('GCS_PREFIX', 'teamviewer/audit/') state_key = os.environ.get('STATE_KEY', 'teamviewer/audit/state.json') window_sec = int(os.environ.get('WINDOW_SECONDS', '3600')) http_timeout = int(os.environ.get('HTTP_TIMEOUT', '60')) max_retries = int(os.environ.get('MAX_RETRIES', '3')) user_agent = os.environ.get('USER_AGENT', 'teamviewer-to-gcs/1.0') # TeamViewer API credentials api_base_url = os.environ.get('API_BASE_URL') script_token = os.environ.get('SCRIPT_TOKEN') if not all([bucket_name, api_base_url, script_token]): print('Error: Missing required environment variables') return try: # Get GCS bucket bucket = storage_client.bucket(bucket_name) # Load state (last processed timestamp) state = load_state(bucket, state_key) now = time.time() from_ts = float(state.get('last_to_ts') or (now - window_sec)) to_ts = now print(f'Fetching TeamViewer audit data from {iso_format(from_ts)} to {iso_format(to_ts)}') # Build audit API URL url = build_audit_url(api_base_url) print(f'Fetching TeamViewer audit data from: {url}') # Fetch audit data with retries and pagination all_records = [] continuation_token = None # Inside main() loop: while True: blob_data, content_type, next_token = fetch_audit_data( url, script_token, user_agent, http_timeout, max_retries, from_ts, to_ts, continuation_token ) # Validate JSON data try: audit_data = json.loads(blob_data) records = audit_data.get('AuditEvents', []) all_records.extend(records) print(f"Retrieved {len(records)} audit records (total: {len(all_records)})") # Check for pagination if next_token: continuation_token = next_token print(f"Fetching next page with ContinuationToken: {continuation_token}") else: break except json.JSONDecodeError as e: print(f"Warning: Invalid JSON received: {e}") break if all_records: # Write to GCS key = put_audit_data(bucket, prefix, json.dumps({'AuditEvents': all_records}), 'application/json', from_ts, to_ts) print(f'Successfully wrote {len(all_records)} audit records to {key}') else: print('No audit records found') # Update state state['last_to_ts'] = to_ts state['last_successful_run'] = now save_state(bucket, state_key, state) except Exception as e: print(f'Error processing TeamViewer logs: {str(e)}') raise def load_state(bucket, key): """Load state from GCS.""" try: blob = bucket.blob(key) if blob.exists(): state_data = blob.download_as_text() return json.loads(state_data) except Exception as e: print(f'Warning: Could not load state: {str(e)}') return {} def save_state(bucket, key, state): """Save state to GCS.""" try: blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, separators=(',', ':')), content_type='application/json' ) except Exception as e: print(f'Warning: Could not save state: {str(e)}') def iso_format(ts): """Convert Unix timestamp to ISO 8601 format.""" return time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime(ts)) def build_audit_url(api_base_url): """Build URL for TeamViewer audit API endpoint.""" return f"{api_base_url.rstrip('/')}/EventLogging" def fetch_audit_data(url, script_token, user_agent, http_timeout, max_retries, from_ts, to_ts, continuation_token=None): """Fetch audit data from TeamViewer API with retries and pagination support.""" # Construct JSON payload payload = { "StartDate": iso_format(from_ts), "EndDate": iso_format(to_ts) } if continuation_token: payload["ContinuationToken"] = continuation_token attempt = 0 while True: req = urllib.request.Request(url, method='POST') req.add_header('User-Agent', user_agent) req.add_header('Authorization', f'Bearer {script_token}') req.add_header('Content-Type', 'application/json') req.add_header('Accept', 'application/json') # Encode payload as bytes for POST body data = json.dumps(payload).encode('utf-8') try: with urllib.request.urlopen(req, data=data, timeout=http_timeout) as r: response_data = r.read() content_type = r.headers.get('Content-Type') or 'application/json' try: data = json.loads(response_data) next_token = data.get('ContinuationToken') except: next_token = None return response_data, content_type, next_token except urllib.error.HTTPError as e: if e.code == 429: attempt += 1 print(f'Rate limited (429) on attempt {attempt}') if attempt > max_retries: raise time.sleep(min(60, 2 ** attempt) + (time.time() % 1)) else: print(f'HTTP error {e.code}: {e.reason}') raise except urllib.error.URLError as e: attempt += 1 print(f'URL error on attempt {attempt}: {e}') if attempt > max_retries: raise time.sleep(min(60, 2 ** attempt) + (time.time() % 1)) def put_audit_data(bucket, prefix, blob_data, content_type, from_ts, to_ts): """Write audit data to GCS.""" ts_path = time.strftime('%Y/%m/%d', time.gmtime(to_ts)) uniq = f"{int(time.time() * 1e6)}_{uuid.uuid4().hex[:8]}" key = f"{prefix}{ts_path}/teamviewer_audit_{int(from_ts)}_{int(to_ts)}_{uniq}.json" blob = bucket.blob(key) blob.metadata = { 'source': 'teamviewer-audit', 'from_timestamp': str(int(from_ts)), 'to_timestamp': str(int(to_ts)) } blob.upload_from_string(blob_data, content_type=content_type) return key- File kedua: requirements.txt:
functions-framework==3.* google-cloud-storage==2.*Klik Deploy untuk menyimpan dan men-deploy fungsi.
Tunggu hingga deployment selesai (2-3 menit).
Buat tugas Cloud Scheduler
Cloud Scheduler memublikasikan pesan ke topik Pub/Sub secara berkala, sehingga memicu fungsi Cloud Run.
- Di konsolGoogle Cloud , buka Cloud Scheduler.
- Klik Create Job.
Berikan detail konfigurasi berikut:
Setelan Nilai Nama teamviewer-logs-collector-hourlyRegion Pilih region yang sama dengan fungsi Cloud Run Frekuensi 0 * * * *(setiap jam, tepat pada jamnya)Zona Waktu Pilih zona waktu (UTC direkomendasikan) Jenis target Pub/Sub Topik Pilih topik Pub/Sub ( teamviewer-logs-trigger)Isi pesan {}(objek JSON kosong)Klik Create.
Opsi frekuensi jadwal
Pilih frekuensi berdasarkan volume log dan persyaratan latensi:
| Frekuensi | Ekspresi Cron | Kasus Penggunaan |
|---|---|---|
| Setiap 5 menit | */5 * * * * |
Volume tinggi, latensi rendah |
| Setiap 15 menit | */15 * * * * |
Volume sedang |
| Setiap jam | 0 * * * * |
Standar (direkomendasikan) |
| Setiap 6 jam | 0 */6 * * * |
Volume rendah, pemrosesan batch |
| Harian | 0 0 * * * |
Pengumpulan data historis |
Menguji integrasi
- Di konsol Cloud Scheduler, temukan tugas Anda (
teamviewer-logs-collector-hourly). - Klik Force run untuk memicu tugas secara manual.
- Tunggu beberapa detik.
- Buka Cloud Run > Services.
- Klik nama fungsi (
teamviewer-logs-collector). - Klik tab Logs.
Pastikan fungsi berhasil dieksekusi. Cari hal berikut:
Fetching TeamViewer audit data from YYYY-MM-DDTHH:MM:SSZ to YYYY-MM-DDTHH:MM:SSZ Retrieved X audit records (total: X) Successfully wrote X audit records to teamviewer/audit/YYYY/MM/DD/teamviewer_audit_...jsonBuka Cloud Storage > Buckets.
Klik nama bucket Anda (
teamviewer-logs).Buka folder awalan (
teamviewer/audit/).Pastikan file
.jsonbaru telah dibuat dengan stempel waktu saat ini.
Jika Anda melihat error di log:
- HTTP 401: Pastikan variabel lingkungan
SCRIPT_TOKENcocok dengan token skrip TeamViewer Anda - HTTP 403: Pastikan token skrip memiliki izin Pelaporan koneksi > Melihat laporan koneksi
- HTTP 429: Pembatasan kapasitas - fungsi akan otomatis mencoba ulang dengan backoff eksponensial
- Variabel lingkungan tidak ada: Pastikan semua variabel yang diperlukan (
GCS_BUCKET,API_BASE_URL,SCRIPT_TOKEN) telah ditetapkan
Mengambil akun layanan Google SecOps
Google SecOps menggunakan akun layanan unik untuk membaca data dari bucket Cloud Storage Anda. Anda harus memberi akun layanan ini akses ke bucket Anda.
Mendapatkan email akun layanan
- Buka Setelan > Pengelolaan Data > Feed. Jika Anda menggunakan platform khusus SIEM, buka Settings > Feeds.
- Klik Tambahkan Feed Berita Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
TeamViewer logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih TeamViewer sebagai Jenis log.
Klik Get Service Account. Email akun layanan yang unik akan ditampilkan, misalnya:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comSalin alamat email ini untuk digunakan di langkah berikutnya.
Memberikan izin IAM ke akun layanan Google SecOps
Akun layanan Google SecOps memerlukan peran Storage Object Viewer di bucket Cloud Storage Anda.
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda (
teamviewer-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Add principals: Tempel email akun layanan Google SecOps.
- Assign roles: Pilih Storage Object Viewer.
Klik Simpan.
Mengonfigurasi feed di Google SecOps untuk menyerap log TeamViewer
- Buka Setelan > Pengelolaan Data > Feed. Jika Anda menggunakan platform khusus SIEM, buka Settings > Feeds.
- Klik Tambahkan Feed Berita Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
TeamViewer logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih TeamViewer sebagai Jenis log.
- Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
Storage bucket URL: Masukkan URI bucket Cloud Storage dengan jalur awalan:
gs://teamviewer-logs/teamviewer/audit/Ganti:
teamviewer-logs: Nama bucket Cloud Storage Anda.teamviewer/audit/: Awalan atau jalur tempat log disimpan.
Opsi penghapusan sumber: Pilih opsi penghapusan sesuai preferensi Anda:
- Never: Tidak pernah menghapus file apa pun setelah transfer (direkomendasikan untuk pengujian).
- Delete transferred files: Menghapus file setelah transfer berhasil.
Delete transferred files and empty directories: Menghapus file dan direktori kosong setelah transfer berhasil.
Usia File Maksimum: Sertakan file yang diubah dalam jumlah hari terakhir. Defaultnya adalah 180 hari.
Namespace aset: Namespace aset.
Label penyerapan: Label yang akan diterapkan ke peristiwa dari feed ini.
Klik Berikutnya.
Tinjau konfigurasi feed berita baru Anda di layar Finalize, lalu klik Submit.
Tabel pemetaan UDM
| Kolom log | Pemetaan UDM | Logika |
|---|---|---|
| AffectedItem | metadata.product_log_id | Nilai AffectedItem dari log mentah dipetakan langsung ke kolom UDM ini. |
| EventDetails.NewValue | principal.resource.attribute.labels.value | Jika PropertyName berisi (server), NewValue akan digunakan sebagai nilai label di principal.resource.attribute.labels. |
| EventDetails.NewValue | principal.user.user_display_name | Jika PropertyName adalah Nama peserta, NewValue akan digunakan sebagai nama tampilan pengguna untuk akun utama. |
| EventDetails.NewValue | principal.user.userid | Jika PropertyName adalah ID peserta, NewValue akan digunakan sebagai ID pengguna untuk akun utama. |
| EventDetails.NewValue | security_result.about.labels.value | Untuk semua nilai PropertyName lainnya (kecuali yang ditangani oleh kondisi tertentu), NewValue digunakan sebagai nilai label dalam array security_result.about.labels. |
| EventDetails.NewValue | target.file.full_path | Jika PropertyName adalah Source file, NewValue akan digunakan sebagai jalur lengkap untuk file target. |
| EventDetails.NewValue | target.resource.attribute.labels.value | Jika PropertyName berisi (client), NewValue akan digunakan sebagai nilai label di target.resource.attribute.labels. |
| EventDetails.NewValue | target.user.user_display_name | Jika PropertyName adalah Nama presenter, NewValue akan diuraikan. Jika berupa bilangan bulat, nilai tersebut akan dihapus. Jika tidak, nama tersebut akan digunakan sebagai nama tampilan pengguna untuk target. |
| EventDetails.NewValue | target.user.userid | Jika PropertyName adalah ID presenter, NewValue akan digunakan sebagai ID pengguna untuk target. |
| EventDetails.PropertyName | principal.resource.attribute.labels.key | Jika PropertyName berisi (server), PropertyName akan digunakan sebagai kunci label di principal.resource.attribute.labels. |
| EventDetails.PropertyName | security_result.about.labels.key | Untuk semua nilai PropertyName lainnya (kecuali yang ditangani oleh kondisi tertentu), PropertyName digunakan sebagai kunci label dalam array security_result.about.labels. |
| EventDetails.PropertyName | target.resource.attribute.labels.key | Jika PropertyName berisi (client), PropertyName akan digunakan sebagai kunci label di target.resource.attribute.labels. |
| EventName | metadata.product_event_type | Nilai EventName dari log mentah dipetakan langsung ke kolom UDM ini. |
| Stempel waktu | metadata.event_timestamp | Nilai Timestamp dari log mentah diuraikan dan digunakan sebagai stempel waktu peristiwa dalam metadata. |
| metadata.event_type | Tetapkan ke USER_UNCATEGORIZED jika src_user (berasal dari ID peserta) tidak kosong, jika tidak, tetapkan ke USER_RESOURCE_ACCESS. | |
| metadata.vendor_name | Dihardcode ke TEAMVIEWER. | |
| metadata.product_name | Dihardcode ke TEAMVIEWER. | |
| network.application_protocol | Dihardcode ke TEAMVIEWER. |
Log Perubahan
Melihat Log Perubahan untuk parser ini
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.