Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.VirusTotal.VirusTotalApi.html
src/eric7/Documentation/Source/eric7.WebBrowser.VirusTotal.VirusTotalApi.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10436
- f6881d10e995
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.VirusTotal.VirusTotalApi</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.WebBrowser.VirusTotal.VirusTotalApi</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the <a href="http://www.virustotal.com">VirusTotal</a> | |
| 13 API class. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#VirusTotalAPI">VirusTotalAPI</a></td> | |
| 26 <td>Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <hr /> | |
| 35 <hr /> | |
| 36 <a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a> | |
| 37 <h2>VirusTotalAPI</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> | |
| 41 API. | |
| 42 </p> | |
| 43 <h3>Signals</h3> | |
| 44 <dl> | |
| 45 | |
| 46 <dt>checkServiceKeyFinished(bool, str)</dt> | |
| 47 <dd> | |
| 48 emitted after the service key | |
| 49 check has been performed. It gives a flag indicating validity | |
| 50 (boolean) and an error message in case of a network error (string). | |
| 51 </dd> | |
| 52 <dt>fileScanReport(str)</dt> | |
| 53 <dd> | |
| 54 emitted with the URL of the file scan report | |
| 55 page | |
| 56 </dd> | |
| 57 <dt>submitUrlError(str)</dt> | |
| 58 <dd> | |
| 59 emitted with the error string, if the URL scan | |
| 60 submission returned an error. | |
| 61 </dd> | |
| 62 <dt>urlScanReport(str)</dt> | |
| 63 <dd> | |
| 64 emitted with the URL of the URL scan report page | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <h3>Derived from</h3> | |
| 68 QObject | |
| 69 <h3>Class Attributes</h3> | |
| 70 | |
| 71 <table> | |
| 72 <tr><td>GetDomainReportPattern</td></tr><tr><td>GetFileReportPattern</td></tr><tr><td>GetIpAddressReportPattern</td></tr><tr><td>GetUrlReportPattern</td></tr><tr><td>ScanUrlPattern</td></tr><tr><td>ServiceCode_InvalidKey</td></tr><tr><td>ServiceCode_InvalidPrivilege</td></tr><tr><td>ServiceCode_RateLimitExceeded</td></tr><tr><td>ServiceResult_ItemNotPresent</td></tr><tr><td>ServiceResult_ItemPresent</td></tr><tr><td>ServiceResult_ItemQueued</td></tr><tr><td>TestServiceKeyScanID</td></tr> | |
| 73 </table> | |
| 74 <h3>Class Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 <h3>Methods</h3> | |
| 80 | |
| 81 <table> | |
| 82 | |
| 83 <tr> | |
| 84 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td> | |
| 85 <td>Constructor</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#VirusTotalAPI.__checkServiceKeyValidityFinished">__checkServiceKeyValidityFinished</a></td> | |
| 89 <td>Private slot to determine the result of the service key validity check.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#VirusTotalAPI.__getDomainReportFinished">__getDomainReportFinished</a></td> | |
| 93 <td>Private slot to process the IP address report data.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#VirusTotalAPI.__getFileScanReportUrl">__getFileScanReportUrl</a></td> | |
| 97 <td>Private method to get the report URL for a file scan.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#VirusTotalAPI.__getFileScanReportUrlFinished">__getFileScanReportUrlFinished</a></td> | |
| 101 <td>Private slot to determine the result of the file scan report URL request.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#VirusTotalAPI.__getIpAddressReportFinished">__getIpAddressReportFinished</a></td> | |
| 105 <td>Private slot to process the IP address report data.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#VirusTotalAPI.__getUrlScanReportUrl">__getUrlScanReportUrl</a></td> | |
| 109 <td>Private method to get the report URL for a URL scan.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#VirusTotalAPI.__getUrlScanReportUrlFinished">__getUrlScanReportUrlFinished</a></td> | |
| 113 <td>Private slot to determine the result of the URL scan report URL.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#VirusTotalAPI.__loadSettings">__loadSettings</a></td> | |
| 117 <td>Private method to load the settings.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#VirusTotalAPI.__submitUrlFinished">__submitUrlFinished</a></td> | |
| 121 <td>Private slot to determine the result of the URL scan submission.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td> | |
| 125 <td>Public method to check the validity of the given service key.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#VirusTotalAPI.close">close</a></td> | |
| 129 <td>Public slot to close the API.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#VirusTotalAPI.getDomainReport">getDomainReport</a></td> | |
| 133 <td>Public method to retrieve a report for a domain.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#VirusTotalAPI.getIpAddressReport">getIpAddressReport</a></td> | |
| 137 <td>Public method to retrieve a report for an IP address.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#VirusTotalAPI.preferencesChanged">preferencesChanged</a></td> | |
| 141 <td>Public slot to handle a change of preferences.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td> | |
| 145 <td>Public method to submit an URL to be scanned.</td> | |
| 146 </tr> | |
| 147 </table> | |
| 148 <h3>Static Methods</h3> | |
| 149 | |
| 150 <table> | |
| 151 <tr><td>None</td></tr> | |
| 152 </table> | |
| 153 | |
| 154 <a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a> | |
| 155 <h4>VirusTotalAPI (Constructor)</h4> | |
| 156 <b>VirusTotalAPI</b>(<i>parent=None</i>) | |
| 157 | |
| 158 <p> | |
| 159 Constructor | |
| 160 </p> | |
| 161 <dl> | |
| 162 | |
| 163 <dt><i>parent</i></dt> | |
| 164 <dd> | |
| 165 reference to the parent object (QObject) | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <a NAME="VirusTotalAPI.__checkServiceKeyValidityFinished" ID="VirusTotalAPI.__checkServiceKeyValidityFinished"></a> | |
| 169 <h4>VirusTotalAPI.__checkServiceKeyValidityFinished</h4> | |
| 170 <b>__checkServiceKeyValidityFinished</b>(<i>reply</i>) | |
| 171 | |
| 172 <p> | |
| 173 Private slot to determine the result of the service key validity check. | |
| 174 </p> | |
| 175 <dl> | |
| 176 | |
| 177 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 178 <dd> | |
| 179 reference to the network reply | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="VirusTotalAPI.__getDomainReportFinished" ID="VirusTotalAPI.__getDomainReportFinished"></a> | |
| 183 <h4>VirusTotalAPI.__getDomainReportFinished</h4> | |
| 184 <b>__getDomainReportFinished</b>(<i>reply</i>) | |
| 185 | |
| 186 <p> | |
| 187 Private slot to process the IP address report data. | |
| 188 </p> | |
| 189 <dl> | |
| 190 | |
| 191 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 192 <dd> | |
| 193 reference to the network reply | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <a NAME="VirusTotalAPI.__getFileScanReportUrl" ID="VirusTotalAPI.__getFileScanReportUrl"></a> | |
| 197 <h4>VirusTotalAPI.__getFileScanReportUrl</h4> | |
| 198 <b>__getFileScanReportUrl</b>(<i>scanId</i>) | |
| 199 | |
| 200 <p> | |
| 201 Private method to get the report URL for a file scan. | |
| 202 </p> | |
| 203 <dl> | |
| 204 | |
| 205 <dt><i>scanId</i></dt> | |
| 206 <dd> | |
| 207 ID of the scan to get the report URL for (string) | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a> | |
| 211 <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4> | |
| 212 <b>__getFileScanReportUrlFinished</b>(<i>reply</i>) | |
| 213 | |
| 214 <p> | |
| 215 Private slot to determine the result of the file scan report URL | |
| 216 request. | |
| 217 </p> | |
| 218 <dl> | |
| 219 | |
| 220 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 221 <dd> | |
| 222 reference to the network reply | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <a NAME="VirusTotalAPI.__getIpAddressReportFinished" ID="VirusTotalAPI.__getIpAddressReportFinished"></a> | |
| 226 <h4>VirusTotalAPI.__getIpAddressReportFinished</h4> | |
| 227 <b>__getIpAddressReportFinished</b>(<i>reply</i>) | |
| 228 | |
| 229 <p> | |
| 230 Private slot to process the IP address report data. | |
| 231 </p> | |
| 232 <dl> | |
| 233 | |
| 234 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 235 <dd> | |
| 236 reference to the network reply | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <a NAME="VirusTotalAPI.__getUrlScanReportUrl" ID="VirusTotalAPI.__getUrlScanReportUrl"></a> | |
| 240 <h4>VirusTotalAPI.__getUrlScanReportUrl</h4> | |
| 241 <b>__getUrlScanReportUrl</b>(<i>scanId</i>) | |
| 242 | |
| 243 <p> | |
| 244 Private method to get the report URL for a URL scan. | |
| 245 </p> | |
| 246 <dl> | |
| 247 | |
| 248 <dt><i>scanId</i></dt> | |
| 249 <dd> | |
| 250 ID of the scan to get the report URL for (string) | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <a NAME="VirusTotalAPI.__getUrlScanReportUrlFinished" ID="VirusTotalAPI.__getUrlScanReportUrlFinished"></a> | |
| 254 <h4>VirusTotalAPI.__getUrlScanReportUrlFinished</h4> | |
| 255 <b>__getUrlScanReportUrlFinished</b>(<i>reply</i>) | |
| 256 | |
| 257 <p> | |
| 258 Private slot to determine the result of the URL scan report URL. | |
| 259 </p> | |
| 260 <dl> | |
| 261 | |
| 262 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 263 <dd> | |
| 264 reference to the network reply | |
| 265 request. | |
| 266 </dd> | |
| 267 </dl> | |
| 268 <a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a> | |
| 269 <h4>VirusTotalAPI.__loadSettings</h4> | |
| 270 <b>__loadSettings</b>(<i></i>) | |
| 271 | |
| 272 <p> | |
| 273 Private method to load the settings. | |
| 274 </p> | |
| 275 <a NAME="VirusTotalAPI.__submitUrlFinished" ID="VirusTotalAPI.__submitUrlFinished"></a> | |
| 276 <h4>VirusTotalAPI.__submitUrlFinished</h4> | |
| 277 <b>__submitUrlFinished</b>(<i>reply</i>) | |
| 278 | |
| 279 <p> | |
| 280 Private slot to determine the result of the URL scan submission. | |
| 281 </p> | |
| 282 <dl> | |
| 283 | |
| 284 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 285 <dd> | |
| 286 reference to the network reply | |
| 287 </dd> | |
| 288 </dl> | |
| 289 <a NAME="VirusTotalAPI.checkServiceKeyValidity" ID="VirusTotalAPI.checkServiceKeyValidity"></a> | |
| 290 <h4>VirusTotalAPI.checkServiceKeyValidity</h4> | |
| 291 <b>checkServiceKeyValidity</b>(<i>key, protocol=""</i>) | |
| 292 | |
| 293 <p> | |
| 294 Public method to check the validity of the given service key. | |
| 295 </p> | |
| 296 <dl> | |
| 297 | |
| 298 <dt><i>key</i></dt> | |
| 299 <dd> | |
| 300 service key (string) | |
| 301 </dd> | |
| 302 <dt><i>protocol</i></dt> | |
| 303 <dd> | |
| 304 protocol used to access VirusTotal (string) | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <a NAME="VirusTotalAPI.close" ID="VirusTotalAPI.close"></a> | |
| 308 <h4>VirusTotalAPI.close</h4> | |
| 309 <b>close</b>(<i></i>) | |
| 310 | |
| 311 <p> | |
| 312 Public slot to close the API. | |
| 313 </p> | |
| 314 <a NAME="VirusTotalAPI.getDomainReport" ID="VirusTotalAPI.getDomainReport"></a> | |
| 315 <h4>VirusTotalAPI.getDomainReport</h4> | |
| 316 <b>getDomainReport</b>(<i>domain</i>) | |
| 317 | |
| 318 <p> | |
| 319 Public method to retrieve a report for a domain. | |
| 320 </p> | |
| 321 <dl> | |
| 322 | |
| 323 <dt><i>domain</i> (str)</dt> | |
| 324 <dd> | |
| 325 domain name | |
| 326 </dd> | |
| 327 </dl> | |
| 328 <a NAME="VirusTotalAPI.getIpAddressReport" ID="VirusTotalAPI.getIpAddressReport"></a> | |
| 329 <h4>VirusTotalAPI.getIpAddressReport</h4> | |
| 330 <b>getIpAddressReport</b>(<i>ipAddress</i>) | |
| 331 | |
| 332 <p> | |
| 333 Public method to retrieve a report for an IP address. | |
| 334 </p> | |
| 335 <dl> | |
| 336 | |
| 337 <dt><i>ipAddress</i> (str)</dt> | |
| 338 <dd> | |
| 339 valid IPv4 address in dotted quad notation | |
| 340 </dd> | |
| 341 </dl> | |
| 342 <a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a> | |
| 343 <h4>VirusTotalAPI.preferencesChanged</h4> | |
| 344 <b>preferencesChanged</b>(<i></i>) | |
| 345 | |
| 346 <p> | |
| 347 Public slot to handle a change of preferences. | |
| 348 </p> | |
| 349 <a NAME="VirusTotalAPI.submitUrl" ID="VirusTotalAPI.submitUrl"></a> | |
| 350 <h4>VirusTotalAPI.submitUrl</h4> | |
| 351 <b>submitUrl</b>(<i>url</i>) | |
| 352 | |
| 353 <p> | |
| 354 Public method to submit an URL to be scanned. | |
| 355 </p> | |
| 356 <dl> | |
| 357 | |
| 358 <dt><i>url</i></dt> | |
| 359 <dd> | |
| 360 url to be scanned (QUrl) | |
| 361 </dd> | |
| 362 </dl> | |
| 363 <div align="right"><a href="#top">Up</a></div> | |
| 364 <hr /> | |
| 365 </body></html> |
