CHANGELOG

Changes in version 0.2.3 - 2014-07-XXX

        * FIXES #5463 https://bugs.torproject.org/5463
        XXX

        * FIXES #9385 https://bugs.torproject.org/9385
        BridgeDB now has the ability to blacklist email addresses, and
        configurable options to fuzzy match and block addresses which are
        similar enough to those in the blacklist.

        * FIXES #12147 https://bugs.torproject.org/12147
        An additional issue with BridgeDB's code for scheduling actions
        was identified by Robert Ransom, who also provided a unittest to
        demonstrate the issue and test for future regressions. The issue
        pointed out has also been fixed.

And include the following general changes:

        * UPDATE translation: Chinese - Taiwan (zh_TW)
                THANKS TO danfong.
        * UPDATE translation: Chinese - China (zh_CN)
                THANKS TO Meng3, leungsookfan, and Wu Ming Shi.
        * UPDATE translation: Turkish (tr)
                THANKS TO eromytsatiffird, Emre, Idil Yuksel, ozkansib,
                Volkan Gezer, and zeki.
        * UPDATE translation: Swedish (sv)
                THANKS TO Anders Jensen-Urstad, GabSeb, and phst.
        * UPDATE translation: Russian (ru)
                THANKS TO Evgrafov Denis, Eugene, foo, Sergey Briskin,
                Valid Olov, and Vitaliy Grishenko.
        * UPDATE translation: Brazilian Portuguese (pt_BR)
                THANKS TO Isabel Ferreira, and Rodrigo Emmanuel Santana
                Borges.
        * UPDATE translation: Portuguese (pt)
                THANKS TO André Monteiro, kagazz, Manuela Silva,
                Andrew_Melim, and Sérgio Marques.
        * UPDATE translation: Polish (pl)
                THANKS TO Aron, Dawid, Krzysztof Łojowski, and seb.
        * UPDATE translation: Norwegian Bokmål (nb)
                THANKS TO Allan Nordhøy, Harald, and thor574.
        * UPDATE translation: Malay (ms_MY)
                THANKS TO shahril.
        * UPDATE translation: Latvian (lv)
                THANKS TO Ojārs Balcers.
        * UPDATE translation: Khmer (km)
                THANKS TO Seng Sutha, Sokhem Khoem, and Sok Sophea.
        * UPDATE translation: Hungarian (hu)
                THANKS TO Blackywantscookies, and Cerbo.
        * UPDATE translation: Croatian (hr_HR)
                THANKS TO Ana B.
        * UPDATE translation: Hebrew (he)
                THANKS TO Elifelet.
        * UPDATE translation: Canadian French (fr_CA)
                THANKS TO yahoe.001.
        * UPDATE translation: French (fr)
                THANKS TO fayçal fatihi, Frisson Reynald, hpatte, Lunar,
                Onizuka, themen, Towinet, and Yannick Heintz.
        * UPDATE translation: Finish (fi)
                THANKS TO viljaminojonen, and Finland355.
        * UPDATE translation: Farsi (fa)
                THANKS TO Mohammad Hossein.
        * UPDATE translation: Spanish - Chile (es_CL)
                THANKS TO Pablo Lezaeta.
        * UPDATE translation: Spanish (es)
                THANKS TO Paola Falcon.
        * UPDATE translation: British English (en_GB)
                THANKS TO richardshaylor.
        * UPDATE translation: Greek (el)
                THANKS TO Adrian Pappas, andromeas, isv31, and Wasilis
                Mandratzis.
        * UPDATE translation: German (de)
                THANKS TO Tobias Bannert.
        * UPDATE translation: Danish (da)
                THANKS TO autofunk78.
        * UPDATE translation: Arabic (ar)
                THANKS TO Ahmad Gharbeia, Mohamed El-Feky, AnonymousLady,
                0xidz, Sherief Alaa , and محيي الدين.


Changes in version 0.2.2 - 2014-06-06

        * FIXES #9874 https://bugs.torproject.org/9874
        BridgeDB's email and HTTPS distributors were written in a manner
        that makes them largely impossible to write unittests for. Since
        the recent rewrite of BridgeDB's email distributor server backends
        for version 0.2.1, BridgeDB email distributor is now testable and
        has near 100% code coverage, see
        https://coveralls.io/r/isislovecruft/bridgedb

        * FIXES #12086 https://bugs.torproject.org/12086
        BridgeDB was found to accept incoming emails sent to any email
        address whose local part included the word bridges, e.g. emails
        sent to 'givemebridges@serious.ly' would be responded to as if
        they were destined for BridgeDB's real email address.
          - BridgeDB now strictly checks that the local part of the email
            address that an incoming email was sent to (after removing plus
            aliases, i.e. '+es_ES', '+fa', etc.) exactly matches BridgeDB
            configured email address username.
          - BridgeDB now checks that the domain name portion of the email
            address that an incoming email was sent to either matches the
            domain name portion of BridgeDB's configured email address, or
            is a subdomain of that domain.

        * FIXES #12089 https://bugs.torproject.org/12089
        There has been a bug for quite some time now where BridgeDB could
        be used to email arbitrary email addresses (as long as these
        addresses were ones which BridgeDB allows, i.e. Gmail or Yahoo
        email addresses). This was due to BridgeDB not checking that the
        email address used in the SMTP 'MAIL FROM:' command on an incoming
        message matched the one used in that email's 'From:'
        header.
          - BridgeDB now checks that the email addresses in the SMTP 'MAIL
            FROM:' and the 'From:' header on that incoming email match, in
            addition to the previous checks that the email address' domain
            is in the set of allowed domains.

        * FIXES #12090 https://bugs.torproject.org/12090
        BridgeDB has been replying with an empty email. I don't actually
        know for sure if this one is fixed. Before deploying version
        0.2.1, the continuous integration tests showed email responses
        being correctly generated, and I was also able to receive
        correctly formed email responses from BridgeDB on a local testing
        instance on my laptop. It appears that this bug occurs only on the
        deployment server at ponticum.torproject.org, possibly due to the
        outdated Python version in Debian Wheezy. I have not been able to
        reproduce this bug on any other machine.

        * FIXES #12091 https://bugs.torproject.org/12091
        BridgeDB wasn't properly ignoring emails whose DKIM signature
        verification header read "X-DKIM-Authentication-Results: dunno".
          - Bridgedb now marks incoming emails which have a
            "X-DKIM-Authentication-Results: dunno" header as invalid and
            ignores them.

        * FIXES #12147 https://bugs.torproject.org/12147
        If a user refreshed https://bridges.torproject.org/bridges after
        successfully solving a CAPTCHA, BridgeDB would reply with a new
        set of bridges for each page refresh. This was due to the use of
        `getIterval()` in `IPBasedDistributor.getBridgesForIP()`.The
        correct function to use is `getIntervalStart()`.  This had been
        noted in a "XXX FIXME" comment above the call for quite some time,
        however, when the `bridgedb.schedule` (previously called
        `bridgedb.Time`) module was revised to support CAPTCHA timeouts
        (#11215), the call to `getInterval()` was mistakenly not replaced
        with the correct function.
          - BridgeDB CAPTCHAs must be solved within 10 minutes.
          - Hashring rotation for bridges in BridgeDB HTTPS distributor
            occurs every 3 hours. Refreshing the page with bridges on it
            will return these same bridges for that time period, and
            afterwards redirect back to the CAPTCHA page.
        THANKS TO francisco on IRC and arma for reporting the bug.

        * FIXES #12212 https://bugs.torproject.org/12122
        TRANSLATOR comments are now properly extracted into the gettext PO
        template file.

And include the following general changes:
        * FIXES an issue where, when verifying GnuPG signatures made by
        BridgeDB's email distributor, GnuPG would error, saying, "invalid
        armor header".

        * ADD Korean (ko) translations.
          Thanks to ilbe123, cwt96, Dr.what, and pCsOrI.

        * UPDATE Ukranian (uk) translations.
          Thanks to LinuxChata and ghostishev.

        * UPDATE Turkish (tr) translations.
          Thanks to volkangezer.

        * UPDATE Brazilian Portuguese (pt_BR) translations.
          Thanks to Communia, Humberto Sartini, Anastasia01, and recognitium.

        * UPDATE Polish (pl) translations.
          Thanks to hoek, yodaa, maxxx, and sebx.

        * UPDATE Dutch (nl) translations.
          Thanks to Ann Boen, erwindelaat, guryman, and BBLN.
          You guys are extra awesome for translating the phrase:
              "Uh oh, spaghettios!"
          into the Dutch:
              "Helaas pindakaas!"
          which, in English, literally means:
              "Unfortunately, peanut butter!"
          You guys totally just made my day. Thanks.

        * UPDATE Japanese (ja) translations.
          Thanks to plazmism, who is extra awesome for translating the phrase:
              "Uh oh, spaghettios!"
          into the Japanese:
              "おっとスパゲッティ！"
          which apparently the literal English translation is:
              "Husband spaghetti!"

        * UPDATE Italian (it) translations.
          Thanks to Random_R.

        * UPDATE Canadian French (fr_CA) translations.
          Thanks to Lunar.

        * UPDATE Spanish (es) translations.
          Thanks to dark_yoshi and strel.

        * UPDATE Greek (el) translations.
          Thanks to pappasadrian.

        * UPDATE German (de) translations.
          Thanks to trantor and unknwon_anonymous.

        * UPDATE Danish (da) translations.
          Thanks to autofunk78 and DavidNielsen.


Changes in version 0.2.1 - 2014-05-16
        * FIXES #5463 https://bugs.torproject.org/5463
        Emails sent from BridgeDB's email distributor should now be signed.
          - BridgeDB's emails will be signed with its online GnuPG keypair. The
            public key has the following fingerprint:
                DF81 1109 E17C 8BF1 34B5  EEB6 8DC4 3A28 4882 1E32
            The online keypair rotates (a new one is placed on the server once
            per year), and it will ALWAYS be signed with BridgeDB's offline
            keypair.
          - The online keypair above contains two subkeys. The signing subkey
            has the fingerprint:
                9FE3 9D1A 7438 9223 3B3F  66F2 21B5 54E9 5938 F4D0
          - BridgeDB's offline keypair has the following fingerprint:
                7B78 4370 15E6 3DF4 7BB1  270A CBD9 7AA2 4E8E 472E
        All of BridgeDB's keys may be found on the public keyservers, as
        well as at https://bridges.torproject.org/keys

        * FIXES #7547 https://bugs.torproject.org/7547
        BridgeDB's email distributor will now send you a message
        explaining how to use it, including valid commands and the list of
        Pluggable Transport TYPES currently supported. To receive help
        with the email distributor, simply send an email to
        mailto:bridges@torproject.org.
          - Any emails which do not contain a valid command will receive
        the help text in response.
          - Otherwise, to specifically request the help text, just say
                "get help"
        in the body of your email.

        * FIXES #7550 https://bugs.torproject.org/7550
        BridgeDB's email responder is now interactive, as described in the
        above entry for ticket #7547.

        * FIXES #8241 https://bugs.torproject.org/8241
        BridgeDB's HTTP distributor won't tell you how to get obfs3
        bridges through email, although a blank email, or an email
        containing "get help" will.

        * CLOSES #9678 https://bugs.torproject.org/9678
        A "Select Language" button was requested for the HTTP distributor
        on https://bridges.torproject.org. Instead, translated pages are
        distributed automatically (via detecting the "Accept-Language"
        header which can be set in the Settings panel of all modern
        browers).
          - To request a specific translation, the "lang=LOCALE" argument
        can be added to the URL of any page. For example:
        https://bridges.torproject.org/options?lang=ar
        will provide the bridge options selection page in Arabic.

        * FIXES #11215 https://bugs.torproject.org/11215
        BridgeDB's usage of gimp-captcha, which creates a local cache of
        CAPTCHA for use on the HTTP distributor, now supports timeouts. If
        a CAPTCHA is not solved within 30 minutes of being served to a
        client, the solution is invalid regardless of its correctness.

        * FIXES #11475 https://bugs.torproject.org/11475
        BridgeDB's email responder, up until this point, explained how to
        use bridges with Vidalia. It now uses the same help text as found
        at https://bridges.torproject.org/howto which explains how to
        enter bridges into TorLauncher (used by Tor Browser and Tails).

        * FIXES #11522 https://bugs.torproject.org/11522
        There were several errors and bugs in BridgeDB's email
        distributor. The entire system of server supporting BridgeDB's
        email distribution system was rewritten.

        * FIXES #11664 https://bugs.torproject.org/11664
        Due to changes in the Python language builtin `buffer` in Python3,
        which were backported to Python 2.7.6, but neither backported to
        Python 2.6.x nor to Python <= 2.7.5, BridgeDB's use of
        `io.StringIO` and `io.BytesIO` combined with buffers had to be
        revised to support both the new and old Python `buffer` APIs.

        * FIXES #11753 https://bugs.torproject.org/11753
        BridgeDB's emails should now be translated.
          - The translations system for BridgeDB, as well as the template
        system for emails, was completely rewritten.  By default, email
        responses are in English. To receive an alternate translation,
        send an email to bridges+LOCALE@torproject.org, where "LOCALE" is
        a locale specifier.
          - For example, to receive BridgeDB emails translated into
        Chinese, use mailto:bridges+zh_CN@torproject.org.
          - Or for Farsi translations, use mailto:bridges+fa@torproject.org.
          - For the full list of currently supported LOCALE codes, see
        https://gitweb.torproject.org/user/isis/bridgedb.git/tree/HEAD:/lib/bridgedb/i18n/

And includes the following general changes:
        * UPDATES the Italian (it) gettext file.
          Thanks to Francesca Ciceri.
        * ADD Welsh (cy) translations.
          Thanks to huwwaters and littlegreykida.
        * ADD Slovak (sk) translations.
          Thanks to Michelozzo and Svistwarrior273.
        * UPDATES the bridgedb.pot translation template file. All the new
        strings in the email and HTTP user interfaces will now need
        translation! To help out with translations, please see:
        https://www.transifex.com/projects/p/torproject/resource/2-bridgedb-bridgedb-pot/
        * FIXES several typos in the BridgeDB's code documentation.
        * ADDS code documentation for several previously undocumented modules.

Changes in version 0.2.0 - 2014-04-19
        * FIXES #5232 Perform long running and blocking transactions in
                background threads. Primarily this moves bridge descriptor
                reparsing into another thread, which significantly increases
                the availability of BridgeDB.
        * FIXES #9119 BridgeDB's logger now automatically sanitises all email
                and IP addresses when the SAFELOGGING config option is enabled.
        * FIXES #9875 BridgeDB logger now has 100% unittest coverage.
        * FIXES #10803 Vidalia is no longer mentioned on
                https://bridges.torproject.org, and instead there are new
                instructions on how to enter bridges into TBB>=3.5 (with
                TorLauncher).
        * FIXES #11346 The web interface now has a homepage link. By clicking
                "BridgeDB" in the upper left corner, users can go back to the
                start of TBB downloading and bridge selection instructions at
                https://bridges.torproject.org.
        * FIXES #11370 We were using an old (and deprecated) module when we
                created our email responses. Now we use the newer version.
        * FIXES #11377 CAPTCHAs on BridgeDB's HTTPS interface are now
                case-insensitive.
                Thanks to Kostas Jakeliunas for the patch.
        * FIXES #11522 fixes several issues with encodings and exception
                handling in the email distributor.

And includes the following general changes:
        * NEW interface design for https://bridges.torproject.org, including
                updated CSS stylesheets, fonts, and HTML templates. In
                particular, the https://bridges.torproject.org/options page has
                been redesigned completely.
                Thanks to Xengi for providing a modified design of the "roots"
                Tor Project logo, which is used to link to
                https://www.torproject.org.
        * CHANGES the TBB download link on the main web interface page to link
                to the new TBB-3.6.x-beta bundles, which include patches by
                David Fifield to unify TBB and PTTBB into one browser, so that
                Pluggable Transports (PTs) are only enabled when the user
                includes a bridge line which uses that PT.
        * FIXES plaintext responses on https://bridges.torproject.org,
                these can be requested by using the 'format' HTTP parameter,
                like so: https://bridges.torproject.org/bridges?format=plain
        * FIXES the logging of all lines of (including headers!) of incoming
                emails.
        * FIXES logfile rotation so that the files are only reable/writable
                by the running process owner, and no other user.
        * CHANGES the data format used for encrypted-then-HMACed CAPTCHAs
                to assume that the HMAC is the first 20 bytes. Before we
                assumed that the HMAC was separated from the encrypted data
                with a ';' character, which causes intermittent issues with
                some encoding and CAPTCHA solution values.
        * REFACTORS some of the translations handling code, so that soon emails
                will be translated (see #7550), and
                https://bridges.torproject.org should have a "Select Language"
                button (see #9678).
        * BUMPS leekspin version to 0.1.3.

Changes in version 0.1.6 - 2014-03-26
BridgeDB 0.1.6 includes fixes for the following bugs:
        * FIXES #11196 BridgeDB should use leekspin
        * FIXES #11218 ReCaptchaProtectedResource.checkSolution()
                doesn't expect a deferred
        * FIXES #11219 BridgeDB's twisted version doesn´t have a
                `t.w.client.HTTPConnectionPool` class
        * FIXES #11231 BridgeDB's txrecaptcha returns the "No bridges
                available!" page if 'captcha_response_field' is blank

And includes the following general changes:
        * ADDS several new translations languages.

Changes in version 0.1.5 - 2014-02-27
BridgeDB 0.1.5 includes fixes for the following bugs:
        * FIXES #9264 Problem with transport lines in BridgeDB's bridge
                pool assignment files
        * FIXES #10809 reCAPTCHA on bridges.torproject.org are impossible
                to solve for humans
        * FIXES #10834 Configurable reCAPTCHA remoteip
        * FIXES #11127 reCaptcha verification is hardcoded to use
                plaintext HTTP

And includes the following general changes:
        * CHANGES the way the client's IP address is reported to the
        reCaptcha API server. Previously, for each client request, a
        completely random IP address was generated, and BridgeDB lied to
        the reCaptcha server by sending this random IP and saying that it
        was the client's IP. With these changes, BridgeDB can be
        configured to report a static IP address (it's own IP) as the
        client's IP, in the hopes that the IP whitelisting used by
        reCaptcha makes the returned CAPTCHAs less impossible to solve.
        * ADDS the ability to use a local cache of CAPTCHAs created by
        scripting Gimp with Python. See:
        https://github.com/isislovecruft/gimp-captcha
        * USES TLS during CAPTCHA solution verification when using
        reCaptcha.


Changes in version 0.1.4 - 2014-02-21
BridgeDB 0.1.4 includes fixes for the following bugs:
        * FIXES an RTL encoding issue in the "Step 2" text on index.html
                of the HTTPS distributor.


Changes in version 0.1.3 - 2014-02-21
BridgeDB 0.1.3 includes fixes for the following bugs:
        * FIXES #9264 Problem with transport lines in BridgeDB's bridge
                pool assignment files
        * FIXES a bug caused by attempts to convert descriptor digests
                which could not be parsed into hexadecimal.
        * FIXES a unicode decoding error within the bridgedb.persistent
                module.
        * REMOVES continuous integration testing for Python 2.6.

Including the following general changes:
        * ADD volunteer page text for GSoC 2014 applications.


Changes in version 0.1.2 - 2014-02-05
BridgeDB 0.1.2 includes fixes for the following bugs:
        * FIXES #10811 BridgeDB's assignments.log files are not being updated


Changes in version 0.1.1 - 2014-02-03
BridgeDB 0.1.1 includes fixes for the following bugs:
        * FIXES #9127 Users can't ask for ipv6 bridges with the new bridgedb
                interface
        * FIXES #9988 Refactor BridgeDB's use of `sha` module to use `hashlib`
        * FIXES #10724 Most of the time spent in testing, as well as most
                of the time spent when "BridgeDB is down" (i.e. when I reply
                with "BridgeDB is single-threaded (see #5232) and is parsing
                millions of descriptors"), is within the same
                `bridgedb.Stability.addOrUpdateBridgeHistory()` function (see
                #10724). This function is pretty brutal on CPU and memory, is
                blocking, and it needs to runs thousands and thousands of
                times whenever BridgeDB is restarted (every half hour). The
                algorithm within that function has a time complexity increasing
                linearithmically relative to the number of bridges and timestamps
                already within the database. [0]
                This patch adds a config option to disable/enable running
                the `addOrUpdateBridgeHistory()` function.
                [0]: https://en.wikipedia.org/wiki/Time_complexity#Linearithmic_time
        * FIXES #10737 POST arguments to bridges.torproject.org are dropped if
                entering a CAPTCHA fails

Including the following general changes:
        * ADDS A general simple error page to display rather than
                webserver tracebacks. See #6127.
        * MOVES The recently added BridgeDB specification file
                ('doc/bridge-db-spec.txt') to the torspec repo:
                https://gitweb.torproject.org/torspec.git
        * FIXES template caching for the web interface.


Changes in version 0.1.0 - 2014-01-14
BridgeDB 0.1.0 includes fixes for the following bugs:
        * FIXES #1606 Write a BridgeDB spec
        * FIXES #3573 bridges.torproject.org doesn't have a robots.txt
        * FIXES #6127 bridges.tpo runs in development mode
        * FIXES #9013 BridgeDB should pass pluggable transport
                shared-secrets to clients
        * FIXES #9157 Persian and Arabic should be right aligned on bridges.tpo
        * FIXES #9462 BridgeDB netstatus descriptor parsers need refactoring
        * FIXES #9959 BridgeDB seems to be missing English translations
        * FIXES #9865 Add automated code coverage report generation
        * FIXES #9872 Create a test runner for BridgeDB unittests
        * FIXES #9873 Convert BridgeDB's old unittests to use twisted.trial
        * FIXES #9937 Create fake non-sanitised bridge descriptors for
                BridgeDB testing purposes
        * FIXES #10333 Indexing list-like objects by 0L in
                Bridges.getConfigLine
        * FIXES #10446 BridgeDB is/was using a GeoIP module which is
                incompatible with virtualenvs
        * FIXES #10559 BridgeDB writes `keyid=` before fingerprints

Including the following general changes:
        * ADD Numerous unittests and automated continuous integration testing.
        * ADD Patches by sysrqb to correctly render right-to-left languages.
        * FIXES fallback languages for translations.
        * ADD Sphinx makefiles, substantial amounts of documentation.
        * ADD Documentations builds (currently at
              https://para.noid.cat/bridgedb)


Changes in version 0.0.1 - 2013-08-20
BridgeDB 0.0.1 includes fixes for the following bugs:
        * FIXES #5332 Update BridgeDB documentation with deployment
                instructions
        * FIXES #9156 BridgeDB: Users try to add obfsbridges to their
                normal TBB
        These commits were added to fix a compatibility issue with
        Vidalia, though they may be reverted to switch back to the old
        behaviour of returning bridge lines in the form:
          Bridge [transport_method] address:port [keyid=fingerprint] [K=v] […]
        in order to work with torrc files and the new TBB-3.x packages
        which use TorLauncher instead of Vidalia.
        * PARTIAL FIX #9264 Problem with transport lines in BridgeDB's
                  bridge pool assignment files.
        * FIXES #9425 Create and document a better BridgeDB (re)deployment
                strategy

Including the following general changes:
        * UPDATE translations files with finished files from Transifex for
        the strings for the newly-refactored web interface created by
        gsathya.
        * ADD an automatic version-numbering system as part of developing
        a better deployment strategy.
        * CHANGE setup.py script to automatically install Python-based
        dependencies from requirements.txt.
        * REMOVE MANIFEST.in and put equivalent 'include' directives into
        setup.py (the less places we have for manually keeping track of
        files, the better).
        * REMOVE the "bridge " prefix from the lines returned on the web
        interface.