pax_global_header00006660000000000000000000000064144711500670014517gustar00rootroot0000000000000052 comment=7179042d86f3d3f07f8f7c99c78e69d0376389e3 rcon-2.4.4/000077500000000000000000000000001447115006700124675ustar00rootroot00000000000000rcon-2.4.4/.gitignore000066400000000000000000000034161447115006700144630ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ pip-wheel-metadata/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json # Pyre type checker .pyre/ .idea/rcon-2.4.4/.readthedocs.yml000066400000000000000000000000431447115006700155520ustar00rootroot00000000000000version: 2 python: version: 3.8 rcon-2.4.4/Jenkinsfile000066400000000000000000000013201447115006700146470ustar00rootroot00000000000000pipeline { agent any stages { stage('Run pytest') { steps { sh 'pip install --user --upgrade pytest' sh 'pip install --user --upgrade -r requirements.txt' sh 'python -m pytest' } } stage('Run SonarQube') { steps { withSonarQubeEnv(installationName: 'rcon', credentialsId: '4cdfb484-a052-41be-8739-3e1c232b5f38') { sh '/opt/sonar-scanner/bin/sonar-scanner' } } } stage('Send Email') { steps { mail(subject: '[rcon] build successful', body: 'https://jenkins.richard-neumann.de/blue/organizations/jenkins/rcon/activity', from: 'jenkins@richard-neumann.de', to: 'mail@richard-neumann.de') } } } }rcon-2.4.4/LICENSE.txt000066400000000000000000001045131447115006700143160ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. 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. Copyright (C) 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 . 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: Copyright (C) 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 . 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 . rcon-2.4.4/Makefile000066400000000000000000000006731447115006700141350ustar00rootroot00000000000000FILE_LIST = ./.installed_files.txt .PHONY: build clean install publish pull push uninstall build: @ ./setup.py sdist bdist_wheel clean: @ rm -Rf ./build ./dist default: | pull clean install install: @ ./setup.py install --record $(FILE_LIST) publish: @ twine upload dist/* pull: @ git pull push: @ git push pypi: | clean build publish uninstall: @ while read FILE; do echo "Removing: $$FILE"; rm "$$FILE"; done < $(FILE_LIST) rcon-2.4.4/README.md000066400000000000000000000043651447115006700137560ustar00rootroot00000000000000[![Documentation Status](https://readthedocs.org/projects/rcon/badge/?version=latest)](https://rcon.readthedocs.io/en/latest/) # rcon An RCON client implementation. * [Source RCON protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) * [BattlEye RCon protocol](https://www.battleye.com/downloads/BERConProtocol.txt) ## Requirements `rcon` requires Python 3.10 or higher. ## Documentation Documentation is available on [readthedocs](https://rcon.readthedocs.io/en/latest/). ## Installation Install rcon from the [AUR](https://aur.archlinux.org/packages/python-rcon/) or via: pip install rcon ## Quick start The `RCON` protocols are used to remotely control game servers, i.e. execute commands on a game server and receive the respective results. ### Source RCON ```python from rcon.source import Client with Client('127.0.0.1', 5000, passwd='mysecretpassword') as client: response = client.run('some_command', 'with', 'some', 'arguments') print(response) ``` #### Async support If you prefer to use Source RCON in an asynchronous environment, you can use `rcon()`. ```python from rcon.source import rcon response = await rcon( 'some_command', 'with', 'some', 'arguments', host='127.0.0.1', port=5000, passwd='mysecretpassword' ) print(response) ``` ### BattlEye RCon ```python from rcon.battleye import Client with Client('127.0.0.1', 5000, passwd='mysecretpassword') as client: response = client.run('some_command', 'with', 'some', 'arguments') print(response) ``` #### Handling server messages Since the BattlEye RCon server will also send server messages to the client alongside command responses, you can register an event handler to process those messages: ```python from rcon.battleye import Client from rcon.battleye.proto import ServerMessage def my_message_handler(server_message: ServerMessage) -> None: """Print server messages.""" print('Server message:', server_message) with Client( '127.0.0.1', 5000, passwd='mysecretpassword', message_handler=my_message_handler ) as client: response = client.run('some_command', 'with', 'some', 'arguments') print('Response:', response) ``` Have a look at `rcon.battleye.proto.ServerMessage` for details on the respective objects. rcon-2.4.4/docs/000077500000000000000000000000001447115006700134175ustar00rootroot00000000000000rcon-2.4.4/docs/Makefile000066400000000000000000000011761447115006700150640ustar00rootroot00000000000000# Minimal makefile for Sphinx documentation # # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) rcon-2.4.4/docs/make.bat000066400000000000000000000014441447115006700150270ustar00rootroot00000000000000@ECHO OFF pushd %~dp0 REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set SOURCEDIR=source set BUILDDIR=build %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.https://www.sphinx-doc.org/ exit /b 1 ) if "%1" == "" goto help %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end :help %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% :end popd rcon-2.4.4/docs/source/000077500000000000000000000000001447115006700147175ustar00rootroot00000000000000rcon-2.4.4/docs/source/bugs.rst000066400000000000000000000003011447115006700164030ustar00rootroot00000000000000Reporting bugs ============== If you found a bug or want to suggest a new feature to be added top `rcon`, please open an appropriate issue on `GitHub `_. rcon-2.4.4/docs/source/conf.py000066400000000000000000000016651447115006700162260ustar00rootroot00000000000000# Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "rcon" copyright = "2022, Richard Neumann" author = "Richard Neumann" release = "2.3.8" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = ["sphinx.ext.autodoc"] templates_path = ["_templates"] exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "alabaster" html_static_path = ["_static"] rcon-2.4.4/docs/source/index.rst000066400000000000000000000007111447115006700165570ustar00rootroot00000000000000rcon - An RCON client library ============================= `rcon` is a Python 3 library, which provides a client to interact with RCON servers. It therefor implements the `RCON `_ protocol. .. toctree:: :maxdepth: 2 :caption: Contents: installation usage modules bugs license Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` rcon-2.4.4/docs/source/installation.rst000066400000000000000000000005011447115006700201460ustar00rootroot00000000000000Installation ============ If you use `Arch Linux` or one of its derivatives, you can install `rcon` from the `AUR `_. Otherwise you can install `rcon` via pip: .. code-block:: bash pip install rcon Requirements ============ `rcon` requires Python 3.8 or higher. rcon-2.4.4/docs/source/license.rst000066400000000000000000001052451447115006700171020ustar00rootroot00000000000000License ======= GNU GENERAL PUBLIC LICENSE -------------------------- Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. 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. Copyright (C) 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 . 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: Copyright (C) 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 . 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 . rcon-2.4.4/docs/source/modules.rst000066400000000000000000000000611447115006700171160ustar00rootroot00000000000000rcon ==== .. toctree:: :maxdepth: 4 rcon rcon-2.4.4/docs/source/rcon.battleye.rst000066400000000000000000000007401447115006700202230ustar00rootroot00000000000000rcon.battleye package ===================== Submodules ---------- rcon.battleye.client module --------------------------- .. automodule:: rcon.battleye.client :members: :undoc-members: :show-inheritance: rcon.battleye.proto module -------------------------- .. automodule:: rcon.battleye.proto :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: rcon.battleye :members: :undoc-members: :show-inheritance: rcon-2.4.4/docs/source/rcon.rst000066400000000000000000000025521447115006700164160ustar00rootroot00000000000000rcon package ============ Subpackages ----------- .. toctree:: :maxdepth: 4 rcon.battleye rcon.source Submodules ---------- rcon.client module ------------------ .. automodule:: rcon.client :members: :undoc-members: :show-inheritance: rcon.config module ------------------ .. automodule:: rcon.config :members: :undoc-members: :show-inheritance: rcon.console module ------------------- .. automodule:: rcon.console :members: :undoc-members: :show-inheritance: rcon.errorhandler module ------------------------ .. automodule:: rcon.errorhandler :members: :undoc-members: :show-inheritance: rcon.exceptions module ---------------------- .. automodule:: rcon.exceptions :members: :undoc-members: :show-inheritance: rcon.gui module --------------- .. automodule:: rcon.gui :members: :undoc-members: :show-inheritance: rcon.rconclt module ------------------- .. automodule:: rcon.rconclt :members: :undoc-members: :show-inheritance: rcon.rconshell module --------------------- .. automodule:: rcon.rconshell :members: :undoc-members: :show-inheritance: rcon.readline module -------------------- .. automodule:: rcon.readline :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: rcon :members: :undoc-members: :show-inheritance: rcon-2.4.4/docs/source/rcon.source.rst000066400000000000000000000011531447115006700177110ustar00rootroot00000000000000rcon.source package =================== Submodules ---------- rcon.source.async\_rcon module ------------------------------ .. automodule:: rcon.source.async_rcon :members: :undoc-members: :show-inheritance: rcon.source.client module ------------------------- .. automodule:: rcon.source.client :members: :undoc-members: :show-inheritance: rcon.source.proto module ------------------------ .. automodule:: rcon.source.proto :members: :undoc-members: :show-inheritance: Module contents --------------- .. automodule:: rcon.source :members: :undoc-members: :show-inheritance: rcon-2.4.4/docs/source/usage.rst000066400000000000000000000053141447115006700165600ustar00rootroot00000000000000Usage ===== Source RCON ----------- To connect to a server using the Source RCON protocol, use :py:class:`rcon.source.Client`. .. code-block:: python from rcon.source import Client with Client('127.0.0.1', 5000, passwd='mysecretpassword') as client: response = client.run('some_command', 'with', 'some', 'arguments') print(response) BattlEye RCon ------------- To connecto to a server using the BattlEye RCon protocol, use :py:class:`rcon.battleye.Client`. .. code-block:: python from rcon.battleye import Client with Client('127.0.0.1', 5000, passwd='mysecretpassword') as client: response = client.run('some_command', 'with', 'some', 'arguments') print(response) Handling server messages ~~~~~~~~~~~~~~~~~~~~~~~~ Since the BattlEye RCon server will also send server messages to the client alongside command responses, you can register an event handler to process those messages: .. code-block:: python from rcon.battleye import Client, ServerMessage def my_message_handler(server_message: ServerMessage) -> None: """Print server messages.""" print('Server message:', server_message) with Client( '127.0.0.1', 5000, passwd='mysecretpassword', message_handler=my_message_handler ) as client: response = client.run('some_command', 'with', 'some', 'arguments') print('Response:', response) Configuration ------------- `rconclt` servers can be configured in :file:`/etc/rcon.conf`. The configuration file format is: .. code-block:: ini [] host = port = passwd = The :code:`passwd` entry is optional. rconclt ------- `rconclt` is an RCON client script to communicate with game servers via the RCON protocol using the shell. To communicate with a server, run: .. code-block:: bash rconclt [options] [...] rconshell --------- `rconshell` is an interactive RCON console to interact with game servers via the RCON protocol. To start a shell, run: .. code-block:: bash rconshell [server] [options] Handling connection timeouts. ----------------------------- You can specify an optional :code:`timeout=` parameter to allow a connection attempt to time out. If a timeout is reached during a connection attempt, it will raise a `socket.timeout `_ exception. The following example will raise a connection timeout after 1.5 seconds: .. code-block:: python try: with Client('127.0.0.1', 5000, timeout=1.5) as client: except socket.timeout as timeout: .. _configuration: rcon-2.4.4/rcon/000077500000000000000000000000001447115006700134305ustar00rootroot00000000000000rcon-2.4.4/rcon/__init__.py000066400000000000000000000017061447115006700155450ustar00rootroot00000000000000"""RCON client library.""" from typing import Any, Coroutine from warnings import warn from rcon.exceptions import EmptyResponse, SessionTimeout, WrongPassword from rcon.source import rcon as _rcon from rcon.source import Client as _Client __all__ = ["EmptyResponse", "SessionTimeout", "WrongPassword", "Client", "rcon"] class Client(_Client): """Wrapper for the rcon.source.Client for backwards compatibility.""" def __init__(self, *args, **kwargs): warn( "rcon.Client() is deprecated. Use rcon.source.Client() instead.", DeprecationWarning, stacklevel=2, ) super().__init__(*args, **kwargs) def rcon(*args, **kwargs) -> Coroutine[Any, Any, str]: """Wrapper for rcon.source.rcon() for backwards compatibility.""" warn( "rcon.rcon() is deprecated. Use rcon.source.rcon() instead.", DeprecationWarning, stacklevel=2, ) return _rcon(*args, **kwargs) rcon-2.4.4/rcon/battleye/000077500000000000000000000000001447115006700152415ustar00rootroot00000000000000rcon-2.4.4/rcon/battleye/__init__.py000066400000000000000000000002431447115006700173510ustar00rootroot00000000000000"""BattlEye RCON implementation.""" from rcon.battleye.client import Client from rcon.battleye.proto import ServerMessage __all__ = ["Client", "ServerMessage"] rcon-2.4.4/rcon/battleye/client.py000066400000000000000000000070371447115006700171000ustar00rootroot00000000000000"""BattlEye RCon client.""" from collections import defaultdict from logging import getLogger from socket import SOCK_DGRAM from typing import Callable from rcon.battleye.proto import HEADER_SIZE from rcon.battleye.proto import RESPONSE_TYPES from rcon.battleye.proto import CommandRequest from rcon.battleye.proto import CommandResponse from rcon.battleye.proto import Header from rcon.battleye.proto import LoginRequest from rcon.battleye.proto import LoginResponse from rcon.battleye.proto import Request from rcon.battleye.proto import Response from rcon.battleye.proto import ServerMessage from rcon.battleye.proto import ServerMessageAck from rcon.client import BaseClient from rcon.exceptions import WrongPassword __all__ = ["Client"] MessageHandler = Callable[[ServerMessage], None] def log_message(server_message: ServerMessage) -> None: """Default handler, logging the server message.""" getLogger("Server message").info(server_message.message) class Client(BaseClient, socket_type=SOCK_DGRAM): """BattlEye RCon client.""" def __init__( self, *args, max_length: int = 4096, message_handler: MessageHandler = log_message, **kwargs, ): super().__init__(*args, **kwargs) self.max_length = max_length self.message_handler = message_handler def handle_server_message(self, message: ServerMessage) -> None: """Handle the respective server message.""" with self._socket.makefile("wb") as file: file.write(bytes(ServerMessageAck(message.seq))) self.message_handler(message) def receive(self) -> Response: """Receive a packet.""" return RESPONSE_TYPES[ ( header := Header.from_bytes( (data := self._socket.recv(self.max_length))[:HEADER_SIZE] ) ).type ].from_bytes(header, data[HEADER_SIZE:]) def communicate(self, request: Request) -> Response | str: """Send a request and receive a response.""" acknowledged = defaultdict(set) command_responses = [] first = False with self._socket.makefile("wb") as file: file.write(bytes(request)) while True: try: response = self.receive() except TimeoutError: if first: raise else: break first = False if isinstance(response, LoginResponse): return response seq = response.seq if isinstance(response, CommandResponse): # Collect fragmented command responses with the same seq command_responses.append(response) else: if seq in acknowledged[response_type := type(response)]: break else: acknowledged[response_type].add(seq) if isinstance(response, ServerMessage): self.handle_server_message(response) return "".join( command_response.message for command_response in sorted(command_responses, key=lambda cr: cr.seq) ) def login(self, passwd: str) -> bool: """Log-in the user.""" if not self.communicate(LoginRequest(passwd)).success: raise WrongPassword() return True def run(self, command: str, *args: str) -> str: """Execute a command and return the text message.""" return self.communicate(CommandRequest.from_command(command, *args)) rcon-2.4.4/rcon/battleye/proto.py000066400000000000000000000112521447115006700167570ustar00rootroot00000000000000"""Low-level protocol stuff.""" from __future__ import annotations from typing import NamedTuple from zlib import crc32 __all__ = [ "HEADER_SIZE", "RESPONSE_TYPES", "Header", "LoginRequest", "LoginResponse", "CommandRequest", "CommandResponse", "ServerMessage", "ServerMessageAck", "Request", "Response", ] HEADER_SIZE = 8 PREFIX = "BE" INFIX = 0xFF class Header(NamedTuple): """Packet header.""" crc32: int type: int def __bytes__(self): return b"".join( ( PREFIX.encode("ascii"), self.crc32.to_bytes(4, "little"), INFIX.to_bytes(1, "little"), self.type.to_bytes(1, "little"), ) ) @classmethod def create(cls, typ: int, payload: bytes) -> Header: """Create a header for the given payload.""" return cls( crc32( b"".join( (INFIX.to_bytes(1, "little"), typ.to_bytes(1, "little"), payload) ) ), typ, ) @classmethod def from_bytes(cls, payload: bytes) -> Header: """Create a header from the given bytes.""" if (size := len(payload)) != HEADER_SIZE: raise ValueError("Invalid payload size", size) if (prefix := payload[:2].decode("ascii")) != PREFIX: raise ValueError("Invalid prefix", prefix) if (infix := int.from_bytes(payload[6:7], "little")) != INFIX: raise ValueError("Invalid infix", infix) return cls( int.from_bytes(payload[2:6], "little"), int.from_bytes(payload[7:8], "little"), ) class LoginRequest(str): """Login request packet.""" def __bytes__(self): return bytes(self.header) + self.payload @property def payload(self) -> bytes: """Return the payload.""" return self.encode("ascii") @property def header(self) -> Header: """Return the appropriate header.""" return Header.create(0x00, self.payload) class LoginResponse(NamedTuple): """A login response.""" header: Header success: bool @classmethod def from_bytes(cls, header: Header, payload: bytes) -> LoginResponse: """Create a login response from the given bytes.""" return cls(header, bool(int.from_bytes(payload[:1], "little"))) class CommandRequest(NamedTuple): """Command packet.""" seq: int command: str def __bytes__(self): return bytes(self.header) + self.payload @property def payload(self) -> bytes: """Return the payload.""" return b"".join((self.seq.to_bytes(1, "little"), self.command.encode("ascii"))) @property def header(self) -> Header: """Return the appropriate header.""" return Header.create(0x01, self.payload) @classmethod def from_string(cls, command: str) -> CommandRequest: """Create a command packet from the given string.""" return cls(0x00, command) @classmethod def from_command(cls, command: str, *args: str) -> CommandRequest: """Create a command packet from the command and arguments.""" return cls.from_string(" ".join([command, *args])) class CommandResponse(NamedTuple): """A command response.""" header: Header seq: int payload: bytes @classmethod def from_bytes(cls, header: Header, payload: bytes) -> CommandResponse: """Create a command response from the given bytes.""" return cls(header, int.from_bytes(payload[:1], "little"), payload[1:]) @property def message(self) -> str: """Return the text message.""" return self.payload.decode("ascii") class ServerMessage(NamedTuple): """A message from the server.""" header: Header seq: int payload: bytes @classmethod def from_bytes(cls, header: Header, payload: bytes) -> ServerMessage: """Create a server message from the given bytes.""" return cls(header, int.from_bytes(payload[:1], "little"), payload[1:]) @property def message(self) -> str: """Return the text message.""" return self.payload.decode("ascii") class ServerMessageAck(NamedTuple): """An acknowledgement of a message from the server.""" seq: int def __bytes__(self): return (0x02).to_bytes(1, "little") + self.payload @property def payload(self) -> bytes: """Return the payload.""" return self.seq.to_bytes(1, "little") Request = LoginRequest | CommandRequest | ServerMessageAck Response = LoginResponse | CommandResponse | ServerMessage RESPONSE_TYPES = {0x00: LoginResponse, 0x01: CommandResponse, 0x02: ServerMessage} rcon-2.4.4/rcon/client.py000066400000000000000000000035501447115006700152630ustar00rootroot00000000000000"""Common base client.""" from socket import SocketKind, socket __all__ = ["BaseClient"] class BaseClient: """A common RCON client.""" def __init__( self, host: str, port: int, *, timeout: float | None = None, passwd: str | None = None ): """Initialize the base client.""" self._socket = socket(type=self._socket_type) self.host = host self.port = port self.timeout = timeout self.passwd = passwd def __init_subclass__(cls, *, socket_type: SocketKind | None = None): if socket_type is not None: cls._socket_type = socket_type def __enter__(self): """Attempt an auto-login if a password is set.""" self._socket.__enter__() self.connect(login=True) return self def __exit__(self, typ, value, traceback): """Delegate to the underlying socket's exit method.""" return self._socket.__exit__(typ, value, traceback) @property def timeout(self) -> float: """Return the socket timeout.""" return self._socket.gettimeout() @timeout.setter def timeout(self, timeout: float): """Set the socket timeout.""" self._socket.settimeout(timeout) def connect(self, login: bool = False) -> None: """Connect the socket and attempt a login if wanted and a password is set. """ self._socket.connect((self.host, self.port)) if login and self.passwd is not None: self.login(self.passwd) def close(self) -> None: """Close the socket connection.""" self._socket.close() def login(self, passwd: str) -> bool: """Perform a login.""" raise NotImplementedError() def run(self, command: str, *args: str) -> str: """Run a command.""" raise NotImplementedError() rcon-2.4.4/rcon/config.py000066400000000000000000000055161447115006700152560ustar00rootroot00000000000000"""RCON server configuration.""" from __future__ import annotations from argparse import Namespace from configparser import ConfigParser, SectionProxy from getpass import getpass from logging import getLogger from os import getenv, name from pathlib import Path from typing import Iterable, NamedTuple from rcon.exceptions import ConfigReadError, UserAbort __all__ = ["CONFIG_FILES", "LOG_FORMAT", "SERVERS", "Config", "from_args"] CONFIG = ConfigParser() if name == "posix": CONFIG_FILES = ( Path("/etc/rcon.conf"), Path("/usr/local/etc/rcon.conf"), Path.home().joinpath(".rcon.conf"), ) elif name == "nt": CONFIG_FILES = ( Path(getenv("LOCALAPPDATA")).joinpath("rcon.conf"), Path.home().joinpath(".rcon.conf"), ) else: raise NotImplementedError(f"Unsupported operating system: {name}") LOG_FORMAT = "[%(levelname)s] %(name)s: %(message)s" LOGGER = getLogger("RCON Config") SERVERS = {} class Config(NamedTuple): """Represents server configuration.""" host: str port: int passwd: str | None = None @classmethod def from_string(cls, string: str) -> Config: """Read the credentials from the given string.""" try: host, port = string.rsplit(":", maxsplit=1) except ValueError: raise ValueError(f"Invalid socket: {string}.") from None port = int(port) try: passwd, host = host.rsplit("@", maxsplit=1) except ValueError: passwd = None return cls(host, port, passwd) @classmethod def from_config_section(cls, section: SectionProxy) -> Config: """Create a credentials tuple from the respective config section. """ host = section["host"] port = section.getint("port") passwd = section.get("passwd") return cls(host, port, passwd) def load(config_files: Path | Iterable[Path] = CONFIG_FILES) -> None: """Read the configuration files and populates SERVERS.""" SERVERS.clear() CONFIG.read(config_files) for section in CONFIG.sections(): SERVERS[section] = Config.from_config_section(CONFIG[section]) def from_args(args: Namespace) -> Config: """Get the credentials for a server from the respective arguments.""" try: host, port, passwd = Config.from_string(args.server) except ValueError: load(args.config) try: host, port, passwd = SERVERS[args.server] except KeyError: LOGGER.error("No such server: %s.", args.server) raise ConfigReadError() from None if passwd is None: try: passwd = getpass("Password: ") except (KeyboardInterrupt, EOFError): print() LOGGER.error("Aborted by user.") raise UserAbort() from None return Config(host, port, passwd) rcon-2.4.4/rcon/console.py000066400000000000000000000065341447115006700154540ustar00rootroot00000000000000"""An interactive console.""" from getpass import getpass from typing import Type from rcon.client import BaseClient from rcon.config import Config from rcon.exceptions import EmptyResponse, SessionTimeout, WrongPassword __all__ = ["PROMPT", "rconcmd"] EXIT_COMMANDS = {"exit", "quit"} MSG_LOGIN_ABORTED = "\nLogin aborted. Bye." MSG_EXIT = "\nBye." MSG_SERVER_GONE = "Server has gone away." MSG_SESSION_TIMEOUT = "Session timed out. Please login again." PROMPT = "RCON {host}:{port}> " VALID_PORTS = range(0, 65536) def read_host() -> str: """Read the host.""" while True: try: return input("Host: ") except KeyboardInterrupt: print() continue def read_port() -> int: """Read the port.""" while True: try: port = input("Port: ") except KeyboardInterrupt: print() continue try: port = int(port) except ValueError: print(f"Invalid integer: {port}") continue if port in VALID_PORTS: return port print(f"Invalid port: {port}") def read_passwd() -> str: """Read the password.""" while True: try: return getpass("Password: ") except KeyboardInterrupt: print() def get_config(host: str, port: int, passwd: str) -> Config: """Read the necessary arguments.""" if host is None: host = read_host() if port is None: port = read_port() if passwd is None: passwd = read_passwd() return Config(host, port, passwd) def login(client: BaseClient, passwd: str) -> str: """Perform a login.""" while True: try: client.login(passwd) except WrongPassword: print("Wrong password.") passwd = read_passwd() continue return passwd def process_input(client: BaseClient, passwd: str, prompt: str) -> bool: """Process the CLI input.""" try: command = input(prompt) except KeyboardInterrupt: print() return True except EOFError: print(MSG_EXIT) return False try: command, *args = command.split() except ValueError: return True if command in EXIT_COMMANDS: return False try: result = client.run(command, *args) except EmptyResponse: print(MSG_SERVER_GONE) return False except SessionTimeout: print(MSG_SESSION_TIMEOUT) try: login(client, passwd) except EOFError: print(MSG_LOGIN_ABORTED) return False return True if result: print(result) return True def rconcmd( client_cls: Type[BaseClient], host: str, port: int, passwd: str, *, timeout: float | None = None, prompt: str = PROMPT, ): """Initialize the console.""" try: host, port, passwd = get_config(host, port, passwd) except EOFError: print(MSG_EXIT) return prompt = prompt.format(host=host, port=port) with client_cls(host, port, timeout=timeout) as client: try: passwd = login(client, passwd) except EOFError: print(MSG_LOGIN_ABORTED) return while True: if not process_input(client, passwd, prompt): break rcon-2.4.4/rcon/errorhandler.py000066400000000000000000000023611447115006700164730ustar00rootroot00000000000000"""Common errors handler.""" from logging import Logger from socket import timeout from rcon.exceptions import ConfigReadError from rcon.exceptions import SessionTimeout from rcon.exceptions import UserAbort from rcon.exceptions import WrongPassword __all__ = ["ErrorHandler"] ERRORS = { UserAbort: (1, None), ConfigReadError: (2, None), ConnectionRefusedError: (3, "Connection refused."), (TimeoutError, timeout): (4, "Connection timed out."), WrongPassword: (5, "Wrong password."), SessionTimeout: (6, "Session timed out."), } class ErrorHandler: """Handles common errors and exits.""" __slots__ = ("logger", "exit_code") def __init__(self, logger: Logger): """Set the logger.""" self.logger = logger self.exit_code = 0 def __enter__(self): return self def __exit__(self, _, value: Exception, __): """Check for common errors and exit respectively.""" if value is None: return True for typ, (exit_code, message) in ERRORS.items(): if isinstance(value, typ): self.exit_code = exit_code if message: self.logger.error(message) return True return None rcon-2.4.4/rcon/exceptions.py000066400000000000000000000011151447115006700161610ustar00rootroot00000000000000"""Common exceptions.""" __all__ = [ "ConfigReadError", "EmptyResponse", "SessionTimeout", "UserAbort", "WrongPassword", ] class ConfigReadError(Exception): """Indicates an error while reading the configuration.""" class EmptyResponse(Exception): """Indicates an empty response from the server.""" class SessionTimeout(Exception): """Indicates that the session timed out.""" class UserAbort(Exception): """Indicates that a required action has been aborted by the user.""" class WrongPassword(Exception): """Indicates a wrong password.""" rcon-2.4.4/rcon/gui.py000066400000000000000000000161421447115006700145720ustar00rootroot00000000000000"""GTK based GUI.""" from argparse import ArgumentParser, Namespace from json import dump, load from logging import DEBUG, INFO, basicConfig, getLogger from os import getenv, name from pathlib import Path from socket import gaierror, timeout from typing import Iterable, NamedTuple, Type from gi import require_version require_version("Gtk", "3.0") from gi.repository import Gtk from rcon import battleye, source from rcon.client import BaseClient from rcon.config import LOG_FORMAT from rcon.exceptions import SessionTimeout, WrongPassword __all__ = ["main"] if name == "posix": CACHE_DIR = Path.home().joinpath(".cache") elif name == "nt": CACHE_DIR = Path(getenv("TEMP") or getenv("TMP")) else: raise NotImplementedError("Unsupported operating system.") CACHE_FILE = CACHE_DIR.joinpath("rcongui.json") LOGGER = getLogger("rcongui") def get_args() -> Namespace: """Parse and return the command line arguments.""" parser = ArgumentParser(description="A minimalistic, GTK-based RCON GUI.") parser.add_argument( "-B", "--battleye", action="store_true", help="use BattlEye RCon instead of Source RCON", ) parser.add_argument( "-d", "--debug", action="store_true", help="print additional debug information" ) parser.add_argument( "-t", "--timeout", type=float, metavar="seconds", help="connection timeout in seconds", ) return parser.parse_args() class RCONParams(NamedTuple): """Represent the RCON parameters.""" host: str port: int passwd: str command: Iterable[str] class GUI(Gtk.Window): """A GTK based GUI for RCON.""" def __init__(self, args: Namespace): """Initialize the GUI.""" super().__init__(title="RCON GUI") self.args = args self.set_position(Gtk.WindowPosition.CENTER) self.grid = Gtk.Grid() self.add(self.grid) self.host = Gtk.Entry() self.host.set_placeholder_text("Host") self.grid.attach(self.host, 0, 0, 1, 1) self.port = Gtk.SpinButton.new_with_range(0, 65535, 1) self.port.set_placeholder_text("Port") self.grid.attach(self.port, 1, 0, 1, 1) self.passwd = Gtk.Entry() self.passwd.set_placeholder_text("Password") self.passwd.set_visibility(False) self.grid.attach(self.passwd, 2, 0, 1, 1) self.command = Gtk.Entry() self.command.set_placeholder_text("Command") self.grid.attach(self.command, 0, 1, 2, 1) self.button = Gtk.Button(label="Run") self.button.connect("clicked", self.on_button_clicked) self.grid.attach(self.button, 2, 1, 1, 1) self.result = Gtk.TextView() self.result.set_wrap_mode(Gtk.WrapMode.WORD) self.result.set_property("editable", False) self.grid.attach(self.result, 0, 2, 2, 1) self.savepw = Gtk.CheckButton(label="Save password") self.grid.attach(self.savepw, 2, 2, 1, 1) self.load_gui_settings() @property def client_cls(self) -> Type[BaseClient]: """Return the client class.""" return battleye.Client if self.args.battleye else source.Client @property def result_text(self) -> str: """Return the result text.""" if (buf := self.result.get_buffer()) is not None: return buf.get_text( buf.get_iter_at_line(0), buf.get_iter_at_line(buf.get_line_count()), True, ) return "" @result_text.setter def result_text(self, text: str): """Set the result text.""" if (buf := self.result.get_buffer()) is not None: buf.set_text(text) @property def gui_settings(self) -> dict: """Return the GUI settings as a dict.""" json = { "host": self.host.get_text(), "port": self.port.get_value_as_int(), "command": self.command.get_text(), "result": self.result_text, "savepw": (savepw := self.savepw.get_active()), } if savepw: json["passwd"] = self.passwd.get_text() return json @gui_settings.setter def gui_settings(self, json: dict): """Set the GUI settings.""" self.host.set_text(json.get("host", "")) self.port.set_value(json.get("port", 0)) self.passwd.set_text(json.get("passwd", "")) self.command.set_text(json.get("command", "")) self.result_text = json.get("result", "") self.savepw.set_active(json.get("savepw", False)) def load_gui_settings(self) -> None: """Load the GUI settings from the cache file.""" try: with CACHE_FILE.open("rb") as cache: self.gui_settings = load(cache) except FileNotFoundError: LOGGER.warning("Cache file not found: %s", CACHE_FILE) except PermissionError: LOGGER.error("Insufficient permissions to read: %s", CACHE_FILE) except ValueError: LOGGER.error("Cache file contains garbage: %s", CACHE_FILE) def save_gui_settings(self): """Save the GUI settings to the cache file.""" try: with CACHE_FILE.open("w", encoding="utf-8") as cache: dump(self.gui_settings, cache, indent=2) except PermissionError: LOGGER.error("Insufficient permissions to read: %s", CACHE_FILE) def show_error(self, message: str): """Show an error message.""" message_dialog = Gtk.MessageDialog( transient_for=self, message_type=Gtk.MessageType.ERROR, buttons=Gtk.ButtonsType.OK, text=message, ) message_dialog.run() message_dialog.destroy() def run_rcon(self) -> str: """Return the current RCON settings.""" with self.client_cls( self.host.get_text().strip(), self.port.get_value_as_int(), timeout=self.args.timeout, passwd=self.passwd.get_text(), ) as client: return client.run(*self.command.get_text().strip().split()) def on_button_clicked(self, _): """Run the client.""" try: result = self.run_rcon() except ValueError as error: self.show_error(str(error)) except gaierror as error: self.show_error(error.strerror) except ConnectionRefusedError: self.show_error("Connection refused.") except (TimeoutError, timeout): self.show_error("Connection timed out.") except WrongPassword: self.show_error("Wrong password.") except SessionTimeout: self.show_error("Session timed out.") else: self.result_text = result def terminate(self, *args, **kwargs): """Save the settings and terminates the application.""" self.save_gui_settings() Gtk.main_quit(*args, **kwargs) def main() -> None: """Start the GUI.""" args = get_args() basicConfig(format=LOG_FORMAT, level=DEBUG if args.debug else INFO) win = GUI(args) win.connect("destroy", win.terminate) win.show_all() Gtk.main() rcon-2.4.4/rcon/rconclt.py000066400000000000000000000037201447115006700154500ustar00rootroot00000000000000"""RCON client CLI.""" from argparse import ArgumentParser, Namespace from logging import DEBUG, INFO, basicConfig, getLogger from pathlib import Path from rcon import battleye, source from rcon.config import CONFIG_FILES, LOG_FORMAT, from_args from rcon.errorhandler import ErrorHandler __all__ = ["main"] LOGGER = getLogger("rconclt") def get_args() -> Namespace: """Parse and return the command line arguments.""" parser = ArgumentParser(description="A Minecraft RCON client.") parser.add_argument("server", help="the server to connect to") parser.add_argument( "-B", "--battleye", action="store_true", help="use BattlEye RCon instead of Source RCON", ) parser.add_argument( "-c", "--config", type=Path, metavar="file", default=CONFIG_FILES, help="the configuration file", ) parser.add_argument( "-d", "--debug", action="store_true", help="print additional debug information" ) parser.add_argument( "-t", "--timeout", type=float, metavar="seconds", help="connection timeout in seconds", ) parser.add_argument("command", help="command to execute on the server") parser.add_argument( "argument", nargs="*", default=(), help="arguments for the command" ) return parser.parse_args() def run() -> None: """Run the RCON client.""" args = get_args() basicConfig(format=LOG_FORMAT, level=DEBUG if args.debug else INFO) host, port, passwd = from_args(args) client_cls = battleye.Client if args.battleye else source.Client with client_cls(host, port, timeout=args.timeout) as client: client.login(passwd) if text := client.run(args.command, *args.argument): print(text, flush=True) def main() -> int: """Run the main script with exceptions handled.""" with ErrorHandler(LOGGER) as handler: run() return handler.exit_code rcon-2.4.4/rcon/rconshell.py000066400000000000000000000035701447115006700160000ustar00rootroot00000000000000"""An interactive RCON shell.""" from argparse import ArgumentParser, Namespace from logging import INFO, basicConfig, getLogger from pathlib import Path from rcon import battleye, source from rcon.readline import CommandHistory from rcon.config import CONFIG_FILES, LOG_FORMAT, from_args from rcon.console import PROMPT, rconcmd from rcon.errorhandler import ErrorHandler __all__ = ["get_args", "main"] LOGGER = getLogger("rconshell") def get_args() -> Namespace: """Parse and returns the CLI arguments.""" parser = ArgumentParser(description="An interactive RCON shell.") parser.add_argument("server", nargs="?", help="the server to connect to") parser.add_argument( "-B", "--battleye", action="store_true", help="use BattlEye RCon instead of Source RCON", ) parser.add_argument( "-c", "--config", type=Path, metavar="file", default=CONFIG_FILES, help="the configuration file", ) parser.add_argument( "-p", "--prompt", default=PROMPT, metavar="PS1", help="the shell prompt" ) parser.add_argument( "-t", "--timeout", type=float, metavar="seconds", help="connection timeout in seconds", ) return parser.parse_args() def run() -> None: """Run the RCON shell.""" args = get_args() basicConfig(level=INFO, format=LOG_FORMAT) client_cls = battleye.Client if args.battleye else source.Client if args.server: host, port, passwd = from_args(args) else: host = port = passwd = None with CommandHistory(LOGGER): rconcmd( client_cls, host, port, passwd, timeout=args.timeout, prompt=args.prompt ) def main() -> int: """Run the main script with exceptions handled.""" with ErrorHandler(LOGGER) as handler: run() return handler.exit_code rcon-2.4.4/rcon/readline.py000066400000000000000000000022141447115006700155640ustar00rootroot00000000000000"""Wrapper for readline support.""" from logging import Logger from pathlib import Path try: from readline import read_history_file, write_history_file except ModuleNotFoundError: read_history_file = write_history_file = lambda _: None __all__ = ["CommandHistory"] HIST_FILE = Path.home() / ".rconshell_history" class CommandHistory: """Context manager for the command line history.""" def __init__(self, logger: Logger, file: Path = HIST_FILE): """Set the logger to use.""" self.logger = logger self.file = file def __enter__(self): """Load the history file.""" try: read_history_file(self.file) except FileNotFoundError: self.logger.warning("Could not find history file: %s", self.file) except PermissionError: self.logger.error("Insufficient permissions to read: %s", self.file) return self def __exit__(self, *_): """Write to the history file.""" try: write_history_file(self.file) except PermissionError: self.logger.error("Insufficient permissions to write: %s", self.file) rcon-2.4.4/rcon/source/000077500000000000000000000000001447115006700147305ustar00rootroot00000000000000rcon-2.4.4/rcon/source/__init__.py000066400000000000000000000002201447115006700170330ustar00rootroot00000000000000"""Source RCON implementation.""" from rcon.source.async_rcon import rcon from rcon.source.client import Client __all__ = ["Client", "rcon"] rcon-2.4.4/rcon/source/async_rcon.py000066400000000000000000000037741447115006700174530ustar00rootroot00000000000000"""Asynchronous RCON.""" from asyncio import StreamReader, StreamWriter, open_connection from rcon.exceptions import SessionTimeout, WrongPassword from rcon.source.proto import Packet, Type __all__ = ["rcon"] async def close(writer: StreamWriter) -> None: """Close socket asynchronously.""" writer.close() await writer.wait_closed() async def communicate( reader: StreamReader, writer: StreamWriter, packet: Packet, *, frag_threshold: int = 4096, frag_detect_cmd: str = "", ) -> Packet: """Make an asynchronous request.""" writer.write(bytes(packet)) await writer.drain() response = await Packet.aread(reader) if len(response.payload) < frag_threshold: return response writer.write(bytes(Packet.make_command(frag_detect_cmd))) await writer.drain() while (successor := await Packet.aread(reader)).id == response.id: response += successor return response async def rcon( command: str, *arguments: str, host: str, port: int, passwd: str, encoding: str = "utf-8", frag_threshold: int = 4096, frag_detect_cmd: str = "", ) -> str: """Run a command asynchronously.""" reader, writer = await open_connection(host, port) response = await communicate( reader, writer, Packet.make_login(passwd, encoding=encoding), frag_threshold=frag_threshold, frag_detect_cmd=frag_detect_cmd, ) # Wait for SERVERDATA_AUTH_RESPONSE according to: # https://developer.valvesoftware.com/wiki/Source_RCON_Protocol while response.type != Type.SERVERDATA_AUTH_RESPONSE: response = await Packet.aread(reader) if response.id == -1: await close(writer) raise WrongPassword() request = Packet.make_command(command, *arguments, encoding=encoding) response = await communicate(reader, writer, request) await close(writer) if response.id != request.id: raise SessionTimeout() return response.payload.decode(encoding) rcon-2.4.4/rcon/source/client.py000066400000000000000000000044411447115006700165630ustar00rootroot00000000000000"""Synchronous client.""" from socket import SOCK_STREAM from rcon.client import BaseClient from rcon.exceptions import SessionTimeout, WrongPassword from rcon.source.proto import Packet, Type __all__ = ["Client"] class Client(BaseClient, socket_type=SOCK_STREAM): """An RCON client.""" def __init__( self, *args, frag_threshold: int = 4096, frag_detect_cmd: str = "", **kwargs ): """Set an optional fragmentation threshold and command in order to detect fragmented packets. For details see: https://wiki.vg/RCON#Fragmentation """ super().__init__(*args, **kwargs) self.frag_threshold = frag_threshold self.frag_detect_cmd = frag_detect_cmd def communicate(self, packet: Packet) -> Packet: """Send and receive a packet.""" self.send(packet) return self.read() def send(self, packet: Packet) -> None: """Send a packet to the server.""" with self._socket.makefile("wb") as file: file.write(bytes(packet)) def read(self) -> Packet: """Read a packet from the server.""" with self._socket.makefile("rb") as file: response = Packet.read(file) if len(response.payload) < self.frag_threshold: return response self.send(Packet.make_command(self.frag_detect_cmd)) while (successor := Packet.read(file)).id == response.id: response += successor return response def login(self, passwd: str, *, encoding: str = "utf-8") -> bool: """Perform a login.""" self.send(Packet.make_login(passwd, encoding=encoding)) # Wait for SERVERDATA_AUTH_RESPONSE according to: # https://developer.valvesoftware.com/wiki/Source_RCON_Protocol while (response := self.read()).type != Type.SERVERDATA_AUTH_RESPONSE: pass if response.id == -1: raise WrongPassword() return True def run(self, command: str, *args: str, encoding: str = "utf-8") -> str: """Run a command.""" request = Packet.make_command(command, *args, encoding=encoding) response = self.communicate(request) if response.id != request.id: raise SessionTimeout() return response.payload.decode(encoding) rcon-2.4.4/rcon/source/proto.py000066400000000000000000000137171447115006700164560ustar00rootroot00000000000000"""Low-level protocol stuff.""" from __future__ import annotations from asyncio import StreamReader from enum import Enum from functools import partial from logging import getLogger from random import randint from typing import IO, NamedTuple from rcon.exceptions import EmptyResponse __all__ = ["LittleEndianSignedInt32", "Type", "Packet", "random_request_id"] LOGGER = getLogger(__file__) TERMINATOR = b"\x00\x00" class LittleEndianSignedInt32(int): """A little-endian, signed int32.""" MIN = -2_147_483_648 MAX = 2_147_483_647 def __init__(self, *_): """Check the boundaries.""" super().__init__() if not self.MIN <= self <= self.MAX: raise ValueError("Signed int32 out of bounds:", int(self)) def __bytes__(self): """Return the integer as signed little endian.""" return self.to_bytes(4, "little", signed=True) @classmethod async def aread(cls, reader: StreamReader) -> LittleEndianSignedInt32: """Read the integer from an asynchronous file-like object.""" return cls.from_bytes(await reader.read(4), "little", signed=True) @classmethod def read(cls, file: IO) -> LittleEndianSignedInt32: """Read the integer from a file-like object.""" return cls.from_bytes(file.read(4), "little", signed=True) class Type(LittleEndianSignedInt32, Enum): """RCON packet types.""" SERVERDATA_AUTH = LittleEndianSignedInt32(3) SERVERDATA_AUTH_RESPONSE = LittleEndianSignedInt32(2) SERVERDATA_EXECCOMMAND = LittleEndianSignedInt32(2) SERVERDATA_RESPONSE_VALUE = LittleEndianSignedInt32(0) def __int__(self): """Return the actual integer value.""" return int(self.value) def __bytes__(self): """Return the integer value as little endian.""" return bytes(self.value) @classmethod async def aread(cls, reader: StreamReader, *, prefix: str = "") -> Type: """Read the type from an asynchronous file-like object.""" LOGGER.debug("%sReading type asynchronously.", prefix) value = await LittleEndianSignedInt32.aread(reader) LOGGER.debug("%s => value: %i", prefix, value) return cls(value) @classmethod def read(cls, file: IO, *, prefix: str = "") -> Type: """Read the type from a file-like object.""" LOGGER.debug("%sReading type.", prefix) value = LittleEndianSignedInt32.read(file) LOGGER.debug("%s => value: %i", prefix, value) return cls(value) class Packet(NamedTuple): """An RCON packet.""" id: LittleEndianSignedInt32 type: Type payload: bytes terminator: bytes = TERMINATOR def __add__(self, other: Packet | None) -> Packet: if other is None: return self if other.id != self.id: raise ValueError("Can only add packages with same id.") if other.type != self.type: raise ValueError("Can only add packages of same type.") if other.terminator != self.terminator: raise ValueError("Can only add packages with same terminator.") return Packet(self.id, self.type, self.payload + other.payload, self.terminator) def __radd__(self, other: Packet | None) -> Packet: if other is None: return self return other.__add__(self) def __bytes__(self): """Return the packet as bytes with prepended length.""" payload = bytes(self.id) payload += bytes(self.type) payload += self.payload payload += self.terminator size = bytes(LittleEndianSignedInt32(len(payload))) return size + payload @classmethod async def aread(cls, reader: StreamReader) -> Packet: """Read a packet from an asynchronous file-like object.""" LOGGER.debug("Reading packet asynchronously.") size = await LittleEndianSignedInt32.aread(reader) LOGGER.debug(" => size: %i", size) if not size: raise EmptyResponse() id_ = await LittleEndianSignedInt32.aread(reader) LOGGER.debug(" => id: %i", id_) type_ = await Type.aread(reader, prefix=" ") LOGGER.debug(" => type: %i", type_) payload = await reader.read(size - 10) LOGGER.debug(" => payload: %s", payload) terminator = await reader.read(2) LOGGER.debug(" => terminator: %s", terminator) if terminator != TERMINATOR: LOGGER.warning("Unexpected terminator: %s", terminator) return cls(id_, type_, payload, terminator) @classmethod def read(cls, file: IO) -> Packet: """Read a packet from a file-like object.""" LOGGER.debug("Reading packet.") size = LittleEndianSignedInt32.read(file) LOGGER.debug(" => size: %i", size) if not size: raise EmptyResponse() id_ = LittleEndianSignedInt32.read(file) LOGGER.debug(" => id: %i", id_) type_ = Type.read(file, prefix=" ") LOGGER.debug(" => type: %i", type_) payload = file.read(size - 10) LOGGER.debug(" => payload: %s", payload) terminator = file.read(2) LOGGER.debug(" => terminator: %s", terminator) if terminator != TERMINATOR: LOGGER.warning("Unexpected terminator: %s", terminator) return cls(id_, type_, payload, terminator) @classmethod def make_command(cls, *args: str, encoding: str = "utf-8") -> Packet: """Create a command packet.""" return cls( random_request_id(), Type.SERVERDATA_EXECCOMMAND, b" ".join(map(partial(str.encode, encoding=encoding), args)), ) @classmethod def make_login(cls, passwd: str, *, encoding: str = "utf-8") -> Packet: """Create a login packet.""" return cls(random_request_id(), Type.SERVERDATA_AUTH, passwd.encode(encoding)) def random_request_id() -> LittleEndianSignedInt32: """Generate a random request ID.""" return LittleEndianSignedInt32(randint(0, LittleEndianSignedInt32.MAX)) rcon-2.4.4/requirements.txt000066400000000000000000000000001447115006700157410ustar00rootroot00000000000000rcon-2.4.4/setup.py000077500000000000000000000014601447115006700142050ustar00rootroot00000000000000#! /usr/bin/env python """Installation script.""" from setuptools import setup setup( name="rcon", use_scm_version=True, setup_requires=["setuptools_scm"], author="Richard Neumann", author_email="mail@richard-neumann.de", python_requires=">=3.10", packages=["rcon", "rcon.battleye", "rcon.source"], extras_require={"GUI": ["pygobject", "pygtk"]}, entry_points={ "console_scripts": [ "rcongui = rcon.gui:main", "rconclt = rcon.rconclt:main", "rconshell = rcon.rconshell:main", ], }, url="https://github.com/conqp/rcon", license="GPLv3", description="An RCON client library.", long_description=open("README.md").read(), long_description_content_type="text/markdown", keywords="python rcon client", ) rcon-2.4.4/tests/000077500000000000000000000000001447115006700136315ustar00rootroot00000000000000rcon-2.4.4/tests/__init__.py000066400000000000000000000000221447115006700157340ustar00rootroot00000000000000"""Unit tests.""" rcon-2.4.4/tests/test_battleye_proto.py000066400000000000000000000007641447115006700203050ustar00rootroot00000000000000"""Test the BattlEye protocol.""" from unittest import TestCase from rcon.battleye.proto import Header HEADER = Header(920575337, 0x00) BYTES = b"BEi\xdd\xde6\xff\x00" class TestHeader(TestCase): """Test header object.""" def test_header_from_bytes(self): """Tests header object parsing.""" self.assertEqual(Header.from_bytes(BYTES), HEADER) def test_header_to_bytes(self): """Tests header object parsing.""" self.assertEqual(bytes(HEADER), BYTES) rcon-2.4.4/tests/test_config.py000066400000000000000000000033171447115006700165130ustar00rootroot00000000000000"""Tests the configuration file parsing.""" from itertools import product from random import shuffle from string import printable from typing import Iterator from unittest import TestCase from rcon.config import Config def random_passwd() -> str: """Generates a random password containing all printable characters.""" chars = list(printable) shuffle(chars) return "".join(chars) class TestConfig(TestCase): """Test the named tuple Config.""" def setUp(self): """Sets up test and target data.""" self.hosts = ["subsubdomain.subdomain.example.com", "locahost", "127.0.0.1"] self.ports = range(65_536) @property def _sockets(self) -> Iterator[tuple[str, int]]: """Yields (host, port) tuples.""" return product(self.hosts, self.ports) def _test_from_string_with_password(self, host, port): """Tests the Config.from_string() method with a password.""" passwd = random_passwd() config = Config.from_string(f"{passwd}@{host}:{port}") self.assertEqual(config.host, host) self.assertEqual(config.port, port) self.assertEqual(config.passwd, passwd) def _test_from_string_without_password(self, host, port): """Tests the Config.from_string() method without a password.""" config = Config.from_string(f"{host}:{port}") self.assertEqual(config.host, host) self.assertEqual(config.port, port) self.assertIsNone(config.passwd) def test_from_string(self): """Tests the Config.from_string() method.""" for host, port in self._sockets: self._test_from_string_with_password(host, port) self._test_from_string_without_password(host, port) rcon-2.4.4/tests/test_source_proto.py000066400000000000000000000125741447115006700177760ustar00rootroot00000000000000"""Testing of the proto module.""" from functools import partial from io import BytesIO from random import randint from unittest import TestCase from rcon.source.proto import LittleEndianSignedInt32 from rcon.source.proto import Packet from rcon.source.proto import Type from rcon.source.proto import random_request_id class TestRandomRequestId(TestCase): """Tests the random_request_id function.""" def _test_type(self, request_id: LittleEndianSignedInt32): """Tests the type of a request id.""" self.assertIsInstance(request_id, LittleEndianSignedInt32) def _test_value(self, request_id: LittleEndianSignedInt32): """Tests the value of a request id.""" self.assertTrue(0 <= request_id <= LittleEndianSignedInt32.MAX) def _test_request_id(self, request_id: LittleEndianSignedInt32): """Tests a request id.""" self._test_type(request_id) self._test_value(request_id) def test_random_request_ids(self): """Tests for valid values.""" for _ in range(1000): self._test_request_id(random_request_id()) class TestLittleEndianSignedInt32(TestCase): """Tests the LittleEndianSignedInt32 type.""" def test_min(self): """Tests the minimum value.""" self.assertEqual( LittleEndianSignedInt32(LittleEndianSignedInt32.MIN), LittleEndianSignedInt32.MIN, ) def test_max(self): """Tests the maximum value.""" self.assertEqual( LittleEndianSignedInt32(LittleEndianSignedInt32.MAX), LittleEndianSignedInt32.MAX, ) def test_below_min(self): """Tests a value below the minimum value.""" self.assertRaises( ValueError, partial(LittleEndianSignedInt32, LittleEndianSignedInt32.MIN - 1), ) def test_above_max(self): """Tests a value above the maximum value.""" self.assertRaises( ValueError, partial(LittleEndianSignedInt32, LittleEndianSignedInt32.MAX + 1), ) def test_random(self): """Tests random LittleEndianSignedInt32 values.""" for _ in range(1000): random = randint( LittleEndianSignedInt32.MIN, LittleEndianSignedInt32.MAX + 1 ) self.assertEqual(LittleEndianSignedInt32(random), random) class TestType(TestCase): """Tests the Type enum.""" def test_serverdata_auth_value(self): """Tests the SERVERDATA_AUTH value.""" self.assertEqual(Type.SERVERDATA_AUTH.value, 3) self.assertEqual(int(Type.SERVERDATA_AUTH), 3) def test_serverdata_auth_bytes(self): """Tests the SERVERDATA_AUTH bytes.""" self.assertEqual(bytes(Type.SERVERDATA_AUTH), (3).to_bytes(4, "little")) def test_serverdata_auth_read(self): """Tests reading of SERVERDATA_AUTH.""" self.assertIs( Type.read(BytesIO((3).to_bytes(4, "little"))), Type.SERVERDATA_AUTH ) def test_serverdata_auth_response_value(self): """Tests the SERVERDATA_AUTH_RESPONSE value.""" self.assertEqual(Type.SERVERDATA_AUTH_RESPONSE.value, 2) self.assertEqual(int(Type.SERVERDATA_AUTH_RESPONSE), 2) def test_serverdata_auth_response_bytes(self): """Tests the SERVERDATA_AUTH_RESPONSE bytes.""" self.assertEqual( bytes(Type.SERVERDATA_AUTH_RESPONSE), (2).to_bytes(4, "little") ) def test_serverdata_auth_response_read(self): """Tests the reading of SERVERDATA_AUTH_RESPONSE.""" self.assertIs( Type.read(BytesIO((2).to_bytes(4, "little"))), Type.SERVERDATA_AUTH_RESPONSE ) def test_serverdata_execcommand_value(self): """Tests the SERVERDATA_EXECCOMMAND value.""" self.assertEqual(Type.SERVERDATA_EXECCOMMAND.value, 2) self.assertEqual(int(Type.SERVERDATA_EXECCOMMAND), 2) def test_serverdata_execcommand_bytes(self): """Tests the SERVERDATA_EXECCOMMAND bytes.""" self.assertEqual(bytes(Type.SERVERDATA_EXECCOMMAND), (2).to_bytes(4, "little")) def test_serverdata_execcommand_read(self): """Tests the reading of SERVERDATA_EXECCOMMAND.""" self.assertIs( Type.read(BytesIO((2).to_bytes(4, "little"))), Type.SERVERDATA_EXECCOMMAND ) def test_serverdata_response_value_value(self): """Tests the SERVERDATA_RESPONSE_VALUE value.""" self.assertEqual(Type.SERVERDATA_RESPONSE_VALUE.value, 0) self.assertEqual(int(Type.SERVERDATA_RESPONSE_VALUE), 0) def test_serverdata_response_value_bytes(self): """Tests the SERVERDATA_RESPONSE_VALUE bytes.""" self.assertEqual( bytes(Type.SERVERDATA_RESPONSE_VALUE), (0).to_bytes(4, "little") ) def test_serverdata_response_value_read(self): """Tests the reading SERVERDATA_RESPONSE_VALUE.""" self.assertIs( Type.read(BytesIO((0).to_bytes(4, "little"))), Type.SERVERDATA_RESPONSE_VALUE, ) class TestPacket(TestCase): """Tests the Packet named tuple.""" def setUp(self): """Creates a packet.""" self.packet = Packet( random_request_id(), Type.SERVERDATA_EXECCOMMAND, "Lorem ipsum sit amet...".encode(), ) def test_bytes_rw(self): """Tests recovering from bytes.""" self.assertEqual(Packet.read(BytesIO(bytes(self.packet))), self.packet)