此页面由 Cloud Translation API 翻译。

Google SecOps CLI 用户指南

支持的平台：

Google SecOps SIEM

Google Security Operations SDK 提供了一个全面的命令行界面 (CLI)，可让您轻松地通过终端与 Google SecOps 产品进行交互。新的 secops CLI 取代了旧版 chronicle_cli，具有增强的功能和改进的用户体验。

概览

secops CLI 可用于访问以下内容：

搜索和分析 UDM 事件
管理 Feed、转发器和解析器
创建和管理检测规则
处理提醒和支持请求
管理参考列表和数据表
将数据导出到 BigQuery 和 Google Cloud Storage
向 Gemini AI 查询安全分析洞见
以及更多功能

Google SecOps CLI 命令采用以下语法：

$ secops COMMAND [SUBCOMMAND] [OPTIONS]

例如，如需搜索活动，请执行以下操作：

$ secops search --query "metadata.event_type = \"NETWORK_CONNECTION\"" --time-window 24

准备工作

在安装 Google SecOps CLI 之前，请确保您已：

您的环境中已安装 Python 3.8 或更高版本。如需了解详情，请参阅安装 Python。
具有适当访问权限的 Google SecOps 实例。
身份验证凭据（服务账号或应用默认凭据）。

安装

安装包含 CLI 的 SecOps SDK：

pip install secops

验证安装：

$ secops --help

身份验证

该 CLI 支持多种身份验证方法：

使用应用默认凭证（推荐）

# Set up ADC with gcloud
gcloud auth application-default login

使用服务账号

将服务账号 JSON 文件放在安全的位置，并在命令中引用该文件：

$ secops search --service-account "/path/to/service-account.json" --customer-id "your-instance-id" --project-id "your-project-id" --query "metadata.event_type = \"USER_LOGIN\""

配置

保存常用设置，以避免在命令中重复输入：

保存配置

# Save instance and authentication settings
$ secops config set --customer-id "your-instance-id" --project-id "your-project-id" --region "us"

# Save service account path (optional)
$ secops config set --service-account "/path/to/service-account.json" --customer-id "your-instance-id" --project-id "your-project-id"

# Set default time window
$ secops config set --time-window 48

查看配置

$ secops config view

清除配置

$ secops config clear

区域

该 CLI 支持所有 Google SecOps 区域。您可以使用以下方式设置区域：

--region 标志与任何命令搭配使用
使用 secops config set --region REGION 的配置文件

支持的区域包括： * US（默认） * EUROPE * ASIA-SOUTHEAST1 * ASIA-SOUTH1 * AUSTRALIA-SOUTHEAST1 * EUROPE-WEST2、EUROPE-WEST3、EUROPE-WEST6、EUROPE-WEST9、EUROPE-WEST12 * 以及更多地区

核心命令

搜索活动

使用查询语法搜索 UDM 事件：

# Search with UDM query
$ secops search --query "metadata.event_type = \"NETWORK_CONNECTION\"" --time-window 24 --max-events 100

# Search using natural language
$ secops search --nl-query "show me failed login attempts" --time-window 24

# Export results as CSV
$ secops search --query "metadata.event_type = \"USER_LOGIN\" AND security_result.action = \"BLOCK\"" \
    --fields "metadata.event_timestamp,principal.user.userid,principal.ip" \
    --time-window 24 --csv

实体信息

获取有关 IP 地址、网域或文件哈希值的详细信息：

$ secops entity --value "8.8.8.8" --time-window 24
$ secops entity --value "example.com" --time-window 24
$ secops entity --value "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" --time-window 24

统计信息

对数据运行统计分析：

$ secops stats --query "metadata.event_type = \"NETWORK_CONNECTION\"
match:
  target.hostname
outcome:
  \$count = count(metadata.id)
order:
  \$count desc" --time-window 24

Feed 管理

在 Google SecOps 中管理数据注入 Feed：

列出 Feed

$ secops feed list

创建 Feed

# Create an HTTP feed
$ secops feed create \
    --display-name "My HTTP Feed" \
    --details '{"logType":"projects/your-project-id/locations/us/instances/your-instance-id/logTypes/WINEVTLOG","feedSourceType":"HTTP","httpSettings":{"uri":"https://example.com/feed","sourceType":"FILES"}}'

更新 Feed

$ secops feed update --id "feed-123" --display-name "Updated Feed Name"

启用/停用 Feed

$ secops feed enable --id "feed-123"
$ secops feed disable --id "feed-123"

删除 Feed

$ secops feed delete --id "feed-123"

解析器管理

解析器会将原始日志数据处理并标准化为 UDM 格式：

列出解析器

$ secops parser list
$ secops parser list --log-type "WINDOWS"

获取解析器详细信息

$ secops parser get --log-type "WINDOWS" --id "pa_12345"

创建解析器

# Create from file
$ secops parser create --log-type "CUSTOM_LOG" --parser-code-file "/path/to/parser.conf"

# Create from string
$ secops parser create --log-type "CUSTOM_LOG" --parser-code "filter { mutate { add_field => { \"test\" => \"value\" } } }"

测试解析器

在部署之前，针对示例日志测试解析器：

# Test with inline logs
$ secops parser run \
    --log-type OKTA \
    --parser-code-file "./parser.conf" \
    --log '{"message": "Test log 1"}' \
    --log '{"message": "Test log 2"}'

# Test with logs from file
$ secops parser run \
    --log-type WINDOWS \
    --parser-code-file "./parser.conf" \
    --logs-file "./sample_logs.txt"

激活/停用解析器

$ secops parser activate --log-type "WINDOWS" --id "pa_12345"
$ secops parser deactivate --log-type "WINDOWS" --id "pa_12345"

删除解析器

$ secops parser delete --log-type "WINDOWS" --id "pa_12345"

解析器扩展程序管理

解析器扩展功能可扩展现有解析器，而无需替换它们：

列出扩展程序

$ secops parser-extension list --log-type OKTA

创建扩展功能

$ secops parser-extension create --log-type OKTA \
    --log /path/to/sample.log \
    --parser-config-file /path/to/parser-config.conf

激活扩展程序

$ secops parser-extension activate --log-type OKTA --id "1234567890"

转发器管理

转发器用于以特定配置注入日志：

创建转发器

# Basic forwarder
$ secops forwarder create --display-name "my-custom-forwarder"

# With metadata and settings
$ secops forwarder create --display-name "prod-forwarder" \
    --metadata '{"environment":"prod","team":"security"}' \
    --upload-compression true \
    --http-settings '{"port":80,"host":"example.com"}'

列出转发器

$ secops forwarder list --page-size 100

获取转发器

$ secops forwarder get --id "1234567890"

更新转发器

$ secops forwarder update --id "1234567890" --display-name "updated-name"

删除转发器

$ secops forwarder delete --id "1234567890"

日志提取

将日志注入 Google SecOps：

提取原始日志

# From file
$ secops log ingest --type "OKTA" --file "/path/to/okta_logs.json"

# With labels
$ secops log ingest --type "WINDOWS" --file "/path/to/logs.xml" \
    --labels "environment=production,team=security"

# Inline message
$ secops log ingest --type "WINDOWS" --message "{\"event\": \"data\"}"

注入 UDM 事件

$ secops log ingest-udm --file "/path/to/udm_event.json"

列出日志类型

$ secops log types
$ secops log types --search "windows"

生成 UDM 映射

$ secops log generate-udm-mapping \
    --log-format "JSON" \
    --log '{"id":"123","user":"test_user","source_ip":"192.168.1.10"}'

规则管理

管理检测规则：

列出规则

$ secops rule list --page-size 50

创建规则

$ secops rule create --file "/path/to/rule.yaral"

更新规则

$ secops rule update --id "ru_12345" --file "/path/to/updated_rule.yaral"

启用/停用规则

$ secops rule enable --id "ru_12345" --enabled true
$ secops rule enable --id "ru_12345" --enabled false

测试规则

针对历史数据测试规则：

# Test for last 24 hours
$ secops rule test --file "/path/to/rule.yaral" --time-window 24

# Test with specific time range
$ secops rule test --file "/path/to/rule.yaral" \
    --start-time "2023-07-01T00:00:00Z" \
    --end-time "2023-07-02T00:00:00Z" \
    --max-results 1000

验证规则

$ secops rule validate --file "/path/to/rule.yaral"

删除规则

$ secops rule delete --id "ru_12345"

提醒管理

获取和管理提醒：

$ secops alert --time-window 24 --max-alerts 50
$ secops alert --snapshot-query "feedback_summary.status != \"CLOSED\"" --time-window 24

案例管理

检索支持请求详细信息：

$ secops case --ids "case-123,case-456"

数据表

数据表是结构化数据集合，可用于检测规则：

创建数据表

$ secops data-table create \
    --name "suspicious_ips" \
    --description "Known suspicious IP addresses" \
    --header '{"ip_address":"CIDR","description":"STRING","severity":"STRING"}'

添加行

$ secops data-table add-rows \
    --name "suspicious_ips" \
    --rows '[["192.168.1.100","Scanning activity","Medium"]]'

列出行

$ secops data-table list-rows --name "suspicious_ips"

删除数据表

$ secops data-table delete --name "suspicious_ips"

参考列表

参考列表是检测规则的简单值列表：

创建参考列表

$ secops reference-list create \
    --name "admin_accounts" \
    --description "Administrative accounts" \
    --entries "admin,administrator,root,superuser"

更新参考列表

$ secops reference-list update \
    --name "admin_accounts" \
    --entries "admin,administrator,root,superuser,sysadmin"

列出参考列表

$ secops reference-list list

数据导出

导出数据以供分析：

创建导出任务

# Export specific log type
$ secops export create \
    --gcs-bucket "projects/my-project/buckets/my-bucket" \
    --log-type "WINDOWS" \
    --time-window 24

# Export all logs
$ secops export create \
    --gcs-bucket "projects/my-project/buckets/my-bucket" \
    --all-logs \
    --time-window 168

查看导出状态

$ secops export status --id "export-123"

取消导出

$ secops export cancel --id "export-123"

列出可供导出的日志类型

$ secops export log-types --time-window 24

Gemini AI 集成

向 Gemini AI 查询安全分析洞见：

# Ask about security concepts
$ secops gemini --query "What is Windows event ID 4625?"

# Generate detection rules
$ secops gemini --query "Write a rule to detect PowerShell downloading files"

# Get vulnerability information
$ secops gemini --query "Tell me about CVE-2021-44228"

选择启用 Gemini：

$ secops gemini --opt-in

信息中心管理

管理原生信息中心：

创建信息中心

$ secops dashboard create \
    --display-name "Security Overview" \
    --description "Security monitoring dashboard" \
    --access-type PRIVATE

列出信息中心

$ secops dashboard list --page-size 10

更新信息中心

$ secops dashboard update --id dashboard-id \
    --display-name "Updated Security Dashboard" \
    --description "Updated security monitoring dashboard"

导出/导入信息中心

# Export
$ secops dashboard export --dashboard-names 'projects/your-project-id/locations/us/instances/your-instance-id/nativeDashboard/xxxxxxx'

# Import
$ secops dashboard import --dashboard-data-file dashboard_data.json

将图表添加到信息中心

$ secops dashboard add-chart --dashboard-id dashboard-id \
    --display-name "DNS Query Chart" \
    --description "Shows DNS query patterns" \
    --query-file dns_query.txt \
    --chart_layout '{"startX": 0, "spanX": 12, "startY": 0, "spanY": 8}'

删除信息中心

$ secops dashboard delete --id dashboard-id

高级示例

完成解析器工作流

检索、测试和部署解析器：

# List parsers
$ secops parser list --log-type "OKTA" > okta_parsers.json

# Get parser details
PARSER_ID=$(cat okta_parsers.json | jq -r '.[0].name' | awk -F'/' '{print $NF}')
$ secops parser get --log-type "OKTA" --id "$PARSER_ID" > parser_details.json

# Extract parser code
cat parser_details.json | jq -r '.cbn' | base64 -d > okta_parser.conf

# Test parser
$ secops parser run \
    --log-type "OKTA" \
    --parser-code-file "okta_parser.conf" \
    --logs-file "sample_logs.txt" > parser_result.json

# Activate if successful
$ secops parser activate --log-type "OKTA" --id "$PARSER_ID"

搜索和导出工作流

搜索活动并导出结果：

# Search for failed logins
$ secops search \
    --query "metadata.event_type = \"USER_LOGIN\" AND security_result.action = \"BLOCK\"" \
    --fields "metadata.event_timestamp,principal.user.userid,principal.ip" \
    --time-window 24 \
    --csv > failed_logins.csv

# Get entity details for suspicious IPs
cat failed_logins.csv | awk -F',' '{print $3}' | sort -u | while read ip; do
    secops entity --value "$ip" --time-window 72
done

规则测试和部署

创建、测试和部署检测规则：

# Create rule file
cat > suspicious_activity.yaral << 'EOF'
rule suspicious_powershell {
    meta:
        description = "Detects suspicious PowerShell activity"
        severity = "Medium"
    events:
        $e.metadata.event_type = "PROCESS_LAUNCH"
        $e.principal.process.file.full_path = /powershell\.exe/i nocase
        $e.principal.process.command_line = /download|invoke-expression|hidden/i nocase
    condition:
        $e
}
EOF

# Validate rule
$ secops rule validate --file suspicious_activity.yaral

# Test against historical data
$ secops rule test --file suspicious_activity.yaral --time-window 168

# Create and enable if tests pass
$ secops rule create --file suspicious_activity.yaral
$ secops rule enable --id "ru_generated_id" --enabled true

问题排查

常见问题

身份验证错误

如果您遇到身份验证错误，请执行以下操作：

验证您的凭据是否有效
检查您的服务账号是否具有必要的权限
确保 ADC 配置正确：gcloud auth application-default login

地区错误

如果您遇到与区域相关的错误，请执行以下操作：

验证区域是否受支持
检查实例是否位于指定区域
使用 --region 标志或在配置中设置该标志

速率限制

对于速率限制问题：

降低 API 调用频率
针对大型结果集使用分页
为重试实现指数退避算法

获取帮助

查看任何命令的相关帮助：

$ secops --help
$ secops search --help
$ secops rule create --help

从 chronicle_cli 迁移

如果您要从旧版 chronicle_cli 迁移，请参阅下表了解常见命令的对应关系：

chronicle_cli	SecOps
`chronicle_cli feeds create`	`secops feed create`
`chronicle_cli feeds list`	`secops feed list`
`chronicle_cli feeds update`	`secops feed update`
`chronicle_cli feeds delete`	`secops feed delete`
`chronicle_cli parsers list`	`secops parser list`
`chronicle_cli parsers create`	`secops parser create`
`chronicle_cli parsers activate`	`secops parser activate`
`chronicle_cli forwarders create`	`secops forwarder create`
`chronicle_cli forwarders list`	`secops forwarder list`

新的 secops CLI 提供了许多 chronicle_cli 中没有的其他功能，包括：

自然语言搜索
Gemini AI 集成
信息中心管理
规则测试和验证
数据表和参考列表
案例管理
以及更多功能