Mengumpulkan log Keamanan Keeper Enterprise
Dokumen ini menjelaskan cara menyerap log Keeper Enterprise Security ke Google Security Operations menggunakan Google Cloud Storage V2.
Keeper Enterprise Security adalah platform pengelolaan akses istimewa dan pengelola sandi tingkat perusahaan yang melindungi kredensial, rahasia, dan data sensitif. Layanan ini membuat log audit untuk akses brankas, perubahan sandi, peristiwa berbagi, dan tindakan administratif melalui Reporting and Alerts API.
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 Konsol Admin Keeper dengan izin administrator
- Paket Keeper Enterprise atau Business dengan Modul Pelaporan dan Pemberitahuan Lanjutan (ARAM) yang diaktifkan
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, keeper-audit-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.
Mengumpulkan kredensial Keeper Enterprise Security API
Buat kunci API
- Login ke Konsol Admin Keeper.
- Buka Admin > Pelaporan & Pemberitahuan.
- Klik Kunci API atau buka bagian pengelolaan kunci API.
- Klik Create API Key.
- Masukkan nama untuk kunci API (misalnya,
Google Security Operations Integration). - Salin dan simpan detail berikut di lokasi yang aman:
- Kunci API: Nilai kunci API yang dibuat
- Private Key: Download file kunci pribadi (digunakan untuk pembuatan token)
Catat ID Enterprise Keeper Enterprise Anda dari Konsol Admin.
Menentukan URL dasar API
URL dasar Keeper API bergantung pada wilayah pusat data Anda:
Wilayah URL Dasar API AS https://keepersecurity.comUni Eropa https://keepersecurity.euAU https://keepersecurity.com.auCA https://keepersecurity.caJP https://keepersecurity.jpUS GovCloud https://govcloud.keepersecurity.us
Verifikasi izin
Untuk memverifikasi bahwa akun memiliki izin yang diperlukan:
- Login ke Konsol Admin Keeper.
- Buka Admin > Pelaporan & Pemberitahuan.
- Jika Anda dapat melihat dasbor Pelaporan & Pemberitahuan dan bagian Kunci API, berarti Anda memiliki izin yang diperlukan.
- Jika Anda tidak dapat melihat opsi ini, hubungi administrator Keeper Anda untuk mengaktifkan modul ARAM dan memberikan akses administrator.
Menguji akses API
Uji kredensial Anda sebelum melanjutkan integrasi:
# Replace with your actual credentials KEEPER_API_KEY="your-api-key" KEEPER_BASE="https://keepersecurity.com" # Test API access - get audit events (requires signed token) # Note: Keeper uses a signed JWT for authentication. # Refer to Keeper Commander CLI for testing: keeper audit-report --format json --limit 1
Buat akun layanan untuk fungsi Cloud Run
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
keeper-logs-collector-sa - Deskripsi akun layanan: Masukkan
Service account for Cloud Run function to collect Keeper Enterprise Security 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,
keeper-audit-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan prinsipal: Masukkan email akun layanan (misalnya,
keeper-logs-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
keeper-logs-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 dari Keeper Reporting and Alerts API dan menuliskannya ke GCS.
- Di GCP Console, 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 keeper-logs-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
keeper-logs-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
keeper-logs-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_BUCKETkeeper-audit-logsNama bucket GCS GCS_PREFIXkeeperAwalan untuk file log STATE_KEYkeeper/state.jsonJalur file status KEEPER_API_BASEhttps://keepersecurity.comURL dasar Keeper API KEEPER_API_KEYyour-api-keyKunci API Keeper KEEPER_PRIVATE_KEYbase64-encoded-private-keyKunci pribadi berenkode base64 KEEPER_ENTERPRISE_ID12345ID Perusahaan MAX_RECORDS5000Jumlah maksimum data per proses PAGE_SIZE1000Catatan per halaman LOOKBACK_HOURS24Periode 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:
- Jumlah minimum instance: Masukkan
0 - Maximum number of instances: Masukkan
100(atau sesuaikan berdasarkan perkiraan beban)
- Jumlah minimum instance: 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 import hashlib import hmac # 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', 'keeper') STATE_KEY = os.environ.get('STATE_KEY', 'keeper/state.json') KEEPER_API_BASE = os.environ.get('KEEPER_API_BASE', 'https://keepersecurity.com') KEEPER_API_KEY = os.environ.get('KEEPER_API_KEY') KEEPER_PRIVATE_KEY = os.environ.get('KEEPER_PRIVATE_KEY') KEEPER_ENTERPRISE_ID = os.environ.get('KEEPER_ENTERPRISE_ID') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '1000')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) def to_unix_millis(dt: datetime) -> int: """Convert datetime to Unix epoch milliseconds.""" if dt.tzinfo is None: dt = dt.replace(tzinfo=timezone.utc) dt = dt.astimezone(timezone.utc) return int(dt.timestamp() * 1000) 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) def get_auth_token(): """ Generate authentication token for Keeper Reporting API. Uses HMAC-SHA512 signing with the private key. """ api_base = KEEPER_API_BASE.rstrip('/') token_url = f"{api_base}/api/rest/enterprise/auth/token" # Build token request timestamp = str(int(time.time())) message = f"{KEEPER_API_KEY}:{timestamp}" # Decode private key from base64 private_key_bytes = base64.b64decode(KEEPER_PRIVATE_KEY) # Sign with HMAC-SHA512 signature = hmac.new( private_key_bytes, message.encode('utf-8'), hashlib.sha512 ).digest() signature_b64 = base64.b64encode(signature).decode('utf-8') body = json.dumps({ 'api_key': KEEPER_API_KEY, 'timestamp': timestamp, 'signature': signature_b64, 'enterprise_id': KEEPER_ENTERPRISE_ID }) headers = { 'Content-Type': 'application/json', 'Accept': 'application/json' } backoff = 1.0 for attempt in range(3): response = http.request('POST', token_url, body=body, headers=headers) if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429) on token request. Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue if response.status != 200: raise RuntimeError(f"Failed to get auth token: {response.status} - {response.data.decode('utf-8')}") data = json.loads(response.data.decode('utf-8')) return data.get('token', data.get('access_token')) raise RuntimeError("Failed to get auth token after 3 retries") @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Keeper Enterprise Security audit logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, KEEPER_API_KEY, KEEPER_PRIVATE_KEY, KEEPER_ENTERPRISE_ID]): print('Error: Missing required environment variables') return try: 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"]) # Overlap by 2 minutes to catch any delayed events 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()}") # Get auth token token = get_auth_token() # Fetch logs records, newest_event_time = fetch_logs( token=token, 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_logs(token: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch audit event logs from Keeper Reporting and Alerts API with pagination and rate limiting. Args: token: Authentication token 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) """ api_base = KEEPER_API_BASE.rstrip('/') endpoint = f"{api_base}/api/rest/enterprise/audit-events" headers = { 'Authorization': f'Bearer {token}', 'Accept': 'application/json', 'Content-Type': 'application/json', 'User-Agent': 'GoogleSecOps-KeeperCollector/1.0' } records = [] newest_time = None page_num = 0 backoff = 1.0 # Convert to Unix epoch seconds for Keeper API start_epoch = int(start_time.timestamp()) end_epoch = int(end_time.timestamp()) cursor = None while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break # Build request body body = { 'start_time': start_epoch, 'end_time': end_epoch, 'limit': min(page_size, max_records - len(records)), 'enterprise_id': KEEPER_ENTERPRISE_ID } if cursor: body['cursor'] = cursor try: response = http.request( 'POST', endpoint, body=json.dumps(body), 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')) page_results = data.get('audit_events', data.get('events', [])) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} events") records.extend(page_results) # Track newest event time for event in page_results: try: event_ts = event.get('timestamp') or event.get('created') if event_ts: if isinstance(event_ts, (int, float)): event_dt = datetime.fromtimestamp(event_ts, tz=timezone.utc) event_time = event_dt.isoformat() else: event_time = str(event_ts) 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 cursor = data.get('cursor') or data.get('next_cursor') if not cursor: print("No more pages (no next cursor)") break except Exception as e: print(f"Error fetching logs: {e}") return [], None print(f"Retrieved {len(records)} total records 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 keeper-logs-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 keeper-logs-triggerIsi 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
keeper-logs-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 events Wrote X records to gs://keeper-audit-logs/keeper/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsBuka Cloud Storage > Buckets.
Klik nama bucket Anda (
keeper-audit-logs).Buka folder
keeper/.Pastikan file
.ndjsonbaru dibuat dengan stempel waktu saat ini.
Jika Anda melihat error dalam log:
- HTTP 401: Periksa kredensial API di variabel lingkungan
- HTTP 403: Verifikasi bahwa akun memiliki izin ARAM yang diperlukan di Konsol Admin Keeper
- HTTP 429: Pembatasan kecepatan - fungsi akan otomatis mencoba lagi dengan penundaan
- Variabel lingkungan tidak ada: Periksa apakah semua variabel yang diperlukan telah ditetapkan
Mengonfigurasi feed di Google SecOps untuk menyerap log Keeper Enterprise Security
- Buka Setelan SIEM > Feed.
- Klik Tambahkan Feed Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
Keeper Enterprise Security Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih Keeper Enterprise Security 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.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
URL bucket penyimpanan: Masukkan URI bucket GCS dengan jalur awalan:
gs://keeper-audit-logs/keeper/- Ganti:
keeper-audit-logs: Nama bucket GCS Anda.keeper: 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
Akun layanan Google SecOps memerlukan peran Storage Object Viewer di bucket GCS Anda.
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda.
- 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 |
|---|---|---|
| logData.channel | extensions.auth.type | Ditetapkan ke nilai huruf besar jika dalam ["SSO", "MACHINE", "VPN", "PHYSICAL", "TACACS"], jika tidak, "AUTHTYPE_UNSPECIFIED" |
| logData.timestamp | metadata.event_timestamp | Dikonversi menggunakan format ISO8601 |
| logData.audit_event, logData.remote_address | metadata.event_type | Ditetapkan ke "USER_LOGIN" jika audit_event cocok dengan "login" dan remote_address tidak kosong, atau "STATUS_UPDATE" jika remote_address tidak kosong, atau "GENERIC_EVENT" |
| logData.audit_event | metadata.product_event_type | Nilai disalin secara langsung |
| logData.enterprise_id | metadata.product_log_id | Dikonversi ke string |
| metadata.product_name | Ditetapkan ke "KEEPER" | |
| metadata.vendor_name | Ditetapkan ke "KEEPER" | |
| logData.client_version | network.http.parsed_user_agent | Nilai disalin secara langsung, lalu dikonversi ke parseduseragent |
| logData.client_version | network.http.user_agent | Nilai disalin secara langsung |
| logData.remote_address | principal.asset.ip | Nilai disalin secara langsung |
| logData.remote_address | principal.ip | Nilai disalin secara langsung |
| logData.category | security_result.category_details | Digabungkan dari sumber |
| logData.shared_folder_uid, logData.folder_uid | security_result.detection_fields | Digabungkan sebagai label dengan kunci "shared_folder_uid" dan "folder_uid" |
| logData.email | target.user.email_addresses | Digabungkan dari sumber |
| logData.username | target.user.userid | Nilai disalin secara langsung |
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.