创建自定义插件

您可以通过构建您自己的插件或为现有插件提供insightConnect的功能来扩展InsightConnect的功能。这让你:

  • 使用新的触发器和操作创建新插件
  • 将触发器和操作添加到现有插件
  • 将InsightConnect工作流连接到内部服务
  • 连接其他第三方服务
  • 更改现有插件的行为

InsightConnect插件基于REST API设计,并在Docker容器中运行(您可以了解更多关于REST API的信息)这里)。

我们使用RESTful设计来摄取和发送不同类型的数据,如纯文本,JSON,CSV和RSS。RESTful Design最好支持InsightConnect触发和步骤通过工作流程的转移变量。

在你开始之前

在您开始构建自己的插件之前,我们建议您查看入门指南在插件库中。

请注意,目前支持的插件开发和基于Debian和Enterprise Linux发行版以及MacOS支持。目前不支持Microsoft Windows。

为了构建或贡献InsightConnect插件,您还需要安装以下工具。使用下面提供的安装说明,或者为您的操作系统或发行版使用包管理器(如果可用)。

工具 安装说明
Python 3 请按照https://www.python.org/download/Releases/3.0/
GNU使 请按照https://docs.docker.com/get-started/
Rapid7 InsightConnect插件工具依赖 运行update-tools.sh来自工具/目录在InsightConnect插件存储库中。或以下以下内容:

创建插件

对于开发插件,请务必检查入门指南来自GitHub上的开源插件存储库.如果您计划修改一个现有的插件,您可以从该存储库中提取插件的代码。

对于现有的插件特定的资源,请在插件的目录中找到Help.md文件。此文件包含有关该插件的版本历史,参数,输入和输出模式,连接配置信息和故障排除建议的信息。

插件开发高级步骤:

  1. 创建插件规范文件
    • 自定义插件不能拥有供应商的价值rapid7或者komand..如果要修改现有插件,请确保更改此值。
    • 每次你上传一个插件到InsightConnect,你必须增加该插件的版本。
    • insightconnect中的版本控制如下语义版本控制降低到预发布版本。例子:1.0.1-1用于修复错误1.0.0
  2. 在本地创建插件
    • 一定要跑制作
  3. 为插件的连接、动作和触发器编写自定义代码
  4. 在本地测试插件
  5. 运行icon-plugin导出导出插件码头图像。
  6. 上传生成的柏油从产品UI内部insightconnect!
    • 一旦上传插件,可以以类似的方式使用与市场插件类似。
    • 这位于设置下 - >插件,选择“导入”以转到“导入”页面。

自定义插件

  • 接下来,来自本地驱动器。

当地驱动器

  • 拖放或选择柏油文件,从您的窗口管理器,您通过icon-plugin.在步骤5中导出。Tar文件

为自定义插件库做出贡献

在安装所需的工具和开发您的插件之后,您可以选择将你的改变回馈给社区

您还可以遵循以下链接到其他资源:

开发人员支持

对于一般性问题和请求,达到Rapid7集成团队IntegrationAlliance@rapid7.com.