#google #cli #google-api #playintegrity

app google-playintegrity1-cli

用于与Play Integrity(协议v1)交互的完整库

2个稳定版本

5.0.4+20240304 2024年3月5日
3.1.0+20220305 2022年4月26日

#2780 in 网络编程

27每月下载量

MIT许可证

105KB
1.5K SLoC

playintegrity1 命令行接口(CLI)允许您从终端舒适地使用Google Play Integrity服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行接口:

cargo install google-playintegrity1-cli

GitHub上找到源代码

用法

本文档是根据版本号为20240304的Play Integrity API生成的。CLI版本为5.0.4

playintegrity1 [options]
        methods
                decode-integrity-token <package-name> (-r <kv>)... [-p <v>]... [-o <out>]
  playintegrity1 --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文件中,文件名以playintegrity1-为前缀。您可以使用--config-dir标志在每个调用基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~581K SLoC