#google #cli #google-api #firebase-app-check

app google-firebaseappcheck1_beta-cli

用于与 Firebaseappcheck(协议 v1beta)交互的完整库

3 个稳定版本

5.0.4+20240226 2024 年 3 月 5 日
3.1.0+20220225 2022 年 4 月 26 日
3.0.0+20220225 2022 年 3 月 8 日

#2603网络编程

每月下载 47 次

MIT 许可证

1.5MB
16K SLoC

firebaseappcheck1-beta 命令行界面(CLI)允许您在终端中舒适地使用 Google Firebaseappcheck 服务的大部分功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-firebaseappcheck1_beta-cli

GitHub 上查找源代码。

用法

本文档是根据 Firebaseappcheck API 在 20240226 版本中生成的。CLI 的版本为 5.0.4

firebaseappcheck1-beta [options]
        jwks
                get <name> [-p <v>]... [-o <out>]
        oauth-clients
                exchange-app-attest-assertion <app> (-r <kv>)... [-p <v>]... [-o <out>]
                exchange-app-attest-attestation <app> (-r <kv>)... [-p <v>]... [-o <out>]
                exchange-debug-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                generate-app-attest-challenge <app> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                apps-app-attest-config-batch-get <parent> [-p <v>]... [-o <out>]
                apps-app-attest-config-get <name> [-p <v>]... [-o <out>]
                apps-app-attest-config-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-debug-tokens-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-debug-tokens-delete <name> [-p <v>]... [-o <out>]
                apps-debug-tokens-get <name> [-p <v>]... [-o <out>]
                apps-debug-tokens-list <parent> [-p <v>]... [-o <out>]
                apps-debug-tokens-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-device-check-config-batch-get <parent> [-p <v>]... [-o <out>]
                apps-device-check-config-get <name> [-p <v>]... [-o <out>]
                apps-device-check-config-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-app-attest-assertion <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-app-attest-attestation <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-custom-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-debug-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-device-check-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-play-integrity-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-recaptcha-enterprise-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-recaptcha-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-recaptcha-v3-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-exchange-safety-net-token <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-generate-app-attest-challenge <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-generate-play-integrity-challenge <app> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-play-integrity-config-batch-get <parent> [-p <v>]... [-o <out>]
                apps-play-integrity-config-get <name> [-p <v>]... [-o <out>]
                apps-play-integrity-config-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-recaptcha-config-batch-get <parent> [-p <v>]... [-o <out>]
                apps-recaptcha-config-get <name> [-p <v>]... [-o <out>]
                apps-recaptcha-config-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-recaptcha-enterprise-config-batch-get <parent> [-p <v>]... [-o <out>]
                apps-recaptcha-enterprise-config-get <name> [-p <v>]... [-o <out>]
                apps-recaptcha-enterprise-config-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-recaptcha-v3-config-batch-get <parent> [-p <v>]... [-o <out>]
                apps-recaptcha-v3-config-get <name> [-p <v>]... [-o <out>]
                apps-recaptcha-v3-config-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                apps-safety-net-config-batch-get <parent> [-p <v>]... [-o <out>]
                apps-safety-net-config-get <name> [-p <v>]... [-o <out>]
                apps-safety-net-config-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                services-batch-update <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                services-get <name> [-p <v>]... [-o <out>]
                services-list <parent> [-p <v>]... [-o <out>]
                services-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                services-resource-policies-batch-update <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                services-resource-policies-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                services-resource-policies-delete <name> [-p <v>]... [-o <out>]
                services-resource-policies-get <name> [-p <v>]... [-o <out>]
                services-resource-policies-list <parent> [-p <v>]... [-o <out>]
                services-resource-policies-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                verify-app-check-token <project> (-r <kv>)... [-p <v>]... [-o <out>]
  firebaseappcheck1-beta --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 文件中,这些文件以 firebaseappcheck1-beta- 为前缀。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息,请参阅以下段落。

身份验证

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

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

首次使用作用域时,系统会提示用户授权。按照 CLI 给出的说明授权或拒绝授权。

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

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

应用程序密钥

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

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

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

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

调试

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

--debug标志将以Debug表示形式将错误打印到标准错误。

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

依赖关系

~19–32MB
~583K SLoC