https://github.com/marten4n6/tinytor
A tiny Tor client implementation (in pure python).
https://github.com/marten4n6/tinytor
anonymity privacy python tor
Last synced: 20 days ago
JSON representation
A tiny Tor client implementation (in pure python).
- Host: GitHub
- URL: https://github.com/marten4n6/tinytor
- Owner: Marten4n6
- License: gpl-3.0
- Created: 2018-10-09T11:42:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-06T03:26:08.000Z (over 1 year ago)
- Last Synced: 2025-03-27T14:54:58.557Z (about 1 month ago)
- Topics: anonymity, privacy, python, tor
- Language: Python
- Homepage:
- Size: 171 KB
- Stars: 133
- Watchers: 5
- Forks: 28
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
TinyTor
A tiny Tor client implementation (in pure python).
---
**This implementation is NOT FINISHED YET.**
TinyTor can be used to communicate with [onion services](https://www.torproject.org/docs/onion-services.html) via [Tor](https://www.torproject.org/about/overview#thesolution).
It may be used by developers as a [python package](https://pypi.org/project/tinytor/) or as a command line utility.
The goals are to have **no dependencies**, live in a **single file** and be **as small as possible**.
The current file size of TinyTor is only ~37KB (uncompressed).
**Some warnings**:
- TinyTor assumes OpenSSL is installed on the running machine (native on Linux/macOS)
- This project is **not** related to the official Tor Project
- For anything dependent on your privacy, please use the [Tor Browser](https://www.torproject.org/download/download-easy.html) or [Tails OS](https://tails.boum.org/)
## How To Use
```bash
# Install TinyTor
$ sudo pip3 install tinytor
# Send a HTTP request over Tor
$ tinytor --host example.onion --verbose
```
### From Source
```bash
# Download or clone this repository
$ git clone https://github.com/Marten4n6/TinyTor
# Go into the repository
$ cd TinyTor
# Send a HTTP request over Tor
$ python tinytor.py --host example.onion --verbose
```
### For Developers
```python
from tinytor import TinyTor
tor = TinyTor()
print(tor.http_get("example.onion"))
```
## Motivation
TinyTor was created to communicate anonymously in [EvilOSX](https://github.com/Marten4n6/EvilOSX).
[compressed.py](https://github.com/Marten4n6/TinyTor/blob/master/compressed.py) is used in EvilOSX, which compresses TinyTor to a *much* smaller size (about ~9KB).
## Versioning
TinyTor will be maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the follow format:
```
..
```
And constructed with the following guidelines:
- Breaking backward compatibility bumps the major
- New additions without breaking backward compatibility bumps the minor
- Bug fixes and misc changes bump the patch
For more information on SemVer, please visit https://semver.org/.
## Support Tor
The Tor network relies on volunteers to donate bandwidth.
Please consider running a relay. You can help make the Tor network:
- faster (and therefore more usable)
- more robust against attacks
- more stable in case of outages
- safer for its users (spying on more relays is harder than on a few)
For more information on volunteering, please visit https://www.torproject.org/getinvolved/volunteer.html.
## Issues
Feel free to submit any issues [here](https://github.com/Marten4n6/TinyTor/issues).
## References
- [Tor Protocol Specification](https://gitweb.torproject.org/torspec.git/tree/tor-spec.txt)
- [Tor: The Second-Generation Onion Router](https://svn.torproject.org/svn/projects/design-paper/tor-design.html)
- [Mini-tor](https://github.com/wbenny/mini-tor)
- [Pycepa](https://github.com/pycepa/pycepa)
- [Struct](https://docs.python.org/3/library/struct.html)
- How Tor Works: Part
[1](https://jordan-wright.com/blog/2015/02/28/how-tor-works-part-one/),
[2](https://jordan-wright.com/blog/2015/05/09/how-tor-works-part-two-relays-vs-bridges/),
[3](https://jordan-wright.com/blog/2015/05/14/how-tor-works-part-three-the-consensus/)
- Logo created by [motusora](https://www.behance.net/motusora)
## License
[GPLv3](https://github.com/Marten4n6/TinyTor/blob/master/LICENSE.txt)