使用 IDE

支持的平台:

本文档介绍了集成开发环境 (IDE) 生产模式。IDE 是一个用于查看、修改和测试代码的框架。您可以查看商业集成的代码,并从头开始创建自定义集成,也可以通过复制商业集成代码来创建自定义集成。

IDE 是您管理、导入和导出自定义集成的地方。

打开 IDE

如需打开 IDE,请按以下步骤操作:

  • 如需打开 IDE,请在主菜单中依次前往响应 > IDE。系统会打开 IDE 页面。

IDE 页面上,您可以访问以下选项:

选项 说明
集成
类型
选择集成类型(连接器、操作、作业、管理器)。
导出
导入
从集成中导出单个或多个商品。导出单个项时会包含相关项,但导出整个软件包时不会包含相关项。
导出的文件是一个包含 JSON 文件的 ZIP 归档文件。导入时,您可以将单个商品添加到现有集成中,也可以导入整个软件包。软件包必须包含 integrations.def 文件以及以下文件夹:ActionsDefinitionsActionsScriptsDependenciesManagers
点击隐藏不活跃/显示全部切换开关,以显示隐藏已停用的项(操作、连接器)。
添加新的自定义集成、连接器、操作、作业或管理器。

添加连接器

如需添加连接器,请按以下步骤操作:

  1. 点击 Create New Item,然后选择 Connector
  2. 输入名称和所需的集成。
  3. 点击创建
  4. 添加集成详细信息。
  5. 添加必需的参数。
  6. 点击连接器切换开关以启用连接器。
  7. 完成后,点击保存,或按 Ctrl + S

详细信息标签页中提供以下选项:

选项 说明
删除 仅适用于自定义集成中的商品。
Play 运行脚本的测试方法。结果会显示在 Testing 标签页中,调试输出会显示在 Debug Output 部分。
file_json 管理 JSON 示例 在 JSON 示例导入/导出对话框中,确保已启用包括 JSON 结果。然后,您可以为操作导入或导出 JSON 结果示例。
详细信息输入用户提供的输入和其他参数,例如集成名称。
版本控制 版本控制 - 选择操作/作业/连接器,然后点击以查看以下选项: 另存为新版本:将对象另存为新版本,并可添加注释。查看版本记录:查看和恢复之前的版本。仅在至少保存了一个版本后才可用。点击“恢复”即可随时恢复到之前的任何版本。仅当您之前点击过操作/作业/连接器/管理器上的另存为新版本时,此选项才可用。
商品重复 复制作业、操作、连接器、管理器等项。保存后,该重复项会显示在列表中,但没有 锁定 锁定图标。

创建自定义集成

  1. 点击 Create New Item(创建新项),然后选择 Integration(集成)。
  2. 输入名称,然后点击创建
  3. 从列表中选择已创建的集成,然后提供以下信息:
    • 说明:显示在 Google Security Operations Marketplace 中,所有 Google SecOps 用户均可看到。
    • SVG 图标:上传与集成一起显示的 SVG 图标。
    • 图片:为 Google SecOps 用户上传应用商店图片。
    • :使用 pip 添加 Python 库。
    • 脚本依赖项:上传 `.WHL`、`.PY`、`.TAR` 或 `.GZ` 文件。这些脚本可为您的集成添加更多功能。
    • 参数:添加具有已定义类型、默认值和必需状态的可配置字段。
  4. 完成后,点击保存

创建作业

如需创建作业,请按以下步骤操作:

  1. 点击 Create New Item(创建新项),然后选择 Job(作业)。
  2. 输入名称和所需的集成。
  3. 点击创建
  4. 可选:添加用户或脚本输入的参数。
  5. 点击保存或按 Ctrl + S
  6. 点击 arrow_right Play Item 以运行脚本。
  7. 前往响应 > 作业调度器
  8. 点击 添加 创建新作业,然后选择您刚刚创建的作业。
  9. 响应 > 作业调度器中,选择运行您创建的作业(脚本)所需的时间。

创建要在 playbook 中使用的新操作

如需为剧本创建新操作,请按以下步骤操作:

  1. 点击 Create New Item,然后选择 Action
  2. 输入名称和所需的集成 > 点击创建
  3. 根据需要修改代码。
  4. 如果操作应在剧本中返回 JSON 结果,请启用包括 JSON 结果
  5. 可选:添加要显示为输入字段的参数。
  6. 启用相应操作,然后点击保存
  7. Polling Configuration 中,您可以设置超时时间和操作超时时的默认返回值。您还可以设置一个默认值,以便在操作未在定义的超时期限内完成时返回该值。

该操作现已可在 Playbook > 操作中使用。

创建自定义管理器

如需创建自定义管理器,请按照以下步骤操作:

  1. 点击 Create New Item,然后选择 Manager。输入名称和所需的集成。
  2. 点击创建
  3. 根据需要修改代码。
  4. 点击保存

IDE 自定义代码验证

在 Google SecOps IDE 中工作时,您将在受管理且安全的环境中构建自定义代码。为确保此平台的完整性和稳定性,IDE 实现了自定义代码验证,以限制特定函数的使用。这些限制是出于安全和技术原因而实施的。

自定义代码中限制使用以下表达式:

  • no_shell = [
    "os.execl",
    "os.execle",
    "os.execlp",
    "os.execlpe",
    "os.execv",
    "os.execve",
    "os.execvp",
    "os.execvpe",
    "os.spawnl",
    "os.spawnle",
    "os.spawnlp",
    "os.spawnlpe",
    "os.spawnv",
    "os.spawnve",
    "os.spawnvp",
    "os.spawnvpe",
    "os.startfile"
    ]

  • shell = [
    "os.system",
    "os.popen",
    "os.popen2",
    "os.popen3",
    "os.popen4",
    "popen2.popen2",
    "popen2.popen3",
    "popen2.popen4",
    "popen2.Popen3",
    "popen2.Popen4",
    "commands.getoutput",
    "commands.getstatusoutput"
    ]

  • subprocess = [
    "subprocess.Popen",
    "subprocess.call",
    "subprocess.check_call",
    "subprocess.check_output"
    ]

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