pax_global_header00006660000000000000000000000064147760577550014541gustar00rootroot0000000000000052 comment=7a6cb8be42a5adc6ed59db00c9b64b07da06be14 tractor-5.1.0/000077500000000000000000000000001477605775500132225ustar00rootroot00000000000000tractor-5.1.0/.gitignore000066400000000000000000000001561477605775500152140ustar00rootroot00000000000000*~ *.swp __pycache__ *.pyc .pypirc .pybuild/ build/ dist/ venv/ *.egg-info/ .coverage .tox tests/htmlcov/ pid tractor-5.1.0/.gitlab-ci.yml000066400000000000000000000031771477605775500156660ustar00rootroot00000000000000# You can override the included template(s) by including variable overrides # SAST customization: https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings # Secret Detection customization: https://docs.gitlab.com/ee/user/application_security/secret_detection/#customizing-settings # Dependency Scanning customization: https://docs.gitlab.com/ee/user/application_security/dependency_scanning/#customizing-the-dependency-scanning-settings # Container Scanning customization: https://docs.gitlab.com/ee/user/application_security/container_scanning/#customizing-the-container-scanning-settings # Note that environment variables can be set in several places # See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence image: debian:testing-slim variables: PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip" sast: stage: test artifacts: paths: - gl-sast-report.json include: - template: Security/SAST.gitlab-ci.yml unittest: image: python:latest stage: test script: - apt-get -qq update - apt-get -qqy install cmake libgirepository-2.0-dev libpython3-all-dev gsettings-desktop-schemas - pip install tox - tox allow_failure: true build: stage: build script: - apt-get -qq update - apt-get -qqy install flit git - rm -f .cache - rm -f gl-sast-report.json - flit build artifacts: paths: - dist deploy: stage: deploy script: - apt-get -qq update - apt-get -qqy install twine - twine upload --non-interactive --disable-progress-bar --skip-existing dist/* only: - tags except: - branches stages: - test - build - deploy tractor-5.1.0/CHANGELOG000066400000000000000000000053561477605775500144450ustar00rootroot00000000000000tractor (5.1.0) 04 Apr 2025 * Remove deperacted items from autocomplete * Tip users about setting proxy after successful connection * Fix test suite tractor (5.0.0) 07 Dec 2024 * Use upstream proxy by default * Add an option to set proxy after successful connection * Add support for conjure bridges * Add support for fascist firewall * Add bility to find current using bridges * Deprecating options: isset, isrunning, isconnected, bridgesfile * Respect NO_COLOR environmental variable tractor (4.5.1) 21 Feb 2024 * Fix a bug with trying cancel tractor (4.5.0) 13 Feb 2024 * Add support for snowflake and webtunnel * Let each bridge type to have its own pt tractor (4.4.1) 27 Jan 2024 * Fix a bug with getting sample bridges tractor (4.4.0) 18 Jan 2024 * Add `--verbose` for action commands * Fix a bug when there is no data directory tractor (4.3.1) 09 Jan 2024 * Fix a crash with no pluggable tranport * Remove python requests module from dependencies * Add test via unittest and tox. tractor (4.3.0) 02 Jan 2024 * Accept different kind of bridge lines * Cleaning the code base tractor (4.2.1) 30 Dec 2023 * move to src-layout tractor (4.2.0) 30 Dec 2023 * Fix killing tor on New ID * Cleaning the code base tractor (4.1.1) 11 Jan 2023 * Clean cache from source package tractor (4.1.0) 10 Jan 2023 * Migrate to pyproject.toml tractor (4.0.1) 04 Jan 2023 * Update bash completion to 4.0 tractor (4.0) 02 Dec 2022 * Allow Multi-user use * Allow to run beside Tor * Support different types of bridges * Add Option to check if proxy is set tractor (3.14) 24 Jul 2022 * separate Debian development from tractor tractor (3.13) 25 May 2022 * fix a bug when using strict exit nodes with bridges enabled tractor (3.12) 17 Aug 2021 * fix a bug with 3.11 in stop function (thank to @eshagh79) tractor (3.11) 08 Aug 2021 * fix a bug with restart (thank to @eshagh79) tractor (3.10) 27 Jun 2021 * add man to wheel tractor (3.9) 21 Jun 2021 * make setup.py debian-independent tractor (3.8) 10 Jun 2021 * don't reset pid in dconf on check * better error display tractor (3.7) 17 May 2021 * some refactors and lintings tractor (3.6) 29 Sep 2020 * allow using fire flags * complete fire help page * add auto completion tractor (3.5) 29 Sep 2020 * reset pid if not running tractor (3.4) 28 Sep 2020 * Made inter-refrences more clear * Add pysocks as requirement tractor (3.3) 27 Sep 2020 * Separating sections into modules * Update README tractor (3.2) 26 Sep 2020 * upgrade base from bionic to focal * changed to native package versions * fixed some lintian warnings tractor (3.1) 25 Sep 2020 * removed unnecessary file check tractor (3.0) 25 Sep 2020 * moved to a python module tractor-5.1.0/CONTRIBUTING.md000066400000000000000000000023631477605775500154570ustar00rootroot00000000000000# How to ## Issues If you have a [Framagit](https://framagit.org) account, you can directly create a new issue at the [issue board](https://framagit.org/tractor/tractor/-/issues). You can also create a new issue by sending an email to the [project's issues email address](mailto:gitlab-incoming+tractor-tractor-67089-4tkz1e0f90cy2gilp6fnnpcfw-issue@framagit.org). The subject will be used as the title of the new issue, and the message will be the description. [Quick actions](https://framagit.org/help/user/project/quick_actions) and styling with [Markdown](https://framagit.org/help/user/markdown) are supported. ## Merge Requests If you have a [Framagit](https://framagit.org) account, you can fork and send merge requests. The second favorite model is using [git send-email](https://git-scm.com/docs/git-send-email) to send patches as issues to the issue board via email. At last, you can reupload this project to the git host of your choice and send the MR link to the issue board via email. # Areas of interests There are some important areas you can contribute to this project: ## Code * Expanding the test suit. ## Community * Packaging for more GNU/Linux distributions. * Packaging for [Homebrew](https://brew.sh) and [Msys2](https://www.msys2.org). tractor-5.1.0/LICENSE000066400000000000000000001045151477605775500142350ustar00rootroot00000000000000 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 . tractor-5.1.0/MANIFEST.in000066400000000000000000000000421477605775500147540ustar00rootroot00000000000000include src/tractor/SampleBridges tractor-5.1.0/README.md000066400000000000000000000021261477605775500145020ustar00rootroot00000000000000# Tractor Tractor is core app which lets user to setup a proxy with Onion Routing via TOR and optionally obfs4proxy in their user space. The goal is to ease the proccess of connecting to TOR and prevent messing up with system files. ## Install Tractor is natively packaged for some distros: [![Packaging status](https://repology.org/badge/vertical-allrepos/tractor.svg)](https://repology.org/project/tractor/versions) If you are any other distribution or OS, Tractor team welcomes you to make build recepie of yours. You can also use use global package mangers like [GNU GUIX](https://packages.guix.gnu.org/packages/tractor) or [Python Pypi](https://pypi.org/project/traxtor) ## Run you can run Tractor by command line or use one of the graphical interfaces which are packaged separately. For command line interface, read manual provided with the package or available [online](https://framagit.org/tractor/tractor/-/blob/main/data/tractor.1). ## Contribute Contibuting is always appreciated. See [CONTRIBUTING](https://framagit.org/tractor/tractor/-/blob/main/CONTRIBUTING.md) for more information. tractor-5.1.0/data/000077500000000000000000000000001477605775500141335ustar00rootroot00000000000000tractor-5.1.0/data/completion/000077500000000000000000000000001477605775500163045ustar00rootroot00000000000000tractor-5.1.0/data/completion/bash/000077500000000000000000000000001477605775500172215ustar00rootroot00000000000000tractor-5.1.0/data/completion/bash/tractor000066400000000000000000000050501477605775500206220ustar00rootroot00000000000000# bash completion support for tractor # DO NOT EDIT. # This script is autogenerated by fire/completion.py. _complete-tractor() { local cur prev opts lastcommand COMPREPLY=() prev="${COMP_WORDS[COMP_CWORD-1]}" cur="${COMP_WORDS[COMP_CWORD]}" lastcommand=$(get_lastcommand) opts="" GLOBAL_OPTIONS="" case "${lastcommand}" in newid) if is_prev_global; then opts="${GLOBAL_OPTIONS}" else opts="--verbose ${GLOBAL_OPTIONS}" fi opts=$(filter_options $opts) ;; restart) if is_prev_global; then opts="${GLOBAL_OPTIONS}" else opts="--verbose ${GLOBAL_OPTIONS}" fi opts=$(filter_options $opts) ;; unset) if is_prev_global; then opts="${GLOBAL_OPTIONS}" else opts="--verbose ${GLOBAL_OPTIONS}" fi opts=$(filter_options $opts) ;; stop) if is_prev_global; then opts="${GLOBAL_OPTIONS}" else opts="--verbose ${GLOBAL_OPTIONS}" fi opts=$(filter_options $opts) ;; killtor) if is_prev_global; then opts="${GLOBAL_OPTIONS}" else opts="--verbose ${GLOBAL_OPTIONS}" fi opts=$(filter_options $opts) ;; start) if is_prev_global; then opts="${GLOBAL_OPTIONS}" else opts="--verbose ${GLOBAL_OPTIONS}" fi opts=$(filter_options $opts) ;; set) if is_prev_global; then opts="${GLOBAL_OPTIONS}" else opts="--verbose ${GLOBAL_OPTIONS}" fi opts=$(filter_options $opts) ;; tractor) opts="start stop newid restart set unset killtor ${GLOBAL_OPTIONS}" opts=$(filter_options $opts) ;; esac COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) ) return 0 } get_lastcommand() { local lastcommand i lastcommand= for ((i=0; i < ${#COMP_WORDS[@]}; ++i)); do if [[ ${COMP_WORDS[i]} != -* ]] && [[ -n ${COMP_WORDS[i]} ]] && [[ ${COMP_WORDS[i]} != $cur ]]; then lastcommand=${COMP_WORDS[i]} fi done echo $lastcommand } filter_options() { local opts opts="" for opt in "$@" do if ! option_already_entered $opt; then opts="$opts $opt" fi done echo $opts } option_already_entered() { local opt for opt in ${COMP_WORDS[@]:0:COMP_CWORD} do if [ $1 == $opt ]; then return 0 fi done return 1 } is_prev_global() { local opt for opt in $GLOBAL_OPTIONS do if [ $opt == $prev ]; then return 0 fi done return 1 } complete -F _complete-tractor tractor tractor-5.1.0/data/tractor.1000066400000000000000000000012721477605775500156750ustar00rootroot00000000000000.\" Manpage for tractor .\" Contact dani.behzi@ubuntu.com to correct errors or typos. .TH man 1 "15 Mar 2024" "5.0.0" "tractor man page" .SH NAME tractor \- Setup an onion routing proxy .SH SYNOPSIS tractor COMMAND [--verbose] .SH DESCRIPTION This package uses python stem library to provide a connection through the onion proxy and sets up proxy in user session, so you don't have to mess up with TOR on your system anymore. .SH COMMANDS start \- starts onion routing stop \- stops onion routing newid \- gives user a new identity restart \- stop, then start set \- setup proxy unset \- unset proxy killtor \- kill all tor processes by user .SH AUTHOR Danial Behzadi (dani.behzi@ubuntu.com) tractor-5.1.0/pyproject.toml000066400000000000000000000021561477605775500161420ustar00rootroot00000000000000[project] name = "traxtor" version = "5.1.0" authors = [ {name = "Danial Behzadi", email = "dani.behzi@ubuntu.com"}, ] description = "Setup an onion routing proxy" readme = "README.md" requires-python = ">=3.9" classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: OS Independent", ] dependencies = [ "PyGObject", "fire", "pysocks", "stem", ] keywords = [ "Tor", "onion", "stem", ] [project.license] file = "LICENSE" [project.scripts] tractor = "tractor.tractor:main" [project.urls] "Homepage" = "https://tractor.frama.io/tractor" "Bug Tracker" = "https://framagit.org/tractor/tractor/-/issues" "Documentation" = "https://framagit.org/tractor/tractor/-/blob/main/tractor/man/tractor.1" "Source Code" = "https://framagit.org/tractor/tractor" [tool.pylint] disable = [ "E1101", # no-member ] [tool.flit.module] name = "tractor" [tool.tox] envlist = [ "py311", "py312", "py313", ] [tool.tox.env_run_base] commands = [["python", "-m", "unittest", "discover", "tests"]] tractor-5.1.0/src/000077500000000000000000000000001477605775500140115ustar00rootroot00000000000000tractor-5.1.0/src/tractor/000077500000000000000000000000001477605775500154675ustar00rootroot00000000000000tractor-5.1.0/src/tractor/SampleBridges000066400000000000000000000016171477605775500201400ustar00rootroot00000000000000217.94.24.184:9001 0DA8DF189C3BA32DB1C9029D242CB4043E189419 141.95.17.236:9333 6E896C8EEDD2E163A540179CF9F242F5DBE11FE4 208.85.23.128:9002 17B00ABF1035E1B9C49561CDDF9D09A7B1C2B6A2 70.34.243.229:443 1C4C9C4A14F1C91428FDA89C13EE6B9E41F785E0 snowflake 192.0.2.3:80 2B280B23E1107BB62ABFC40DDCC8824814F80A72 snowflake 192.0.2.4:80 8838024498816A039FCBBAB14E6F40A0843051FA obfs4 85.31.186.98:443 011F2599C0E9B27EE74B353155E244813763C3E5 cert=ayq0XzCwhpdysn5o0EyDUbmSOx3X/oTEbzDMvczHOdBJKlvIdHHLJGkZARtT4dcBFArPPg iat-mode=0 obfs4 85.31.186.26:443 91A6354697E6B02A386312F68D82CF86824D3606 cert=PBwr+S8JTVZo6MPdHnkTwXJPILWADLqfMGoVvhZClMq/Urndyd42BwX9YFJHZnBB3H0XCw iat-mode=0 meek_lite 192.0.2.18:80 BE776A53492E1E044A26F17306E1BC46A55A1625 url=https://meek.azureedge.net/ front=ajax.aspnetcdn.com conjure 143.110.214.222:80 url=https://registration.refraction.network.global.prod.fastly.net/api front=cdn.sstatic.net tractor-5.1.0/src/tractor/__init__.py000066400000000000000000000000001477605775500175660ustar00rootroot00000000000000tractor-5.1.0/src/tractor/actions.py000066400000000000000000000137641477605775500175140ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2020-2024. """ real actions of tractor """ import os import signal from shutil import rmtree from stem.process import launch_tor from stem.util import term from . import checks, control, db, proxy, tractorrc no_color = os.environ["NO_COLOR"] if "NO_COLOR" in os.environ else 0 def _print_bootstrap_lines(line) -> None: """ prints bootstrap line in standard output """ if "Bootstrapped " in line: print( term.format(line, "" if no_color else term.Color.BLUE), flush=True, ) def _print_all_lines(line) -> None: """ prints bootstrap line in standard output """ print( term.format(line, "" if no_color else term.Color.BLUE), flush=True, ) def _finish_notification(verbose: bool) -> None: """ Notify user after start finished """ if not checks.running(): print( term.format( "Tractor could not connect.\n" "Please check your connection and try again.", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.RED, ) ) else: checks.verbose_print( term.format( "Connected", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.GREEN, ), verbose, ) if db.get_val("auto-set"): proxy.proxy_set(verbose) else: checks.verbose_print( term.format( "You may set the proxy manually.", "", "" if no_color else term.Color.YELLOW, ), verbose, ) def _launch(torrc: str, tmpdir: str, verbose: bool) -> None: """ Actually launch tor """ msg_handler = checks.verbose_return( _print_bootstrap_lines, _print_all_lines, verbose ) try: tractor_process = launch_tor( torrc_path=torrc, init_msg_handler=msg_handler, ) db.set_val("pid", tractor_process.pid) except OSError as error: print(term.format(f"{error}\n", "" if no_color else term.Color.RED)) except KeyboardInterrupt: pass else: _finish_notification(verbose) finally: if os.path.exists(tmpdir): rmtree(tmpdir, ignore_errors=True) def _start_launch(verbose: bool) -> None: """ Start launching tor """ data_dir = db.data_directory() os.makedirs(data_dir, mode=0o700, exist_ok=True) try: tmpdir, torrc = tractorrc.create() except ValueError as error: print( term.format( f"Error Creating torrc. Check your configurations\n{error}", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.RED, ) ) except EnvironmentError as error: print( term.format( str(error), "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.RED, ) ) else: checks.verbose_print( term.format( "Starting connection…", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.YELLOW, ), verbose, ) _launch(torrc, tmpdir, verbose) def start(verbose: bool = False) -> None: """ starts onion routing """ if not checks.running(): _start_launch(verbose) else: print( term.format( "Tractor is already started", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.GREEN, ) ) def stop(verbose: bool = False) -> None: """ stops onion routing """ if checks.running(): control.send_signal("term") db.reset("pid") proxy.proxy_unset() db.reset("upstream-proxy") checks.verbose_print( term.format( "Tractor stopped", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.YELLOW, ), verbose, ) else: checks.verbose_print( term.format( "Tractor seems to be stopped.", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.YELLOW, ), verbose, ) def restart(verbose: bool = False) -> None: """ stop, then start """ stop(verbose) start(verbose) def new_id(verbose: bool = False) -> None: """ gives user a new identity """ if not checks.running(): print( term.format( "Tractor is stopped.", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.YELLOW, ) ) else: control.send_signal("newnym") checks.verbose_print( term.format( "You now have a new ID.", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.GREEN, ), verbose, ) def kill_tor(verbose: bool = False) -> None: """ kill tor process """ pid = control.get_pid() if pid: os.killpg(os.getpgid(control.get_pid()), signal.SIGTERM) db.reset("pid") checks.verbose_print( term.format( "Tor process has been successfully killed!", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.GREEN, ), verbose, ) else: checks.verbose_print( term.format( "Couldn't find any process to kill!", "" if no_color else term.Attr.BOLD, "" if no_color else term.Color.RED, ), verbose, ) tractor-5.1.0/src/tractor/bridges.py000066400000000000000000000156661477605775500174760ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2020-2024. """ module to manages bridges """ import os import re import shutil from . import db def get_sample_bridges() -> str: """ there should be some sample bridges in the package """ return os.path.join( os.path.dirname(os.path.abspath(__file__)), "SampleBridges" ) def copy_sample_bridges(bridges_file) -> None: """ function to copy sample bridges for tractor """ sample_bridges_file = get_sample_bridges() try: shutil.copyfile(sample_bridges_file, bridges_file) except (PermissionError, FileNotFoundError) as exception: raise IOError(f"Bridge copy failed: {exception}") from exception os.chmod(bridges_file, 0o600) def get_file() -> str: """ get bridges file address """ data_dir = db.data_directory() os.makedirs(data_dir, mode=0o700, exist_ok=True) bridges_file = os.path.join(data_dir, "Bridges") if not os.path.isfile(bridges_file): copy_sample_bridges(bridges_file) return bridges_file def relevant_lines(my_bridges: str, bridge_type: str) -> list: """ return the relevant bridge lines from bridge list """ obfs_transports = [ "meek_lite", "obfs2", "obfs3", "obfs4", "scramblesuit", "webtunnel", ] transports = obfs_transports if bridge_type == "obfs4" else [bridge_type] matches = [ bridge for bridge in my_bridges.split("\n") if parse_bridge_line(bridge)["transport"] in transports ] return matches def parse_bridge_line(line: str): """ return a dict of transport, addr, id and args for a bridge line """ if line.startswith("#") or not line: return {"transport": None} pattern = re.compile( r""" (?:(?P\S+)\s+)? (?P[0-9a-fA-F\.\[\]\:]+:\d{1,5}) (?:\s+(?P[0-9a-fA-F]{40}))? (?:\s+(?P.+))? """, re.VERBOSE, ) match = re.match(pattern, line) if not match: return {"transport": None} bridge = match.groupdict() if "transport" not in bridge or not bridge["transport"]: bridge["transport"] = "vanilla" return bridge def create_emoji(bridge_line: str) -> list: """ Create FNV-1a hash for the given address and map it to the emoji list. """ emoji_list = [ "👽️", "🤖", "🧠", "👁️", "🧙", "🧚", "🧜", "🐵", "🦧", "🐶", "🐺", "🦊", "🦝", "🐱", "🦁", "🐯", "🐴", "🦄", "🦓", "🦌", "🐮", "🐷", "🐗", "🐪", "🦙", "🦒", "🐘", "🦣", "🦏", "🐭", "🐰", "🐿️", "🦔", "🦇", "🐻", "🐨", "🦥", "🦦", "🦘", "🐥", "🐦️", "🕊️", "🦆", "🦉", "🦤", "🪶", "🦩", "🦚", "🦜", "🐊", "🐢", "🦎", "🐍", "🐲", "🦕", "🐳", "🐬", "🦭", "🐟️", "🐠", "🦈", "🐙", "🐚", "🐌", "🦋", "🐛", "🐝", "🐞", "💐", "🌹", "🌺", "🌻", "🌷", "🌲", "🌳", "🌴", "🌵", "🌿", "🍁", "🍇", "🍈", "🍉", "🍊", "🍋", "🍌", "🍍", "🥭", "🍏", "🍐", "🍑", "🍒", "🍓", "🫐", "🥝", "🍅", "🫒", "🥥", "🥑", "🍆", "🥕", "🌽", "🌶️", "🥬", "🥦", "🧅", "🍄", "🥜", "🥐", "🥖", "🥨", "🥯", "🥞", "🧇", "🍔", "🍕", "🌭", "🌮", "🍿", "🦀", "🦞", "🍨", "🍩", "🍪", "🎂", "🧁", "🍫", "🍬", "🍭", "🫖", "🧃", "🧉", "🧭", "🏔️", "🌋", "🏕️", "🏝️", "🏡", "⛲️", "🎠", "🎡", "🎢", "💈", "🚆", "🚋", "🚍️", "🚕", "🚗", "🚚", "🚜", "🛵", "🛺", "🛴", "🛹", "🛼", "⚓️", "⛵️", "🛶", "🚤", "🚢", "✈️", "🚁", "🚠", "🛰️", "🚀", "🛸", "⏰", "🌙", "🌡️", "☀️", "🪐", "🌟", "🌀", "🌈", "☂️", "❄️", "☄️", "🔥", "💧", "🌊", "🎃", "✨", "🎈", "🎉", "🎏", "🎀", "🎁", "🎟️", "🏆️", "⚽️", "🏀", "🏈", "🎾", "🥏", "🏓", "🏸", "🤿", "🥌", "🎯", "🪀", "🪁", "🔮", "🎲", "🧩", "🎨", "🧵", "👕", "🧦", "👗", "🩳", "🎒", "👟", "👑", "🧢", "💄", "💍", "💎", "📢", "🎶", "🎙️", "📻️", "🎷", "🪗", "🎸", "🎺", "🎻", "🪕", "🥁", "☎️", "🔋", "💿️", "🧮", "🎬️", "💡", "🔦", "🏮", "📕", "🏷️", "💳️", "✏️", "🖌️", "🖍️", "📌", "📎", "🔑", "🪃", "🏹", "⚖️", "🧲", "🧪", "🧬", "🔬", "🔭", "📡", "🪑", "🧹", "🗿", ] prime = 0x01000193 offset = 0x811C9DC5 hash_value = offset # Calculate FNV-1a hash of the bridge_line for byte in bridge_line.encode("utf-8"): hash_value = (hash_value ^ byte) * prime hash_value %= 2**32 # Get the last 32-bit of the integer # Map every 4 bytes of the hash to emojis hash_bytes = hash_value.to_bytes(length=4, byteorder="big") return [emoji_list[hash_bytes[i] % len(emoji_list)] for i in range(4)] tractor-5.1.0/src/tractor/checks.py000066400000000000000000000054071477605775500173070ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2020-2024. """ actions for tractor internals """ import socket import urllib from contextlib import contextmanager import socks from gi.repository import Gio from stem.util import system from . import control, db def running() -> bool: """ checks if Tractor is running or not """ if system.is_running("tor"): pid = control.get_pid() if pid: return system.is_running(pid) return False def _getaddrinfo(*args): """ Perform DNS resolution through the socket """ return [(socket.AF_INET, socket.SOCK_STREAM, 6, "", (args[0], args[1]))] @contextmanager def _patch_socket(): """ Context manager for mokey patching the socket """ old_socket = socket.socket old_getaddrinfo = socket.getaddrinfo socket.socket = socks.socksocket socket.getaddrinfo = _getaddrinfo try: yield finally: socket.socket = old_socket socket.getaddrinfo = old_getaddrinfo def _fetched() -> bool: """ Checks if the expected resource fetched or not """ port = control.get_listener("socks")[1] host = "https://check.torproject.org/" socks.setdefaultproxy(socks.PROXY_TYPE_SOCKS5, "127.0.0.1", port) expectation = "Congratulations." err = urllib.error with _patch_socket(): try: with urllib.request.urlopen(host) as request: status = request.status response = request.read().decode("utf-8") except (err.HTTPError, err.URLError, TimeoutError): return False if status == 200 and expectation in response: return True return False def connected() -> bool: """ checks if Tractor is connected or not """ if running(): return _fetched() return False def proxy_set() -> bool: """ checks if proxy is set or not """ schema = "org.gnome.system.proxy" conf = Gio.Settings.new(schema) if conf.get_string("mode") != "manual": return False try: x_ip, x_port = control.get_listener("socks") except ValueError: x_ip = "0.0.0.0" if db.get_val("accept-connection") else "127.0.0.1" x_port = db.get_val("socks-port") schema = "org.gnome.system.proxy.socks" conf = Gio.Settings.new(schema) my_ip = conf.get_string("host") my_port = conf.get_int("port") if my_ip == x_ip and my_port == x_port: return True return False def verbose_print(text: str, verbose): """ Print text only if the verbose is True """ if verbose: print(text) def verbose_return(obj1: type, obj2: type, verbose: bool): """ Return object based on verbosity """ if verbose: return obj2 return obj1 tractor-5.1.0/src/tractor/control.py000066400000000000000000000030701477605775500175210ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2024. """ Things to do with control socket """ from os.path import join from gi.repository import GLib from stem import Signal from stem.connection import connect from stem.control import Controller def _get_controller() -> Controller: """ Return the control socket """ socket = join(GLib.get_user_config_dir(), "tractor", "control.sock") controller = connect(control_socket=socket) return controller def send_signal(signal: str) -> None: """ Send a signal to the tor process """ controller = _get_controller() if controller: match signal: case "term": controller.signal(Signal.TERM) case "newnym": controller.signal(Signal.NEWNYM) case _: raise ValueError(f"Wrong signal '{signal}'.") def get_listener(listener_type: str) -> int: """ Get configuration from control socket """ controller = _get_controller() if controller: value = controller.get_listeners(listener_type) return value[0] raise ValueError("No listener.") def get_pid() -> int: """ Get pid of the tor process """ controller = _get_controller() if controller: return controller.get_pid() return 0 def get_bridge() -> str: """ Get the current using bridges """ controller = _get_controller() if controller: if controller.get_conf("UseBridges"): return controller.get_conf("Bridge") return "" tractor-5.1.0/src/tractor/db.py000066400000000000000000000060021477605775500164240ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2023-2024. """ Module to get values of keys from gschema """ import os from gi.repository import Gio, GLib def dconf() -> Gio.Settings: """ connect to gsettings database """ schema = "org.tractor" schemas = Gio.SettingsSchemaSource.get_default() if not Gio.SettingsSchemaSource.lookup(schemas, schema, False): gschema_dir = "/usr/share/glib-2.0/schemas/" for directory in GLib.get_system_data_dirs(): gdir = f"{directory}/glib-2.0/schemas/" if os.path.exists(gdir): gschema_dir = os.path.abspath(gdir) break raise FileNotFoundError( f""" Please compile the "tractor.gschema.xml" file. In GNU/Linux you can copy it from "{os.path.dirname(os.path.abspath(__file__))}" to "{gschema_dir}" and run: "sudo glib-compile-schemas {gschema_dir}" """ ) conf = Gio.Settings.new(schema) return conf def get_val(key: str) -> bool | int | str: """ get the value of the key """ conf = dconf() match key: case "pid" | "socks-port" | "http-port" | "dns-port": return conf.get_int(key) case "exit-node" | "bridge-type": return conf.get_string(key) case "accept-connection" | "fascist-firewall" | "auto-set": return conf.get_boolean(key) case "upstream-proxy": return conf.get_value(key) case "pluggable-transport": path_list = conf.get_value(key) types = ["none", "vanilla", "obfs4", "snowflake", "conjure"] bridge_type = get_val("bridge-type") return path_list[types.index(bridge_type)] case _: raise TypeError(f"key is not supported: {key}") def set_val(key: str, value: bool | int | str) -> None: """ set a value for the key """ conf = dconf() match key: case "pid" | "socks-port" | "http-port" | "dns-port": conf.set_int(key, value) case "exit-node" | "bridge-type": conf.set_string(key, value) case "accept-connection" | "fascist-firewall" | "auto-set": conf.set_boolean(key, value) case "upstream-proxy": gvar = GLib.Variant("(ssi)", value) conf.set_value(key, gvar) case "pluggable-transport": path_list = list(conf.get_value(key)) types = ["none", "vanilla", "obfs4", "snowflake", "conjure"] bridge_type = get_val("bridge-type") path_list[types.index(bridge_type)] = value gvar = GLib.Variant("(sssss)", tuple(path_list)) conf.set_value(key, gvar) case _: raise TypeError("key is not supported") def reset(key: str) -> None: """ Reset a key """ dconf().reset(key) def data_directory() -> str: """ return the data directory for tractor """ return os.path.join(GLib.get_user_config_dir(), "tractor") tractor-5.1.0/src/tractor/proxy.py000066400000000000000000000070021477605775500172210ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi, 2020-2024 """ module for setting and removing proxy """ from os import environ from gi.repository import Gio from stem.util import term from . import checks, control, db no_color = environ["NO_COLOR"] if "NO_COLOR" in environ else 0 def proxy_set(verbose: bool = False) -> None: """ setup proxy """ if not checks.running(): print("Tractor is not running!") elif checks.proxy_set(): checks.verbose_print("Proxy is already set", verbose) else: proxy = Gio.Settings.new("org.gnome.system.proxy") mode, host, port = get_proxy() if mode in ["socks", "https", "http"]: db.set_val("upstream-proxy", (mode, host, port)) socks = Gio.Settings.new("org.gnome.system.proxy.socks") my_ip, socks_port = control.get_listener("socks") ignored = [ "localhost", "127.0.0.0/8", "::1", "192.168.0.0/16", "10.0.0.0/8", "172.16.0.0/12", ] socks.set_string("host", my_ip) socks.set_int("port", socks_port) proxy.set_string("mode", "manual") proxy.set_strv("ignore-hosts", ignored) checks.verbose_print( term.format( "Proxy has been set.", "", "" if no_color else term.Color.GREEN, ), verbose, ) def proxy_unset(verbose: bool = False) -> None: """ unset proxy """ if checks.proxy_set(): mode, host, port = tuple(db.get_val("upstream-proxy")) proxy = Gio.Settings.new("org.gnome.system.proxy") match mode: case "none": proxy.set_string("mode", "none") case "socks": proxy.set_string("mode", "manual") socks = Gio.Settings.new("org.gnome.system.proxy.socks") socks.set_string("host", host) socks.set_int("port", port) case "https": proxy.set_string("mode", "manual") https = Gio.Settings.new("org.gnome.system.proxy.https") https.set_string("host", host) https.set_int("port", port) case "http": proxy.set_string("mode", "manual") http = Gio.Settings.new("org.gnome.system.proxy.http") http.set_string("host", host) http.set_int("port", port) checks.verbose_print("Proxy unset", verbose) else: checks.verbose_print("Proxy is not set", verbose) def get_proxy() -> tuple[str, str, int]: """ get current proxy of system """ try: if checks.proxy_set(): return "none", "", 0 except ValueError: return "none", "", 0 proxy = Gio.Settings.new("org.gnome.system.proxy") if proxy.get_string("mode") == "manual": socks = Gio.Settings.new("org.gnome.system.proxy.socks") host = socks.get_string("host") port = socks.get_int("port") if host and port: return "socks", host, port https = Gio.Settings.new("org.gnome.system.proxy.https") host = https.get_string("host") port = https.get_int("port") if host and port: return "https", host, port http = Gio.Settings.new("org.gnome.system.proxy.http") host = http.get_string("host") port = http.get_int("port") if host and port: return "http", host, port return "none", "", 0 tractor-5.1.0/src/tractor/tractor.gschema.xml000066400000000000000000000053671477605775500213100ustar00rootroot00000000000000 false Auto set proxy Automatically set proxy on system after successful connection "ww" Exit Node The country you want to connect from 9052 Socks Port Local port on which Tractor would be listen 9053 DNS Port Local port on which you would have an anonymous name server 9080 HTTP Port Local port on which Tractor HTTP tunnel would be listen 0 Proccess ID PID of the running Tractor proccess for user "none" Bridge Type Type of the tor bridge to use from false Accept Connection Whether or not allowing external devices to use this network false Fascist Firewall Allow to run Tor as a client behind a firewall with restrictive policies ("", "", "/usr/bin/obfs4proxy", "/usr/bin/snowflake-client", "/usr/bin/conjure-client") Pluggable Transport Files Path of executables for (none, vanilla, obfs, snowflake, conjure) ("none", "", 0) Upstream proxy Mode, host and port of the upstream proxy tractor-5.1.0/src/tractor/tractor.py000066400000000000000000000010761477605775500175230ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi, 2020-2024. """ main front file for tractor """ import fire from . import actions, proxy def main() -> None: """ use fire to manage cli """ fire.Fire( { "start": actions.start, "stop": actions.stop, "newid": actions.new_id, "restart": actions.restart, "set": proxy.proxy_set, "unset": proxy.proxy_unset, "killtor": actions.kill_tor, } ) if __name__ == "__main__": main() tractor-5.1.0/src/tractor/tractorrc.py000066400000000000000000000107761477605775500200570ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2020-2024. """ this module creates tractorrc file """ import os import tempfile from . import bridges, db, proxy def _get_upstream_line() -> str: """ set upstream proxy if available """ mode, host, port = proxy.get_proxy() match mode: case "socks": return f"Socks5Proxy {host}:{port}\n" case "https" | "http": return f"HTTPSProxy {host}:{port}\n" return "" def _get_port_lines() -> str: """ Get torrc lines for different ports """ if db.get_val("accept-connection"): my_ip = "0.0.0.0" socks_line = f"SocksPort {my_ip}:{str(db.get_val('socks-port'))}\n" socks_line += "SocksPolicy accept *\n" else: my_ip = "127.0.0.1" socks_line = f"SocksPort {my_ip}:{str(db.get_val('socks-port'))}\n" http_line = f"HTTPTunnelPort {my_ip}:{str(db.get_val('http-port'))}\n" dns_line = f"DNSPort {my_ip}:{str(db.get_val('dns-port'))}\n" dns_line += "AutomapHostsOnResolve 1\n" dns_line += "AutomapHostsSuffixes .exit,.onion\n" return f"{socks_line}{http_line}{dns_line}" def _get_path_lines() -> str: """ Get torrc lines for different pathes """ data_dir = db.data_directory() path_line = f"DataDirectory {data_dir}\n" path_line += f"ControlSocket {data_dir}/control.sock\n" return path_line def _get_exit_lines() -> str: """ Get torrc lines for exit nodes """ exit_node = db.get_val("exit-node") if exit_node != "ww": return f"ExitNodes {'{'}{exit_node}{'}'}\n" "StrictNodes 1\n" return "" def _fill_bridge_lines(bridge_type: str, my_bridges: str) -> str: """ Fill the bridge-related lines for torrc """ bridge_line = "UseBridges 1\n" match bridge_type: case "vanilla": pass case "obfs4": path = db.get_val("pluggable-transport") bridge_line += ( "ClientTransportPlugin meek_lite,obfs2,obfs3," f"obfs4,scramblesuit,webtunnel exec {path}\n" ) case "snowflake": path = db.get_val("pluggable-transport") broker = "snowflake-broker.torproject.net.global.prod.fastly.net" bridge_line += f"ClientTransportPlugin snowflake exec {path} " bridge_line += f"-url https://{broker}/ -front foursquare.com " bridge_line += ( "-ice stun:stun.l.google.com:19302,stun:stun.antisip.com:3478," "stun:stun.bluesip.net:3478,stun:stun.dus.net:3478," "stun:stun.epygi.com:3478,stun:stun.sonetel.net:3478," "stun:stun.uls.co.za:3478,stun:stun.voipgate.com:3478," "stun:stun.voys.nl:3478\n" ) case "conjure": path = db.get_val("pluggable-transport") reg_url = "https://registration.refraction.network/api" bridge_line += f"ClientTransportPlugin conjure exec {path} " bridge_line += f"-registerURL {reg_url}\n" case _: raise ValueError("Bridge type is not supported") for line in my_bridges: bridge_line += f"Bridge {line}\n" return bridge_line def _get_bridge_lines() -> str: """ Get torrc lines for bridges """ bridge_type = db.get_val("bridge-type") if bridge_type != "none": with open(bridges.get_file(), encoding="utf-8") as file: my_bridges = file.read() my_bridges = bridges.relevant_lines(my_bridges, bridge_type) if not my_bridges: raise EnvironmentError("No relevant bridges given") bridge_lines = _fill_bridge_lines(bridge_type, my_bridges) return bridge_lines return "" def create() -> (str, str): """ main function of the module """ upstream_lines = _get_upstream_line() port_lines = _get_port_lines() path_lines = _get_path_lines() exit_lines = _get_exit_lines() fascist_fw = db.get_val("fascist-firewall") bridge_lines = _get_bridge_lines() tmpdir = tempfile.mkdtemp() path = os.path.join(tmpdir, "tractorrc") with open(path, "w", encoding="utf-8") as file: if upstream_lines: file.write(upstream_lines) file.write(port_lines) file.write(path_lines) if exit_lines: file.write(exit_lines) if bridge_lines: file.write(bridge_lines) if fascist_fw: file.write("FascistFirewall 1\n") os.chmod(path=path, mode=0o600) return tmpdir, path tractor-5.1.0/tests/000077500000000000000000000000001477605775500143645ustar00rootroot00000000000000tractor-5.1.0/tests/test_actions.py000066400000000000000000000225751477605775500174500ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2024. """ unit tests for actions """ import signal import unittest from unittest.mock import patch, MagicMock from tractor import actions class MsgHandler(unittest.TestCase): """ test case for message handlers """ @patch("builtins.print") def test_print_bootstrap_lines_no(self, mock_print): """ should not print """ actions._print_bootstrap_lines("line") mock_print.assert_not_called() @patch("builtins.print") def test_print_bootstrap_lines_yes(self, mock_print): """ should print """ actions._print_bootstrap_lines("Bootstrapped line") mock_print.assert_called_once_with( "\x1b[34mBootstrapped line\x1b[0m", flush=True ) @patch("builtins.print") def test_print_all_lines(self, mock_print): """ should print """ actions._print_all_lines("line") mock_print.assert_called_once_with("\x1b[34mline\x1b[0m", flush=True) class FinishNotification(unittest.TestCase): """ test case for _finish_notification """ @patch("tractor.checks.running", return_value=False) @patch("sys.stdout") @patch("tractor.checks.verbose_print") def test_finish_notification_fail(self, mock_verbose_print, *_): """ couldn't connect """ actions._finish_notification(verbose=False) mock_verbose_print.assert_not_called() @patch("stem.util.term.format", return_value="connected") @patch("tractor.checks.running", return_value=True) @patch("tractor.db.get_val", return_value=True) @patch("tractor.proxy.proxy_set") @patch("tractor.checks.verbose_print") def test_finish_notification_done( self, mock_verbose_print, mock_proxy_set, *_ ): """ connection is successful and proxy is auto-set """ actions._finish_notification(verbose=False) mock_verbose_print.assert_called_once_with("connected", False) mock_proxy_set.assert_called_once_with(False) @patch("stem.util.term.format", return_value="connected") @patch("tractor.checks.running", return_value=True) @patch("tractor.db.get_val", return_value=False) @patch("tractor.proxy.proxy_set") @patch("tractor.checks.verbose_print") def test_finish_notification_done_no_auto_set( self, mock_verbose_print, mock_proxy_set, *_ ): """ connection is successful and proxy is not auto-set """ actions._finish_notification(verbose=False) mock_proxy_set.assert_not_called() self.assertEqual(mock_verbose_print.call_count, 2) class Launch(unittest.TestCase): """ test case for _launch """ @patch("os.rmdir") @patch("os.remove") @patch("sys.stdout") @patch("os.path.exists", return_value=False) @patch("tractor.actions.launch_tor", side_effect=OSError) @patch("tractor.actions._finish_notification") def test_launch_os_error(self, mock_finish, *_): """ Couldn't launch """ actions._launch("torrc", "tmpdir", False) mock_finish.assert_not_called() @patch("os.rmdir") @patch("os.remove") @patch("os.path.exists", return_value=False) @patch("tractor.actions.launch_tor", side_effect=KeyboardInterrupt) @patch("tractor.actions._finish_notification") def test_launch_interrupt(self, mock_finish, *_): """ Keyboard interrupt """ actions._launch("torrc", "tmpdir", False) mock_finish.assert_not_called() @patch("os.rmdir") @patch("os.remove") @patch("os.path.exists", return_value=True) @patch("tractor.db.set_val") @patch("tractor.actions.launch_tor") @patch("tractor.actions.rmtree") @patch("tractor.actions._finish_notification") def test_launch_ok( self, mock_finish, mock_rmtree, mock_launch_tor, mock_set_val, *_ ): """ successful """ # Arrange mock_process = MagicMock() mock_process.pid = 12345 mock_launch_tor.return_value = mock_process # Act actions._launch("torrc", "tmpdir", False) # Assert mock_finish.assert_called_once_with(False) mock_set_val.assert_called_once_with("pid", 12345) mock_rmtree.assert_called_once_with("tmpdir", ignore_errors=True) class StartLaunch(unittest.TestCase): """ test case for _start_launch """ @patch("sys.stdout") @patch("os.makedirs") @patch("tractor.tractorrc.create", side_effect=ValueError) @patch("tractor.actions._launch") def test_start_launch_value_error(self, mock_launch, *_): """ configuration error """ actions._start_launch(verbose=False) mock_launch.assert_not_called() @patch("sys.stdout") @patch("os.makedirs") @patch("tractor.tractorrc.create", side_effect=EnvironmentError) @patch("tractor.actions._launch") def test_start_launch_env_error(self, mock_launch, *_): """ no bridge """ actions._start_launch(verbose=False) mock_launch.assert_not_called() @patch("sys.stdout") @patch("os.makedirs") @patch("tractor.tractorrc.create", return_value=("a", "b")) @patch("tractor.actions._launch") def test_start_launch_success(self, mock_launch, *_): """ starting launch """ actions._start_launch(verbose=False) mock_launch.assert_called_once_with("b", "a", False) class Start(unittest.TestCase): """ test case for start """ @patch("tractor.checks.running", return_value=False) @patch("tractor.actions._start_launch") def test_start_do(self, mock_launch, *_): """ tractor is not running """ actions.start() mock_launch.assert_called_once() @patch("sys.stdout") @patch("tractor.checks.running", return_value=True) @patch("tractor.actions._start_launch") def test_start_dont(self, mock_launch, *_): """ tractor is already running """ actions.start() mock_launch.assert_not_called() class Stop(unittest.TestCase): """ test case for stop """ @patch("stem.util.term.format", return_value="Tractor stopped") @patch("tractor.checks.running", return_value=True) @patch("tractor.db.reset") @patch("tractor.control.send_signal") @patch("stem.connection.connect") @patch("tractor.checks.verbose_print") def test_stop_do(self, mock_verbose_print, *_): """ tractor is already running """ actions.stop() mock_verbose_print.assert_called_with("Tractor stopped", False) @patch("stem.util.term.format", return_value="Tractor is stopped") @patch("tractor.checks.running", return_value=False) @patch("tractor.checks.verbose_print") def test_stop_dont(self, mock_verbose_print, *_): """ tractor is not running """ actions.stop() mock_verbose_print.assert_called_once_with("Tractor is stopped", False) class Restart(unittest.TestCase): """ test case for restart """ @patch("tractor.actions.stop") @patch("tractor.actions.start") def test_restart(self, mock_start, mock_stop): """ test restart """ actions.restart() mock_stop.assert_called_once() mock_start.assert_called_once() class NewId(unittest.TestCase): """ test case for new_id """ @patch("sys.stdout") @patch("tractor.checks.running", return_value=False) @patch("tractor.control.send_signal") def test_new_id_not_running(self, mock_send_signal, mock_running, *_): """ tractor is not running """ actions.new_id() mock_running.assert_called_once() mock_send_signal.assert_not_called() @patch("stem.util.term.format", return_value="You have a new ID") @patch("tractor.checks.running", return_value=True) @patch("tractor.control.send_signal") @patch("tractor.checks.verbose_print") def test_new_id_running(self, mock_verbose_print, mock_send_signal, *_): """ tractor is running """ actions.new_id() mock_send_signal.assert_called_once_with("newnym") mock_verbose_print.assert_called_once_with("You have a new ID", False) class KillTor(unittest.TestCase): """ test case for kill_tor """ @patch("stem.util.term.format", return_value="No process to kill") @patch("tractor.control.get_pid", return_value=None) @patch("os.killpg") @patch("tractor.checks.verbose_print") def test_kill_tor_not_running(self, mock_verbose_print, mock_killpg, *_): """ tractor is not running """ actions.kill_tor() mock_killpg.assert_not_called() mock_verbose_print.assert_called_once_with("No process to kill", False) @patch("stem.util.term.format", return_value="Process killed") @patch("tractor.control.get_pid", return_value=5734) @patch("os.getpgid", return_value=1234) @patch("tractor.db.reset") @patch("os.killpg") @patch("tractor.checks.verbose_print") def test_kill_tor_running(self, mock_verbose_print, mock_killpg, *_): """ tractor is running """ actions.kill_tor() mock_killpg.assert_called_once_with(1234, signal.SIGTERM) mock_verbose_print.assert_called_once_with("Process killed", False) tractor-5.1.0/tests/test_bridges.py000066400000000000000000000125651477605775500174250ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2024. """ Unit tests for bridges """ import unittest from unittest.mock import patch from tractor import bridges class GetSampleBridges(unittest.TestCase): """ Testcase for get_sample_bridges """ def test_get_sample_bridges(self): """ Test get_sample_bridges """ result = bridges.get_sample_bridges() self.assertTrue(result.endswith("/SampleBridges")) class CopySampleBridges(unittest.TestCase): """ Testcase for copy_sample_bridges """ @patch("os.chmod") @patch("shutil.copyfile") def test_copy_done(self, mock_copyfile, mock_chmod): """ Test copy_sample_bridges """ with patch( "tractor.bridges.get_sample_bridges", return_value="/path/to/module/SampleBridges", ): bridges.copy_sample_bridges("/path/to/destination") mock_copyfile.assert_called_once_with( "/path/to/module/SampleBridges", "/path/to/destination", ) mock_chmod.assert_called_once_with("/path/to/destination", 0o600) @patch( "shutil.copyfile", side_effect=FileNotFoundError("Simulated copy error"), ) def test_copy_failed(self, mock_copyfile): """ When copy fails """ with patch( "tractor.bridges.get_sample_bridges", return_value="/path/to/module/SampleBridges", ): with self.assertRaises(IOError): bridges.copy_sample_bridges("/path/to/destination") mock_copyfile.assert_called_once_with( "/path/to/module/SampleBridges", "/path/to/destination", ) class GetFile(unittest.TestCase): """ TestCase for get_file """ @patch("tractor.db.data_directory", return_value="/path/to/data") @patch("os.makedirs") @patch("os.path.isfile", return_value=False) @patch("tractor.bridges.copy_sample_bridges") def test_file_doesnt_exists(self, mock_copy, *_): """ bridge file does not exist """ self.assertEqual(bridges.get_file(), "/path/to/data/Bridges") mock_copy.assert_called_once_with("/path/to/data/Bridges") class RelevantLines(unittest.TestCase): """ Main class for testing bridges """ def setUp(self): """ initialize class """ super().setUp() self.lines = ( "obfs4 162.223.88.72:43565 " "FADC7451A08A3B9690E38137C440C209E6683409 " "cert=DYku/2U6MZXDSoE9fiLmgdldLbaPjhAjdxMWPMU0Of4BL54a1cT6QDQv8V1" "H3onvlG80SQ iat-mode=2\n" "obfs4 81.169.154.212:8181 " "C13FE89EC22ED9DC26BC4EA40740C0DEEDC4B0D9 " "cert=GT7NbRmPO+2ieNlAlbhp+VFG2lHnY2ABGXAF+eaSlcw3P/v4Gpc5gjexjcm" "x5/sI+XWFXA iat-mode=0\n" "188.121.110.127:9056 F3D627AFD9EB5E1B8843733B06EBC2D3B6BAB209\n" "209\n" "snowflake 82.36.31.1:1 4D6FEC29302160C16E03A3FDBA6FD0983CCF6D60\n" "webtunnel [2001:db8:9971:e9c7:2b64:916b:17f8:7775]:443 " "2F104EE04E1224CAFF6B8DFC62F83550CA2958DC " "url=https://learnstack.xyz/tohG1pieHieJ0eit43k ver=0.0.1\n" ) def test_vanilla(self): """ test vanilla bridge """ expected = [ "188.121.110.127:9056 F3D627AFD9EB5E1B8843733B06EBC2D3B6BAB209", ] self.assertEqual( bridges.relevant_lines(self.lines, "vanilla"), expected ) def test_obfs(self): """ test obfs4 bridge """ expected = [ "obfs4 162.223.88.72:43565 " "FADC7451A08A3B9690E38137C440C209E6683409 " "cert=DYku/2U6MZXDSoE9fiLmgdldLbaPjhAjdxMWPMU0Of4BL54a1cT6QDQv8V1" "H3onvlG80SQ iat-mode=2", "obfs4 81.169.154.212:8181 " "C13FE89EC22ED9DC26BC4EA40740C0DEEDC4B0D9 " "cert=GT7NbRmPO+2ieNlAlbhp+VFG2lHnY2ABGXAF+eaSlcw3P/v4Gpc5gjexjcm" "x5/sI+XWFXA iat-mode=0", "webtunnel [2001:db8:9971:e9c7:2b64:916b:17f8:7775]:443 " "2F104EE04E1224CAFF6B8DFC62F83550CA2958DC " "url=https://learnstack.xyz/tohG1pieHieJ0eit43k ver=0.0.1", ] self.assertEqual(bridges.relevant_lines(self.lines, "obfs4"), expected) def test_snowflake(self): """ test snowflake bridge """ expected = [ "snowflake 82.36.31.1:1 4D6FEC29302160C16E03A3FDBA6FD0983CCF6D60" ] self.assertEqual( bridges.relevant_lines(self.lines, "snowflake"), expected ) def test_webtunnel(self): """ test webtunnel bridge """ expected = [ "webtunnel [2001:db8:9971:e9c7:2b64:916b:17f8:7775]:443 " "2F104EE04E1224CAFF6B8DFC62F83550CA2958DC " "url=https://learnstack.xyz/tohG1pieHieJ0eit43k ver=0.0.1" ] self.assertEqual( bridges.relevant_lines(self.lines, "webtunnel"), expected ) class CreateEmoji(unittest.TestCase): """ TestCase for creating emojis from bridge lines """ def test_create_emoji(self): """ test the function """ line = "82.65.123.107:9001 5105C5FD49A1A8DEF6CD754F7657BDA13BA2A3FE" self.assertEqual(bridges.create_emoji(line), ["⏰", "🚚", "🎡", "🦌"]) tractor-5.1.0/tests/test_checks.py000066400000000000000000000147141477605775500172440ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2024. """ Unit tests for db """ import unittest import socket from unittest.mock import mock_open, patch, Mock from tractor import checks class Running(unittest.TestCase): """ test case for running """ @patch("tractor.control.get_pid", return_value=1234) @patch("stem.util.system.is_running", return_value=True) def test_success(self, mock_is_running, mock_get_pid): """ it is running """ result = checks.running() self.assertTrue(result) mock_get_pid.assert_called_once() mock_is_running.assert_called_with(1234) @patch("tractor.control.get_pid", return_value=None) def test_running_failure(self, mock_get_pid): """ it's not running """ result = checks.running() self.assertFalse(result) mock_get_pid.assert_called_once() class GetAddrInfoTestCase(unittest.TestCase): """ test casr for _getaddrinfo """ def test_getaddrinfo(self): """ test _getaddrinfo """ result = checks._getaddrinfo("example.com", 80) # Assert the structure of the result self.assertEqual(len(result), 1) self.assertIsInstance(result[0], tuple) self.assertEqual(len(result[0]), 5) # Assert the values in the result self.assertEqual(result[0][0], socket.AF_INET) self.assertEqual(result[0][1], socket.SOCK_STREAM) self.assertEqual(result[0][2], 6) # socket.IPPROTO_TCP self.assertEqual(result[0][3], "") self.assertEqual(result[0][4], ("example.com", 80)) class Fetched(unittest.TestCase): """ test case for _fetched """ @patch("tractor.control.get_listener") @patch("urllib.request.urlopen", side_effect=TimeoutError) def test_timeout(self, *_): """ timeout given """ self.assertFalse(checks._fetched()) @patch("tractor.control.get_listener", return_value=("127.0.0.1", 9052)) @patch("urllib.request.urlopen") def test_failed(self, mock_urlopen, *_): """ not using tor """ mock_response = mock_open( read_data="Sorry. You are not using Tor.".encode() ).return_value mock_response.status = 200 mock_urlopen.return_value = mock_response result = checks._fetched() self.assertFalse(result) mock_urlopen.assert_called_once_with("https://check.torproject.org/") @patch("tractor.control.get_listener", return_value=("127.0.0.1", 9052)) @patch("urllib.request.urlopen") def test_success(self, mock_urlopen, *_): """ connection successful """ mock_response = mock_open( read_data=( "Congratulations. This browser is configured to use Tor." ).encode() ).return_value mock_response.status = 200 mock_urlopen.return_value = mock_response result = checks._fetched() self.assertTrue(result) mock_urlopen.assert_called_once_with("https://check.torproject.org/") class Connected(unittest.TestCase): """ test case for connected """ @patch("tractor.checks.running", return_value=False) def test_fail(self, mock_running): """ not running """ result = checks.connected() self.assertFalse(result) mock_running.assert_called_once() @patch("tractor.checks.running", return_value=True) @patch("tractor.checks._fetched", return_value=True) def test_success(self, mock_fetched, mock_running): """ running """ result = checks.connected() self.assertTrue(result) mock_running.assert_called_once() mock_fetched.assert_called_once() class ProxySet(unittest.TestCase): """ test case for proxy_set """ @patch("gi.repository.Gio.Settings.new") def test_proxy_none(self, mock_gio_settings_new): """ proxy is not on manual """ mock_gio_settings_instance = Mock() mock_gio_settings_instance.get_string.return_value = "none" mock_gio_settings_new.return_value = mock_gio_settings_instance result = checks.proxy_set() self.assertFalse(result) mock_gio_settings_new.assert_called_with("org.gnome.system.proxy") mock_gio_settings_instance.get_string.assert_called_with("mode") @patch("tractor.control.get_listener", return_value=("127.0.0.1", 9052)) @patch("gi.repository.Gio.Settings.new") def test_proxy_fail(self, mock_settings, *_): """ proxy mismatch """ mock_settings_instance = Mock() mock_settings_instance.get_string.return_value = "manual" mock_settings_instance.get_int.return_value = 9050 mock_settings.return_value = mock_settings_instance result = checks.proxy_set() self.assertFalse(result) mock_settings.assert_called() mock_settings_instance.get_string.assert_called() mock_settings_instance.get_int.assert_called_with("port") @patch("tractor.control.get_listener", return_value=("127.0.0.1", 9052)) @patch("gi.repository.Gio.Settings.new") def test_proxy_set(self, mock_settings, *_): """ proxy is set """ mock_settings_instance = Mock() mock_settings_instance.get_string.side_effect = ( lambda key: "manual" if key == "mode" else "127.0.0.1" ) mock_settings_instance.get_int.return_value = 9052 mock_settings.return_value = mock_settings_instance result = checks.proxy_set() self.assertTrue(result) mock_settings.assert_called() mock_settings_instance.get_string.assert_called() mock_settings_instance.get_int.assert_called_with("port") class Verbose(unittest.TestCase): """ test case for verbose functions """ def test_verbose_print(self): """ print """ with patch("builtins.print") as mock_print: checks.verbose_print("Test Message", verbose=True) mock_print.assert_called_once_with("Test Message") def test_verbose_return(self): """ return """ result = checks.verbose_return(True, False, verbose=True) self.assertFalse(result) def test_nonverbose_return(self): """ return """ result = checks.verbose_return(True, False, verbose=False) self.assertTrue(result) tractor-5.1.0/tests/test_control.py000066400000000000000000000060521477605775500174600ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2024. """ Unit tests for db """ import unittest from unittest.mock import patch, MagicMock from tractor import control class SendSignal(unittest.TestCase): """ test case for send_signal """ @patch("tractor.control._get_controller") def test_send_signal_term(self, mock_get_controller, *_): """ send defined signals """ # Arrange mock_controller = MagicMock() mock_get_controller.return_value = mock_controller # Act & Assert control.send_signal("term") mock_controller.signal.assert_called_once_with("TERM") @patch("tractor.control._get_controller") def test_send_signal_newnym(self, mock_get_controller, *_): """ send defined signals """ # Arrange mock_controller = MagicMock() mock_get_controller.return_value = mock_controller # Act & Assert control.send_signal("newnym") mock_controller.signal.assert_called_once_with("NEWNYM") @patch("tractor.control._get_controller", return_value=True) def test_send_signal_fail(self, *_): """ undefined signal """ with self.assertRaises(ValueError): control.send_signal("kill") class GetListener(unittest.TestCase): """ test case for get_listener """ @patch("tractor.control._get_controller") def test_get_listener_success(self, mock_get_controller, *_): """ get listener of any type """ # Arrange mock_controller = MagicMock() mock_controller.get_listeners.return_value = [9052] mock_get_controller.return_value = mock_controller # Act result = control.get_listener("socks") # Assert mock_get_controller.assert_called_once() mock_controller.get_listeners.assert_called_once_with("socks") self.assertEqual(result, 9052) @patch("tractor.control._get_controller", return_value = False) def test_get_listener_fail(self, *_): """ get listener of any type """ # Act & Assert with self.assertRaises(ValueError): control.get_listener("ftp") class GetPid(unittest.TestCase): """ test case for get_pid """ @patch("tractor.control._get_controller") def test_get_pid_success(self, mock_get_controller, *_): """ Test get_pid returns a valid PID when controller is available. """ # Arrange mock_controller = MagicMock() mock_controller.get_pid.return_value = 5678 mock_get_controller.return_value = mock_controller # Act result = control.get_pid() # Assert self.assertEqual(result, 5678) @patch("tractor.control._get_controller", return_value = False) def test_get_pid_fail(self, *_): """ Test get_pid returns 0 when no controller is returned. """ # Act result = control.get_pid() # Assert self.assertEqual(result, 0) tractor-5.1.0/tests/test_db.py000066400000000000000000000131011477605775500163560ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2024. """ Unit tests for db """ import unittest from unittest.mock import patch, Mock from tractor import db class Dconf(unittest.TestCase): """ test case for dconf """ @patch("gi.repository.Gio.SettingsSchemaSource.lookup", return_value=False) def test_absent(self, *_): """ if dconf is not installed """ with self.assertRaises(FileNotFoundError): db.dconf() @patch("gi.repository.Gio.SettingsSchemaSource.lookup", return_value=True) @patch("gi.repository.Gio.Settings.new") def test_present(self, mock_settings, *_): """ if dconf is installed """ mock_settings_instance = Mock() mock_settings.return_value = mock_settings_instance result = db.dconf() mock_settings.assert_called_once() self.assertIs(result, mock_settings_instance) class GetVal(unittest.TestCase): """ test case for get_val """ @patch("tractor.db.dconf") def test_int(self, mock_dconf): """ get an int value """ mock_get_int = Mock() mock_dconf.return_value.get_int = mock_get_int key = "socks-port" db.get_val(key) mock_get_int.assert_called_once_with(key) @patch("tractor.db.dconf") def test_string(self, mock_dconf): """ get a string value """ mock_get_string = Mock() mock_dconf.return_value.get_string = mock_get_string key = "exit-node" db.get_val(key) mock_get_string.assert_called_once_with(key) @patch("tractor.db.dconf") def test_boolean(self, mock_dconf): """ get a boolean value """ mock_get_boolean = Mock() mock_dconf.return_value.get_boolean = mock_get_boolean key = "accept-connection" db.get_val(key) mock_get_boolean.assert_called_once_with(key) @patch("tractor.db.dconf") def test_pluggable_transport(self, mock_dconf): """ get pluggable-transport """ mock_get_value = Mock() mock_dconf.return_value.get_value = mock_get_value mock_get_value.return_value = [1, 2, 3] mock_get_string = Mock() mock_dconf.return_value.get_string = mock_get_string mock_get_string.return_value = "vanilla" key = "pluggable-transport" result = db.get_val(key) mock_get_value.assert_called_once_with(key) mock_get_string.assert_called_once_with("bridge-type") self.assertEqual(result, 2) def test_invalid(self): """ get invalid key """ with self.assertRaises(TypeError): try: db.get_val("pi") except (FileNotFoundError, TypeError): with patch("tractor.db.dconf"): db.get_val("pi") class SetVal(unittest.TestCase): """ test case for set_val """ @patch("tractor.db.dconf") def test_int(self, mock_dconf): """ set an int value """ mock_set_int = Mock() mock_dconf.return_value.set_int = mock_set_int key = "http-port" value = 9080 db.set_val(key, value) mock_set_int.assert_called_once_with(key, value) @patch("tractor.db.dconf") def test_string(self, mock_dconf): """ set a string value """ mock_set_string = Mock() mock_dconf.return_value.set_string = mock_set_string key = "exit-node" value = "ww" db.set_val(key, value) mock_set_string.assert_called_once_with(key, value) @patch("tractor.db.dconf") def test_boolean(self, mock_dconf): """ set a boolean value """ mock_set_boolean = Mock() mock_dconf.return_value.set_boolean = mock_set_boolean key = "accept-connection" value = True db.set_val(key, value) mock_set_boolean.assert_called_once_with(key, value) @patch("tractor.db.get_val", return_value="vanilla") @patch("tractor.db.dconf") def test_pluggable_transport(self, mock_dconf, *_): """ set pluggable transport """ mock_set_value = Mock() mock_dconf.return_value.set_value = mock_set_value mock_dconf.return_value.get_value.return_value = ( "1", "2", "3", "4", "5", ) key = "pluggable-transport" value = "6" db.set_val(key, value) mock_set_value.assert_called_once() def test_invalid(self): """ set invalid value """ with self.assertRaises(TypeError): try: db.set_val("pi", 3.14) except (FileNotFoundError, TypeError): with patch("tractor.db.dconf"): db.set_val("pi", 3.14) class Reset(unittest.TestCase): """ TestCase for reset """ @patch("tractor.db.dconf") def test_reset(self, mock_dconf): """ resetting a key """ mock_reset_method = Mock() mock_dconf.return_value.reset = mock_reset_method db.reset("socks-port") mock_reset_method.assert_called_once_with("socks-port") class DataDirectory(unittest.TestCase): """ TestCase for get_file """ @patch( "gi.repository.GLib.get_user_config_dir", return_value="/path/to/data" ) def test_data_directory(self, *_): """ correct adding of `tractor` """ self.assertEqual(db.data_directory(), "/path/to/data/tractor") tractor-5.1.0/tests/test_tractorrc.py000066400000000000000000000070741477605775500200100ustar00rootroot00000000000000# Released under GPLv3+ License # Danial Behzadi , 2024. """ unit tests for tractorrc """ import unittest from unittest.mock import patch from tractor import tractorrc class GetExitLines(unittest.TestCase): """ test case for _get_exit_lines """ @patch("tractor.db.get_val", return_value="ww") def test_auto(self, *_): """ auto exit node """ self.assertEqual(tractorrc._get_exit_lines(), "") @patch("tractor.db.get_val", return_value="us") def test_us(self, *_): """ specific exit node """ self.assertEqual( tractorrc._get_exit_lines(), "ExitNodes {us}\nStrictNodes 1\n" ) class FillBridgeLines(unittest.TestCase): """ test case for _fill_bridge_lines """ @patch("tractor.db.get_val", return_value="obfs4proxy") def test_obfs(self, *_): """ obfs lines """ self.assertEqual( tractorrc._fill_bridge_lines("obfs4", ["line1", "line2"]), "UseBridges 1\n" + "ClientTransportPlugin meek_lite,obfs2,obfs3,obfs4,scramblesuit" + ",webtunnel exec obfs4proxy\n" + "Bridge line1\n" + "Bridge line2\n", ) @patch("tractor.db.get_val", return_value="snowflake") def test_snowflake(self, *_): """ obfs lines """ self.assertEqual( tractorrc._fill_bridge_lines("snowflake", ["line1", "line2"]), "UseBridges 1\n" + "ClientTransportPlugin snowflake exec snowflake " + "-url https://snowflake-broker.torproject.net.global.prod." + "fastly.net/ -front foursquare.com -ice " + "stun:stun.l.google.com:19302,stun:stun.antisip.com:3478," + "stun:stun.bluesip.net:3478,stun:stun.dus.net:3478," + "stun:stun.epygi.com:3478,stun:stun.sonetel.net:3478," + "stun:stun.uls.co.za:3478,stun:stun.voipgate.com:3478," + "stun:stun.voys.nl:3478\n" + "Bridge line1\n" + "Bridge line2\n", ) def test_bad_type(self, *_): """ bad bridge typr """ with self.assertRaises(ValueError): tractorrc._fill_bridge_lines(0, "line") class GetBridgeLines(unittest.TestCase): """ test case for _get_bridge_lines """ @patch("tractor.db.get_val", return_value=2) @patch("tractor.bridges.relevant_lines", return_value=None) def test_no_bridge(self, *_): """ No relevant bridges found """ with self.assertRaises(EnvironmentError): tractorrc._get_bridge_lines() class Create(unittest.TestCase): """ test case for create """ @patch("tractor.tractorrc._get_upstream_line", return_value="") @patch("tractor.db.get_val", return_value="none") @patch("os.chmod") def test_local(self, *_): """ local connection """ tmpdir, path = tractorrc.create() self.assertTrue(tmpdir.startswith("/tmp/")) self.assertTrue(path.endswith("/tractorrc")) @patch("tractor.tractorrc._get_bridge_lines", return_value=None) @patch("tractor.tractorrc._get_upstream_line", return_value="") @patch("tractor.bridges.relevant_lines", return_value=None) @patch("tractor.db.get_val", return_value=True) @patch("os.chmod") def test_network(self, *_): """ listen on network """ tmpdir, path = tractorrc.create() self.assertTrue(tmpdir.startswith("/tmp/")) self.assertTrue(path.endswith("/tractorrc"))