Mengumpulkan log Proofpoint Secure Email Relay
Dokumen ini menjelaskan cara menyerap log Proofpoint Secure Email Relay ke Google Security Operations menggunakan Google Cloud Storage V2.
Proofpoint Secure Email Relay (SER) adalah layanan keamanan email keluar yang menyediakan enkripsi, pencegahan kebocoran data (DLP), dan penegakan kepatuhan untuk pesan yang dikirim dari organisasi Anda. Parser mengekstrak kolom dari data pelacakan pesan SER dan memetakannya ke Model Data Terpadu (UDM), yang mencakup metadata email, metrik throughput, status pengiriman, dan aktivitas pengguna.
Sebelum memulai
Pastikan Anda memiliki prasyarat berikut:
- Instance Google SecOps
- Project GCP dengan Cloud Storage API diaktifkan
- Izin untuk membuat dan mengelola bucket GCS
- Izin untuk mengelola kebijakan IAM di bucket GCS
- Izin untuk membuat layanan Cloud Run, topik Pub/Sub, dan tugas Cloud Scheduler
- Akses istimewa ke Proofpoint Secure Email Relay dengan akses kunci 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 Beri nama bucket Anda Masukkan nama yang unik secara global (misalnya, proofpoint-ser-logs)Location type Pilih berdasarkan kebutuhan Anda (Region, Dual-region, Multi-region) Location Pilih lokasi (misalnya, us-central1)Kelas penyimpanan Standar (direkomendasikan untuk log yang sering diakses) Access control Seragam (direkomendasikan) Alat perlindungan Opsional: Aktifkan pembuatan versi objek atau kebijakan retensi Klik Create.
Kumpulkan kredensial Proofpoint SER API
Mendapatkan kredensial API
- Login ke portal admin Proofpoint Secure Email Relay dengan kredensial administrator.
- Buka Settings > API Keys.
- Klik Buat atau Buat Kunci API.
Salin dan simpan kredensial berikut dengan aman:
- Kunci API: Salin nilai ini
- Rahasia API: Salin nilai ini
Verifikasi izin
Untuk memverifikasi bahwa kredensial API memiliki izin yang diperlukan:
- Login ke portal admin SER Proofpoint.
- Buka Settings > API Keys.
- Pastikan kunci API tercantum dan memiliki status Aktif.
- Pastikan kunci memiliki akses ke endpoint pelaporan dan pelacakan pesan.
Menguji akses API
Uji kredensial Anda sebelum melanjutkan integrasi:
# Replace with your actual credentials API_KEY="<your-api-key>" API_SECRET="<your-api-secret>" # Test API access - retrieve recent messages curl -v -u "${API_KEY}:${API_SECRET}" \ "https://ser-api.proofpoint.com/v1/messages?startDate=$(date -u -v-1H +%Y-%m-%dT%H:%M:%SZ)&endDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)"
Buat akun layanan untuk Cloud Run Function
Fungsi Cloud Run memerlukan akun layanan dengan izin untuk menulis ke bucket GCS dan dipanggil oleh Pub/Sub.
Membuat akun layanan
- Di GCP Console, buka IAM & Admin > Service Accounts.
- Klik Create Service Account.
- Berikan detail konfigurasi berikut:
- Nama akun layanan: Masukkan
proofpoint-ser-collector-sa - Deskripsi akun layanan: Masukkan
Service account for Cloud Run function to collect Proofpoint Secure Email Relay logs
- Nama akun layanan: Masukkan
- Klik Create and Continue.
- Di bagian Berikan akun layanan ini akses ke 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 GCS dan mengelola file status
- Cloud Run Invoker: Mengizinkan Pub/Sub memanggil fungsi
- Cloud Functions Invoker: Mengizinkan pemanggilan fungsi
Memberikan izin IAM pada bucket GCS
Beri akun layanan izin tulis di bucket GCS:
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda (misalnya,
proofpoint-ser-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan prinsipal: Masukkan email akun layanan (misalnya,
proofpoint-ser-collector-sa@PROJECT_ID.iam.gserviceaccount.com) - Tetapkan peran: Pilih Storage Object Admin
- Tambahkan prinsipal: Masukkan email akun layanan (misalnya,
- Klik Simpan.
Membuat topik Pub/Sub
Buat topik Pub/Sub yang akan dipublikasikan oleh Cloud Scheduler dan akan dilanggan oleh fungsi Cloud Run.
- Di Konsol GCP, buka Pub/Sub > Topics.
- Klik Create topic.
- Berikan detail konfigurasi berikut:
- ID Topik: Masukkan
proofpoint-ser-trigger - Biarkan setelan lainnya menggunakan setelan default
- ID Topik: Masukkan
- Klik Create.
Membuat fungsi Cloud Run untuk mengumpulkan log
Fungsi Cloud Run akan dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil log pesan dari Proofpoint SER API dan menuliskannya ke GCS.
- Di Konsol GCP, buka Cloud Run.
- Klik Create service.
- Pilih Function (gunakan editor inline untuk membuat fungsi).
Di bagian Konfigurasi, berikan detail konfigurasi berikut:
Setelan Nilai Nama layanan proofpoint-ser-collectorRegion Pilih region yang cocok dengan bucket GCS Anda (misalnya, us-central1)Runtime Pilih Python 3.12 atau yang lebih baru Di bagian Pemicu (opsional):
- Klik + Tambahkan pemicu.
- Pilih Cloud Pub/Sub.
- Di Select a Cloud Pub/Sub topic, pilih topik Pub/Sub (
proofpoint-ser-trigger). - Klik Simpan.
Di bagian Authentication:
- Pilih Wajibkan autentikasi.
- Periksa Identity and Access Management (IAM).
Scroll ke bawah dan luaskan Containers, Networking, Security.
Buka tab Security:
- Akun layanan: Pilih akun layanan (
proofpoint-ser-collector-sa)
- Akun layanan: Pilih akun layanan (
Buka tab Containers:
- Klik Variables & Secrets.
- Klik + Tambahkan variabel untuk setiap variabel lingkungan:
Nama Variabel Nilai Contoh Deskripsi GCS_BUCKETproofpoint-ser-logsNama bucket GCS GCS_PREFIXser-logsAwalan untuk file log STATE_KEYser-logs/state.jsonJalur file status API_KEYyour-api-keyKunci Proofpoint SER API API_SECRETyour-api-secretRahasia Proofpoint SER API MAX_RECORDS1000Jumlah maksimum data per proses PAGE_SIZE100Catatan per halaman LOOKBACK_HOURS1Periode lihat balik awal Di bagian Variables & Secrets, scroll ke bawah ke Requests:
- Waktu tunggu permintaan: Masukkan
600detik (10 menit)
- Waktu tunggu permintaan: Masukkan
Buka tab Setelan:
- Di bagian Materi:
- Memori: Pilih 512 MiB atau yang lebih tinggi
- CPU: Pilih 1
- Di bagian Materi:
Di bagian Penskalaan revisi:
- Minimum number of instances: Masukkan
0 - Jumlah maksimum instance: Masukkan
100(atau sesuaikan berdasarkan perkiraan beban)
- Minimum number of instances: Masukkan
Klik Create.
Tunggu hingga layanan dibuat (1-2 menit).
Setelah layanan dibuat, editor kode inline akan terbuka secara otomatis.
Menambahkan kode fungsi
- Masukkan main di kolom 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 urllib3 from datetime import datetime, timezone, timedelta import time import base64 # Initialize HTTP client with timeouts http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=30.0), retries=False, ) # Initialize Storage client storage_client = storage.Client() # Environment variables GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'ser-logs') STATE_KEY = os.environ.get('STATE_KEY', 'ser-logs/state.json') API_KEY = os.environ.get('API_KEY') API_SECRET = os.environ.get('API_SECRET') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '1000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '1')) API_BASE = "https://ser-api.proofpoint.com/v1" def parse_datetime(value: str) -> datetime: """Parse ISO datetime string to datetime object.""" if value.endswith("Z"): value = value[:-1] + "+00:00" return datetime.fromisoformat(value) @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Proofpoint SER message logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, API_KEY, API_SECRET]): print('Error: Missing required environment variables') return try: # Get GCS bucket bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") # Build auth header (Basic auth with API key and secret) auth_string = f"{API_KEY}:{API_SECRET}" auth_bytes = auth_string.encode('utf-8') auth_b64 = base64.b64encode(auth_bytes).decode('utf-8') # Fetch messages records, newest_event_time = fetch_messages( auth_b64=auth_b64, start_time=last_time, end_time=now, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) if not records: print("No new log records found.") save_state(bucket, STATE_KEY, now.isoformat()) return # Write to GCS as NDJSON timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/logs_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in records]) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(records)} records to gs://{GCS_BUCKET}/{object_key}") # Update state with newest event time if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(records)} records") except Exception as e: print(f'Error processing 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: {e}") return {} def save_state(bucket, key, last_event_time_iso: str): """Save the last event timestamp to GCS state file.""" try: state = {'last_event_time': last_event_time_iso} blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_event_time={last_event_time_iso}") except Exception as e: print(f"Warning: Could not save state: {e}") def fetch_messages(auth_b64: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch message logs from Proofpoint SER API with pagination. Args: auth_b64: Base64-encoded API key:secret for Basic auth start_time: Start time for log query end_time: End time for log query page_size: Number of records per page max_records: Maximum total records to fetch Returns: Tuple of (records list, newest_event_time ISO string) """ headers = { 'Authorization': f'Basic {auth_b64}', 'Accept': 'application/json', 'Content-Type': 'application/json', 'User-Agent': 'GoogleSecOps-ProofpointSERCollector/1.0', } records = [] newest_time = None page_num = 0 backoff = 1.0 offset = 0 start_date = start_time.strftime('%Y-%m-%dT%H:%M:%SZ') end_date = end_time.strftime('%Y-%m-%dT%H:%M:%SZ') while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break current_limit = min(page_size, max_records - len(records)) url = f"{API_BASE}/messages?startDate={start_date}&endDate={end_date}&offset={offset}&limit={current_limit}" try: response = http.request('GET', url, headers=headers) # Handle rate limiting with exponential backoff if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429). Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue backoff = 1.0 if response.status != 200: print(f"HTTP Error: {response.status}") response_text = response.data.decode('utf-8') print(f"Response body: {response_text}") return [], None data = json.loads(response.data.decode('utf-8')) if isinstance(data, list): page_results = data else: page_results = data.get('messages', data.get('results', data.get('data', []))) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} messages") records.extend(page_results) # Track newest event time for event in page_results: try: event_time = event.get('date') or event.get('timestamp') or event.get('sentDate') if event_time: if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time): newest_time = event_time except Exception as e: print(f"Warning: Could not parse event time: {e}") # Check for more results if len(page_results) < current_limit: print(f"Reached last page (size={len(page_results)} < limit={current_limit})") break offset += len(page_results) except Exception as e: print(f"Error fetching messages: {e}") return [], None print(f"Retrieved {len(records)} total messages from {page_num} pages") return records, newest_timeFile kedua - requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0
Klik Deploy untuk menyimpan dan men-deploy fungsi.
Tunggu hingga deployment selesai (2-3 menit).
Buat tugas Cloud Scheduler
Cloud Scheduler akan memublikasikan pesan ke topik Pub/Sub secara berkala, sehingga memicu fungsi Cloud Run.
- Di GCP Console, buka Cloud Scheduler.
- Klik Create Job.
Berikan detail konfigurasi berikut:
Setelan Nilai Nama proofpoint-ser-collector-hourlyRegion Pilih region yang sama dengan fungsi Cloud Run Frekuensi 0 * * * *(setiap jam, tepat pada waktunya)Zona Waktu Pilih zona waktu (UTC direkomendasikan) Jenis target Pub/Sub Topik Pilih topik Pub/Sub ( proofpoint-ser-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.
- Klik Force run untuk memicu tugas secara manual.
- Tunggu beberapa detik.
- Buka Cloud Run > Services.
- Klik nama fungsi Anda (
proofpoint-ser-collector). - Klik tab Logs.
Pastikan fungsi berhasil dieksekusi. Cari:
Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Page 1: Retrieved X messages Wrote X records to gs://proofpoint-ser-logs/ser-logs/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsBuka Cloud Storage > Buckets.
Klik nama bucket Anda (
proofpoint-ser-logs).Buka folder awalan (
ser-logs/).Pastikan file
.ndjsonbaru dibuat dengan stempel waktu saat ini.
Jika Anda melihat error dalam log:
- HTTP 401: Periksa kunci API dan rahasia API di variabel lingkungan
- HTTP 403: Pastikan kunci API memiliki akses ke endpoint pelacakan pesan
- HTTP 429: Pembatasan kecepatan - fungsi akan otomatis mencoba lagi dengan penundaan
- Variabel lingkungan tidak ada: Pastikan semua variabel yang diperlukan telah ditetapkan
Mengambil akun layanan Google SecOps
Google SecOps menggunakan akun layanan unik untuk membaca data dari bucket GCS Anda. Anda harus memberi akun layanan ini akses ke bucket Anda.
Dapatkan email akun layanan
- Buka Setelan SIEM > Feed.
- Klik Tambahkan Feed Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
Proofpoint SER Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih ProofPoint Secure Email Relay 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.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
URL bucket penyimpanan: Masukkan URI bucket GCS dengan jalur awalan:
gs://proofpoint-ser-logs/ser-logs/- Ganti:
proofpoint-ser-logs: Nama bucket GCS Anda.ser-logs: Awalan/jalur folder opsional tempat log disimpan (biarkan kosong untuk root).
- Ganti:
Opsi penghapusan sumber: Pilih opsi penghapusan sesuai preferensi Anda:
- Jangan pernah: Tidak pernah menghapus file apa pun setelah transfer (direkomendasikan untuk pengujian).
- Hapus file yang ditransfer: Menghapus file setelah transfer berhasil.
Hapus file yang ditransfer dan direktori kosong: Menghapus file dan direktori kosong setelah transfer berhasil.
Usia File Maksimum: Menyertakan file yang diubah dalam beberapa 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 baru Anda di layar Selesaikan, lalu klik Kirim.
Memberikan izin IAM ke akun layanan Google SecOps
3Akun layanan Google SecOps memerlukan peran Storage Object Viewer di bucket GCS Anda.
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda (misalnya,
proofpoint-ser-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Add principals: Tempel email akun layanan Google SecOps
- Tetapkan peran: Pilih Storage Object Viewer
Klik Simpan.
Tabel pemetaan UDM
| Kolom Log | Pemetaan UDM | Logika |
|---|---|---|
| status, details, data.throughputLimit, data.throughput, data.totalThroughput, log_metadata.totalThroughput, data.averageDailyThroughput, data.throughputForecast, data.remainingThroughput, data.acceptedThroughput, data.licenseStartDate, data.licenseEndDate, data.average7DayThroughput, data.average30DayThroughput, data.requestedMessages, data.acceptedMessages, data.sentMessages, data.deliveredMessages, data.avgAcceptedMessageSize, data.blockedMessages, data.quarantinedMessages, data.rejectedMessages, data.requestedThroughput, data.totalMessages, data.undeliveredMessages | additional.fields | Label gabungan dari peta status sebagai nilai string, detail peta bertingkat sebagai kunci yang diratakan dengan nilai string, dan berbagai kolom data sebagai nilai string atau angka |
| desc, data.name | metadata.description | Nilai dari deskripsi jika tidak kosong, atau data.name |
| event_type | metadata.event_type | Disetel ke EMAIL_TRANSACTION jika user_present benar, atau GENERIC_EVENT |
| metadata.product_name | Tetapkan ke "PROOFPOINT SER" | |
| metadata.vendor_name | Tetapkan ke "PROOFPOINT" | |
| fromEnvelope | network.email.bounce_address | Nilai dari fromEnvelope jika cocok dengan pola email |
| fromHeader | network.email.from | Nilai dari fromHeader jika cocok dengan pola email |
| applicationName | principal.administrative_domain | Nilai disalin secara langsung |
| principal_host | principal.asset.hostname | Nilai disalin secara langsung |
| principal_host | principal.hostname | Nilai disalin secara langsung |
| principal_port | principal.port | Nilai dari principal_port dikonversi menjadi bilangan bulat |
| userId, data.relayUserId | principal.user.product_object_id | Nilai dari userId jika tidak kosong, atau data.relayUserId |
| applicationUserName | principal.user.user_display_name | Nilai disalin secara langsung |
| senderName | target.administrative_domain | Nilai disalin secara langsung |
| senderId | target.user.product_object_id | Nilai disalin secara langsung |
data.throughput" and "data.totalThroughput |
additional.fields |
Dipetakan dari log perubahan |
data.throughputLimit", "data.averageDailyThroughput", "data.throughputForecast", "data.remainingThroughput", "data.acceptedThroughput", "data.licenseStartDate", "data.licenseEndDate", "data.average7DayThroughput", "data.average30DayThroughput", "data.requestedMessages", "data.acceptedMessages", "data.sentMessages", "data.deliveredMessages", "data.avgAcceptedMessageSize", "data.blockedMessages", "data.quarantinedMessages", "data.rejectedMessages", "data.requestedThroughput", "data.totalMessages", and "data.undeliveredMessages |
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.