REST Resource: hashList

资源：HashList

由其名称标识的哈希列表。

JSON 表示法 
{
  "name": string,
  "version": string,
  "partialUpdate": boolean,
  "compressedRemovals": {
    object (RiceDeltaEncoded32Bit)
  },
  "minimumWaitDuration": string,
  "metadata": {
    object (HashListMetadata)
  },

  // Union field compressed_additions can be only one of the following:
  "additionsFourBytes": {
    object (RiceDeltaEncoded32Bit)
  },
  "additionsEightBytes": {
    object (RiceDeltaEncoded64Bit)
  },
  "additionsSixteenBytes": {
    object (RiceDeltaEncoded128Bit)
  },
  "additionsThirtyTwoBytes": {
    object (RiceDeltaEncoded256Bit)
  }
  // End of list of possible types for union field compressed_additions.

  // Union field checksum can be only one of the following:
  "sha256Checksum": string
  // End of list of possible types for union field checksum.
}
字段
name

string

哈希列表的名称。请注意，全局缓存也只是哈希列表，在此处可以引用。
version

string (bytes format)

哈希列表的版本。客户端不得操纵这些字节。

使用 base64 编码的字符串。
partialUpdate

boolean

如果为 true，则是部分差异，其中包含根据客户端已有的内容添加和移除的内容。如果为 false，这是完整的哈希列表。

如果为 false，客户端必须删除此哈希列表的任何本地存储版本。这意味着客户端拥有的版本严重已过时或客户端数据已损坏。compressedRemovals 字段将为空。

如果为 true，客户端必须先应用移除，然后再应用添加，从而应用增量更新。
compressedRemovals

object (RiceDeltaEncoded32Bit)

移除索引的 Rice-delta 编码版本。由于每个哈希列表包含的条目都少于 2^32 个，因此索引将被视为 32 位整数并进行编码。
minimumWaitDuration

string (Duration format)

客户端应等待至少此时长才能再次获取哈希列表。如果省略或为零，客户端应立即提取，因为这表明服务器有其他要发送给客户端的更新，但由于客户端指定的约束而无法发送。

此时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
metadata

object (HashListMetadata)

关于哈希列表的元数据。它不是由 hashList.get 方法填充的，而是由 ListHashLists 方法填充。
联合字段 compressed_additions。加法的 Rice-delta 编码版本。添加到列表中的所有添加项的哈希前缀长度都是相同的。该值可以是客户端发送的 desired_hash_length，也可以是服务器选择的值（如果客户端省略了该字段）。compressed_additions 只能是下列其中一项：
additionsFourBytes

object (RiceDeltaEncoded32Bit)

4 字节附加内容。
additionsEightBytes

object (RiceDeltaEncoded64Bit)

8 字节附加内容。
additionsSixteenBytes

object (RiceDeltaEncoded128Bit)

增加的 16 个字节。
additionsThirtyTwoBytes

object (RiceDeltaEncoded256Bit)

添加 32 个字节。
联合字段 checksum。这是应用提供的更新后，数据库中存在的所有哈希的排序列表的校验和。此字段是“oneof”字段，允许多种哈希算法。服务器也可以省略此字段（在未提供更新的情况下），以指示客户端应使用现有的校验和。checksum 只能是下列其中一项：
sha256Checksum

string (bytes format)

已排序的所有哈希列表，使用 SHA256 再次进行哈希处理。

使用 base64 编码的字符串。

RiceDeltaEncoded32 位

Rice-Golomb 编码数据。用于哈希或移除索引。可以保证此处的每个哈希或索引都具有相同的长度，并且该长度正好为 32 位。

一般来说，如果我们按字典顺序对所有条目进行排序，会发现高阶位的变化频率不会像低阶位那样频繁。这意味着，如果我们加上条目之间的相邻差值，则高阶位很有可能为零。这种方法从本质上选择了特定数量的位，从而利用了这种高的零概率；所有比该数量更高的有效位都可能为零，因此我们使用一元编码。请参阅 riceParameter 字段。

历史说明：Rice-delta 编码首次在此 API 的 V4 中使用。在 V5 中进行了两项重大改进：首先，现在可使用超过 4 个字节的哈希前缀使用 Rice-delta 编码；其次，现在将编码数据作为大端字节序处理，以避免开销高的排序步骤。

JSON 表示法 
{
  "firstValue": integer,
  "riceParameter": integer,
  "entriesCount": integer,
  "encodedData": string
}
字段
firstValue

integer (uint32 format)

编码数据中的第一个条目（哈希或索引）；或者，如果只对单个哈希前缀或索引进行了编码，则值为该条目的值。如果该字段为空，则该条目为零。
riceParameter

integer

Golomb-Rice 参数。此参数必须介于 3 和 30 之间（含 3 和 30）。
entriesCount

integer

编码数据中经过增量编码的条目数。如果只对一个整数进行编码，此值将为 0，并且该单个值将存储在 firstValue 中。
encodedData

string (bytes format)

使用 Golomb-Rice 编码器编码的已编码增量。

使用 base64 编码的字符串。

RiceDeltaEncoded64 位

与 RiceDeltaEncoded32Bit 相同，不过它会对 64 位数字进行编码。

JSON 表示法 
{
  "firstValue": string,
  "riceParameter": integer,
  "entriesCount": integer,
  "encodedData": string
}
字段
firstValue

string

编码数据中的第一个条目（哈希）或该条目的值（如果只编码了一个哈希前缀）。如果该字段为空，则该条目为零。
riceParameter

integer

Golomb-Rice 参数。此参数必须介于 35 和 62 之间（含 35 和 62）。
entriesCount

integer

编码数据中经过增量编码的条目数。如果只对一个整数进行编码，此值将为 0，并且该单个值将存储在 firstValue 中。
encodedData

string (bytes format)

使用 Golomb-Rice 编码器编码的已编码增量。

使用 base64 编码的字符串。

RiceDelta 编码 128 位

与 RiceDeltaEncoded32Bit 相同，不过它会对 128 位数字进行编码。

JSON 表示法 
{
  "firstValueHi": string,
  "firstValueLo": string,
  "riceParameter": integer,
  "entriesCount": integer,
  "encodedData": string
}
字段
firstValueHi

string

编码数据中第一个条目的高 64 位（哈希）。如果该字段为空，则上限 64 位全部为零。
firstValueLo

string (uint64 format)

编码数据中第一个条目的低 64 位（哈希）。如果该字段为空，则低 64 位全部为零。
riceParameter

integer

Golomb-Rice 参数。此参数应介于 99 和 126 之间（含 99 和 126）。
entriesCount

integer

编码数据中经过增量编码的条目数。如果只对一个整数进行编码，此值将为 0，并且该单个值将存储在 firstValue 中。
encodedData

string (bytes format)

使用 Golomb-Rice 编码器编码的已编码增量。

使用 base64 编码的字符串。

RiceDelta 编码 256 位

与 RiceDeltaEncoded32Bit 相同，不过它会对 256 位数字进行编码。

JSON 表示法 
{
  "firstValueFirstPart": string,
  "firstValueSecondPart": string,
  "firstValueThirdPart": string,
  "firstValueFourthPart": string,
  "riceParameter": integer,
  "entriesCount": integer,
  "encodedData": string
}
字段
firstValueFirstPart

string

编码数据中第一个条目的前 64 位（哈希）。如果该字段为空，则前 64 位全部为零。
firstValueSecondPart

string (uint64 format)

编码数据中第一个条目的 65 到 128 位（哈希）。如果该字段为空，则第 65 位到第 128 位都为零。
firstValueThirdPart

string (uint64 format)

编码数据中第一个条目的 129 到 192 位（哈希）。如果该字段为空，则第 129 位到第 192 位都为零。
firstValueFourthPart

string (uint64 format)

编码数据中第一个条目的最后 64 位（哈希）。如果该字段为空，则最后 64 位全部为零。
riceParameter

integer

Golomb-Rice 参数。此参数应介于 227 和 254 之间（含 227 和 254）。
entriesCount

integer

编码数据中经过增量编码的条目数。如果只对一个整数进行编码，此值将为 0，并且该单个值将存储在 firstValue 中。
encodedData

string (bytes format)

使用 Golomb-Rice 编码器编码的已编码增量。

使用 base64 编码的字符串。

HashListMetadata

关于特定哈希列表的元数据。

JSON 表示法 
{
  "threatTypes": [
    enum (ThreatType)
  ],
  "likelySafeTypes": [
    enum (LikelySafeType)
  ],
  "mobileOptimized": boolean,
  "description": string,
  "supportedHashLengths": [
    enum (HashLength)
  ]
}
字段
threatTypes[]

enum (ThreatType)

无序列表。如果不为空，则表示该哈希列表是一种威胁列表，并且枚举与此哈希列表中的哈希或哈希前缀关联的威胁类型。如果相应条目不表示威胁（即在它表示可能的安全类型时），则此字段可能为空。
likelySafeTypes[]

enum (LikelySafeType)

无序列表。如果不为空，则表示哈希列表表示一个可能安全的哈希列表，并且枚举了这些哈希可能被认为安全的方式。此字段与 threatTypes 字段互斥。
mobileOptimized

boolean

是否针对移动设备（Android 和 iOS）优化了此列表。
description

string

关于此列表的人类可读说明。所用语言为英文。
supportedHashLengths[]

enum (HashLength)

此哈希列表支持的哈希长度。每个哈希列表至少支持一种长度。因此，此字段不能为空。

ThreatType

威胁类型。

枚举
THREAT_TYPE_UNSPECIFIED 未知威胁类型。如果服务器返回此错误代码，则客户端应完全忽略外围的 FullHashDetail。
MALWARE

恶意软件威胁类型。恶意软件是指符合以下特征的所有软件或移动应用：蓄意危害计算机、移动设备、计算机/移动设备上运行的软件或计算机/移动设备用户。恶意软件会表现出各种恶意行为，其中包括：未经用户同意就擅自安装软件，以及安装病毒等有害软件。

如需了解详情，请参阅此处。
SOCIAL_ENGINEERING

社会工程学威胁类型。社交工程页面会谎称代表第三方行事，意图混淆观看者做出某种行为，而观看者只会相信第三方的真正代理人。钓鱼式攻击是一种社会工程学攻击，它会诱使观看者执行提供信息（例如登录凭据）的具体操作。

如需了解详情，请参阅此处。
UNWANTED_SOFTWARE 垃圾软件威胁类型。垃圾软件是指任何不符合 Google 软件准则但不属于恶意软件的软件。
POTENTIALLY_HARMFUL_APPLICATION Google Play 保护机制针对 Play 商店使用的潜在有害应用威胁类型。

LikelySafeType

可能安全的网站的类型。

请注意，SearchHashesResponse 有意不包含 LikelySafeType。

枚举
LIKELY_SAFE_TYPE_UNSPECIFIED 未知。
GENERAL_BROWSING 此网站可能足以进行一般浏览。这也称为全局缓存。
CSD 该网站很可能足够安全，因此无需运行客户端检测模型或密码保护检查。
DOWNLOAD 该网站很可能足够安全，因此无需检查从该网站下载内容。

HashLength

哈希列表中的哈希长度。

枚举
HASH_LENGTH_UNSPECIFIED 未指定长度。服务器不会在响应客户端时返回此值（在 supportedHashLengths 字段中），但允许客户端向服务器发送此值（在 desiredHashLength 字段中），在这种情况下，服务器会自动选择一个值。客户端应允许服务器选择值。
FOUR_BYTES 每个哈希都是四字节前缀。
EIGHT_BYTES 每个哈希都是 8 字节的前缀。
SIXTEEN_BYTES 每个哈希都是 16 字节的前缀。
THIRTY_TWO_BYTES 每个哈希都是 32 字节的完整哈希。

方法

get

 获取哈希列表的最新内容。