├── LICENSE ├── README.md ├── protocols ├── ftp_proto.py ├── ftps_proto.py ├── sample_proto.py └── smb_proto.py └── xcavator.py /LICENSE: -------------------------------------------------------------------------------- 1 |  GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | xcavator 2 | ======== 3 | A network data locater using credentials obtained during penetration tests. 4 | 5 | Xcavator is a tool that scans a range of IP addresses for services that host files (FTP, FTPS and SMB at the moment) and for 6 | given credentials it will try to download everything it can and scan within the files for interesting strings. 7 | 8 | Another mode is to download only those files that their filenames match a RegEx. 9 | 10 | Developed by Nikos Laleas, nikos d0t laleas at nccgroup d0t com 11 | 12 | Released under AGPL. See LICENSE for more information. 13 | 14 | Prerequisites 15 | ------------- 16 | Python 3.3 and [[https://pypi.python.org/pypi/pysmb | pysmb]] 17 | 18 | Options 19 | ------- 20 | All the necessary parameters are picked up from a config file witch is created and populated on the first run. 21 | 22 | #####Config file example 23 |
24 | [SMB]
25 | user = h4x0r
26 | pass = 123456
27 | regex = \bpassword\b
28 | port = 445
29 | range = 192.168.1.1-192.168.1.15, 10.10.10.0/24
30 | 
31 | 32 | There are also additional optional arguments: 33 | 34 |
35 |   -h, --help                      show this help message and exit
36 |   
37 |   -c CONFIG, --config CONFIG      Config file (Default: xcavator.conf)
38 |   
39 |   -t TIMEOUT, --timeout TIMEOUT		Timeout in seconds (Default: 2s)
40 |   
41 |   -s, --search                    Search mode. Searches recursively for filenames
42 |                                   matching RegEx instead of downloading everything
43 |                                   (Default: downloads everything and scans for strings)
44 |                                   
45 |   -v, --verbose                   Verbosity level. More "v"s, more detail. (Default: Prints basic info)
46 | 
47 | 48 | Adding new protocols 49 | -------------------- 50 | In order to support new protocols you need to create a file named protocolname_proto.py in the 'protocols' directory. Have a look at 'sample_proto.py'. 51 | Finally, edit the 'xcavator.py' and add the protocol name and the default port to the correspondent lists. -------------------------------------------------------------------------------- /protocols/ftp_proto.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3.3 2 | # Released as open source by NCC Group Plc - http://www.nccgroup.com/ 3 | # Developed by Nikos Laleas, nikos dot laleas at nccgroup dot com 4 | # https://github.com/nccgroup/xcavator 5 | # Released under AGPL. See LICENSE for more information 6 | 7 | from ftplib import FTP 8 | from xcavator import convert_bytes 9 | import ftplib 10 | import os 11 | 12 | 13 | def startProtocol(port, user, passwd, ip, regex, target_path, args): 14 | global num_files, size, mirror, verbose, timeout 15 | num_files = 0 16 | size = 0 17 | mirror = args.search 18 | verbose = args.verbose 19 | timeout = args.timeout 20 | try: 21 | print(70*'#') 22 | print('Trying FTP server: %s:%s' %(ip, port)) 23 | host = FTP() 24 | host.connect(str(ip), int(port), timeout) 25 | host.login(user, passwd) 26 | #target_path=os.path.join(destination, str(ip)) 27 | #makedir(target_path) 28 | print('Connected... Downloading files...\n') 29 | files = downloadFTPFiles(target_path, host, regex) 30 | print('%i files (%s) downloaded... Closing connection...' % (files, convert_bytes(size))) 31 | host.close() 32 | except ftplib.all_errors as err: 33 | print (err) 34 | 35 | 36 | def makedir(path): 37 | if os.path.isdir(path): 38 | return 39 | dirname = os.path.dirname(path) 40 | if dirname: makedir(dirname) 41 | os.mkdir(path, 0o777) 42 | 43 | 44 | def downloadFTPFiles(destination, host, regex): 45 | global num_files, size 46 | pwd = host.pwd() 47 | if destination and not os.path.isdir(destination): 48 | try: 49 | makedir(destination) 50 | except os.error as err: 51 | if verbose > 0: print(err) 52 | return 53 | subdirs = [] 54 | listing = [] 55 | host.retrlines('LIST', listing.append) 56 | for line in listing: 57 | prop = line.split(None, 8) 58 | if len(prop) < 6: continue 59 | filename = prop[-1].lstrip() 60 | #is symlink? 61 | if (prop[0][0]) is 'l': continue 62 | if filename is ('.' or '..'): continue 63 | #is directory? 64 | if (prop[0][0]) is 'd': 65 | subdirs.append(filename) 66 | continue 67 | fullname = os.path.join(destination, filename) 68 | tempname = os.path.join(destination, filename+'.tmp') 69 | try: 70 | os.unlink(tempname) 71 | except os.error: 72 | pass 73 | try: 74 | fp = open(tempname, 'wb') 75 | except IOError as err: 76 | if verbose > 0: print ("Can't create %r: %s" % (tempname, err)) 77 | continue 78 | fullpath='' 79 | if pwd is not '/': fullpath = '%s/%s' %(pwd, filename) 80 | else: fullpath = '/%s' % filename 81 | try: 82 | if not mirror: 83 | if verbose > 2: print('Checking file: %r' % fullpath) 84 | if regex.match(filename): 85 | if verbose > 2: print('***Found match...') 86 | filesize = host.size(filename) 87 | if verbose > 1: print('Downloading file: %s.....[%s]' % (fullpath, convert_bytes(filesize))) 88 | host.retrbinary('RETR ' + filename, fp.write, 8*1024) 89 | size += filesize 90 | num_files+=1 91 | else: 92 | if verbose > 2: print('No match...') 93 | fp.close() 94 | os.remove(tempname) 95 | else: 96 | filesize = host.size(filename) 97 | if verbose > 1: print('Downloading file: %s.....[%s]' % (fullpath, convert_bytes(filesize))) 98 | host.retrbinary('RETR ' + filename, fp.write, 8*1024) 99 | size += filesize 100 | num_files+=1 101 | except ftplib.error_perm as err: 102 | if verbose > 1: print ('%s: %s' %(fullpath, err)) 103 | fp.close() 104 | os.remove(tempname) 105 | continue 106 | fp.close() 107 | try: 108 | os.unlink(fullname) 109 | except os.error: 110 | pass 111 | try: 112 | os.rename(tempname, fullname) 113 | except os.error: 114 | continue 115 | 116 | for subdir in subdirs: 117 | localsub = os.path.join(destination, subdir) 118 | pwd = host.pwd() 119 | try: 120 | if verbose > 2: print('Changing current directory to: %r' % (pwd+subdir)) 121 | host.cwd(subdir) 122 | except ftplib.error_perm as err: 123 | if verbose > 0: print('%s\n%s' %(subdir, err)) 124 | continue 125 | else: 126 | downloadFTPFiles(localsub, host, regex) 127 | host.cwd('..') 128 | if host.pwd() != pwd: 129 | break 130 | #Delete empty directories 131 | try: os.rmdir(localsub) 132 | except OSError: pass 133 | return num_files 134 | -------------------------------------------------------------------------------- /protocols/ftps_proto.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3.3 2 | # Released as open source by NCC Group Plc - http://www.nccgroup.com/ 3 | # Developed by Nikos Laleas, nikos dot laleas at nccgroup dot com 4 | # https://github.com/nccgroup/xcavator 5 | # Released under AGPL. See LICENSE for more information 6 | 7 | from ftplib import FTP_TLS 8 | from xcavator import convert_bytes 9 | import ftplib 10 | import os 11 | 12 | 13 | def startProtocol(port, user, passwd, ip, regex, target_path, args): 14 | global num_files, size, mirror, verbose, timeout 15 | num_files = 0 16 | size = 0 17 | mirror = args.search 18 | verbose = args.verbose 19 | timeout = args.timeout 20 | try: 21 | print(70*'#') 22 | print('Trying FTPS server: %s:%s' %(ip, port)) 23 | host = FTP_TLS(str(ip), timeout = timeout) 24 | host.login(user, passwd) 25 | host.prot_p() 26 | print('Connected... Downloading files...\n') 27 | files = downloadFTPFiles(target_path, host, regex) 28 | print('%i files (%s) downloaded... Closing connection...' % (files, convert_bytes(size))) 29 | host.close() 30 | except ftplib.all_errors as err: 31 | print (err) 32 | 33 | 34 | def makedir(path): 35 | if os.path.isdir(path): 36 | return 37 | dirname = os.path.dirname(path) 38 | if dirname: makedir(dirname) 39 | os.mkdir(path, 0o777) 40 | 41 | 42 | def downloadFTPFiles(destination, host, regex): 43 | global num_files, size 44 | pwd = host.pwd() 45 | if destination and not os.path.isdir(destination): 46 | try: 47 | makedir(destination) 48 | except os.error as err: 49 | if verbose > 0: print(err) 50 | return 51 | subdirs = [] 52 | listing = [] 53 | host.retrlines('LIST', listing.append) 54 | for line in listing: 55 | prop = line.split(None, 8) 56 | if len(prop) < 6: continue 57 | filename = prop[-1].lstrip() 58 | #is symlink? 59 | if (prop[0][0]) is 'l': continue 60 | if filename is ('.' or '..'): continue 61 | #is directory? 62 | if (prop[0][0]) is 'd': 63 | subdirs.append(filename) 64 | continue 65 | fullname = os.path.join(destination, filename) 66 | tempname = os.path.join(destination, filename+'.tmp') 67 | try: 68 | os.unlink(tempname) 69 | except os.error: 70 | pass 71 | try: 72 | fp = open(tempname, 'wb') 73 | except IOError as err: 74 | if verbose > 0: print ("Can't create %r: %s" % (tempname, err)) 75 | continue 76 | fullpath='' 77 | if pwd is not '/': fullpath = '%s/%s' %(pwd, filename) 78 | else: fullpath = '/%s' % filename 79 | try: 80 | if not mirror: 81 | if verbose > 2: print('Checking file: %r' % fullpath) 82 | if regex.match(filename): 83 | if verbose > 2: print('***Found match...') 84 | filesize = host.size(filename) 85 | if verbose > 1: print('Downloading file: %s.....[%s]' % (fullpath, convert_bytes(filesize))) 86 | host.retrbinary('RETR ' + filename, fp.write, 8*1024) 87 | size += filesize 88 | num_files+=1 89 | else: 90 | if verbose > 2: print('No match...') 91 | fp.close() 92 | os.remove(tempname) 93 | else: 94 | filesize = host.size(filename) 95 | if verbose > 1: print('Downloading file: %s.....[%s]' % (fullpath, convert_bytes(filesize))) 96 | host.retrbinary('RETR ' + filename, fp.write, 8*1024) 97 | size += filesize 98 | num_files+=1 99 | except ftplib.error_perm as err: 100 | if verbose > 1: print ('%s: %s' %(fullpath, err)) 101 | fp.close() 102 | os.remove(tempname) 103 | continue 104 | fp.close() 105 | try: 106 | os.unlink(fullname) 107 | except os.error: 108 | pass 109 | try: 110 | os.rename(tempname, fullname) 111 | except os.error: 112 | continue 113 | 114 | for subdir in subdirs: 115 | localsub = os.path.join(destination, subdir) 116 | pwd = host.pwd() 117 | try: 118 | if verbose > 2: print('Changing current directory to: %r' % (pwd+subdir)) 119 | host.cwd(subdir) 120 | except ftplib.error_perm as err: 121 | if verbose > 0: print('%s\n%s' %(subdir, err)) 122 | continue 123 | else: 124 | downloadFTPFiles(localsub, host, regex) 125 | host.cwd('..') 126 | if host.pwd() != pwd: 127 | break 128 | #Delete empty directories 129 | try: os.rmdir(localsub) 130 | except OSError: pass 131 | return num_files 132 | -------------------------------------------------------------------------------- /protocols/sample_proto.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3.3 2 | 3 | 4 | #str port Service port 5 | #str user Username for the service 6 | #str passwd Password 7 | #IPv4Address ip Target IP 8 | #SRE_Pattern regex Compiled RegEx 9 | #str target_path Current working directory: project_name\{IP address} 10 | #Namespace args Optional arguments 11 | 12 | def startProtocol(port, user, passwd, ip, regex, target_path, args): 13 | global mirror, verbose, timeout 14 | mirror = args.search 15 | verbose = args.verbose 16 | timeout = args.timeout 17 | print("Your code here") -------------------------------------------------------------------------------- /protocols/smb_proto.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3.3 2 | # Released as open source by NCC Group Plc - http://www.nccgroup.com/ 3 | # Developed by Nikos Laleas, nikos dot laleas at nccgroup dot com 4 | # https://github.com/nccgroup/xcavator 5 | # Released under AGPL. See LICENSE for more information 6 | 7 | import os 8 | from sys import stdout 9 | from xcavator import convert_bytes 10 | from smb import smb_structs 11 | from smb.SMBConnection import SMBConnection 12 | 13 | 14 | def startProtocol(port, user, passwd, ip, regex, target_path, args): 15 | global mirror, verbose, timeout 16 | mirror = args.search 17 | verbose = args.verbose 18 | timeout = args.timeout 19 | serverName = '*' 20 | conn = [] 21 | direct = True 22 | if port != '445': 23 | serverName = input("SMB over TCP is used by default on port 445.\nIf you prefer NetBIOS instead, you need to provide the NetBIOS name of the remote machine: ") 24 | direct = False 25 | try: 26 | conn = SMBConnection(user, passwd, 'noone', serverName, use_ntlm_v2 = True, is_direct_tcp = direct) 27 | stdout.write("Trying SMB server: %s......" % str(ip)) 28 | stdout.flush() 29 | conn.connect(str(ip), int(port), timeout = timeout) 30 | print("[Connected]") 31 | shares(target_path, conn, regex) 32 | conn.close() 33 | except OSError as err: 34 | print("[No connection]") 35 | if verbose > 0: print(err.message) 36 | conn.close() 37 | pass 38 | 39 | 40 | def makedir(path): 41 | if os.path.isdir(path): 42 | return 43 | os.mkdir(path, 0o777) 44 | 45 | 46 | def shares(targetPath, conn, regex): 47 | global num_files, size 48 | shareList = conn.listShares() 49 | num_files = 0 50 | size = 0 51 | if verbose == 0: print("Downloading files...") 52 | for r in shareList: 53 | if targetPath and not os.path.isdir(os.path.join(targetPath, r.name)): 54 | try: 55 | makedir(os.path.join(targetPath, r.name)) 56 | except os.error as err: 57 | if verbose > 0: print(err) 58 | return 59 | 60 | downloadSMBFiles("\\", os.path.join(targetPath,r.name), conn, regex, r.name) 61 | print('%i files (%s) downloaded. Closing connection...' % (num_files, convert_bytes(size))) 62 | 63 | 64 | def downloadSMBFiles(smbpath, projPath, conn, regex, share): 65 | global num_files, size 66 | cwd = "" 67 | if smbpath[:1] is "\\": cwd = (smbpath[1:]) #trim first \ 68 | cwd = os.path.join(projPath,cwd) 69 | if cwd and not os.path.isdir(cwd): 70 | try: 71 | makedir(cwd) 72 | except os.error as err: 73 | if verbose > 0: print(err) 74 | return 75 | 76 | 77 | subdirs = [] 78 | try: 79 | listing = conn.listPath(share, smbpath) 80 | for l in listing: 81 | filename = l.filename 82 | if l.isDirectory: 83 | if filename is ".": continue 84 | if filename == "..": continue #Using 'is' didn't work 85 | subdirs.append(filename) 86 | continue 87 | else: 88 | relativeRemotePath = os.path.join(smbpath, l.filename) 89 | relativeLocalPath = os.path.join(share, relativeRemotePath[1:]) 90 | tempname = relativeLocalPath+'.tmp' 91 | try: 92 | os.unlink(tempname) 93 | except os.error: 94 | pass 95 | try: 96 | fp = open(tempname, 'wb') 97 | except IOError as err: 98 | if verbose > 0: print ("Can't create %r: %s" % (tempname, err)) 99 | continue 100 | try: 101 | if not mirror: 102 | if verbose > 2: print('Checking file: %r' % relativeRemotePath) 103 | if regex.match(filename): 104 | print('***Found match...***') 105 | if verbose > 0: print("Downloading file: %s.....[%s]" % (relativeRemotePath, convert_bytes(l.file_size))) 106 | file_attributes, filesize = conn.retrieveFile(share, relativeRemotePath, fp) 107 | fp.close() 108 | size += filesize 109 | num_files+=1 110 | else: 111 | if verbose > 2: print('Not matched...') 112 | fp.close() 113 | os.remove(tempname) 114 | else: 115 | if verbose > 1: print("Downloading file: %s.....[%s]" % (relativeRemotePath, convert_bytes(l.file_size))) 116 | try: 117 | file_attributes, filesize = conn.retrieveFile(share, relativeRemotePath, fp) 118 | size += filesize 119 | fp.close() 120 | except smb_structs.OperationFailure as err: 121 | if verbose > 1: print(err.message) 122 | fp.close() 123 | os.remove(tempname) 124 | continue 125 | num_files+=1 126 | except OSError as err: 127 | if verbose > 0: print ('%s: %s' %(relativeRemotePath, err)) 128 | fp.close() 129 | os.remove(tempname) 130 | continue 131 | try: 132 | os.unlink(relativeRemotePath) 133 | except os.error: 134 | pass 135 | try: 136 | os.rename(tempname, relativeLocalPath) 137 | except os.error: 138 | continue 139 | 140 | for subdir in subdirs: 141 | localsub = os.path.join(cwd, subdir) 142 | newdest = smbpath+subdir+"\\" 143 | if verbose > 2: print('Changing current directory to: %s' % (share+newdest)) 144 | downloadSMBFiles(newdest, projPath, conn, regex, share) 145 | 146 | #Delete empty directories 147 | try: os.rmdir(localsub) 148 | except OSError: pass 149 | 150 | return num_files 151 | 152 | except smb_structs.OperationFailure as err: 153 | #print(err) 154 | return 155 | 156 | 157 | -------------------------------------------------------------------------------- /xcavator.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3.3 2 | # Released as open source by NCC Group Plc - http://www.nccgroup.com/ 3 | # Developed by Nikos Laleas, nikos dot laleas at nccgroup dot com 4 | # https://github.com/nccgroup/xcavator 5 | # Released under AGPL. See LICENSE for more information 6 | 7 | import os 8 | import re 9 | import ipaddress 10 | import configparser 11 | import sys 12 | import time 13 | import mmap 14 | import argparse 15 | 16 | 17 | 18 | #Add your own protocols to the list 19 | protocols = ['ftp', 'smb', 'ftps'] 20 | 21 | #Also add the default port 22 | default_port = ['21', '139', '990'] 23 | 24 | num_files = 0 25 | conf = '' 26 | timeout = 0 27 | verbose = 0 28 | mirror = True 29 | 30 | 31 | def main(): 32 | print("+"+58*"-"+"+") 33 | print(" _ _ _ ") 34 | print(" ( ) ( ) ( )_ ") 35 | print(" `\\`\\/'/' ___ _ _ _ _ _ _ | ,_) _ _ __ ") 36 | print(" > < /'___) /'_` )( ) ( ) /'_` )| | /'_`\\ ( '__) ") 37 | print(" /'/\\`\\ ( (___ ( (_| || \\_/ |( (_| || |_ ( (_) )| | ") 38 | print(" (_) (_)`\\____)`\\__,_)`\\___/'`\\__,_)`\\__)`\\___/'(_) ") 39 | print("\n"+"+"+58*"-"+"+"+"\n") 40 | 41 | args = parseArgs() 42 | if os.path.isfile(conf): 43 | print ('Using existing configuration...') 44 | read_conf(args) 45 | else: 46 | print ('Config not found. Creating new...') 47 | create_new_conf(args) 48 | 49 | def parseArgs(): 50 | global conf, timeout, verbose, mirror 51 | parser = argparse.ArgumentParser() 52 | parser.add_argument('-c', '--config', type = str, default = 'xcavator.conf', help = 'Config file (Default: xcavator.conf)') 53 | parser.add_argument('-t', '--timeout', type = float, default = 2, help = 'Timeout in seconds (Default: 2s)') 54 | parser.add_argument('-s', '--search', default = True, action = 'store_false', help = 'Search mode. Searches recursively for filenames matching RegEx instead of downloading everything (Default: downloads everything and scans for strings)') 55 | parser.add_argument('-v', '--verbose', default = 0, action = 'count', help = 'Verbosity level. More "v"s, more detail. (Default: Prints basic info)') 56 | args = parser.parse_args() 57 | conf = args.config 58 | timeout = args.timeout 59 | verbose = args.verbose 60 | mirror = args.search 61 | return args 62 | 63 | def create_new_conf(args): 64 | prot = input('Protocol (e.g. ftp): ') 65 | 66 | while prot.lower() not in protocols: 67 | prot = input('Invalid protocol. Try again: ') 68 | 69 | port = input('Port [' + default_port[protocols.index(prot)] + ']: ') 70 | if port is '': port = default_port[protocols.index(prot)] 71 | user = input('Username [anonymous]: ') 72 | passwd = input('Password [anonymous]: ') 73 | if user is '': 74 | user = 'anonymous' 75 | if passwd is '': passwd = 'anonymous' 76 | ip_range = input('IP range: ') 77 | ip_range_exp = validate_ip_range(ip_range) 78 | while True: 79 | if ip_range_exp: 80 | break 81 | else: 82 | ip_range = input('Try again: ') 83 | ip_range_exp = validate_ip_range(ip_range) 84 | regex = input('Regex: ') 85 | compregex= "" 86 | while True: 87 | try: 88 | compregex = re.compile(regex) 89 | break 90 | except re.error as err: 91 | print('RegEx error: %s' %err) 92 | regex = input('Try again: ') 93 | parser = configparser.ConfigParser() 94 | parser[prot.upper()] = {'PORT': port, 95 | 'User': user, 96 | 'Pass': passwd, 97 | 'Range': ip_range, 98 | 'RegEx': regex} 99 | 100 | with open(conf, 'w') as configfile: 101 | parser.write(configfile) 102 | process_request(prot.lower(), port, user, passwd, ip_range_exp, compregex, args) 103 | 104 | 105 | 106 | def read_conf(args): 107 | parser = configparser.ConfigParser() 108 | parser.read(conf) 109 | sections = parser.sections() 110 | prot = sections[0] 111 | if prot.lower() not in protocols: 112 | print ('Protocol not supported. Edit the configuration or delete it to create a new one.') 113 | sys.exit() 114 | port = parser[prot]['port'] 115 | if port is '': 116 | print ('Port not specified. Using default.') 117 | port = default_port[protocols.index(prot)] 118 | user = parser[prot]['user'] 119 | passwd = parser[prot]['pass'] 120 | if user is '': 121 | user = 'anonymous' 122 | if passwd is '': 123 | passwd = 'anonymous' 124 | ip_range = parser[prot] ['range'] 125 | ip_range = validate_ip_range(ip_range) 126 | if not ip_range: 127 | print ('IP address range not valid. Edit the configuration or delete it to create a new one.') 128 | sys.exit() 129 | regex = parser[prot]['regex'] 130 | try: 131 | regex = re.compile(regex) 132 | except re.error as err: 133 | print('RegEx error: %s' %err) 134 | sys.exit() 135 | process_request(prot.lower(), port, user, passwd, ip_range, regex, args) 136 | 137 | 138 | 139 | def validate_ip_range(iprange): 140 | iprange = iprange.replace(" ","") 141 | iprange = iprange.split(',') 142 | ip_list=[] 143 | 144 | for ip in iprange: 145 | try: 146 | i=ipaddress.ip_address(ip) 147 | if i: 148 | ip_list.append(i) 149 | except ValueError: 150 | try: 151 | i=ipaddress.ip_network(ip) 152 | if i: 153 | for x in i.hosts(): 154 | ip_list.append(x) 155 | except ValueError: 156 | if ip.find('-')==-1: 157 | print('Invalid range or IP address -> ', ip) 158 | return None 159 | else: 160 | temp=ip.split('-') 161 | for t in temp: 162 | try: 163 | ipaddress.ip_address(t) 164 | except ValueError: 165 | print('Invalid syntax -> ', t) 166 | return None 167 | if ipaddress.ip_address(temp[0])>ipaddress.ip_address(temp[1]) : 168 | print('Invalid syntax -> ' + temp[0] + ' is higher than ' + temp[1]) 169 | return None 170 | else: 171 | x=ipaddress.ip_address(temp[0]) 172 | while x <= ipaddress.ip_address(temp[1]): 173 | ip_list.append(x) 174 | x+=1 175 | return ip_list 176 | 177 | 178 | 179 | def process_request(prot, port, user, passwd, ip_range, regex, args): 180 | try: 181 | projPath = 'scan_%4d-%02d-%02d_%02d.%02d.%02d' % time.localtime()[0:6] 182 | print('Creating project directory...: %s' % projPath) 183 | makedir(projPath) 184 | projPath=os.path.join(os.getcwd(), projPath) 185 | prot = prot+'_proto' 186 | temp = __import__('protocols', fromlist = [prot]) 187 | prot = getattr(temp, prot) 188 | for ip in ip_range: 189 | target_path=os.path.join(projPath, str(ip)) 190 | makedir(target_path) 191 | os.chdir(target_path) 192 | prot.startProtocol(port, user, passwd, ip, regex, target_path, args) 193 | #globals()[prot + '_func'](port, user, passwd, ip, regex, projPath) 194 | try: 195 | os.chdir(projPath) 196 | os.rmdir(target_path) 197 | except OSError as err: 198 | pass 199 | if mirror: scanFiles(regex, projPath) 200 | except KeyError: 201 | print ('Method %s not implemented' % prot) 202 | sys.exit() 203 | 204 | 205 | def scanFiles(regex, projPath): 206 | print('Scanning files...') 207 | regex = str.encode(regex.pattern) 208 | for curdir, dirs, files in os.walk(projPath): 209 | for file in files: 210 | try: 211 | filepath = os.path.join(curdir, file) 212 | if verbose > 2: print('Scanning file: %s' % filepath) 213 | size = os.stat(filepath).st_size 214 | f = open(filepath) 215 | data = mmap.mmap(f.fileno(), size, access=mmap.ACCESS_READ) 216 | f.close() 217 | newfile = '' 218 | counter = 1 219 | for m in re.finditer(regex, data): 220 | if newfile is not file: 221 | print('\n'+70*'='+'\nFile: %s' % filepath) 222 | print(70*'=') 223 | newfile = file 224 | print('%d. Match: %s at offset: 0x%0.8x' % (counter ,m.group(0), m.start())) 225 | counter += 1 226 | except ValueError as err: 227 | if verbose > 2: print('Error: %s' % err) 228 | continue 229 | if counter > 1: print(70*'-'+'\n') 230 | print("Done.") 231 | 232 | 233 | def makedir(path): 234 | if os.path.isdir(path): 235 | return 236 | dirname = os.path.dirname(path) 237 | if dirname: makedir(dirname) 238 | os.mkdir(path, 0o777) 239 | 240 | 241 | def convert_bytes(bytes): 242 | bytes = float(bytes) 243 | if bytes >= 1099511627776: 244 | terabytes = bytes / 1099511627776 245 | size = '%.2fTB' % terabytes 246 | elif bytes >= 1073741824: 247 | gigabytes = bytes / 1073741824 248 | size = '%.2fGB' % gigabytes 249 | elif bytes >= 1048576: 250 | megabytes = bytes / 1048576 251 | size = '%.2fMB' % megabytes 252 | elif bytes >= 1024: 253 | kilobytes = bytes / 1024 254 | size = '%.2fKB' % kilobytes 255 | else: 256 | size = '%.2fb' % bytes 257 | return size 258 | 259 | if __name__ == '__main__': 260 | main() 261 | --------------------------------------------------------------------------------