Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(37)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/safebrowsing__v4.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/runtimeconfig__v1.json ('k') | discovery/googleapis/script__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/safebrowsing__v4.json
diff --git a/discovery/googleapis/safebrowsing__v4.json b/discovery/googleapis/safebrowsing__v4.json
index 747f1aaf25ea0c36a2be9c04c4ff71dedd541025..014b0d04991e58daaaf4ddecd5369f2d8b5a8ce5 100644
--- a/discovery/googleapis/safebrowsing__v4.json
+++ b/discovery/googleapis/safebrowsing__v4.json
@@ -15,6 +15,37 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "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"
+ },
+ "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",
@@ -26,13 +57,13 @@
"location": "query",
"type": "boolean"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
@@ -69,94 +100,10 @@
],
"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"
- },
- "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"
}
},
"protocol": "rest",
"resources": {
- "threatListUpdates": {
- "methods": {
- "fetch": {
- "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
- "httpMethod": "POST",
- "id": "safebrowsing.threatListUpdates.fetch",
- "parameterOrder": [],
- "parameters": {},
- "path": "v4/threatListUpdates:fetch",
- "request": {
- "$ref": "FetchThreatListUpdatesRequest"
- },
- "response": {
- "$ref": "FetchThreatListUpdatesResponse"
- }
- }
- }
- },
- "encodedFullHashes": {
- "methods": {
- "get": {
- "description": "",
- "httpMethod": "GET",
- "id": "safebrowsing.encodedFullHashes.get",
- "parameterOrder": [
- "encodedRequest"
- ],
- "parameters": {
- "clientId": {
- "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
- "location": "query",
- "type": "string"
- },
- "clientVersion": {
- "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}",
- "response": {
- "$ref": "FindFullHashesResponse"
- }
- }
- }
- },
"threatLists": {
"methods": {
"list": {
@@ -218,6 +165,11 @@
"encodedRequest"
],
"parameters": {
+ "clientVersion": {
+ "description": "The version of the client implementation.",
+ "location": "query",
+ "type": "string"
+ },
"encodedRequest": {
"description": "A serialized FetchThreatListUpdatesRequest proto.",
"format": "byte",
@@ -229,52 +181,96 @@
"description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
"location": "query",
"type": "string"
- },
+ }
+ },
+ "path": "v4/encodedUpdates/{encodedRequest}",
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ }
+ }
+ }
+ },
+ "threatListUpdates": {
+ "methods": {
+ "fetch": {
+ "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
+ "httpMethod": "POST",
+ "id": "safebrowsing.threatListUpdates.fetch",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v4/threatListUpdates:fetch",
+ "request": {
+ "$ref": "FetchThreatListUpdatesRequest"
+ },
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ }
+ }
+ }
+ },
+ "encodedFullHashes": {
+ "methods": {
+ "get": {
+ "description": "",
+ "httpMethod": "GET",
+ "id": "safebrowsing.encodedFullHashes.get",
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "parameters": {
"clientVersion": {
"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"
+ },
+ "clientId": {
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v4/encodedUpdates/{encodedRequest}",
+ "path": "v4/encodedFullHashes/{encodedRequest}",
"response": {
- "$ref": "FetchThreatListUpdatesResponse"
+ "$ref": "FindFullHashesResponse"
}
}
}
}
},
- "revision": "20170704",
+ "revision": "20170726",
"rootUrl": "https://safebrowsing.googleapis.com/",
"schemas": {
- "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",
+ "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": {
- "threatEntryType": {
- "description": "The entry types contained 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"
+ "listUpdateRequests": {
+ "description": "The requested threat list updates.",
+ "items": {
+ "$ref": "ListUpdateRequest"
+ },
+ "type": "array"
},
+ "client": {
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
+ }
+ },
+ "type": "object"
+ },
+ "ListUpdateResponse": {
+ "description": "An update to an individual list.",
+ "id": "ListUpdateResponse",
+ "properties": {
"platformType": {
- "description": "The platform type targeted by the list's entries.",
+ "description": "The platform type for which data is returned.",
"enum": [
"PLATFORM_TYPE_UNSPECIFIED",
"WINDOWS",
@@ -299,40 +295,374 @@
],
"type": "string"
},
- "threatType": {
- "description": "The threat type posed by the list's entries.",
+ "threatEntryType": {
+ "description": "The format of the threats.",
"enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "MALICIOUS_BINARY"
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
],
"enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Malicious binary threat type."
- ],
- "type": "string"
- }
- },
- "type": "object"
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "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"
+ },
+ "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",
+ "MALICIOUS_BINARY"
+ ],
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Malicious binary 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": "ThreatEntrySet"
+ },
+ "type": "array"
+ },
+ "newClientState": {
+ "description": "The new client state, in encrypted format. Opaque to clients.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Constraints": {
+ "description": "The constraints for this update.",
+ "id": "Constraints",
+ "properties": {
+ "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"
+ },
+ "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"
+ },
+ "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",
+ "properties": {
+ "threatType": {
+ "description": "The threat type matching this threat.",
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "MALICIOUS_BINARY"
+ ],
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Malicious binary 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."
+ ],
+ "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"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "RiceDeltaEncoding": {
+ "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
+ "id": "RiceDeltaEncoding",
+ "properties": {
+ "encodedData": {
+ "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
+ "format": "byte",
+ "type": "string"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "FindThreatMatchesResponse": {
+ "id": "FindThreatMatchesResponse",
+ "properties": {
+ "matches": {
+ "description": "The threat list matches.",
+ "items": {
+ "$ref": "ThreatMatch"
+ },
+ "type": "array"
+ }
+ },
+ "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",
+ "properties": {
+ "threatType": {
+ "description": "The threat type posed by the list's entries.",
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "MALICIOUS_BINARY"
+ ],
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Malicious binary threat type."
+ ],
+ "type": "string"
+ },
+ "threatEntryType": {
+ "description": "The entry types contained 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"
+ },
+ "platformType": {
+ "description": "The platform type targeted by the list's entries.",
+ "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"
+ }
+ },
+ "type": "object"
},
"MetadataEntry": {
"description": "A single metadata entry.",
"id": "MetadataEntry",
"properties": {
- "key": {
- "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
+ "value": {
+ "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
"format": "byte",
"type": "string"
},
- "value": {
- "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
+ "key": {
+ "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
"format": "byte",
"type": "string"
}
@@ -343,13 +673,13 @@
"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"
+ },
+ "clientId": {
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "type": "string"
}
},
"type": "object"
@@ -358,6 +688,13 @@
"description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
"id": "ThreatInfo",
"properties": {
+ "threatEntries": {
+ "description": "The threat entries to be checked.",
+ "items": {
+ "$ref": "ThreatEntry"
+ },
+ "type": "array"
+ },
"threatEntryTypes": {
"description": "The entry types to be checked.",
"enumDescriptions": [
@@ -434,13 +771,6 @@
"type": "string"
},
"type": "array"
- },
- "threatEntries": {
- "description": "The threat entries to be checked.",
- "items": {
- "$ref": "ThreatEntry"
- },
- "type": "array"
}
},
"type": "object"
@@ -539,6 +869,13 @@
"FindFullHashesResponse": {
"id": "FindFullHashesResponse",
"properties": {
+ "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",
@@ -548,13 +885,6 @@
"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"
@@ -563,6 +893,10 @@
"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."
@@ -588,10 +922,6 @@
"rawIndices": {
"$ref": "RawIndices",
"description": "The raw removal indices for a local list."
- },
- "rawHashes": {
- "$ref": "RawHashes",
- "description": "The raw SHA256-formatted entries."
}
},
"type": "object"
@@ -600,18 +930,6 @@
"description": "Request to return full hashes matched by the provided hash prefixes.",
"id": "FindFullHashesRequest",
"properties": {
- "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 hashes to be checked."
@@ -619,102 +937,12 @@
"apiClient": {
"$ref": "ClientInfo",
"description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
- }
- },
- "type": "object"
- },
- "ListUpdateRequest": {
- "description": "A single list update request.",
- "id": "ListUpdateRequest",
- "properties": {
- "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"
},
- "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"
- },
- "constraints": {
- "$ref": "Constraints",
- "description": "The constraints associated with this request."
- },
- "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",
- "MALICIOUS_BINARY"
- ],
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Malicious binary threat type."
- ],
- "type": "string"
- }
- },
- "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",
- "properties": {
- "listUpdateRequests": {
- "description": "The requested threat list updates.",
+ "clientStates": {
+ "description": "The current client states for each of the client's local threat lists.",
"items": {
- "$ref": "ListUpdateRequest"
+ "format": "byte",
+ "type": "string"
},
"type": "array"
},
@@ -725,97 +953,16 @@
},
"type": "object"
},
- "ListUpdateResponse": {
- "description": "An update to an individual list.",
- "id": "ListUpdateResponse",
+ "ListUpdateRequest": {
+ "description": "A single list update request.",
+ "id": "ListUpdateRequest",
"properties": {
- "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"
- },
- "newClientState": {
- "description": "The new client state, in encrypted format. Opaque to clients.",
- "format": "byte",
- "type": "string"
- },
- "platformType": {
- "description": "The platform type for which data is returned.",
- "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"
- },
- "threatEntryType": {
- "description": "The format of the threats.",
- "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"
- },
- "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"
- },
- "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"
+ "constraints": {
+ "$ref": "Constraints",
+ "description": "The constraints associated with this request."
},
"threatType": {
- "description": "The threat type for which data is returned.",
+ "description": "The type of threat posed by entries present in the list.",
"enum": [
"THREAT_TYPE_UNSPECIFIED",
"MALWARE",
@@ -833,54 +980,9 @@
"Malicious binary threat type."
],
"type": "string"
- }
- },
- "type": "object"
- },
- "Constraints": {
- "description": "The constraints for this update.",
- "id": "Constraints",
- "properties": {
- "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"
- },
- "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"
},
- "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"
- }
- },
- "type": "object"
- },
- "ThreatMatch": {
- "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
- "id": "ThreatMatch",
- "properties": {
"threatEntryType": {
- "description": "The threat entry type matching this threat.",
+ "description": "The types of entries present in the list.",
"enum": [
"THREAT_ENTRY_TYPE_UNSPECIFIED",
"URL",
@@ -901,41 +1003,13 @@
],
"type": "string"
},
- "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",
- "MALICIOUS_BINARY"
- ],
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Malicious binary threat type."
- ],
+ "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"
},
- "threat": {
- "$ref": "ThreatEntry",
- "description": "The threat matching this threat."
- },
"platformType": {
- "description": "The platform type matching this threat.",
+ "description": "The type of platform at risk by entries present in the list.",
"enum": [
"PLATFORM_TYPE_UNSPECIFIED",
"WINDOWS",
@@ -962,80 +1036,6 @@
}
},
"type": "object"
- },
- "ListThreatListsResponse": {
- "id": "ListThreatListsResponse",
- "properties": {
- "threatLists": {
- "description": "The lists available for download by the client.",
- "items": {
- "$ref": "ThreatListDescriptor"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RiceDeltaEncoding": {
- "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
- "id": "RiceDeltaEncoding",
- "properties": {
- "encodedData": {
- "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
- "format": "byte",
- "type": "string"
- },
- "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"
- },
- "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"
- },
- "FindThreatMatchesResponse": {
- "id": "FindThreatMatchesResponse",
- "properties": {
- "matches": {
- "description": "The threat list matches.",
- "items": {
- "$ref": "ThreatMatch"
- },
- "type": "array"
- }
- },
- "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": {
- "url": {
- "description": "A URL.",
- "type": "string"
- },
- "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"
- }
- },
- "type": "object"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/runtimeconfig__v1.json ('k') | discovery/googleapis/script__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698