├── LICENSE ├── README.md ├── data.py ├── db.7z ├── logo.png ├── replica.png └── replica.py /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 |

REPLICA

2 |
3 | Example 4 |

5 | 6 | TAME THE DRAGON 7 | 8 |

9 |
10 | 23 | 24 | 25 | 26 | 27 | ## ✨Features 28 | 29 | - ⚡ Disassemble missed instructions - Define code that Ghidra's auto analysis missed 30 | - ⚡ Detect and fix missed functions - Define functions that Ghidra's auto analysis missed 31 | - ⚡ Fix 'undefinedN' datatypes - Enhance Disassembly and Decompilation by fixing 32 | 'undefinedN' DataTypes 33 | - ⚡ Set MSDN API info as comments - Integrate information about functions, arguments 34 | and return values into Ghidra's disassembly listing in the form of comments 35 | - ⚡ Tag Functions based on API calls - rename functions that calls one or more APIs with 36 | the API name and API type family if available 37 | - ⚡ Detect and mark wrapper functions - Rename wrapper functions with the wrapping 38 | level and wrapped function name 39 | - ⚡ Fix undefined data and strings - Defines ASCII strings that Ghidra's auto analysis 40 | missed and Converts undefined bytes in the data segment into DWORDs/QWORDs 41 | - ⚡ Detect and label crypto constants - Searche and label constants known to be associated 42 | with cryptographic algorithm in the code 43 | - ⚡ Detect and comment stack strings - Find and post-comment stack strings 44 | - ⚡ Rename Functions Based on string references - rename functions that references one 45 | or more strings with the function name followed by the string name. 46 | - ⚡ Bookmark String Hints - Bookmark intersting strings (file extensions, browser agents, registry keys, etc..) 47 | 48 | ## 🚀 Installation: 49 | Copy the repository files into any of `ghidra_scripts` directories and extract `db.7z`, directories can be found from `Window->Script Manager->Script Directories` 50 | 51 | ![image](https://user-images.githubusercontent.com/22657154/72688222-becde680-3b0d-11ea-8fb2-b9baa0239042.png) 52 | 53 | Search for replica and enable `in tool` option 54 | ![image](https://user-images.githubusercontent.com/22657154/72688275-153b2500-3b0e-11ea-8fc2-77d6bfe9dc78.png) 55 | 56 | Done! 57 | ![image](https://user-images.githubusercontent.com/22657154/72688313-6d722700-3b0e-11ea-95f6-2d27519ca9fd.png) 58 | 59 | ![image](https://user-images.githubusercontent.com/22657154/73777200-bcb48a80-4791-11ea-8f8c-7dec1aadc5d7.png) 60 | 61 | 62 | 63 | ## 🔒 License 64 | 65 | Licensed under [GNU General Public License v3.0](https://github.com/reb311ion/replica/blob/master/LICENSE) 66 | 67 | ## ⛏️ BUG? OPEN NEW ISSUE 68 | OPEN [NEW ISSUE](https://github.com/reb311ion/replica/issues) 69 | -------------------------------------------------------------------------------- /db.7z: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/reb311ion/replica/fede41b9afd2ef5e33c860ce114e8a24193751ac/db.7z -------------------------------------------------------------------------------- /logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/reb311ion/replica/fede41b9afd2ef5e33c860ce114e8a24193751ac/logo.png -------------------------------------------------------------------------------- /replica.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/reb311ion/replica/fede41b9afd2ef5e33c860ce114e8a24193751ac/replica.png -------------------------------------------------------------------------------- /replica.py: -------------------------------------------------------------------------------- 1 | # Automatically enhance Ghidra auto analysis 2 | # @author @reb311ion 3 | # @keybinding shift R 4 | # @category Analysis 5 | # @toolbar replica.png 6 | 7 | import json 8 | import re 9 | import struct 10 | from time import sleep 11 | 12 | import ghidra.app.plugin.core.analysis.AutoAnalysisManager as AutoAnalysisManager 13 | import ghidra.program.util.ProgramMemoryUtil as ProgramMemoryUtil 14 | import java.util.ArrayList as ArrayList 15 | from ghidra.app.decompiler import DecompInterface 16 | from ghidra.app.services import DataTypeManagerService 17 | from ghidra.program.model.address.Address import * 18 | from ghidra.program.model.data import ArrayDataType 19 | from ghidra.program.model.data import PointerDataType 20 | from ghidra.program.model.listing import * 21 | from ghidra.program.model.symbol import * 22 | from ghidra.program.model.symbol import FlowType 23 | from ghidra.program.model.symbol.SourceType import * 24 | from ghidra.program.model.symbol.SourceType import * 25 | from ghidra.program.model.symbol.SymbolUtilities import * 26 | from ghidra.util.task import ConsoleTaskMonitor 27 | from java.lang import IllegalArgumentException 28 | from java.util import * 29 | 30 | from data import * 31 | 32 | try: 33 | open(dbPath).read() 34 | except: 35 | dbPath = askFile("db.json path", "Choose file:") 36 | dbPath = str(dbPath) 37 | db = open(dbPath.replace("db.json", "data.py"), "a") 38 | db.write("\n\n") 39 | db.write("dbPath = r'" + dbPath + "'") 40 | db.close() 41 | 42 | 43 | def addrToInt(addr): 44 | return int("0x" + addr.toString(), 16) 45 | 46 | 47 | def disasFun(addr, getBody=False): 48 | code = "" 49 | programList = currentProgram.getListing() 50 | function = getFunctionContaining(addr) 51 | start = function.getEntryPoint() 52 | instruction = programList.getInstructionAt(start) 53 | while instruction: 54 | code += instruction.address.toString() + " " + instruction.toString() 55 | code += "\n" 56 | if isValidEnd(instruction): 57 | if getBody: 58 | end = instruction.address 59 | return code, addrToInt(start), addrToInt(end) 60 | else: 61 | return code 62 | instruction = instruction.next 63 | 64 | 65 | def getFunctionStartEnd(function): 66 | functionBody = function.getBody().toList() 67 | start = addrToInt(functionBody[0].minAddress) 68 | end = addrToInt(functionBody[-1].maxAddress) 69 | return start, end 70 | 71 | 72 | def isWrapperFunction(function): 73 | programList = currentProgram.getListing() 74 | instruction = programList.getInstructionAt(function.getEntryPoint()) 75 | callsCounter = 0 76 | while instruction: 77 | if FlowType.isJump(instruction.getFlowType()): 78 | return False 79 | if FlowType.isCall(instruction.getFlowType()): 80 | callsCounter += 1 81 | if callsCounter > 1: 82 | return False 83 | if isValidEnd(instruction): 84 | return True 85 | instruction = instruction.next 86 | 87 | 88 | def checkString(addr): 89 | data = getDataAt(addr) 90 | sym = getSymbolAt(addr) 91 | if data: 92 | dataCmp = data.getBaseDataType().getName().lower() 93 | if ("string" == dataCmp) or ("unicode" == dataCmp): 94 | return data.getValue() 95 | if sym is not None: 96 | symCmp = str(sym).lower() 97 | if symCmp.startswith("ptr_s_") or symCmp.startswith("ptr_u_") or symCmp.startswith( 98 | "rep_ptr_s_") or symCmp.startswith("rep_ptr_u_"): 99 | return str(sym) 100 | return None 101 | 102 | 103 | def getaddressListFromDisas(code): 104 | if code == None: 105 | return None 106 | pattern = "0x[a-fA-F0-9]{6,}" 107 | return re.findall(pattern, code) 108 | 109 | 110 | def setcommnet(addr, msg): 111 | listing = currentProgram.getListing() 112 | codeUnit = listing.getCodeUnitAt(addr) 113 | codeUnit.setComment(codeUnit.PLATE_COMMENT, msg) 114 | 115 | 116 | def FormatD(description, tabsize, termsize=100): 117 | data = "" 118 | lines = [] 119 | line = [] 120 | tabsize = " " * tabsize 121 | Tab = False 122 | descriptionarr = description.split(" ") 123 | 124 | for index in descriptionarr: 125 | line.append(index) 126 | if len(" ".join(line)) >= (int(termsize) - 30): 127 | lines.append(" ".join(line)) 128 | line = [] 129 | if lines == []: 130 | data += "\n" 131 | data += " ".join(line) 132 | else: 133 | for index in lines: 134 | if Tab: 135 | data += "\n" 136 | data += tabsize + index 137 | else: 138 | data += "\n" 139 | data += index 140 | Tab = True 141 | if not line == [] and Tab == True: 142 | data += "\n" 143 | data += tabsize + " ".join(line) 144 | return data[1:] 145 | 146 | 147 | def getApiInfo(function, database): 148 | msg = "" 149 | function = str(function) 150 | if function[-1] == "A" or function[-1] == "W": 151 | function = function[:-1] 152 | if function[:-2] == "EX": 153 | function = function[:-2] 154 | for i in database['msdn']['functions']['function']: 155 | if i['name'] == function: 156 | msg += 'Name: ' + i['name'] 157 | msg += "\n" 158 | msg += '\nDLL: ' + i['dll'] 159 | msg += "\n" 160 | msg += '\nDescription: ' + FormatD(i['description'], 0) 161 | try: 162 | argz = i['arguments']['argument'] 163 | except: 164 | argz = None 165 | if argz: 166 | msg += "\n" 167 | msg += '\nArguments: ' 168 | msg += "\n" 169 | if 'dict' in str(type(argz)): 170 | msg += '\n Name: ' + str(argz['name']) 171 | msg += "\n" 172 | msg += ' Description: ' + FormatD(argz['description'], 9) 173 | msg += "\n" 174 | elif 'list' in str(type(argz)): 175 | for arg in argz: 176 | msg += '\n Name: ' + str(arg['name']) 177 | msg += "\n" 178 | msg += ' Description: ' + FormatD(arg['description'], 16) 179 | msg += "\n" 180 | if i['returns']: 181 | msg += "\n" + FormatD(i['returns'], 0) 182 | return msg 183 | 184 | 185 | def findAllReferences(addr, taskMonitor): 186 | directReferenceList = ArrayList() 187 | results = ArrayList() 188 | toAddr = currentProgram.getListing().getCodeUnitContaining(addr).getMinAddress() 189 | try: 190 | ProgramMemoryUtil.loadDirectReferenceList(currentProgram, 1, toAddr, None, directReferenceList, taskMonitor) 191 | except: 192 | return Collections.emptyList() 193 | for rap in directReferenceList: 194 | fromAddr = currentProgram.getListing().getCodeUnitContaining(rap.getSource()).getMinAddress() 195 | if (not fromAddr in results): 196 | results.add(fromAddr) 197 | ri = currentProgram.getReferenceManager().getReferencesTo(toAddr) 198 | while (ri.hasNext()): 199 | r = ri.next() 200 | fromAddr = r.getFromAddress() 201 | if (not fromAddr in results): 202 | results.add(fromAddr) 203 | return results 204 | 205 | 206 | def getWrapperFunctionName(functionName): 207 | if "rep_wrap" in functionName: 208 | wrapNumber = int(functionName.split("_")[2]) + 1 209 | return "rep_wrap_" + str(wrapNumber) + "_" + "_".join(functionName.split("_")[3:]) 210 | else: 211 | return "rep_wrap_0_" + functionName 212 | 213 | 214 | def recoverStackString(addr): 215 | stackStr = "" 216 | inst = getInstructionAt(addr) 217 | maxaddr = addr 218 | while inst and inst.getScalar(1): 219 | value = inst.getScalar(1).value 220 | if value == 0x00 and stackStr != "": 221 | return stackStr, str(maxaddr) 222 | stackStrPart = "" 223 | while value > 0: 224 | stackStrPart += chr(value & 0xff) 225 | value = value >> 8 226 | stackStr += stackStrPart 227 | try: 228 | if (inst.getNext().getScalar(1) == None) and (inst.getNext().getNext().getScalar(1) != None): 229 | inst = inst.getNext() 230 | except: 231 | pass 232 | inst = inst.getNext() 233 | maxaddr = inst.address 234 | return stackStr, str(maxaddr) 235 | 236 | 237 | def getDataType(dataType, isArr=False, elm=0): 238 | tool = state.getTool() 239 | service = tool.getService(DataTypeManagerService) 240 | dataTypeManagers = service.getDataTypeManagers() 241 | for manager in dataTypeManagers: 242 | dt = manager.getDataType(dataType.replace(" ", "").replace("*", "")) 243 | if dt != None: 244 | if "*" in dataType: 245 | for i in range(str(dataType).count("*")): 246 | dt = manager.getPointer(dt) 247 | if isArr: 248 | if type(dt) == PointerDataType: 249 | ln = dt.getDataType().getLength() 250 | else: 251 | ln = dt.getLength() 252 | dt = ArrayDataType(dt, elm, ln) 253 | return dt 254 | return None 255 | 256 | 257 | def getDataTypeWrap(dt, isArr=False, elm=0): 258 | ptr = "" 259 | if "*" in dt: 260 | ptr = " " + ('*' * dt.count("*")) 261 | if "1" in dt: 262 | dt = getDataType("/byte" + ptr, isArr, elm) 263 | elif "2" in dt: 264 | dt = getDataType("/word" + ptr, isArr, elm) 265 | elif "4" in dt: 266 | dt = getDataType("/dword" + ptr, isArr, elm) 267 | elif "8" in dt: 268 | dt = getDataType("/qword" + ptr, isArr, elm) 269 | else: 270 | return None 271 | return dt 272 | 273 | 274 | def fixUndefinedDataTypes(): 275 | monitor.setMessage("Fixing Undefined Data Types") 276 | function = getFirstFunction() 277 | decompinterface = DecompInterface() 278 | decompinterface.openProgram(currentProgram) 279 | 280 | while function is not None: 281 | prt = False 282 | varList = [] 283 | try: 284 | tokengrp = decompinterface.decompileFunction(function, 0, ConsoleTaskMonitor()) 285 | code = tokengrp.getDecompiledFunction().getC() 286 | for line in code.split("\n"): 287 | if line == " \r": 288 | break 289 | if prt: 290 | varList.append(filter(None, line.split(";")[0].split(" "))) 291 | if line.startswith("{"): 292 | prt = True 293 | except: 294 | pass 295 | 296 | for var in function.getAllVariables(): 297 | varMsg = str(var) 298 | dt = str(var.getDataType()) 299 | inx = 0 300 | if "undefined" in dt: 301 | for decVar in varList: 302 | if len(decVar) > 1: 303 | arr = False 304 | if len(decVar) == 3: 305 | try: 306 | arr = True 307 | inx = int(decVar[2].split("[")[1].split("]")[0]) 308 | except: 309 | arr = False 310 | if decVar[1].replace("*", "") == var.getName(): 311 | if not "undefined" in decVar[0]: 312 | if '*' in decVar[1]: 313 | dt = getDataType("/" + decVar[0] + " " + ('*' * decVar[1].count("*")), arr, inx) 314 | else: 315 | dt = getDataType("/" + decVar[0], arr, inx) 316 | else: 317 | if '*' in decVar[1]: 318 | dtlen = decVar[0].replace("undefined", "") 319 | if dtlen == "": 320 | dtlen = "1" 321 | dt = getDataTypeWrap(dtlen + ('*' * decVar[1].count("*")), arr, inx) 322 | else: 323 | dt = getDataTypeWrap(decVar[0], arr, inx) 324 | 325 | if type(dt) == str: 326 | dt = str(var.getDataType()) 327 | dt = dt.replace("undefined", "") 328 | dt = getDataTypeWrap(dt) 329 | if dt: 330 | try: 331 | var.setDataType(dt, USER_DEFINED) 332 | print "[+] " + str(function.getName()) + ": " + varMsg + " -> " + str(dt) 333 | except: 334 | pass 335 | function = getFunctionAfter(function) 336 | return 0 337 | 338 | 339 | def Pack(const): 340 | byte_array = [] 341 | if const["size"] == "B": 342 | byte_array = const["array"] 343 | elif const["size"] == "L": 344 | for val in const["array"]: 345 | byte_array += list(map(lambda x: x if type(x) == int else ord(x), struct.pack("= end: 388 | print("[+] Created Function: " + "FUN_" + addressString) 389 | else: 390 | removeFunction(createdFunction) 391 | except: 392 | pass 393 | 394 | 395 | def tagFunctions(): 396 | monitor.setMessage("Tagging Functions With Called API Family And Names") 397 | function = getFirstFunction() 398 | while function is not None and not monitor.isCancelled(): 399 | if function.getName().startswith("FUN"): 400 | for calledFunction in function.getCalledFunctions(monitor): 401 | tagName = "" 402 | for tag in apiTags.keys(): 403 | for value in apiTags[tag]: 404 | if value in str(calledFunction): 405 | tagName = "rep__" + tag + "_" + str(function.getEntryPoint()) + "_" 406 | if tagName == "": 407 | tagName = "rep_" + str(function.getEntryPoint()) + "_" 408 | if not "FUN_" in str(calledFunction) and not "rep_" in str(calledFunction): 409 | functionNewName = tagName + str(calledFunction) 410 | print "[+]" + str(function.getName()) + " -> " + functionNewName 411 | function.setName(functionNewName, USER_DEFINED) 412 | break 413 | function = getFunctionAfter(function) 414 | return 0 415 | 416 | 417 | def detectWrapperFunctions(): 418 | monitor.setMessage("Labeling Wrapper Functions") 419 | FunctionRenamed = True 420 | while FunctionRenamed: 421 | function = getFirstFunction() 422 | FunctionRenamed = False 423 | while function is not None and not monitor.isCancelled(): 424 | FunctionName = str(function.getName()) 425 | if FunctionName.startswith("FUN_") or FunctionName.startswith("rep"): 426 | calledFunction = function.getCalledFunctions(monitor) 427 | if len(calledFunction) == 1 and isWrapperFunction(function): 428 | functionNewName = getWrapperFunctionName(str(list(calledFunction)[0])) 429 | isFunctionRecursive = str(function.getName()) == str(list(calledFunction)[0]) 430 | 431 | if str(function.getName()) != functionNewName and not isFunctionRecursive: 432 | print "[+] " + str(function.getName()) + " -> " + functionNewName 433 | FunctionRenamed = True 434 | function.setName(functionNewName, USER_DEFINED) 435 | function = getFunctionAfter(function) 436 | return 0 437 | 438 | 439 | def cleanUpDisassembly(): 440 | monitor.setMessage("Cleaning Up Disassembly") 441 | bmgr = currentProgram.getBookmarkManager() 442 | listing = currentProgram.getListing() 443 | previousSet = None 444 | while (True): 445 | badAddr = bmgr.getBookmarkAddresses("Error") 446 | bai = badAddr.getAddresses(True) 447 | while (bai.hasNext()): 448 | ba = bai.next() 449 | bm = bmgr.getBookmark(ba, "Error", "Bad Instruction") 450 | if (bm != None): 451 | contextReg = currentProgram.getProgramContext().getRegister("TMode") 452 | baEnd = ba 453 | if (listing.getCodeUnitAt(ba) != None): 454 | baEnd = listing.getCodeUnitAt(ba).getMaxAddress() 455 | while (getDataContaining(baEnd.add(4)) != None): 456 | baEnd = getDataContaining(baEnd.add(4)).getMaxAddress() 457 | while (getDataContaining(ba.subtract(1)) != None): 458 | ba = getDataContaining(ba.subtract(1)).getAddress() 459 | listing.clearCodeUnits(ba, baEnd, False) 460 | if (contextReg != None): 461 | paddr = listing.getInstructionBefore(ba).getAddress() 462 | if (paddr != None): 463 | rv = currentProgram.getProgramContext().getRegisterValue(contextReg, paddr) 464 | currentProgram.getProgramContext().setRegisterValue(ba, baEnd, rv) 465 | bmgr.removeBookmark(bm) 466 | else: 467 | break 468 | while (AutoAnalysisManager.getAnalysisManager(currentProgram).isAnalyzing()): 469 | sleep(500) 470 | if (badAddr.equals(previousSet)): 471 | break 472 | previousSet = badAddr 473 | 474 | 475 | def fixMissingDisassembly(): 476 | monitor.setMessage("Fixing missing instructions") 477 | memoryBlocks = getCurrentProgram().getMemory().getBlocks() 478 | for block in memoryBlocks: 479 | if block.isExecute(): 480 | blockStart = int("0x" + block.getStart().toString(), 16) 481 | blockEnd = int("0x" + block.getEnd().toString(), 16) 482 | for addr in range(blockStart, blockEnd): 483 | addr = toAddr(addr) 484 | alignment = currentProgram.getLanguage().getInstructionAlignment() 485 | if getInstructionAt(addr) == None and addr.offset % alignment == 0: 486 | disassemble(addr) 487 | cleanUpDisassembly() 488 | 489 | 490 | def setApiInfoComment(): 491 | db = open(dbPath).read() 492 | loadedDB = json.loads(db) 493 | monitor.setMessage("Setting MSDN API Info For Functions") 494 | function = getFirstFunction() 495 | while function is not None and not monitor.isCancelled(): 496 | FunctionName = str(function.getName()) 497 | if not "FUN_" in FunctionName: 498 | msg = getApiInfo(FunctionName, loadedDB) 499 | if msg != None and len(msg) > 10: 500 | setcommnet(function.getEntryPoint(), msg) 501 | print "[+] " + FunctionName 502 | function = getFunctionAfter(function) 503 | return 0 504 | 505 | 506 | def renameFunctionsBasedOnStrRef(): 507 | monitor.setMessage("Rename Functions Based on string refrences ") 508 | function = getFirstFunction() 509 | while function is not None and not monitor.isCancelled(): 510 | if function.getName().startswith("FUN"): 511 | addressList = getaddressListFromDisas(disasFun(function.getEntryPoint())) 512 | if addressList: 513 | for address in addressList: 514 | name = checkString(toAddr(address)) 515 | if name != None: 516 | if len(name) < 3: 517 | continue 518 | name = re.sub(r'[^a-zA-Z0-9_.]+', '', name[:50]) 519 | functionName = "rep_" + str(function.getEntryPoint()) + "_s_" + name 520 | print "[+] " + function.getName() + " -> " + functionName 521 | function.setName(functionName, USER_DEFINED) 522 | break 523 | function = getFunctionAfter(function) 524 | return 0 525 | 526 | 527 | def detectCryptoConstants(): 528 | monitor.setMessage("Labeling Crypto Constants Within The Binary") 529 | symbolTable = currentProgram.getSymbolTable() 530 | for const in non_sparse_consts: 531 | const["byte_array"] = Pack(const) 532 | found = currentProgram.getMemory().findBytes(currentProgram.getMinAddress(), const["byte_array"], None, True, 533 | monitor) 534 | if found != None: 535 | labelName = "rep_crypto_constant_" + const['algorithm'] + "_" + const['name'] 536 | print "[+] " + const['algorithm'] + " " + const['name'] + " 0x" + str(found) + " -> " + labelName 537 | symbolTable.createLabel(found, labelName, USER_DEFINED) 538 | 539 | listing = currentProgram.getListing() 540 | instruction = listing.getInstructions(1) 541 | while instruction.hasNext(): 542 | inst = instruction.next() 543 | for const in sparse_consts: 544 | if str(const["array"][0]).upper() == str(inst.getScalar(1)).upper(): 545 | labeladdr = inst.getAddress() 546 | for val in const["array"][1:]: 547 | inst = instruction.next() 548 | if not str(val).upper() == str(inst.getScalar(1)).upper(): 549 | if const['name'] == "SHA1_H" and const['array'][-1]: 550 | labelName = "rep_crypto_constant_MD5_initstate" 551 | print "[+] " + "MD5_initstate" + " 0x" + str(labeladdr) + " -> " + labelName 552 | symbolTable.createLabel(labeladdr, labelName, USER_DEFINED) 553 | break 554 | else: 555 | labelName = "rep_crypto_constant_" + const['algorithm'] + "_" + const['name'] 556 | print "[+] " + const['name'] + " 0x" + str(labeladdr) + " -> " + labelName 557 | symbolTable.createLabel(labeladdr, labelName, USER_DEFINED) 558 | 559 | 560 | def detectStackStrings(): 561 | monitor.setMessage("Detecting Stack Strings") 562 | programList = currentProgram.getListing() 563 | instruction = programList.getInstructions(1) 564 | while instruction.hasNext() and not monitor.isCancelled(): 565 | inst = instruction.next() 566 | instStr = str(inst.getScalar(1)).replace("0x", "") 567 | if not instStr == "None" and (len(instStr) % 2) == 0 and not "-" in instStr: 568 | stackStr, maxAddr = recoverStackString(inst.address) 569 | FilteredStackStr = re.sub(r'[^a-zA-Z0-9 .,\-\*\/\[\]\{\}\!\@\#\$\%\^\&\(\)\=\~\:\"\'\\\+\?\>\<\`\_\;]+', '', 570 | stackStr) 571 | if len(FilteredStackStr) > 4 and FilteredStackStr == stackStr: 572 | print "[+] " + str(inst.address) + " " + stackStr 573 | codeUnit = programList.getCodeUnitAt(inst.address) 574 | codeUnit.setComment(codeUnit.PRE_COMMENT, stackStr) 575 | 576 | while str(inst.address) != maxAddr: 577 | inst = instruction.next() 578 | 579 | 580 | def fixUndefinedData(): 581 | data_sections = [] 582 | addr_factory = currentProgram.getAddressFactory() 583 | memory_manager = currentProgram.getMemory() 584 | address_ranges = memory_manager.getLoadedAndInitializedAddressSet() 585 | is64Bit = "64" in currentProgram.language.toString() 586 | 587 | executable_set = memory_manager.getExecuteSet() 588 | addr_view = address_ranges.xor(executable_set) 589 | for section in addr_view: 590 | new_view = addr_factory.getAddressSet(section.getMinAddress(), section.getMaxAddress()) 591 | data_sections.append(new_view) 592 | 593 | for section in data_sections: 594 | print '[+] Section {} - {}'.format(section.getMinAddress(), section.getMaxAddress()) 595 | startAddr = section.getMinAddress() 596 | endAddr = section.getMaxAddress() 597 | 598 | for addr in range(addrToInt(startAddr), addrToInt(endAddr)): 599 | try: 600 | addr = toAddr(addr) 601 | if getSymbolAt(addr).getSymbolType().toString() == "Label" and ( 602 | getByte(addr) > 31 and getByte(addr) < 128): 603 | enc = 1 604 | while True: 605 | addrPlus = toAddr(addrToInt(addr) + enc) 606 | addrByte = getByte(addrPlus) 607 | if not (((addrByte > 31 and addrByte < 128) or addrByte == 0) and getSymbolAt( 608 | addrPlus) == None): 609 | break 610 | enc += 1 611 | if enc >= 4: 612 | createAsciiString(addr, enc) 613 | except: 614 | continue 615 | 616 | undefinedData = getUndefinedDataAt(startAddr) 617 | if undefinedData is None: 618 | undefinedData = getUndefinedDataAfter(startAddr) 619 | 620 | while undefinedData is not None and undefinedData.getAddress() < endAddr: 621 | undefinedAddr = undefinedData.getAddress() 622 | undefinedData = getUndefinedDataAfter(undefinedAddr) 623 | try: 624 | if is64Bit: 625 | createQWord(undefinedAddr) 626 | else: 627 | createDWord(undefinedAddr) 628 | 629 | except: 630 | continue 631 | 632 | 633 | def createBookMark(addr, category, description): 634 | bm = currentProgram.getBookmarkManager() 635 | bm.setBookmark(addr, "Info", category, description) 636 | 637 | 638 | def isRef(addr, hint): 639 | if getReferencesTo(addr).tolist() != []: 640 | return "Referenced " + hint 641 | else: 642 | return hint 643 | 644 | 645 | def bookMarkStringHints(): 646 | monitor.setMessage("Book Marking String Hint") 647 | listing = currentProgram.getListing() 648 | monitor.setMessage("BookMarking Intersting Strings [Hints]") 649 | dataIterator = listing.getDefinedData(True) 650 | while (dataIterator.hasNext() and not monitor.isCancelled()): 651 | data = dataIterator.next() 652 | strType = data.getDataType().getName().lower() 653 | matchStr = str(data.getValue()) 654 | if ("unicode" in strType or "string" in strType) and matchStr: 655 | for hint in stringHint.keys(): 656 | for value in stringHint[hint]: 657 | if hint == "Extension Hint": 658 | if matchStr.endswith(value) or (value + " ") in matchStr: 659 | hint = isRef(data.getAddress(), hint) 660 | createBookMark(data.getAddress(), "Replica", hint) 661 | print "[+] " + hint + ": " + repr(matchStr) 662 | else: 663 | if value == matchStr or (len(value) >= 6 and value in matchStr): 664 | hint = isRef(data.getAddress(), hint) 665 | createBookMark(data.getAddress(), "Replica", hint) 666 | print "[+] " + hint + ": " + repr(matchStr) 667 | return 0 668 | 669 | 670 | if __name__ == '__main__': 671 | try: 672 | 673 | choices = askChoices("Choices", "Please choose from Analysis Options.", 674 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 675 | ["Disassemble missed instructions", "Detect and fix missed functions", 676 | "Fix undefined datatypes", "Set MSDN API info as comments", 677 | "Tag Functions based on API calls", "Detect and mark wrapper functions", 678 | "Fix undefined data and strings", "Detect and label crypto constants", 679 | "Detect and comment stack strings", "Rename Functions Based on string references", 680 | "Bookmark String Hints"]) 681 | 682 | if 0 in choices: 683 | fixMissingDisassembly() 684 | if 1 in choices: 685 | detectUndefinedFunctions() 686 | if 2 in choices: 687 | fixUndefinedDataTypes() 688 | if 3 in choices: 689 | setApiInfoComment() 690 | if 4 in choices: 691 | tagFunctions() 692 | if 5 in choices: 693 | detectWrapperFunctions() 694 | if 6 in choices: 695 | fixUndefinedData() 696 | if 7 in choices: 697 | detectCryptoConstants() 698 | if 8 in choices: 699 | detectStackStrings() 700 | if 9 in choices: 701 | renameFunctionsBasedOnStrRef() 702 | if 10 in choices: 703 | bookMarkStringHints() 704 | 705 | except IllegalArgumentException as error: 706 | print error.toString() 707 | --------------------------------------------------------------------------------