├── LICENSE ├── README.md ├── investigate.py └── requirements.txt /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Python Hunt 2 | ## Quick OSINT checks for IPs and Domains during triage and investigations. 3 | 4 | --- 5 | 6 | ### About 7 | This script queries APIs for various freely-available intelligence platforms 8 | in order to gain important context and reputation data for IP addresses and/or 9 | domains. 10 | 11 | --- 12 | 13 | #### Platforms Used 14 | * WHOIS 15 | * VirusTotal 16 | * AlienVault OTX 17 | * Greynoise 18 | * Robtex 19 | * Shodan 20 | * ipinfo.io 21 | 22 | 23 | ##### API Keys Required for: 24 | * VirusTotal 25 | * Greynoise 26 | * Shodan 27 | 28 | If you do not wish to create an account to get an API key for these platforms, 29 | you can use the `-p` or `--platforms` argument to only enable the platforms you 30 | want to use. See Example Usage below for more information. 31 | 32 | NOTE: All three of these APIs can be obtained with free accounts. 33 | 34 | 35 | #### Installation and Requirements 36 | This is built for Python 3.x. 37 | 38 | Install required modules with: 39 | ```bash 40 | python3 -m pip install -r requirements.txt 41 | ``` 42 | 43 | You will need to also edit the main script to include your API keys for a few 44 | of the platforms. Do this in the "API Key" section near the top of the code. 45 | 46 | If you'd like to link this in your CLI $PATH, perform the following: 47 | ```bash 48 | $ ln -s /path/to/repo/investigate.py /usr/local/bin/investigate 49 | ``` 50 | Reload your terminal (new window, log off and back on, etc) and `investigate` 51 | should be a native command. You can now call it by executing directly. 52 | ```bash 53 | $ investigate 54 | ``` 55 | 56 | 57 | #### Example Usage 58 | Python Hunt can take single IPs as command line argument with `-i` or `--ipaddress`. 59 | ```bash 60 | $ investigate -i 95.217.163.246 61 | ``` 62 | 63 | It can also perform a lookup for domains with `-d` or `--domain` flags. 64 | ```bash 65 | $ investigate -d apple.com 66 | ``` 67 | Finally, it can check a file for a list of IPs or Domains. 68 | You may mix types in the file, but they must be 1 per line. 69 | You can do this by using `-f` or `--file`. 70 | 71 | ```bash 72 | $ investigate -f IoC_file.txt 73 | ``` 74 | Unfortunately, due to API rate limiting with some of the free APIs, you may only 75 | look up 5 items per minute by default. 76 | If you have paid for API keys without limits, you can ignore this. 77 | 78 | Otherwise, you can also specify which APIs to use with the optional `-p` 79 | or `--platforms` flag. 80 | By default, if no platform is specified, the script will run through all 81 | of them. 82 | 83 | ```bash 84 | $ investigate -i 165.254.239.130 -p ipinfo 85 | ``` 86 | Or 87 | ```bash 88 | $ investigate -f IoC_file.txt -p otx shodan 89 | ``` 90 | 91 | #### Example Output 92 | 93 | ```bash 94 | $ investigate -i 64.95.10.243 95 | _________________________________________ 96 | 97 | Investigating 64.95.10.243: 98 | 99 | Connecting from Dallas, Texas; US. 100 | IP belongs to AS399629 BL Networks. 101 | 102 | 103 | Shodan 104 | ---------- 105 | 106 | Geolocation double-check: 107 | Dallas, United States, TX 108 | Owned by BL Networks. 109 | 110 | Additional Shodan Info: 111 | OS: None 112 | Port(s): [80, 443, 22] 113 | Hostname: ['supfoundrysettlers.us'] 114 | Last Updated: 2024-06-21T00:06:36.008929 115 | 116 | 117 | VirusTotal 118 | ---------- 119 | 120 | Scan Stats: 121 | Country is US 122 | AS Owner is BLNWX 123 | Harmless: 49 124 | Suspicious: 2 125 | Malicious: 16 126 | Undetected: 26 127 | 128 | 129 | AlienVault OTX 130 | ---------- 131 | 132 | Pulse Count: 5 133 | Reputation Score: 0 134 | Pulse Name(s): Malvertising Campaign Leads to Execution of Oyster Backdoor, Malware campaign attempts abuse of defender binaries, Malvertising Campaign Leads to Execution of Oyster Backdoor | Rapid7 Blog, Malvertising Campaign Leads to Execution of Oyster Backdoor | Rapid7 Blog, malvertising campaign 135 | 136 | 137 | Greynoise 138 | ---------- 139 | 140 | IP not found in Greynoise database. 141 | 142 | 143 | Robtex 144 | ---------- 145 | 146 | County: United States 147 | ASN: 10910, 148 | WHOIS Desc.: Carrington Capital (C01174673) 149 | BGP Route: 64.95.0.0/20 150 | Active DNS Record: None 151 | Active DNS History: None 152 | Passive DNS: None 153 | Passive DNS History: None 154 | 155 | ``` 156 | 157 | --- 158 | 159 | ```bash 160 | $ investigate -d creditkarma.com 161 | __________________________________________________ 162 | 163 | Investigating Domain "creditkarma.com" 164 | 165 | 166 | WHOIS 167 | ---------- 168 | 169 | Created on 2005-08-30 02:56:23 170 | Expires on 2024-08-30 02:56:23 171 | Registrar: CSC Corporate Domains, Inc. 172 | Last Updated: 2023-08-27 05:34:34 173 | Registered in: US 174 | Name Servers: a1-204.akam.net, a16-64.akam.net, a28-65.akam.net, a3-67.akam.net, a4-66.akam.net, a9-66.akam.net, dns1.p04.nsone.net, dns2.p04.nsone.net, dns3.p04.nsone.net, dns4.p04.nsone.net 175 | 176 | 177 | VirusTotal 178 | ---------- 179 | 180 | Domain Created: 2005-08-29 10:56:23 181 | Alexa Rank: 821 182 | Cisco Umbrella Rank: 11422 183 | Overall Reputation: 0 184 | Harmless: 67 185 | Suspicious: 0 186 | Malicious: 0 187 | Undetected: 26 188 | 189 | 190 | AlienVault OTX 191 | ---------- 192 | 193 | No findings for this domain. 194 | 195 | ``` 196 | 197 | --- 198 | 199 | ```bash 200 | $ investigate -i 165.254.239.130 -p ipinfo robtex 201 | _________________________________________ 202 | 203 | Investigating 165.254.239.130: 204 | 205 | Connecting from Santa Monica, California; US. 206 | IP belongs to AS2914 NTT America, Inc.. 207 | 208 | 209 | Robtex 210 | ---------- 211 | 212 | County: United States 213 | ASN: 2914, NTTC-GIN-AS NTT Communications Global IP 214 | WHOIS Desc.: NTT America, Inc. (NTTAM-1) 215 | BGP Route: 165.254.0.0/16 216 | Active DNS Record: None 217 | Active DNS History: d1-6-1-1-1.a00.smtwny01.us.ce.verio.net 218 | Passive DNS: hc-1-us-ca-1.services.vnc.com 219 | Passive DNS History: None 220 | 221 | ``` 222 | 223 | --- 224 | 225 | #### Thank you to the following projects 226 | * [Python Whois](https://pypi.org/project/python-whois/) 227 | * [VirusTotal](https://virustotal.com) 228 | * [AlienVault](https://otx.alienvault.com) 229 | * [Greynoise](https://viz.greynoise.io) 230 | * [IP Info](https://ipinfo.io) 231 | * [Shodan](https://shodan.io) 232 | * [Robtex](https://www.robtex.com) 233 | 234 | -------------------------------------------------------------------------------- /investigate.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | """ 4 | Script to assist in investigations by collecting IP data from various sources. 5 | """ 6 | 7 | import argparse 8 | from datetime import datetime 9 | 10 | import requests 11 | import shodan 12 | import whois 13 | 14 | # API Keys 15 | # API Keys are required for Shodan, VirusTotal, and Greynoise 16 | # Register with them here: 17 | # https://shodan.io 18 | # https://virustotal.com 19 | # https://viz.greynoise.io 20 | 21 | SHODAN_API = "[YOUR API KEY HERE]" 22 | VT_API = "[YOUR API KEY HERE]" 23 | GREYNOISE_API = "[YOUR API KEY HERE]" 24 | 25 | # Platforms 26 | ALIENVAULT_OTX = "otx" 27 | GREYNOISE = "greynoise" 28 | IPINFO_IO = "ipinfo" 29 | ROBTEX = "robtex" 30 | SHODAN = "shodan" 31 | VIRUSTOTAL = "vt" 32 | WHOIS = "whois" 33 | 34 | PLATFORMS = { 35 | ALIENVAULT_OTX, 36 | GREYNOISE, 37 | IPINFO_IO, 38 | ROBTEX, 39 | SHODAN, 40 | VIRUSTOTAL, 41 | WHOIS, 42 | } 43 | RATELIMITED_PLATFORMS = { 44 | ROBTEX, 45 | VIRUSTOTAL, 46 | } 47 | 48 | 49 | def main(): 50 | """ 51 | Defining main parser for arguments passed to the script. 52 | """ 53 | 54 | parser = argparse.ArgumentParser( 55 | description="Investigate an IP address or Domain for available OSINT." 56 | ) 57 | group = parser.add_mutually_exclusive_group(required=True) 58 | group.add_argument("-i", "--ipaddress", help="IP to investigate.") 59 | group.add_argument("-d", "--domain", help="Domain to investigate.") 60 | group.add_argument( 61 | "-f", 62 | "--file", 63 | help="File containing a list of IPs (1 per line, up to 5 if " 64 | "using VirusTotal or Robtex due to API ratelimiting).", 65 | ) 66 | parser.add_argument( 67 | "-p", 68 | "--platforms", 69 | nargs="+", 70 | default=PLATFORMS, 71 | choices=PLATFORMS, 72 | ) 73 | args = parser.parse_args() 74 | 75 | if args.ipaddress: 76 | ip_check(args.ipaddress, args.platforms) 77 | elif args.domain: 78 | domain_check(args.domain, args.platforms) 79 | elif args.file: 80 | targets_processed_count = 0 81 | is_ratelimited = bool(set(args.platforms).intersection(RATELIMITED_PLATFORMS)) 82 | with open(args.file) as file: 83 | for target in file: 84 | if targets_processed_count > 5: 85 | print("Stopping due to API ratelimits.") 86 | break 87 | clean = target.strip() 88 | kind = clean.replace(".", "").replace(":", "").replace("/", "") 89 | if kind.isdigit(): 90 | if is_ratelimited: 91 | targets_processed_count += 1 92 | ip_check(clean, args.platforms) 93 | elif kind.isalnum(): 94 | if is_ratelimited: 95 | targets_processed_count += 1 96 | domain_check(clean, args.platforms) 97 | else: 98 | print(f"Skipping {clean}, can't determine the type.") 99 | 100 | 101 | # Start of IP Check functions 102 | 103 | 104 | def geo_info(target): 105 | """ 106 | Basic geolocation and IP ownership information. 107 | """ 108 | data = requests.get(f"https://ipinfo.io/{target}/json").json() 109 | print( 110 | """_________________________________________ 111 | 112 | Investigating {}: 113 | 114 | Connecting from {}, {}; {}. 115 | IP belongs to {}. 116 | """.format( 117 | data.get("ip", "IP Not Found."), 118 | data.get("city", "Not Found."), 119 | data.get("region", "Not Found."), 120 | data.get("country", "Not Found."), 121 | data.get("org", "Not Found."), 122 | ) 123 | ) 124 | 125 | 126 | def shodan_check(target): 127 | """ 128 | Double check geo and org information with Shodan, as well as pull 129 | additional information on the host. 130 | """ 131 | print( 132 | """ 133 | Shodan 134 | ----------""" 135 | ) 136 | try: 137 | data = shodan.Shodan(SHODAN_API).host(target) 138 | except shodan.APIError as error: 139 | print(f" {error}") 140 | else: 141 | print( 142 | """ 143 | Geolocation double-check: 144 | {}, {}, {} 145 | Owned by {}.""".format( 146 | data.get("city", "No Data."), 147 | data.get("country_name", "No Data"), 148 | data.get("region_code", "No Data."), 149 | data.get("org", "No Data."), 150 | ) 151 | ) 152 | print( 153 | """ 154 | Additional Shodan Info: 155 | OS: {} 156 | Port(s): {} 157 | Hostname: {} 158 | Last Updated: {} 159 | """.format( 160 | data.get("os", "No Data."), 161 | data.get("ports", "No Data."), 162 | data.get("hostnames", "No Data."), 163 | data.get("last_update", "No Data"), 164 | ) 165 | ) 166 | 167 | 168 | def vt_ip_check(target): 169 | """ 170 | Checks VirusTotal for known malicious actions/malware associated with the IP. 171 | """ 172 | url = f"https://www.virustotal.com/api/v3/ip_addresses/{target}" 173 | headers = {"x-apikey": VT_API} 174 | response = requests.get(url, headers=headers) 175 | attributes = response.json().get("data", {}).get("attributes", {}) 176 | last_analysis = attributes.get("last_analysis_stats", {}) 177 | print( 178 | """ 179 | VirusTotal 180 | ----------""" 181 | ) 182 | if response.status_code == 200: 183 | print( 184 | """ 185 | Scan Stats: 186 | Country is {} 187 | AS Owner is {} 188 | Harmless: {} 189 | Suspicious: {} 190 | Malicious: {} 191 | Undetected: {} 192 | """.format( 193 | attributes.get("country", "Not Found"), 194 | attributes.get("as_owner", "Not Found"), 195 | last_analysis.get("harmless", "None."), 196 | last_analysis.get("suspicious", "None."), 197 | last_analysis.get("malicious", "None."), 198 | last_analysis.get("undetected", "None."), 199 | ) 200 | ) 201 | else: 202 | print( 203 | """ 204 | Error: 205 | VirusTotal Response Code {}""".format( 206 | response.status_code 207 | ) 208 | ) 209 | 210 | 211 | def av_otx(target): 212 | """ 213 | Checks IP to see if it shows up in any "pulse", which is a crowdsourced 214 | datafeed for malware/malicious action. 215 | """ 216 | url = f"https://otx.alienvault.com/api/v1/indicators/IPv4/{target}" 217 | response = requests.get(url) 218 | data = response.json() 219 | 220 | print( 221 | """ 222 | AlienVault OTX 223 | ----------""" 224 | ) 225 | if response.status_code == 200: 226 | pulse_count = data.get("pulse_info", {}).get("count") 227 | if pulse_count > 0: 228 | pulse_name = [item["name"] for item in data["pulse_info"]["pulses"]] 229 | 230 | print( 231 | """ 232 | Pulse Count: {} 233 | Reputation Score: {} 234 | Pulse Name(s): {} 235 | """.format( 236 | pulse_count, 237 | data.get("reputation", "No Data"), 238 | ", ".join(pulse_name) if pulse_name else "No Data", 239 | ) 240 | ) 241 | 242 | elif pulse_count == 0: 243 | print( 244 | """ 245 | No findings for this IP. 246 | """ 247 | ) 248 | else: 249 | print( 250 | """ 251 | Error: OTX response code: {}""".format( 252 | response.status_code 253 | ) 254 | ) 255 | 256 | 257 | def robtex(target): 258 | """ 259 | Robtex provides acitve and passive DNS data, as well as BGP routing data. 260 | """ 261 | # Robtex doesn't accept the Python UA for some reason, so we need to set a 262 | # custom UA. This one is mimicking Firefox 90 on MacOS Big Sur. 263 | # Change if desired. 264 | headers = { 265 | "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0) Gecko/20100101 Firefox/102.0" 266 | } 267 | data = requests.get( 268 | f"https://freeapi.robtex.com/ipquery/{target}", headers=headers 269 | ).json() 270 | status = data["status"] 271 | print( 272 | """ 273 | Robtex 274 | ----------""" 275 | ) 276 | if status == "ok": 277 | active_dns = [hit["o"] for hit in data.get("act", [])] 278 | active_hist = [hit["o"] for hit in data.get("acth", [])] 279 | passive_dns = [hit["o"] for hit in data.get("pas", [])] 280 | passive_hist = [hit["o"] for hit in data.get("pash", [])] 281 | print( 282 | """ 283 | County: {} 284 | ASN: {}, {} 285 | WHOIS Desc.: {} 286 | BGP Route: {} 287 | Active DNS Record: {} 288 | Active DNS History: {} 289 | Passive DNS: {} 290 | Passive DNS History: {} 291 | """.format( 292 | data.get("country", "No Data."), 293 | data.get("as", "No Data."), 294 | data.get("asname", "No Data."), 295 | data.get("whoisdesc", "No Data."), 296 | data.get("bgproute", "No Data."), 297 | ", ".join(active_dns) if active_dns else "None", 298 | ", ".join(active_hist) if active_hist else "None", 299 | ", ".join(passive_dns) if passive_dns else "None", 300 | ", ".join(passive_hist) if passive_hist else "None", 301 | ) 302 | ) 303 | elif status == "ratelimited": 304 | print( 305 | """ 306 | API Rate Limit reached. Try again soon. 307 | """ 308 | ) 309 | else: 310 | print( 311 | """ 312 | Robtex has no records. 313 | """ 314 | ) 315 | 316 | 317 | def greynoise(target): 318 | """ 319 | Checking Greynoise for data on scanning IPs and "noisy" traffic. 320 | """ 321 | url = f"https://api.greynoise.io/v3/community/{target}" 322 | headers = { 323 | 'key': GREYNOISE_API 324 | } 325 | response = requests.request("GET", url, headers=headers) 326 | print( 327 | """ 328 | Greynoise 329 | ----------""" 330 | ) 331 | if response.status_code == 200: 332 | data = response.json() 333 | print( 334 | """ 335 | IP: {} 336 | Noise: {} 337 | RIOT: {} 338 | Classification: {} 339 | Name: {} 340 | Last Seen: {} 341 | Link: {} 342 | """.format( 343 | data.get("ip", "No Data."), 344 | data.get("noise", "No Data."), 345 | data.get("riot", "No Data"), 346 | data.get("classification", "No Data."), 347 | data.get("name", "No Data."), 348 | data.get("last_seen", "No Data."), 349 | data.get("link", "No Data.") 350 | ) 351 | ) 352 | elif response.status_code == 404: 353 | print( 354 | """ 355 | IP not found in Greynoise database. 356 | """ 357 | ) 358 | else: 359 | print( 360 | """ 361 | Greynoise Response Code: {} 362 | """.format( 363 | response.status_code 364 | ) 365 | ) 366 | 367 | 368 | # Start of Domain Check functions 369 | 370 | 371 | def whois_lookup(target): 372 | """ 373 | Basic WHOIS data lookup. Uses https://github.com/DannyCork/python-whois/ 374 | """ 375 | try: 376 | domain = whois.query(target) 377 | if domain is None: 378 | print("Domain not found in WHOIS") 379 | name = "Not Found." 380 | created = "No Data." 381 | expires = "No Data." 382 | updated = "No Data." 383 | reg = "No Data." 384 | country = "No Data." 385 | nameservers = None 386 | ns_clean = None 387 | else: 388 | name = domain.name 389 | created = domain.creation_date 390 | expires = domain.expiration_date 391 | updated = domain.last_updated 392 | reg = domain.registrar 393 | country = domain.registrant_country 394 | nameservers = domain.name_servers 395 | ns_clean = set(server.strip() for server in nameservers) 396 | except AttributeError as error: 397 | print(error) 398 | else: 399 | print( 400 | """__________________________________________________ 401 | 402 | Investigating Domain "{}" 403 | 404 | 405 | WHOIS 406 | ---------- 407 | 408 | Created on {} 409 | Expires on {} 410 | Registrar: {} 411 | Last Updated: {} 412 | Registered in: {} 413 | Name Servers: {} 414 | """.format( 415 | name if name else "No Data", 416 | created if created else "No Data", 417 | expires if expires else "No Data", 418 | reg if reg else "No Data", 419 | updated if updated else "No Data", 420 | country if country else "No Data", 421 | ", ".join(sorted(list(ns_clean))) if ns_clean else "No Data", 422 | ) 423 | ) 424 | 425 | 426 | def vt_domain_check(target): 427 | """ 428 | Checks VirusTotal for known malicious actions/malware associated with the Domain. 429 | """ 430 | url = f"https://www.virustotal.com/api/v3/domains/{target}" 431 | headers = {"x-apikey": VT_API} 432 | response = requests.get(url, headers=headers) 433 | data = response.json() 434 | attributes = data.get("data", {}).get("attributes", {}) 435 | rank = data.get("data", {}).get("attributes", {}).get("popularity_ranks", {}) 436 | last_analysis = ( 437 | data.get("data", {}).get("attributes", {}).get("last_analysis_stats", {}) 438 | ) 439 | creation_date = attributes.get("creation_date") 440 | print( 441 | """ 442 | VirusTotal 443 | ----------""" 444 | ) 445 | if response.status_code == 200: 446 | print( 447 | """ 448 | Domain Created: {} 449 | Alexa Rank: {} 450 | Cisco Umbrella Rank: {} 451 | Overall Reputation: {} 452 | Harmless: {} 453 | Suspicious: {} 454 | Malicious: {} 455 | Undetected: {} 456 | """.format( 457 | datetime.fromtimestamp(creation_date).strftime("%Y-%m-%d %I:%M:%S") 458 | if creation_date 459 | else "None", 460 | rank.get("Alexa", {}).get("rank", "No Data."), 461 | rank.get("Cisco Umbrella", {}).get("rank", "No Data."), 462 | attributes.get("reputation", "No Data."), 463 | last_analysis.get("harmless", "None."), 464 | last_analysis.get("suspicious", "None."), 465 | last_analysis.get("malicious", "None."), 466 | last_analysis.get("undetected", "None."), 467 | ) 468 | ) 469 | else: 470 | print( 471 | """ 472 | Error: 473 | VirusTotal Response Code {}""".format( 474 | response.status_code 475 | ) 476 | ) 477 | 478 | 479 | def av_otx_domain(target): 480 | """ 481 | Checks Domain to see if it shows up in any "pulse", which is a crowdsourced 482 | datafeed for malware/malicious action. 483 | """ 484 | url = f"https://otx.alienvault.com/api/v1/indicators/domain/{target}" 485 | response = requests.get(url) 486 | data = response.json() 487 | pulse_count = data.get("pulse_info", {}).get("count", "No Data") 488 | print( 489 | """ 490 | AlienVault OTX 491 | ----------""" 492 | ) 493 | if response.status_code == 200: 494 | if pulse_count > 0: 495 | try: 496 | pulse_name = [item["name"] for item in data["pulse_info"]["pulses"]] 497 | except TypeError as error: 498 | print(error) 499 | print( 500 | """ 501 | Pulse Count: {} 502 | Reputation Score: {} 503 | Pulse Name(s): {} 504 | """.format( 505 | pulse_count, 506 | data.get("reputation", "No Data."), 507 | ", ".join(pulse_name) if pulse_name else "No Data", 508 | ) 509 | ) 510 | elif pulse_count == 0: 511 | print( 512 | """ 513 | No findings for this domain. 514 | """ 515 | ) 516 | else: 517 | print( 518 | """ 519 | Error: OTX Response Code {} 520 | """.format( 521 | response.status_code 522 | ) 523 | ) 524 | 525 | 526 | def ip_check(target, platforms): 527 | """ 528 | Collection of all IP check functions to run. 529 | """ 530 | if IPINFO_IO in platforms: 531 | geo_info(target) 532 | if SHODAN in platforms: 533 | shodan_check(target) 534 | if VIRUSTOTAL in platforms: 535 | vt_ip_check(target) 536 | if ALIENVAULT_OTX in platforms: 537 | av_otx(target) 538 | if GREYNOISE in platforms: 539 | greynoise(target) 540 | if ROBTEX in platforms: 541 | robtex(target) 542 | 543 | 544 | def domain_check(target, platforms): 545 | """ 546 | Collection of all Domain check functions to run. 547 | """ 548 | if WHOIS in platforms: 549 | whois_lookup(target) 550 | if VIRUSTOTAL in platforms: 551 | vt_domain_check(target) 552 | if ALIENVAULT_OTX in platforms: 553 | av_otx_domain(target) 554 | 555 | 556 | if __name__ == "__main__": 557 | main() 558 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | shodan 3 | whois 4 | --------------------------------------------------------------------------------