收集 Citrix Analytics 日志

解析器版本：1.0

支持的平台：

本文档介绍了如何使用 Google Cloud Storage 将 Citrix Analytics 日志注入到 Google Security Operations。Citrix Analytics for Performance (Cloud Software Group) 提供 Citrix Virtual Apps and Desktops 环境的汇总性能数据，让您能够通过 OData API 获取会话、机器和用户数据。Citrix Analytics for Security 提供风险洞见和数据源事件，可通过基于 Kafka 的 SIEM 集成导出这些信息。

准备工作

请确保满足以下前提条件：

  • Google SecOps 实例
  • 已启用 Cloud Storage API 的 GCP 项目
  • 创建和管理 GCS 存储分区的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 对 Citrix Analytics for Performance 租户的特权访问权限
  • Citrix Cloud API 凭据（客户端 ID、客户端密钥、客户 ID）

收集 Citrix Analytics API 凭据

获取 Citrix Cloud API 凭据

  1. 登录 Citrix Cloud Console。
  2. 点击屏幕左上角的菜单图标。
  3. 从菜单中选择 Identity and Access Management。
  4. 选择 API 访问权限标签页。
  5. 点击创建客户端。
  6. 复制以下详细信息并将其保存在安全的位置：
    • 客户端 ID (Client ID)
    • 客户端密钥 (Client Secret)
    • 客户 ID（位于 Citrix Cloud 网址或 IAM 页面中）

确定 API 基准网址

OData API 基准网址取决于您的 Citrix Cloud 区域：

区域 API 基本网址
美国 https://api.cloud.com/casodata
欧盟 https://api.eu.cloud.com/casodata
亚太南部 https://api.ap-s.cloud.com/casodata

验证权限

如需验证账号是否具有所需权限，请执行以下操作：

  1. 登录 Citrix Cloud。
  2. 前往 Identity and Access Management > 管理员。
  3. 验证用于创建 API 凭据的账号是否具有完全访问权限或自定义访问权限，并且已启用 Citrix Analytics for Performance 权限。
  4. 如果您看不到所需的权限，请与 Citrix Cloud 管理员联系以获取访问权限。

测试 API 访问权限

  • 在继续进行集成之前，请先测试您的凭据：

    CITRIX_CUSTOMER_ID="your-customer-id"
CITRIX_CLIENT_ID="your-client-id"
CITRIX_CLIENT_SECRET="your-client-secret"

# Get bearer token
TOKEN=$(curl -s -X POST \
  "https://api.cloud.com/cctrustoauth2/${CITRIX_CUSTOMER_ID}/tokens/clients" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=${CITRIX_CLIENT_ID}&client_secret=${CITRIX_CLIENT_SECRET}" \
  | python3 -c "import sys,json; print(json.load(sys.stdin)['access_token'])")

# Test OData API access
curl -v -H "Authorization: CwsAuth bearer=${TOKEN}" \
  -H "Citrix-CustomerId: ${CITRIX_CUSTOMER_ID}" \
  -H "Accept: application/json" \
  "https://api.cloud.com/casodata/sessions?\$top=1"

创建 Google Cloud Storage 存储桶

  1. 前往 Google Cloud 控制台。
  2. 选择您的项目或创建新项目。
  3. 在导航菜单中，依次前往 Cloud Storage > 存储分区。
  4. 点击创建存储分区。

  5. 提供以下配置详细信息：

    设置 值
    为存储桶命名 输入一个全局唯一的名称（例如 citrix-analytics-logs）
    位置类型 根据您的需求进行选择（区域级、双区域、多区域）
    位置 选择营业地点（例如 us-central1）
    存储类别 标准（建议用于经常访问的日志）
    访问权限控制 均匀（推荐）
    保护工具 可选：启用对象版本控制或保留政策

  6. 点击创建。

为 Cloud Run 函数创建服务账号

Cloud Run 函数需要一个服务账号，该账号具有写入 GCS 存储桶的权限，并且可以由 Pub/Sub 调用。

创建服务账号

  1. 在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
  2. 点击创建服务账号。
  3. 提供以下配置详细信息：
    • 服务账号名称：输入 citrix-analytics-collector-sa
    • 服务账号说明：输入 Service account for Cloud Run function to collect Citrix Analytics logs
  4. 点击创建并继续。
  5. 在向此服务账号授予对项目的访问权限部分中，添加以下角色：
    1. 点击选择角色。
    2. 搜索并选择 Storage Object Admin。
    3. 点击 + 添加其他角色。
    4. 搜索并选择 Cloud Run Invoker。
    5. 点击 + 添加其他角色。
    6. 搜索并选择 Cloud Functions Invoker。
  6. 点击继续。
  7. 点击完成。

必须拥有这些角色，才能：

  • Storage Object Admin：将日志写入 GCS 存储桶并管理状态文件
  • Cloud Run Invoker：允许 Pub/Sub 调用函数
  • Cloud Functions Invoker：允许调用函数

授予对 GCS 存储桶的 IAM 权限

向服务账号授予对 GCS 存储桶的写入权限：

  1. 前往 Cloud Storage > 存储分区。
  2. 点击您的存储桶名称。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：输入服务账号电子邮件地址（例如 citrix-analytics-collector-sa@PROJECT_ID.iam.gserviceaccount.com）
    • 分配角色：选择 Storage Object Admin
  6. 点击保存。

创建 Pub/Sub 主题

创建一个 Pub/Sub 主题，Cloud Scheduler 将向该主题发布消息，而 Cloud Run 函数将订阅该主题。

  1. 在 GCP 控制台中，前往 Pub/Sub > 主题。
  2. 点击创建主题。
  3. 提供以下配置详细信息：
    • 主题 ID：输入 citrix-analytics-trigger
    • 将其他设置保留为默认值
  4. 点击创建。

创建 Cloud Run 函数以收集日志

Cloud Run 函数将由来自 Cloud Scheduler 的 Pub/Sub 消息触发，以从 Citrix Analytics OData API 中提取日志并将其写入 GCS。

  1. 在 GCP 控制台中，前往 Cloud Run。
  2. 点击创建服务。
  3. 选择函数（使用内嵌编辑器创建函数）。

  4. 在配置部分中，提供以下配置详细信息：

    设置 值
    Service 名称 citrix-analytics-collector
    区域 选择与您的 GCS 存储桶匹配的区域（例如 us-central1）
    运行时 选择 Python 3.12 或更高版本

  5. 在触发器（可选）部分中：

    1. 点击 + 添加触发器。
    2. 选择 Cloud Pub/Sub。
    3. 在选择 Cloud Pub/Sub 主题部分，选择主题 citrix-analytics-trigger。
    4. 点击保存。

  6. 在身份验证部分中：

    1. 选择需要进行身份验证。
    2. 检查 Identity and Access Management (IAM)。

  7. 向下滚动并展开容器、网络、安全性。

  8. 前往安全性标签页：

    • 服务账号：选择服务账号 citrix-analytics-collector-sa

  9. 前往容器标签页：

    1. 点击变量和密钥。
    2. 为每个环境变量点击+ 添加变量：
    变量名称 示例值 说明
    GCS_BUCKET citrix-analytics-logs GCS 存储桶名称
    GCS_PREFIX citrix_analytics 日志文件的前缀
    STATE_KEY citrix_analytics/state.json 状态文件路径
    CITRIX_CLIENT_ID your-client-id Citrix Cloud 客户端 ID
    CITRIX_CLIENT_SECRET your-client-secret Citrix Cloud 客户端密钥
    CITRIX_CUSTOMER_ID your-customer-id Citrix Cloud 客户 ID
    API_BASE https://api.cloud.com/casodata OData API 基本网址
    ENTITIES sessions,machines,users 要收集的实体类型
    TOP_N 1000 每页记录数
    LOOKBACK_MINUTES 75 初始回溯期

  10. 在变量和 Secret 部分中，向下滚动到请求：

    • 请求超时：输入 600 秒（10 分钟）

  11. 前往设置标签页：

    • 在资源部分中：
      • 内存：选择 512 MiB 或更高值
      • CPU：选择 1

  12. 在修订版本伸缩部分中：

    • 实例数下限：输入 0
    • 实例数上限：输入 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, timedelta, timezone
import urllib.parse
import time

# 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()

CITRIX_TOKEN_URL_TMPL = "https://api.cloud.com/cctrustoauth2/{customerid}/tokens/clients"
DEFAULT_API_BASE = "https://api.cloud.com/casodata"

@functions_framework.cloud_event
def main(cloud_event):
    """
    Cloud Run function triggered by Pub/Sub to fetch logs
    from Citrix Analytics OData API 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', 'citrix_analytics').strip('/')
    state_key = os.environ.get('STATE_KEY') or f"{prefix}/state.json"
    customer_id = os.environ.get('CITRIX_CUSTOMER_ID')
    client_id = os.environ.get('CITRIX_CLIENT_ID')
    client_secret = os.environ.get('CITRIX_CLIENT_SECRET')
    api_base = os.environ.get('API_BASE', DEFAULT_API_BASE)
    entities = [e.strip() for e in os.environ.get('ENTITIES', 'sessions,machines,users').split(',') if e.strip()]
    top_n = int(os.environ.get('TOP_N', '1000'))
    lookback_minutes = int(os.environ.get('LOOKBACK_MINUTES', '75'))

    if not all([bucket_name, customer_id, client_id, client_secret]):
        print('Error: Missing required environment variables')
        return

    try:
        # Get GCS bucket
        bucket = storage_client.bucket(bucket_name)

        # Determine target hour to collect
        now = datetime.now(timezone.utc)
        fallback_target = (now - timedelta(minutes=lookback_minutes)).replace(minute=0, second=0, microsecond=0)

        # Load state (last processed timestamp)
        state = load_state(bucket, state_key)
        last_processed_str = state.get('last_hour_utc')

        if last_processed_str:
            last_processed = datetime.fromisoformat(last_processed_str.replace('Z', '+00:00')).replace(tzinfo=None)
            target_hour = last_processed + timedelta(hours=1)
        else:
            target_hour = fallback_target

        print(f'Processing logs for hour: {target_hour.isoformat()}Z')

        # Get authentication token
        token = get_citrix_token(customer_id, client_id, client_secret)
        headers = {
            'Authorization': f'CwsAuth bearer={token}',
            'Citrix-CustomerId': customer_id,
            'Accept': 'application/json',
            'Content-Type': 'application/json',
        }

        total_records = 0

        # Process each entity type
        for entity in entities:
            records = []
            for row in fetch_odata_entity(entity, target_hour, top_n, headers, api_base):
                enriched_record = {
                    'citrix_entity': entity,
                    'citrix_hour_utc': target_hour.isoformat() + 'Z',
                    'collection_timestamp': datetime.now(timezone.utc).isoformat() + 'Z',
                    'raw': row
                }
                records.append(enriched_record)

                # Write in batches to avoid memory issues
                if len(records) >= 1000:
                    blob_name = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{datetime.now(timezone.utc).strftime('%Y%m%d%H%M%S%f')}.ndjson"
                    write_ndjson_to_gcs(bucket, blob_name, records)
                    total_records += len(records)
                    records = []

            # Write remaining records
            if records:
                blob_name = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{datetime.now(timezone.utc).strftime('%Y%m%d%H%M%S%f')}.ndjson"
                write_ndjson_to_gcs(bucket, blob_name, records)
                total_records += len(records)

        # Update state file
        save_state(bucket, state_key, {'last_hour_utc': target_hour.isoformat() + 'Z'})

        print(f'Successfully processed {total_records} records for hour {target_hour.isoformat()}Z')

    except Exception as e:
        print(f'Error processing logs: {str(e)}')
        raise

def get_citrix_token(customer_id, client_id, client_secret):
    """Get Citrix Cloud authentication token."""
    url = CITRIX_TOKEN_URL_TMPL.format(customerid=customer_id)
    payload = {
        'grant_type': 'client_credentials',
        'client_id': client_id,
        'client_secret': client_secret,
    }
    data = urllib.parse.urlencode(payload).encode('utf-8')

    response = http.request(
        'POST',
        url,
        body=data,
        headers={
            'Accept': 'application/json',
            'Content-Type': 'application/x-www-form-urlencoded',
        }
    )

    if response.status != 200:
        print(f'Token request failed with status {response.status}')
        print(f'Response: {response.data.decode("utf-8")}')
        raise Exception(f'Failed to get Citrix token: HTTP {response.status}')

    token_response = json.loads(response.data.decode('utf-8'))
    return token_response['access_token']

def fetch_odata_entity(entity, when_utc, top, headers, api_base):
    """Fetch data from Citrix Analytics OData API with pagination and rate limiting."""
    year = when_utc.year
    month = when_utc.month
    day = when_utc.day
    hour = when_utc.hour

    base_url = f"{api_base.rstrip('/')}/{entity}?year={year:04d}&month={month:02d}&day={day:02d}&hour={hour:02d}"
    skip = 0
    backoff = 1.0

    while True:
        url = f"{base_url}&$top={top}&$skip={skip}"

        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

        data = json.loads(response.data.decode('utf-8'))
        items = data.get('value', [])

        if not items:
            break

        for item in items:
            yield item

        if len(items) < top:
            break

        skip += top

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 write_ndjson_to_gcs(bucket, key, records):
    """Write records as NDJSON to GCS."""
    body_lines = []
    for record in records:
        json_line = json.dumps(record, separators=(',', ':'), ensure_ascii=False)
        body_lines.append(json_line)

    body = ('\n'.join(body_lines) + '\n').encode('utf-8')

    blob = bucket.blob(key)
    blob.upload_from_string(body, content_type='application/x-ndjson')

    • 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 Console 中，前往 Cloud Scheduler。
  2. 点击创建作业。

  3. 提供以下配置详细信息：

    设置 值
    名称 citrix-analytics-collector-hourly
    区域 选择与 Cloud Run 函数相同的区域
    频率 0 * * * *（每小时一次，整点时）
    时区 选择时区（建议选择 UTC）
    目标类型 Pub/Sub
    主题 选择主题 citrix-analytics-trigger
    消息正文 {}（空 JSON 对象）

  4. 点击创建。

时间表频率选项

根据日志量和延迟时间要求选择频次：

频率 Cron 表达式 使用场景
每小时 0 * * * * 标准（推荐）
每 2 小时 0 */2 * * * 调低音量
每 6 小时 0 */6 * * * 低成交量、批处理

测试集成

  1. 在 Cloud Scheduler 控制台中，找到您的作业。
  2. 点击强制运行以手动触发作业。
  3. 等待几秒钟。
  4. 前往 Cloud Run > 服务。
  5. 点击函数名称 citrix-analytics-collector。
  6. 点击日志标签页。

  7. 验证函数是否已成功执行。查找：

    Processing logs for hour: YYYY-MM-DDTHH:00:00Z
Successfully processed X records for hour YYYY-MM-DDTHH:00:00Z

  8. 前往 Cloud Storage > 存储分区。

  9. 点击您的存储桶名称。

  10. 前往前缀文件夹 citrix_analytics/。

  11. 验证是否已创建具有当前时间戳的新 .ndjson 文件。

如果您在日志中看到错误，请执行以下操作：

  • HTTP 401：检查环境变量中的 API 凭据
  • HTTP 403：验证账号是否在 Citrix Cloud 中拥有所需权限
  • HTTP 429：速率限制 - 函数将自动重试并进行退避
  • 缺少环境变量：检查是否已设置所有必需的变量

在 Google SecOps 中配置 Feed 以注入 Citrix Analytics 日志

  1. 依次前往 SIEM 设置 > Feed。
  2. 点击添加新 Feed。
  3. 点击配置单个 Feed。
  4. 在 Feed 名称字段中，输入 Feed 的名称（例如 Citrix Analytics logs）。
  5. 选择 Google Cloud Storage V2 作为来源类型。
  6. 选择 Citrix Analytics 作为日志类型。

  7. 点击获取服务账号。系统会显示一个唯一的服务账号电子邮件地址，例如：

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

  8. 复制此电子邮件地址，以便在下一步中使用。

  9. 点击下一步。

  10. 为以下输入参数指定值：

    • 存储桶网址：输入带有前缀路径的 GCS 存储桶 URI：

      gs://citrix-analytics-logs/citrix_analytics/
      • 替换：
        • citrix-analytics-logs：您的 GCS 存储桶名称。
        • citrix_analytics：存储日志的可选前缀/文件夹路径（留空表示根目录）。

    • 来源删除选项：根据您的偏好选择删除选项：

      • 永不：转移后永不删除任何文件（建议用于测试）。
      • 删除已转移的文件：在成功转移后删除文件。
      • 删除已转移的文件和空目录：成功转移后删除文件和空目录。

    • 文件存在时间上限：包含在过去指定天数内修改的文件（默认值为 180 天）

    • 资产命名空间：资产命名空间

    • 注入标签：要应用于此 Feed 中事件的标签

  11. 点击下一步。

  12. 在最终确定界面中查看新的 Feed 配置，然后点击提交。

向 Google SecOps 服务账号授予 IAM 权限

Google SecOps 服务账号需要您的 GCS 存储桶的 Storage Object Viewer 角色。

  1. 前往 Cloud Storage > 存储分区。
  2. 点击您的存储桶名称。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：粘贴 Google SecOps 服务账号电子邮件地址
    • 分配角色：选择 Storage Object Viewer

  6. 点击保存。

UDM 映射表

日志字段 UDM 映射 逻辑
occurrence_event_type extensions.auth.type 已映射：Session.Logon → AUTHTYPE_UNSPECIFIED，Session.End → AUTHTYPE_UNSPECIFIED
server_name intermediary.asset.hostname 直接映射
server_name intermediary.hostname 直接映射
event_type metadata.description 直接映射
timestamp metadata.event_timestamp 解析为 ISO8601
udm_event_type metadata.event_type 已映射："USER_LOGIN", "USER_LOGOUT" → GENERIC_EVENT
tenant_id metadata.product_deployment_id 直接映射
occurrence_event_type metadata.product_event_type 直接映射
event_id metadata.product_log_id 直接映射
product metadata.product_name 直接映射
product_version metadata.product_version 直接映射
ui_link metadata.url_back_to_product 直接映射
session_key network.session_id 直接映射
domain principal.administrative_domain 直接映射
device_id principal.asset.hostname 直接映射
client_ip principal.asset.ip 已合并
vulnerability principal.asset.vulnerabilities 已合并
device_id principal.hostname 直接映射
client_ip principal.ip 已合并
os_name principal.platform 映射值（总共 6 个，例如 (?i)windows → WINDOWS、(?i)windows → MAC、(?i)windows...
os_extra_info principal.platform_patch_level 直接映射
os_version principal.platform_version 直接映射
entity_id principal.user.email_addresses 已映射：^.+@.+$ → entity_id
entity_type principal.user.email_addresses 已映射：user → entity_id
session_user_name principal.user.user_display_name 直接映射
entity_id principal.user.userid 直接映射
session_user_name principal.user.userid 直接映射
alert_message security_result.action_details 直接映射
analytic security_result.analytics_metadata 已合并
category security_result.category 已合并
indicator_category security_result.category 已映射：Data exfiltration → category
indicator_name security_result.description 直接映射
label security_result.detection_fields 已合并
label security_result.outcomes 已合并
severity security_result.severity 直接映射
app_name target.application 直接映射
app_name target.process.file.names 已合并
printer_name target.resource.name 直接映射
entity_id target.user.email_addresses 已映射：^.+@.+$ → entity_id
entity_type target.user.email_addresses 已映射：user → entity_id
session_user_name target.user.user_display_name 直接映射
entity_id target.user.userid 直接映射
session_user_name target.user.userid 直接映射
不适用 extensions.auth.type 常量：AUTHTYPE_UNSPECIFIED
不适用 metadata.event_type 常量：GENERIC_EVENT
不适用 metadata.vendor_name 常量：CITRIX_ANALYTICS
不适用 principal.platform 常量：WINDOWS
不适用 security_result.confidence_score 常量：risk_probability
不适用 security_result.risk_score 常量：cur_riskscore

更新日志

查看相应解析器的更改日志

需要更多帮助？获得社区成员和 Google SecOps 专业人士的解答。