Safe Browsing API . fullHashes

Instance Methods

close()

Close httplib2 connections.

find(body=None, x__xgafv=None)

Finds the full hashes that match the requested hash prefixes.

Method Details

close()
Close httplib2 connections.
find(body=None, x__xgafv=None)
Finds the full hashes that match the requested hash prefixes.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request to return full hashes matched by the provided hash prefixes.
  "apiClient": { # The client metadata associated with Safe Browsing API requests. # Client metadata associated with callers of higher-level APIs built on top of the client's implementation.
    "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
    "clientVersion": "A String", # The version of the client implementation.
  },
  "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
    "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
    "clientVersion": "A String", # The version of the client implementation.
  },
  "clientStates": [ # The current client states for each of the client's local threat lists.
    "A String",
  ],
  "threatInfo": { # The information regarding one or more threats that a client submits when checking for matches in threat lists. # The lists and hashes to be checked.
    "platformTypes": [ # The platform types to be checked.
      "A String",
    ],
    "threatEntries": [ # The threat entries to be checked.
      { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.
        "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.
        "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
        "url": "A String", # A URL.
      },
    ],
    "threatEntryTypes": [ # The entry types to be checked.
      "A String",
    ],
    "threatTypes": [ # The threat types to be checked.
      "A String",
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "matches": [ # The full hashes that matched the requested prefixes.
    { # A match when checking a threat entry in the Safe Browsing threat lists.
      "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.
      "platformType": "A String", # The platform type matching this threat.
      "threat": { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. # The threat matching this threat.
        "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.
        "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
        "url": "A String", # A URL.
      },
      "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type. # Optional metadata associated with this threat.
        "entries": [ # The metadata entries.
          { # A single metadata entry.
            "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
            "value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
          },
        ],
      },
      "threatEntryType": "A String", # The threat entry type matching this threat.
      "threatType": "A String", # The threat type matching this threat.
    },
  ],
  "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want.
  "negativeCacheDuration": "A String", # For requested entities that did not match the threat list, how long to cache the response.
}