[tor-commits] [bridgedb/master] Use stem instead of leekspin to make descriptors.
phw at torproject.org
phw at torproject.org
Tue Aug 20 16:56:57 UTC 2019
commit ed37530c24fbf8ef80c7976ee4da1b667e9ba725
Author: Philipp Winter <phw at nymity.ch>
Date: Tue Jun 11 16:02:15 2019 -0700
Use stem instead of leekspin to make descriptors.
Stem now provides the ability to create and sign descriptors, so
there's no reason to use leekspin anymore. Stem is faster at creating
descriptors and we're already heavily depending on stem anyway.
This patch improves the preliminary work that Isis Lovecruft and
Damian Johnson already did. Some code in this patch was taken from
leekspin.
This fixes bug 22755: <https://bugs.torproject.org/22755>
---
.test.requirements.txt | 1 -
.travis.requirements.txt | 1 -
CHANGELOG | 4 +
README.rst | 6 +-
bridgedb/main.py | 10 +-
bridgedb/runner.py | 37 +-----
doc/HACKING.md | 10 +-
scripts/create_descriptors | 298 +++++++++++++++++++++++++++++++++++++++++++++
scripts/setup-tests | 2 +-
setup.py | 2 +-
10 files changed, 316 insertions(+), 55 deletions(-)
diff --git a/.test.requirements.txt b/.test.requirements.txt
index c84fb58..ad5342f 100644
--- a/.test.requirements.txt
+++ b/.test.requirements.txt
@@ -6,7 +6,6 @@
# $ make coverage
#
coverage==4.2
-git+https://git.torproject.org/user/phw/leekspin.git@d34c804cd0f01af5206833e62c0dedec8565b235#egg=leekspin
mechanize==0.2.5
pep8==1.5.7
# pylint must be pinned until pylint bug #203 is fixed. See
diff --git a/.travis.requirements.txt b/.travis.requirements.txt
index 2d56b79..e6eaf10 100644
--- a/.travis.requirements.txt
+++ b/.travis.requirements.txt
@@ -15,7 +15,6 @@
#------------------------------------------------------------------------------
coverage==4.2
coveralls==1.2.0
-git+https://git.torproject.org/user/phw/leekspin.git@d34c804cd0f01af5206833e62c0dedec8565b235#egg=leekspin
mechanize==0.2.5
sure==1.2.2
Babel==0.9.6
diff --git a/CHANGELOG b/CHANGELOG
index ae0e651..32e6fe5 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -12,6 +12,10 @@ Changes in version 0.8.0 - YYYY-MM-DD
* FIXES #26542 https://bugs.torproject.org/26542
Make BridgeDB distribute vanilla IPv6 bridges again.
+ * FIXES #22755 https://bugs.torproject.org/22755
+ Use stem instead of leekspin to create test descriptors. We now don't
+ need to depend on leekspin anymore.
+
Changes in version 0.7.1 - 2019-06-07
* FIXES #28496 https://bugs.torproject.org/28496
diff --git a/README.rst b/README.rst
index ee1c979..4f05ea5 100644
--- a/README.rst
+++ b/README.rst
@@ -315,11 +315,7 @@ To create a bunch of fake bridge descriptors to test BridgeDB, do::
bridgedb mock [-n NUMBER_OF_DESCRIPTORS]
-Note that you will need to install
-`leekspin <https://pypi.python.org/pypi/leekspin>`__ in order to run the
-``bridgedb mock`` command. See ``doc/HACKING.md`` for details.
-
-And finally, to run the test suites, do::
+To run the test suites, do::
make coverage
diff --git a/bridgedb/main.py b/bridgedb/main.py
index 6b99127..5d9b0c6 100644
--- a/bridgedb/main.py
+++ b/bridgedb/main.py
@@ -551,15 +551,9 @@ def runSubcommand(options, config):
# mentioned above with the email.server and https.server.
from bridgedb import runner
- statuscode = 0
-
if options.subCommand is not None:
logging.debug("Running BridgeDB command: '%s'" % options.subCommand)
if 'descriptors' in options.subOptions:
- statuscode = runner.generateDescriptors(
- options.subOptions['descriptors'], config.RUN_IN_DIR)
-
- logging.info("Subcommand '%s' finished with status %s."
- % (options.subCommand, statuscode))
- sys.exit(statuscode)
+ runner.generateDescriptors(int(options.subOptions['descriptors']), config.RUN_IN_DIR)
+ sys.exit(0)
diff --git a/bridgedb/runner.py b/bridgedb/runner.py
index b1a21d2..b6117e1 100644
--- a/bridgedb/runner.py
+++ b/bridgedb/runner.py
@@ -81,17 +81,6 @@ def find(filename):
def generateDescriptors(count=None, rundir=None):
"""Run a script which creates fake bridge descriptors for testing purposes.
- This will run Leekspin_ to create bridge server descriptors, bridge
- extra-info descriptors, and networkstatus document.
-
- .. warning: This function can take a very long time to run, especially in
- headless environments where entropy sources are minimal, because it
- creates the keys for each mocked OR, which are embedded in the server
- descriptors, used to calculate the OR fingerprints, and sign the
- descriptors, among other things.
-
- .. _Leekspin: https://gitweb.torproject.org/user/phw/leekspin.git
-
:param integer count: Number of mocked bridges to generate descriptor
for. (default: 3)
:type rundir: string or None
@@ -100,25 +89,11 @@ def generateDescriptors(count=None, rundir=None):
directory MUST already exist, and the descriptor files will be created
in it. If None, use the whatever directory we are currently in.
"""
- import subprocess
- import os.path
+ from stem.descriptor.server_descriptor import RelayDescriptor
- proc = None
- statuscode = 0
- script = 'leekspin'
- rundir = rundir if os.path.isdir(rundir) else None
count = count if count else 3
- try:
- proc = subprocess.Popen([script, '-n', str(count)],
- close_fds=True, cwd=rundir)
- finally:
- if proc is not None:
- proc.wait()
- if proc.returncode:
- print("There was an error generating bridge descriptors.",
- "(Returncode: %d)" % proc.returncode)
- statuscode = proc.returncode
- else:
- print("Sucessfully generated %s descriptors." % str(count))
- del subprocess
- return statuscode
+ rundir = rundir if rundir else os.getcwd()
+
+ for i in range(count):
+ with open(os.path.join(rundir, 'descriptor_%i' % i), 'w') as descriptor_file:
+ descriptor_file.write(RelayDescriptor.content(sign = True))
diff --git a/doc/HACKING.md b/doc/HACKING.md
index aa6c119..a8ec640 100644
--- a/doc/HACKING.md
+++ b/doc/HACKING.md
@@ -12,20 +12,16 @@ with password ```writecode```.
## Generating bridge descriptors
Developers wishing to test BridgeDB will need to generate mock bridge
-descriptors. This is accomplished through the [leekspin
-script](https://gitweb.torproject.org/user/phw/leekspin.git). To generate 20
-bridge descriptors, change to the bridgedb running directory and do:
+descriptors. This is accomplished through the file **create-descriptors**. To
+generate 20 bridge descriptors, change to the bridgedb running directory and do:
- $ leekspin -n 20
+ $ ./scripts/create-descriptors 20
It is recommended that you generate at least 250 descriptors for testing.
Ideally, even more descriptors should be generated, somewhere in the realm of
2000, as certain bugs do not emerge until BridgeDB is processing thousands of
descriptors.
-**Leekspin is for testing purposes only and should never be deployed on a
-production server.** We do not want to distribute fake bridges.
-
## Git Workflow
See this article on git branching [workflow][workflow]. The only modifications
diff --git a/scripts/create_descriptors b/scripts/create_descriptors
new file mode 100755
index 0000000..839a6ba
--- /dev/null
+++ b/scripts/create_descriptors
@@ -0,0 +1,298 @@
+#!/usr/bin/env python2.7
+#
+# This file is part of BridgeDB, a Tor bridge distribution system.
+
+import os
+import random
+import sys
+import time
+import ipaddr
+import math
+import argparse
+import hashlib
+
+# A bunch of Tor version numbers.
+SERVER_VERSIONS = ["0.2.2.39",
+ "0.2.3.24-rc",
+ "0.2.3.25",
+ "0.2.4.5-alpha",
+ "0.2.4.6-alpha",
+ "0.2.4.7-alpha",
+ "0.2.4.8-alpha",
+ "0.2.4.9-alpha",
+ "0.2.4.10-alpha",
+ "0.2.4.11-alpha",
+ "0.2.4.12-alpha",
+ "0.2.4.14-alpha",
+ "0.2.4.15-rc",
+ "0.2.4.16-rc",
+ "0.2.4.17-rc",
+ "0.2.4.18-rc",
+ "0.2.4.19",
+ "0.2.4.20",
+ "0.2.5.1-alpha",
+ ]
+
+try:
+ import stem
+ import stem.descriptor
+ from stem.descriptor.server_descriptor import RelayDescriptor
+ from stem.descriptor.extrainfo_descriptor import RelayExtraInfoDescriptor
+ from stem.descriptor.networkstatus import NetworkStatusDocumentV3
+except ImportError:
+ print("Creating descriptors requires stem <https://stem.torproject.org>")
+ sys.exit(1)
+
+if not hasattr(stem.descriptor, "create_signing_key"):
+ print("This requires stem version 1.6 or later but you are running "
+ "version %s" % stem.__version__)
+ sys.exit(1)
+
+
+def make_output_dir():
+ if not os.path.exists(os.getcwd()):
+ os.mkdir(os.getcwd())
+
+
+def write_descriptors(descs, filename):
+ make_output_dir()
+ with open(os.path.join(os.getcwd(), filename), "w") as descriptor_file:
+ for descriptor in descs:
+ descriptor_file.write(str(descriptor))
+
+
+def write_descriptor(desc, filename):
+ make_output_dir()
+ with open(os.path.join(os.getcwd(), filename), "w") as descriptor_file:
+ descriptor_file.write(str(desc))
+
+
+def check_ip_validity(ip):
+ if (ip.is_link_local or
+ ip.is_loopback or
+ ip.is_multicast or
+ ip.is_private or
+ ip.is_unspecified or
+ ((ip.version == 6) and ip.is_site_local) or
+ ((ip.version == 4) and ip.is_reserved)):
+ return False
+ return True
+
+
+def get_transport_line(probing_resistant, addr, port):
+ """
+ If probing_resistant is True, add a transport protocol that's resistant to
+ active probing attacks.
+ """
+
+ transports = []
+ if probing_resistant:
+ transports.append("obfs2 %s:%s" % (addr, port-10))
+ iat_mode = random.randint(0, 1)
+ node_id = hashlib.sha1(bytes(random.getrandbits(8))).hexdigest()
+ public_key = hashlib.sha256(bytes(random.getrandbits(8))).hexdigest()
+ transports.append("obfs4 %s:%s iat-mode=%s,node-id=%s,public-key=%s" %
+ (addr, port-20, iat_mode, node_id, public_key))
+
+ # Always include obfs4 and occasionally include scramblesuit.
+
+ if random.randint(0, 1) > 0:
+ transports.append("scramblesuit 216.117.3.62:63174 "
+ "password=ABCDEFGHIJKLMNOPQRSTUVWXYZ234567")
+ else:
+ transports.append("obfs2 %s:%s" % (addr, port-10))
+ transports.append("obfs3 %s:%s" % (addr, port-20))
+
+ return "\ntransport ".join(transports)
+
+
+def get_hex_string(size):
+ hexstr = ""
+ for _ in range(size):
+ hexstr += random.choice("ABCDEF0123456789")
+ return hexstr
+
+
+def get_random_ipv6_addr():
+ valid_addr = None
+ while not valid_addr:
+ maybe = ipaddr.IPv6Address(random.getrandbits(128))
+ valid = check_ip_validity(maybe)
+ if valid:
+ valid_addr = maybe
+ break
+ return str(valid_addr)
+
+
+def get_random_ipv4_addr():
+ return "%i.%i.%i.%i" % (random.randint(0, 255),
+ random.randint(0, 255),
+ random.randint(0, 255),
+ random.randint(0, 255))
+
+
+def get_protocol(tor_version):
+ line = ""
+ if tor_version is not None:
+ line += "opt "
+ line += "protocols Link 1 2 Circuit 1"
+ return line
+
+
+def make_timestamp(now=None, fmt=None, variation=False, period=None):
+ now = int(now) if now is not None else int(time.time())
+ fmt = fmt if fmt else "%Y-%m-%d %H:%M:%S"
+
+ if variation:
+ then = 1
+ if period is not None:
+ secs = int(period) * 3600
+ then = now - secs
+ # Get a random number between one epochseconds number and another
+ diff = random.randint(then, now)
+ # Then rewind the clock
+ now = diff
+
+ return time.strftime(fmt, time.localtime(now))
+
+
+def make_bandwidth(variance=30):
+ observed = random.randint(20 * 2**10, 2 * 2**30)
+ percentage = float(variance) / 100.
+ burst = int(observed + math.ceil(observed * percentage))
+ bandwidths = [burst, observed]
+ nitems = len(bandwidths) if (len(bandwidths) > 0) else float("nan")
+ avg = int(math.ceil(float(sum(bandwidths)) / nitems))
+ return "%s %s %s" % (avg, burst, observed)
+
+
+def make_bridge_distribution_request():
+
+ methods = [
+ "any",
+ "none",
+ "https",
+ "email",
+ "moat",
+ ]
+
+ return random.choice(methods)
+
+
+def create_server_desc(signing_key):
+ """
+ Create and return a server descriptor.
+ """
+
+ nickname = ("Unnamed%i" % random.randint(0, 100000000000000))[:19]
+
+ # We start at port 10 because we subtract from this port to get port
+ # numbers for IPv6 and obfuscation protocols.
+
+ port = random.randint(10, 65535)
+ tor_version = random.choice(SERVER_VERSIONS)
+ timestamp = make_timestamp(variation=True, period=36)
+
+ server_desc = RelayDescriptor.create({
+ "router": "%s %s %s 0 0" % (nickname, get_random_ipv4_addr(), port),
+ "or-address": "[%s]:%s" % (get_random_ipv6_addr(), port-1),
+ "platform": "Tor %s on Linux" % tor_version,
+ get_protocol(tor_version): "",
+ "published": timestamp,
+ "uptime": str(int(random.randint(1800, 63072000))),
+ "bandwidth": make_bandwidth(),
+ "contact": "Somebody <somebody at example.com>",
+ "bridge-distribution-request": make_bridge_distribution_request(),
+ "reject": "*:*",
+ }, signing_key=signing_key)
+
+ return server_desc
+
+
+def create_extrainfo_desc(server_desc, signing_key, probing_resistant):
+ """
+ Create and return an extrainfo descriptor.
+ """
+
+ ts = server_desc.published
+
+ extrainfo_desc = RelayExtraInfoDescriptor.create({
+ "extra-info": "%s %s" % (server_desc.nickname,
+ server_desc.fingerprint),
+ "transport": get_transport_line(probing_resistant,
+ server_desc.address,
+ server_desc.or_port),
+ "write-history": "%s (900 s) 3188736,2226176,2866176" % ts,
+ "read-history": "%s (900 s) 3891200,2483200,2698240" % ts,
+ "dirreq-write-history": "%s (900 s) 1024,0,2048" % ts,
+ "dirreq-read-history": "%s (900 s) 0,0,0" % ts,
+ "geoip-db-digest": "%s" % get_hex_string(40),
+ "geoip6-db-digest": "%s" % get_hex_string(40),
+ "dirreq-stats-end": "%s (86400 s)" % ts,
+ "dirreq-v3-ips": "",
+ "dirreq-v3-reqs": "",
+ "dirreq-v3-resp": "ok=16,not-enough-sigs=0,unavailable=0,"
+ "not-found=0,not-modified=0,busy=0",
+ "dirreq-v3-direct-dl": "complete=0,timeout=0,running=0",
+ "dirreq-v3-tunneled-dl": "complete=12,timeout=0,running=0",
+ "bridge-stats-end": "%s (86400 s)" % ts,
+ "bridge-ips": "ca=8",
+ "bridge-ip-versions": "v4=8,v6=0",
+ "bridge-ip-transports": "<OR>=8",
+ }, signing_key=signing_key)
+
+ return extrainfo_desc
+
+
+def make_descriptors(count, num_probing_resistant):
+ """
+ Create fake descriptors and write them to the working directory.
+ """
+
+ consensus_entries = []
+ server_descriptors = []
+ extrainfos_old = []
+ extrainfos_new = []
+
+ for i in range(count):
+ signing_key = stem.descriptor.create_signing_key()
+
+ server_desc = create_server_desc(signing_key)
+ server_descriptors.append(server_desc)
+ consensus_entries.append(server_desc.make_router_status_entry())
+
+ extrainfo_desc = create_extrainfo_desc(server_desc,
+ signing_key,
+ num_probing_resistant > 0)
+ if random.random() > 0.75:
+ extrainfos_new.append(extrainfo_desc)
+ else:
+ extrainfos_old.append(extrainfo_desc)
+
+ if num_probing_resistant > 0:
+ num_probing_resistant -= 1
+
+ consensus = NetworkStatusDocumentV3.create(routers=consensus_entries)
+ write_descriptor(consensus, "networkstatus-bridges")
+ write_descriptors(server_descriptors, "bridge-descriptors")
+ write_descriptors(extrainfos_old, "cached-extrainfo")
+ write_descriptors(extrainfos_new, "cached-extrainfo.new")
+
+
+if __name__ == "__main__":
+
+ parser = argparse.ArgumentParser(description="Create fake descriptors.")
+ parser.add_argument("num_descs",
+ type=int,
+ help="The number of descriptors to create.")
+ parser.add_argument("--num-resistant-descs",
+ dest="num_resistant_descs",
+ type=int,
+ default=-1,
+ help="The number of active probing-resistant "
+ "descriptors to create")
+ args = parser.parse_args()
+ if args.num_resistant_descs == -1:
+ args.num_resistant_descs = args.num_descs
+
+ make_descriptors(args.num_descs, args.num_resistant_descs)
diff --git a/scripts/setup-tests b/scripts/setup-tests
index ccfd6cd..1de3c71 100755
--- a/scripts/setup-tests
+++ b/scripts/setup-tests
@@ -29,7 +29,7 @@ sed -r -i -e "s/(SERVER_PUBLIC_FQDN = )(.*)/\1'127.0.0.1:6788'/" run/bridgedb.co
sed -r -i -e "s/(MOAT_HTTP_IP = )(None)/\1'127.0.0.1'/" run/bridgedb.conf
sed -r -i -e "s/(MOAT_HTTP_PORT = )(None)/\16790/" run/bridgedb.conf
# Create descriptors
-leekspin -n 100 -xp 50
+./scripts/create_descriptors 200 --num-resistant-descs 100
cp -t run/from-authority networkstatus-bridges cached-extrainfo* bridge-descriptors
cp -t run/from-bifroest networkstatus-bridges cached-extrainfo* bridge-descriptors
# Create TLS certificates
diff --git a/setup.py b/setup.py
index a31391c..d416289 100644
--- a/setup.py
+++ b/setup.py
@@ -387,7 +387,7 @@ setuptools.setup(
'scripts/get-tor-exits'],
extras_require={'test': ["sure==1.2.2",
"coverage==4.2",
- "leekspin==1.1.4"]},
+ "cryptography==1.9"]},
zip_safe=False,
cmdclass=get_cmdclass(),
include_package_data=True,
More information about the tor-commits
mailing list