收集 Duo Telephony 日志

支持的平台:

本文档介绍了如何使用 Google Cloud Storage 将 Duo Telephony 日志提取到 Google Security Operations。解析器从日志中提取字段,并将其转换和映射到统一数据模型 (UDM)。它可处理各种 Duo 日志格式,转换时间戳,提取用户信息、网络详细信息和安全结果,最后将输出内容结构化为标准化的 UDM 格式。

准备工作

确保您满足以下前提条件:

  • Google SecOps 实例
  • 已启用 Cloud Storage API 的 GCP 项目
  • 创建和管理 GCS 存储分区的权限
  • 管理 GCS 存储分区的 IAM 政策的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 通过“所有者”角色对 Duo 管理面板进行特权访问

收集 Duo 前提条件(API 凭据)

  1. 以拥有“所有者”角色的管理员身份登录 Duo 管理控制台。
  2. 前往应用 > 应用目录
  3. 在目录中找到 Admin API 的条目。
  4. 点击 + 添加以创建应用。
  5. 复制以下详细信息并将其保存在安全的位置:
    • 集成密钥
    • 密钥
    • API 主机名(例如 api-yyyyyyyy.duosecurity.com
  6. 权限部分,仅选中读取电话权限复选框,并取消选择所有其他权限。
  7. 点击保存更改

验证权限

如需验证 Admin API 应用是否具有所需权限,请执行以下操作:

  1. 登录 Duo 管理面板。
  2. 前往应用 > 保护应用
  3. 找到您的 Admin API 应用。
  4. 点击应用名称可查看详情。
  5. 权限部分,验证是否仅选中了读取电话
  6. 如果选中了其他权限,或者未选中“读取电话状态”,请更新权限,然后点击保存更改

测试 API 访问权限

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

    # Replace with your actual credentials
    DUO_IKEY="your-integration-key"
    DUO_SKEY="your-secret-key"
    DUO_HOST="api-yyyyyyyy.duosecurity.com"
    
    # Test API access (requires signing - use Duo's API test tool or Python script)
    # Visit https://duo.com/docs/adminapi#testing to test your credentials
    

创建 Google Cloud Storage 存储分区

  1. 前往 Google Cloud 控制台
  2. 选择您的项目或创建新项目。
  3. 在导航菜单中,依次前往 Cloud Storage > 存储分区
  4. 点击创建存储分区
  5. 提供以下配置详细信息:

    设置
    为存储分区命名 输入一个全局唯一的名称(例如 duo-telephony-logs
    位置类型 根据您的需求进行选择(区域级、双区域级、多区域级)
    位置 选择相应位置(例如 us-central1
    存储类别 标准(建议用于经常访问的日志)
    访问权限控制 统一(推荐)
    保护工具 可选:启用对象版本控制或保留政策
  6. 点击创建

为 Cloud Run 函数创建服务账号

Cloud Run 函数需要一个服务账号,该账号具有向 GCS 存储分区写入内容以及被 Pub/Sub 调用的权限。

创建服务账号

  1. GCP 控制台中,依次前往 IAM 和管理 > 服务账号
  2. 点击创建服务账号
  3. 提供以下配置详细信息:
    • 服务账号名称:输入 duo-telephony-collector-sa
    • 服务账号说明:输入 Service account for Cloud Run function to collect Duo Telephony 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. 点击您的存储分区名称(例如 duo-telephony-logs)。
  3. 前往权限标签页。
  4. 点击授予访问权限
  5. 提供以下配置详细信息:
    • 添加主账号:输入服务账号电子邮件地址(例如 duo-telephony-collector-sa@PROJECT_ID.iam.gserviceaccount.com)。
    • 分配角色:选择 Storage Object Admin
  6. 点击保存

创建发布/订阅主题

创建一个 Pub/Sub 主题,供 Cloud Scheduler 发布消息,并供 Cloud Run 函数订阅。

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

创建 Cloud Run 函数以收集日志

Cloud Run 函数由来自 Cloud Scheduler 的 Pub/Sub 消息触发,用于从 Duo Telephony API 中提取日志并将其写入 GCS。

  1. GCP 控制台中,前往 Cloud Run
  2. 点击创建服务
  3. 选择函数(使用内嵌编辑器创建函数)。
  4. 配置部分中,提供以下配置详细信息:

    设置
    Service 名称 duo-telephony-logs-collector
    区域 选择与您的 GCS 存储分区匹配的区域(例如 us-central1
    运行时 选择 Python 3.12 或更高版本
  5. 触发器(可选)部分中:

    1. 点击 + 添加触发器
    2. 选择 Cloud Pub/Sub
    3. 选择 Cloud Pub/Sub 主题中,选择 Pub/Sub 主题 (duo-telephony-trigger)。
    4. 点击保存
  6. 身份验证部分中:

    1. 选择需要进行身份验证
    2. 检查 Identity and Access Management (IAM)
  7. 向下滚动并展开容器、网络、安全性

  8. 前往安全标签页:

    • 服务账号:选择服务账号 (duo-telephony-collector-sa)。
  9. 前往容器标签页:

    1. 点击变量和密钥
    2. 为每个环境变量点击 + 添加变量
    变量名称 示例值
    GCS_BUCKET duo-telephony-logs
    GCS_PREFIX duo-telephony
    STATE_KEY duo-telephony/state.json
    DUO_IKEY <your-integration-key>
    DUO_SKEY <your-secret-key>
    DUO_API_HOST api-yyyyyyyy.duosecurity.com
    MAX_ITERATIONS 10
  10. 变量和密钥标签页中,向下滚动到请求

    • 请求超时:输入 600 秒(10 分钟)。
  11. 前往容器中的设置标签页:

    • 资源部分中:
      • 内存:选择 512 MiB 或更高值。
      • CPU:选择 1
    • 点击完成
  12. 滚动到执行环境

    • 选择默认(推荐)。
  13. 修订版本扩缩部分中:

    • 实例数下限:输入 0
    • 实例数上限:输入 100(或根据预期负载进行调整)。
  14. 点击创建

  15. 等待服务创建完成(1-2 分钟)。

  16. 创建服务后,系统会自动打开内嵌代码编辑器

添加函数代码

  1. 入口点字段中输入 main
  2. 在内嵌代码编辑器中,创建两个文件:

    • 第一个文件:main.py:
    import functions_framework
    from google.cloud import storage
    import json
    import os
    import hmac
    import hashlib
    import base64
    import urllib.parse
    import urllib3
    import email.utils
    from datetime import datetime, timedelta, timezone
    from typing import Dict, Any, List, Optional
    
    # 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()
    
    @functions_framework.cloud_event
    def main(cloud_event):
        """
        Cloud Run function triggered by Pub/Sub to fetch Duo telephony logs 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', 'duo-telephony').rstrip('/')
        state_key = os.environ.get('STATE_KEY', 'duo-telephony/state.json')
        integration_key = os.environ.get('DUO_IKEY')
        secret_key = os.environ.get('DUO_SKEY')
        api_hostname = os.environ.get('DUO_API_HOST')
    
        if not all([bucket_name, integration_key, secret_key, api_hostname]):
            print('Error: Missing required environment variables')
            return
    
        try:
            # Get GCS bucket
            bucket = storage_client.bucket(bucket_name)
    
            # Load state
            state = load_state(bucket, state_key)
    
            # Calculate time range
            now = datetime.now(timezone.utc)
    
            if state.get('last_offset'):
                # Continue from last offset
                next_offset = state['last_offset']
                logs = []
                has_more = True
            else:
                # Start from last timestamp or 24 hours ago
                mintime = state.get('last_timestamp_ms', int((now - timedelta(hours=24)).timestamp() * 1000))
                # Apply 2-minute delay as recommended by Duo
                maxtime = int((now - timedelta(minutes=2)).timestamp() * 1000)
                next_offset = None
                logs = []
                has_more = True
    
            # Fetch logs with pagination
            total_fetched = 0
            max_iterations = int(os.environ.get('MAX_ITERATIONS', '10'))
    
            while has_more and total_fetched < max_iterations:
                page_num = total_fetched + 1
    
                if next_offset:
                    # Use offset for pagination
                    params = {
                        'limit': '100',
                        'next_offset': next_offset
                    }
                else:
                    # Initial request with time range
                    params = {
                        'mintime': str(mintime),
                        'maxtime': str(maxtime),
                        'limit': '100',
                        'sort': 'ts:asc'
                    }
    
                # Make API request with retry logic
                response = duo_api_call_with_retry(
                    'GET',
                    api_hostname,
                    '/admin/v2/logs/telephony',
                    params,
                    integration_key,
                    secret_key
                )
    
                if 'items' in response:
                    logs.extend(response['items'])
                    total_fetched += 1
    
                # Check for more data
                if 'metadata' in response and 'next_offset' in response['metadata']:
                    next_offset = response['metadata']['next_offset']
                    state['last_offset'] = next_offset
                else:
                    has_more = False
                    state['last_offset'] = None
    
                    # Update timestamp for next run
                    if logs:
                        # Get the latest timestamp from logs (ISO 8601 format)
                        latest_ts = max([log.get('ts', '') for log in logs])
                        if latest_ts:
                            # Convert ISO timestamp to milliseconds
                            dt = datetime.fromisoformat(latest_ts.replace('Z', '+00:00'))
                            state['last_timestamp_ms'] = int(dt.timestamp() * 1000) + 1
    
            # Save logs to GCS if any were fetched
            if logs:
                timestamp = datetime.now(timezone.utc).strftime('%Y%m%d_%H%M%S')
                blob_name = f"{prefix}/telephony_{timestamp}.json"
    
                # Format logs as newline-delimited JSON
                log_data = '\n'.join(json.dumps(log) for log in logs)
    
                blob = bucket.blob(blob_name)
                blob.upload_from_string(
                    log_data,
                    content_type='application/x-ndjson'
                )
    
                print(f"Saved {len(logs)} telephony logs to gs://{bucket_name}/{blob_name}")
            else:
                print("No new telephony logs found")
    
            # Save state
            save_state(bucket, state_key, state)
    
        except Exception as e:
            print(f'Error processing logs: {str(e)}')
            raise
    
    def duo_api_call_with_retry(
        method: str,
        host: str,
        path: str,
        params: Dict[str, str],
        ikey: str,
        skey: str,
        max_retries: int = 3
    ) -> Dict[str, Any]:
        """Make an authenticated API call to Duo Admin API with retry logic."""
        for attempt in range(max_retries):
            try:
                return duo_api_call(method, host, path, params, ikey, skey)
            except Exception as e:
                if '429' in str(e) or '5' in str(e)[:1]:
                    if attempt < max_retries - 1:
                        wait_time = (2 ** attempt) * 2
                        print(f"Retrying after {wait_time} seconds...")
                        import time
                        time.sleep(wait_time)
                        continue
                raise
    
    def duo_api_call(
        method: str,
        host: str,
        path: str,
        params: Dict[str, str],
        ikey: str,
        skey: str
    ) -> Dict[str, Any]:
        """Make an authenticated API call to Duo Admin API."""
        # Create canonical string for signing using RFC 2822 date format
        now = email.utils.formatdate()
        canon = [now, method.upper(), host.lower(), path]
    
        # Add parameters
        args = []
        for key in sorted(params.keys()):
            val = params[key]
            args.append(f"{urllib.parse.quote(key, '~')}={urllib.parse.quote(val, '~')}")
        canon.append('&'.join(args))
    
        canon_str = '\n'.join(canon)
    
        # Sign the request
        sig = hmac.new(
            skey.encode('utf-8'),
            canon_str.encode('utf-8'),
            hashlib.sha1
        ).hexdigest()
    
        # Create authorization header
        auth = base64.b64encode(f"{ikey}:{sig}".encode('utf-8')).decode('utf-8')
    
        # Build URL
        url = f"https://{host}{path}"
        if params:
            url += '?' + '&'.join(args)
    
        # Make request
        headers = {
            'Authorization': f'Basic {auth}',
            'Date': now,
            'Host': host,
            'User-Agent': 'duo-telephony-gcs-ingestor/1.0'
        }
    
        try:
            response = http.request('GET', url, headers=headers)
            data = json.loads(response.data.decode('utf-8'))
    
            if data.get('stat') == 'OK':
                return data.get('response', {})
            else:
                raise Exception(f"API error: {data.get('message', 'Unknown error')}")
        except urllib3.exceptions.HTTPError as e:
            raise Exception(f"HTTP error: {str(e)}")
    
    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),
                content_type='application/json'
            )
        except Exception as e:
            print(f'Warning: Could not save state: {str(e)}')
    
    • 第二个文件: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. 提供以下配置详细信息:

    设置
    名称 duo-telephony-logs-1h
    区域 选择与 Cloud Run 函数相同的区域
    频率 0 * * * *(每小时一次,在整点时)
    时区 选择时区(建议选择世界协调时间 [UTC])
    目标类型 Pub/Sub
    主题 选择 Pub/Sub 主题 (duo-telephony-trigger)
    消息正文 {}(空 JSON 对象)
  4. 点击创建

时间表频率选项

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

    频率 Cron 表达式 使用场景
    每隔 5 分钟 */5 * * * * 高容量、低延迟
    每隔 15 分钟 */15 * * * * 搜索量中等
    每小时 0 * * * * 标准(推荐)
    每 6 小时 0 */6 * * * 量小、批处理
    每天 0 0 * * * 历史数据收集

测试调度器作业

  1. Cloud Scheduler 控制台中,找到您的作业 (duo-telephony-logs-1h)。
  2. 点击强制运行以手动触发。
  3. 等待几秒钟,然后前往 Cloud Run > 服务
  4. 点击函数名称 (duo-telephony-logs-collector)。
  5. 点击日志标签页。
  6. 验证函数是否已成功执行。
  7. 前往 Cloud Storage > 存储分区
  8. 点击您的存储分区名称 (duo-telephony-logs)。
  9. 前往前缀文件夹 (duo-telephony/)。
  10. 验证是否已创建包含日志的新 .json 文件。

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

  • HTTP 401:检查环境变量中的 API 凭据(DUO_IKEY、DUO_SKEY、DUO_API_HOST)
  • HTTP 403:验证 Admin API 应用是否已启用读取电话权限
  • HTTP 429:速率限制 - 函数将自动重试,并采用指数退避算法
  • 缺少环境变量:检查是否已在 Cloud Run 函数配置中设置所有必需的变量

检索 Google SecOps 服务账号

Google SecOps 使用唯一的服务账号从您的 GCS 存储分区中读取数据。您必须授予此服务账号对您的存储分区的访问权限。

获取服务账号电子邮件地址

  1. 依次前往 SIEM 设置 > Feed
  2. 点击添加新 Feed
  3. 点击配置单个 Feed
  4. Feed 名称字段中,输入 Feed 的名称(例如 Duo Telephony logs)。
  5. 选择 Google Cloud Storage V2 作为来源类型
  6. 选择 Duo Telephony Logs 作为日志类型
  7. 点击获取服务账号。系统会显示一个唯一的服务账号电子邮件地址,例如:

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
    
  8. 复制此电子邮件地址,以便在下一步中使用。

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

Google SecOps 服务账号需要对您的 GCS 存储分区具有 Storage Object Viewer 角色。

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

在 Google SecOps 中配置 Feed 以注入 Duo 电话日志

  1. 依次前往 SIEM 设置 > Feed
  2. 点击添加新 Feed
  3. 点击配置单个 Feed
  4. Feed 名称字段中,输入 Feed 的名称(例如 Duo Telephony logs)。
  5. 选择 Google Cloud Storage V2 作为来源类型
  6. 选择 Duo Telephony Logs 作为日志类型
  7. 点击下一步
  8. 为以下输入参数指定值:

    • 存储分区网址:输入带有前缀路径的 GCS 存储分区 URI:

      gs://duo-telephony-logs/duo-telephony/
      
        • duo-telephony-logs:您的 GCS 存储分区名称。
        • duo-telephony:存储日志的可选前缀/文件夹路径(留空表示根目录)。
      • 示例

        • 根存储分区:gs://duo-telephony-logs/
        • 带前缀:gs://duo-telephony-logs/duo-telephony/
    • 来源删除选项:根据您的偏好选择删除选项:

      • 永不:永不删除转移后的任何文件(建议用于测试)。
      • 删除已转移的文件:在成功转移后删除文件。
      • 删除已转移的文件和空目录:在成功转移后删除文件和空目录。
    • 文件存在时间上限:包含在过去指定天数内修改的文件。默认值为 180 天。

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

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

  9. 点击下一步

  10. 最终确定界面中查看新的 Feed 配置,然后点击提交

UDM 映射表

日志字段 UDM 映射 逻辑
context metadata.product_event_type 直接从原始日志中的上下文字段映射。
赠金 security_result.detection_fields.value 直接从原始日志中的 credits 字段映射,嵌套在具有相应键 credits 的 detection_fields 对象下。
eventtype security_result.detection_fields.value 直接从原始日志中的 eventtype 字段映射,嵌套在具有相应键 eventtype 的 detection_fields 对象下。
主机 principal.hostname 如果不是 IP 地址,则直接从原始日志中的主机字段映射。
security_result.action 在解析器中设置为静态值“ALLOW”。
security_result.detection_fields.value 在解析器中设置为静态值“MECHANISM_UNSPECIFIED”。
metadata.event_timestamp 从原始日志中的 ts 字段解析而来,该字段是 ISO 8601 时间戳字符串。
metadata.event_type 如果原始日志中同时存在上下文字段和宿主字段,则设置为“USER_UNCATEGORIZED”。如果只有主持人,则设置为“STATUS_UPDATE”。否则,设置为“GENERIC_EVENT”。
metadata.log_type 直接从原始日志的 log_type 字段中获取。
metadata.product_name 在解析器中设置为静态值“Telephony”。
metadata.vendor_name 在解析器中设置为静态值“Duo”。
电话 principal.user.phone_numbers 直接从原始日志中的电话字段映射。
电话 principal.user.userid 直接从原始日志中的电话字段映射。
security_result.severity 在解析器中设置为静态值“INFORMATIONAL”。
security_result.summary 在解析器中设置为静态值“Duo Telephony”。
ts metadata.event_timestamp 从原始日志中的 ts 字段解析而来,该字段是 ISO 8601 时间戳字符串。
类型 security_result.summary 直接从原始日志中的类型字段映射。

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