| Index: discovery/googleapis/safebrowsing__v4.json
|
| diff --git a/discovery/googleapis/safebrowsing__v4.json b/discovery/googleapis/safebrowsing__v4.json
|
| index c199f1e980dab454e7f394a50486d46665556275..2e606882d83ed68f433c14e8757c67580d10bb0d 100644
|
| --- a/discovery/googleapis/safebrowsing__v4.json
|
| +++ b/discovery/googleapis/safebrowsing__v4.json
|
| @@ -15,37 +15,6 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "quotaUser": {
|
| - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "upload_protocol": {
|
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| "location": "query",
|
| @@ -67,6 +36,11 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "callback": {
|
| + "description": "JSONP",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "$.xgafv": {
|
| "description": "V1 error format.",
|
| "enum": [
|
| @@ -80,11 +54,6 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "callback": {
|
| - "description": "JSONP",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| @@ -100,43 +69,41 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| + },
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "quotaUser": {
|
| + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| "resources": {
|
| - "threatLists": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "Lists the Safe Browsing threat lists available for download.",
|
| - "httpMethod": "GET",
|
| - "id": "safebrowsing.threatLists.list",
|
| - "parameterOrder": [],
|
| - "parameters": {},
|
| - "path": "v4/threatLists",
|
| - "response": {
|
| - "$ref": "ListThreatListsResponse"
|
| - }
|
| - }
|
| - }
|
| - },
|
| - "threatMatches": {
|
| - "methods": {
|
| - "find": {
|
| - "description": "Finds the threat entries that match the Safe Browsing lists.",
|
| - "httpMethod": "POST",
|
| - "id": "safebrowsing.threatMatches.find",
|
| - "parameterOrder": [],
|
| - "parameters": {},
|
| - "path": "v4/threatMatches:find",
|
| - "request": {
|
| - "$ref": "FindThreatMatchesRequest"
|
| - },
|
| - "response": {
|
| - "$ref": "FindThreatMatchesResponse"
|
| - }
|
| - }
|
| - }
|
| - },
|
| "fullHashes": {
|
| "methods": {
|
| "find": {
|
| @@ -218,6 +185,13 @@
|
| "encodedRequest"
|
| ],
|
| "parameters": {
|
| + "encodedRequest": {
|
| + "description": "A serialized FindFullHashesRequest proto.",
|
| + "format": "byte",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| "clientId": {
|
| "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
|
| "location": "query",
|
| @@ -227,13 +201,6 @@
|
| "description": "The version of the client implementation.",
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "encodedRequest": {
|
| - "description": "A serialized FindFullHashesRequest proto.",
|
| - "format": "byte",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v4/encodedFullHashes/{encodedRequest}",
|
| @@ -242,185 +209,116 @@
|
| }
|
| }
|
| }
|
| + },
|
| + "threatLists": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Lists the Safe Browsing threat lists available for download.",
|
| + "httpMethod": "GET",
|
| + "id": "safebrowsing.threatLists.list",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v4/threatLists",
|
| + "response": {
|
| + "$ref": "ListThreatListsResponse"
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "threatMatches": {
|
| + "methods": {
|
| + "find": {
|
| + "description": "Finds the threat entries that match the Safe Browsing lists.",
|
| + "httpMethod": "POST",
|
| + "id": "safebrowsing.threatMatches.find",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v4/threatMatches:find",
|
| + "request": {
|
| + "$ref": "FindThreatMatchesRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "FindThreatMatchesResponse"
|
| + }
|
| + }
|
| + }
|
| }
|
| },
|
| - "revision": "20170319",
|
| + "revision": "20170404",
|
| "rootUrl": "https://safebrowsing.googleapis.com/",
|
| "schemas": {
|
| - "ThreatEntryMetadata": {
|
| - "description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.",
|
| - "id": "ThreatEntryMetadata",
|
| - "properties": {
|
| - "entries": {
|
| - "description": "The metadata entries.",
|
| - "items": {
|
| - "$ref": "MetadataEntry"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "RawIndices": {
|
| - "description": "A set of raw indices to remove from a local list.",
|
| - "id": "RawIndices",
|
| + "FetchThreatListUpdatesRequest": {
|
| + "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5",
|
| + "id": "FetchThreatListUpdatesRequest",
|
| "properties": {
|
| - "indices": {
|
| - "description": "The indices to remove from a lexicographically-sorted local list.",
|
| + "listUpdateRequests": {
|
| + "description": "The requested threat list updates.",
|
| "items": {
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "$ref": "ListUpdateRequest"
|
| },
|
| "type": "array"
|
| + },
|
| + "client": {
|
| + "$ref": "ClientInfo",
|
| + "description": "The client metadata."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "RawHashes": {
|
| - "description": "The uncompressed threat entries in hash format of a particular prefix length.\nHashes can be anywhere from 4 to 32 bytes in size. A large majority are 4\nbytes, but some hashes are lengthened if they collide with the hash of a\npopular URL.\n\nUsed for sending ThreatEntrySet to clients that do not support compression,\nor when sending non-4-byte hashes to clients that do support compression.",
|
| - "id": "RawHashes",
|
| + "ListUpdateResponse": {
|
| + "description": "An update to an individual list.",
|
| + "id": "ListUpdateResponse",
|
| "properties": {
|
| - "prefixSize": {
|
| - "description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "checksum": {
|
| + "$ref": "Checksum",
|
| + "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
|
| },
|
| - "rawHashes": {
|
| - "description": "The hashes, in binary format, concatenated into one long string. Hashes are\nsorted in lexicographic order. For JSON API users, hashes are\nbase64-encoded.",
|
| - "format": "byte",
|
| + "responseType": {
|
| + "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
|
| + "enum": [
|
| + "RESPONSE_TYPE_UNSPECIFIED",
|
| + "PARTIAL_UPDATE",
|
| + "FULL_UPDATE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unknown.",
|
| + "Partial updates are applied to the client's existing local database.",
|
| + "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
|
| + ],
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "FetchThreatListUpdatesResponse": {
|
| - "id": "FetchThreatListUpdatesResponse",
|
| - "properties": {
|
| - "listUpdateResponses": {
|
| - "description": "The list updates requested by the clients.",
|
| + },
|
| + "threatType": {
|
| + "description": "The threat type for which data is returned.",
|
| + "enum": [
|
| + "THREAT_TYPE_UNSPECIFIED",
|
| + "MALWARE",
|
| + "SOCIAL_ENGINEERING",
|
| + "UNWANTED_SOFTWARE",
|
| + "POTENTIALLY_HARMFUL_APPLICATION"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unknown.",
|
| + "Malware threat type.",
|
| + "Social engineering threat type.",
|
| + "Unwanted software threat type.",
|
| + "Potentially harmful application threat type."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "removals": {
|
| + "description": "A set of entries to remove from a local threat type's list. In practice,\nthis field is empty or contains exactly one ThreatEntrySet.",
|
| "items": {
|
| - "$ref": "ListUpdateResponse"
|
| + "$ref": "ThreatEntrySet"
|
| },
|
| "type": "array"
|
| },
|
| - "minimumWaitDuration": {
|
| - "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
|
| - "format": "google-duration",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Checksum": {
|
| - "description": "The expected state of a client's local database.",
|
| - "id": "Checksum",
|
| - "properties": {
|
| - "sha256": {
|
| - "description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.",
|
| - "format": "byte",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "FindFullHashesResponse": {
|
| - "id": "FindFullHashesResponse",
|
| - "properties": {
|
| - "minimumWaitDuration": {
|
| - "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
|
| - "format": "google-duration",
|
| - "type": "string"
|
| - },
|
| - "matches": {
|
| - "description": "The full hashes that matched the requested prefixes.",
|
| - "items": {
|
| - "$ref": "ThreatMatch"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "negativeCacheDuration": {
|
| - "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
|
| - "format": "google-duration",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ThreatEntrySet": {
|
| - "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
|
| - "id": "ThreatEntrySet",
|
| - "properties": {
|
| - "compressionType": {
|
| - "description": "The compression type for the entries in this set.",
|
| - "enum": [
|
| - "COMPRESSION_TYPE_UNSPECIFIED",
|
| - "RAW",
|
| - "RICE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unknown.",
|
| - "Raw, uncompressed data.",
|
| - "Rice-Golomb encoded data."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "riceIndices": {
|
| - "$ref": "RiceDeltaEncoding",
|
| - "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data."
|
| - },
|
| - "rawIndices": {
|
| - "$ref": "RawIndices",
|
| - "description": "The raw removal indices for a local list."
|
| - },
|
| - "rawHashes": {
|
| - "$ref": "RawHashes",
|
| - "description": "The raw SHA256-formatted entries."
|
| - },
|
| - "riceHashes": {
|
| - "$ref": "RiceDeltaEncoding",
|
| - "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "FindFullHashesRequest": {
|
| - "description": "Request to return full hashes matched by the provided hash prefixes.",
|
| - "id": "FindFullHashesRequest",
|
| - "properties": {
|
| - "client": {
|
| - "$ref": "ClientInfo",
|
| - "description": "The client metadata."
|
| - },
|
| - "threatInfo": {
|
| - "$ref": "ThreatInfo",
|
| - "description": "The lists and hashes to be checked."
|
| - },
|
| - "apiClient": {
|
| - "$ref": "ClientInfo",
|
| - "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
|
| - },
|
| - "clientStates": {
|
| - "description": "The current client states for each of the client's local threat lists.",
|
| - "items": {
|
| - "format": "byte",
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListUpdateRequest": {
|
| - "description": "A single list update request.",
|
| - "id": "ListUpdateRequest",
|
| - "properties": {
|
| - "state": {
|
| - "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
|
| - "format": "byte",
|
| + "newClientState": {
|
| + "description": "The new client state, in encrypted format. Opaque to clients.",
|
| + "format": "byte",
|
| "type": "string"
|
| },
|
| "platformType": {
|
| - "description": "The type of platform at risk by entries present in the list.",
|
| + "description": "The platform type for which data is returned.",
|
| "enum": [
|
| "PLATFORM_TYPE_UNSPECIFIED",
|
| "WINDOWS",
|
| @@ -445,30 +343,8 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "threatType": {
|
| - "description": "The type of threat posed by entries present in the list.",
|
| - "enum": [
|
| - "THREAT_TYPE_UNSPECIFIED",
|
| - "MALWARE",
|
| - "SOCIAL_ENGINEERING",
|
| - "UNWANTED_SOFTWARE",
|
| - "POTENTIALLY_HARMFUL_APPLICATION"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unknown.",
|
| - "Malware threat type.",
|
| - "Social engineering threat type.",
|
| - "Unwanted software threat type.",
|
| - "Potentially harmful application threat type."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "constraints": {
|
| - "$ref": "Constraints",
|
| - "description": "The constraints associated with this request."
|
| - },
|
| "threatEntryType": {
|
| - "description": "The types of entries present in the list.",
|
| + "description": "The format of the threats.",
|
| "enum": [
|
| "THREAT_ENTRY_TYPE_UNSPECIFIED",
|
| "URL",
|
| @@ -488,34 +364,92 @@
|
| "CERT"
|
| ],
|
| "type": "string"
|
| + },
|
| + "additions": {
|
| + "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
|
| + "items": {
|
| + "$ref": "ThreatEntrySet"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "FetchThreatListUpdatesRequest": {
|
| - "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5",
|
| - "id": "FetchThreatListUpdatesRequest",
|
| + "Constraints": {
|
| + "description": "The constraints for this update.",
|
| + "id": "Constraints",
|
| "properties": {
|
| - "listUpdateRequests": {
|
| - "description": "The requested threat list updates.",
|
| + "supportedCompressions": {
|
| + "description": "The compression types supported by the client.",
|
| + "enumDescriptions": [
|
| + "Unknown.",
|
| + "Raw, uncompressed data.",
|
| + "Rice-Golomb encoded data."
|
| + ],
|
| "items": {
|
| - "$ref": "ListUpdateRequest"
|
| + "enum": [
|
| + "COMPRESSION_TYPE_UNSPECIFIED",
|
| + "RAW",
|
| + "RICE"
|
| + ],
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "client": {
|
| - "$ref": "ClientInfo",
|
| - "description": "The client metadata."
|
| + "maxUpdateEntries": {
|
| + "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "maxDatabaseEntries": {
|
| + "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "region": {
|
| + "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListUpdateResponse": {
|
| - "description": "An update to an individual list.",
|
| - "id": "ListUpdateResponse",
|
| + "ThreatMatch": {
|
| + "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
|
| + "id": "ThreatMatch",
|
| "properties": {
|
| + "cacheDuration": {
|
| + "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
|
| + "format": "google-duration",
|
| + "type": "string"
|
| + },
|
| + "threatEntryMetadata": {
|
| + "$ref": "ThreatEntryMetadata",
|
| + "description": "Optional metadata associated with this threat."
|
| + },
|
| + "threatType": {
|
| + "description": "The threat type matching this threat.",
|
| + "enum": [
|
| + "THREAT_TYPE_UNSPECIFIED",
|
| + "MALWARE",
|
| + "SOCIAL_ENGINEERING",
|
| + "UNWANTED_SOFTWARE",
|
| + "POTENTIALLY_HARMFUL_APPLICATION"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unknown.",
|
| + "Malware threat type.",
|
| + "Social engineering threat type.",
|
| + "Unwanted software threat type.",
|
| + "Potentially harmful application threat type."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "threat": {
|
| + "$ref": "ThreatEntry",
|
| + "description": "The threat matching this threat."
|
| + },
|
| "platformType": {
|
| - "description": "The platform type for which data is returned.",
|
| + "description": "The platform type matching this threat.",
|
| "enum": [
|
| "PLATFORM_TYPE_UNSPECIFIED",
|
| "WINDOWS",
|
| @@ -541,7 +475,7 @@
|
| "type": "string"
|
| },
|
| "threatEntryType": {
|
| - "description": "The format of the threats.",
|
| + "description": "The threat entry type matching this threat.",
|
| "enum": [
|
| "THREAT_ENTRY_TYPE_UNSPECIFIED",
|
| "URL",
|
| @@ -561,225 +495,67 @@
|
| "CERT"
|
| ],
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "RiceDeltaEncoding": {
|
| + "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
|
| + "id": "RiceDeltaEncoding",
|
| + "properties": {
|
| + "firstValue": {
|
| + "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| - "additions": {
|
| - "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
|
| + "encodedData": {
|
| + "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "numEntries": {
|
| + "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "riceParameter": {
|
| + "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListThreatListsResponse": {
|
| + "id": "ListThreatListsResponse",
|
| + "properties": {
|
| + "threatLists": {
|
| + "description": "The lists available for download by the client.",
|
| "items": {
|
| - "$ref": "ThreatEntrySet"
|
| + "$ref": "ThreatListDescriptor"
|
| },
|
| "type": "array"
|
| - },
|
| - "checksum": {
|
| - "$ref": "Checksum",
|
| - "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
|
| - },
|
| - "responseType": {
|
| - "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
|
| - "enum": [
|
| - "RESPONSE_TYPE_UNSPECIFIED",
|
| - "PARTIAL_UPDATE",
|
| - "FULL_UPDATE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unknown.",
|
| - "Partial updates are applied to the client's existing local database.",
|
| - "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "threatType": {
|
| - "description": "The threat type for which data is returned.",
|
| - "enum": [
|
| - "THREAT_TYPE_UNSPECIFIED",
|
| - "MALWARE",
|
| - "SOCIAL_ENGINEERING",
|
| - "UNWANTED_SOFTWARE",
|
| - "POTENTIALLY_HARMFUL_APPLICATION"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unknown.",
|
| - "Malware threat type.",
|
| - "Social engineering threat type.",
|
| - "Unwanted software threat type.",
|
| - "Potentially harmful application threat type."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "newClientState": {
|
| - "description": "The new client state, in encrypted format. Opaque to clients.",
|
| - "format": "byte",
|
| - "type": "string"
|
| - },
|
| - "removals": {
|
| - "description": "A set of entries to remove from a local threat type's list. In practice,\nthis field is empty or contains exactly one ThreatEntrySet.",
|
| - "items": {
|
| - "$ref": "ThreatEntrySet"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Constraints": {
|
| - "description": "The constraints for this update.",
|
| - "id": "Constraints",
|
| - "properties": {
|
| - "maxDatabaseEntries": {
|
| - "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "region": {
|
| - "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
|
| - "type": "string"
|
| - },
|
| - "supportedCompressions": {
|
| - "description": "The compression types supported by the client.",
|
| - "enumDescriptions": [
|
| - "Unknown.",
|
| - "Raw, uncompressed data.",
|
| - "Rice-Golomb encoded data."
|
| - ],
|
| - "items": {
|
| - "enum": [
|
| - "COMPRESSION_TYPE_UNSPECIFIED",
|
| - "RAW",
|
| - "RICE"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "maxUpdateEntries": {
|
| - "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ThreatMatch": {
|
| - "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
|
| - "id": "ThreatMatch",
|
| + "ThreatEntry": {
|
| + "description": "An individual threat; for example, a malicious URL or its hash\nrepresentation. Only one of these fields should be set.",
|
| + "id": "ThreatEntry",
|
| "properties": {
|
| - "cacheDuration": {
|
| - "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
|
| - "format": "google-duration",
|
| - "type": "string"
|
| - },
|
| - "threatType": {
|
| - "description": "The threat type matching this threat.",
|
| - "enum": [
|
| - "THREAT_TYPE_UNSPECIFIED",
|
| - "MALWARE",
|
| - "SOCIAL_ENGINEERING",
|
| - "UNWANTED_SOFTWARE",
|
| - "POTENTIALLY_HARMFUL_APPLICATION"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unknown.",
|
| - "Malware threat type.",
|
| - "Social engineering threat type.",
|
| - "Unwanted software threat type.",
|
| - "Potentially harmful application threat type."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "threatEntryMetadata": {
|
| - "$ref": "ThreatEntryMetadata",
|
| - "description": "Optional metadata associated with this threat."
|
| - },
|
| - "threat": {
|
| - "$ref": "ThreatEntry",
|
| - "description": "The threat matching this threat."
|
| - },
|
| - "platformType": {
|
| - "description": "The platform type matching this threat.",
|
| - "enum": [
|
| - "PLATFORM_TYPE_UNSPECIFIED",
|
| - "WINDOWS",
|
| - "LINUX",
|
| - "ANDROID",
|
| - "OSX",
|
| - "IOS",
|
| - "ANY_PLATFORM",
|
| - "ALL_PLATFORMS",
|
| - "CHROME"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unknown platform.",
|
| - "Threat posed to Windows.",
|
| - "Threat posed to Linux.",
|
| - "Threat posed to Android.",
|
| - "Threat posed to OS X.",
|
| - "Threat posed to iOS.",
|
| - "Threat posed to at least one of the defined platforms.",
|
| - "Threat posed to all defined platforms.",
|
| - "Threat posed to Chrome."
|
| - ],
|
| + "url": {
|
| + "description": "A URL.",
|
| "type": "string"
|
| },
|
| - "threatEntryType": {
|
| - "description": "The threat entry type matching this threat.",
|
| - "enum": [
|
| - "THREAT_ENTRY_TYPE_UNSPECIFIED",
|
| - "URL",
|
| - "EXECUTABLE",
|
| - "IP_RANGE",
|
| - "CHROME_EXTENSION",
|
| - "FILENAME",
|
| - "CERT"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unspecified.",
|
| - "A URL.",
|
| - "An executable program.",
|
| - "An IP range.",
|
| - "Chrome extension.",
|
| - "Filename.",
|
| - "CERT"
|
| - ],
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "RiceDeltaEncoding": {
|
| - "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
|
| - "id": "RiceDeltaEncoding",
|
| - "properties": {
|
| - "firstValue": {
|
| - "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
|
| - "format": "int64",
|
| + "digest": {
|
| + "description": "The digest of an executable in SHA256 format. The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
|
| + "format": "byte",
|
| "type": "string"
|
| },
|
| - "encodedData": {
|
| - "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
|
| + "hash": {
|
| + "description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON requests, hashes are\nbase64-encoded.",
|
| "format": "byte",
|
| "type": "string"
|
| - },
|
| - "numEntries": {
|
| - "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "riceParameter": {
|
| - "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListThreatListsResponse": {
|
| - "id": "ListThreatListsResponse",
|
| - "properties": {
|
| - "threatLists": {
|
| - "description": "The lists available for download by the client.",
|
| - "items": {
|
| - "$ref": "ThreatListDescriptor"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -797,27 +573,6 @@
|
| },
|
| "type": "object"
|
| },
|
| - "ThreatEntry": {
|
| - "description": "An individual threat; for example, a malicious URL or its hash\nrepresentation. Only one of these fields should be set.",
|
| - "id": "ThreatEntry",
|
| - "properties": {
|
| - "digest": {
|
| - "description": "The digest of an executable in SHA256 format. The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
|
| - "format": "byte",
|
| - "type": "string"
|
| - },
|
| - "hash": {
|
| - "description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON requests, hashes are\nbase64-encoded.",
|
| - "format": "byte",
|
| - "type": "string"
|
| - },
|
| - "url": {
|
| - "description": "A URL.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "ThreatListDescriptor": {
|
| "description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
|
| "id": "ThreatListDescriptor",
|
| @@ -912,13 +667,28 @@
|
| "description": "The client metadata associated with Safe Browsing API requests.",
|
| "id": "ClientInfo",
|
| "properties": {
|
| + "clientId": {
|
| + "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
|
| + "type": "string"
|
| + },
|
| "clientVersion": {
|
| "description": "The version of the client implementation.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "FindThreatMatchesRequest": {
|
| + "description": "Request to check entries against lists.",
|
| + "id": "FindThreatMatchesRequest",
|
| + "properties": {
|
| + "client": {
|
| + "$ref": "ClientInfo",
|
| + "description": "The client metadata."
|
| },
|
| - "clientId": {
|
| - "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
|
| - "type": "string"
|
| + "threatInfo": {
|
| + "$ref": "ThreatInfo",
|
| + "description": "The lists and entries to be checked for matches."
|
| }
|
| },
|
| "type": "object"
|
| @@ -927,44 +697,8 @@
|
| "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
|
| "id": "ThreatInfo",
|
| "properties": {
|
| - "platformTypes": {
|
| - "description": "The platform types to be checked.",
|
| - "enumDescriptions": [
|
| - "Unknown platform.",
|
| - "Threat posed to Windows.",
|
| - "Threat posed to Linux.",
|
| - "Threat posed to Android.",
|
| - "Threat posed to OS X.",
|
| - "Threat posed to iOS.",
|
| - "Threat posed to at least one of the defined platforms.",
|
| - "Threat posed to all defined platforms.",
|
| - "Threat posed to Chrome."
|
| - ],
|
| - "items": {
|
| - "enum": [
|
| - "PLATFORM_TYPE_UNSPECIFIED",
|
| - "WINDOWS",
|
| - "LINUX",
|
| - "ANDROID",
|
| - "OSX",
|
| - "IOS",
|
| - "ANY_PLATFORM",
|
| - "ALL_PLATFORMS",
|
| - "CHROME"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "threatEntries": {
|
| - "description": "The threat entries to be checked.",
|
| - "items": {
|
| - "$ref": "ThreatEntry"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "threatEntryTypes": {
|
| - "description": "The entry types to be checked.",
|
| + "threatEntryTypes": {
|
| + "description": "The entry types to be checked.",
|
| "enumDescriptions": [
|
| "Unspecified.",
|
| "A URL.",
|
| @@ -1008,21 +742,287 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "platformTypes": {
|
| + "description": "The platform types to be checked.",
|
| + "enumDescriptions": [
|
| + "Unknown platform.",
|
| + "Threat posed to Windows.",
|
| + "Threat posed to Linux.",
|
| + "Threat posed to Android.",
|
| + "Threat posed to OS X.",
|
| + "Threat posed to iOS.",
|
| + "Threat posed to at least one of the defined platforms.",
|
| + "Threat posed to all defined platforms.",
|
| + "Threat posed to Chrome."
|
| + ],
|
| + "items": {
|
| + "enum": [
|
| + "PLATFORM_TYPE_UNSPECIFIED",
|
| + "WINDOWS",
|
| + "LINUX",
|
| + "ANDROID",
|
| + "OSX",
|
| + "IOS",
|
| + "ANY_PLATFORM",
|
| + "ALL_PLATFORMS",
|
| + "CHROME"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "threatEntries": {
|
| + "description": "The threat entries to be checked.",
|
| + "items": {
|
| + "$ref": "ThreatEntry"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "FindThreatMatchesRequest": {
|
| - "description": "Request to check entries against lists.",
|
| - "id": "FindThreatMatchesRequest",
|
| + "ThreatEntryMetadata": {
|
| + "description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.",
|
| + "id": "ThreatEntryMetadata",
|
| + "properties": {
|
| + "entries": {
|
| + "description": "The metadata entries.",
|
| + "items": {
|
| + "$ref": "MetadataEntry"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "RawIndices": {
|
| + "description": "A set of raw indices to remove from a local list.",
|
| + "id": "RawIndices",
|
| + "properties": {
|
| + "indices": {
|
| + "description": "The indices to remove from a lexicographically-sorted local list.",
|
| + "items": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "RawHashes": {
|
| + "description": "The uncompressed threat entries in hash format of a particular prefix length.\nHashes can be anywhere from 4 to 32 bytes in size. A large majority are 4\nbytes, but some hashes are lengthened if they collide with the hash of a\npopular URL.\n\nUsed for sending ThreatEntrySet to clients that do not support compression,\nor when sending non-4-byte hashes to clients that do support compression.",
|
| + "id": "RawHashes",
|
| + "properties": {
|
| + "prefixSize": {
|
| + "description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "rawHashes": {
|
| + "description": "The hashes, in binary format, concatenated into one long string. Hashes are\nsorted in lexicographic order. For JSON API users, hashes are\nbase64-encoded.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "FetchThreatListUpdatesResponse": {
|
| + "id": "FetchThreatListUpdatesResponse",
|
| + "properties": {
|
| + "listUpdateResponses": {
|
| + "description": "The list updates requested by the clients.",
|
| + "items": {
|
| + "$ref": "ListUpdateResponse"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "minimumWaitDuration": {
|
| + "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
|
| + "format": "google-duration",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Checksum": {
|
| + "description": "The expected state of a client's local database.",
|
| + "id": "Checksum",
|
| + "properties": {
|
| + "sha256": {
|
| + "description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "FindFullHashesResponse": {
|
| + "id": "FindFullHashesResponse",
|
| + "properties": {
|
| + "negativeCacheDuration": {
|
| + "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
|
| + "format": "google-duration",
|
| + "type": "string"
|
| + },
|
| + "minimumWaitDuration": {
|
| + "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
|
| + "format": "google-duration",
|
| + "type": "string"
|
| + },
|
| + "matches": {
|
| + "description": "The full hashes that matched the requested prefixes.",
|
| + "items": {
|
| + "$ref": "ThreatMatch"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ThreatEntrySet": {
|
| + "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
|
| + "id": "ThreatEntrySet",
|
| + "properties": {
|
| + "rawHashes": {
|
| + "$ref": "RawHashes",
|
| + "description": "The raw SHA256-formatted entries."
|
| + },
|
| + "riceHashes": {
|
| + "$ref": "RiceDeltaEncoding",
|
| + "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
|
| + },
|
| + "compressionType": {
|
| + "description": "The compression type for the entries in this set.",
|
| + "enum": [
|
| + "COMPRESSION_TYPE_UNSPECIFIED",
|
| + "RAW",
|
| + "RICE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unknown.",
|
| + "Raw, uncompressed data.",
|
| + "Rice-Golomb encoded data."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "riceIndices": {
|
| + "$ref": "RiceDeltaEncoding",
|
| + "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data."
|
| + },
|
| + "rawIndices": {
|
| + "$ref": "RawIndices",
|
| + "description": "The raw removal indices for a local list."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "FindFullHashesRequest": {
|
| + "description": "Request to return full hashes matched by the provided hash prefixes.",
|
| + "id": "FindFullHashesRequest",
|
| "properties": {
|
| + "apiClient": {
|
| + "$ref": "ClientInfo",
|
| + "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
|
| + },
|
| + "clientStates": {
|
| + "description": "The current client states for each of the client's local threat lists.",
|
| + "items": {
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| "client": {
|
| "$ref": "ClientInfo",
|
| "description": "The client metadata."
|
| },
|
| "threatInfo": {
|
| "$ref": "ThreatInfo",
|
| - "description": "The lists and entries to be checked for matches."
|
| + "description": "The lists and hashes to be checked."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListUpdateRequest": {
|
| + "description": "A single list update request.",
|
| + "id": "ListUpdateRequest",
|
| + "properties": {
|
| + "state": {
|
| + "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "platformType": {
|
| + "description": "The type of platform at risk by entries present in the list.",
|
| + "enum": [
|
| + "PLATFORM_TYPE_UNSPECIFIED",
|
| + "WINDOWS",
|
| + "LINUX",
|
| + "ANDROID",
|
| + "OSX",
|
| + "IOS",
|
| + "ANY_PLATFORM",
|
| + "ALL_PLATFORMS",
|
| + "CHROME"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unknown platform.",
|
| + "Threat posed to Windows.",
|
| + "Threat posed to Linux.",
|
| + "Threat posed to Android.",
|
| + "Threat posed to OS X.",
|
| + "Threat posed to iOS.",
|
| + "Threat posed to at least one of the defined platforms.",
|
| + "Threat posed to all defined platforms.",
|
| + "Threat posed to Chrome."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "threatType": {
|
| + "description": "The type of threat posed by entries present in the list.",
|
| + "enum": [
|
| + "THREAT_TYPE_UNSPECIFIED",
|
| + "MALWARE",
|
| + "SOCIAL_ENGINEERING",
|
| + "UNWANTED_SOFTWARE",
|
| + "POTENTIALLY_HARMFUL_APPLICATION"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unknown.",
|
| + "Malware threat type.",
|
| + "Social engineering threat type.",
|
| + "Unwanted software threat type.",
|
| + "Potentially harmful application threat type."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "constraints": {
|
| + "$ref": "Constraints",
|
| + "description": "The constraints associated with this request."
|
| + },
|
| + "threatEntryType": {
|
| + "description": "The types of entries present in the list.",
|
| + "enum": [
|
| + "THREAT_ENTRY_TYPE_UNSPECIFIED",
|
| + "URL",
|
| + "EXECUTABLE",
|
| + "IP_RANGE",
|
| + "CHROME_EXTENSION",
|
| + "FILENAME",
|
| + "CERT"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unspecified.",
|
| + "A URL.",
|
| + "An executable program.",
|
| + "An IP range.",
|
| + "Chrome extension.",
|
| + "Filename.",
|
| + "CERT"
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
|
|
Chromium Code Reviews
Issue 2824163002:
Api-roll 48: 2017-04-18 (Closed)
