6个稳定版本 (3个主要版本)

5.0.4+20240227 2024年3月5日
3.1.0+20220215 2022年4月26日
3.0.0+20220215 2022年3月8日
2.0.4+20210302 2021年4月15日
1.0.14+20200512 2020年7月10日

#2727 in 网络编程

Download history 7/week @ 2024-03-12 8/week @ 2024-03-26 32/week @ 2024-04-02

每月108次下载

MIT许可证

115KB
1.5K SLoC

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

默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接导向文件,而不受您的shell功能限制。错误将打印到标准错误,并导致程序退出代码非零。

如果请求数据结构,则这些数据结构将以美观打印的JSON格式返回,以便作为其他工具的输入。

有关verifiedaccess API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-verifiedaccess1-cli

GitHub上查找源代码

用法

本文档是根据修订版20240227verifiedaccess API生成的。CLI版本为5.0.4

verifiedaccess1 [options]
        challenge
                create (-r <kv>)... [-p <v>]... [-o <out>]
                verify (-r <kv>)... [-p <v>]... [-o <out>]
  verifiedaccess1 --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文件中,文件以verifiedaccess1-为前缀。您可以使用--config-dir标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,会提示用户获取权限。根据CLI的指示进行授权或拒绝。

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

要撤销授权的身份验证,请参阅官方文档

应用程序密钥

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

为了在不强制任何用户注册自己的应用程序的情况下更舒适地使用CLI,CLI自带默认的应用程序密钥,并相应地配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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

依赖关系

~20–31MB
~580K SLoC