#google #google-api #cli #json-input #securitycenter

应用 google-securitycenter1-cli

与安全命令中心(协议v1)交互的完整库

10个稳定版本

3.1.0+20220224 2022年4月26日
3.0.0+20220224 2022年3月8日
2.0.4+20210326 2021年4月15日
1.0.14+20200703 2020年7月10日
1.0.10+20190628 2019年7月7日

Web编程 中排名 2949

Download history 77/week @ 2024-03-31 1/week @ 2024-04-07

每月下载量 74

MIT 许可证

3.5MB
42K SLoC

securitycenter1 命令行界面(CLI)允许您从终端舒适地使用 Google 安全命令中心服务的几乎所有功能。

默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其直接重定向到文件,而无需考虑 shell 的功能。错误将打印到标准错误,并导致程序的退出代码非零。

如果请求数据结构,这些数据结构将作为格式化的 JSON 返回,以便作为其他工具的输入使用。

有关安全命令中心 API 的其他所有信息,请参阅官方文档网站

安装和源代码

使用 cargo 安装命令行界面

cargo install google-securitycenter1-cli

GitHub 上找到源代码。

用法

此文档是根据修订版 20220224安全命令中心 API 生成的。CLI 版本为 3.1.0

securitycenter1 [options]
        folders
                assets-group <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                assets-list <parent> [-p <v>]... [-o <out>]
                assets-update-security-marks <name> (-r <kv>)... [-p <v>]... [-o <out>]
                big-query-exports-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                big-query-exports-delete <name> [-p <v>]... [-o <out>]
                big-query-exports-get <name> [-p <v>]... [-o <out>]
                big-query-exports-list <parent> [-p <v>]... [-o <out>]
                big-query-exports-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                findings-bulk-mute <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                mute-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                mute-configs-delete <name> [-p <v>]... [-o <out>]
                mute-configs-get <name> [-p <v>]... [-o <out>]
                mute-configs-list <parent> [-p <v>]... [-o <out>]
                mute-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-external-systems-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-group <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-list <parent> [-p <v>]... [-o <out>]
                sources-findings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-set-mute <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-set-state <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-update-security-marks <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-list <parent> [-p <v>]... [-o <out>]
        organizations
                assets-group <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                assets-list <parent> [-p <v>]... [-o <out>]
                assets-run-discovery <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                assets-update-security-marks <name> (-r <kv>)... [-p <v>]... [-o <out>]
                big-query-exports-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                big-query-exports-delete <name> [-p <v>]... [-o <out>]
                big-query-exports-get <name> [-p <v>]... [-o <out>]
                big-query-exports-list <parent> [-p <v>]... [-o <out>]
                big-query-exports-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                findings-bulk-mute <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                get-organization-settings <name> [-p <v>]... [-o <out>]
                mute-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                mute-configs-delete <name> [-p <v>]... [-o <out>]
                mute-configs-get <name> [-p <v>]... [-o <out>]
                mute-configs-list <parent> [-p <v>]... [-o <out>]
                mute-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                notification-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                notification-configs-delete <name> [-p <v>]... [-o <out>]
                notification-configs-get <name> [-p <v>]... [-o <out>]
                notification-configs-list <parent> [-p <v>]... [-o <out>]
                notification-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-cancel <name> [-p <v>]... [-o <out>]
                operations-delete <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
                sources-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-external-systems-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-group <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-list <parent> [-p <v>]... [-o <out>]
                sources-findings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-set-mute <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-set-state <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-update-security-marks <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-get <name> [-p <v>]... [-o <out>]
                sources-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-list <parent> [-p <v>]... [-o <out>]
                sources-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                update-organization-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                assets-group <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                assets-list <parent> [-p <v>]... [-o <out>]
                assets-update-security-marks <name> (-r <kv>)... [-p <v>]... [-o <out>]
                big-query-exports-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                big-query-exports-delete <name> [-p <v>]... [-o <out>]
                big-query-exports-get <name> [-p <v>]... [-o <out>]
                big-query-exports-list <parent> [-p <v>]... [-o <out>]
                big-query-exports-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                findings-bulk-mute <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                mute-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                mute-configs-delete <name> [-p <v>]... [-o <out>]
                mute-configs-get <name> [-p <v>]... [-o <out>]
                mute-configs-list <parent> [-p <v>]... [-o <out>]
                mute-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-external-systems-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-group <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-list <parent> [-p <v>]... [-o <out>]
                sources-findings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-set-mute <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-set-state <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-findings-update-security-marks <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sources-list <parent> [-p <v>]... [-o <out>]
  securitycenter1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在 ~/.google-service-cli 目录中的 JSON 文件中,文件名以 securitycenter1- 开头。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

以下段落中提供了有关各种类型持久数据的更多信息。

身份验证

大多数 API 需要用户对任何请求进行身份验证。如果是这种情况,则 作用域 确定了授予的权限集。这些权限的粒度通常不超过 只读完全访问

如果没有设置,系统将自动选择最小的可行作用域,例如,在调用只读方法时,它只会请求只读作用域。您可以使用 --scope 标志直接指定作用域。所有适用的作用域都在各自方法的 CLI 文档中有记录。

首次使用作用域时,用户会被请求权限。按照 CLI 提供的说明授予权限或拒绝。

如果用户验证了作用域,相关信息将被存储在配置目录中的JSON格式中,例如:~/.google-service-cli/securitycenter1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授予的认证,请参阅官方文档

应用程序密钥

为了允许任何应用程序使用Google服务,它需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用,并设有每日配额。

为了在不强制用户注册自己的应用程序的情况下,更方便地使用CLI,CLI自带了一个默认的应用程序密钥,并根据需要进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题:~/.google-service-cli/securitycenter1-secret.json,假设已为它启用了所需的securitycenter API。此类密钥文件可以从Google开发者控制台APIs & auth -> Credentials -> Download JSON中下载,并直接使用。

有关如何设置Google项目和使用API的更多信息,请参阅官方文档

调试

尽管CLI尽最大努力提供可用的错误消息,但有时了解导致特定问题的确切原因可能是有用的。这可以通过允许所有客户端服务器通信以原始方式输出到标准错误来实现。

使用--debug标志将在标准错误中打印错误,使用Debug表示法。

您可以考虑将标准错误重定向到文件,以便于使用,例如:securitycenter1 --debug <resource> <method> [options] 2>debug.txt

依赖关系

~18–33MB
~577K SLoC