收集 Jamf Pro 情境記錄
本文說明如何使用 Cloud Storage 搭配 Cloud Run functions、Pub/Sub 和 Cloud Scheduler,將 Jamf Pro 情境記錄 (裝置和使用者情境) 擷取至 Google Security Operations。Jamf Pro 是 Apple 裝置的全方位管理解決方案,提供裝置清查、使用者情境和設定管理功能。
事前準備
請確認您符合下列必要條件:
- Google SecOps 執行個體
- 已啟用 Cloud Storage API 的 Google Cloud 專案
- 建立及管理 Cloud Storage bucket 的權限
- 具備 Cloud Storage bucket 的 IAM 政策管理權限
- 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
- Jamf Pro 租戶的特殊存取權
設定 Jamf API 角色
- 登入 Jamf 網頁版 UI。
- 依序前往「Settings」>「System」部分 >「API Roles and Clients」。
- 選取「API Roles」分頁標籤。
- 點選「New」(新增)。
- 輸入 API 角色的顯示名稱 (例如
context_role)。 在「Jamf Pro API role privileges」中輸入權限名稱,然後從選單中選取:
- 電腦清單
- 行動裝置清單
按一下「儲存」。
設定 Jamf API 用戶端
- 在 Jamf Pro 中,依序前往「Settings」>「System」部分 >「API roles and clients」。
- 選取「API 用戶端」分頁標籤。
- 點選「New」(新增)。
- 輸入 API 用戶端的顯示名稱 (例如
context_client)。 - 在「API Roles」欄位中,新增先前建立的
context_role角色。 - 在「Access Token Lifetime」(存取權杖生命週期) 下方,輸入存取權杖的有效時間 (以秒為單位)。
- 按一下「儲存」。
- 按一下 [編輯]。
- 按一下「啟用 API 用戶端」。
- 按一下「儲存」。
設定 Jamf 用戶端密鑰
- 在 Jamf Pro 中,前往新建立的 API 用戶端。
- 按一下「產生用戶端密鑰」。
- 在確認畫面中,按一下「Create Secret」(建立密鑰)。
- 將下列參數儲存在安全的位置:
- 基準網址:
https://<your>.jamfcloud.com - 用戶端 ID:UUID。
- 用戶端密鑰:值只會顯示一次。
- 基準網址:
建立 Cloud Storage bucket
- 前往 Google Cloud 控制台。
- 選取專案或建立新專案。
- 在導覽選單中,依序前往「Cloud Storage」>「Bucket」。
- 按一下「建立值區」。
提供下列設定詳細資料:
設定 值 為 bucket 命名 輸入全域不重複的名稱 (例如 jamfpro)位置類型 請根據需求選擇 (單一區域、雙區域、多區域) 位置 選取位置 (例如 us-central1)儲存空間級別 標準 (建議用於經常存取的記錄) 存取控管 統一 (建議) 保護工具 選用:啟用物件版本管理或資料保留政策 點選「建立」。
建立 Cloud Run 函式的服務帳戶
Cloud Run 函式需要具備權限的服務帳戶,才能寫入 Cloud Storage bucket,並由 Pub/Sub 叫用。
建立服務帳戶
- 在控制台中,依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
- 按一下「Create Service Account」(建立服務帳戶)。
- 提供下列設定詳細資料:
- 服務帳戶名稱:輸入
jamf-pro-collector-sa。 - 「Service account description」(服務帳戶說明):輸入
Service account for Cloud Run function to collect Jamf Pro context logs。
- 服務帳戶名稱:輸入
- 按一下「建立並繼續」。
- 在「將專案存取權授予這個服務帳戶」部分,新增下列角色:
- 按一下「請選擇角色」。
- 搜尋並選取「Storage 物件管理員」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Run Invoker」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Functions 叫用者」。
- 按一下「繼續」。
- 按一下「完成」。
這些角色適用於:
- Storage 物件管理員:將記錄寫入 Cloud Storage bucket,並管理狀態檔案
- Cloud Run 叫用者:允許 Pub/Sub 叫用函式
- Cloud Functions 叫用者:允許叫用函式
授予 Cloud Storage bucket 的 IAM 權限
授予服務帳戶 Cloud Storage bucket 的寫入權限:
- 依序前往「Cloud Storage」>「Bucket」。
- 按一下 bucket 名稱。
- 前往「權限」分頁。
- 按一下「授予存取權」。
- 提供下列設定詳細資料:
- 新增主體:輸入服務帳戶電子郵件地址 (例如
jamf-pro-collector-sa@PROJECT_ID.iam.gserviceaccount.com)。 - 指派角色:選取「Storage 物件管理員」。
- 新增主體:輸入服務帳戶電子郵件地址 (例如
- 按一下「儲存」。
建立 Pub/Sub 主題
建立 Pub/Sub 主題,Cloud Scheduler 會發布至該主題,Cloud Run 函式則會訂閱該主題。
- 在控制台中,依序前往「Pub/Sub」>「Topics」(主題)。
- 按一下「建立主題」。
- 提供下列設定詳細資料:
- 主題 ID:輸入
jamf-pro-context-trigger。 - 其他設定保留預設值。
- 主題 ID:輸入
- 點選「建立」。
建立 Cloud Run 函式來收集記錄
Cloud Scheduler 傳送 Pub/Sub 訊息時,會觸發 Cloud Run 函式,從 Jamf Pro API 擷取記錄並寫入 Cloud Storage。
- 前往控制台的「Cloud Run」。
- 按一下「Create service」(建立服務)。
- 選取「函式」(使用直接修改建立函式)。
在「Configure」(設定) 部分,提供下列設定詳細資料:
設定 值 服務名稱 jamf-pro-context-collector區域 選取與 Cloud Storage bucket 相符的區域 (例如 us-central1)執行階段 選取「Python 3.12」或更新版本 在「Trigger (optional)」(觸發條件 (選用)) 部分:
- 按一下「+ 新增觸發條件」。
- 選取「Pub/Sub」。
- 在「Select a Pub/Sub topic」(選取 Pub/Sub 主題),選擇 Pub/Sub 主題 (
jamf-pro-context-trigger)。 - 按一下「儲存」。
在「Authentication」(驗證) 部分:
- 選取「需要驗證」。
- Identity and Access Management (IAM)。
向下捲動並展開「容器、網路、安全性」。
前往「安全性」分頁:
- 服務帳戶:選取服務帳戶 (
jamf-pro-collector-sa)。
- 服務帳戶:選取服務帳戶 (
前往「容器」分頁:
- 按一下「Variables & Secrets」(變數與密鑰)。
- 針對每個環境變數,按一下「+ 新增變數」:
變數名稱 範例值 GCS_BUCKETjamfproGCS_PREFIXjamf-pro/context/JAMF_CLIENT_ID輸入 Jamf 用戶端 ID JAMF_CLIENT_SECRET輸入 Jamf 用戶端密鑰 JAMF_BASE_URL輸入 Jamf 網址,並替換 https://<your>.jamfcloud.com中的<your>PAGE_SIZE200在「變數與密鑰」分頁中,向下捲動至「要求」:
- 要求逾時:輸入
600秒 (10 分鐘)。
- 要求逾時:輸入
前往「容器」的「設定」分頁:
- 在「Resources」(資源) 部分:
- 「記憶體」:選取「512 MiB」或以上。
- CPU:選取「1」。
- 按一下「完成」。
- 在「Resources」(資源) 部分:
向下捲動至「Execution environment」(執行環境):
- 選取「預設」(建議)。
在「Revision scaling」(修訂版本資源調度) 部分:
- 「Minimum number of instances」(執行個體數量下限):輸入
0。 - 「執行個體數量上限」:輸入
100(或依預期負載調整)。
- 「Minimum number of instances」(執行個體數量下限):輸入
點選「建立」。
等待服務建立完成 (1 至 2 分鐘)。
服務建立後,內嵌程式碼編輯器會自動開啟。
新增函式程式碼
- 在「函式進入點」中輸入 main
在內嵌程式碼編輯器中,建立兩個檔案:
- 第一個檔案:main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 from datetime import datetime, timezone import gzip import io import time # Initialize HTTP client http = urllib3.PoolManager() # Initialize Storage client storage_client = storage.Client() # Configuration BASE_URL = os.environ.get("JAMF_BASE_URL", "").rstrip("/") CLIENT_ID = os.environ.get("JAMF_CLIENT_ID") CLIENT_SECRET = os.environ.get("JAMF_CLIENT_SECRET") GCS_BUCKET = os.environ.get("GCS_BUCKET") GCS_PREFIX = os.environ.get("GCS_PREFIX", "jamf-pro/context/") PAGE_SIZE = int(os.environ.get("PAGE_SIZE", "200")) SECTIONS = [ "GENERAL", "HARDWARE", "OPERATING_SYSTEM", "USER_AND_LOCATION", "DISK_ENCRYPTION", "SECURITY", "EXTENSION_ATTRIBUTES", "APPLICATIONS", "CONFIGURATION_PROFILES", "LOCAL_USER_ACCOUNTS", "CERTIFICATES", "SERVICES", "PRINTERS", "SOFTWARE_UPDATES", "GROUP_MEMBERSHIPS", "CONTENT_CACHING", "STORAGE", "FONTS", "PACKAGE_RECEIPTS", "PLUGINS", "ATTACHMENTS", "LICENSED_SOFTWARE", "IBEACONS", "PURCHASING" ] # Cached access token, refreshed shortly before it expires _token_cache = {"value": None, "expires_at": 0.0} def get_token(): """OAuth2 client credentials > access_token""" url = f"{BASE_URL}/api/oauth/token" fields = { "grant_type": "client_credentials", "client_id": CLIENT_ID, "client_secret": CLIENT_SECRET } # encode_multipart=False is required. It sends a real # application/x-www-form-urlencoded body, which is what the Jamf token # endpoint expects. Without it, urllib3 sends a multipart/form-data body # and Jamf cannot read grant_type, client_id and client_secret. response = http.request( 'POST', url, fields=fields, encode_multipart=False, timeout=30.0 ) if response.status != 200: raise Exception(f"Failed to get token: {response.status} {response.data.decode('utf-8')}") data = json.loads(response.data.decode('utf-8')) return data["access_token"], int(data.get("expires_in", 1200)) def get_valid_token(): """Return a cached token, refreshing it before it expires.""" now = time.time() if _token_cache["value"] and now < _token_cache["expires_at"] - 60: return _token_cache["value"] token, ttl = get_token() _token_cache["value"] = token _token_cache["expires_at"] = now + ttl return token def fetch_page(token, page): """GET /api/v1/computers-inventory with sections & pagination""" url = f"{BASE_URL}/api/v1/computers-inventory" # Build query parameters params = [("page", str(page)), ("page-size", str(PAGE_SIZE))] params.extend([("section", s) for s in SECTIONS]) # Encode parameters query_string = "&".join([f"{k}={v}" for k, v in params]) full_url = f"{url}?{query_string}" headers = { "Authorization": f"Bearer {token}", "Accept": "application/json" } response = http.request( 'GET', full_url, headers=headers, timeout=60.0 ) if response.status != 200: raise Exception(f"Failed to fetch page {page}: {response.status} {response.data.decode('utf-8')}") return json.loads(response.data.decode('utf-8')) def write_ndjson_gz(objs, when): buf = io.BytesIO() with gzip.GzipFile(filename="-", mode="wb", fileobj=buf, mtime=int(time.time())) as gz: for obj in objs: line = json.dumps(obj, separators=(",", ":")) + "\n" gz.write(line.encode("utf-8")) buf.seek(0) prefix = GCS_PREFIX.strip("/") + "/" if GCS_PREFIX else "" key = f"{prefix}{when:%Y/%m/%d}/jamf_pro_context_{int(when.timestamp())}.ndjson.gz" bucket = storage_client.bucket(GCS_BUCKET) blob = bucket.blob(key) blob.upload_from_file(buf, content_type="application/gzip") return key @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Jamf Pro context logs and write to Cloud Storage. Each computer is written exactly as Jamf returns it: the inventory sections (general, hardware, operatingSystem, userAndLocation, and so on) are top-level keys on the record. The default parser reads this shape directly, so the records are not reshaped here. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([BASE_URL, CLIENT_ID, CLIENT_SECRET, GCS_BUCKET]): print("Error: Missing required environment variables") return try: page = 0 total = 0 batch = [] now = datetime.now(timezone.utc) while True: payload = fetch_page(get_valid_token(), page) results = payload.get("results") or [] if not results: break # Write the Jamf records as returned; do not rename or nest fields. batch.extend(results) total += len(results) if len(batch) >= 5000: key = write_ndjson_gz(batch, now) print(f"Wrote {len(batch)} records to gs://{GCS_BUCKET}/{key}") batch = [] if len(results) < PAGE_SIZE: break page += 1 if batch: key = write_ndjson_gz(batch, now) print(f"Wrote {len(batch)} records to gs://{GCS_BUCKET}/{key}") print(f"Successfully processed {total} total records") except Exception as e: print(f"Error processing Jamf Pro context logs: {str(e)}") raise- 第二個檔案:requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0按一下「部署」,即可儲存並部署函式。
等待部署作業完成 (2 至 3 分鐘)。
建立 Cloud Scheduler 工作
Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題,觸發 Cloud Run 函式。
- 在控制台中,前往「Cloud Scheduler」。
- 點選「建立工作」。
提供下列設定詳細資料:
設定 值 名稱 jamfpro-context-schedule-1h區域 選取與 Cloud Run 函式相同的區域 頻率 0 * * * *(每小時整點)時區 選取時區 (建議選取世界標準時間) 目標類型 Pub/Sub 主題 選取 Pub/Sub 主題 ( jamf-pro-context-trigger)郵件內文 {}(空白 JSON 物件)點選「建立」。
測試排程器工作
- 在 Cloud Scheduler 控制台中找到您的工作。
- 按一下「強制執行」,手動觸發。
- 等待幾秒鐘,然後依序前往「Cloud Run」>「服務」>「jamf-pro-context-collector」>「記錄」。
- 確認函式是否執行成功。
- 查看 Cloud Storage bucket,確認記錄已寫入。
在 Google SecOps 設定動態饋給,擷取 Jamf Pro 情境記錄
- 依序前往「設定」>「資料管理」>「動態饋給」。如果使用的是 SIEM 專用平台,請依序前往「設定」>「動態饋給」。
- 按一下「新增動態饋給」。
- 按一下「設定單一動態饋給」。
- 在「Feed name」(動態饋給名稱) 欄位中,輸入動態饋給名稱 (例如
Jamf Pro Context logs)。 - 選取「Google Cloud Storage V2」做為「來源類型」。
- 選取「Jamf Pro context」做為「Log type」。
按一下「Get Service Account」。系統會顯示專屬服務帳戶電子郵件地址,例如:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com複製這個電子郵件地址。後續步驟會用到。
點選「下一步」。
指定下列輸入參數的值:
Storage bucket URL:輸入 Cloud Storage bucket URI,並加上前置字元路徑:
gs://jamfpro/jamf-pro/context/將
jamfpro替換為值區的實際名稱。
來源刪除選項:根據偏好選取刪除選項:
- Never:轉移後一律不刪除任何檔案 (建議用於測試)。
- 刪除已轉移的檔案:在成功轉移後刪除檔案。
- 刪除已轉移的檔案和空白目錄:成功轉移後,刪除檔案和空白目錄。
檔案存在時間上限:包含過去幾天內修改過的檔案。預設值為 180 天。
Asset namespace:資產命名空間。
擷取標籤:要套用至這個動態饋給事件的標籤。
- 點選「下一步」。
- 在「完成」畫面中檢查新的新聞動態消息設定,然後按一下「提交」。
將 IAM 權限授予 Google SecOps 服務帳戶
Google SecOps 服務帳戶必須具備 Cloud Storage bucket 的 Storage 物件檢視者角色。
- 依序前往「Cloud Storage」>「Bucket」。
- 按一下 bucket 名稱。
- 前往「權限」分頁。
- 按一下「授予存取權」。
- 提供下列設定詳細資料:
- 新增主體:貼上 Google SecOps 服務帳戶電子郵件地址。
- 指派角色:選取「Storage 物件檢視者」。
按一下「儲存」。
變更記錄
還有其他問題嗎?向社群成員和 Google SecOps 專家尋求解答。