#google-api #google #cli #privateca #command-line-interface

app google-privateca1_beta1-cli

与证书授权服务(协议 v1beta1)交互的完整库

6 个稳定版本

5.0.4+20240221 2024 年 3 月 5 日
3.1.0+20220209 2022 年 4 月 26 日
3.0.0+20220209 2022 年 3 月 8 日
2.0.4+20210322 2021 年 4 月 15 日

#2572 in 网络编程

Download history 22/week @ 2024-03-09 1/week @ 2024-03-16 49/week @ 2024-03-30 10/week @ 2024-04-06 1/week @ 2024-05-18

每月 105 次下载

MIT 许可证

405KB
5K SLoC

privateca1-beta1 命令行界面(CLI)允许您从终端舒适地使用大多数 Google 证书授权服务(Certificate Authority Service)功能。

默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其定向到与您的 shell 功能无关的文件。错误将打印到标准错误,并导致程序的退出代码不为零。

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

有关证书授权服务(Certificate Authority Service)API 的其他信息,请参阅官方文档网站

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-privateca1_beta1-cli

GitHub 上查找源代码。

用法

本文档是从修订版 20240221证书授权服务(Certificate Authority Service)API 生成的。CLI 版本为 5.0.4

privateca1-beta1 [options]
        projects
                locations-certificate-authorities-certificate-revocation-lists-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-certificate-authorities-certificate-revocation-lists-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-certificate-authorities-certificate-revocation-lists-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-certificate-authorities-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-certificate-authorities-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-certificate-authorities-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-reusable-configs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-reusable-configs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-reusable-configs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  privateca1-beta1 --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 文件中,文件名以 privateca1-beta1- 开头。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

当首次使用作用域时,系统会请求用户授权。根据命令行界面(CLI)的指示进行授权或拒绝。

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

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

应用程序密钥

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

为了在不强制任何人注册自己的应用程序的情况下更方便地使用CLI,CLI包含一个默认的应用程序密钥,并相应地进行配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题:~/.google-service-cli/privateca1-beta1-secret.json,前提是该应用程序已启用了所需的privateca API。此类密钥文件可以在Google开发者控制台APIs & auth -> Credentials -> Download JSON中下载,并直接使用。

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

调试

尽管CLI尽可能提供可用的错误消息,但有时可能需要知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原样输出到标准错误来完成的。

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

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

依赖关系

~20–31MB
~583K SLoC