Skip to main content

An Onion Router descriptor generator

Project description

Leekspin (á la the original internet masterpiece ) is a small tool for generating mocked Onion Router (OR) descriptors, such as those used by relays and bridges within Tor in order to convey information about said relay/bridge to the Tor directory authorities, the bridge authority, and Tor clients connecting to the network.

This library is meant to be used to generate mock descriptors for testing other Tor libraries and programs, such as Stem and BridgeDB .

The keys, hash digests, and signatures generated within these mock descriptors are meant to be indistinguishable from those generated by real relays and bridges within the Tor network.

Installing

The very simplest way, if you use pip , would be to do:

$ pip install leekspin

Otherwise, the standard setuptools commands work just fine:

$ git clone https://github.com/isislovecruft/leekspin.git
$ cd leekspin
$ python setup.py install --record installed-files.txt

Running

Leekspin will install a script named… leekspin. To use it to generate 20 bridge descriptors, do:

$ leekspin -n 20

And to generate 20 relay descriptors:

$ leekspin -r -n 20

Bugs

Should you decide to use this tool, and especially should you be so insane and to try hacking on it, you will likely find bugs. You may find bugs in Leekspin, BridgeDB, Stem, Tor’s specifications , and possibly even in Tor. Please, for math’s sake! Report them! The Tor developers will love you forever. You can report bugs here on our issue tracker .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

leekspin-1.1.3.tar.gz (22.8 kB view hashes)

Uploaded Source

Built Distribution

leekspin-1.1.3-py2.7.egg (64.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page