收集 Smartsheet 記錄

支援的國家/地區：

本文說明如何使用 Google Cloud Storage，將 Smartsheet 記錄擷取至 Google Security Operations。

Smartsheet 是協作式工作管理平台，可為企業團隊提供類似試算表的專案管理、工作追蹤和工作流程自動化功能。事件報告 API 提供稽核記錄，涵蓋 100 多種事件類型，包括使用者動作、資料存取、共用變更，以及 Smartsheet 機構的系統管理作業。

事前準備

請確認您已完成下列事前準備事項：

  • Google SecOps 執行個體
  • 已啟用 Cloud Storage API 的 GCP 專案
  • 建立及管理 GCS bucket 的權限
  • 管理 Google Cloud Storage 值區 IAM 政策的權限
  • 建立 Cloud Run 函式、Pub/Sub 主題和 Cloud Scheduler 工作的權限
  • 已啟用事件報表外掛程式的 Smartsheet Enterprise 方案
  • 具備 API 存取權的 Smartsheet 系統管理員帳戶

收集 Smartsheet API 憑證

產生 API 存取權杖

  1. 使用系統管理員帳戶登入 Smartsheet 帳戶。
  2. 在左側導覽列底部選取「帳戶」 (預設個人圖片)，然後前往「個人設定」。
  3. 前往「API 存取權」分頁標籤。
  4. 按一下「產生新的存取權杖」。
  5. 輸入權杖名稱 (例如 SecOps SIEM Integration)。
  6. 按一下 [確定]。

  7. 複製並妥善儲存存取權杖。

驗證權限

如要確認帳戶是否具備必要權限，請按照下列步驟操作：

  1. 登入 Smartsheet 帳戶。
  2. 依序前往「帳戶」(個人資料圖片) >「個人設定」>「API 存取權」。
  3. 如果可以查看「管理 API 存取權杖」頁面並產生權杖，表示您具備必要權限。
  4. 如果無法存取這些選項，請與 Smartsheet 系統管理員聯絡，要求授予 API 存取權。

測試 API 存取權

  • 請先測試憑證，再繼續進行整合：

    # Replace with your actual access token
SMARTSHEET_TOKEN="<your-access-token>"

# Test Event Reporting API access
curl -v -H "Authorization: Bearer ${SMARTSHEET_TOKEN}" \
  "https://api.smartsheet.com/2.0/events?since=$(date -u -d '1 hour ago' +%Y-%m-%dT%H:%M:%SZ)&maxCount=10"

如果看到這些錯誤訊息：

  • HTTP 401：確認存取權杖是否正確。
  • HTTP 403：確認帳戶具備系統管理員權限，且方案已啟用「事件報表」外掛程式。

建立 Google Cloud Storage bucket

  1. 前往 Google Cloud 控制台。
  2. 選取專案或建立新專案。
  3. 在導覽選單中，依序前往「Cloud Storage」>「Bucket」。
  4. 按一下「建立值區」。

  5. 請提供下列設定詳細資料：

    設定 值
    為 bucket 命名 輸入全域不重複的名稱 (例如 smartsheet-audit-logs)
    位置類型 根據需求選擇 (區域、雙區域、多區域)
    位置 選取位置 (例如 us-central1)
    儲存空間級別 標準 (建議用於經常存取的記錄)
    存取控管 統一 (建議)
    保護工具 選用：啟用物件版本管理或資料保留政策

  6. 點選「建立」。

為 Cloud Run 函式建立服務帳戶

Cloud Run 函式需要具備 GCS bucket 寫入權限，且可由 Pub/Sub 叫用的服務帳戶。

建立服務帳戶

  1. 在 GCP 控制台中，依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
  2. 按一下「Create Service Account」(建立服務帳戶)。
  3. 請提供下列設定詳細資料：
    • 服務帳戶名稱：輸入 smartsheet-logs-sa。
    • 服務帳戶說明：輸入 Service account for Cloud Run function to collect Smartsheet audit logs。
  4. 按一下「建立並繼續」。
  5. 在「將專案存取權授予這個服務帳戶」部分，新增下列角色：
    1. 按一下「選擇角色」。
    2. 搜尋並選取「Storage 物件管理員」。
    3. 點選「+ 新增其他角色」。
    4. 搜尋並選取「Cloud Run Invoker」。
    5. 點選「+ 新增其他角色」。
    6. 搜尋並選取「Cloud Functions Invoker」(Cloud Functions 叫用者)。
  6. 按一下「繼續」。
  7. 按一下 [完成]。

這些角色適用於：

  • Storage 物件管理員：將記錄檔寫入 GCS bucket，並管理狀態檔案
  • Cloud Run 叫用者：允許 Pub/Sub 叫用函式
  • Cloud Functions 叫用者：允許函式叫用

授予 GCS 值區的 IAM 權限

將 GCS bucket 的寫入權限授予服務帳戶：

  1. 依序前往「Cloud Storage」>「Buckets」。
  2. 按一下 bucket 名稱 (例如 smartsheet-audit-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」。
  5. 請提供下列設定詳細資料：
    • 新增主體：輸入服務帳戶電子郵件地址 (例如 smartsheet-logs-sa@PROJECT_ID.iam.gserviceaccount.com)。
    • 指派角色：選取「Storage 物件管理員」。
  6. 按一下 [儲存]。

建立 Pub/Sub 主題

建立 Pub/Sub 主題，Cloud Scheduler 會將訊息發布至該主題，而 Cloud Run 函式會訂閱該主題。

  1. 在 GCP Console 中，前往「Pub/Sub」>「Topics」(主題)。
  2. 按一下「建立主題」。
  3. 請提供下列設定詳細資料：
    • 主題 ID：輸入 smartsheet-logs-trigger。
    • 其他設定保留預設值。
  4. 點選「建立」。

建立 Cloud Run 函式來收集記錄

Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發，從 Smartsheet Event Reporting API 擷取記錄，並寫入 GCS。

  1. 前往 GCP Console 的「Cloud Run」。
  2. 按一下「Create service」(建立服務)。
  3. 選取「函式」 (使用內嵌編輯器建立函式)。

  4. 在「設定」部分，提供下列設定詳細資料：

    設定 值
    服務名稱 smartsheet-logs-to-gcs
    區域 選取與 GCS bucket 相符的區域 (例如 us-central1)
    執行階段 選取 Python 3.12 以上版本

  5. 在「Trigger (optional)」(觸發條件 (選用)) 專區：

    1. 按一下「+ 新增觸發條件」。
    2. 選取「Cloud Pub/Sub」。
    3. 在「Select a Cloud Pub/Sub topic」(選取 Cloud Pub/Sub 主題) 中，選擇 smartsheet-logs-trigger。
    4. 按一下 [儲存]。

  6. 在「Authentication」(驗證) 部分：

    1. 選取「需要驗證」。
    2. 檢查 Identity and Access Management (IAM)。

  7. 向下捲動並展開「容器」、「網路」和「安全性」。

  8. 前往「安全性」分頁：

    • 服務帳戶：選取 smartsheet-logs-sa。

  9. 前往「容器」分頁：

    1. 按一下「變數與密鑰」。
    2. 針對每個環境變數，按一下「+ 新增變數」：
    變數名稱 範例值
    GCS_BUCKET smartsheet-audit-logs
    GCS_PREFIX smartsheet/events/
    STATE_KEY smartsheet/events/state.json
    SMARTSHEET_TOKEN <your-smartsheet-access-token>
    MAX_COUNT 1000
    TIMEOUT 30

  10. 在「變數與密鑰」部分，向下捲動至「要求」：

    • 要求逾時：輸入 600 秒 (10 分鐘)。

  11. 前往「設定」分頁：

    • 在「資源」部分：
      • 記憶體：選取 512 MiB 以上。
      • CPU：選取 1。

  12. 在「修訂版本資源調度」部分：

    • 執行個體數量下限：輸入 0。
    • 「Maximum number of instances」(執行個體數量上限)：輸入 100 (或根據預期負載調整)。

  13. 點選「建立」。

  14. 等待服務建立完成 (1 到 2 分鐘)。

  15. 服務建立完成後，系統會自動開啟內嵌程式碼編輯器。

新增函式程式碼

  1. 在「函式進入點」中輸入 main。

  2. 在內嵌程式碼編輯器中建立兩個檔案：

    • 第一個檔案：main.py:

      import functions_framework
from google.cloud import storage
import json
import os
import urllib3
from datetime import datetime, timezone
import uuid
import gzip
import io

# 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', 'smartsheet/events/')
STATE_KEY = os.environ.get('STATE_KEY', 'smartsheet/events/state.json')
SMARTSHEET_TOKEN = os.environ.get('SMARTSHEET_TOKEN')
MAX_COUNT = int(os.environ.get('MAX_COUNT', '1000'))
TIMEOUT = int(os.environ.get('TIMEOUT', '30'))

EVENTS_URL = "https://api.smartsheet.com/2.0/events"

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch Smartsheet
  Event Reporting audit logs and write to GCS.

  Args:
    cloud_event: CloudEvent object containing Pub/Sub message
  """

  if not all([GCS_BUCKET, SMARTSHEET_TOKEN]):
    print('Error: Missing required environment variables')
    return

  try:
    bucket = storage_client.bucket(GCS_BUCKET)

    # Load state
    state = load_state(bucket, STATE_KEY)
    stream_position = state.get('stream_position')

    print(f'Fetching events from stream position: {stream_position or "latest"}')

    # Fetch events
    total_written = 0
    has_more = True

    while has_more:
      events, new_position, more = fetch_events(stream_position)

      if events:
        write_chunk(bucket, events, datetime.now(timezone.utc))
        total_written += len(events)

      if new_position:
        stream_position = new_position

      has_more = more and total_written < 50000

    # Save state
    state['stream_position'] = stream_position
    save_state(bucket, STATE_KEY, state)

    print(f'Successfully processed {total_written} events')

  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: {str(e)}')

  return {}

def save_state(bucket, key, state):
  """Save state to GCS."""
  try:
    state['updated_at'] = datetime.now(timezone.utc).isoformat()
    blob = bucket.blob(key)
    blob.upload_from_string(
      json.dumps(state),
      content_type='application/json'
    )
  except Exception as e:
    print(f'Warning: Could not save state: {str(e)}')

def write_chunk(bucket, items, ts):
  """Write log chunk to GCS as compressed NDJSON."""
  key = f"{GCS_PREFIX}{ts:%Y/%m/%d}/smartsheet-events-{uuid.uuid4()}.json.gz"

  buf = io.BytesIO()
  with gzip.GzipFile(fileobj=buf, mode='w') as gz:
    for rec in items:
      gz.write((json.dumps(rec) + '\n').encode('utf-8'))

  buf.seek(0)
  blob = bucket.blob(key)
  blob.upload_from_file(buf, content_type='application/gzip')

  print(f'Wrote {len(items)} events to {key}')
  return key

def fetch_events(stream_position):
  """
  Fetch events from Smartsheet Event Reporting API.

  The API uses a streaming model with streamPosition for pagination.
  On first call (no streamPosition), it returns the current position
  without events. Subsequent calls return events since the position.

  Returns:
    Tuple of (events list, new stream position, has more data)
  """
  headers = {
    'Authorization': f'Bearer {SMARTSHEET_TOKEN}',
    'Accept': 'application/json'
  }

  params = [f'maxCount={MAX_COUNT}']
  if stream_position:
    params.append(f'streamPosition={stream_position}')

  url = f"{EVENTS_URL}?{'&'.join(params)}"

  response = http.request(
    'GET',
    url,
    headers=headers,
    timeout=TIMEOUT
  )

  if response.status == 429:
    retry_after = int(response.headers.get('Retry-After', '60'))
    print(f'Rate limited (429). Retry-After: {retry_after}s')
    import time
    time.sleep(min(retry_after, 120))
    return fetch_events(stream_position)

  if response.status != 200:
    print(f'API request failed: {response.status}')
    response_text = response.data.decode('utf-8')
    print(f'Response body: {response_text}')
    raise Exception(f'Failed to fetch events: {response.status}')

  data = json.loads(response.data.decode('utf-8'))

  events = data.get('data', []) or []
  new_position = data.get('nextStreamPosition')
  more_available = data.get('moreEventsAvailable', False)

  if events:
    print(f'Retrieved {len(events)} events')

  return events, new_position, more_available

    • 第二個檔案：requirements.txt:

      functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

  3. 點選「部署」即可儲存並部署函式。

  4. 等待部署作業完成 (2 到 3 分鐘)。

建立 Cloud Scheduler 工作

Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題，觸發 Cloud Run 函式。

  1. 前往 GCP 主控台的「Cloud Scheduler」。
  2. 點選「建立工作」。

  3. 請提供下列設定詳細資料：

    設定 值
    名稱 smartsheet-logs-schedule-15min
    區域 選取與 Cloud Run 函式相同的區域
    頻率 */15 * * * * (每 15 分鐘)
    時區 選取時區 (建議使用世界標準時間)
    目標類型 Pub/Sub
    主題 選取「smartsheet-logs-trigger」
    郵件內文 {} (空白 JSON 物件)

  4. 點選「建立」。

排程頻率選項

根據記錄檔量和延遲時間要求選擇頻率：

頻率 Cron 運算式 用途
每 5 分鐘 */5 * * * * 大量、低延遲
每 15 分鐘 */15 * * * * 標準 (建議)
每小時 0 * * * * 音量過低
每 6 小時 0 */6 * * * 批次處理

測試整合項目

  1. 在 Cloud Scheduler 控制台中，找出您的工作 (例如 smartsheet-logs-schedule-15min)。
  2. 按一下「強制執行」即可手動觸發工作。
  3. 稍等幾秒鐘。
  4. 前往「Cloud Run」>「Services」。
  5. 按一下函式名稱 (smartsheet-logs-to-gcs)。
  6. 按一下 [Logs] (記錄) 分頁標籤。

  7. 確認函式是否已順利執行。請注意以下事項：

    Fetching events from stream position: <position>
Retrieved X events
Wrote X events to smartsheet/events/YYYY/MM/DD/smartsheet-events-UUID.json.gz
Successfully processed X events

  8. 依序前往「Cloud Storage」>「Buckets」。

  9. 按一下 bucket 名稱 (smartsheet-audit-logs)。

  10. 前往前置字元資料夾 (smartsheet/events/)。

  11. 確認是否已建立新的 .json.gz 檔案，且檔案名稱包含目前的時間戳記。

如果記錄中顯示錯誤：

  • HTTP 401：檢查環境變數中的 Smartsheet 存取權杖
  • HTTP 403：確認帳戶具備系統管理員權限，且已啟用事件報表功能
  • HTTP 429：頻率限制 - 函式會自動重試並延遲
  • 缺少環境變數：檢查 Cloud Run 函式設定中是否已設定所有必要變數

擷取 Google SecOps 服務帳戶

Google SecOps 會使用專屬服務帳戶，從 GCS bucket 讀取資料。您必須授予這個服務帳戶值區存取權。

在 Google SecOps 中設定動態饋給，擷取 Smartsheet 記錄

  1. 依序前往「SIEM 設定」>「動態饋給」。
  2. 按一下「新增動態消息」。
  3. 按一下「設定單一動態饋給」。
  4. 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如 Smartsheet Audit Logs)。
  5. 選取「Google Cloud Storage V2」做為「來源類型」。
  6. 選取「Smartsheet」做為「記錄類型」。

  7. 按一下「取得服務帳戶」，系統會顯示專屬服務帳戶電子郵件地址，例如：

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com

  8. 複製這個電子郵件地址，後續步驟會用到。

  9. 點選「下一步」。

  10. 指定下列輸入參數的值：

    • 儲存空間 bucket URL：輸入 GCS bucket URI，並加上前置路徑：
    gs://smartsheet-audit-logs/smartsheet/events/

    • 更改項目：

      • smartsheet-audit-logs：您的 GCS bucket 名稱。
      • smartsheet/events/：儲存記錄的路徑前置字元。
    • 來源刪除選項：根據偏好選取刪除選項：
      • 永不：移轉後一律不刪除任何檔案 (建議用於測試)。
      • 刪除已轉移的檔案：成功轉移檔案後刪除檔案。
      • 刪除已轉移的檔案和空白目錄：成功轉移後刪除檔案和空白目錄。
    • 檔案存在時間上限：納入在過去天數內修改的檔案。預設值為 180 天。
    • 資產命名空間：資產命名空間。
    • 擷取標籤：要套用至這個動態饋給事件的標籤。

  11. 點選「下一步」。

  12. 在「Finalize」(完成) 畫面中檢查新的動態饋給設定，然後按一下「Submit」(提交)。

將 IAM 權限授予 Google SecOps 服務帳戶

Google SecOps 服務帳戶需要 GCS bucket 的「Storage 物件檢視者」角色。

  1. 依序前往「Cloud Storage」>「Buckets」。
  2. 按一下 bucket 名稱 (例如 smartsheet-audit-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」。
  5. 請提供下列設定詳細資料：
    • 新增主體：貼上 Google SecOps 服務帳戶電子郵件地址。
    • 指派角色：選取「Storage 物件檢視者」。

  6. 按一下 [儲存]。

UDM 對應表

記錄欄位 UDM 對應 邏輯
accessLevel_label additional.fields 已合併
appName_label additional.fields 已合併
attachmentName_label additional.fields 已合併
cellLinkSourceSheetId_label additional.fields 已合併
dashboardName_label additional.fields 已合併
folderName_label additional.fields 已合併
formatType_label additional.fields 已合併
includeAttachments_label additional.fields 已合併
includeDiscussions_label additional.fields 已合併
mergeType_label additional.fields 已合併
rowCount_label additional.fields 已合併
rowsMoved_label additional.fields 已合併
sheetId_label additional.fields 已合併
sheetName_label additional.fields 已合併
sheetRowId_label additional.fields 已合併
sourceFolderId_label additional.fields 已合併
sourceObjectId_label additional.fields 已合併
sourceSheetId_label additional.fields 已合併
sourceType_label additional.fields 已合併
tokenDisplayValue_label additional.fields 已合併
tokenUserId_label additional.fields 已合併
userId_label additional.fields 已合併
workspaceId_label additional.fields 已合併
additionalDetails.accessScopes metadata.description 直接對應
additionalDetails_tokenExpirationTimestamp metadata.event_timestamp 剖析為 yyyy-MM-ddTHH:mm:ssZ
eventTimestamp metadata.event_timestamp 剖析為 yyyy-MM-ddTHH:mm:ssZ
has_principal metadata.event_type 已對應：true → USER_UNCATEGORIZED
accessTokenName metadata.product_log_id 直接對應
eventId metadata.product_log_id 直接對應
additionalDetails.appClientId principal.user.userid 直接對應
requestUserId principal.user.userid 直接對應
object_id security_result.about.labels 已合併
source_label security_result.about.labels 已合併
object_type security_result.about.resource.attribute.labels 已合併
action security_result.action_details 直接對應
userId target.user.userid 直接對應
不適用 metadata.event_type 常數：USER_UNCATEGORIZED

變更記錄

查看這個剖析器的變更記錄

還有其他問題嗎？向社群成員和 Google SecOps 專業人員尋求答案。