BridgeDB developer documentation

BridgeDB’s README

• BridgeDB
  • What are Tor Bridges?
    • What’s a Pluggable Transport?
    • So how do I use this?
  • Maintainer Setup
    • Dependencies and installation
    • Deploying BridgeDB
  • Enabling additional features
    • Translations
    • Enabling HTTPS
    • Enabling CAPTCHA Support
    • GnuPG email signing:
    • Preventing already-blocked bridges from being distributed:
  • Testing BridgeDB
  • Running BridgeDB
    • Reloading Bridges From Their Descriptor Files:
    • To extract bucket files of all unallocated bridges:
  • Using a BridgeDB Instance
    • Accessing the HTTPS User Interface
    • Accessing the Email User Interface
  • Contact & Support

Packages & Modules

• Packages & Modules
  • bridgedb.bridgerequest
  • bridgedb.bridges
  • bridgedb.Bridges
  • bridgedb.Bucket
  • bridgedb.captcha
  • bridgedb.configure
  • bridgedb.distribute
  • bridgedb.crypto
  • bridgedb.email
    • bridgedb.email.autoresponder
    • bridgedb.email.autoresponder
    • bridgedb.email.dkim
    • bridgedb.email.request
    • bridgedb.email.server
    • bridgedb.email.templates
  • bridgedb.filters
  • bridgedb.geo
  • bridgedb.https
    • bridgedb.https.distributor
    • bridgedb.https.request
    • bridgedb.https.server
  • bridgedb.interfaces
  • bridgedb.Main
  • bridgedb.parse
    • bridgedb.parse.addr
    • bridgedb.parse.descriptors
    • bridgedb.parse.fingerprint
    • bridgedb.parse.headers
    • bridgedb.parse.nicknames
    • bridgedb.parse.options
    • bridgedb.parse.versions
  • bridgedb.persistent
  • bridgedb.proxy
  • bridgedb.qrcodes
  • bridgedb.runner
  • bridgedb.safelog
  • bridgedb.schedule
  • bridgedb.Stability
  • bridgedb.Storage
  • bridgedb.strings
  • bridgedb.translations
  • bridgedb.txrecaptcha
  • bridgedb.util

Tor Bridge Descriptor Formats

Please also see the CollecTor documentation on Tor Bridge descriptor formats.

• Tor Bridge Descriptor Formats
  • Bridge router descriptors
    • With 0.2.4.15 > tor >= 0.2.3.35
    • With tor >= 0.2.4.15
  • Bridge extra-info descriptors
    • A minimal bridge extra-info descriptor
    • A more dense bridge extra-info descriptor
    • A bridge extra-info descriptor with pluggable transports
  • Bridge networkstatus documents

Help Develop BridgeDB!

To see all open tickets for BridgeDB, please visit the Tor Project’s Trac instance.

Todo List

This TODO list is generated in an automated manner via the Sphinx TODO extension, and it only includes portions documentation string within BridgeDB’s codebase which have been marked with the Sphinx .. todo: directive. As such, this should be taken neither as a canonical nor complete list of tasks planned for future development, but rather a brief list of small(ish) places within the codebase that could use some attention.

Todo

This should probably be reimplemented as a property that automatically sanitises the values for each ORAddress, as is done for bridgedb.bridges.BridgeAddressBase.address and bridgedb.bridges.BridgeBase.orPort.

(The original entry is located in /home/isis/code/torproject/bridgedb/bridgedb/bridges.py:docstring of bridgedb.bridges.Bridge.assertOK, line 14.)

Todo

The transport attribute of Stem’s BridgeExtraInfoDescriptor class is a dictionary that uses the Pluggable Transport’s type as the keys… meaning that if a bridge were to offer four instances of obfs3, only one of them would get to us through Stem. This might pose a problem someday.

(The original entry is located in /home/isis/code/torproject/bridgedb/bridgedb/bridges.py:docstring of bridgedb.bridges.Bridge.updateFromExtraInfoDescriptor, line 18.)

Todo

At some point, we may want to change this class to optionally handle creating Multipart MIME encoding messages, so that we can include attachments. (This would be useful for attaching our GnuPG keyfile, for example, rather than simply pasting it into the body of the email.)

(The original entry is located in /home/isis/code/torproject/bridgedb/bridgedb/email/autoresponder.py:docstring of bridgedb.email.autoresponder.EmailResponse, line 3.)

Todo

The instructions for the OpenPGP keys in BRIDGEDB_OPENPGP_KEY are not translated… should we translate them? Should we tell users where to obtain GPG4Win/GPGTools/gnupg? Should those instruction be that verbose? Or should we get rid of the instructions altogether, and assume that any encouragement towards using GPG will just make users more frustrated, and (possibly) (mis-)direct that frustration at Tor or BridgeDB?

(The original entry is located in /home/isis/code/torproject/bridgedb/bridgedb/strings.py:docstring of bridgedb.strings, line 3.)