未提供项目描述
项目描述
肯纳

kenna
是Kenna Security的API客户端,允许您使用应用程序、资产、连接器、仪表板组、用户、角色、漏洞和修复程序。
常问问题
包括什么?
- 一个 API 客户端,允许您查找和计算应用程序、资产、资产组、连接器、连接器运行、仪表板组、用户、角色、修复和漏洞;
- 一个强大的命令行界面与之配套
安装
要安装kenna
使用pip
:
$ pip install kenna
从源安装kenna
(需要poetry
):
$ git clone git@github.com:whitfieldsdad/python-kenna.git
$ cd python-kenna
$ make install
要使用(即如果您不使用)kenna
从源安装:setup.py
poetry
$ git clone git@github.com:whitfieldsdad/python-kenna.git
$ cd python-kenna
$ python3 setup.py install
最后,导出一个名为KENNA_API_KEY
您的shell 的环境变量(即将它添加到您的~/.bashrc
或用户配置文件中)。
重要的环境变量
KENNA_API_KEY
:您用于访问 Kenna 的 API 密钥(必需)ENABLE_INTEGRATION_TESTS
:true
或false
(可选)
测试
您可以按如下方式为此包运行单元测试和集成测试:
$ make test
如果$ENABLE_INTEGRATION_TESTS
环境变量的值设置为true
,则单元测试和集成测试都将被执行:
$ ENABLE_INTEGRATION_TESTS=true make test
如果您有单独的开发和生产租户,您可以选择要使用的租户,如下所示:
$ ENABLE_INTEGRATION_TESTS=true
$ KENNA_API_KEY=${KENNA_DEVELOPMENT_API_KEY} make test
$ KENNA_API_KEY=${KENNA_PRODUCTION_API_KEY} make test
教程
命令行界面
命令行界面kenna
允许您搜索、列出和计算应用程序、资产、资产组、连接器、连接器运行、仪表板组、修复、角色、用户和漏洞。
安装后kenna
,您可以访问命令行界面,如下所示:
$ poetry run kenna
如果你不使用poetry
(你应该使用它),你可以访问命令行如下:
$ python3 -m kenna.cli
一般的
命令行界面中提供了以下常规选项:
$ poetry run kenna
用法:kenna [选项]命令[ ARGS ] ...
选项:
--api-key 文本
--region 文本
--help 显示此消息并退出。
命令:
应用
资产组
资产
连接器运行
连接器
仪表板组
修复
角色
用户
漏洞
应用
使用应用程序时可以使用以下选项:
$ poetry run kenna applications --help
Usage: kenna applications [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-applications
count-applications
列出应用程序
列出应用程序时可以使用以下选项:
$ poetry run kenna applications get-applications --help
Usage: kenna applications get-applications [OPTIONS]
Options:
--application-ids TEXT
--application-names TEXT
--application-owners TEXT
--application-teams TEXT
--application-business-units TEXT
--min-application-risk-meter-score INTEGER
--max-application-risk-meter-score INTEGER
--min-asset-count INTEGER
--max-asset-count INTEGER
--min-vulnerability-count INTEGER
--max-vulnerability-count INTEGER
--limit INTEGER
--help Show this message and exit.
资产
使用资产时可以使用以下选项:
$ poetry run kenna assets --help
Usage: kenna assets [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-assets
count-assets
列出资产
列出资产时可以使用以下选项:
$ poetry run kenna assets get-assets --help
Usage: kenna assets get-assets [OPTIONS]
Options:
--asset-ids TEXT
--asset-group-ids TEXT
--asset-group-names TEXT
--asset-tags TEXT
--asset-hostnames TEXT
--asset-ip-addresses TEXT
--asset-mac-addresses TEXT
--min-asset-risk-meter-score INTEGER
--max-asset-risk-meter-score INTEGER
--min-asset-first-seen-time TEXT
--max-asset-first-seen-time TEXT
--min-asset-last-seen-time TEXT
--max-asset-last-seen-time TEXT
--min-asset-last-boot-time TEXT
--max-asset-last-boot-time TEXT
--limit INTEGER
--help Show this message and exit.
资产组
使用资产组时可以使用以下选项:
$ poetry run kenna asset-groups --help
Usage: kenna asset-groups [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-asset-groups
count-asset-groups
列出资产组
列出资产组时可以使用以下选项:
$ poetry run kenna asset-groups get-asset-groups --help
Usage: kenna asset-groups get-asset-groups [OPTIONS]
Options:
--asset-group-ids TEXT
--asset-group-names TEXT
--asset-ids TEXT
--asset-tags TEXT
--asset-hostnames TEXT
--asset-ip-addresses TEXT
--asset-mac-addresses TEXT
--min-asset-group-create-time TEXT
--max-asset-group-create-time TEXT
--min-asset-group-last-update-time TEXT
--max-asset-group-last-update-time TEXT
--limit INTEGER
--help Show this message and exit.
例如,让我们列出与名称包含字符串“Europe”的每个资产组关联的 ID、名称、资产计数、漏洞计数和修复计数:
$ poetry run kenna asset-groups get-asset-groups --asset-group-names "*Europe*" | jq '{"id": .id, "name": .name, "asset_count": .asset_count, "vulnerability_count": .vulnerability_count, "fix_count": .fix_count}' | jq --slurp
[
{
"id": 123456,
"name": "All European assets",
"asset_count": 12345,
"vulnerability_count": 1234567,
"fix_count": 12345
}
]
连接器
使用连接器时可以使用以下选项:
$ poetry run kenna connectors --help
Usage: kenna connectors [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-connectors
count-connectors
列出连接器
列出连接器时可以使用以下选项:
$ poetry run kenna connectors get-connectors --help
Usage: kenna connectors get-connectors [OPTIONS]
Options:
--connector-ids TEXT
--connector-names TEXT
--min-connector-run-start-time TEXT
--max-connector-run-start-time TEXT
--min-connector-run-end-time TEXT
--max-connector-run-end-time TEXT
--limit INTEGER
--help Show this message and exit.
连接器运行
使用连接器管路时可以使用以下选项:
$ poetry run kenna connector-runs --help
Usage: kenna connector-runs [OPTIONS] COMMAND [ARGS]...
Options:
--connector-ids TEXT
--connector-names TEXT
--connector-run-ids TEXT
--min-connector-run-start-time TEXT
--max-connector-run-start-time TEXT
--min-connector-run-end-time TEXT
--max-connector-run-end-time TEXT
--help Show this message and exit.
Commands:
get-connector-runs
count-connector-runs
列出连接器运行
列出连接器运行时,以下选项可用:
$ poetry run kenna connector-runs get-connector-runs --help
Usage: kenna connector-runs get-connector-runs [OPTIONS]
Options:
--connector-ids TEXT
--connector-names TEXT
--connector-run-ids TEXT
--min-connector-run-start-time TEXT
--max-connector-run-start-time TEXT
--min-connector-run-end-time TEXT
--max-connector-run-end-time TEXT
--limit INTEGER
--help Show this message and exit.
仪表板组
使用仪表板组时可以使用以下选项:
$ poetry run kenna dashboard-groups --help
Usage: kenna dashboard-groups [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-dashboard-groups
count-dashboard-groups
列出仪表板组
列出仪表板组时可以使用以下选项:
$ poetry run kenna dashboard-groups get-dashboard-groups --help
Usage: kenna dashboard-groups get-dashboard-groups [OPTIONS]
Options:
--dashboard-group-ids TEXT
--dashboard-group-names TEXT
--role-ids TEXT
--role-names TEXT
--min-dashboard-group-create-time TEXT
--max-dashboard-group-create-time TEXT
--min-dashboard-group-last-update-time TEXT
--max-dashboard-group-last-update-time TEXT
--limit INTEGER
--help Show this message and exit.
用户
与用户合作时可以使用以下选项:
$ poetry run kenna users --help
Usage: kenna users [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-users
count-users
列出用户
列出用户时可以使用以下选项:
$ poetry run kenna users get-users --help
poetry run kenna users get-users --help
Usage: kenna users get-users [OPTIONS]
Options:
--user-ids TEXT
--user-names TEXT
--user-email-addresses TEXT
--min-user-create-time TEXT
--max-user-create-time TEXT
--min-user-last-sign-in-time TEXT
--max-user-last-sign-in-time TEXT
--min-user-last-update-time TEXT
--max-user-last-update-time TEXT
--limit INTEGER
--help Show this message and exit.
角色
使用角色时可以使用以下选项:
$ poetry run kenna roles --help
Usage: kenna roles [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-roles
count-roles
列出角色
列出角色时可以使用以下选项:
$ poetry run kenna roles get-roles --help
Usage: kenna roles get-roles [OPTIONS]
Options:
--role-ids TEXT
--role-names TEXT
--role-types TEXT
--role-access-levels TEXT
--role-custom-permissions TEXT
--user-ids TEXT
--user-email-addresses TEXT
--user-names TEXT
--min-role-create-time TEXT
--max-role-create-time TEXT
--min-role-last-update-time TEXT
--max-role-last-update-time TEXT
--limit INTEGER
--help Show this message and exit.
漏洞
处理漏洞时可以使用以下选项:
$ poetry run kenna vulnerabilities --help
Usage: kenna vulnerabilities [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-vulnerabilities
count-vulnerabilities
列出漏洞
列出漏洞时可以使用以下选项:
$ poetry run kenna vulnerabilities get-vulnerabilities --help
Usage: kenna vulnerabilities get-vulnerabilities [OPTIONS]
Options:
--vulnerability-ids TEXT
--cve-ids TEXT
--fix-ids TEXT
--fix-names TEXT
--fix-vendors TEXT
--asset-ids TEXT
--asset-hostnames TEXT
--asset-ip-addresses TEXT
--asset-mac-addresses TEXT
--asset-group-ids TEXT
--asset-group-names TEXT
--asset-tags TEXT
--min-vulnerability-risk-meter-score INTEGER
--max-vulnerability-risk-meter-score INTEGER
--min-vulnerability-first-seen-time TEXT
--max-vulnerability-first-seen-time TEXT
--min-vulnerability-last-seen-time TEXT
--max-vulnerability-last-seen-time TEXT
--min-cve-publish-time TEXT
--max-cve-publish-time TEXT
--min-patch-publish-time TEXT
--max-patch-publish-time TEXT
--min-patch-due-date TEXT
--max-patch-due-date TEXT
--limit INTEGER
--help Show this message and exit.
修复
使用修复时可以使用以下选项:
$ poetry run kenna fixes --help
Usage: kenna fixes [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get-fixes
count-fixes
列出修复
列出修复时可以使用以下选项:
$ poetry run kenna fixes get-fixes --help
Usage: kenna fixes get-fixes [OPTIONS]
Options:
--fix-ids TEXT
--fix-names TEXT
--fix-vendors TEXT
--cve-ids TEXT
--asset-ids TEXT
--asset-hostnames TEXT
--asset-ip-addresses TEXT
--asset-mac-addresses TEXT
--asset-ip-addresses TEXT
--asset-mac-addresses TEXT
--asset-group-ids TEXT
--asset-group-names TEXT
--asset-tags TEXT
--min-fix-create-time TEXT
--max-fix-create-time TEXT
--min-fix-last-update-time TEXT
--max-fix-last-update-time TEXT
--limit INTEGER
--help Show this message and exit.
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。