safebrowsing4 命令行界面（CLI）允许您在终端中方便地使用 Google Safebrowsing 服务的大部分功能。

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

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

关于 Safebrowsing API 的其他所有信息都可以在 官方文档网站 找到。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-safebrowsing4-cli

在 GitHub 上找到源代码。

用法

本文档是从修订版本 20220305 的 Safebrowsing API 生成的。CLI 版本为 3.1.0。

safebrowsing4 [options]
        encoded-full-hashes
                get <encoded-request> [-p <v>]... [-o <out>]
        encoded-updates
                get <encoded-request> [-p <v>]... [-o <out>]
        full-hashes
                find (-r <kv>)... [-p <v>]... [-o <out>]
        threat-hits
                create (-r <kv>)... [-p <v>]... [-o <out>]
        threat-list-updates
                fetch (-r <kv>)... [-p <v>]... [-o <out>]
        threat-lists
                list [-p <v>]... [-o <out>]
        threat-matches
                find (-r <kv>)... [-p <v>]... [-o <out>]
  safebrowsing4 --help

Configuration:
  --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 文件中，文件名以 safebrowsing4- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，会提示用户授权。根据CLI的说明授权或拒绝。

如果用户认证了范围，相应的信息将以JSON格式存储在配置目录中，例如~/.google-service-cli/safebrowsing4-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授予的认证，请参阅官方文档。

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件，以便于使用，例如safebrowsing4 --debug <资源> <方法> [选项] 2>debug.txt。