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