OLD | NEW |
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": "The Safe Browsing API is an experimental API that allows cli
ent applications to check URLs against Google's constantly-updated blacklists of
suspected phishing and malware pages. Your client application can use the API t
o download an encrypted table for local, client-side lookups of URLs.", | 5 "description": "The Safe Browsing API is an experimental API that allows cli
ent applications to check URLs against Google's constantly-updated blacklists of
suspected phishing and malware pages. Your client application can use the API t
o download an encrypted table for local, client-side lookups of URLs.", |
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 }, | |
23 "key": { | |
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.", | |
25 "location": "query", | |
26 "type": "string" | |
27 }, | |
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.", | |
30 "location": "query", | |
31 "type": "string" | |
32 }, | |
33 "pp": { | |
34 "default": "true", | |
35 "description": "Pretty-print response.", | |
36 "location": "query", | |
37 "type": "boolean" | |
38 }, | |
39 "oauth_token": { | |
40 "description": "OAuth 2.0 token for the current user.", | |
41 "location": "query", | |
42 "type": "string" | |
43 }, | |
44 "bearer_token": { | |
45 "description": "OAuth bearer token.", | |
46 "location": "query", | |
47 "type": "string" | |
48 }, | |
49 "upload_protocol": { | 18 "upload_protocol": { |
50 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 19 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
51 "location": "query", | 20 "location": "query", |
52 "type": "string" | 21 "type": "string" |
53 }, | 22 }, |
54 "prettyPrint": { | 23 "prettyPrint": { |
55 "default": "true", | 24 "default": "true", |
56 "description": "Returns response with indentations and line breaks."
, | 25 "description": "Returns response with indentations and line breaks."
, |
57 "location": "query", | 26 "location": "query", |
58 "type": "boolean" | 27 "type": "boolean" |
59 }, | 28 }, |
60 "uploadType": { | 29 "uploadType": { |
61 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 30 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
62 "location": "query", | 31 "location": "query", |
63 "type": "string" | 32 "type": "string" |
64 }, | 33 }, |
65 "fields": { | 34 "fields": { |
66 "description": "Selector specifying which fields to include in a par
tial response.", | 35 "description": "Selector specifying which fields to include in a par
tial response.", |
67 "location": "query", | 36 "location": "query", |
68 "type": "string" | 37 "type": "string" |
69 }, | 38 }, |
| 39 "callback": { |
| 40 "description": "JSONP", |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
70 "$.xgafv": { | 44 "$.xgafv": { |
71 "description": "V1 error format.", | 45 "description": "V1 error format.", |
72 "enum": [ | 46 "enum": [ |
73 "1", | 47 "1", |
74 "2" | 48 "2" |
75 ], | 49 ], |
76 "enumDescriptions": [ | 50 "enumDescriptions": [ |
77 "v1 error format", | 51 "v1 error format", |
78 "v2 error format" | 52 "v2 error format" |
79 ], | 53 ], |
80 "location": "query", | 54 "location": "query", |
81 "type": "string" | 55 "type": "string" |
82 }, | 56 }, |
83 "callback": { | |
84 "description": "JSONP", | |
85 "location": "query", | |
86 "type": "string" | |
87 }, | |
88 "alt": { | 57 "alt": { |
89 "default": "json", | 58 "default": "json", |
90 "description": "Data format for response.", | 59 "description": "Data format for response.", |
91 "enum": [ | 60 "enum": [ |
92 "json", | 61 "json", |
93 "media", | 62 "media", |
94 "proto" | 63 "proto" |
95 ], | 64 ], |
96 "enumDescriptions": [ | 65 "enumDescriptions": [ |
97 "Responses with Content-Type of application/json", | 66 "Responses with Content-Type of application/json", |
98 "Media download with context-dependent Content-Type", | 67 "Media download with context-dependent Content-Type", |
99 "Responses with Content-Type of application/x-protobuf" | 68 "Responses with Content-Type of application/x-protobuf" |
100 ], | 69 ], |
101 "location": "query", | 70 "location": "query", |
102 "type": "string" | 71 "type": "string" |
| 72 }, |
| 73 "key": { |
| 74 "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.", |
| 75 "location": "query", |
| 76 "type": "string" |
| 77 }, |
| 78 "access_token": { |
| 79 "description": "OAuth access token.", |
| 80 "location": "query", |
| 81 "type": "string" |
| 82 }, |
| 83 "quotaUser": { |
| 84 "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.", |
| 85 "location": "query", |
| 86 "type": "string" |
| 87 }, |
| 88 "pp": { |
| 89 "default": "true", |
| 90 "description": "Pretty-print response.", |
| 91 "location": "query", |
| 92 "type": "boolean" |
| 93 }, |
| 94 "bearer_token": { |
| 95 "description": "OAuth bearer token.", |
| 96 "location": "query", |
| 97 "type": "string" |
| 98 }, |
| 99 "oauth_token": { |
| 100 "description": "OAuth 2.0 token for the current user.", |
| 101 "location": "query", |
| 102 "type": "string" |
103 } | 103 } |
104 }, | 104 }, |
105 "protocol": "rest", | 105 "protocol": "rest", |
106 "resources": { | 106 "resources": { |
107 "threatLists": { | |
108 "methods": { | |
109 "list": { | |
110 "description": "Lists the Safe Browsing threat lists availab
le for download.", | |
111 "httpMethod": "GET", | |
112 "id": "safebrowsing.threatLists.list", | |
113 "parameterOrder": [], | |
114 "parameters": {}, | |
115 "path": "v4/threatLists", | |
116 "response": { | |
117 "$ref": "ListThreatListsResponse" | |
118 } | |
119 } | |
120 } | |
121 }, | |
122 "threatMatches": { | |
123 "methods": { | |
124 "find": { | |
125 "description": "Finds the threat entries that match the Safe
Browsing lists.", | |
126 "httpMethod": "POST", | |
127 "id": "safebrowsing.threatMatches.find", | |
128 "parameterOrder": [], | |
129 "parameters": {}, | |
130 "path": "v4/threatMatches:find", | |
131 "request": { | |
132 "$ref": "FindThreatMatchesRequest" | |
133 }, | |
134 "response": { | |
135 "$ref": "FindThreatMatchesResponse" | |
136 } | |
137 } | |
138 } | |
139 }, | |
140 "fullHashes": { | 107 "fullHashes": { |
141 "methods": { | 108 "methods": { |
142 "find": { | 109 "find": { |
143 "description": "Finds the full hashes that match the request
ed hash prefixes.", | 110 "description": "Finds the full hashes that match the request
ed hash prefixes.", |
144 "httpMethod": "POST", | 111 "httpMethod": "POST", |
145 "id": "safebrowsing.fullHashes.find", | 112 "id": "safebrowsing.fullHashes.find", |
146 "parameterOrder": [], | 113 "parameterOrder": [], |
147 "parameters": {}, | 114 "parameters": {}, |
148 "path": "v4/fullHashes:find", | 115 "path": "v4/fullHashes:find", |
149 "request": { | 116 "request": { |
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
211 "encodedFullHashes": { | 178 "encodedFullHashes": { |
212 "methods": { | 179 "methods": { |
213 "get": { | 180 "get": { |
214 "description": "", | 181 "description": "", |
215 "httpMethod": "GET", | 182 "httpMethod": "GET", |
216 "id": "safebrowsing.encodedFullHashes.get", | 183 "id": "safebrowsing.encodedFullHashes.get", |
217 "parameterOrder": [ | 184 "parameterOrder": [ |
218 "encodedRequest" | 185 "encodedRequest" |
219 ], | 186 ], |
220 "parameters": { | 187 "parameters": { |
| 188 "encodedRequest": { |
| 189 "description": "A serialized FindFullHashesRequest p
roto.", |
| 190 "format": "byte", |
| 191 "location": "path", |
| 192 "required": true, |
| 193 "type": "string" |
| 194 }, |
221 "clientId": { | 195 "clientId": { |
222 "description": "A client ID that (hopefully) uniquel
y identifies the client implementation\nof the Safe Browsing API.", | 196 "description": "A client ID that (hopefully) uniquel
y identifies the client implementation\nof the Safe Browsing API.", |
223 "location": "query", | 197 "location": "query", |
224 "type": "string" | 198 "type": "string" |
225 }, | 199 }, |
226 "clientVersion": { | 200 "clientVersion": { |
227 "description": "The version of the client implementa
tion.", | 201 "description": "The version of the client implementa
tion.", |
228 "location": "query", | 202 "location": "query", |
229 "type": "string" | 203 "type": "string" |
230 }, | |
231 "encodedRequest": { | |
232 "description": "A serialized FindFullHashesRequest p
roto.", | |
233 "format": "byte", | |
234 "location": "path", | |
235 "required": true, | |
236 "type": "string" | |
237 } | 204 } |
238 }, | 205 }, |
239 "path": "v4/encodedFullHashes/{encodedRequest}", | 206 "path": "v4/encodedFullHashes/{encodedRequest}", |
240 "response": { | 207 "response": { |
241 "$ref": "FindFullHashesResponse" | 208 "$ref": "FindFullHashesResponse" |
242 } | 209 } |
243 } | 210 } |
244 } | 211 } |
| 212 }, |
| 213 "threatLists": { |
| 214 "methods": { |
| 215 "list": { |
| 216 "description": "Lists the Safe Browsing threat lists availab
le for download.", |
| 217 "httpMethod": "GET", |
| 218 "id": "safebrowsing.threatLists.list", |
| 219 "parameterOrder": [], |
| 220 "parameters": {}, |
| 221 "path": "v4/threatLists", |
| 222 "response": { |
| 223 "$ref": "ListThreatListsResponse" |
| 224 } |
| 225 } |
| 226 } |
| 227 }, |
| 228 "threatMatches": { |
| 229 "methods": { |
| 230 "find": { |
| 231 "description": "Finds the threat entries that match the Safe
Browsing lists.", |
| 232 "httpMethod": "POST", |
| 233 "id": "safebrowsing.threatMatches.find", |
| 234 "parameterOrder": [], |
| 235 "parameters": {}, |
| 236 "path": "v4/threatMatches:find", |
| 237 "request": { |
| 238 "$ref": "FindThreatMatchesRequest" |
| 239 }, |
| 240 "response": { |
| 241 "$ref": "FindThreatMatchesResponse" |
| 242 } |
| 243 } |
| 244 } |
245 } | 245 } |
246 }, | 246 }, |
247 "revision": "20170319", | 247 "revision": "20170404", |
248 "rootUrl": "https://safebrowsing.googleapis.com/", | 248 "rootUrl": "https://safebrowsing.googleapis.com/", |
249 "schemas": { | 249 "schemas": { |
250 "ThreatEntryMetadata": { | 250 "FetchThreatListUpdatesRequest": { |
251 "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.", | 251 "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", |
252 "id": "ThreatEntryMetadata", | 252 "id": "FetchThreatListUpdatesRequest", |
253 "properties": { | 253 "properties": { |
254 "entries": { | 254 "listUpdateRequests": { |
255 "description": "The metadata entries.", | 255 "description": "The requested threat list updates.", |
256 "items": { | 256 "items": { |
257 "$ref": "MetadataEntry" | 257 "$ref": "ListUpdateRequest" |
258 }, | 258 }, |
259 "type": "array" | 259 "type": "array" |
| 260 }, |
| 261 "client": { |
| 262 "$ref": "ClientInfo", |
| 263 "description": "The client metadata." |
260 } | 264 } |
261 }, | 265 }, |
262 "type": "object" | 266 "type": "object" |
263 }, | 267 }, |
264 "RawIndices": { | 268 "ListUpdateResponse": { |
265 "description": "A set of raw indices to remove from a local list.", | 269 "description": "An update to an individual list.", |
266 "id": "RawIndices", | 270 "id": "ListUpdateResponse", |
267 "properties": { | 271 "properties": { |
268 "indices": { | 272 "checksum": { |
269 "description": "The indices to remove from a lexicographical
ly-sorted local list.", | 273 "$ref": "Checksum", |
| 274 "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." |
| 275 }, |
| 276 "responseType": { |
| 277 "description": "The type of response. This may indicate that
an action is required by the\nclient when the response is received.", |
| 278 "enum": [ |
| 279 "RESPONSE_TYPE_UNSPECIFIED", |
| 280 "PARTIAL_UPDATE", |
| 281 "FULL_UPDATE" |
| 282 ], |
| 283 "enumDescriptions": [ |
| 284 "Unknown.", |
| 285 "Partial updates are applied to the client's existing lo
cal database.", |
| 286 "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." |
| 287 ], |
| 288 "type": "string" |
| 289 }, |
| 290 "threatType": { |
| 291 "description": "The threat type for which data is returned."
, |
| 292 "enum": [ |
| 293 "THREAT_TYPE_UNSPECIFIED", |
| 294 "MALWARE", |
| 295 "SOCIAL_ENGINEERING", |
| 296 "UNWANTED_SOFTWARE", |
| 297 "POTENTIALLY_HARMFUL_APPLICATION" |
| 298 ], |
| 299 "enumDescriptions": [ |
| 300 "Unknown.", |
| 301 "Malware threat type.", |
| 302 "Social engineering threat type.", |
| 303 "Unwanted software threat type.", |
| 304 "Potentially harmful application threat type." |
| 305 ], |
| 306 "type": "string" |
| 307 }, |
| 308 "removals": { |
| 309 "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.", |
270 "items": { | 310 "items": { |
271 "format": "int32", | 311 "$ref": "ThreatEntrySet" |
272 "type": "integer" | |
273 }, | |
274 "type": "array" | |
275 } | |
276 }, | |
277 "type": "object" | |
278 }, | |
279 "RawHashes": { | |
280 "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.", | |
281 "id": "RawHashes", | |
282 "properties": { | |
283 "prefixSize": { | |
284 "description": "The number of bytes for each prefix encoded
below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256
hash).", | |
285 "format": "int32", | |
286 "type": "integer" | |
287 }, | |
288 "rawHashes": { | |
289 "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.", | |
290 "format": "byte", | |
291 "type": "string" | |
292 } | |
293 }, | |
294 "type": "object" | |
295 }, | |
296 "FetchThreatListUpdatesResponse": { | |
297 "id": "FetchThreatListUpdatesResponse", | |
298 "properties": { | |
299 "listUpdateResponses": { | |
300 "description": "The list updates requested by the clients.", | |
301 "items": { | |
302 "$ref": "ListUpdateResponse" | |
303 }, | 312 }, |
304 "type": "array" | 313 "type": "array" |
305 }, | 314 }, |
306 "minimumWaitDuration": { | 315 "newClientState": { |
307 "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.", | 316 "description": "The new client state, in encrypted format. O
paque to clients.", |
308 "format": "google-duration", | |
309 "type": "string" | |
310 } | |
311 }, | |
312 "type": "object" | |
313 }, | |
314 "Checksum": { | |
315 "description": "The expected state of a client's local database.", | |
316 "id": "Checksum", | |
317 "properties": { | |
318 "sha256": { | |
319 "description": "The SHA256 hash of the client state; that is
, of the sorted list of all\nhashes present in the database.", | |
320 "format": "byte", | |
321 "type": "string" | |
322 } | |
323 }, | |
324 "type": "object" | |
325 }, | |
326 "FindFullHashesResponse": { | |
327 "id": "FindFullHashesResponse", | |
328 "properties": { | |
329 "minimumWaitDuration": { | |
330 "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.", | |
331 "format": "google-duration", | |
332 "type": "string" | |
333 }, | |
334 "matches": { | |
335 "description": "The full hashes that matched the requested p
refixes.", | |
336 "items": { | |
337 "$ref": "ThreatMatch" | |
338 }, | |
339 "type": "array" | |
340 }, | |
341 "negativeCacheDuration": { | |
342 "description": "For requested entities that did not match th
e threat list, how long to\ncache the response.", | |
343 "format": "google-duration", | |
344 "type": "string" | |
345 } | |
346 }, | |
347 "type": "object" | |
348 }, | |
349 "ThreatEntrySet": { | |
350 "description": "A set of threats that should be added or removed fro
m a client's local\ndatabase.", | |
351 "id": "ThreatEntrySet", | |
352 "properties": { | |
353 "compressionType": { | |
354 "description": "The compression type for the entries in this
set.", | |
355 "enum": [ | |
356 "COMPRESSION_TYPE_UNSPECIFIED", | |
357 "RAW", | |
358 "RICE" | |
359 ], | |
360 "enumDescriptions": [ | |
361 "Unknown.", | |
362 "Raw, uncompressed data.", | |
363 "Rice-Golomb encoded data." | |
364 ], | |
365 "type": "string" | |
366 }, | |
367 "riceIndices": { | |
368 "$ref": "RiceDeltaEncoding", | |
369 "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." | |
370 }, | |
371 "rawIndices": { | |
372 "$ref": "RawIndices", | |
373 "description": "The raw removal indices for a local list." | |
374 }, | |
375 "rawHashes": { | |
376 "$ref": "RawHashes", | |
377 "description": "The raw SHA256-formatted entries." | |
378 }, | |
379 "riceHashes": { | |
380 "$ref": "RiceDeltaEncoding", | |
381 "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." | |
382 } | |
383 }, | |
384 "type": "object" | |
385 }, | |
386 "FindFullHashesRequest": { | |
387 "description": "Request to return full hashes matched by the provide
d hash prefixes.", | |
388 "id": "FindFullHashesRequest", | |
389 "properties": { | |
390 "client": { | |
391 "$ref": "ClientInfo", | |
392 "description": "The client metadata." | |
393 }, | |
394 "threatInfo": { | |
395 "$ref": "ThreatInfo", | |
396 "description": "The lists and hashes to be checked." | |
397 }, | |
398 "apiClient": { | |
399 "$ref": "ClientInfo", | |
400 "description": "Client metadata associated with callers of h
igher-level APIs built on top\nof the client's implementation." | |
401 }, | |
402 "clientStates": { | |
403 "description": "The current client states for each of the cl
ient's local threat lists.", | |
404 "items": { | |
405 "format": "byte", | |
406 "type": "string" | |
407 }, | |
408 "type": "array" | |
409 } | |
410 }, | |
411 "type": "object" | |
412 }, | |
413 "ListUpdateRequest": { | |
414 "description": "A single list update request.", | |
415 "id": "ListUpdateRequest", | |
416 "properties": { | |
417 "state": { | |
418 "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).", | |
419 "format": "byte", | 317 "format": "byte", |
420 "type": "string" | 318 "type": "string" |
421 }, | 319 }, |
422 "platformType": { | 320 "platformType": { |
423 "description": "The type of platform at risk by entries pres
ent in the list.", | 321 "description": "The platform type for which data is returned
.", |
424 "enum": [ | 322 "enum": [ |
425 "PLATFORM_TYPE_UNSPECIFIED", | 323 "PLATFORM_TYPE_UNSPECIFIED", |
426 "WINDOWS", | 324 "WINDOWS", |
427 "LINUX", | 325 "LINUX", |
428 "ANDROID", | 326 "ANDROID", |
429 "OSX", | 327 "OSX", |
430 "IOS", | 328 "IOS", |
431 "ANY_PLATFORM", | 329 "ANY_PLATFORM", |
432 "ALL_PLATFORMS", | 330 "ALL_PLATFORMS", |
433 "CHROME" | 331 "CHROME" |
434 ], | 332 ], |
435 "enumDescriptions": [ | 333 "enumDescriptions": [ |
436 "Unknown platform.", | 334 "Unknown platform.", |
437 "Threat posed to Windows.", | 335 "Threat posed to Windows.", |
438 "Threat posed to Linux.", | 336 "Threat posed to Linux.", |
439 "Threat posed to Android.", | 337 "Threat posed to Android.", |
440 "Threat posed to OS X.", | 338 "Threat posed to OS X.", |
441 "Threat posed to iOS.", | 339 "Threat posed to iOS.", |
442 "Threat posed to at least one of the defined platforms."
, | 340 "Threat posed to at least one of the defined platforms."
, |
443 "Threat posed to all defined platforms.", | 341 "Threat posed to all defined platforms.", |
444 "Threat posed to Chrome." | 342 "Threat posed to Chrome." |
445 ], | 343 ], |
446 "type": "string" | 344 "type": "string" |
447 }, | 345 }, |
448 "threatType": { | |
449 "description": "The type of threat posed by entries present
in the list.", | |
450 "enum": [ | |
451 "THREAT_TYPE_UNSPECIFIED", | |
452 "MALWARE", | |
453 "SOCIAL_ENGINEERING", | |
454 "UNWANTED_SOFTWARE", | |
455 "POTENTIALLY_HARMFUL_APPLICATION" | |
456 ], | |
457 "enumDescriptions": [ | |
458 "Unknown.", | |
459 "Malware threat type.", | |
460 "Social engineering threat type.", | |
461 "Unwanted software threat type.", | |
462 "Potentially harmful application threat type." | |
463 ], | |
464 "type": "string" | |
465 }, | |
466 "constraints": { | |
467 "$ref": "Constraints", | |
468 "description": "The constraints associated with this request
." | |
469 }, | |
470 "threatEntryType": { | 346 "threatEntryType": { |
471 "description": "The types of entries present in the list.", | 347 "description": "The format of the threats.", |
472 "enum": [ | 348 "enum": [ |
473 "THREAT_ENTRY_TYPE_UNSPECIFIED", | 349 "THREAT_ENTRY_TYPE_UNSPECIFIED", |
474 "URL", | 350 "URL", |
475 "EXECUTABLE", | 351 "EXECUTABLE", |
476 "IP_RANGE", | 352 "IP_RANGE", |
477 "CHROME_EXTENSION", | 353 "CHROME_EXTENSION", |
478 "FILENAME", | 354 "FILENAME", |
479 "CERT" | 355 "CERT" |
480 ], | 356 ], |
481 "enumDescriptions": [ | 357 "enumDescriptions": [ |
482 "Unspecified.", | 358 "Unspecified.", |
483 "A URL.", | 359 "A URL.", |
484 "An executable program.", | 360 "An executable program.", |
485 "An IP range.", | 361 "An IP range.", |
486 "Chrome extension.", | 362 "Chrome extension.", |
487 "Filename.", | 363 "Filename.", |
488 "CERT" | 364 "CERT" |
489 ], | 365 ], |
490 "type": "string" | 366 "type": "string" |
| 367 }, |
| 368 "additions": { |
| 369 "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.", |
| 370 "items": { |
| 371 "$ref": "ThreatEntrySet" |
| 372 }, |
| 373 "type": "array" |
| 374 } |
| 375 }, |
| 376 "type": "object" |
| 377 }, |
| 378 "Constraints": { |
| 379 "description": "The constraints for this update.", |
| 380 "id": "Constraints", |
| 381 "properties": { |
| 382 "supportedCompressions": { |
| 383 "description": "The compression types supported by the clien
t.", |
| 384 "enumDescriptions": [ |
| 385 "Unknown.", |
| 386 "Raw, uncompressed data.", |
| 387 "Rice-Golomb encoded data." |
| 388 ], |
| 389 "items": { |
| 390 "enum": [ |
| 391 "COMPRESSION_TYPE_UNSPECIFIED", |
| 392 "RAW", |
| 393 "RICE" |
| 394 ], |
| 395 "type": "string" |
| 396 }, |
| 397 "type": "array" |
| 398 }, |
| 399 "maxUpdateEntries": { |
| 400 "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.", |
| 401 "format": "int32", |
| 402 "type": "integer" |
| 403 }, |
| 404 "maxDatabaseEntries": { |
| 405 "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.", |
| 406 "format": "int32", |
| 407 "type": "integer" |
| 408 }, |
| 409 "region": { |
| 410 "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.", |
| 411 "type": "string" |
491 } | 412 } |
492 }, | 413 }, |
493 "type": "object" | 414 "type": "object" |
494 }, | 415 }, |
495 "FetchThreatListUpdatesRequest": { | 416 "ThreatMatch": { |
496 "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", | 417 "description": "A match when checking a threat entry in the Safe Bro
wsing threat lists.", |
497 "id": "FetchThreatListUpdatesRequest", | 418 "id": "ThreatMatch", |
498 "properties": { | 419 "properties": { |
499 "listUpdateRequests": { | 420 "cacheDuration": { |
500 "description": "The requested threat list updates.", | 421 "description": "The cache lifetime for the returned match. C
lients must not cache this\nresponse for more than this duration to avoid false
positives.", |
501 "items": { | 422 "format": "google-duration", |
502 "$ref": "ListUpdateRequest" | 423 "type": "string" |
503 }, | |
504 "type": "array" | |
505 }, | 424 }, |
506 "client": { | 425 "threatEntryMetadata": { |
507 "$ref": "ClientInfo", | 426 "$ref": "ThreatEntryMetadata", |
508 "description": "The client metadata." | 427 "description": "Optional metadata associated with this threa
t." |
509 } | 428 }, |
510 }, | 429 "threatType": { |
511 "type": "object" | 430 "description": "The threat type matching this threat.", |
512 }, | 431 "enum": [ |
513 "ListUpdateResponse": { | 432 "THREAT_TYPE_UNSPECIFIED", |
514 "description": "An update to an individual list.", | 433 "MALWARE", |
515 "id": "ListUpdateResponse", | 434 "SOCIAL_ENGINEERING", |
516 "properties": { | 435 "UNWANTED_SOFTWARE", |
| 436 "POTENTIALLY_HARMFUL_APPLICATION" |
| 437 ], |
| 438 "enumDescriptions": [ |
| 439 "Unknown.", |
| 440 "Malware threat type.", |
| 441 "Social engineering threat type.", |
| 442 "Unwanted software threat type.", |
| 443 "Potentially harmful application threat type." |
| 444 ], |
| 445 "type": "string" |
| 446 }, |
| 447 "threat": { |
| 448 "$ref": "ThreatEntry", |
| 449 "description": "The threat matching this threat." |
| 450 }, |
517 "platformType": { | 451 "platformType": { |
518 "description": "The platform type for which data is returned
.", | 452 "description": "The platform type matching this threat.", |
519 "enum": [ | 453 "enum": [ |
520 "PLATFORM_TYPE_UNSPECIFIED", | 454 "PLATFORM_TYPE_UNSPECIFIED", |
521 "WINDOWS", | 455 "WINDOWS", |
522 "LINUX", | 456 "LINUX", |
523 "ANDROID", | 457 "ANDROID", |
524 "OSX", | 458 "OSX", |
525 "IOS", | 459 "IOS", |
526 "ANY_PLATFORM", | 460 "ANY_PLATFORM", |
527 "ALL_PLATFORMS", | 461 "ALL_PLATFORMS", |
528 "CHROME" | 462 "CHROME" |
529 ], | 463 ], |
530 "enumDescriptions": [ | 464 "enumDescriptions": [ |
531 "Unknown platform.", | 465 "Unknown platform.", |
532 "Threat posed to Windows.", | 466 "Threat posed to Windows.", |
533 "Threat posed to Linux.", | 467 "Threat posed to Linux.", |
534 "Threat posed to Android.", | 468 "Threat posed to Android.", |
535 "Threat posed to OS X.", | 469 "Threat posed to OS X.", |
536 "Threat posed to iOS.", | 470 "Threat posed to iOS.", |
537 "Threat posed to at least one of the defined platforms."
, | 471 "Threat posed to at least one of the defined platforms."
, |
538 "Threat posed to all defined platforms.", | 472 "Threat posed to all defined platforms.", |
539 "Threat posed to Chrome." | 473 "Threat posed to Chrome." |
540 ], | 474 ], |
541 "type": "string" | 475 "type": "string" |
542 }, | 476 }, |
543 "threatEntryType": { | 477 "threatEntryType": { |
544 "description": "The format of the threats.", | 478 "description": "The threat entry type matching this threat."
, |
545 "enum": [ | 479 "enum": [ |
546 "THREAT_ENTRY_TYPE_UNSPECIFIED", | 480 "THREAT_ENTRY_TYPE_UNSPECIFIED", |
547 "URL", | 481 "URL", |
548 "EXECUTABLE", | 482 "EXECUTABLE", |
549 "IP_RANGE", | 483 "IP_RANGE", |
550 "CHROME_EXTENSION", | 484 "CHROME_EXTENSION", |
551 "FILENAME", | 485 "FILENAME", |
552 "CERT" | 486 "CERT" |
553 ], | 487 ], |
554 "enumDescriptions": [ | 488 "enumDescriptions": [ |
555 "Unspecified.", | 489 "Unspecified.", |
556 "A URL.", | 490 "A URL.", |
557 "An executable program.", | 491 "An executable program.", |
558 "An IP range.", | 492 "An IP range.", |
559 "Chrome extension.", | 493 "Chrome extension.", |
560 "Filename.", | 494 "Filename.", |
561 "CERT" | 495 "CERT" |
562 ], | 496 ], |
563 "type": "string" | 497 "type": "string" |
564 }, | |
565 "additions": { | |
566 "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.", | |
567 "items": { | |
568 "$ref": "ThreatEntrySet" | |
569 }, | |
570 "type": "array" | |
571 }, | |
572 "checksum": { | |
573 "$ref": "Checksum", | |
574 "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." | |
575 }, | |
576 "responseType": { | |
577 "description": "The type of response. This may indicate that
an action is required by the\nclient when the response is received.", | |
578 "enum": [ | |
579 "RESPONSE_TYPE_UNSPECIFIED", | |
580 "PARTIAL_UPDATE", | |
581 "FULL_UPDATE" | |
582 ], | |
583 "enumDescriptions": [ | |
584 "Unknown.", | |
585 "Partial updates are applied to the client's existing lo
cal database.", | |
586 "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." | |
587 ], | |
588 "type": "string" | |
589 }, | |
590 "threatType": { | |
591 "description": "The threat type for which data is returned."
, | |
592 "enum": [ | |
593 "THREAT_TYPE_UNSPECIFIED", | |
594 "MALWARE", | |
595 "SOCIAL_ENGINEERING", | |
596 "UNWANTED_SOFTWARE", | |
597 "POTENTIALLY_HARMFUL_APPLICATION" | |
598 ], | |
599 "enumDescriptions": [ | |
600 "Unknown.", | |
601 "Malware threat type.", | |
602 "Social engineering threat type.", | |
603 "Unwanted software threat type.", | |
604 "Potentially harmful application threat type." | |
605 ], | |
606 "type": "string" | |
607 }, | |
608 "newClientState": { | |
609 "description": "The new client state, in encrypted format. O
paque to clients.", | |
610 "format": "byte", | |
611 "type": "string" | |
612 }, | |
613 "removals": { | |
614 "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.", | |
615 "items": { | |
616 "$ref": "ThreatEntrySet" | |
617 }, | |
618 "type": "array" | |
619 } | |
620 }, | |
621 "type": "object" | |
622 }, | |
623 "Constraints": { | |
624 "description": "The constraints for this update.", | |
625 "id": "Constraints", | |
626 "properties": { | |
627 "maxDatabaseEntries": { | |
628 "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.", | |
629 "format": "int32", | |
630 "type": "integer" | |
631 }, | |
632 "region": { | |
633 "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.", | |
634 "type": "string" | |
635 }, | |
636 "supportedCompressions": { | |
637 "description": "The compression types supported by the clien
t.", | |
638 "enumDescriptions": [ | |
639 "Unknown.", | |
640 "Raw, uncompressed data.", | |
641 "Rice-Golomb encoded data." | |
642 ], | |
643 "items": { | |
644 "enum": [ | |
645 "COMPRESSION_TYPE_UNSPECIFIED", | |
646 "RAW", | |
647 "RICE" | |
648 ], | |
649 "type": "string" | |
650 }, | |
651 "type": "array" | |
652 }, | |
653 "maxUpdateEntries": { | |
654 "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.", | |
655 "format": "int32", | |
656 "type": "integer" | |
657 } | |
658 }, | |
659 "type": "object" | |
660 }, | |
661 "ThreatMatch": { | |
662 "description": "A match when checking a threat entry in the Safe Bro
wsing threat lists.", | |
663 "id": "ThreatMatch", | |
664 "properties": { | |
665 "cacheDuration": { | |
666 "description": "The cache lifetime for the returned match. C
lients must not cache this\nresponse for more than this duration to avoid false
positives.", | |
667 "format": "google-duration", | |
668 "type": "string" | |
669 }, | |
670 "threatType": { | |
671 "description": "The threat type matching this threat.", | |
672 "enum": [ | |
673 "THREAT_TYPE_UNSPECIFIED", | |
674 "MALWARE", | |
675 "SOCIAL_ENGINEERING", | |
676 "UNWANTED_SOFTWARE", | |
677 "POTENTIALLY_HARMFUL_APPLICATION" | |
678 ], | |
679 "enumDescriptions": [ | |
680 "Unknown.", | |
681 "Malware threat type.", | |
682 "Social engineering threat type.", | |
683 "Unwanted software threat type.", | |
684 "Potentially harmful application threat type." | |
685 ], | |
686 "type": "string" | |
687 }, | |
688 "threatEntryMetadata": { | |
689 "$ref": "ThreatEntryMetadata", | |
690 "description": "Optional metadata associated with this threa
t." | |
691 }, | |
692 "threat": { | |
693 "$ref": "ThreatEntry", | |
694 "description": "The threat matching this threat." | |
695 }, | |
696 "platformType": { | |
697 "description": "The platform type matching this threat.", | |
698 "enum": [ | |
699 "PLATFORM_TYPE_UNSPECIFIED", | |
700 "WINDOWS", | |
701 "LINUX", | |
702 "ANDROID", | |
703 "OSX", | |
704 "IOS", | |
705 "ANY_PLATFORM", | |
706 "ALL_PLATFORMS", | |
707 "CHROME" | |
708 ], | |
709 "enumDescriptions": [ | |
710 "Unknown platform.", | |
711 "Threat posed to Windows.", | |
712 "Threat posed to Linux.", | |
713 "Threat posed to Android.", | |
714 "Threat posed to OS X.", | |
715 "Threat posed to iOS.", | |
716 "Threat posed to at least one of the defined platforms."
, | |
717 "Threat posed to all defined platforms.", | |
718 "Threat posed to Chrome." | |
719 ], | |
720 "type": "string" | |
721 }, | |
722 "threatEntryType": { | |
723 "description": "The threat entry type matching this threat."
, | |
724 "enum": [ | |
725 "THREAT_ENTRY_TYPE_UNSPECIFIED", | |
726 "URL", | |
727 "EXECUTABLE", | |
728 "IP_RANGE", | |
729 "CHROME_EXTENSION", | |
730 "FILENAME", | |
731 "CERT" | |
732 ], | |
733 "enumDescriptions": [ | |
734 "Unspecified.", | |
735 "A URL.", | |
736 "An executable program.", | |
737 "An IP range.", | |
738 "Chrome extension.", | |
739 "Filename.", | |
740 "CERT" | |
741 ], | |
742 "type": "string" | |
743 } | 498 } |
744 }, | 499 }, |
745 "type": "object" | 500 "type": "object" |
746 }, | 501 }, |
747 "RiceDeltaEncoding": { | 502 "RiceDeltaEncoding": { |
748 "description": "The Rice-Golomb encoded data. Used for sending compr
essed 4-byte hashes or\ncompressed removal indices.", | 503 "description": "The Rice-Golomb encoded data. Used for sending compr
essed 4-byte hashes or\ncompressed removal indices.", |
749 "id": "RiceDeltaEncoding", | 504 "id": "RiceDeltaEncoding", |
750 "properties": { | 505 "properties": { |
751 "firstValue": { | 506 "firstValue": { |
752 "description": "The offset of the first entry in the encoded
data, or, if only a single\ninteger was encoded, that single integer's value.", | 507 "description": "The offset of the first entry in the encoded
data, or, if only a single\ninteger was encoded, that single integer's value.", |
(...skipping 23 matching lines...) Expand all Loading... |
776 "properties": { | 531 "properties": { |
777 "threatLists": { | 532 "threatLists": { |
778 "description": "The lists available for download by the clie
nt.", | 533 "description": "The lists available for download by the clie
nt.", |
779 "items": { | 534 "items": { |
780 "$ref": "ThreatListDescriptor" | 535 "$ref": "ThreatListDescriptor" |
781 }, | 536 }, |
782 "type": "array" | 537 "type": "array" |
783 } | 538 } |
784 }, | 539 }, |
785 "type": "object" | 540 "type": "object" |
| 541 }, |
| 542 "ThreatEntry": { |
| 543 "description": "An individual threat; for example, a malicious URL o
r its hash\nrepresentation. Only one of these fields should be set.", |
| 544 "id": "ThreatEntry", |
| 545 "properties": { |
| 546 "url": { |
| 547 "description": "A URL.", |
| 548 "type": "string" |
| 549 }, |
| 550 "digest": { |
| 551 "description": "The digest of an executable in SHA256 format
. The API supports both\nbinary and hex digests. For JSON requests, digests are
base64-encoded.", |
| 552 "format": "byte", |
| 553 "type": "string" |
| 554 }, |
| 555 "hash": { |
| 556 "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.", |
| 557 "format": "byte", |
| 558 "type": "string" |
| 559 } |
| 560 }, |
| 561 "type": "object" |
786 }, | 562 }, |
787 "FindThreatMatchesResponse": { | 563 "FindThreatMatchesResponse": { |
788 "id": "FindThreatMatchesResponse", | 564 "id": "FindThreatMatchesResponse", |
789 "properties": { | 565 "properties": { |
790 "matches": { | 566 "matches": { |
791 "description": "The threat list matches.", | 567 "description": "The threat list matches.", |
792 "items": { | 568 "items": { |
793 "$ref": "ThreatMatch" | 569 "$ref": "ThreatMatch" |
794 }, | 570 }, |
795 "type": "array" | 571 "type": "array" |
796 } | 572 } |
797 }, | 573 }, |
798 "type": "object" | 574 "type": "object" |
799 }, | 575 }, |
800 "ThreatEntry": { | |
801 "description": "An individual threat; for example, a malicious URL o
r its hash\nrepresentation. Only one of these fields should be set.", | |
802 "id": "ThreatEntry", | |
803 "properties": { | |
804 "digest": { | |
805 "description": "The digest of an executable in SHA256 format
. The API supports both\nbinary and hex digests. For JSON requests, digests are
base64-encoded.", | |
806 "format": "byte", | |
807 "type": "string" | |
808 }, | |
809 "hash": { | |
810 "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.", | |
811 "format": "byte", | |
812 "type": "string" | |
813 }, | |
814 "url": { | |
815 "description": "A URL.", | |
816 "type": "string" | |
817 } | |
818 }, | |
819 "type": "object" | |
820 }, | |
821 "ThreatListDescriptor": { | 576 "ThreatListDescriptor": { |
822 "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.", | 577 "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.", |
823 "id": "ThreatListDescriptor", | 578 "id": "ThreatListDescriptor", |
824 "properties": { | 579 "properties": { |
825 "platformType": { | 580 "platformType": { |
826 "description": "The platform type targeted by the list's ent
ries.", | 581 "description": "The platform type targeted by the list's ent
ries.", |
827 "enum": [ | 582 "enum": [ |
828 "PLATFORM_TYPE_UNSPECIFIED", | 583 "PLATFORM_TYPE_UNSPECIFIED", |
829 "WINDOWS", | 584 "WINDOWS", |
830 "LINUX", | 585 "LINUX", |
(...skipping 74 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
905 "format": "byte", | 660 "format": "byte", |
906 "type": "string" | 661 "type": "string" |
907 } | 662 } |
908 }, | 663 }, |
909 "type": "object" | 664 "type": "object" |
910 }, | 665 }, |
911 "ClientInfo": { | 666 "ClientInfo": { |
912 "description": "The client metadata associated with Safe Browsing AP
I requests.", | 667 "description": "The client metadata associated with Safe Browsing AP
I requests.", |
913 "id": "ClientInfo", | 668 "id": "ClientInfo", |
914 "properties": { | 669 "properties": { |
| 670 "clientId": { |
| 671 "description": "A client ID that (hopefully) uniquely identi
fies the client implementation\nof the Safe Browsing API.", |
| 672 "type": "string" |
| 673 }, |
915 "clientVersion": { | 674 "clientVersion": { |
916 "description": "The version of the client implementation.", | 675 "description": "The version of the client implementation.", |
917 "type": "string" | 676 "type": "string" |
918 }, | |
919 "clientId": { | |
920 "description": "A client ID that (hopefully) uniquely identi
fies the client implementation\nof the Safe Browsing API.", | |
921 "type": "string" | |
922 } | 677 } |
923 }, | 678 }, |
924 "type": "object" | 679 "type": "object" |
| 680 }, |
| 681 "FindThreatMatchesRequest": { |
| 682 "description": "Request to check entries against lists.", |
| 683 "id": "FindThreatMatchesRequest", |
| 684 "properties": { |
| 685 "client": { |
| 686 "$ref": "ClientInfo", |
| 687 "description": "The client metadata." |
| 688 }, |
| 689 "threatInfo": { |
| 690 "$ref": "ThreatInfo", |
| 691 "description": "The lists and entries to be checked for matc
hes." |
| 692 } |
| 693 }, |
| 694 "type": "object" |
925 }, | 695 }, |
926 "ThreatInfo": { | 696 "ThreatInfo": { |
927 "description": "The information regarding one or more threats that a
client submits when\nchecking for matches in threat lists.", | 697 "description": "The information regarding one or more threats that a
client submits when\nchecking for matches in threat lists.", |
928 "id": "ThreatInfo", | 698 "id": "ThreatInfo", |
929 "properties": { | 699 "properties": { |
930 "platformTypes": { | |
931 "description": "The platform types to be checked.", | |
932 "enumDescriptions": [ | |
933 "Unknown platform.", | |
934 "Threat posed to Windows.", | |
935 "Threat posed to Linux.", | |
936 "Threat posed to Android.", | |
937 "Threat posed to OS X.", | |
938 "Threat posed to iOS.", | |
939 "Threat posed to at least one of the defined platforms."
, | |
940 "Threat posed to all defined platforms.", | |
941 "Threat posed to Chrome." | |
942 ], | |
943 "items": { | |
944 "enum": [ | |
945 "PLATFORM_TYPE_UNSPECIFIED", | |
946 "WINDOWS", | |
947 "LINUX", | |
948 "ANDROID", | |
949 "OSX", | |
950 "IOS", | |
951 "ANY_PLATFORM", | |
952 "ALL_PLATFORMS", | |
953 "CHROME" | |
954 ], | |
955 "type": "string" | |
956 }, | |
957 "type": "array" | |
958 }, | |
959 "threatEntries": { | |
960 "description": "The threat entries to be checked.", | |
961 "items": { | |
962 "$ref": "ThreatEntry" | |
963 }, | |
964 "type": "array" | |
965 }, | |
966 "threatEntryTypes": { | 700 "threatEntryTypes": { |
967 "description": "The entry types to be checked.", | 701 "description": "The entry types to be checked.", |
968 "enumDescriptions": [ | 702 "enumDescriptions": [ |
969 "Unspecified.", | 703 "Unspecified.", |
970 "A URL.", | 704 "A URL.", |
971 "An executable program.", | 705 "An executable program.", |
972 "An IP range.", | 706 "An IP range.", |
973 "Chrome extension.", | 707 "Chrome extension.", |
974 "Filename.", | 708 "Filename.", |
975 "CERT" | 709 "CERT" |
(...skipping 25 matching lines...) Expand all Loading... |
1001 "enum": [ | 735 "enum": [ |
1002 "THREAT_TYPE_UNSPECIFIED", | 736 "THREAT_TYPE_UNSPECIFIED", |
1003 "MALWARE", | 737 "MALWARE", |
1004 "SOCIAL_ENGINEERING", | 738 "SOCIAL_ENGINEERING", |
1005 "UNWANTED_SOFTWARE", | 739 "UNWANTED_SOFTWARE", |
1006 "POTENTIALLY_HARMFUL_APPLICATION" | 740 "POTENTIALLY_HARMFUL_APPLICATION" |
1007 ], | 741 ], |
1008 "type": "string" | 742 "type": "string" |
1009 }, | 743 }, |
1010 "type": "array" | 744 "type": "array" |
1011 } | 745 }, |
1012 }, | 746 "platformTypes": { |
1013 "type": "object" | 747 "description": "The platform types to be checked.", |
1014 }, | 748 "enumDescriptions": [ |
1015 "FindThreatMatchesRequest": { | 749 "Unknown platform.", |
1016 "description": "Request to check entries against lists.", | 750 "Threat posed to Windows.", |
1017 "id": "FindThreatMatchesRequest", | 751 "Threat posed to Linux.", |
1018 "properties": { | 752 "Threat posed to Android.", |
| 753 "Threat posed to OS X.", |
| 754 "Threat posed to iOS.", |
| 755 "Threat posed to at least one of the defined platforms."
, |
| 756 "Threat posed to all defined platforms.", |
| 757 "Threat posed to Chrome." |
| 758 ], |
| 759 "items": { |
| 760 "enum": [ |
| 761 "PLATFORM_TYPE_UNSPECIFIED", |
| 762 "WINDOWS", |
| 763 "LINUX", |
| 764 "ANDROID", |
| 765 "OSX", |
| 766 "IOS", |
| 767 "ANY_PLATFORM", |
| 768 "ALL_PLATFORMS", |
| 769 "CHROME" |
| 770 ], |
| 771 "type": "string" |
| 772 }, |
| 773 "type": "array" |
| 774 }, |
| 775 "threatEntries": { |
| 776 "description": "The threat entries to be checked.", |
| 777 "items": { |
| 778 "$ref": "ThreatEntry" |
| 779 }, |
| 780 "type": "array" |
| 781 } |
| 782 }, |
| 783 "type": "object" |
| 784 }, |
| 785 "ThreatEntryMetadata": { |
| 786 "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.", |
| 787 "id": "ThreatEntryMetadata", |
| 788 "properties": { |
| 789 "entries": { |
| 790 "description": "The metadata entries.", |
| 791 "items": { |
| 792 "$ref": "MetadataEntry" |
| 793 }, |
| 794 "type": "array" |
| 795 } |
| 796 }, |
| 797 "type": "object" |
| 798 }, |
| 799 "RawIndices": { |
| 800 "description": "A set of raw indices to remove from a local list.", |
| 801 "id": "RawIndices", |
| 802 "properties": { |
| 803 "indices": { |
| 804 "description": "The indices to remove from a lexicographical
ly-sorted local list.", |
| 805 "items": { |
| 806 "format": "int32", |
| 807 "type": "integer" |
| 808 }, |
| 809 "type": "array" |
| 810 } |
| 811 }, |
| 812 "type": "object" |
| 813 }, |
| 814 "RawHashes": { |
| 815 "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.", |
| 816 "id": "RawHashes", |
| 817 "properties": { |
| 818 "prefixSize": { |
| 819 "description": "The number of bytes for each prefix encoded
below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256
hash).", |
| 820 "format": "int32", |
| 821 "type": "integer" |
| 822 }, |
| 823 "rawHashes": { |
| 824 "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.", |
| 825 "format": "byte", |
| 826 "type": "string" |
| 827 } |
| 828 }, |
| 829 "type": "object" |
| 830 }, |
| 831 "FetchThreatListUpdatesResponse": { |
| 832 "id": "FetchThreatListUpdatesResponse", |
| 833 "properties": { |
| 834 "listUpdateResponses": { |
| 835 "description": "The list updates requested by the clients.", |
| 836 "items": { |
| 837 "$ref": "ListUpdateResponse" |
| 838 }, |
| 839 "type": "array" |
| 840 }, |
| 841 "minimumWaitDuration": { |
| 842 "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.", |
| 843 "format": "google-duration", |
| 844 "type": "string" |
| 845 } |
| 846 }, |
| 847 "type": "object" |
| 848 }, |
| 849 "Checksum": { |
| 850 "description": "The expected state of a client's local database.", |
| 851 "id": "Checksum", |
| 852 "properties": { |
| 853 "sha256": { |
| 854 "description": "The SHA256 hash of the client state; that is
, of the sorted list of all\nhashes present in the database.", |
| 855 "format": "byte", |
| 856 "type": "string" |
| 857 } |
| 858 }, |
| 859 "type": "object" |
| 860 }, |
| 861 "FindFullHashesResponse": { |
| 862 "id": "FindFullHashesResponse", |
| 863 "properties": { |
| 864 "negativeCacheDuration": { |
| 865 "description": "For requested entities that did not match th
e threat list, how long to\ncache the response.", |
| 866 "format": "google-duration", |
| 867 "type": "string" |
| 868 }, |
| 869 "minimumWaitDuration": { |
| 870 "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.", |
| 871 "format": "google-duration", |
| 872 "type": "string" |
| 873 }, |
| 874 "matches": { |
| 875 "description": "The full hashes that matched the requested p
refixes.", |
| 876 "items": { |
| 877 "$ref": "ThreatMatch" |
| 878 }, |
| 879 "type": "array" |
| 880 } |
| 881 }, |
| 882 "type": "object" |
| 883 }, |
| 884 "ThreatEntrySet": { |
| 885 "description": "A set of threats that should be added or removed fro
m a client's local\ndatabase.", |
| 886 "id": "ThreatEntrySet", |
| 887 "properties": { |
| 888 "rawHashes": { |
| 889 "$ref": "RawHashes", |
| 890 "description": "The raw SHA256-formatted entries." |
| 891 }, |
| 892 "riceHashes": { |
| 893 "$ref": "RiceDeltaEncoding", |
| 894 "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." |
| 895 }, |
| 896 "compressionType": { |
| 897 "description": "The compression type for the entries in this
set.", |
| 898 "enum": [ |
| 899 "COMPRESSION_TYPE_UNSPECIFIED", |
| 900 "RAW", |
| 901 "RICE" |
| 902 ], |
| 903 "enumDescriptions": [ |
| 904 "Unknown.", |
| 905 "Raw, uncompressed data.", |
| 906 "Rice-Golomb encoded data." |
| 907 ], |
| 908 "type": "string" |
| 909 }, |
| 910 "riceIndices": { |
| 911 "$ref": "RiceDeltaEncoding", |
| 912 "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." |
| 913 }, |
| 914 "rawIndices": { |
| 915 "$ref": "RawIndices", |
| 916 "description": "The raw removal indices for a local list." |
| 917 } |
| 918 }, |
| 919 "type": "object" |
| 920 }, |
| 921 "FindFullHashesRequest": { |
| 922 "description": "Request to return full hashes matched by the provide
d hash prefixes.", |
| 923 "id": "FindFullHashesRequest", |
| 924 "properties": { |
| 925 "apiClient": { |
| 926 "$ref": "ClientInfo", |
| 927 "description": "Client metadata associated with callers of h
igher-level APIs built on top\nof the client's implementation." |
| 928 }, |
| 929 "clientStates": { |
| 930 "description": "The current client states for each of the cl
ient's local threat lists.", |
| 931 "items": { |
| 932 "format": "byte", |
| 933 "type": "string" |
| 934 }, |
| 935 "type": "array" |
| 936 }, |
1019 "client": { | 937 "client": { |
1020 "$ref": "ClientInfo", | 938 "$ref": "ClientInfo", |
1021 "description": "The client metadata." | 939 "description": "The client metadata." |
1022 }, | 940 }, |
1023 "threatInfo": { | 941 "threatInfo": { |
1024 "$ref": "ThreatInfo", | 942 "$ref": "ThreatInfo", |
1025 "description": "The lists and entries to be checked for matc
hes." | 943 "description": "The lists and hashes to be checked." |
1026 } | 944 } |
1027 }, | 945 }, |
1028 "type": "object" | 946 "type": "object" |
| 947 }, |
| 948 "ListUpdateRequest": { |
| 949 "description": "A single list update request.", |
| 950 "id": "ListUpdateRequest", |
| 951 "properties": { |
| 952 "state": { |
| 953 "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).", |
| 954 "format": "byte", |
| 955 "type": "string" |
| 956 }, |
| 957 "platformType": { |
| 958 "description": "The type of platform at risk by entries pres
ent in the list.", |
| 959 "enum": [ |
| 960 "PLATFORM_TYPE_UNSPECIFIED", |
| 961 "WINDOWS", |
| 962 "LINUX", |
| 963 "ANDROID", |
| 964 "OSX", |
| 965 "IOS", |
| 966 "ANY_PLATFORM", |
| 967 "ALL_PLATFORMS", |
| 968 "CHROME" |
| 969 ], |
| 970 "enumDescriptions": [ |
| 971 "Unknown platform.", |
| 972 "Threat posed to Windows.", |
| 973 "Threat posed to Linux.", |
| 974 "Threat posed to Android.", |
| 975 "Threat posed to OS X.", |
| 976 "Threat posed to iOS.", |
| 977 "Threat posed to at least one of the defined platforms."
, |
| 978 "Threat posed to all defined platforms.", |
| 979 "Threat posed to Chrome." |
| 980 ], |
| 981 "type": "string" |
| 982 }, |
| 983 "threatType": { |
| 984 "description": "The type of threat posed by entries present
in the list.", |
| 985 "enum": [ |
| 986 "THREAT_TYPE_UNSPECIFIED", |
| 987 "MALWARE", |
| 988 "SOCIAL_ENGINEERING", |
| 989 "UNWANTED_SOFTWARE", |
| 990 "POTENTIALLY_HARMFUL_APPLICATION" |
| 991 ], |
| 992 "enumDescriptions": [ |
| 993 "Unknown.", |
| 994 "Malware threat type.", |
| 995 "Social engineering threat type.", |
| 996 "Unwanted software threat type.", |
| 997 "Potentially harmful application threat type." |
| 998 ], |
| 999 "type": "string" |
| 1000 }, |
| 1001 "constraints": { |
| 1002 "$ref": "Constraints", |
| 1003 "description": "The constraints associated with this request
." |
| 1004 }, |
| 1005 "threatEntryType": { |
| 1006 "description": "The types of entries present in the list.", |
| 1007 "enum": [ |
| 1008 "THREAT_ENTRY_TYPE_UNSPECIFIED", |
| 1009 "URL", |
| 1010 "EXECUTABLE", |
| 1011 "IP_RANGE", |
| 1012 "CHROME_EXTENSION", |
| 1013 "FILENAME", |
| 1014 "CERT" |
| 1015 ], |
| 1016 "enumDescriptions": [ |
| 1017 "Unspecified.", |
| 1018 "A URL.", |
| 1019 "An executable program.", |
| 1020 "An IP range.", |
| 1021 "Chrome extension.", |
| 1022 "Filename.", |
| 1023 "CERT" |
| 1024 ], |
| 1025 "type": "string" |
| 1026 } |
| 1027 }, |
| 1028 "type": "object" |
1029 } | 1029 } |
1030 }, | 1030 }, |
1031 "servicePath": "", | 1031 "servicePath": "", |
1032 "title": "Google Safe Browsing API", | 1032 "title": "Google Safe Browsing API", |
1033 "version": "v4" | 1033 "version": "v4" |
1034 } | 1034 } |
OLD | NEW |