Skip to main content

An Onion Router descriptor generator

Project description

An Onion Router descriptor generator

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

This tool is meant to be used to generate mock descriptors for testing or fuzzing other Tor libraries and programs, such as Stem, BridgeDB, and Tor. The keys, hash digests, and signatures generated within these mock descriptors are meant to be indistinguishable from those generated by real relays, bridges, and Hidden Services within the Tor network.

authors:Isis Lovecruft <>
licence:MIT licence, see LICENSE file for details
copyright:© 2013-2016 Isis Lovecruft, The Tor Project, Inc.


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
$ cd leekspin
$ python install --record installed-files.txt


Leekspin will install a script named… leekspin. To use it to generate twenty-three Bridge descriptors, do:

$ leekspin --bridge -n 23

And to generate forty-two Relay descriptors:

$ leekspin --relay -n 42

And, likewise, to generate ten hidden service descriptors, do:

$ leekspin --hidden-service -n 10

Commandline Flags

$ leekspin -h
usage: leekspin [-h] [[-v | -q] [--version] [-r | -b | -hs] [-n DESCRIPTORS]

Generate a signed set of network-status, extra-info, and server descriptor
documents for mock Tor relays or bridges.

Optional arguments:

-h, --help show this help message and exit
-v, --verbose print information to stdout
-q, --quiet don’t print anything
--version print leekspin version and exit

Descriptor types:

-r, --relay generate Relay descriptors
-b, --bridge generate Bridge descriptors
-hs, --hidden-service
 generate Hidden Service rendezvous descriptors

Descriptor variations:

-xt, --without-tap
 generate descriptors without TAP support, e.g. without RSA keys
-xn, --without-ntor
 generate descriptors without ntor support, e.g. without Ed25519 keys

Required arguments:

 generate <n> sets of descriptors


Should you decide to use this tool, and especially should you be so insane as 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 on our issue tracker here .

Project details

Download files

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

Source Distributions (44.2 kB view hashes)

Uploaded source

leekspin-2.1.1.tar.gz (35.7 kB view hashes)

Uploaded source

Built Distribution

leekspin-2.1.1-py2.7.egg (89.0 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page