tagcube-cli 1.0.7

TagCube的CLI工具

使用TagCube的REST API启动Web应用程序安全扫描，常用于持续交付脚本。

用法

开始新扫描的最简单方法是使用目标URL作为参数调用tagcube

$ export TAGCUBE_EMAIL=user@example.com
$ export TAGCUBE_API_KEY=`cat key.txt`
$ tagcube scan --root-url http://domain.com
Web application scan for "http://domain.com/" successfully started at TagCube cloud.

这将在TagCube的REST API中创建新的域名资源，并使用这些默认值启动新的扫描

• 引导路径： /

• Web应用程序扫描配置文件： full_audit

扫描完成后，将向用户的电子邮件地址发送电子邮件。

重要：根据TagCube的许可证配额和权限，您可能需要在运行针对目标域的第一次扫描之前，使用REST API或Web应用程序创建和验证目标域的所有权。

高级用法

对http://target.com/进行扫描，扫描完成后通知REST API用户名和电子邮件地址

$ tagcube scan --root-urls http://target.com

使用自定义配置文件进行扫描，启用详细模式，扫描完成后通知不同的电子邮件地址

$ tagcube scan --root-urls http://target.com --email-notify=other@example.com \
               --scan-profile=fast_scan -v

将TagCube的REST API凭据作为命令行参数提供。阅读文档以了解如何使用环境变量或.tagcube文件提供REST API凭据

$ tagcube scan --root-urls http://target.com  --tagcube-email=user@example.com \
               --tagcube-api-key=...

验证配置的凭据是否有效

$ tagcube auth

配置文件

避免在源代码和部署脚本中使用硬编码的凭据总是一个好主意。此工具可以从当前目录或用户的家目录中的YAML文件获取凭据。文件名应为.tagcube，格式如下

credentials:
    email: ...
    api_key: ...

文件放置到位后，即可运行工具

$ tagcube auth
Successfully authenticated against TagCube's API.
$

通过环境变量进行配置

另一种向 tagcube-cli 提供REST API凭据的方法是设置 TAGCUBE_EMAIL 和 TAGCUBE_API_KEY 环境变量。这些变量方便避免在脚本或源代码中硬编码凭据。

与持续交付集成

使用TagCube，您可以在代码推送到服务器后轻松添加安全性，我们建议添加以下两行代码

pip install --upgrade tagcube-cli
tagcube scan --root-url http://target.com

尽管在大多数情况下，建议针对使用 pip 安装的任何外部软件包的版本进行具体说明，但我们建议为 tagcube-cli 采用更宽松的安装过程，这样我们就可以频繁地向客户推送升级。

更多信息

有关教程和示例用法的更详细文档，可以在 TagCube网站 找到

报告错误

在 tagcube-cli问题跟踪器 中报告您的问题和功能请求，我们将非常乐意修复它们。

欢迎提交拉取请求！