插件工具
该工具旨在用于开发新的或现有的插件。
工具
你可以找到一个列表开源插件要引用、添加新特性或修复错误。我们欢迎并鼓励pull requests!
图标插件
这是开发插件的主要工具。安装说明icon-plugin可在入门文档。
建造
子命令构建构建插件开发的工件。
参数
图片用于将插件代码打包到Docker映像中,使其可以运行。这通常是您在处理现有插件时要做的第一件事,以确保它成功构建。
1
$ CD Base64.
2
$ icon-plugin build image
3.
INFO[0000] Building image base64:1.1.1
4.
info [0000]运行命令:Docker Build - Pull -T Rapid7 / Base64:1.1.1。
压缩文件用于构建插件的tarball。这用于InsightConnect中的向后兼容测试。
1
$ CD Base64.
2
$ icon-plugin build tarball
3.
INFO [0000]建立Tarball Rapid7-Base64-1.1.1.tar.gz
生成
子命令生成创建插件骨架。
它可以用来从插件规范生成一个新的插件(插件规范),并将规范的路径作为参数。
icon-plugin生成--regenerate python plugin.spec.yaml
随时修改插件规范,使用子命令生成与之- 再生标志,以在不损害先前编写的代码的情况下,用新的模式重新构建框架。这使得添加操作和更新插件规范变得简单而快速。
icon-plugin生成--regenerate python plugin.spec.yaml
的帮助。Md文件是插件的关键部分。这提供了关于插件的基本信息和用法。当运行下面的命令时,帮助将输出到stdout。如果help.md丢失了,请使用重定向来帮助。Md创建帮助基地。
帮助例子
| 命令 | 描述 |
|---|---|
icon-plugin产生帮助 |
产生帮助 |
图标-插件生成帮助>帮助 |
帮助重定向 |
你需要样本来测试插件。当生成一个示例时,它将创建一个JSON文件,其中包含插件所需的参数。
样本示例
| 命令 | 描述 |
|---|---|
icon-plugin sample - sample动作或触发名称 |
生成一个样本 |
icon-plugin生成样本 |
生成所有样品 |
运行
子命令运行在版本3.3.0 = 制作。
看到运行插件页以了解更多细节。下面是一些例子。
运行示例
| 命令 | 描述 |
|---|---|
Icon-plugin运行-c info |
显示插件信息 |
icon-plugin运行-r tests / submit.json -j |
在提交JSON测试上执行run方法 |
icon-plugin运行-r tests / submit.json -a |
在提交JSON测试文件上执行run方法,以打印评估,并将其发布在我们的PR中开源GitHub存储库 |
icon-plugin运行-t all -r所有-j |
执行测试并运行所有JSON测试的方法 |
HTTP服务器
您还可以在REST模式下与HTTP的插件交互:
Icon-plugin run -c HTTP
然后你可以使用包含JSON输入作为有效负载的web请求来点击它的运行或测试端点:
1
curl -d @ tests / forward.json http://127.0.0.1:1000001/10-9/10/10/10/10/4/10/10
2
curl -d @ tests / forward.json http://127.0.0.1:10001/127.0.0.1:10001/10-/taction/forward/test
出口
子命令出口将Docker镜像导出为。柏油您可以导入InsightConnect的文件。此命令的输出是您将导入InsightConnect作为自定义插件以开始使用它。请注意,此命令将在导出之前先构建插件。
1
$ CD Base64.
2
$ icon-plugin导出
3.
info [0000]运行命令:Docker Build - Pull -T Rapid7 / Base64:1.1.1。
4.
...
5.
信息[0010]建立标签
6.
INFO [0010]运行命令:DOCKER标签RAPIT7 / BASE64:1.1.1 RAPIT7 / BASE64:最新
7.
INFO [0010]建筑插件Tarball Rapid7_base64_1.1.1.tar
8.
INFO[0010]运行命令:docker save rapid7/base64:1.1.1 -o rapid7_base64_1.1.1.tar . gz
杰森到规范
一个剧本叫做json_to_spec.py将JSON对象转换为InsightConnect插件规范数据。它需要一个包含JSON作为参数的文件。它位于开源插件repo。
1
$ curl -s https://ifconfig.co/json > ifconfig.json
2
$工具/ json_to_spec.py ifconfig.json
3.
类型:{}
4.
5.
输出:
6.
城市:
7.
描述:输入说明
8.
标题:输入标题
9.
类型:字符串
10.
主机名:
11.
描述:输入说明
12.
标题:输入标题
13.
类型:字符串
14.
知识产权:
15.
描述:输入说明
16.
标题:输入标题
17.
类型:字符串
18.
country_iso:
19.
描述:输入说明
20.
标题:输入标题
21
类型:字符串
22
ip_decimal:
23
描述:输入说明
24
标题:输入标题
25
类型:整数
26
国家:
27
描述:输入说明
28
标题:输入标题
29
类型:字符串
然后,您可以将输出复制并粘贴到插件规格中,而不是手动输入它。