├── .gitattributes ├── LICENSE ├── config.json ├── main.py ├── readme.md ├── run.bat └── run.sh /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "TOKEN": "YOUR DISCORD-BOT-TOKEN-HERE", 3 | "SHODAN_KEY": "YOUR-SHODAN-KEY-HERE" 4 | } 5 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | # __________ __ __ ________ .___ 2 | # \______ \ ____ ____ | | __ ____ _/ |_ / _____/ ____ __| _/ 3 | # | _/ / _ \ _/ ___\ | |/ /_/ __ \\ __\/ \ ___ / _ \ / __ | 4 | # | | \( <_> )\ \___ | < \ ___/ | | \ \_\ \( <_> )/ /_/ | 5 | # |____|_ / \____/ \___ >|__|_ \ \___ >|__| \______ / \____/ \____ | 6 | # \/ \/ \/ \/ \/ \/ 7 | # 8 | # Shodan Discord Bot by RocketGod 9 | # 10 | # https://github.com/RocketGod-git/shodanbot 11 | 12 | import json 13 | import logging 14 | 15 | from ipaddress import ip_address 16 | import base64 17 | import io 18 | import re 19 | 20 | import discord 21 | from discord import Embed 22 | import discord.errors 23 | from discord import ui 24 | 25 | import shodan 26 | 27 | 28 | # Reset logging configuration to clear any handlers 29 | logging.root.handlers = [] 30 | 31 | # Define the logger and handler 32 | logger = logging.getLogger(__name__) 33 | logger.setLevel(logging.INFO) 34 | 35 | # Create console handler with a specific level 36 | ch = logging.StreamHandler() 37 | ch.setLevel(logging.INFO) 38 | 39 | # Create formatter and add it to the handler 40 | formatter = logging.Formatter('[%(asctime)s] [%(levelname)s] - %(message)s') 41 | ch.setFormatter(formatter) 42 | 43 | # Add the handler to the logger 44 | logger.addHandler(ch) 45 | 46 | # Mute the discord library's logs 47 | logging.getLogger('discord').setLevel(logging.CRITICAL) 48 | 49 | # Specifically mute INFO level logs from discord.gateway 50 | logging.getLogger('discord.gateway').setLevel(logging.ERROR) 51 | 52 | def load_config(): 53 | try: 54 | with open('config.json', 'r') as file: 55 | return json.load(file) 56 | except Exception as e: 57 | logger.error(f"Error loading configuration: {e}") 58 | return None 59 | 60 | def check_configurations(config): 61 | if not config: 62 | return False 63 | 64 | required_keys = ['TOKEN', 'SHODAN_KEY'] 65 | missing_keys = [key for key in required_keys if key not in config] 66 | 67 | if missing_keys: 68 | logger.error(f"Missing keys in config.json: {', '.join(missing_keys)}") 69 | return False 70 | 71 | return True 72 | 73 | def is_ipv6(addr: str) -> bool: 74 | """Checks if the given address is an IPv6 address.""" 75 | try: 76 | return ip_address(addr).version == 6 77 | except ValueError: 78 | return False 79 | 80 | class aclient(discord.Client): 81 | def __init__(self, shodan_key) -> None: 82 | super().__init__(intents=discord.Intents.default()) 83 | self.shodan = shodan.Shodan(shodan_key) 84 | self.tree = discord.app_commands.CommandTree(self) 85 | self.activity = discord.Activity(type=discord.ActivityType.watching, name="/shodan") 86 | self.discord_message_limit = 2000 87 | 88 | async def send_split_messages(self, interaction, message: str, require_response=True): 89 | """Sends a message, and if it's too long for Discord, splits it.""" 90 | # Handle empty messages 91 | if not message.strip(): 92 | logging.warning("Attempted to send an empty message.") 93 | return 94 | 95 | # Extract the user's query/command from the interaction to prepend it to the first chunk 96 | query = "" 97 | for option in interaction.data.get("options", []): 98 | if option.get("name") == "query": 99 | query = option.get("value", "") 100 | break 101 | 102 | prepend_text = "" 103 | if query: 104 | prepend_text = f"Query: {query}\n\n" 105 | 106 | lines = message.split("\n") 107 | chunks = [] 108 | current_chunk = "" 109 | 110 | # First, add the prepend_text (if any) to the initial chunk 111 | if prepend_text: 112 | current_chunk += prepend_text 113 | 114 | for line in lines: 115 | # If the individual line is too long, split it up before chunking 116 | while len(line) > self.discord_message_limit: 117 | sub_line = line[:self.discord_message_limit] 118 | if len(current_chunk) + len(sub_line) + 1 > self.discord_message_limit: 119 | chunks.append(current_chunk) 120 | current_chunk = "" 121 | current_chunk += sub_line + "\n" 122 | line = line[self.discord_message_limit:] 123 | 124 | # If adding the next line to the current chunk would exceed the Discord message limit 125 | if len(current_chunk) + len(line) + 1 > self.discord_message_limit: 126 | chunks.append(current_chunk) 127 | current_chunk = line + "\n" 128 | else: 129 | current_chunk += line + "\n" 130 | 131 | if current_chunk: 132 | chunks.append(current_chunk) 133 | 134 | # Check if there are chunks to send 135 | if not chunks: 136 | logging.warning("No chunks generated from the message.") 137 | return 138 | 139 | # If a response is required and the interaction hasn't been responded to, defer the response 140 | if require_response and not interaction.response.is_done(): 141 | await interaction.response.defer(ephemeral=False) 142 | 143 | # Edit the deferred response 144 | try: 145 | await interaction.followup.send(content=chunks[0], ephemeral=False) 146 | chunks = chunks[1:] # Remove the first chunk since we've already sent it 147 | except Exception as e: 148 | logging.error(f"Failed to send the first chunk via followup. Error: {e}") 149 | 150 | # Send the rest of the chunks directly to the channel 151 | for chunk in chunks: 152 | try: 153 | await interaction.channel.send(chunk) 154 | except Exception as e: 155 | logging.error(f"Failed to send a message chunk to the channel. Error: {e}") 156 | 157 | client = None 158 | 159 | async def handle_errors(interaction, error, error_type="Error"): 160 | error_message = f"{error_type}: {error}" 161 | logger.error(f"Error occurred for user {interaction.user} in {interaction.guild.name if interaction.guild else 'Direct Message'}: {error_message}") 162 | 163 | try: 164 | # Check if the interaction has been responded to 165 | if interaction.response.is_done(): 166 | await interaction.followup.send(error_message) 167 | else: 168 | await interaction.response.send_message(error_message, ephemeral=True) 169 | except discord.HTTPException as http_err: 170 | logger.warning(f"HTTP error while responding to {interaction.user}: {http_err}") 171 | try: 172 | await interaction.followup.send(error_message) 173 | except discord.HTTPException as followup_http_err: 174 | logger.error(f"HTTP error during followup to {interaction.user}: {followup_http_err}") 175 | except Exception as unexpected_followup_error: 176 | logger.error(f"Unexpected error during followup to {interaction.user}: {unexpected_followup_error}") 177 | except Exception as unexpected_err: 178 | logger.error(f"Unexpected error while responding to {interaction.user}: {unexpected_err}") 179 | try: 180 | await interaction.followup.send("An unexpected error occurred. Please try again later.") 181 | except Exception as followup_error: 182 | logger.error(f"Failed to send followup: {followup_error}") 183 | 184 | async def process_shodan_results(interaction: discord.Interaction, result: dict, max_results: int = 10, display_mode: str = "full"): 185 | user = interaction.user.name 186 | guild_name = interaction.guild.name if interaction.guild else "Direct Message" 187 | command_name = interaction.data.get("name", "unknown_command") 188 | options = ", ".join([f"{option.get('name')}: {option.get('value')}" for option in interaction.data.get("options", [])]) 189 | 190 | logger.info(f"{user} executed /{command_name} from {guild_name}. Options used: {options}") 191 | 192 | print(f"{user} executed /{command_name} from {guild_name}. Options used: {options}") 193 | 194 | matches = result.get('matches', []) 195 | if matches: 196 | total = result.get('total', 0) 197 | info = f"Found {total} results. Here are the top results:\n\n" 198 | 199 | # For list mode, send each IP link and screenshot immediately 200 | if display_mode == "easy": 201 | for match in matches[:max_results]: 202 | ip = match.get('ip_str', 'No IP available.') 203 | port = match.get('port', 'No port available.') 204 | 205 | # Format IP link 206 | clickable_link = f"[{ip}:{port}](http://{ip}:{port})\n" 207 | await interaction.followup.send(clickable_link, ephemeral=True) 208 | 209 | # Handle screenshot if available 210 | screenshot_data = match.get('screenshot', {}).get('data') 211 | if screenshot_data: 212 | screenshot_bytes = base64.b64decode(screenshot_data) 213 | screenshot_file = io.BytesIO(screenshot_bytes) 214 | await interaction.followup.send(file=discord.File(screenshot_file, filename=f'screenshot_{ip}.jpg')) 215 | return 216 | 217 | # If display mode is full 218 | responses = [] # Initialize the responses list 219 | for match in matches[:max_results]: 220 | detailed_info = generate_detailed_info(match) 221 | responses.append(detailed_info) 222 | 223 | message = info + "\n".join(responses) 224 | await client.send_split_messages(interaction, message) 225 | else: 226 | # Extract the user's query from the interaction 227 | query = "" 228 | for option in interaction.data.get("options", []): 229 | if option.get("name") == "query": 230 | query = option.get("value", "") 231 | break 232 | 233 | # If the query is not empty, include it in the response message 234 | response_message = "No results found." 235 | if query: 236 | response_message = f"No results found for the query: `{query}`." 237 | 238 | await interaction.followup.send(response_message) 239 | 240 | def generate_detailed_info(match: dict) -> str: 241 | ip = match.get('ip_str', 'No IP available.') 242 | port = match.get('port', 'No port available.') 243 | org = match.get('org', 'N/A') 244 | product = match.get('product', 'N/A') 245 | version = match.get('version', 'N/A') 246 | data = match.get('data', 'No data available.').strip() 247 | asn = match.get('asn', 'N/A') 248 | hostnames = ", ".join(match.get('hostnames', [])) or 'N/A' 249 | os = match.get('os', 'N/A') 250 | timestamp = match.get('timestamp', 'N/A') 251 | isp = match.get('isp', 'N/A') 252 | http_title = match.get('http', {}).get('title', 'N/A') 253 | ssl_data = match.get('ssl', {}).get('cert', {}).get('subject', {}).get('CN', 'N/A') 254 | vulns = ", ".join(match.get('vulns', [])) or 'N/A' 255 | tags = ", ".join(match.get('tags', [])) or 'N/A' 256 | transport = match.get('transport', 'N/A') 257 | 258 | # Location details with Google Maps link 259 | lat = match.get('location', {}).get('latitude') 260 | long = match.get('location', {}).get('longitude') 261 | google_maps_link = f"https://www.google.com/maps?q={lat},{long}" if lat and long else None 262 | country = match.get('location', {}).get('country_name', 'N/A') 263 | city = match.get('location', {}).get('city', 'N/A') 264 | if google_maps_link: 265 | location = f"{country} - {city} ([Lat: {lat}, Long: {long}]({google_maps_link}))" 266 | else: 267 | location = f"{country} - {city} (Lat: {lat}, Long: {long})" 268 | 269 | main_link = f"http://{ip}:{port}" 270 | 271 | detailed_info = ( 272 | f"**IP:** [{ip}]({main_link})\n" 273 | f"**Port:** {port}\n" 274 | f"**Transport:** {transport}\n" 275 | f"**Organization:** {org}\n" 276 | f"**Location:** {location}\n" 277 | f"**Product:** {product} {version}\n" 278 | f"**ASN:** {asn}\n" 279 | f"**Hostnames:** {hostnames}\n" 280 | f"**OS:** {os}\n" 281 | f"**ISP:** {isp}\n" 282 | f"**HTTP Title:** {http_title}\n" 283 | f"**SSL Common Name:** {ssl_data}\n" 284 | f"**Tags:** {tags}\n" 285 | f"**Vulnerabilities:** {vulns}\n" 286 | f"**Timestamp:** {timestamp}\n" 287 | f"**Data:** {data}\n" 288 | f"---" 289 | ) 290 | 291 | return detailed_info 292 | 293 | 294 | class QueryModal(discord.ui.Modal): 295 | def __init__(self, *args, **kwargs): 296 | super().__init__(*args, **kwargs) 297 | self.add_item(discord.ui.TextInput(label="Enter your search query", style=discord.TextStyle.short, custom_id="query_input")) 298 | 299 | async def on_submit(self, interaction: discord.Interaction): 300 | await interaction.response.defer(ephemeral=True) 301 | query = self.children[0].value # Extract the query from the modal 302 | view = MaxResultsView(query) 303 | message = await interaction.followup.send(content="Choose the maximum number of results:", view=view, ephemeral=False) 304 | view.query_message_id = message.id 305 | 306 | class MaxResultsView(discord.ui.View): 307 | def __init__(self, query): 308 | super().__init__() 309 | self.query = query 310 | self.message_id = None # Used for the MaxResultsView message 311 | self.query_message_id = None 312 | 313 | async def handle_search(self, interaction: discord.Interaction, max_results: int): 314 | shodan_client = interaction.client.shodan 315 | user = interaction.user.name 316 | guild_name = interaction.guild.name if interaction.guild else "Direct Message" 317 | 318 | logger.info(f"{user} initiated a search with query '{self.query}' in {guild_name}") 319 | 320 | try: 321 | result = shodan_client.search(self.query) 322 | matches = result.get('matches', []) 323 | 324 | if matches: 325 | limited_matches = matches[:max_results] 326 | total = result.get('total', 0) 327 | info = f"{user} used /shodan to search for `{self.query}` from {guild_name} and found {total} results. Here are the top {max_results} results:\n\n" 328 | 329 | if self.query_message_id: 330 | try: 331 | message_channel = interaction.channel 332 | query_message = await message_channel.fetch_message(self.query_message_id) 333 | await query_message.edit(content=info, view=None) # Edit the message to display results 334 | # logger.info(f"Successfully edited QueryModal message with ID: {self.query_message_id} to display results.") 335 | except Exception as e: 336 | logger.error(f"Error editing QueryModal message with ID {self.query_message_id}: {e}") 337 | 338 | await interaction.followup.send(info) 339 | 340 | for match in limited_matches: 341 | ip = match.get('ip_str', 'No IP available.') 342 | port = match.get('port', 'No port available.') 343 | 344 | # Extract geolocation details for easy mode 345 | lat = match.get('location', {}).get('latitude') 346 | long = match.get('location', {}).get('longitude') 347 | google_maps_link = f"https://www.google.com/maps?q={lat},{long}" if lat and long else None 348 | geolocation_text = f"([map](<{google_maps_link}>))" if google_maps_link else "" 349 | 350 | # Check if IP is IPv6 351 | if is_ipv6(ip): 352 | clickable_link = f"{ip} (port: {port}) {geolocation_text}" 353 | else: 354 | clickable_link = f"[{ip}:{port}](http://{ip}:{port}) {geolocation_text}" 355 | 356 | await interaction.channel.send(clickable_link) 357 | 358 | screenshot_data = match.get('screenshot', {}).get('data') 359 | if screenshot_data: 360 | try: 361 | screenshot_bytes = base64.b64decode(screenshot_data) 362 | screenshot_file = io.BytesIO(screenshot_bytes) 363 | screenshot_filename = f"screenshot_{match.get('ip_str', 'unknown')}.jpg" 364 | screenshot_attachment = discord.File(screenshot_file, filename=screenshot_filename) 365 | await interaction.channel.send("**Screenshot:**", file=screenshot_attachment) 366 | except Exception as e: 367 | logger.error(f"Error decoding screenshot data for IP {ip}: {e}") 368 | await interaction.channel.send("**Screenshot:** Error decoding screenshot data.") 369 | 370 | # Send the entire API response as query.txt 371 | query_response = json.dumps(result, indent=2) 372 | query_file = discord.File(io.StringIO(query_response), filename="query.txt") 373 | await interaction.channel.send(file=query_file) 374 | else: 375 | await interaction.followup.send(content=f"No results found for the query: `{self.query}`.", ephemeral=True) 376 | 377 | except shodan.APIError as e: 378 | logger.error(f"Shodan API Error for user {user} in {guild_name}: {e}") 379 | await interaction.followup.send(content=f"Shodan API Error: {e}", ephemeral=True) 380 | except json.JSONDecodeError as e: 381 | logger.error(f"Unable to parse JSON response for user {user} in {guild_name}. Error: {e}") 382 | logger.error(f"Response content: {e.doc}") 383 | await interaction.followup.send(content=f"Unable to parse JSON response. Error: {e}", ephemeral=True) 384 | except discord.errors.DiscordServerError as e: 385 | logger.error(f"Discord server error occurred for user {user} in {guild_name}: {e}") 386 | await interaction.followup.send(content="A Discord server error occurred. Please try again later.", ephemeral=True) 387 | except Exception as e: 388 | logger.error(f"Unexpected error occurred for user {user} in {guild_name}: {e}") 389 | await interaction.followup.send(content=f"An unexpected error occurred: {e}", ephemeral=True) 390 | 391 | 392 | async def button_callback(self, interaction: discord.Interaction, max_results: int): 393 | if not interaction.response.is_done(): 394 | await interaction.response.defer() 395 | 396 | # Disable the buttons in the view 397 | for child in self.children: 398 | child.disabled = True 399 | 400 | # Immediately edit the original QueryModal message to remove the content or view 401 | if self.query_message_id: 402 | try: 403 | message_channel = interaction.channel 404 | query_message = await message_channel.fetch_message(self.query_message_id) 405 | await query_message.edit(content="Processing your request...", view=None) 406 | # logger.info(f"Successfully edited QueryModal message with ID: {self.query_message_id} to indicate processing.") 407 | except discord.NotFound: 408 | logger.error(f"QueryModal message with ID {self.query_message_id} not found. It might have been deleted.") 409 | except discord.Forbidden: 410 | logger.error(f"Bot does not have permissions to edit QueryModal message with ID {self.query_message_id}.") 411 | except discord.HTTPException as e: 412 | logger.error(f"Failed to edit QueryModal message due to HTTPException: {e}") 413 | except Exception as e: 414 | logger.error(f"Unexpected error occurred when trying to edit QueryModal message with ID {self.query_message_id}: {e}") 415 | 416 | await self.handle_search(interaction, max_results) 417 | 418 | 419 | @discord.ui.button(label="20", style=discord.ButtonStyle.primary, custom_id="max_results_20") 420 | async def twenty_results_button(self, interaction: discord.Interaction, button: discord.ui.Button): 421 | await self.button_callback(interaction, 20) 422 | 423 | @discord.ui.button(label="50", style=discord.ButtonStyle.primary, custom_id="max_results_50") 424 | async def fifty_results_button(self, interaction: discord.Interaction, button: discord.ui.Button): 425 | await self.button_callback(interaction, 50) 426 | 427 | @discord.ui.button(label="100", style=discord.ButtonStyle.primary, custom_id="max_results_100") 428 | async def hundred_results_button(self, interaction: discord.Interaction, button: discord.ui.Button): 429 | await self.button_callback(interaction, 100) 430 | 431 | @discord.ui.button(label="250", style=discord.ButtonStyle.primary, custom_id="max_results_250") 432 | async def two_hundred_fifty_results_button(self, interaction: discord.Interaction, button: discord.ui.Button): 433 | await self.button_callback(interaction, 250) 434 | 435 | 436 | def setup_bot_commands(): 437 | @client.event 438 | async def on_ready(): 439 | # Print the bot's connection status and list the servers it's connected to 440 | print(f'{client.user} has successfully connected to Discord!') 441 | print(f'The bot is currently active in {len(client.guilds)} server(s):') 442 | 443 | for guild in client.guilds: 444 | print(f'- {guild.name} (ID: {guild.id})') 445 | 446 | # Attempt to sync commands for each guild 447 | failed_guilds = [] 448 | for guild in client.guilds: 449 | retry_count = 0 450 | while True: 451 | try: 452 | await client.tree.sync(guild=guild) 453 | print(f'Successfully synced commands for guild: {guild.name}') 454 | break 455 | except discord.errors.HTTPException as e: 456 | if e.status == 429: 457 | retry_after = e.response.headers.get('Retry-After', 5) 458 | retry_after = int(retry_after) 459 | retry_count += 1 460 | logger.warning(f"Rate limited while syncing commands for guild: {guild.name}. Retrying in {retry_after} seconds. Retry attempt: {retry_count}") 461 | await asyncio.sleep(retry_after) 462 | else: 463 | logger.error(f'Failed to sync commands for guild: {guild.name}. Error: {e}') 464 | failed_guilds.append(guild.name) 465 | break 466 | except Exception as e: 467 | logger.error(f'Failed to sync commands for guild: {guild.name}. Error: {e}') 468 | failed_guilds.append(guild.name) 469 | break 470 | 471 | if failed_guilds: 472 | logger.warning("Failed to sync commands for the following guild(s):") 473 | for guild_name in failed_guilds: 474 | logger.warning(f'- {guild_name}') 475 | else: 476 | logger.info("Successfully synced commands for all guilds.") 477 | 478 | try: 479 | await client.tree.sync() 480 | logger.info("Successfully synced commands globally.") 481 | except discord.errors.HTTPException as e: 482 | if e.status == 429: 483 | retry_after = e.response.headers.get('Retry-After', 5) 484 | retry_after = int(retry_after) 485 | logger.warning(f"Rate limited while syncing commands globally. Retrying in {retry_after} seconds.") 486 | await asyncio.sleep(retry_after) 487 | await client.tree.sync() 488 | else: 489 | logger.error(f'Failed to sync commands globally. Error: {e}') 490 | except Exception as e: 491 | logger.error(f'Failed to sync commands globally. Error: {e}') 492 | 493 | # Update bot's presence to indicate it's ready 494 | await client.change_presence(activity=client.activity) 495 | 496 | print('Bot is ready and operational!') 497 | 498 | @client.tree.command(name="hostinfo", description="Get information about a host.") 499 | async def hostinfo(interaction: discord.Interaction, host_ip: str): 500 | try: 501 | host_info = client.shodan.host(host_ip) 502 | await client.send_split_messages(interaction, f"IP: {host_info['ip_str']}\nOS: {host_info.get('os', 'Unknown')}") 503 | except shodan.APIError as e: 504 | await handle_errors(interaction, e, "Shodan API Error") 505 | except Exception as e: 506 | await handle_errors(interaction, e) 507 | 508 | @client.tree.command(name="protocols", description="List supported protocols.") 509 | async def protocols(interaction: discord.Interaction): 510 | try: 511 | protocol_list = client.shodan.protocols() 512 | formatted_protocols = "\n".join([f"- {protocol}" for protocol in protocol_list]) 513 | 514 | await client.send_split_messages(interaction, formatted_protocols) 515 | except shodan.APIError as e: 516 | await handle_errors(interaction, e, "Shodan API Error") 517 | except Exception as e: 518 | await handle_errors(interaction, e) 519 | 520 | @client.tree.command(name="shodan", description="Advanced and basic Shodan queries. Use `/help` for examples.") 521 | async def search(interaction: discord.Interaction): 522 | try: 523 | # Log the user and guild information 524 | user = interaction.user.name 525 | guild_name = interaction.guild.name if interaction.guild else "Direct Message" 526 | # logger.info(f"{user} initiated a Shodan search from {guild_name}") 527 | 528 | modal = QueryModal(title="Shodan Search Query") 529 | await interaction.response.send_modal(modal) 530 | 531 | except discord.HTTPException as e: 532 | logger.error(f"HTTP error while sending the modal to {user} in {guild_name}: {e}") 533 | await handle_errors(interaction, e, "HTTP Error") 534 | 535 | except Exception as e: 536 | logger.error(f"Unexpected error while processing the search command for {user} in {guild_name}: {e}") 537 | await handle_errors(interaction, e) 538 | 539 | @client.tree.command(name="searchcity", description="Search Shodan by city.") 540 | async def searchcity(interaction: discord.Interaction, city: str): 541 | city = city.strip() 542 | 543 | try: 544 | result = client.shodan.search(f"city:\"{city}\"") 545 | await process_shodan_results(interaction, result) 546 | except shodan.APIError as e: 547 | await handle_errors(interaction, e, "Shodan API Error") 548 | except Exception as e: 549 | await handle_errors(interaction, e) 550 | 551 | @client.tree.command(name="searchorg", description="Search Shodan by organization.") 552 | async def searchorg(interaction: discord.Interaction, organization: str): 553 | try: 554 | await interaction.response.defer(ephemeral=False) 555 | result = client.shodan.search(f"org:\"{organization}\"") 556 | await process_shodan_results(interaction, result) 557 | except shodan.APIError as e: 558 | await handle_errors(interaction, e, "Shodan API Error") 559 | except Exception as e: 560 | await handle_errors(interaction, e) 561 | 562 | @client.tree.command(name="searchport", description="Search Shodan by port.") 563 | async def searchport(interaction: discord.Interaction, port: int): 564 | try: 565 | await interaction.response.defer(ephemeral=False) 566 | result = client.shodan.search(f"port:{port}") 567 | await process_shodan_results(interaction, result) 568 | except shodan.APIError as e: 569 | await handle_errors(interaction, e, "Shodan API Error") 570 | except Exception as e: 571 | await handle_errors(interaction, e) 572 | 573 | @client.tree.command(name="searchcountry", description="Search Shodan by country using a 2-letter country code (e.g., 'US' for the United States).") 574 | async def searchcountry(interaction: discord.Interaction, country_code: str): 575 | try: 576 | # Convert country code to uppercase to ensure case-insensitivity 577 | country_code = country_code.upper() 578 | 579 | # Ensure the country code is valid 580 | if len(country_code) != 2: 581 | await interaction.response.send_message("Please provide a valid 2-letter country code (e.g., 'US' for the United States).", ephemeral=True) 582 | return 583 | 584 | result = client.shodan.search(f"country:\"{country_code}\"") 585 | await process_shodan_results(interaction, result) 586 | except shodan.APIError as e: 587 | await handle_errors(interaction, e, "Shodan API Error") 588 | except Exception as e: 589 | await handle_errors(interaction, e) 590 | 591 | @client.tree.command(name="exploitsearch", description="Search for known vulnerabilities using a term.") 592 | async def exploitsearch(interaction: discord.Interaction, term: str): 593 | try: 594 | exploit_search = client.shodan.exploits.search(term) 595 | 596 | if 'matches' in exploit_search and exploit_search['matches']: 597 | top_exploits = exploit_search['matches'][:10] 598 | replies = [] 599 | 600 | for exploit in top_exploits: 601 | description = exploit.get('description', 'No description available.').strip() 602 | source = exploit.get('source', 'Unknown source') 603 | date = exploit.get('date', 'Unknown date') 604 | exploit_type = exploit.get('type', 'Unknown type') 605 | 606 | detailed_info = (f"**Description:** {description}\n" 607 | f"**Source:** {source}\n" 608 | f"**Date:** {date}\n" 609 | f"**Type:** {exploit_type}\n" 610 | f"---") 611 | replies.append(detailed_info) 612 | 613 | message = "\n".join(replies) 614 | await client.send_split_messages(interaction, message) 615 | else: 616 | await interaction.followup.send("No exploits found for that term.") 617 | except shodan.APIError as e: 618 | await handle_errors(interaction, e, "Shodan API Error") 619 | except Exception as e: 620 | await handle_errors(interaction, e) 621 | 622 | @client.tree.command( 623 | name="listtags", 624 | description="Get Shodan Exploits tags. Specify size (1-100). E.g., `/listtags 5`." 625 | ) 626 | async def listtags(interaction: discord.Interaction, size: int = 10): 627 | """ 628 | Retrieves a list of popular exploit tags from Shodan based on a specified size. 629 | """ 630 | try: 631 | if not 1 <= size <= 100: 632 | await interaction.response.send_message( 633 | "The provided size is out of bounds. Please specify a value between 1 and 100.", 634 | ephemeral=True 635 | ) 636 | return 637 | 638 | tags = client.shodan.exploits.tags(size=size) 639 | tag_list = ", ".join([tag['value'] for tag in tags['matches']]) 640 | 641 | if not tag_list: 642 | message = "No popular exploit tags found." 643 | elif size == 1: 644 | message = f"The most popular exploit tag is: {tag_list}" 645 | else: 646 | message = f"Here are the top {size} popular exploit tags: {tag_list}" 647 | 648 | await interaction.followup.send(message) 649 | except shodan.APIError as e: 650 | await handle_errors(interaction, e, "Shodan API Error") 651 | except Exception as e: 652 | await handle_errors(interaction, e) 653 | 654 | @client.tree.command(name="searchnetblock", description="Search devices in a specific netblock.") 655 | async def searchnetblock(interaction: discord.Interaction, netblock: str): 656 | try: 657 | result = client.shodan.search(f"net:{netblock}") 658 | await process_shodan_results(interaction, result) 659 | except shodan.APIError as e: 660 | await handle_errors(interaction, e, "Shodan API Error") 661 | except Exception as e: 662 | await handle_errors(interaction, e) 663 | 664 | @client.tree.command(name="searchproduct", description="Search devices associated with a specific product.") 665 | async def searchproduct(interaction: discord.Interaction, product: str): 666 | try: 667 | result = client.shodan.search(f"product:{product}") 668 | await process_shodan_results(interaction, result) 669 | except shodan.APIError as e: 670 | await handle_errors(interaction, e, "Shodan API Error") 671 | except Exception as e: 672 | await handle_errors(interaction, e) 673 | 674 | @client.tree.command(name="searchssl", description="Search for domains associated with a specific SSL certificate hash.") 675 | async def searchssl(interaction: discord.Interaction, ssl_hash: str): 676 | try: 677 | result = client.shodan.search(f"ssl.cert.fingerprint:{ssl_hash}") 678 | await process_shodan_results(interaction, result) 679 | except shodan.APIError as e: 680 | await handle_errors(interaction, e, "Shodan API Error") 681 | except Exception as e: 682 | await handle_errors(interaction, e) 683 | 684 | @client.tree.command(name="searchisp", description="Search devices associated with a specific ISP.") 685 | async def searchisp(interaction: discord.Interaction, isp: str): 686 | try: 687 | result = client.shodan.search(f"isp:\"{isp}\"") 688 | await process_shodan_results(interaction, result) 689 | except shodan.APIError as e: 690 | await handle_errors(interaction, e, "Shodan API Error") 691 | except Exception as e: 692 | await handle_errors(interaction, e) 693 | 694 | @client.tree.command(name="searchgeo", description="Search devices around specific GPS coordinates.") 695 | async def searchgeo(interaction: discord.Interaction, latitude: float, longitude: float, radius: int = 10): 696 | await interaction.response.defer(ephemeral=True) 697 | 698 | try: 699 | result = client.shodan.search(f"geo:{latitude},{longitude},{radius}") 700 | if not result.get('matches', []): 701 | no_results_message = (f"No devices found around the coordinates " 702 | f"Latitude: {latitude}, Longitude: {longitude} within a radius of {radius} km.") 703 | await interaction.followup.send(content=no_results_message) 704 | return 705 | 706 | await process_shodan_results(interaction, result) 707 | except shodan.APIError as e: 708 | await handle_errors(interaction, e, "Shodan API Error") 709 | except Exception as e: 710 | await handle_errors(interaction, e) 711 | 712 | @client.tree.command(name="help", description="Displays a list of available commands.") 713 | async def help_command(interaction: discord.Interaction): 714 | embed = discord.Embed(title="Available Commands", description="Here are the commands you can use:", color=0x3498db) 715 | 716 | # Basic Commands Header 717 | embed.add_field(name="🟢 Basic Commands", value="Commands for common tasks.", inline=False) 718 | 719 | basic_commands_description = "\n".join([ 720 | f"{command}: {description}" 721 | for command, description in { 722 | "/shodan": "General use of shodan. This is the main command.", 723 | "/hostinfo": "Get information about a host.", 724 | "/protocols": "List supported protocols.", 725 | "/searchcity": "Search Shodan by city.", 726 | "/searchorg": "Search Shodan by organization.", 727 | "/searchport": "Search Shodan by port.", 728 | "/searchcountry": "Search Shodan by country.", 729 | "/exploitsearch": "Search for known vulnerabilities using a term.", 730 | "/listtags": "List popular tags.", 731 | "/searchnetblock": "Search devices in a specific netblock.", 732 | "/searchproduct": "Search devices associated with a specific product.", 733 | "/searchssl": "Search for domains associated with a specific SSL certificate hash.", 734 | "/searchisp": "Search devices associated with a specific ISP.", 735 | "/searchgeo": "Search devices around specific GPS coordinates." 736 | }.items() 737 | ]) 738 | embed.add_field(name="Commands & Descriptions", value=basic_commands_description, inline=False) 739 | 740 | # Advanced Search Command Header 741 | embed.add_field(name="🔴 Advanced Command", value="**Command**: \n`/shodan\nSearch Shodan. All options will be provided.", inline=False) 742 | 743 | embed.add_field(name="Examples of Basic Searches", value=( 744 | "- Single IP: `192.168.1.1`\n" 745 | "- Domain: `example.com`\n" 746 | "- Product/Service: `nginx`" 747 | ), inline=False) 748 | 749 | embed.add_field(name="Examples of Advanced Queries", value=( 750 | "- IP Range: `ip:18.9.47.0-18.9.47.255`\n" 751 | "- Network: `net:18.9.47.0/24`\n" 752 | "- SSL Cert Subject: `ssl.cert.subject.cn:stellar.mit.edu`\n" 753 | "- Headers & HTML:\n" 754 | " - By Title: `http.title:\"Massachusetts Institute of Technology\"` - Searches for specific titles in HTTP responses.\n" 755 | " - By HTML Content: `http.html:'ua-1592615'` - Looks within the content of HTML pages.\n" 756 | "- Webcams & IoT:\n" 757 | " - Search for vulnerable cams like `wyze`, `webcamxp 5`, or more specific like:\n" 758 | " - \"`Server:yawcam\" \"Mime-Type:text/html`\"\n" 759 | " - Webcam in ASN: `screenshot.label:webcam asn:AS45102`\n" 760 | " - With Screenshot: `has_screenshot:true`" 761 | ), inline=False) 762 | 763 | await interaction.response.send_message(embed=embed, ephemeral=False) 764 | 765 | if __name__ == "__main__": 766 | config = load_config() 767 | if check_configurations(config): 768 | client = aclient(config.get("SHODAN_KEY")) 769 | setup_bot_commands() 770 | client.run(config.get("TOKEN")) 771 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # ShodanBot 2 | A Discord bot to interact with the Shodan API, allowing users to fetch information about devices, services, and vulnerabilities. 3 | 4 | ## Table of Contents 5 | 6 | - [Installation](#installation) 7 | - [Configuration](#configuration) 8 | - [Usage](#usage) 9 | - [Contributing](#contributing) 10 | - [License](#license) 11 | 12 | ## Installation 13 | 14 | 1. Clone the repository: 15 | ```bash 16 | git clone https://github.com/rocketgod-git/shodanbot.git 17 | cd shodanbot 18 | ``` 19 | 20 | 2. **Windows Users**: Run the `run.bat` file to set up the virtual environment and install necessary dependencies. 21 | 22 | **Linux Users**: Make `run.sh` executable with `chmod +x run.sh` and then run it with `./run.sh`. 23 | 24 | ## Configuration 25 | 26 | Before running the bot, you need to set up the `config.json` file: 27 | 28 | - `TOKEN`: Your Discord bot token. 29 | - `SHODAN_API_KEY`: Your Shodan API key. 30 | 31 | Example: 32 | ```json 33 | { 34 | "TOKEN": "YOUR_DISCORD_BOT_TOKEN", 35 | "SHODAN_API_KEY": "YOUR_SHODAN_API_KEY" 36 | } 37 | ``` 38 | 39 | ## Usage 40 | 41 | Invite the bot to your server and use the available commands to interact with Shodan. Here's a detailed list of the available commands: 42 | 43 | - `/hostinfo `: Get information about a host. 44 | - `/protocols`: List supported protocols. 45 | - `/search `: Search Shodan. 46 | - `/searchcity `: Search Shodan by city. 47 | - `/searchorg `: Search Shodan by organization. 48 | - `/searchport `: Search Shodan by port. 49 | - `/searchcountry `: Search Shodan by country. 50 | - `/exploitsearch `: Search for known vulnerabilities using a term. 51 | - `/listtags`: List popular tags on Shodan. 52 | - `/searchnetblock `: Search devices in a specific netblock. 53 | - `/searchproduct `: Search devices associated with a specific product. 54 | - `/searchssl `: Search for domains associated with a specific SSL certificate hash. 55 | - `/searchisp `: Search devices associated with a specific ISP. 56 | - `/searchgeo `: Search devices around specific GPS coordinates. 57 | 58 | For more advanced usage or to get more information about a particular command, use the bot's help command or refer to the bot's command descriptions in Discord. 59 | 60 | ## Contributing 61 | 62 | Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change. 63 | 64 | ## License 65 | 66 | [LICENSE](LICENSE) 67 | 68 | 69 | ![rocketgod_logo](https://github.com/RocketGod-git/shodanbot/assets/57732082/7929b554-0fba-4c2b-b22d-6772d23c4a18) 70 | -------------------------------------------------------------------------------- /run.bat: -------------------------------------------------------------------------------- 1 | @echo off 2 | 3 | REM Check if the virtual environment already exists 4 | if not exist "venv\" ( 5 | echo Creating a virtual environment... 6 | python -m venv venv 7 | 8 | REM Activate the virtual environment 9 | call venv\Scripts\activate 10 | 11 | echo Installing the required packages... 12 | pip install discord shodan 13 | ) else ( 14 | REM Activate the virtual environment 15 | call venv\Scripts\activate 16 | ) 17 | 18 | REM Run the bot 19 | python main.py 20 | -------------------------------------------------------------------------------- /run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Check if the virtual environment already exists 4 | if [ ! -d "venv" ]; then 5 | echo "Creating a virtual environment..." 6 | python3 -m venv venv 7 | 8 | # Activate the virtual environment 9 | source venv/bin/activate 10 | 11 | echo "Installing the required packages..." 12 | pip install discord shodan 13 | else 14 | # Activate the virtual environment 15 | source venv/bin/activate 16 | fi 17 | 18 | # Run the bot 19 | python3 main.py --------------------------------------------------------------------------------