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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/safebrowsing__v4.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 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 unified diff | Download patch
« no previous file with comments | « discovery/googleapis/runtimeconfig__v1.json ('k') | discovery/googleapis/script__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "basePath": "", 2 "basePath": "",
3 "baseUrl": "https://safebrowsing.googleapis.com/", 3 "baseUrl": "https://safebrowsing.googleapis.com/",
4 "batchPath": "batch", 4 "batchPath": "batch",
5 "description": "Enables client applications to check web resources (most com monly URLs) against Google-generated lists of unsafe web resources.", 5 "description": "Enables client applications to check web resources (most com monly URLs) against Google-generated lists of unsafe web resources.",
6 "discoveryVersion": "v1", 6 "discoveryVersion": "v1",
7 "documentationLink": "https://developers.google.com/safe-browsing/", 7 "documentationLink": "https://developers.google.com/safe-browsing/",
8 "icons": { 8 "icons": {
9 "x16": "http://www.google.com/images/icons/product/search-16.gif", 9 "x16": "http://www.google.com/images/icons/product/search-16.gif",
10 "x32": "http://www.google.com/images/icons/product/search-32.gif" 10 "x32": "http://www.google.com/images/icons/product/search-32.gif"
11 }, 11 },
12 "id": "safebrowsing:v4", 12 "id": "safebrowsing:v4",
13 "kind": "discovery#restDescription", 13 "kind": "discovery#restDescription",
14 "name": "safebrowsing", 14 "name": "safebrowsing",
15 "ownerDomain": "google.com", 15 "ownerDomain": "google.com",
16 "ownerName": "Google", 16 "ownerName": "Google",
17 "parameters": { 17 "parameters": {
18 "access_token": {
19 "description": "OAuth access token.",
20 "location": "query",
21 "type": "string"
22 },
18 "key": { 23 "key": {
19 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 24 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
20 "location": "query", 25 "location": "query",
21 "type": "string" 26 "type": "string"
22 }, 27 },
23 "access_token": {
24 "description": "OAuth access token.",
25 "location": "query",
26 "type": "string"
27 },
28 "quotaUser": { 28 "quotaUser": {
29 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 29 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
30 "location": "query", 30 "location": "query",
31 "type": "string" 31 "type": "string"
32 }, 32 },
33 "pp": { 33 "pp": {
34 "default": "true", 34 "default": "true",
35 "description": "Pretty-print response.", 35 "description": "Pretty-print response.",
36 "location": "query", 36 "location": "query",
37 "type": "boolean" 37 "type": "boolean"
38 }, 38 },
39 "bearer_token": {
40 "description": "OAuth bearer token.",
41 "location": "query",
42 "type": "string"
43 },
39 "oauth_token": { 44 "oauth_token": {
40 "description": "OAuth 2.0 token for the current user.", 45 "description": "OAuth 2.0 token for the current user.",
41 "location": "query", 46 "location": "query",
42 "type": "string" 47 "type": "string"
43 }, 48 },
44 "bearer_token": {
45 "description": "OAuth bearer token.",
46 "location": "query",
47 "type": "string"
48 },
49 "upload_protocol": { 49 "upload_protocol": {
50 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 50 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
51 "location": "query", 51 "location": "query",
52 "type": "string" 52 "type": "string"
53 }, 53 },
54 "prettyPrint": { 54 "prettyPrint": {
55 "default": "true", 55 "default": "true",
56 "description": "Returns response with indentations and line breaks." , 56 "description": "Returns response with indentations and line breaks." ,
57 "location": "query", 57 "location": "query",
58 "type": "boolean" 58 "type": "boolean"
59 }, 59 },
60 "uploadType": {
61 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
62 "location": "query",
63 "type": "string"
64 },
60 "fields": { 65 "fields": {
61 "description": "Selector specifying which fields to include in a par tial response.", 66 "description": "Selector specifying which fields to include in a par tial response.",
62 "location": "query", 67 "location": "query",
63 "type": "string" 68 "type": "string"
64 }, 69 },
65 "uploadType": {
66 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
67 "location": "query",
68 "type": "string"
69 },
70 "callback": {
71 "description": "JSONP",
72 "location": "query",
73 "type": "string"
74 },
75 "$.xgafv": { 70 "$.xgafv": {
76 "description": "V1 error format.", 71 "description": "V1 error format.",
77 "enum": [ 72 "enum": [
78 "1", 73 "1",
79 "2" 74 "2"
80 ], 75 ],
81 "enumDescriptions": [ 76 "enumDescriptions": [
82 "v1 error format", 77 "v1 error format",
83 "v2 error format" 78 "v2 error format"
84 ], 79 ],
85 "location": "query", 80 "location": "query",
86 "type": "string" 81 "type": "string"
87 }, 82 },
83 "callback": {
84 "description": "JSONP",
85 "location": "query",
86 "type": "string"
87 },
88 "alt": { 88 "alt": {
89 "default": "json", 89 "default": "json",
90 "description": "Data format for response.", 90 "description": "Data format for response.",
91 "enum": [ 91 "enum": [
92 "json", 92 "json",
93 "media", 93 "media",
94 "proto" 94 "proto"
95 ], 95 ],
96 "enumDescriptions": [ 96 "enumDescriptions": [
97 "Responses with Content-Type of application/json", 97 "Responses with Content-Type of application/json",
98 "Media download with context-dependent Content-Type", 98 "Media download with context-dependent Content-Type",
99 "Responses with Content-Type of application/x-protobuf" 99 "Responses with Content-Type of application/x-protobuf"
100 ], 100 ],
101 "location": "query", 101 "location": "query",
102 "type": "string" 102 "type": "string"
103 } 103 }
104 }, 104 },
105 "protocol": "rest", 105 "protocol": "rest",
106 "resources": { 106 "resources": {
107 "threatListUpdates": {
108 "methods": {
109 "fetch": {
110 "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
111 "httpMethod": "POST",
112 "id": "safebrowsing.threatListUpdates.fetch",
113 "parameterOrder": [],
114 "parameters": {},
115 "path": "v4/threatListUpdates:fetch",
116 "request": {
117 "$ref": "FetchThreatListUpdatesRequest"
118 },
119 "response": {
120 "$ref": "FetchThreatListUpdatesResponse"
121 }
122 }
123 }
124 },
125 "encodedFullHashes": {
126 "methods": {
127 "get": {
128 "description": "",
129 "httpMethod": "GET",
130 "id": "safebrowsing.encodedFullHashes.get",
131 "parameterOrder": [
132 "encodedRequest"
133 ],
134 "parameters": {
135 "clientId": {
136 "description": "A client ID that (hopefully) uniquel y identifies the client implementation\nof the Safe Browsing API.",
137 "location": "query",
138 "type": "string"
139 },
140 "clientVersion": {
141 "description": "The version of the client implementa tion.",
142 "location": "query",
143 "type": "string"
144 },
145 "encodedRequest": {
146 "description": "A serialized FindFullHashesRequest p roto.",
147 "format": "byte",
148 "location": "path",
149 "required": true,
150 "type": "string"
151 }
152 },
153 "path": "v4/encodedFullHashes/{encodedRequest}",
154 "response": {
155 "$ref": "FindFullHashesResponse"
156 }
157 }
158 }
159 },
160 "threatLists": { 107 "threatLists": {
161 "methods": { 108 "methods": {
162 "list": { 109 "list": {
163 "description": "Lists the Safe Browsing threat lists availab le for download.", 110 "description": "Lists the Safe Browsing threat lists availab le for download.",
164 "httpMethod": "GET", 111 "httpMethod": "GET",
165 "id": "safebrowsing.threatLists.list", 112 "id": "safebrowsing.threatLists.list",
166 "parameterOrder": [], 113 "parameterOrder": [],
167 "parameters": {}, 114 "parameters": {},
168 "path": "v4/threatLists", 115 "path": "v4/threatLists",
169 "response": { 116 "response": {
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after
235 "required": true, 182 "required": true,
236 "type": "string" 183 "type": "string"
237 } 184 }
238 }, 185 },
239 "path": "v4/encodedUpdates/{encodedRequest}", 186 "path": "v4/encodedUpdates/{encodedRequest}",
240 "response": { 187 "response": {
241 "$ref": "FetchThreatListUpdatesResponse" 188 "$ref": "FetchThreatListUpdatesResponse"
242 } 189 }
243 } 190 }
244 } 191 }
192 },
193 "threatListUpdates": {
194 "methods": {
195 "fetch": {
196 "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
197 "httpMethod": "POST",
198 "id": "safebrowsing.threatListUpdates.fetch",
199 "parameterOrder": [],
200 "parameters": {},
201 "path": "v4/threatListUpdates:fetch",
202 "request": {
203 "$ref": "FetchThreatListUpdatesRequest"
204 },
205 "response": {
206 "$ref": "FetchThreatListUpdatesResponse"
207 }
208 }
209 }
210 },
211 "encodedFullHashes": {
212 "methods": {
213 "get": {
214 "description": "",
215 "httpMethod": "GET",
216 "id": "safebrowsing.encodedFullHashes.get",
217 "parameterOrder": [
218 "encodedRequest"
219 ],
220 "parameters": {
221 "clientVersion": {
222 "description": "The version of the client implementa tion.",
223 "location": "query",
224 "type": "string"
225 },
226 "encodedRequest": {
227 "description": "A serialized FindFullHashesRequest p roto.",
228 "format": "byte",
229 "location": "path",
230 "required": true,
231 "type": "string"
232 },
233 "clientId": {
234 "description": "A client ID that (hopefully) uniquel y identifies the client implementation\nof the Safe Browsing API.",
235 "location": "query",
236 "type": "string"
237 }
238 },
239 "path": "v4/encodedFullHashes/{encodedRequest}",
240 "response": {
241 "$ref": "FindFullHashesResponse"
242 }
243 }
244 }
245 } 245 }
246 }, 246 },
247 "revision": "20170814", 247 "revision": "20170906",
248 "rootUrl": "https://safebrowsing.googleapis.com/", 248 "rootUrl": "https://safebrowsing.googleapis.com/",
249 "schemas": { 249 "schemas": {
250 "Constraints": { 250 "ThreatInfo": {
251 "description": "The constraints for this update.", 251 "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
252 "id": "Constraints", 252 "id": "ThreatInfo",
253 "properties": { 253 "properties": {
254 "supportedCompressions": { 254 "threatEntryTypes": {
255 "description": "The compression types supported by the clien t.", 255 "description": "The entry types to be checked.",
256 "enumDescriptions": [ 256 "enumDescriptions": [
257 "Unknown.", 257 "Unspecified.",
258 "Raw, uncompressed data.", 258 "A URL.",
259 "Rice-Golomb encoded data." 259 "An executable program.",
260 "An IP range.",
261 "Chrome extension.",
262 "Filename.",
263 "CERT"
260 ], 264 ],
261 "items": { 265 "items": {
262 "enum": [ 266 "enum": [
263 "COMPRESSION_TYPE_UNSPECIFIED", 267 "THREAT_ENTRY_TYPE_UNSPECIFIED",
264 "RAW", 268 "URL",
265 "RICE" 269 "EXECUTABLE",
270 "IP_RANGE",
271 "CHROME_EXTENSION",
272 "FILENAME",
273 "CERT"
266 ], 274 ],
267 "type": "string" 275 "type": "string"
268 }, 276 },
269 "type": "array" 277 "type": "array"
270 }, 278 },
271 "maxUpdateEntries": { 279 "threatTypes": {
272 "description": "The maximum size in number of entries. The u pdate 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.", 280 "description": "The threat types to be checked.",
273 "format": "int32",
274 "type": "integer"
275 },
276 "region": {
277 "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP addr ess. Expects ISO\n3166-1 alpha-2 format.",
278 "type": "string"
279 },
280 "maxDatabaseEntries": {
281 "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 be tween 2**10 and\n2**20. If zero, no database size limit is set.",
282 "format": "int32",
283 "type": "integer"
284 }
285 },
286 "type": "object"
287 },
288 "ThreatMatch": {
289 "description": "A match when checking a threat entry in the Safe Bro wsing threat lists.",
290 "id": "ThreatMatch",
291 "properties": {
292 "threatType": {
293 "description": "The threat type matching this threat.",
294 "enum": [
295 "THREAT_TYPE_UNSPECIFIED",
296 "MALWARE",
297 "SOCIAL_ENGINEERING",
298 "UNWANTED_SOFTWARE",
299 "POTENTIALLY_HARMFUL_APPLICATION",
300 "SOCIAL_ENGINEERING_INTERNAL",
301 "API_ABUSE",
302 "MALICIOUS_BINARY",
303 "CSD_WHITELIST",
304 "CSD_DOWNLOAD_WHITELIST",
305 "CLIENT_INCIDENT",
306 "CLIENT_INCIDENT_WHITELIST",
307 "APK_MALWARE_OFFLINE",
308 "SUBRESOURCE_FILTER"
309 ],
310 "enumDescriptions": [ 281 "enumDescriptions": [
311 "Unknown.", 282 "Unknown.",
312 "Malware threat type.", 283 "Malware threat type.",
313 "Social engineering threat type.", 284 "Social engineering threat type.",
314 "Unwanted software threat type.", 285 "Unwanted software threat type.",
315 "Potentially harmful application threat type.", 286 "Potentially harmful application threat type.",
316 "Social engineering threat type for internal use.", 287 "Social engineering threat type for internal use.",
317 "API abuse threat type.", 288 "API abuse threat type.",
318 "Malicious binary threat type.", 289 "Malicious binary threat type.",
319 "Client side detection whitelist threat type.", 290 "Client side detection whitelist threat type.",
320 "Client side download detection whitelist threat type.", 291 "Client side download detection whitelist threat type.",
321 "Client incident threat type.", 292 "Client incident threat type.",
322 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.", 293 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.",
323 "List used for offline APK checks in PAM.", 294 "List used for offline APK checks in PAM.",
324 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list." 295 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list."
325 ], 296 ],
326 "type": "string" 297 "items": {
298 "enum": [
299 "THREAT_TYPE_UNSPECIFIED",
300 "MALWARE",
301 "SOCIAL_ENGINEERING",
302 "UNWANTED_SOFTWARE",
303 "POTENTIALLY_HARMFUL_APPLICATION",
304 "SOCIAL_ENGINEERING_INTERNAL",
305 "API_ABUSE",
306 "MALICIOUS_BINARY",
307 "CSD_WHITELIST",
308 "CSD_DOWNLOAD_WHITELIST",
309 "CLIENT_INCIDENT",
310 "CLIENT_INCIDENT_WHITELIST",
311 "APK_MALWARE_OFFLINE",
312 "SUBRESOURCE_FILTER"
313 ],
314 "type": "string"
315 },
316 "type": "array"
327 }, 317 },
328 "threatEntryMetadata": { 318 "platformTypes": {
329 "$ref": "ThreatEntryMetadata", 319 "description": "The platform types to be checked.",
330 "description": "Optional metadata associated with this threa t."
331 },
332 "threat": {
333 "$ref": "ThreatEntry",
334 "description": "The threat matching this threat."
335 },
336 "platformType": {
337 "description": "The platform type matching this threat.",
338 "enum": [
339 "PLATFORM_TYPE_UNSPECIFIED",
340 "WINDOWS",
341 "LINUX",
342 "ANDROID",
343 "OSX",
344 "IOS",
345 "ANY_PLATFORM",
346 "ALL_PLATFORMS",
347 "CHROME"
348 ],
349 "enumDescriptions": [ 320 "enumDescriptions": [
350 "Unknown platform.", 321 "Unknown platform.",
351 "Threat posed to Windows.", 322 "Threat posed to Windows.",
352 "Threat posed to Linux.", 323 "Threat posed to Linux.",
353 "Threat posed to Android.", 324 "Threat posed to Android.",
354 "Threat posed to OS X.", 325 "Threat posed to OS X.",
355 "Threat posed to iOS.", 326 "Threat posed to iOS.",
356 "Threat posed to at least one of the defined platforms." , 327 "Threat posed to at least one of the defined platforms." ,
357 "Threat posed to all defined platforms.", 328 "Threat posed to all defined platforms.",
358 "Threat posed to Chrome." 329 "Threat posed to Chrome."
359 ], 330 ],
360 "type": "string" 331 "items": {
361 }, 332 "enum": [
333 "PLATFORM_TYPE_UNSPECIFIED",
334 "WINDOWS",
335 "LINUX",
336 "ANDROID",
337 "OSX",
338 "IOS",
339 "ANY_PLATFORM",
340 "ALL_PLATFORMS",
341 "CHROME"
342 ],
343 "type": "string"
344 },
345 "type": "array"
346 },
347 "threatEntries": {
348 "description": "The threat entries to be checked.",
349 "items": {
350 "$ref": "ThreatEntry"
351 },
352 "type": "array"
353 }
354 },
355 "type": "object"
356 },
357 "FindThreatMatchesRequest": {
358 "description": "Request to check entries against lists.",
359 "id": "FindThreatMatchesRequest",
360 "properties": {
361 "client": {
362 "$ref": "ClientInfo",
363 "description": "The client metadata."
364 },
365 "threatInfo": {
366 "$ref": "ThreatInfo",
367 "description": "The lists and entries to be checked for matc hes."
368 }
369 },
370 "type": "object"
371 },
372 "ThreatEntryMetadata": {
373 "description": "The metadata associated with a specific threat entry . The client is expected\nto know the metadata key/value pairs associated with e ach threat type.",
374 "id": "ThreatEntryMetadata",
375 "properties": {
376 "entries": {
377 "description": "The metadata entries.",
378 "items": {
379 "$ref": "MetadataEntry"
380 },
381 "type": "array"
382 }
383 },
384 "type": "object"
385 },
386 "RawIndices": {
387 "description": "A set of raw indices to remove from a local list.",
388 "id": "RawIndices",
389 "properties": {
390 "indices": {
391 "description": "The indices to remove from a lexicographical ly-sorted local list.",
392 "items": {
393 "format": "int32",
394 "type": "integer"
395 },
396 "type": "array"
397 }
398 },
399 "type": "object"
400 },
401 "RawHashes": {
402 "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 d o support compression.",
403 "id": "RawHashes",
404 "properties": {
405 "rawHashes": {
406 "description": "The hashes, in binary format, concatenated i nto one long string. Hashes are\nsorted in lexicographic order. For JSON API use rs, hashes are\nbase64-encoded.",
407 "format": "byte",
408 "type": "string"
409 },
410 "prefixSize": {
411 "description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).",
412 "format": "int32",
413 "type": "integer"
414 }
415 },
416 "type": "object"
417 },
418 "FetchThreatListUpdatesResponse": {
419 "id": "FetchThreatListUpdatesResponse",
420 "properties": {
421 "minimumWaitDuration": {
422 "description": "The minimum duration the client must wait be fore issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
423 "format": "google-duration",
424 "type": "string"
425 },
426 "listUpdateResponses": {
427 "description": "The list updates requested by the clients.",
428 "items": {
429 "$ref": "ListUpdateResponse"
430 },
431 "type": "array"
432 }
433 },
434 "type": "object"
435 },
436 "Checksum": {
437 "description": "The expected state of a client's local database.",
438 "id": "Checksum",
439 "properties": {
440 "sha256": {
441 "description": "The SHA256 hash of the client state; that is , of the sorted list of all\nhashes present in the database.",
442 "format": "byte",
443 "type": "string"
444 }
445 },
446 "type": "object"
447 },
448 "FindFullHashesResponse": {
449 "id": "FindFullHashesResponse",
450 "properties": {
451 "minimumWaitDuration": {
452 "description": "The minimum duration the client must wait be fore issuing any find hashes\nrequest. If this field is not set, clients can iss ue a request as soon as\nthey want.",
453 "format": "google-duration",
454 "type": "string"
455 },
456 "matches": {
457 "description": "The full hashes that matched the requested p refixes.",
458 "items": {
459 "$ref": "ThreatMatch"
460 },
461 "type": "array"
462 },
463 "negativeCacheDuration": {
464 "description": "For requested entities that did not match th e threat list, how long to\ncache the response.",
465 "format": "google-duration",
466 "type": "string"
467 }
468 },
469 "type": "object"
470 },
471 "ThreatEntrySet": {
472 "description": "A set of threats that should be added or removed fro m a client's local\ndatabase.",
473 "id": "ThreatEntrySet",
474 "properties": {
475 "riceIndices": {
476 "$ref": "RiceDeltaEncoding",
477 "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 delt a encoded\nand stored as encoded_data."
478 },
479 "compressionType": {
480 "description": "The compression type for the entries in this set.",
481 "enum": [
482 "COMPRESSION_TYPE_UNSPECIFIED",
483 "RAW",
484 "RICE"
485 ],
486 "enumDescriptions": [
487 "Unknown.",
488 "Raw, uncompressed data.",
489 "Rice-Golomb encoded data."
490 ],
491 "type": "string"
492 },
493 "rawIndices": {
494 "$ref": "RawIndices",
495 "description": "The raw removal indices for a local list."
496 },
497 "rawHashes": {
498 "$ref": "RawHashes",
499 "description": "The raw SHA256-formatted entries."
500 },
501 "riceHashes": {
502 "$ref": "RiceDeltaEncoding",
503 "description": "The encoded 4-byte prefixes of SHA256-format ted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
504 }
505 },
506 "type": "object"
507 },
508 "FindFullHashesRequest": {
509 "description": "Request to return full hashes matched by the provide d hash prefixes.",
510 "id": "FindFullHashesRequest",
511 "properties": {
512 "clientStates": {
513 "description": "The current client states for each of the cl ient's local threat lists.",
514 "items": {
515 "format": "byte",
516 "type": "string"
517 },
518 "type": "array"
519 },
520 "client": {
521 "$ref": "ClientInfo",
522 "description": "The client metadata."
523 },
524 "threatInfo": {
525 "$ref": "ThreatInfo",
526 "description": "The lists and hashes to be checked."
527 },
528 "apiClient": {
529 "$ref": "ClientInfo",
530 "description": "Client metadata associated with callers of h igher-level APIs built on top\nof the client's implementation."
531 }
532 },
533 "type": "object"
534 },
535 "ListUpdateRequest": {
536 "description": "A single list update request.",
537 "id": "ListUpdateRequest",
538 "properties": {
362 "threatEntryType": { 539 "threatEntryType": {
363 "description": "The threat entry type matching this threat." , 540 "description": "The types of entries present in the list.",
364 "enum": [ 541 "enum": [
365 "THREAT_ENTRY_TYPE_UNSPECIFIED", 542 "THREAT_ENTRY_TYPE_UNSPECIFIED",
366 "URL", 543 "URL",
367 "EXECUTABLE", 544 "EXECUTABLE",
368 "IP_RANGE", 545 "IP_RANGE",
369 "CHROME_EXTENSION", 546 "CHROME_EXTENSION",
370 "FILENAME", 547 "FILENAME",
371 "CERT" 548 "CERT"
372 ], 549 ],
373 "enumDescriptions": [ 550 "enumDescriptions": [
374 "Unspecified.", 551 "Unspecified.",
375 "A URL.", 552 "A URL.",
376 "An executable program.",
377 "An IP range.",
378 "Chrome extension.",
379 "Filename.",
380 "CERT"
381 ],
382 "type": "string"
383 },
384 "cacheDuration": {
385 "description": "The cache lifetime for the returned match. C lients must not cache this\nresponse for more than this duration to avoid false positives.",
386 "format": "google-duration",
387 "type": "string"
388 }
389 },
390 "type": "object"
391 },
392 "RiceDeltaEncoding": {
393 "description": "The Rice-Golomb encoded data. Used for sending compr essed 4-byte hashes or\ncompressed removal indices.",
394 "id": "RiceDeltaEncoding",
395 "properties": {
396 "numEntries": {
397 "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero a nd the single value will be\nstored in `first_value`.",
398 "format": "int32",
399 "type": "integer"
400 },
401 "riceParameter": {
402 "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is ze ro.",
403 "format": "int32",
404 "type": "integer"
405 },
406 "encodedData": {
407 "description": "The encoded deltas that are encoded using th e Golomb-Rice coder.",
408 "format": "byte",
409 "type": "string"
410 },
411 "firstValue": {
412 "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
413 "format": "int64",
414 "type": "string"
415 }
416 },
417 "type": "object"
418 },
419 "ListThreatListsResponse": {
420 "id": "ListThreatListsResponse",
421 "properties": {
422 "threatLists": {
423 "description": "The lists available for download by the clie nt.",
424 "items": {
425 "$ref": "ThreatListDescriptor"
426 },
427 "type": "array"
428 }
429 },
430 "type": "object"
431 },
432 "FindThreatMatchesResponse": {
433 "id": "FindThreatMatchesResponse",
434 "properties": {
435 "matches": {
436 "description": "The threat list matches.",
437 "items": {
438 "$ref": "ThreatMatch"
439 },
440 "type": "array"
441 }
442 },
443 "type": "object"
444 },
445 "ThreatEntry": {
446 "description": "An individual threat; for example, a malicious URL o r its hash\nrepresentation. Only one of these fields should be set.",
447 "id": "ThreatEntry",
448 "properties": {
449 "hash": {
450 "description": "A hash prefix, consisting of the most signif icant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON req uests, hashes are\nbase64-encoded.",
451 "format": "byte",
452 "type": "string"
453 },
454 "url": {
455 "description": "A URL.",
456 "type": "string"
457 },
458 "digest": {
459 "description": "The digest of an executable in SHA256 format . The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
460 "format": "byte",
461 "type": "string"
462 }
463 },
464 "type": "object"
465 },
466 "ThreatListDescriptor": {
467 "description": "Describes an individual threat list. A list is defin ed by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
468 "id": "ThreatListDescriptor",
469 "properties": {
470 "platformType": {
471 "description": "The platform type targeted by the list's ent ries.",
472 "enum": [
473 "PLATFORM_TYPE_UNSPECIFIED",
474 "WINDOWS",
475 "LINUX",
476 "ANDROID",
477 "OSX",
478 "IOS",
479 "ANY_PLATFORM",
480 "ALL_PLATFORMS",
481 "CHROME"
482 ],
483 "enumDescriptions": [
484 "Unknown platform.",
485 "Threat posed to Windows.",
486 "Threat posed to Linux.",
487 "Threat posed to Android.",
488 "Threat posed to OS X.",
489 "Threat posed to iOS.",
490 "Threat posed to at least one of the defined platforms." ,
491 "Threat posed to all defined platforms.",
492 "Threat posed to Chrome."
493 ],
494 "type": "string"
495 },
496 "threatType": {
497 "description": "The threat type posed by the list's entries. ",
498 "enum": [
499 "THREAT_TYPE_UNSPECIFIED",
500 "MALWARE",
501 "SOCIAL_ENGINEERING",
502 "UNWANTED_SOFTWARE",
503 "POTENTIALLY_HARMFUL_APPLICATION",
504 "SOCIAL_ENGINEERING_INTERNAL",
505 "API_ABUSE",
506 "MALICIOUS_BINARY",
507 "CSD_WHITELIST",
508 "CSD_DOWNLOAD_WHITELIST",
509 "CLIENT_INCIDENT",
510 "CLIENT_INCIDENT_WHITELIST",
511 "APK_MALWARE_OFFLINE",
512 "SUBRESOURCE_FILTER"
513 ],
514 "enumDescriptions": [
515 "Unknown.",
516 "Malware threat type.",
517 "Social engineering threat type.",
518 "Unwanted software threat type.",
519 "Potentially harmful application threat type.",
520 "Social engineering threat type for internal use.",
521 "API abuse threat type.",
522 "Malicious binary threat type.",
523 "Client side detection whitelist threat type.",
524 "Client side download detection whitelist threat type.",
525 "Client incident threat type.",
526 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.",
527 "List used for offline APK checks in PAM.",
528 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list."
529 ],
530 "type": "string"
531 },
532 "threatEntryType": {
533 "description": "The entry types contained in the list.",
534 "enum": [
535 "THREAT_ENTRY_TYPE_UNSPECIFIED",
536 "URL",
537 "EXECUTABLE",
538 "IP_RANGE",
539 "CHROME_EXTENSION",
540 "FILENAME",
541 "CERT"
542 ],
543 "enumDescriptions": [
544 "Unspecified.",
545 "A URL.",
546 "An executable program.",
547 "An IP range.",
548 "Chrome extension.",
549 "Filename.",
550 "CERT"
551 ],
552 "type": "string"
553 }
554 },
555 "type": "object"
556 },
557 "MetadataEntry": {
558 "description": "A single metadata entry.",
559 "id": "MetadataEntry",
560 "properties": {
561 "value": {
562 "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
563 "format": "byte",
564 "type": "string"
565 },
566 "key": {
567 "description": "The metadata entry key. For JSON requests, t he key is base64-encoded.",
568 "format": "byte",
569 "type": "string"
570 }
571 },
572 "type": "object"
573 },
574 "ClientInfo": {
575 "description": "The client metadata associated with Safe Browsing AP I requests.",
576 "id": "ClientInfo",
577 "properties": {
578 "clientId": {
579 "description": "A client ID that (hopefully) uniquely identi fies the client implementation\nof the Safe Browsing API.",
580 "type": "string"
581 },
582 "clientVersion": {
583 "description": "The version of the client implementation.",
584 "type": "string"
585 }
586 },
587 "type": "object"
588 },
589 "ThreatInfo": {
590 "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
591 "id": "ThreatInfo",
592 "properties": {
593 "threatEntries": {
594 "description": "The threat entries to be checked.",
595 "items": {
596 "$ref": "ThreatEntry"
597 },
598 "type": "array"
599 },
600 "threatEntryTypes": {
601 "description": "The entry types to be checked.",
602 "enumDescriptions": [
603 "Unspecified.",
604 "A URL.",
605 "An executable program.", 553 "An executable program.",
606 "An IP range.", 554 "An IP range.",
607 "Chrome extension.", 555 "Chrome extension.",
608 "Filename.", 556 "Filename.",
609 "CERT" 557 "CERT"
610 ], 558 ],
611 "items": { 559 "type": "string"
612 "enum": [
613 "THREAT_ENTRY_TYPE_UNSPECIFIED",
614 "URL",
615 "EXECUTABLE",
616 "IP_RANGE",
617 "CHROME_EXTENSION",
618 "FILENAME",
619 "CERT"
620 ],
621 "type": "string"
622 },
623 "type": "array"
624 }, 560 },
625 "threatTypes": { 561 "state": {
626 "description": "The threat types to be checked.", 562 "description": "The current state of the client for the requ ested list (the encrypted\nclient state that was received from the last successf ul list update).",
563 "format": "byte",
564 "type": "string"
565 },
566 "platformType": {
567 "description": "The type of platform at risk by entries pres ent in the list.",
568 "enum": [
569 "PLATFORM_TYPE_UNSPECIFIED",
570 "WINDOWS",
571 "LINUX",
572 "ANDROID",
573 "OSX",
574 "IOS",
575 "ANY_PLATFORM",
576 "ALL_PLATFORMS",
577 "CHROME"
578 ],
579 "enumDescriptions": [
580 "Unknown platform.",
581 "Threat posed to Windows.",
582 "Threat posed to Linux.",
583 "Threat posed to Android.",
584 "Threat posed to OS X.",
585 "Threat posed to iOS.",
586 "Threat posed to at least one of the defined platforms." ,
587 "Threat posed to all defined platforms.",
588 "Threat posed to Chrome."
589 ],
590 "type": "string"
591 },
592 "constraints": {
593 "$ref": "Constraints",
594 "description": "The constraints associated with this request ."
595 },
596 "threatType": {
597 "description": "The type of threat posed by entries present in the list.",
598 "enum": [
599 "THREAT_TYPE_UNSPECIFIED",
600 "MALWARE",
601 "SOCIAL_ENGINEERING",
602 "UNWANTED_SOFTWARE",
603 "POTENTIALLY_HARMFUL_APPLICATION",
604 "SOCIAL_ENGINEERING_INTERNAL",
605 "API_ABUSE",
606 "MALICIOUS_BINARY",
607 "CSD_WHITELIST",
608 "CSD_DOWNLOAD_WHITELIST",
609 "CLIENT_INCIDENT",
610 "CLIENT_INCIDENT_WHITELIST",
611 "APK_MALWARE_OFFLINE",
612 "SUBRESOURCE_FILTER"
613 ],
627 "enumDescriptions": [ 614 "enumDescriptions": [
628 "Unknown.", 615 "Unknown.",
629 "Malware threat type.", 616 "Malware threat type.",
630 "Social engineering threat type.", 617 "Social engineering threat type.",
631 "Unwanted software threat type.", 618 "Unwanted software threat type.",
632 "Potentially harmful application threat type.", 619 "Potentially harmful application threat type.",
633 "Social engineering threat type for internal use.", 620 "Social engineering threat type for internal use.",
634 "API abuse threat type.", 621 "API abuse threat type.",
635 "Malicious binary threat type.", 622 "Malicious binary threat type.",
636 "Client side detection whitelist threat type.", 623 "Client side detection whitelist threat type.",
637 "Client side download detection whitelist threat type.", 624 "Client side download detection whitelist threat type.",
638 "Client incident threat type.", 625 "Client incident threat type.",
639 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.", 626 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.",
640 "List used for offline APK checks in PAM.", 627 "List used for offline APK checks in PAM.",
641 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list." 628 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list."
642 ], 629 ],
643 "items": { 630 "type": "string"
644 "enum": [ 631 }
645 "THREAT_TYPE_UNSPECIFIED", 632 },
646 "MALWARE", 633 "type": "object"
647 "SOCIAL_ENGINEERING", 634 },
648 "UNWANTED_SOFTWARE", 635 "FetchThreatListUpdatesRequest": {
649 "POTENTIALLY_HARMFUL_APPLICATION", 636 "description": "Describes a Safe Browsing API update request. Client s can request updates for\nmultiple lists in a single request.\nNOTE: Field inde x 2 is unused.\nNEXT: 5",
650 "SOCIAL_ENGINEERING_INTERNAL", 637 "id": "FetchThreatListUpdatesRequest",
651 "API_ABUSE", 638 "properties": {
652 "MALICIOUS_BINARY", 639 "listUpdateRequests": {
653 "CSD_WHITELIST", 640 "description": "The requested threat list updates.",
654 "CSD_DOWNLOAD_WHITELIST", 641 "items": {
655 "CLIENT_INCIDENT", 642 "$ref": "ListUpdateRequest"
656 "CLIENT_INCIDENT_WHITELIST", 643 },
657 "APK_MALWARE_OFFLINE", 644 "type": "array"
658 "SUBRESOURCE_FILTER" 645 },
659 ], 646 "client": {
660 "type": "string" 647 "$ref": "ClientInfo",
661 }, 648 "description": "The client metadata."
662 "type": "array" 649 }
663 }, 650 },
664 "platformTypes": { 651 "type": "object"
665 "description": "The platform types to be checked.", 652 },
653 "ListUpdateResponse": {
654 "description": "An update to an individual list.",
655 "id": "ListUpdateResponse",
656 "properties": {
657 "newClientState": {
658 "description": "The new client state, in encrypted format. O paque to clients.",
659 "format": "byte",
660 "type": "string"
661 },
662 "removals": {
663 "description": "A set of entries to remove from a local thre at type's list. In practice,\nthis field is empty or contains exactly one Threat EntrySet.",
664 "items": {
665 "$ref": "ThreatEntrySet"
666 },
667 "type": "array"
668 },
669 "platformType": {
670 "description": "The platform type for which data is returned .",
671 "enum": [
672 "PLATFORM_TYPE_UNSPECIFIED",
673 "WINDOWS",
674 "LINUX",
675 "ANDROID",
676 "OSX",
677 "IOS",
678 "ANY_PLATFORM",
679 "ALL_PLATFORMS",
680 "CHROME"
681 ],
666 "enumDescriptions": [ 682 "enumDescriptions": [
667 "Unknown platform.", 683 "Unknown platform.",
668 "Threat posed to Windows.", 684 "Threat posed to Windows.",
669 "Threat posed to Linux.", 685 "Threat posed to Linux.",
670 "Threat posed to Android.", 686 "Threat posed to Android.",
671 "Threat posed to OS X.", 687 "Threat posed to OS X.",
672 "Threat posed to iOS.", 688 "Threat posed to iOS.",
673 "Threat posed to at least one of the defined platforms." , 689 "Threat posed to at least one of the defined platforms." ,
674 "Threat posed to all defined platforms.", 690 "Threat posed to all defined platforms.",
675 "Threat posed to Chrome." 691 "Threat posed to Chrome."
676 ], 692 ],
677 "items": { 693 "type": "string"
678 "enum": [ 694 },
679 "PLATFORM_TYPE_UNSPECIFIED", 695 "threatEntryType": {
680 "WINDOWS", 696 "description": "The format of the threats.",
681 "LINUX", 697 "enum": [
682 "ANDROID", 698 "THREAT_ENTRY_TYPE_UNSPECIFIED",
683 "OSX", 699 "URL",
684 "IOS", 700 "EXECUTABLE",
685 "ANY_PLATFORM", 701 "IP_RANGE",
686 "ALL_PLATFORMS", 702 "CHROME_EXTENSION",
687 "CHROME" 703 "FILENAME",
688 ], 704 "CERT"
689 "type": "string" 705 ],
690 }, 706 "enumDescriptions": [
691 "type": "array" 707 "Unspecified.",
692 } 708 "A URL.",
693 }, 709 "An executable program.",
694 "type": "object" 710 "An IP range.",
695 }, 711 "Chrome extension.",
696 "FindThreatMatchesRequest": { 712 "Filename.",
697 "description": "Request to check entries against lists.", 713 "CERT"
698 "id": "FindThreatMatchesRequest", 714 ],
699 "properties": { 715 "type": "string"
700 "client": { 716 },
701 "$ref": "ClientInfo", 717 "additions": {
702 "description": "The client metadata." 718 "description": "A set of entries to add to a local threat ty pe's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
703 }, 719 "items": {
704 "threatInfo": { 720 "$ref": "ThreatEntrySet"
705 "$ref": "ThreatInfo", 721 },
706 "description": "The lists and entries to be checked for matc hes." 722 "type": "array"
707 } 723 },
708 }, 724 "responseType": {
709 "type": "object" 725 "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
710 }, 726 "enum": [
711 "ThreatEntryMetadata": { 727 "RESPONSE_TYPE_UNSPECIFIED",
712 "description": "The metadata associated with a specific threat entry . The client is expected\nto know the metadata key/value pairs associated with e ach threat type.", 728 "PARTIAL_UPDATE",
713 "id": "ThreatEntryMetadata", 729 "FULL_UPDATE"
714 "properties": { 730 ],
715 "entries": { 731 "enumDescriptions": [
716 "description": "The metadata entries.", 732 "Unknown.",
717 "items": { 733 "Partial updates are applied to the client's existing lo cal database.",
718 "$ref": "MetadataEntry" 734 "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."
719 }, 735 ],
720 "type": "array" 736 "type": "string"
721 } 737 },
722 }, 738 "checksum": {
723 "type": "object" 739 "$ref": "Checksum",
724 }, 740 "description": "The expected SHA256 hash of the client state ; that is, of the sorted list\nof all hashes present in the database after apply ing the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
725 "RawIndices": { 741 },
726 "description": "A set of raw indices to remove from a local list.", 742 "threatType": {
727 "id": "RawIndices", 743 "description": "The threat type for which data is returned." ,
728 "properties": { 744 "enum": [
729 "indices": { 745 "THREAT_TYPE_UNSPECIFIED",
730 "description": "The indices to remove from a lexicographical ly-sorted local list.", 746 "MALWARE",
731 "items": { 747 "SOCIAL_ENGINEERING",
732 "format": "int32", 748 "UNWANTED_SOFTWARE",
733 "type": "integer" 749 "POTENTIALLY_HARMFUL_APPLICATION",
734 }, 750 "SOCIAL_ENGINEERING_INTERNAL",
735 "type": "array" 751 "API_ABUSE",
736 } 752 "MALICIOUS_BINARY",
737 }, 753 "CSD_WHITELIST",
738 "type": "object" 754 "CSD_DOWNLOAD_WHITELIST",
739 }, 755 "CLIENT_INCIDENT",
740 "RawHashes": { 756 "CLIENT_INCIDENT_WHITELIST",
741 "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 d o support compression.", 757 "APK_MALWARE_OFFLINE",
742 "id": "RawHashes", 758 "SUBRESOURCE_FILTER"
743 "properties": { 759 ],
744 "rawHashes": { 760 "enumDescriptions": [
745 "description": "The hashes, in binary format, concatenated i nto one long string. Hashes are\nsorted in lexicographic order. For JSON API use rs, hashes are\nbase64-encoded.", 761 "Unknown.",
746 "format": "byte", 762 "Malware threat type.",
747 "type": "string" 763 "Social engineering threat type.",
748 }, 764 "Unwanted software threat type.",
749 "prefixSize": { 765 "Potentially harmful application threat type.",
750 "description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).", 766 "Social engineering threat type for internal use.",
751 "format": "int32", 767 "API abuse threat type.",
752 "type": "integer" 768 "Malicious binary threat type.",
753 } 769 "Client side detection whitelist threat type.",
754 }, 770 "Client side download detection whitelist threat type.",
755 "type": "object" 771 "Client incident threat type.",
756 }, 772 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.",
757 "FetchThreatListUpdatesResponse": { 773 "List used for offline APK checks in PAM.",
758 "id": "FetchThreatListUpdatesResponse", 774 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list."
759 "properties": { 775 ],
760 "minimumWaitDuration": { 776 "type": "string"
761 "description": "The minimum duration the client must wait be fore issuing any update\nrequest. If this field is not set clients may update as soon as they want.", 777 }
762 "format": "google-duration", 778 },
763 "type": "string" 779 "type": "object"
764 }, 780 },
765 "listUpdateResponses": { 781 "Constraints": {
766 "description": "The list updates requested by the clients.", 782 "description": "The constraints for this update.",
767 "items": { 783 "id": "Constraints",
768 "$ref": "ListUpdateResponse" 784 "properties": {
769 }, 785 "supportedCompressions": {
770 "type": "array" 786 "description": "The compression types supported by the clien t.",
771 }
772 },
773 "type": "object"
774 },
775 "FindFullHashesResponse": {
776 "id": "FindFullHashesResponse",
777 "properties": {
778 "matches": {
779 "description": "The full hashes that matched the requested p refixes.",
780 "items": {
781 "$ref": "ThreatMatch"
782 },
783 "type": "array"
784 },
785 "negativeCacheDuration": {
786 "description": "For requested entities that did not match th e threat list, how long to\ncache the response.",
787 "format": "google-duration",
788 "type": "string"
789 },
790 "minimumWaitDuration": {
791 "description": "The minimum duration the client must wait be fore issuing any find hashes\nrequest. If this field is not set, clients can iss ue a request as soon as\nthey want.",
792 "format": "google-duration",
793 "type": "string"
794 }
795 },
796 "type": "object"
797 },
798 "Checksum": {
799 "description": "The expected state of a client's local database.",
800 "id": "Checksum",
801 "properties": {
802 "sha256": {
803 "description": "The SHA256 hash of the client state; that is , of the sorted list of all\nhashes present in the database.",
804 "format": "byte",
805 "type": "string"
806 }
807 },
808 "type": "object"
809 },
810 "ThreatEntrySet": {
811 "description": "A set of threats that should be added or removed fro m a client's local\ndatabase.",
812 "id": "ThreatEntrySet",
813 "properties": {
814 "riceIndices": {
815 "$ref": "RiceDeltaEncoding",
816 "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 delt a encoded\nand stored as encoded_data."
817 },
818 "compressionType": {
819 "description": "The compression type for the entries in this set.",
820 "enum": [
821 "COMPRESSION_TYPE_UNSPECIFIED",
822 "RAW",
823 "RICE"
824 ],
825 "enumDescriptions": [ 787 "enumDescriptions": [
826 "Unknown.", 788 "Unknown.",
827 "Raw, uncompressed data.", 789 "Raw, uncompressed data.",
828 "Rice-Golomb encoded data." 790 "Rice-Golomb encoded data."
829 ], 791 ],
830 "type": "string" 792 "items": {
831 }, 793 "enum": [
832 "rawIndices": { 794 "COMPRESSION_TYPE_UNSPECIFIED",
833 "$ref": "RawIndices", 795 "RAW",
834 "description": "The raw removal indices for a local list." 796 "RICE"
835 }, 797 ],
836 "rawHashes": {
837 "$ref": "RawHashes",
838 "description": "The raw SHA256-formatted entries."
839 },
840 "riceHashes": {
841 "$ref": "RiceDeltaEncoding",
842 "description": "The encoded 4-byte prefixes of SHA256-format ted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
843 }
844 },
845 "type": "object"
846 },
847 "FindFullHashesRequest": {
848 "description": "Request to return full hashes matched by the provide d hash prefixes.",
849 "id": "FindFullHashesRequest",
850 "properties": {
851 "apiClient": {
852 "$ref": "ClientInfo",
853 "description": "Client metadata associated with callers of h igher-level APIs built on top\nof the client's implementation."
854 },
855 "clientStates": {
856 "description": "The current client states for each of the cl ient's local threat lists.",
857 "items": {
858 "format": "byte",
859 "type": "string" 798 "type": "string"
860 }, 799 },
861 "type": "array" 800 "type": "array"
862 }, 801 },
863 "client": { 802 "maxUpdateEntries": {
864 "$ref": "ClientInfo", 803 "description": "The maximum size in number of entries. The u pdate 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.",
865 "description": "The client metadata." 804 "format": "int32",
866 }, 805 "type": "integer"
867 "threatInfo": { 806 },
868 "$ref": "ThreatInfo", 807 "region": {
869 "description": "The lists and hashes to be checked." 808 "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP addr ess. Expects ISO\n3166-1 alpha-2 format.",
870 } 809 "type": "string"
871 }, 810 },
872 "type": "object" 811 "maxDatabaseEntries": {
873 }, 812 "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 be tween 2**10 and\n2**20. If zero, no database size limit is set.",
874 "ListUpdateRequest": { 813 "format": "int32",
875 "description": "A single list update request.", 814 "type": "integer"
876 "id": "ListUpdateRequest", 815 }
877 "properties": { 816 },
878 "constraints": { 817 "type": "object"
879 "$ref": "Constraints", 818 },
880 "description": "The constraints associated with this request ." 819 "ThreatMatch": {
820 "description": "A match when checking a threat entry in the Safe Bro wsing threat lists.",
821 "id": "ThreatMatch",
822 "properties": {
823 "threat": {
824 "$ref": "ThreatEntry",
825 "description": "The threat matching this threat."
826 },
827 "platformType": {
828 "description": "The platform type matching this threat.",
829 "enum": [
830 "PLATFORM_TYPE_UNSPECIFIED",
831 "WINDOWS",
832 "LINUX",
833 "ANDROID",
834 "OSX",
835 "IOS",
836 "ANY_PLATFORM",
837 "ALL_PLATFORMS",
838 "CHROME"
839 ],
840 "enumDescriptions": [
841 "Unknown platform.",
842 "Threat posed to Windows.",
843 "Threat posed to Linux.",
844 "Threat posed to Android.",
845 "Threat posed to OS X.",
846 "Threat posed to iOS.",
847 "Threat posed to at least one of the defined platforms." ,
848 "Threat posed to all defined platforms.",
849 "Threat posed to Chrome."
850 ],
851 "type": "string"
852 },
853 "threatEntryType": {
854 "description": "The threat entry type matching this threat." ,
855 "enum": [
856 "THREAT_ENTRY_TYPE_UNSPECIFIED",
857 "URL",
858 "EXECUTABLE",
859 "IP_RANGE",
860 "CHROME_EXTENSION",
861 "FILENAME",
862 "CERT"
863 ],
864 "enumDescriptions": [
865 "Unspecified.",
866 "A URL.",
867 "An executable program.",
868 "An IP range.",
869 "Chrome extension.",
870 "Filename.",
871 "CERT"
872 ],
873 "type": "string"
874 },
875 "cacheDuration": {
876 "description": "The cache lifetime for the returned match. C lients must not cache this\nresponse for more than this duration to avoid false positives.",
877 "format": "google-duration",
878 "type": "string"
879 },
880 "threatEntryMetadata": {
881 "$ref": "ThreatEntryMetadata",
882 "description": "Optional metadata associated with this threa t."
881 }, 883 },
882 "threatType": { 884 "threatType": {
883 "description": "The type of threat posed by entries present in the list.", 885 "description": "The threat type matching this threat.",
884 "enum": [ 886 "enum": [
885 "THREAT_TYPE_UNSPECIFIED", 887 "THREAT_TYPE_UNSPECIFIED",
886 "MALWARE", 888 "MALWARE",
887 "SOCIAL_ENGINEERING", 889 "SOCIAL_ENGINEERING",
888 "UNWANTED_SOFTWARE", 890 "UNWANTED_SOFTWARE",
889 "POTENTIALLY_HARMFUL_APPLICATION", 891 "POTENTIALLY_HARMFUL_APPLICATION",
890 "SOCIAL_ENGINEERING_INTERNAL", 892 "SOCIAL_ENGINEERING_INTERNAL",
891 "API_ABUSE", 893 "API_ABUSE",
892 "MALICIOUS_BINARY", 894 "MALICIOUS_BINARY",
893 "CSD_WHITELIST", 895 "CSD_WHITELIST",
(...skipping 13 matching lines...) Expand all
907 "API abuse threat type.", 909 "API abuse threat type.",
908 "Malicious binary threat type.", 910 "Malicious binary threat type.",
909 "Client side detection whitelist threat type.", 911 "Client side detection whitelist threat type.",
910 "Client side download detection whitelist threat type.", 912 "Client side download detection whitelist threat type.",
911 "Client incident threat type.", 913 "Client incident threat type.",
912 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.", 914 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.",
913 "List used for offline APK checks in PAM.", 915 "List used for offline APK checks in PAM.",
914 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list." 916 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list."
915 ], 917 ],
916 "type": "string" 918 "type": "string"
919 }
920 },
921 "type": "object"
922 },
923 "ListThreatListsResponse": {
924 "id": "ListThreatListsResponse",
925 "properties": {
926 "threatLists": {
927 "description": "The lists available for download by the clie nt.",
928 "items": {
929 "$ref": "ThreatListDescriptor"
930 },
931 "type": "array"
932 }
933 },
934 "type": "object"
935 },
936 "RiceDeltaEncoding": {
937 "description": "The Rice-Golomb encoded data. Used for sending compr essed 4-byte hashes or\ncompressed removal indices.",
938 "id": "RiceDeltaEncoding",
939 "properties": {
940 "encodedData": {
941 "description": "The encoded deltas that are encoded using th e Golomb-Rice coder.",
942 "format": "byte",
943 "type": "string"
917 }, 944 },
945 "firstValue": {
946 "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
947 "format": "int64",
948 "type": "string"
949 },
950 "numEntries": {
951 "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero a nd the single value will be\nstored in `first_value`.",
952 "format": "int32",
953 "type": "integer"
954 },
955 "riceParameter": {
956 "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is ze ro.",
957 "format": "int32",
958 "type": "integer"
959 }
960 },
961 "type": "object"
962 },
963 "FindThreatMatchesResponse": {
964 "id": "FindThreatMatchesResponse",
965 "properties": {
966 "matches": {
967 "description": "The threat list matches.",
968 "items": {
969 "$ref": "ThreatMatch"
970 },
971 "type": "array"
972 }
973 },
974 "type": "object"
975 },
976 "ThreatEntry": {
977 "description": "An individual threat; for example, a malicious URL o r its hash\nrepresentation. Only one of these fields should be set.",
978 "id": "ThreatEntry",
979 "properties": {
980 "digest": {
981 "description": "The digest of an executable in SHA256 format . The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
982 "format": "byte",
983 "type": "string"
984 },
985 "hash": {
986 "description": "A hash prefix, consisting of the most signif icant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON req uests, hashes are\nbase64-encoded.",
987 "format": "byte",
988 "type": "string"
989 },
990 "url": {
991 "description": "A URL.",
992 "type": "string"
993 }
994 },
995 "type": "object"
996 },
997 "ThreatListDescriptor": {
998 "description": "Describes an individual threat list. A list is defin ed by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
999 "id": "ThreatListDescriptor",
1000 "properties": {
918 "threatEntryType": { 1001 "threatEntryType": {
919 "description": "The types of entries present in the list.", 1002 "description": "The entry types contained in the list.",
920 "enum": [ 1003 "enum": [
921 "THREAT_ENTRY_TYPE_UNSPECIFIED", 1004 "THREAT_ENTRY_TYPE_UNSPECIFIED",
922 "URL", 1005 "URL",
923 "EXECUTABLE", 1006 "EXECUTABLE",
924 "IP_RANGE", 1007 "IP_RANGE",
925 "CHROME_EXTENSION", 1008 "CHROME_EXTENSION",
926 "FILENAME", 1009 "FILENAME",
927 "CERT" 1010 "CERT"
928 ], 1011 ],
929 "enumDescriptions": [ 1012 "enumDescriptions": [
930 "Unspecified.", 1013 "Unspecified.",
931 "A URL.", 1014 "A URL.",
932 "An executable program.", 1015 "An executable program.",
933 "An IP range.", 1016 "An IP range.",
934 "Chrome extension.", 1017 "Chrome extension.",
935 "Filename.", 1018 "Filename.",
936 "CERT" 1019 "CERT"
937 ], 1020 ],
938 "type": "string" 1021 "type": "string"
939 }, 1022 },
940 "state": {
941 "description": "The current state of the client for the requ ested list (the encrypted\nclient state that was received from the last successf ul list update).",
942 "format": "byte",
943 "type": "string"
944 },
945 "platformType": { 1023 "platformType": {
946 "description": "The type of platform at risk by entries pres ent in the list.", 1024 "description": "The platform type targeted by the list's ent ries.",
947 "enum": [ 1025 "enum": [
948 "PLATFORM_TYPE_UNSPECIFIED", 1026 "PLATFORM_TYPE_UNSPECIFIED",
949 "WINDOWS", 1027 "WINDOWS",
950 "LINUX", 1028 "LINUX",
951 "ANDROID", 1029 "ANDROID",
952 "OSX", 1030 "OSX",
953 "IOS", 1031 "IOS",
954 "ANY_PLATFORM", 1032 "ANY_PLATFORM",
955 "ALL_PLATFORMS", 1033 "ALL_PLATFORMS",
956 "CHROME" 1034 "CHROME"
957 ], 1035 ],
958 "enumDescriptions": [ 1036 "enumDescriptions": [
959 "Unknown platform.", 1037 "Unknown platform.",
960 "Threat posed to Windows.", 1038 "Threat posed to Windows.",
961 "Threat posed to Linux.", 1039 "Threat posed to Linux.",
962 "Threat posed to Android.", 1040 "Threat posed to Android.",
963 "Threat posed to OS X.", 1041 "Threat posed to OS X.",
964 "Threat posed to iOS.", 1042 "Threat posed to iOS.",
965 "Threat posed to at least one of the defined platforms." , 1043 "Threat posed to at least one of the defined platforms." ,
966 "Threat posed to all defined platforms.", 1044 "Threat posed to all defined platforms.",
967 "Threat posed to Chrome." 1045 "Threat posed to Chrome."
968 ], 1046 ],
969 "type": "string" 1047 "type": "string"
970 }
971 },
972 "type": "object"
973 },
974 "FetchThreatListUpdatesRequest": {
975 "description": "Describes a Safe Browsing API update request. Client s can request updates for\nmultiple lists in a single request.\nNOTE: Field inde x 2 is unused.\nNEXT: 5",
976 "id": "FetchThreatListUpdatesRequest",
977 "properties": {
978 "listUpdateRequests": {
979 "description": "The requested threat list updates.",
980 "items": {
981 "$ref": "ListUpdateRequest"
982 },
983 "type": "array"
984 },
985 "client": {
986 "$ref": "ClientInfo",
987 "description": "The client metadata."
988 }
989 },
990 "type": "object"
991 },
992 "ListUpdateResponse": {
993 "description": "An update to an individual list.",
994 "id": "ListUpdateResponse",
995 "properties": {
996 "additions": {
997 "description": "A set of entries to add to a local threat ty pe's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
998 "items": {
999 "$ref": "ThreatEntrySet"
1000 },
1001 "type": "array"
1002 },
1003 "checksum": {
1004 "$ref": "Checksum",
1005 "description": "The expected SHA256 hash of the client state ; that is, of the sorted list\nof all hashes present in the database after apply ing the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
1006 },
1007 "responseType": {
1008 "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
1009 "enum": [
1010 "RESPONSE_TYPE_UNSPECIFIED",
1011 "PARTIAL_UPDATE",
1012 "FULL_UPDATE"
1013 ],
1014 "enumDescriptions": [
1015 "Unknown.",
1016 "Partial updates are applied to the client's existing lo cal database.",
1017 "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."
1018 ],
1019 "type": "string"
1020 }, 1048 },
1021 "threatType": { 1049 "threatType": {
1022 "description": "The threat type for which data is returned." , 1050 "description": "The threat type posed by the list's entries. ",
1023 "enum": [ 1051 "enum": [
1024 "THREAT_TYPE_UNSPECIFIED", 1052 "THREAT_TYPE_UNSPECIFIED",
1025 "MALWARE", 1053 "MALWARE",
1026 "SOCIAL_ENGINEERING", 1054 "SOCIAL_ENGINEERING",
1027 "UNWANTED_SOFTWARE", 1055 "UNWANTED_SOFTWARE",
1028 "POTENTIALLY_HARMFUL_APPLICATION", 1056 "POTENTIALLY_HARMFUL_APPLICATION",
1029 "SOCIAL_ENGINEERING_INTERNAL", 1057 "SOCIAL_ENGINEERING_INTERNAL",
1030 "API_ABUSE", 1058 "API_ABUSE",
1031 "MALICIOUS_BINARY", 1059 "MALICIOUS_BINARY",
1032 "CSD_WHITELIST", 1060 "CSD_WHITELIST",
(...skipping 13 matching lines...) Expand all
1046 "API abuse threat type.", 1074 "API abuse threat type.",
1047 "Malicious binary threat type.", 1075 "Malicious binary threat type.",
1048 "Client side detection whitelist threat type.", 1076 "Client side detection whitelist threat type.",
1049 "Client side download detection whitelist threat type.", 1077 "Client side download detection whitelist threat type.",
1050 "Client incident threat type.", 1078 "Client incident threat type.",
1051 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.", 1079 "Whitelist used when detecting client incident threats.\ nThis enum was never launched and should be re-used for the next list.",
1052 "List used for offline APK checks in PAM.", 1080 "List used for offline APK checks in PAM.",
1053 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list." 1081 "Patterns to be used for activating the subresource filt er. Interstitial\nwill not be shown for patterns from this list."
1054 ], 1082 ],
1055 "type": "string" 1083 "type": "string"
1056 },
1057 "newClientState": {
1058 "description": "The new client state, in encrypted format. O paque to clients.",
1059 "format": "byte",
1060 "type": "string"
1061 },
1062 "removals": {
1063 "description": "A set of entries to remove from a local thre at type's list. In practice,\nthis field is empty or contains exactly one Threat EntrySet.",
1064 "items": {
1065 "$ref": "ThreatEntrySet"
1066 },
1067 "type": "array"
1068 },
1069 "platformType": {
1070 "description": "The platform type for which data is returned .",
1071 "enum": [
1072 "PLATFORM_TYPE_UNSPECIFIED",
1073 "WINDOWS",
1074 "LINUX",
1075 "ANDROID",
1076 "OSX",
1077 "IOS",
1078 "ANY_PLATFORM",
1079 "ALL_PLATFORMS",
1080 "CHROME"
1081 ],
1082 "enumDescriptions": [
1083 "Unknown platform.",
1084 "Threat posed to Windows.",
1085 "Threat posed to Linux.",
1086 "Threat posed to Android.",
1087 "Threat posed to OS X.",
1088 "Threat posed to iOS.",
1089 "Threat posed to at least one of the defined platforms." ,
1090 "Threat posed to all defined platforms.",
1091 "Threat posed to Chrome."
1092 ],
1093 "type": "string"
1094 },
1095 "threatEntryType": {
1096 "description": "The format of the threats.",
1097 "enum": [
1098 "THREAT_ENTRY_TYPE_UNSPECIFIED",
1099 "URL",
1100 "EXECUTABLE",
1101 "IP_RANGE",
1102 "CHROME_EXTENSION",
1103 "FILENAME",
1104 "CERT"
1105 ],
1106 "enumDescriptions": [
1107 "Unspecified.",
1108 "A URL.",
1109 "An executable program.",
1110 "An IP range.",
1111 "Chrome extension.",
1112 "Filename.",
1113 "CERT"
1114 ],
1115 "type": "string"
1116 } 1084 }
1117 }, 1085 },
1086 "type": "object"
1087 },
1088 "MetadataEntry": {
1089 "description": "A single metadata entry.",
1090 "id": "MetadataEntry",
1091 "properties": {
1092 "value": {
1093 "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
1094 "format": "byte",
1095 "type": "string"
1096 },
1097 "key": {
1098 "description": "The metadata entry key. For JSON requests, t he key is base64-encoded.",
1099 "format": "byte",
1100 "type": "string"
1101 }
1102 },
1103 "type": "object"
1104 },
1105 "ClientInfo": {
1106 "description": "The client metadata associated with Safe Browsing AP I requests.",
1107 "id": "ClientInfo",
1108 "properties": {
1109 "clientVersion": {
1110 "description": "The version of the client implementation.",
1111 "type": "string"
1112 },
1113 "clientId": {
1114 "description": "A client ID that (hopefully) uniquely identi fies the client implementation\nof the Safe Browsing API.",
1115 "type": "string"
1116 }
1117 },
1118 "type": "object" 1118 "type": "object"
1119 } 1119 }
1120 }, 1120 },
1121 "servicePath": "", 1121 "servicePath": "",
1122 "title": "Google Safe Browsing API", 1122 "title": "Google Safe Browsing API",
1123 "version": "v4" 1123 "version": "v4"
1124 } 1124 }
OLDNEW
« 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