12 个稳定版本 (3 个主要版本)
5.0.4+20240221 | 2024年3月5日 |
---|---|
3.1.0+20220225 | 2022年4月26日 |
3.0.0+20220225 | 2022年3月8日 |
2.0.4+20210326 | 2021年4月15日 |
1.0.8+20181004 | 2018年10月14日 |
#2561 在 网络编程
每月下载量 243 次
170KB
2K SLoC
该 iamcredentials1
命令行界面 (CLI) 允许您从终端舒适地使用 Google IAM 凭据服务的多数功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其直接定向到文件,而不受您的 shell 能力限制。错误将打印到标准错误,并导致程序退出代码非零。
如果请求数据结构,则将它们作为格式化的 JSON 返回,以供其他工具使用。
有关 IAM 凭据 API 的其他所有信息,请参阅 官方文档网站。
安装和源代码
使用 cargo 安装命令行界面:
cargo install google-iamcredentials1-cli
在 GitHub 上找到源代码。
用法
此文档是根据 IAM 凭据 API 的修订版 20240221 生成的。CLI 版本为 5.0.4。
iamcredentials1 [options]
projects
service-accounts-generate-access-token <name> (-r <kv>)... [-p <v>]... [-o <out>]
service-accounts-generate-id-token <name> (-r <kv>)... [-p <v>]... [-o <out>]
service-accounts-sign-blob <name> (-r <kv>)... [-p <v>]... [-o <out>]
service-accounts-sign-jwt <name> (-r <kv>)... [-p <v>]... [-o <out>]
iamcredentials1 --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 文件中,文件名以 iamcredentials1
开头。您可以使用 --config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落提供了有关各种持久数据的更多信息。
身份验证
大多数 API 需要用户对任何请求进行身份验证。如果是这种情况,作用域 确定了授予的权限集。这些的粒度通常不超过 只读 或 完全访问。
如果没有设置,系统将自动选择最小可行的范围,例如,当调用只读方法时,它将只请求只读范围。您可以使用 --scope
标志直接指定范围。所有适用的作用域都在相应方法的 CLI 文档中进行了记录。
第一次使用作用域时,系统会请求用户授权。按照CLI的指示进行授权或拒绝。
如果用户已经验证了作用域,相应的信息将被存储在配置目录中,格式为JSON,例如~/.google-service-cli/iamcredentials1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用,并设有每日配额。
为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI,CLI附带了一个默认的应用程序密钥,并进行相应的配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。
您可以通过将自定义密钥文件放在此位置来解决这个问题:~/.google-service-cli/iamcredentials1-secret.json
,前提是已为它启用了所需的iamcredentials API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON部分下载,并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误消息,但有时可能希望知道导致特定问题的确切原因。这是通过允许将所有客户端-服务器通信输出到标准错误原始形式来实现的。
使用--debug
标志将错误以Debug
表示形式打印到标准错误。
您可以将标准错误重定向到文件中以便于使用,例如iamcredentials1 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–31MB
~577K SLoC