GitSync

GitSync 是专为 Google SecOps 构建的集成,可将安全自动化资产和组件与外部 Git 代码库(例如 GitHub、GitLab 或 Bitbucket)同步。它有助于实现内容的双向同步,在整个安全运维生命周期内提供自动化版本控制、配置备份和跨环境升级。请注意,GitSync 旨在在相关环境(例如开发、预演和生产环境)之间备份和迁移资产,而不是在内部数据库标识符可能导致冲突的不相关系统之间分发资产。

使用场景

GitSync 集成支持以下主要应用场景:

  • 版本控制和可审核性(安全即代码):跟踪修改、查看 diff(差异比较),并维护 Playbook、连接器、集成和系统设置的完整版本记录。

  • 多环境提升(CI/CD 流水线):通过拉取请求和分支合并,系统地将 playbook、本体映射和集成设置从开发和预演环境提升到生产环境。

  • 备份和灾难恢复:直接从 Git 代码库恢复意外删除、损坏或配置错误的 playbook 和平台配置。

  • 跨环境标准化:从中央存储库向相关 Google SecOps 环境分发标准化 playbook、自定义可视化系列和连接器定义。

  • 分支和预演隔离:在专用环境中测试实验性 playbook 和功能分支,而不会影响生产工作流或时间表。

  • 离线审核和协作:将平台定义导出为 JSON 和 Markdown,以便在标准开发者工具中进行同行评审、自动验证和检查。

  • 可重复使用的工作流块:与完整 playbook 一起或单独同步模块化工作流块,以便团队共享常见自动化步骤。

按目标划分的实现工作流程

如需直接前往与您当前目标相符的指南,请选择您的工作流:

  • 新的 GitSync 部署或新分支:如果您是首次配置 GitSync 集成或创建新的代码库分支,请按照以下端到端设置顺序操作:

    1. 完成前提条件和凭证设置。
    2. 配置共享集成实例。
    3. 使用 Ping 操作测试网络连接和身份验证。
    4. 在运行任何拉取作业之前,请先运行初始推送内容作业以填充该分支。
    5. 配置和安排自动执行的同步作业。
  • 作业和代码库参考文档:

    • 如需查看配置参数并针对特定资产(playbook、连接器、集成等)运行独立的推送或拉取作业,请参阅作业。
    • 如需查看标准代码库布局,请参阅代码库目录结构。
  • 排查同步问题:如果操作或作业失败并出现错误,请参阅问题排查。

准备工作

在配置和执行 GitSync 操作之前,请验证您的集成版本、获取代码库访问权限,并完成以下设置任务:

  • 使用具有写入权限的私有 Git 代码库:确保您对托管在受支持的 Git 提供商(例如 GitHub、GitLab 或 Bitbucket)上的私有远程 Git 代码库具有写入权限。虽然默认情况下会排除 Password 类型的参数(除非启用了 Commit Passwords),但所有其他参数(例如应用 ID、客户端 ID、用户名和端点)都会以明文形式导出。切勿将公共代码库与 GitSync 搭配使用。

  • 初始化远程仓库:确认远程仓库至少有一个初始提交(例如 README.md 或 .gitignore 文件)。GitSync 无法同步到空代码库。

  • 准备 Git 身份验证凭证:生成具有代码库写入权限的身份验证凭证。GitSync 支持采用 base64 编码的 SSH 私钥(推荐)、个人访问令牌 (PAT) 以及基本用户名和密码凭据。

    如需生成和编码 SSH 密钥,请参阅为 GitSync 生成 SSH 密钥。

  • 验证网络连接和 VPC Service Controls:验证您的 Google SecOps 实例或远程运行程序是否具有通过 TCP 端口 443(用于 HTTPS)或 TCP 端口 22(用于 SSH)连接到 Git 提供商的出站防火墙访问权限。

    如果您的Google Cloud 环境使用 VPC Service Controls 服务边界,请与 Google Cloud 管理员合作配置入站和出站规则,以便响应集成可以与所需的 Google Cloud API 和外部端点通信。

  • 获取 Git 主机指纹(推荐):为防范中间人 (PITM) 攻击,请检索 Git 服务器的公钥指纹,以便进行主机指纹固定。

    如需了解配置步骤,请参阅启用主机指纹固定。

  • 授予 playbook 修改权限:如果您打算同步具有受限默认访问权限(例如默认权限设置为可以查看)的 playbook,请在运行同步作业之前,向 Administrator SOC 角色授予对源系统的可以修改权限。

    如需查看分步说明,请参阅配置 playbook 权限。

为 GitSync 生成 SSH 密钥

如需使用 SSH 密钥配置安全的无密码身份验证,请执行以下操作:

  1. 在终端中生成 RSA 或 Ed25519 密钥对。系统提示输入口令时,请按 Enter 键将其留空:

    ssh-keygen -b 2048 -t rsa -f ./id_rsa
    

    此命令会创建两个文件:id_rsa(私钥)和 id_rsa.pub(公钥)。

  2. 将公钥 (id_rsa.pub) 作为具有写入权限的部署密钥或访问密钥添加到远程 Git 托管服务。

  3. 将私钥转换为单行 base64 编码字符串:

    • Linux/macOS:

      base64 -w 0 ./id_rsa
      
    • Windows (PowerShell):

      [Convert]::ToBase64String([System.IO.File]::ReadAllBytes(".\id_rsa"))
      
  4. 复制生成的 base64 字符串,并在配置 GitSync 集成实例时将其粘贴到 Git 密码/令牌/SSH 密钥参数中。

启用主机指纹固定

主机指纹固定会在连接时验证 Git 服务器的身份,以防范中间人 (PITM) 攻击。虽然 Git 服务器指纹参数是可选的,但配置该参数可确保 GitSync 仅连接到经过验证的 Git 主机。

如需配置主机指纹固定,请执行以下操作:

  1. 检索主机指纹: 在终端中针对 Git 服务器主机名运行 ssh-keyscan:

    ssh-keyscan -t rsa <hostname>
    

    例如,对于 GitHub,请运行 ssh-keyscan -t rsa github.com。该命令会输出类似于以下内容的公共主机密钥行:

    github.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC...
    
  2. 保存指纹以供配置:复制主机公钥行。在配置 GitSync 集成实例(以将其应用于所有作业)或单个同步作业(以覆盖特定主机的设置)时,请在 Git 服务器指纹参数中输入此值。

配置 playbook 权限

同步具有受限权限(例如,默认权限设置为可以查看)的 playbook 时,请为 Administrator SOC 角色分配修改权限:

  1. 在 Google SecOps 中,前往 Playbook,然后选择目标 Playbook。
  2. 打开 playbook 权限设置。
  3. 将 Administrator SOC 角色添加到实体列表中,并将其权限设置为可以修改。

版本 53.0 回滚

GitSync 53.0 版引入了 Chronicle API 变更,并修改了 JSON 导出架构,导致同步失败。 为解决这些问题,GitSync 54.0 版还原了 53.0 版的更改,并恢复了稳定的 52.0 版代码库。

请完成以下步骤,以迁移到 52.0 版或 54.0 版,并恢复兼容的代码库分支:

  1. 暂停预定的同步作业:停用所有处于活动状态的预定 GitSync 作业(例如推送内容和拉取内容),以便在您切换版本和分支时作业不会运行。

  2. 切换到版本 54.0 或回滚到版本 52.0:在内容中心内,找到 GitSync 集成:

    • 如果 54.0 版可用,请将集成升级到 54.0 版。
    • 如果 54.0 版尚未显示(Content Hub 缓存大约每 8 小时同步一次),或者您希望直接降级,请将集成版本回滚到 52.0 版。
  3. 将 GitSync 指向您之前的代码库分支:使用版本 53.0 填充的代码库分支使用与版本 52.0 或 54.0 不兼容的其他 JSON 架构:

    • 如果您为 53.0 版创建了单独的分支(例如 gitsync-chronicle-api):请依次前往设置 > 集成 > GitSync,将分支参数改回原始分支(例如 main),然后运行 Ping 操作以验证连接。
    • 如果您在 53.0 版中覆盖了现有分支:请从 backup-legacy-pre-migration Git 标记(或 53.0 版之前的最后一次提交)恢复该分支,或者移除 53.0 版导出的目录(Playbooks/、Connectors/、Integrations/、Jobs/、Ontology/、SimulatedCases/ 和 Settings/),然后从 52.0 版或 54.0 版运行完整的推送内容作业,以重新填充该分支。
  4. 恢复预定作业:确认分支包含由 52.0 或 54.0 版导出的配置后,重新启用预定的 GitSync 作业。

配置集成

在 Google SecOps 中将 GitSync 集成配置为共享实例,以便所有平台组件和计划作业都可以访问代码库配置。

GitSync 集成参数

参数 说明
Repo URL

必填。

远程 Git 代码库网址。

使用 HTTPS 身份验证时,网址必须以 https:// 开头(例如 https://github.com/organization/secops-platform.git)。

使用 SSH 身份验证时,网址必须以 git@ 或 ssh:// 开头(例如 git@github.com:organization/secops-platform.git)。

Branch

必填。

要与之同步的 Git 代码库分支(例如 main)。

Git Password/Token/SSH Key

必填。

远程 Git 代码库的身份验证凭证。

此参数接受 Git 账号密码、个人访问令牌 (PAT) 或 base64 编码的 SSH 私钥(RSA 2048 位或 Ed25519)。

Git Username

可选。

Git 账号用户名。

通过 HTTPS 使用用户名和密码身份验证时,此字段为必填字段。

Git Server Fingerprint

可选。

远程 Git 服务器的 SSH 主机公钥(例如 github.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC...)。

配置此参数可启用主机指纹固定,确保 GitSync 仅连接到经过验证的 Git 主机,并降低中间人 (PITM) 风险。

如需检索此值,请参阅启用主机指纹固定。

Commit Author

可选。

附加到 GitSync 生成的出站 Git 提交的作者身份。

格式必须遵循标准 Git 作者身份:Name &lt;email@domain.com&gt;(默认为 GitSync &lt;gitsync@siemplify.co&gt;)。

Siemplify Verify SSL

必填。

如果选中,集成会验证 Google SecOps API 端点的 SSL 证书。

默认处于启用状态。

Git Verify SSL

必填。

如果选中,集成会验证远程 Git 提供商服务器的 SSL 证书。

默认处于启用状态。

SOAR Username

可选。

拥有 playbook 修改权限的账号的 Google SecOps 用户名。

如果默认 API 密钥因权限限制而失败,请提供此参数。

SOAR Password

可选。

与配置的 SOAR Username 对应的密码。

操作

如需详细了解操作,请参阅在工作桌中响应待处理的操作和在案例中运行手动操作。

Ping

使用 Ping 操作测试网络连接,并根据配置的 Git 代码库和分支验证身份验证凭证。

操作输入

无。

操作输出

Ping 操作提供以下输出:

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
案例墙表格 不可用
丰富化表 不可用
JSON 结果 不可用
输出消息 可用
脚本结果 可用
输出消息

Ping 操作可能会返回以下输出消息:

输出消息 消息说明
Successfully executed action "Ping". 操作成功,代码库连接性已验证。
Error executing action "Ping". Reason: ERROR_REASON 操作失败。请验证代码库网址、分支名称、凭据或网络路由。
脚本结果

下表列出了使用 Ping 操作时的脚本结果值:

脚本结果名称 值
is_success true 或 false

作业

GitSync 提供 16 种同步作业配置(2 个完整实例作业和 7 个独立作业对),用于管理平台资产。这些作业支持完整的实例级和有针对性的独立同步范围。

同步范围和支持的资产

该集成将同步作业分为两个不同的操作范围,以满足不同的管理和自动化需求:

  • 完整实例同步(Push Content 和 Pull Content):通过单次批量操作同步整个 Google SecOps 平台。

    这涵盖了三个功能领域的 21 个平台资产类别:

    • 系统和环境配置:环境、网域、动态参数、客户名单、网络、拒绝清单、案例标题设置、电子邮件模板和徽标。

    • 提醒和案例管理:案例标签、案例阶段、案例关闭原因、SLA 记录和模拟案例。

    • 安全自动化和集成:Playbook(包括可重复使用的工作流块)、集成、集成实例、连接器、计划作业、本体映射和可视化系列。

  • 精细化资产同步(独立的推送和拉取作业):

    为七种特定资产提供专用的推送和拉取作业对。在开发、更新或测试单个组件时,使用独立作业,而无需同步或覆盖环境的其余部分:

    • Playbook 和工作流块:Push Playbook 和 Pull Playbook

    • 连接器:Push Connectors 和 Pull Connector

    • 集成:Push Integration 和 Pull Integration

    • 预定作业:Push Job 和 Pull Jobs

    • 本体映射:Push Mappings 和 Pull Mappings

    • 自定义视觉系列:Push Custom Family 和 Pull Custom Family

    • 模拟测试用例:Push Simulated Cases 和 Pull Simulated Cases

代码库目录结构

运行初始推送内容作业(在新的或迁移的分支上运行任何拉取作业之前,必须先运行此作业)会在远程 Git 代码库中创建以下预定义的目录结构、JSON 配置文件、根 GitSync.json 元数据文件和生成的 README.md 文档。

├── Connectors/
│   └── <Integration_Name>/
│       └── <Connector_Name>/
│           ├── <Connector_Name>.json
│           └── README.md
├── Integrations/
│   └── <Integration_Identifier>/
│       ├── Actions/
│       ├── Connectors/
│       ├── Dependencies/
│       ├── Jobs/
│       ├── Managers/
│       ├── Resources/
│       ├── Integration-<Integration_Identifier>.def
│       └── README.md
├── Jobs/
│   ├── <Job_Name>.json
│   └── README.md
├── Ontology/
│   ├── Mappings/
│   │   └── <Source_Name>/
│   │       ├── <Source_Name>_Records.json
│   │       ├── <Source_Name>_Rules.json
│   │       └── README.md
│   └── VisualFamilies/
│       └── <Family_Name>/
│           ├── <Family_Name>.json
│           ├── <Family_Name>.png
│           └── README.md
├── Playbooks/
│   ├── README.md
│   └── <Folder_Name>/
│       └── <Playbook_Or_Block_Name>/
│           ├── <Playbook_Or_Block_Name>.json
│           └── README.md
├── Settings/
│   ├── blacklists.json
│   ├── caseCloseCauses.json
│   ├── caseTitles.json
│   ├── customLists.json
│   ├── domains.json
│   ├── dynamicParameters.json
│   ├── emailTemplates.json
│   ├── environments.json
│   ├── integrationInstances.json
│   ├── logo.json
│   ├── networks.json
│   ├── slaDefinitions.json
│   ├── stages.json
│   └── tags.json
├── SimulatedCases/
│   └── <Case_Name>.case
├── GitSync.json
└── README.md

实例级同步作业

实例级作业会在整个 Google SecOps 实例中同步所选资产类别。

推送内容

使用推送内容作业,从 Google SecOps 实例中导出所选资产类别,并将其提交到配置的 Git 代码库分支。初始化新分支时,请始终先运行推送内容。

作业输入

如需配置推送内容作业,请使用以下参数:

参数 说明
Commit

必填。

描述导出的内容更改的 Git 提交消息。

Commit Passwords

可选。

如果选中,作业会导出已配置的集成实例、连接器和作业的明文 Password 类型参数。

素材资源选择参数:
Integrations、Playbooks、Jobs、Connectors、Simulated Cases、Integration Instances、Visual Families、Mappings、Environments、Dynamic Parameters、Logo、Case Tags、Case Stages、Case Title Settings、Case Close Reasons、Networks、Domains、Custom Lists、Email Templates、Blacklists、SLA Records

可选(布尔值切换开关)。

选择要包含在导出内容中的每个资产类别。

Repo URL

可选。

覆盖集成实例中配置的代码库网址。

Branch

可选。

替换集成实例中配置的代码库分支。

Commit Author

可选。

替换集成实例中配置的提交作者。必须使用 Name &lt;email@domain.com&gt; 格式。

Git Server Fingerprint

可选。

替换集成实例中配置的 SSH 主机指纹。

作业输出

该作业会将 JSON 配置文件和 README.md 摘要写入标准目录层次结构(/Playbooks、/Connectors、/Integrations、/Jobs、/Ontology/Mappings、/Ontology/VisualFamilies、/SimulatedCases 和 /Settings)下的目标 Git 分支,并将执行日志输出到作业运行器控制台。自定义集成会作为完整软件包导出,而商业集成仅会导出添加到集成的自定义脚本或修改。

拉取内容

使用拉取内容作业从配置的 Git 代码库分支中检索所选配置类别,并将其应用到 Google SecOps 平台。

作业输入

如需配置拉取内容作业,请使用以下参数:

参数 说明
素材资源选择参数:
Integrations、Playbooks、Jobs、Connectors、Simulated Cases、Integration Instances、Visual Families、Mappings、Environments、Dynamic Parameters、Logo、Case Tags、Case Stages、Case Title Settings、Case Close Reasons、Networks、Domains、Custom Lists、Email Templates、Blacklists、SLA Records

可选(布尔值切换开关)。

选择要从代码库导入到环境中的每个资产类别。

Repo URL

可选。

覆盖集成实例中配置的代码库网址。

Branch

可选。

替换集成实例中配置的代码库分支。

Git Server Fingerprint

可选。

替换集成实例中配置的 SSH 主机指纹。

作业输出

该作业会将所选代码库定义导入平台,创建或更新集成实例、Playbook、连接器、作业、本体映射和设置,并将执行日志输出到作业运行器控制台。

独立同步作业

独立作业允许对特定资产进行精细同步,而无需进行完整的代码库同步。

推送 Playbook

使用推送 Playbook 作业将单个 Playbook 或可重复使用的工作流块导出到 Git。

作业输入

如需配置推送 Playbook 作业,请使用以下参数:

参数 说明
Commit

必填。

描述 playbook 更改的 Git 提交消息。

Playbook Whitelist

可选。

要导出的 Playbook 或区块的确切名称(区分大小写,以逗号分隔列表形式提供)。请提供 Playbook Whitelist 或 Folders Whitelist。

Folders Whitelist

可选。

Playbook 文件夹(类别)名称的英文逗号分隔列表。这些文件夹中的所有 playbook 和代码块都会导出。

Include Playbook Blocks

可选。

如果选中,则会导出可重复使用的工作流块以及所选 playbook,包括在这些 playbook 中作为步骤引用的任何块。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Commit Author

可选。

替换默认提交作者。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

Readme Addon

可选。

附加到生成的 README.md 的自定义内容,适用于在此运行中推送并保存在根 GitSync.json 元数据文件中的所有 playbook。

同时支持 Markdown 语法和 Jinja 模板。

作业输出

将所选 playbook 和包含的工作流块导出到 /Playbooks/<Folder_Name>/<Playbook_Name>/ 并更新 /Playbooks/README.md。

拉取 Playbook

使用拉取 playbook 作业从 Git 导入特定 playbook 或块。

作业输入

如需配置拉取 playbook 作业,请使用以下参数:

参数 说明
Playbook Whitelist

必填。

要从代码库导入的确切 playbook 或代码块名称的逗号分隔列表。

Include Playbook Blocks

可选。

如果选中,系统会自动导入所选 playbook 引用的任何可重复使用的工作流块。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

将指定的 playbook 和代码块从 /Playbooks(或 /Blocks)导入平台,先安装引用的代码块,然后再安装父级 playbook。

推送连接器

使用推送连接器作业将连接器配置导出到 Git。

作业输入

如需配置推送连接器作业,请使用以下参数:

参数 说明
Connectors

必填。

要导出的连接器显示名称的英文逗号分隔列表。

Commit

必填。

Git 提交消息。

Include Mappings

可选。

如果选中,则会将与连接器集成关联的本体映射记录和规则导出到 /Ontology/Mappings。

Include Visual Families

可选。

如果选中,则会将与连接器的本体记录关联的自定义视觉系列导出到 /Ontology/VisualFamilies。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Commit Author

可选。

替换默认提交作者。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

Readme Addon

可选。

附加到为此运行中推送的所有连接器生成的 README.md 并保存在 GitSync.json 中的自定义内容。

同时支持 Markdown 语法和 Jinja 模板。

作业输出

将连接器设置和时间表导出到 /Connectors/<Integration_Name>/<Connector_Name>/(以及关联的本体映射和视觉系列,如果已选择)。

拉取连接器

使用拉取连接器作业从 Git 导入连接器配置。在运行此作业之前,请确保连接器的底层集成已安装在目标环境中。

作业输入

如需配置拉取连接器作业,请使用以下参数:

参数 说明
Connector Name

必填。

要从代码库导入的连接器的显示名称。

Include Mappings

可选。

如果选中,则会导入与连接器的集成关联的本体映射。

Include Visual Families

可选。

如果选中,则会导入与连接器集成相关联的自定义视觉系列。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

在目标环境中安装或更新连接器(以及关联的映射或视觉系列,如果已选择)。

推送集成

使用推送集成作业将自定义集成或添加到商业集成的自定义脚本导出到 Git。自定义集成会作为完整集成软件包导出,而商业集成仅会导出添加到集成的自定义脚本或修改。

作业输入

如需配置推送集成作业,请使用以下参数:

参数 说明
Push Whitelist

必填。

要导出的集成标识符的英文逗号分隔列表。

Commit

必填。

Git 提交消息。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Commit Author

可选。

替换默认提交作者。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

Readme Addon

可选。

为在此运行中推送并保存在 GitSync.json 中的所有集成附加到生成的 README.md 的自定义内容。

同时支持 Markdown 语法和 Jinja 模板。

作业输出

将集成定义、自定义脚本(Actions/、Connectors/、Jobs/、Managers/)、依赖项和 README.md 文档导出到 /Integrations/<Integration_Identifier>/。

拉取集成

使用拉取集成作业从 Git 导入自定义集成或用于商业集成的自定义脚本。对于商业集成,GitSync 会从 Content Hub 安装最新版本的集成,并将自定义脚本保存到其中。

作业输入

如需配置拉取集成作业,请使用以下参数:

参数 说明
Install Whitelist

必填。

要从代码库导入的集成标识符的英文逗号分隔列表。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

安装自定义集成软件包或从 Content Hub 安装商业集成,并在目标环境中更新其自定义脚本。

推送作业

使用推送作业作业将预定的平台作业配置导出到 Git。

作业输入

如需配置推送作业作业,请使用以下参数:

参数 说明
Job Whitelist

必填。

要导出的计划作业名称的逗号分隔列表。

Commit

必填。

Git 提交消息。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Commit Author

可选。

替换默认提交作者。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

Readme Addon

可选。

附加到为此运行中推送的所有作业生成的 README.md 并保存在 GitSync.json 中的自定义内容。

同时支持 Markdown 语法和 Jinja 模板。

作业输出

将作业参数和时间间隔导出到 /Jobs/<Job_Name>.json,并更新 /Jobs/README.md。

拉取作业

使用拉取作业作业从 Git 导入计划的平台作业。

作业输入

如需配置拉取作业作业,请使用以下参数:

参数 说明
Job Whitelist

必填。

要从代码库导入的计划作业名称的逗号分隔列表。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

在平台作业调度器中配置并注册指定的计划作业。

推送映射

使用推送映射作业将特定来源的本体事件映射记录和规则导出到 Git。

作业输入

如需配置推送映射作业,请使用以下参数:

参数 说明
Source

必填。

要导出其映射记录和规则的本体来源(集成名称)。

Commit

必填。

Git 提交消息。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Commit Author

可选。

替换默认提交作者。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

Readme Addon

可选。

为在此次运行中推送的所有映射生成的 README.md 附加的自定义内容,并保存在 GitSync.json 中。

同时支持 Markdown 语法和 Jinja 模板。

作业输出

将本体记录 (<Source>_Records.json)、映射规则 (<Source>_Rules.json) 和 README.md 写入 /Ontology/Mappings/<Source>/。

拉取映射

使用拉取映射作业从 Git 导入特定来源的本体映射记录和规则。

作业输入

如需配置拉取映射作业,请使用以下参数:

参数 说明
Source

必填。

您要导入其映射记录和规则的本体来源(集成名称)。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

在平台本体设置中注册本体映射规则和视觉系列分配。 提取相应事件后,映射会显示在“本体状态”表中。

推送自定义系列

使用推送自定义系列作业将自定义视觉系列定义和图标导出到 Git。

作业输入

如需配置推送自定义系列作业,请使用以下参数:

参数 说明
Family Name

必填。

要导出的自定义视觉系列名称的英文逗号分隔列表。

Commit

必填。

Git 提交消息。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Commit Author

可选。

替换默认提交作者。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

Readme Addon

可选。

附加到生成的 README.md 的自定义内容,适用于在此运行中推送并保存在 GitSync.json 中的所有自定义视觉系列。

同时支持 Markdown 语法和 Jinja 模板。

作业输出

将视觉系列定义 (<Family_Name>.json)、图标图片文件 (<Family_Name>.png) 和 README.md 导出到 /Ontology/VisualFamilies/<Family_Name>/。

拉取自定义系列

使用拉取自定义系列作业从 Git 导入自定义视觉系列定义和图标。

作业输入

如需配置拉取自定义系列作业,请使用以下参数:

参数 说明
Family Name

必填。

要导入的自定义视觉素材系列的确切名称。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

将自定义视觉系列定义和图标导入平台本体设置。

推送模拟支持请求

使用推送模拟用例作业将模拟测试用例导出到 Git。

作业输入

如需配置推送模拟案例作业,请使用以下参数:

参数 说明
Simulated Cases

必填。

要导出的模拟案例名称的逗号分隔列表。

Commit

必填。

Git 提交消息。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Commit Author

可选。

替换默认提交作者。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

将模拟案例作为 .case 文件导出到 /SimulatedCases/<Case_Name>.case。

拉取模拟支持请求

使用拉取模拟用例作业从 Git 导入模拟测试用例。

作业输入

如需配置拉取模拟案例作业,请使用以下参数:

参数 说明
Simulated Cases

必填。

要从代码库导入的模拟案例名称的逗号分隔列表。

Repo URL

可选。

替换默认代码库网址。

Branch

可选。

替换默认分支。

Git Server Fingerprint

可选。

替换默认 SSH 主机指纹。

作业输出

将指定的模拟支持请求导入到平台的模拟支持请求目录中。

问题排查

下表提供了常见同步错误的修复步骤:

观察到的出错提示 操作原因 修复程序
GitSync 53.0 版中出现 AttributeError: 'OnePlatformSoarApi' object has no attribute 'update_ide_item' 或同步失败 运行回归 GitSync 53.0 版软件包,其中包含自定义 IDE 项和修改后的 JSON 架构的已知同步问题。 在 Content Hub 中,将 GitSync 回滚到版本 52.0 或升级到版本 54.0,并确保 Branch 参数指向版本 53 之前的代码库分支。如需查看分步说明,请参阅版本 53.0 回滚和版本 52.0/54.0 兼容性。
Permission denied (publickey) 或 Host key verification failed(或 Authentication failed for 'https://...') Git 身份验证失败,原因可能是凭证格式无效、缺少部署密钥写入权限或主机指纹不匹配。
  • SSH 身份验证:验证您的私有 SSH 密钥是否已转换为单行 base64 字符串,且末尾没有换行符或空格。确认对应的公钥已在 Git 代码库中注册,并具有写入权限。
  • 主机指纹:如果启用了主机指纹固定,请使用 ssh-keyscan -t rsa <hostname> 验证指纹字符串,并更新 Git 服务器指纹参数。
  • HTTPS 身份验证:验证您的个人访问令牌 (PAT) 是否未过期,并且具有代码库写入权限。
403 Forbidden: Insufficient permissions to modify playbook(或 Failed to push playbook: Access denied) 目标 playbook 的默认访问权限受限(例如可以查看),并且 Administrator SOC 角色在源系统上未被授予可以修改权限。 在 Google SecOps 中,前往 Playbook,选择受影响的 Playbook,打开其权限设置,然后添加具有可以修改权限的 Administrator SOC 角色(或在 GitSync 集成实例上配置可选的 SOAR 用户名和 SOAR 密码参数)。如需了解详细步骤,请参阅配置 playbook 权限。
拉取内容或拉取集成作业在 5 分钟后超时 在单次拉取操作期间从 Content Hub 安装多个商业集成超出了 5 分钟的作业执行超时限制。 在运行拉取内容之前,请先从 Content Hub 手动安装所需的商业集成,或重新运行拉取内容作业以继续导入剩余资产。
General error performing Job Pull Content(或 400 Bad Request / 404 Not Found,从代码库分支拉取时) 尝试从以下分支拉取:未初始化的代码库分支,或其 JSON 文件是使用不兼容的 GitSync 53.0 版架构导出的分支。
  • 如果分支是使用 GitSync 53.0 版修改的,请将分支参数切换回 53.0 版之前的代码库分支,或恢复 53.0 版之前的分支备份(请参阅53.0 版回滚和 52.0/54.0 版兼容性)。
  • 如果您要在 52.0 或 54.0 版上设置新分支,请先执行完整的推送内容作业来填充该分支,然后再运行任何拉取作业。
Playbook '<Playbook_Name>' is assigned to environment(s) that don't exist 正在导入的 playbook 或代码块被分配给目标实例上尚未创建的环境或环境组。 请先运行拉取内容并选择环境选项,或者在目标实例上依次前往设置 > 访问管理 > 环境,手动创建缺失的环境,然后再拉取 playbook。如果您使用的是仅限 SOAR 的平台,请前往设置 > 组织 > 环境。
Commit Author parameter must be in the following format: Name <example@gmail.com> 集成实例或作业配置中的提交作者参数缺少尖括号中的邮箱。 请更新提交作者参数,使其符合要求的格式:Name <email@domain.com>(例如 GitSync <gitsync@example.com>)。
导入本体映射时出现 400 Bad Request 或 409 Conflict 代码库中的事件映射规则与现有平台本体规则冲突,或者这些规则是使用不兼容的 GitSync 版本导出的。 使用 GitSync 54.0 或 52.0 版执行新的推送映射作业,以重新导出映射定义,或在设置 > 调查 > 本体状态(或在仅限 SOAR 的平台上,依次点击设置 > 本体 > 本体状态)中解决重复的事件映射规则,然后再重新运行作业。

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