Parse bridge blocking info from SQL database.
[tor-bridgedb.git] / CHANGELOG
blob10012cec372186a57f30704b05dbe171d5cb5c1d
1     * FIXES https://bugs.torproject.org/34260
2     Parse bridge blocking information from SQL database.
4     * FIXES https://gitlab.torproject.org/tpo/anti-censorship/bridgedb/-/issues/40001
5     Remove the --reload command line switch.  It doesn't actually do anything.
7     * FIXES https://bugs.torproject.org/29184
8     Add a new configuration option, BLACKLISTED_TOR_VERSIONS, which contains a
9     list of Tor versions.  BridgeDB won't hand out bridges whose Tor version
10     is present in this blacklist.
12     * FIXES https://bugs.torproject.org/19774
13     Add a favicon to BridgeDB's web UI.
15 Changes in version 0.10.1 - 2020-05-27
17     * FIXES https://bugs.torproject.org/33945
18     This patch fixes a bug that caused the email autoresponder to fail after
19     a while.
21     * FIXES https://bugs.torproject.org/34154
22     Add new fields to the SQLite table BlockedBridges in preparation for taking
23     into account OONI's bridge measurement results.
25     * FIXES https://bugs.torproject.org/31528
26     BridgeDB's UI uses a bunch of obscure "chatspeak" references in its UI.  One
27     example is that it responds with "Uh oh, spaghettios!" if there are
28     currently no bridges available.  While funny to some, this is difficult to
29     translate and shouldn't be part of software that's used by an international
30     audience.  This patch removes such references.
32     * FIXES https://bugs.torproject.org/12802
33     Add a script that sends a bridge request over email, and then checks if it
34     received a response from BridgeDB.  We use this script as part of our nagios
35     setup, so we notice when our autoresponder breaks.
37     * FIXES https://bugs.torproject.org/17548
38     This patch removes PGP support.  BridgeDB's signing key expired on
39     2015-09-11.  Nobody ever complained and maintaining the bits and pieces
40     necessary to sign emails isn't worth the effort, so this patch removes that
41     feature.
43     * FIXES https://bugs.torproject.org/30941
44     Make our email responder more usable.  This patch removes the concept of
45     "valid" email commands and returns bridges (obfs4, for now) no matter what
46     the user sends.  BridgeDB still supports email commands in case the user
47     needs a vanilla or IPv6 bridge.
49     * FIXES https://bugs.torproject.org/29686
50     Rename files that contain "Bridges" to "bridgerings", to eliminate headache
51     on file systems that are case insensitive.
53 Changes in version 0.10.0 - 2020-04-01
55     * FIXES https://bugs.torproject.org/30317
56     Update our "howto" box, which explains how one adds bridges to Tor Browser.
57     In addition to updating the instructions, this patch also links to
58     instructions for Android.
60     * FIXES https://bugs.torproject.org/33631
61     So far, BridgeDB remembered only the first distribution mechanism it ever
62     learned for a given bridge.  That means that if a bridge would change its
63     mind and re-configure its distribution mechanism using BridgeDistribution,
64     BridgeDB would ignore it.  This patch changes this behavior, so bridges can
65     actually change their distribution mechanism.
67     * FIXES https://bugs.torproject.org/31967
68     Use a CSPRNG for selecting cached CAPTCHAs.
70     * FIXES https://bugs.torproject.org/33008
71     Add an info page, available at bridges.torproject.org/info.  Relay Search
72     links to this info page to explain to bridge operators what their bridge
73     distribution mechanism means.
75 Changes in version 0.9.4 - 2020-02-19
77     * FIXES https://bugs.torproject.org/30946
78     This patch ports BridgeDB to Python 3.  Python 2 is no longer supported
79     since Jan 1, 2020.
81 Changes in version 0.9.3 - 2020-02-18
83     * FIXES <https://bugs.torproject.org/33299>
84     This patch disables the distribution of FTE, ScrambleSuit, and obfs3.
86 Changes in version 0.9.2 - 2020-02-04
88     * FIXES <https://bugs.torproject.org/31427>
89     This patch updates the AUTHORS file, HACKING.md, contact information, the
90     Trac URL to report bugs, our instructions on BridgeDB's landing page, and it
91     fixes a small bug in descriptor generation.
93 Changes in version 0.9.1 - 2019-10-29
95     * FIXES https://bugs.torproject.org/32203
96     The metrics code used to weed out vanilla bridges, so they did not show up
97     in our metrics.  This patch fixes this issue.
99     * FIXES https://bugs.torproject.org/32134
100     While implementing our language switcher (#26543), we added a new string,
101     "Language", that requires translations.  This patch adds a new translation
102     request and also updates our instructions on how to request new
103     translations.
105     * FIXES https://bugs.torproject.org/32105
106     Mention an undocumented OS-level dependency: python3-dkim.
108 Changes in version 0.9.0 - 2019-10-16
110     * FIXES https://bugs.torproject.org/26543
111     Implement a language switcher that allows users to override the locale that
112     BridgeDB automatically selects by inspecting the client's request headers.
114 Changes in version 0.8.3 - 2019-10-03
116     * FIXES https://bugs.torproject.org/31903
117     Update existing translations and request new translations.  Thanks to all
118     volunteers who helped translate BridgeDB!
120     * FIXES https://bugs.torproject.org/31780
121     We implemented BridgeDB's metrics in #9316 but haven't specified its format
122     until now.  In addition to adding a specification, this patch also makes our
123     implementation consistent with our (slightly updated) specification.
125     * FIXES https://bugs.torproject.org/29484
126     Update BridgeDB's requirements to the latest respective versions.  Among
127     others, this patch set updates Twisted to 19.7.0, pyOpenSSL to 19.0.0, and
128     replaces (the abandoned) PyCrypto with PyCryptodome, which fixes security
129     vulnerabilities.
131 Changes in version 0.8.2 - 2019-09-20
133     Updated translations for the following languages:
134     bn, da, eo, fa, it, ko, nl, pt_BR, pt_PT, sr, zh_CN.
136 Changes in version 0.8.1 - 2019-09-11
138     * FIXES https://bugs.torproject.org/17626
139     BridgeDB gets confused when users reply to a "get help" email.  The issue is
140     that BridgeDB interprets commands anywhere in the email body, even if it's
141     in quoted text.  To fix this issue, we are ignoring commands whose email
142     body line starts with a '>' character, which is typically used for email
143     quotes.
145     * FIXES https://bugs.torproject.org/28533
146     The frontdesk is seeing plenty of empty bogus emails.  This fix removes the
147     email links and instead encourages users to take a look at the Tor Browser
148     Manual and at our Support Portal.
150 Changes in version 0.8.0 - 2019-08-20
152     * FIXES https://bugs.torproject.org/9316
153     Make BridgeDB export usage metrics every 24 hours.  At the end of each
154     24-hour measurement interval, BridgeDB will append usage metrics to the file
155     METRICS_FILE, which is configured in bridgedb.conf.  Our metrics keep track
156     of the number of (un)successful requests per transport type per country code
157     (or email provider) per distribution method.  This way, we get to learn
158     that, say, over the last 24 hours there were 31-40 users in Iran who
159     successfully requested an obfs4 bridge over Moat.
161     * FIXES #26542 https://bugs.torproject.org/26542
162     Make BridgeDB distribute vanilla IPv6 bridges again.
164     * FIXES #22755 https://bugs.torproject.org/22755
165     Use stem instead of leekspin to create test descriptors.  We now don't need
166     to depend on leekspin anymore.
168     * FIXES #31252 https://bugs.torproject.org/31252
169     Add an anti-bot mechanism that allows us to detect bots by matching HTTP
170     request headers for blacklisted patterns.  For example, bots may have their
171     Accept-Language set to "Klingon".  Blacklisted patterns are configured in
172     BLACKLISTED_REQUEST_HEADERS_FILE.  When BridgeDB detects a bot request, we
173     can answer their request with a decoy bridge that's only handed out to bots.
174     Decoy bridges are configured in DECOY_BRIDGES_FILE.
176 Changes in version 0.7.1 - 2019-06-07
178     * FIXES #28496 https://bugs.torproject.org/28496
179     Remove Yahoo from the list of allowed email domains.  Yahoo allows you to
180     create up to 500 disposable email addresses, which BridgeDB interprets as
181     unique:
182     https://bugs.torproject.org/28496#comment:8
183     We could address this issue in BridgeDB but at this point we seem better off
184     dropping support for Yahoo because the provider likely also fell behind in
185     Sybil protection.
187 Changes in version 0.7.0 - 2019-06-07
189     * FIXES #28655 https://bugs.torproject.org/28655
190     When a bridge supports an active probing-resistant transport, it should not
191     give out flavors that are vulnerable to active probing.  For example, if a
192     bridge supports obfs4 and obfs3, it should only give out obfs4.
194     * FIXES #30706 https://bugs.torproject.org/30706
195     Do some simple BridgeDB housekeeping: Add missing CHANGELOG entries, add
196     Philipp's contact info to the support section, fix a broken Trac URL, and
197     turn HTTP link into HTTPS.
199     * FIXES #30157: https://bugs.torproject.org/30157
200     Update BridgeDB translations.  This ticket both adds new translations and
201     updates existing ones.
203 Changes in version 0.6.9 - 2018-11-20
205     * FIXES #23894 https://bugs.torproject.org/23894
206     Really change the contact address, in the correct place this time.
208 Changes in version 0.6.8 - 2018-11-19
210     * FIXES #28528 https://bugs.torproject.org/28528
211     Change maintainer info.
213     * FIXES #23894 https://bugs.torproject.org/23894
214     Change contact email address.
216 Changes in version 0.6.7 - 2018-05-21
218     Print fingerprints in hex thank you very much.
220 Changes in version 0.6.6 - 2018-05-21
222     * FIXES #26150 https://bugs.torproject.org/26150
223     Hotfix for strange bridges missing address fields.
225 Changes in version 0.6.5 - 2018-05-04
227     * FIXES #26023 https://bugs.torproject.org/26023
228     There's few bridges whose ed25519 certificates contain the year 491869,
229     which the datetime module (called from Stem) believes "out of range". So
230     instead we'll parse the descriptors one at a time and catch the errors as we
231     go.
233     * FIXES #25246 https://bugs.torproject.org/25246
234     Add script for assigning unallocated bridges to another distributor.
236 Changes in version 0.6.4 - 2018-02-13
238     * FIXES #24432 https://bugs.torproject.org/24432
239     Add config option to skip loopback addresses in X-Forwarded-For parsing.
241 Changes in version 0.6.3 - 2018-01-23
243     * FIXES #24432 https://bugs.torproject.org/24432
244     The production moat server had issues related to redirecting to resources
245     properly, which are now fixed.
247     * FIXES #24701 https://bugs.torproject.org/24701
248     Adds a special surprise for the special someone who has been automatedly
249     requesting bridges not through driving a browser, but through a script which
250     is so thoroughly stupid that it doesn't even send the URL parameters for the
251     CAPTCHA challenge and solution.  Their script will now be delayed for quite
252     some time and then rickrolled.  Mess with the best, die like the rest.
254     * FIXES #24704 https://bugs.torproject.org/24704
255     Bridges returned to a single request are now filtered such that there will
256     never be two bridges from the same IPv4 /16 or IPv6 /64.
258 And includes the following general changes:
260     * ADDS unittests for the legacy code in bridgedb/Bridges.py,
261     bringing the total test coverage above 90% for the first time.
263 Changes in version 0.6.2 - 2017-12-20
265     * FIXES #24636 https://bugs.torproject.org/24636
266     The moat API specification included an extra response type which could be
267     sent if there was no overlap between transports the client supported and
268     those which the server supported.  This has been removed from the
269     specification, which now describes the behaviour moat has always exhibited:
270     if there is no overlap, the server responds with a CAPTCHA image response
271     which includes the list of transports it does support.
273     * FIXES #24637 https://bugs.torproject.org/24637
274     The moat server did not respond correctly with the specified JSON API error
275     type when there were no bridges available.  It now responds correctly with a
276     404 error whose details describe why the request could not be fulfilled.
277     The moat server also now logs messages if there were not the configured
278     MOAT_BRIDGES_PER_RESPONSE number of bridges available.
280 Changes in version 0.6.1 - 2017-12-13
282     * ADDS a shell script, scripts/test-moat, for testing either a
283     locally-running moat server, or a remote one through a meek tunnel.  Thanks
284     to David Fifield for his work on meek, assistance setting it up, and
285     providing the first version of this script.
287     * FIXES #24433 https://bugs.torproject.org/24433
288     The test-moat script wasn't sending an X-Forwarded-For header, which
289     triggered a bug in the moat server, since the CAPTCHA solution includes an
290     HMAC based on the client's IP (forwarded through all the several layers of
291     tunnels/proxies).
293     * FIXES #24443 https://bugs.torproject.org/24443
294     Due to a difference between how booleans are parsed by Python's json library
295     and normal Python booleans, the moat server was generating and returning
296     QRCodes… regardless of whether the remote client application asked for one.
297     This is now fixed.
299     * FIXES #24460 https://bugs.torproject.org/24460
300     There was an unhandled error when sending certain (what appears to be
301     possibly malicious? but in a very strange way) requests to BridgeDB's HTTPS
302     distributor.  The robots making the requests were attempting to request
303     bridges, but were presenting a CAPTCHA solution without the correct HTML
304     form field parameters present, which isn't possible through normal usage of
305     the web interface.  Whoever or whatever is doing this is now going to be
306     endlessly redirected so that they may forever spiral in their own private
307     internet hell.  I reserve the right come up with a worse fate for them
308     later, should I get bored.
310     * FIXES #3015 https://bugs.torproject.org/3015
311     BridgeDB has had a partially-implemented concept of "buckets" since the age
312     of the dinosaurs: write some of the unallocated bridges to a file which
313     should (somehow) be manually distributed.  In addition to be unused and
314     untested, there were several issues with the buckets, the most significant
315     of which were the inability to request pluggable transports in a bucket and
316     the fact that buckets were not persistent in any way (e.g. if i request a
317     bucket of 50 bridges for Gomez and another with 50 for Morticia, they might
318     end up with some of the same bridges, further, tomorrow they'll end up with
319     50 possibly different bridges than those they received today).  All of this
320     code is now removed.
322 And includes the following general changes:
324     * FIXES issues with JSON quote syntax and a mistaken JSON API
325     "type" parameter in the specification of the moat server (in the README).
326     Thanks to Mark Smith and Kathy Brade for pointing out the issues.
328 Changes in version 0.6.0 - 2017-11-15
330     * ADDS a new JSON API distributor called "moat", which is intended
331     for use for Tor Launcher to use to build an in-browser UI for retrieving
332     bridges.
334     * CHANGES the organisation of code to add a new
335     bridgedb.distributors package as well as a bridgedb.distributors.common
336     package for code shared between multiple distributors.
338 Changes in version 0.5.0 - 2017-10-28
340     * FIXES #23957 https://bugs.torproject.org/23957
341     BridgeDB now supports bridge operators choosing how their bridge will be
342     distributed.  See the "BridgeDistribution" torrc option in tor's manpage for
343     details.
345     * FIXES #16650 https://bugs.torproject.org/16650
346     BridgeDB is now accessible via select remote user interfaces through a meek
347     tunnel.
349     * FIXES #22998 https://bugs.torproject.org/23033
350     * FIXES #23033 https://bugs.torproject.org/23033
351     * FIXES #23034 https://bugs.torproject.org/23034
352     Upgrades BridgeDB to newer versions of Twisted and PyOpenSSL, and fixes
353     several issues due to non-backwards compatible changes within those
354     libraries.
356 Changes in version 0.4.0 - 2017-01-09
358     * FIXES #21162 https://bugs.torproject.org/21162
359     BridgeDB now supports arbitrarily blacklisting suspected bad bridges from
360     being distributed to clients.  This is in response to a suspected sybil
361     attack by an unknown party.  For more details, see:
362     https://lists.torproject.org/pipermail/tor-project/2016-December/000851.html
364 Changes in version 0.3.8 - 2016-09-22
366     * FIXES #20088 https://bugs.torproject.org/20088
367     BridgeDB now supports receiving descriptors from multiple Bridge
368     Authorities.  See also #19690.
370     * FIXES #20087 https://bugs.torproject.org/20087
371     BridgeDB's version of Stem now supports parsing transport lines in bridge
372     extrainfo descriptors which contain IPv6 addresses contained within square
373     brackets.
375 Changes in version 0.3.7 - 2016-08-04
377     * FIXES #19691 https://bugs.torproject.org
378     BridgeDB (as running on Tor Project infrastructure) is now invocated with a
379     redirection of stdout and stderr to the flog utility, in order to ensure
380     that file handles are properly closed and reopened when BridgeDB receives a
381     SIGHUP.
383 And includes the following general changes:
385     * ADDS some files which were missing from BridgeDB PyPI packages
386     to the MANIFEST.in, so that they are now included.
388 Changes in version 0.3.6 - 2016-07-28
390     * FIXES #18237 https://bugs.torproject.org/18237
391     During descriptor parsing, BridgeDB saves copies of descriptor files which
392     couldn't be parsed, for later debugging purposes.  To avoid filing up the
393     runtime directory with these files, we now delete files older than 24 hours,
394     every 24 hours.
396     * FIXES #18949 https://bugs.torproject.org/18949
397     Since we've upgraded the host machine which runs The Tor Project's BridgeDB
398     instance to Debian Jessie, this patch updates the testing configurations and
399     continuous integration infrastructure to run tests on versions of Python
400     dependencies in Debian Jessie and Stretch.
402 Changes in version 0.3.4 - 0.3.5 - 2015-11-30
404     * FIXES #14685 https://bugs.torproject.org/14685
405     This disables distribution of obfs2 bridges.  This pluggable transport has
406     known distiguishers which allow adversaries to identify client connections
407     to obfs2 bridges, which in turn allows these connections to be
408     blocked/censored.  With numerous obfs3 and obfs4 bridges both readily
409     available, users should not be presented with an easily-configurable choice
410     that is known to be unsafe for the majority of users.
412 And includes the following general changes:
414     * ADDS error pages to BridgeDB's web interface, to provide
415     friendlier explanations for downtime, missing pages, and internal server
416     errors.  For example: https://bridges.torproject.org/404
418 Changes in version 0.3.3 - 2015-10-25
420     * FIXES #12029 https://bugs.torproject.org/12029
421     BridgeDB now has an API for creating Bridge Distributors.  See the
422     bridgedb.distribute module, or its developer documentation at
423     https://pythonhosted.org/bridgedb/bridgedb.distribute.html.
425     * FIXES PART OF #12506  https://bugs.torproject.org/12506
426     BridgeDB's two Distributors (HTTPS and Email) are now entirely modularised
427     and self-contained within separate subdirectories in the source code.  This
428     is the first step to redesigning these Distributors into their own separate
429     processes, which will allow the Distributors to remain functional while
430     BridgeDB is reparsing bridge descriptors.
432     * FIXES #15968 https://bugs.torproject.org/15968
433     BridgeDB now sends a Content-Security-Policy header which explicitly allows
434     Javascript, images, CSS, and fonts, from https://bridges.torproject.org.
435     All other types of content are forbidden, including:
436       - embedding https://bridges.torproject.org within
437         <iframe>, <embed>, or <object>, and attempting to source
438         additional resources into its embedded context
439       - inline Javascript, including Javascript within SVG files
440       - inline CSS
441       - externally hosted fonts
442       - inline SVG, e.g. via the HTML5 <svg> tag
443       - any and all connections made via Javascript XMLHttpRequests,
444         WebSockets, sendBeacon(), and Web Workers
445       - plugins
446       - applets
447     BridgeDB's Content-Security-Policy does not yet make use of certain newer,
448     lesser supported, Content-Security-Policy v2.0 directives, such as
449     "reflected-xss" and "frame-ancestors", but may someday.
451     * FIXES #16273 https://bugs.torproject.org/16273
452     Several links to Tor Project gitweb URLs within the developer documentation
453     were outdated in that they still used the old gitweb URL format.  These are
454     now updated.  Thanks to David Fifield for the bug report and patches.
456     * FIXES #16330 https://bugs.torproject.org/16330
457     BridgeDB can now handle bridge-server-descriptors with extra-info-digest
458     fields which have two values, as well as both bridge-server-descriptors and
459     bridge-extrainfo descriptors which contain Ed25519 key material and
460     signatures.  See Tor proposals #220 and #228 for more information on the
461     changes to these descriptors.  Note that BridgeDB can now parse this
462     information, but does not yet make use of any Ed25519 cryptographic material
463     within bridge descriptors.
464     https://gitweb.torproject.org/torspec.git/tree/proposals/220-ecc-id-keys.txt
465     https://gitweb.torproject.org/torspec.git/tree/proposals/228-cross-certification-onionkeys.txt
466     Thanks to Atagar for patching Stem.
468     * FIXES #16616 https://bugs.torproject.org/16616
469     The HSDir flag can now be included within bridge-networkstatus documents.
470     BridgeDB now has unittests which guarantee that its parsers safely ignore
471     this flag, as well as any flags unknown to BridgeDB which may appear in the
472     future.  Thanks to Roger Dingledine for alerting me about the change.
474     * FIXES #16649 https://bugs.torproject.org/16649
475     Mobile users, and other users with small screen pixel ratios, will find that
476     the UI of BridgeDB's HTTPS Distributor has greatly increased in usability
477     and readability.
479 And includes the following general changes:
481     * FIXES an error when requesting the non-HTML version of the
482     bridges page (e.g. https://bridges.torproject.org/bridges?format=plain)
484     * REMOVES the `bridgedb test` commandline option.
485     BridgeDB's tests can be run via `python setup.py test` or `make test` (or
486     `make coverage` for generating HTML test coverage statistics).
488     * CHANGES the HTTPS Distributor to HTML-encode Bridge Lines.
489     Previously, a malicious Pluggable Transport Bridge could include in its PT
490     arguments something like "evil=<script>[…]</script>" and if such a Bridge
491     were to be distributed to a user, that user's web browser would execute the
492     script (if Javacript was enabled).  Other characters, including non-ASCII,
493     control characters, double quotes, and backslashes, are also sanitised from
494     Bridge Lines.  Thanks to Robert Ransom for the patches.
496     * CHANGES BridgeDB's module/package version numbers to be compliant with
497     PEP440.
499     * CHANGES the layout of BridgeDB's source code directories.
500     Rather than storing BridgeDB's source in "lib/bridgedb/", it is now kept in
501     "bridgedb/".  Similarly, the directory containing BridgeDB's tests has been
502     moved from "lib/bridgedb/test/" to "test/", which means that the tests are
503     no longer installed when running `python setup.py install` or `make
504     install`.
506     * ADDS several improvements to the developer documentation at
507     https://pythonhosted.org/bridgedb.
509     * UPDATE English (en_US) translations.
511     * UPDATE English (en) translations.
513     * ADD Serbian (sr) translations.
514       Thanks to obj.petit.a, Ivan Radeljic, and Milenko Doder.
516     * UPDATE Arabic (ar) translations.
517       Thanks to  A. Hassan, debo debo, KACIMI LAMINE, and Nudroid A.
519     * UPDATE Catalan (ca) translations.
520       Thanks to laia_.
522     * UPDATE Czech (cs) translations.
523       Thanks to Tomas Palik and Vlastimil Burián.
525     * UPDATE Danish (da) translations.
526       Thanks to Mogelbjerg.
528     * UPDATE German (de) translations.
529       Thanks to jschfr, Junge Limba, and Toralf Förster.
531     * UPDATE English (en_GB) translations.
532       Thanks to Andi Chandler.
534     * UPDATE Farsi (fa) translations.
535       Thanks to some awesome anonymous person for helping out.
537     * UPDATE Finish (fi) translations.
538       Thanks to Riku Viitanen.
540     * UPDATE French (fr) translations.
541       Thanks to elouann, Trans-fr, and Towinet.
543     * UPDATE French (fr_CA) translations.
544       Thanks to Trans-fr.
546     * UPDATE Croatian (hr_HR) translations.
547       Thanks to some awesome anonymous person for helping out.
549     * UPDATE Hungarian (hu) translations.
550       Thanks to some awesome anonymous person for helping out.
552     * UPDATE Indonesian (id) translations.
553       Thanks to Anthony Santana, Astryd Viandila Dahlan, cholif yulian,
554       constantius damar wicaksono, Dwi Cahyono, L1Nus, km242saya, and Zamani
555       Karmana.
557     * UPDATE Italian (it) translations.
558       Thanks to Random_R.
560     * UPDATE Japanese (ja) translations.
561       Thanks to ABE Tsunehiko.
563     * UPDATE Latvian (lv) translations.
564       Thanks to Ojārs Balcers.
566     * UPDATE Norwegian Bokmål (nb) translations.
567       Thanks to Erik Matson and Kristian Andre Henriksen.
569     * UPDATE Dutch (nl) translations.
570       Thanks to Mart3000.
572     * UPDATE Polish (pl) translations.
573       Thanks to Karol Obartuch.
575     * UPDATE Portuguese (pt) translations.
576       Thanks to Bruno D. Rodrigues and MMSRS.
578     * UPDATE Brazillian Portuguese (pt_BR) translations.
579       Thanks to Communia.
581     * UPDATE Romanian (ro) translations.
582       Thanks to  Ana, axel_89, and Di N.
584     * UPDATE Russian (ru) translations.
585       Thanks to Ivan.
587     * UPDATE Slovak (sk_SK) translations.
588       Thanks to StefanH.
590     * UPDATE Albanian (sq) translations.
591       Thanks to  some awesome unknown anonymous person who didn't add their name
592       to the list of translators.
594     * UPDATE Swedish (sv) translations.
595       Thanks to Peter Michanek.
597     * UPDATE Turkish (tr) translations.
598       Thanks to Bullgeschichte and Fomas.
600     * UPDATE Ukranian (uk) translations.
601       Thanks to Yasha.
603     * UPDATE Chinese Mandarin (zh_CN) translations.
604       Thanks to khi.
606     * UPDATE Taiwanese Mandarin (zh_TW) translations.
607       Thanks to x4r.
609 Changes in version 0.3.2 - 2015-05-01
611     * FIXES a problem with the calculation of Levenshtein distances
612     between blacklisted email addresses and those on incoming email. This fixes
613     a problem with the fuzzy matching implemented in #9385:
614     https://bugs.torproject.org/9385.
616     * FIXES #1839 https://bugs.torproject.org/1839
617     BridgeDB's distributors now rotate their hashrings at configurable scheduled
618     intervals.
620     * FIXES #4771 https://bugs.torproject.org/4771
621     BridgeDB now records which of the HTTPS Distributor's sub-hashrings are used
622     for clients coming from Tor Exit nodes and other known proxies.
624     * FIXES #12504 https://bugs.torproject.org/12504
625     Which Pluggable Transports BridgeDB distributes is now easily configurable
626     via the bridgedb.conf configuration file.
628     * FIXES #13202 https://bugs.torproject.org/13202
629     Old bridges running Tor-0.2.4.x with Pluggable Transports like scramblesuit
630     and obfs4proxy have a bug which causes them to not include the PT arguments
631     in the `transport` line they submit to the BridgeAuthority in their
632     extrainfo descriptors.  This causes BridgeDB to have broken bridge lines for
633     these bridges.  For example, scramblesuit requires a `password=` in the
634     `ClientTransportPlugin` for clients to connect to it.  If BridgeDB receives
635     a line in that bridge's extrainfo which says `transport scramblesuit
636     1.2.3.4:1234` (without a password), then when BridgeDB gives clients a
637     bridge line for that bridge, it'll look like "Bridge scramblesuit
638     1.2.3.4:1234" - meaning that it won't work.  This fixes the issue by
639     excluding broken transports from being distributed to clients.
641     * FIXES #15517 https://bugs.torproject.org/15517
642     For all clients who are coming from IPv6 addresses and are not using Tor,
643     who go to https://bridges.torproject.org, BridgeDB now groups these clients
644     together by /32.  This "grouping" causes all IPv6 clients within the same
645     IPv6 /32 to get the same bridges.  Previously, BridgeDB grouped IPv6 clients
646     by /64 (which is ridiculously small, considering standard IPv6 allocation
647     sizes).
649     For all clients who are coming from IPv4 addresses and are not using Tor,
650     BridgeDB now groups these clients together by /16.  Previously, BridgeDB
651     grouped IPv4 clients by /24.  (This latter change was technically made as
652     part of #4771.)
654     * FIXES #15464 https://bugs.torproject.org/15464
655     The setup procedure for creating a BridgeDB Continuous Integration build
656     machine is now simplified and generalised to include build environments like
657     Jenkins, not just TravisCI.
659     * FIXES #15866 https://bugs.torproject.org/15866
660     BridgeDB now ignores nearly all the information in the networkstatus-bridges
661     file created by the BridgeAuthority.
663     * ADDS benchmark tests to BridgeDB's test suite, and some of
664     BridgeDB's algorithms have been revised to improve their speed.
666 Changes in version 0.3.1 - 2015-03-24
668     * FIXES #14065 https://bugs.torproject.org/14065
669     When requesting vanilla IPv6 bridges from https://bridges.torproject.org,
670     BridgeDB would respond with IPv4 addresses.  It now correctly responds with
671     IPv6 addresses.
673 And includes the following general changes:
675     * FIXES an issue with the filtering of hashrings while answering
676     requests for Pluggable Transports. (commit 3ef37df6)
678     * FIXES the return value from the GnuPG interface initialization
679     function (bridgedb.crypto.initializeGnuPG) when creating a test signature
680     has failed.
682     * CHANGES the way BridgeDB handles the case where it parses to
683     duplicate extrainfo descriptors (for the same Bridge) which also have
684     identical timestamps.  Before, we assumed this wasn't possible.  It turns
685     out that it not only is possible, but that usually every batch of
686     descriptors has at least one Bridge with such a set of perfectly identical
687     extrainfo descriptors.  Even stranger, it appears that only Bridges started
688     for the first time quite recently (within the last eight hours) display this
689     behaviour.  BridgeDB now logs these errors, rather than leaving them
690     unhandled.  (commit a27d7905)
692     * ADDS an environment variable check to setup.py which controls
693     whether the setup.py script tries to install the dependencies listed in the
694     requirements.txt file with easy_install.  If the environment variable
695     BRIDGEDB_INSTALL_DEPENDENCIES=0, then setup.py will not use easy_install.
696     When BridgeDB is installed via `make install` the default is to not use
697     easy_install; however, when installed via `python setup.py install`, the
698     default is to use easy_install to check for, find, and install dependencies.
699     (NOTE: the latter is *not* recommended.) (commit d035fe64)
701 Changes in version 0.3.0 - 2015-03-21
703     * FIXES #2895 https://bugs.torproject.org/2895
704     BridgeDB no longer assumes that any extrainfo descriptor files are in
705     chronological order.
707     * FIXES #4405 https://bugs.torproject.org/4405
708     BridgeDB now has a built-in timer mechanism for scheduling cronjobesque
709     events. This is now used to routinely download and parse the list of Tor
710     exit relays in a completely asynchronous manner.
712     * FIXES #9380 https://bugs.torproject.org/9380
713     BridgeDB now uses Stem (https://stem.torproject.org) for its parsers, and
714     has better classes for parsing and storing information on Bridges and their
715     Pluggable Transports.  Additionally, all of BridgeDB's parses and the new
716     Bridge/PluggableTransport classes all have 100% unittest and integration
717     test coverage.
719     * FIXES #10385 https://bugs.torproject.org/10385
720     BridgeDB now uses python-gnupg (https://pypi.python.org/gnupg) instead of
721     GPGME (libgpgme11 and pygpgme). Previously, when using GPGME, BridgeDB was
722     unable to sign emails with a subkey whose master private key was not
723     present, causing all signing to be broken. Additionally, GPGME tried to
724     access and modify the BridgeDB users $HOME directory, and GPGME would also
725     try to create signatures with encryption-only subkeys, and try to
726     encrypt/decrypt with signing-only subkeys. All of these issues are no more,
727     because the writhing tangled mass of bugs known ad GPGME is gone for good.
729     * FIXES #11216 https://bugs.torproject.org/11216
730     BridgeDB no longer parses any extrainfo descriptor files cumulatively.
731     Before, a Bridge which had a descriptor in cached-extrainfo and in
732     cached-extrainfo.new and supported obfs3, obfs4, and scramblesuit transports
733     would be parsed twice, resulting in the Bridge having six transports. This
734     is no longer the case.
736     * HOTFIXES an issue with non-deterministic unittest failures in
737     the Mechanize-based integrations tests in lib/bridgedb/test/test_https.py.
738     hotfix/0.2.4-mechanize-tags
740     * FIXES part of #12507 https://bugs.torproject.org/12507
741     BridgeDB now has semi-automated developer documentation builds at
742     https://pythonhosted.org/bridgedb/.
744     * FIXES #12805 https://bugs.torproject.org/12805
745     BridgeDB is now packaged on PyPI, in the hopes that someday other
746     organisations will be able to run their own BridgeDBs.
748     * FIXES #12843 https://bugs.torproject.org/12843
749     BridgeDB will no longer distribute bridges which it believes are located in
750     Iran or Syria.
752     * FIXES #12872 https://bugs.torproject.org/12872
753     BridgeDB now has geolocational information for Bridges, telling it which
754     country each Bridge's primary ORAddress is within, as well as geolocational
755     information for each PluggableTransport address.  Thanks to Alden S. Page
756     for the patches.
758     * FIXES #15155 https://bugs.torproject.org/15155
759     The instructions for obtaining a copy of Tor Browser should now be more
760     clear.  Thanks to Jens Kubieziel, Nick Mathewson, and Peter Palfrader.
762 And includes the following general changes:
763     * CHANGES BridgeDB's continuous integration infrastructure to run
764     tests for:
765             - Twisted-13.2.0 (Debian Wheezy version),
766             - Twisted-14.0.2 (Debian Jessie version), and
767             - Twisted-15.0.0 (latest and greatest)
768     As well as testing both:
769             - pyOpenSSL-0.13.1 (Debian Wheezy version), and
770             - pyOpenSSL-0.14 (Debian Jessie version).
771     See https://travis-ci.org/isislovecruft/bridgedb/builds
773     * FIXES an issue with the $PYTHON_EGG_CACHE directory being group
774     writable on Travis-CI build machines.
776     * UPDATE English (en_US) translations.
778     * UPDATE English (en) translations.
780     * ADD Tamil (ta) translations.
781       Thanks to git12a.
783     * ADD Albanian (sq) translations.
784       Thanks to Bujar Tafili.
786     * ADD Slovenian (sl_SI) translations.
787       Thanks to Dušan, marko, and Nwolfy.
789     * ADD Slovak (sk_SK) translations.
790       Thanks to once.
792     * ADD Esperanto (eo) translations.
793       Thanks to identity, Rico Chan, and trio.
795     * ADD Bulgarian (bg) translations.
796       Thanks to aramaic.
798     * ADD Azerbaijani (az) translations.
799       Thanks to E.
801     * UPDATE Chinese (zh_TW) translations.
802       Thanks to LNDDYL.
804     * UPDATE Chinese (zh_CN) translations.
805       Thanks to Wu Ming Shi and YF.
807     * UPDATE Ukranian (uk) translations.
808       Thanks to Eugene ghostishev, LinuxChata, Oleksii Golub, and
809       Андрій Бандура.
811     * UPDATE Turkish (tr) translations.
812       Thanks to eromytsatiffird, Emir Sarı, Idil Yuksel, ozkansib,
813       Volkan Gezer, and zeki.
815     * UPDATE Swedish (sv) translations.
816       Thanks to Anders Jensen-Urstad, Emil Johansson, GabSeb, ph AA, phst,
817       and leveebreaks.
819     * UPDATE Slovak (sk) translations.
820       Thanks to elo, FooBar, Michal Slovák, Roman 'Kaktuxista' Benji, and
821       StefanH.
823     * UPDATE Russian (ru) translations.
824       Thanks to Andrey Yoker Ogurchikov, Evgrafov Denis, foo,
825       joshuaridney, Oleg, Sergey Briskin, Valid Olov, and Vitaliy Grishenko.
827     * UPDATE Romanian (ro) translations.
828       Thanks to Isus Satanescu, laura berindei, and clopotel.
830     * UPDATE Portuguese (pt_BR) translations.
831       Thanks to João Paulo S.S.
833     * UPDATE Portuguese (pt) translations.
834       Thanks to alfalb.as, André Monteiro, kagazz, Manuela Silva,
835       alfalb_mansil, Andrew_Melim, Pedro Albuquerque, Sérgio Marques, and
836       TiagoJMMC.
838     * UPDATE Polish (pl) translations.
839       Thanks to Aron, JerBen, bogdrozd, Dawid, Rikson, Krzysztof Łojowski,
840       oirpos, and seb.
842     * UPDATE Dutch (nl) translations.
843       Thanks to Adriaan Callaerts, Ann Boen, Cleveridge, Dick,
844       Johann Behrens, Shondoit Walker, Marco Brohet, guryman, Marco
845       Brohet, Tom Becht, Tonko Mulder, math1985, and BBLN.
847     * UPDATE Norwegian Bokmål (nb) translations.
848       Thanks to Allan Nordhøy, Harald, lateralus, Per Thorsheim,
849       and thor574.
851     * UPDATE Latvian (lv) translations.
852       Thanks to Ojārs Balcers and ThePirateDuck.
854     * UPDATE Khmer (km) translations.
855       Thanks to Seng Sutha, Sokhem Khoem, and Sok Sophea.
857     * UPDATE Japanese (ja) translations.
858       Thanks to brt, ABE Tsunehiko, タカハシ, Masaki Saito, and
859       藤前 甲.
861     * UPDATE Italian (it) translations.
862       Thanks to fetidyoo, Francesca Ciceri, HostFat, ironbishop, and
863       Jacob Appelbaum.
865     * UPDATE Hungarian (hu) translations.
866       Thanks to Blackywantscookies, Lajos Pasztor, Cerbo, and vargaviktor.
868     * UPDATE Croatian (hr) translations.
869       Thanks to Ana B, Armando Vega, skiddiep, Tomislav Siroglavić,
870       and gogo.
872     * UPDATE French (fr_CA) translations.
873       Thanks to Lunar, mehditaileb, Onizuka, and yahoe.001.
875     * UPDATE French (fr) translations.
876       Thanks to apaddlingduck, fayçal fatihi, Boubou, Cryptie,
877       Frisson Reynald, hpatte, Lucas Leroy, Lunar, Onizuka, and mehditaileb.
879     * UPDATE Finnish (fi) translations.
880       Thanks to Jorma Karvonen, Spacha, Ossi Kallunki, Sami Kuusisto,
881       viljaminojonen, and Finland355.
883     * UPDATE Farsi (fa) translations.
884       Thanks to arashaalaei, signal89, ardeshir, Gilberto, johnholzer,
885       Mohammad Hossein, perspolis, and Setareh.
887     * UPDATE Spanish (es) translations.
888       Thanks to dark_yoshi, toypurina, BL, NinjaTuna, Noel Torres,
889       Paola Falcon, strel, and Jonis.
891     * UPDATE English (en_GB) translations.
892       Thanks to Andi Chandler, Richard Shaylor, and ronnietse.
894     * UPDATE Greek (el) translations.
895       Thanks to Adrian Pappas, andromeas, oahanx, isv31, and kotkotkot.
897     * UPDATE German (de) translations.
898       Thanks to trantor, Ettore Atalan, unknwon_anonymous, konstibae,
899       Locke, Tobias Bannert, qbi, Sebastian, and debakel.
901     * UPDATE Danish (da) translations.
902       Thanks to Christian Villum, David Nielsen, OliverMller, torebjornson,
903       Thomas Pryds, and Tore Bjørnson.
905     * UPDATE Czech (cs) translations.
906       Thanks to A5h8d0wf0x, Adam Slovacek, Elisa, Sanky, Jiří Vírava,
907       mxsedlacek, and Radek Bensch.
909     * UPDATE Catalan (ca) translations.
910       Thanks to Albert, Assumpta Anglada, Eloi García i Fargas, Humbert,
911       and laia_.
913     * UPDATE Arabic (ar) translations.
914       Thanks to Ash and Valetudinarian.
916 Changes in version 0.2.4 - 2015-02-03
918     * HOTFIXES a UnicodeDecodeError resulting from patches for #12627.
919     https://bugs.torproject.org/12627
921     * FIXES #9874 https://bugs.torproject.org/9874
922     BridgeDB now has integration tests for all bridge distributors.  Thanks to
923     trygve for the patches.
925     * FIXES #12871 https://bugs.torproject.org/12871
926     Bridge Buckets now work, even if the code for calculating Bridge stability
927     is disabled.  Thanks to Matt Finkel for the patches.
929     * FIXES part of #12029 https://bugs.torproject.org/12029
930     Major sections of the bridgedb.Bridges module, which holds BridgeDB's main
931     data structures for storing and parsing Bridges, have been refactored in
932     preparation for upcoming changes to use Stem's parsers (see #9380
933     https://bugs.torproject.org/9380)
935     * FIXES #12932 https://bugs.torproject.org/12932
936     Arguments for Pluggable Transports in the bridge lines which BridgeDB
937     distributes to users are now properly space-separated. This issue was
938     affecting the deployment of the obfs4 PT (see #12130
939     https://bugs.torproject.org/12130).
941     * FIXES #13123 https://bugs.torproject.org/13123
942     Previously, there were two additional whitespace characters at the beginning
943     of bridge lines handed out by BridgeDB's HTTPS distributor, which would be
944     annoyingly copy+pasted into TorLauncher and torrcs, etc.  These are now
945     gone.
947     * FIXES #12664 https://bugs.torproject.org/12664
948     Previously, for the bridge lines handed out by BridgeDB's HTTPS distributor,
949     the newlines were not properly pasted when a user would copy+paste the
950     lines. This is now fixed. Additionally, there is now a "Select All" button
951     (JS must be enabled) to select all text for the bridge lines, to attempt to
952     reduce user copy+paste errors.  If the display area which contains the
953     bridge lines is clicked, and JS is enabled, it has the same effect as
954     clicking the "Select All" button.
956     * FIXES #14064 https://bugs.torproject.org/14064
957     The bridge lines handed out by BridgeDB's HTTPS distributor are now
958     displayed with a horizontal scrollbar if they are too long to fit into the
959     display area.
961     * FIXES #11345 https://bugs.torproject.org/11345
962     BridgeDB now supports giving users QRCodes for their bridge lines, to
963     facilitate getting bridges into Tails and onto mobile devices.
965     * FIXES #12130 https://bugs.torproject.org/12130
966     BridgeDB's distributors now have options to distribute obfs4 bridges.
968 And includes the following general changes:
969     * CHANGES the integration tests based on Mechanize to only run on
970     CI servers, not locally on developers laptops, since it requires the running
971     BridgeDB test/staging instance to offer a plaintext HTTP interface. See
972     commit 24acf6a72.
973     https://gitweb.torproject.org/bridgedb.git/commit/?id=24acf6a72931c602631c97dbbeb582c22cf446cb
975     * ADDS better installation instructions in README.rst for
976     developers who wish to test their changes to BridgeDB.  Thanks to Alden Page
977     for the patch.
979 Changes in version 0.2.3 - 2014-07-26
981     * FIXES #5463 https://bugs.torproject.org/5463
982     BridgeDB can now OpenPGP sign outgoing emails.
984     * FIXES #9385 https://bugs.torproject.org/9385
985     BridgeDB now has the ability to blacklist email addresses, and configurable
986     options to fuzzy match and block addresses which are similar enough to those
987     in the blacklist.
989     * FIXES #11139 https://bugs.torproject.org/11139
990     You can now email BridgeDB from Riseup email addresses!
992     * FIXES #12147 https://bugs.torproject.org/12147
993     An additional issue with BridgeDB's code for scheduling actions was
994     identified by Robert Ransom, who also provided a unittest to demonstrate the
995     issue and test for future regressions. The issue pointed out has also been
996     fixed.
998     * FIXES #12635 https://bugs.torproject.org/12635
999     The links in BridgeDB's email and HTTPS distributor UIs have been changed
1000     from the obsolete
1001     https://www.torproject.org/projects/torbrowser.html.en#downloads-beta
1002     to
1003     https://www.torproject.org/projects/torbrowser.html.
1005     * FIXES #12650 https://bugs.torproject.org/12650
1006     BridgeDB's translation files sometimes take a little while to update because
1007     real live human volunteers need to go to Transifex.org and convert the
1008     strings between languages. Then I need to import the strings, check all of
1009     them by hand to make sure there's no funny business which could harm users
1010     in them, and then commit all the diffs. Sadly, there isn't much more we can
1011     do to speed up this process, so sometimes BridgeDB's UI falls back to
1012         English when it doesn't have new enough translations files. Sorry!
1014 And includes the following general changes:
1016     * UPDATE translation: Chinese - Taiwan (zh_TW)
1017             THANKS TO danfong.
1018     * UPDATE translation: Chinese - China (zh_CN)
1019             THANKS TO Meng3, leungsookfan, and Wu Ming Shi.
1020     * UPDATE translation: Turkish (tr)
1021             THANKS TO eromytsatiffird, Emre, Idil Yuksel, ozkansib,
1022             Volkan Gezer, and zeki.
1023     * UPDATE translation: Swedish (sv)
1024             THANKS TO Anders Jensen-Urstad, GabSeb, and phst.
1025     * UPDATE translation: Russian (ru)
1026             THANKS TO Evgrafov Denis, Eugene, foo, Sergey Briskin,
1027             Valid Olov, and Vitaliy Grishenko.
1028     * UPDATE translation: Brazilian Portuguese (pt_BR)
1029             THANKS TO Isabel Ferreira, and Rodrigo Emmanuel Santana
1030             Borges.
1031     * UPDATE translation: Portuguese (pt)
1032             THANKS TO André Monteiro, kagazz, Manuela Silva,
1033             Andrew_Melim, and Sérgio Marques.
1034     * UPDATE translation: Polish (pl)
1035             THANKS TO Aron, Dawid, Krzysztof Łojowski, and seb.
1036     * UPDATE translation: Norwegian Bokmål (nb)
1037             THANKS TO Allan Nordhøy, Harald, and thor574.
1038     * UPDATE translation: Malay (ms_MY)
1039             THANKS TO shahril.
1040     * UPDATE translation: Latvian (lv)
1041             THANKS TO Ojārs Balcers.
1042     * UPDATE translation: Khmer (km)
1043             THANKS TO Seng Sutha, Sokhem Khoem, and Sok Sophea.
1044     * UPDATE translation: Hungarian (hu)
1045             THANKS TO Blackywantscookies, and Cerbo.
1046     * UPDATE translation: Croatian (hr_HR)
1047             THANKS TO Ana B.
1048     * UPDATE translation: Hebrew (he)
1049             THANKS TO Elifelet.
1050     * UPDATE translation: Canadian French (fr_CA)
1051             THANKS TO yahoe.001.
1052     * UPDATE translation: French (fr)
1053             THANKS TO fayçal fatihi, Frisson Reynald, hpatte, Lunar,
1054             Onizuka, themen, Towinet, and Yannick Heintz.
1055     * UPDATE translation: Finish (fi)
1056             THANKS TO viljaminojonen, and Finland355.
1057     * UPDATE translation: Farsi (fa)
1058             THANKS TO Mohammad Hossein.
1059     * UPDATE translation: Spanish - Chile (es_CL)
1060             THANKS TO Pablo Lezaeta.
1061     * UPDATE translation: Spanish (es)
1062             THANKS TO Paola Falcon.
1063     * UPDATE translation: British English (en_GB)
1064             THANKS TO richardshaylor.
1065     * UPDATE translation: Greek (el)
1066             THANKS TO Adrian Pappas, andromeas, isv31, and Wasilis
1067             Mandratzis.
1068     * UPDATE translation: German (de)
1069             THANKS TO Tobias Bannert.
1070     * UPDATE translation: Danish (da)
1071             THANKS TO autofunk78.
1072     * UPDATE translation: Arabic (ar)
1073             THANKS TO Ahmad Gharbeia, Mohamed El-Feky, AnonymousLady,
1074             0xidz, Sherief Alaa , and محيي الدين.
1076 Changes in version 0.2.2 - 2014-06-06
1078     * FIXES #9874 https://bugs.torproject.org/9874
1079     BridgeDB's email and HTTPS distributors were written in a manner that makes
1080     them largely impossible to write unittests for. Since the recent rewrite of
1081     BridgeDB's email distributor server backends for version 0.2.1, BridgeDB
1082     email distributor is now testable and has near 100% code coverage, see
1083     https://coveralls.io/r/isislovecruft/bridgedb
1085     * FIXES #12086 https://bugs.torproject.org/12086
1086     BridgeDB was found to accept incoming emails sent to any email address whose
1087     local part included the word bridges, e.g. emails sent to
1088     'givemebridges@serious.ly' would be responded to as if they were destined
1089     for BridgeDB's real email address.
1090       - BridgeDB now strictly checks that the local part of the email address
1091         that an incoming email was sent to (after removing plus aliases, i.e.
1092         '+es_ES', '+fa', etc.) exactly matches BridgeDB configured email address
1093         username.
1094       - BridgeDB now checks that the domain name portion of the email address
1095         that an incoming email was sent to either matches the domain name
1096         portion of BridgeDB's configured email address, or is a subdomain of
1097         that domain.
1099     * FIXES #12089 https://bugs.torproject.org/12089
1100     There has been a bug for quite some time now where BridgeDB could be used to
1101     email arbitrary email addresses (as long as these addresses were ones which
1102     BridgeDB allows, i.e. Gmail or Yahoo email addresses). This was due to
1103     BridgeDB not checking that the email address used in the SMTP 'MAIL FROM:'
1104     command on an incoming message matched the one used in that email's 'From:'
1105     header.
1106       - BridgeDB now checks that the email addresses in the SMTP 'MAIL FROM:'
1107         and the 'From:' header on that incoming email match, in addition to the
1108         previous checks that the email address' domain is in the set of allowed
1109         domains.
1111     * FIXES #12090 https://bugs.torproject.org/12090
1112     BridgeDB has been replying with an empty email. I don't actually know for
1113     sure if this one is fixed. Before deploying version 0.2.1, the continuous
1114     integration tests showed email responses being correctly generated, and I
1115     was also able to receive correctly formed email responses from BridgeDB on a
1116     local testing instance on my laptop. It appears that this bug occurs only on
1117     the deployment server at ponticum.torproject.org, possibly due to the
1118     outdated Python version in Debian Wheezy. I have not been able to reproduce
1119     this bug on any other machine.
1121     * FIXES #12091 https://bugs.torproject.org/12091
1122     BridgeDB wasn't properly ignoring emails whose DKIM signature verification
1123     header read "X-DKIM-Authentication-Results: dunno".
1124       - Bridgedb now marks incoming emails which have a
1125         "X-DKIM-Authentication-Results: dunno" header as invalid and ignores
1126         them.
1128     * FIXES #12147 https://bugs.torproject.org/12147
1129     If a user refreshed https://bridges.torproject.org/bridges after
1130     successfully solving a CAPTCHA, BridgeDB would reply with a new set of
1131     bridges for each page refresh. This was due to the use of `getInterval()` in
1132     `IPBasedDistributor.getBridgesForIP()`.  The correct function to use is
1133     `getIntervalStart()`.  This had been noted in a "XXX FIXME" comment above
1134     the call for quite some time, however, when the `bridgedb.schedule`
1135     (previously called `bridgedb.Time`) module was revised to support CAPTCHA
1136     timeouts (#11215), the call to `getInterval()` was mistakenly not replaced
1137     with the correct function.
1138       - BridgeDB CAPTCHAs must be solved within 10 minutes.
1139       - Hashring rotation for bridges in BridgeDB HTTPS distributor occurs every
1140         3 hours. Refreshing the page with bridges on it will return these same
1141         bridges for that time period, and afterwards redirect back to the
1142         CAPTCHA page.  THANKS TO francisco on IRC and arma for reporting the
1143         bug.
1145     * FIXES #12212 https://bugs.torproject.org/12122
1146     TRANSLATOR comments are now properly extracted into the gettext PO template
1147     file.
1149 And include the following general changes:
1150     * FIXES an issue where, when verifying GnuPG signatures made by
1151     BridgeDB's email distributor, GnuPG would error, saying, "invalid armor
1152     header".
1154     * ADD Korean (ko) translations.
1155       Thanks to ilbe123, cwt96, Dr.what, and pCsOrI.
1157     * UPDATE Ukranian (uk) translations.
1158       Thanks to LinuxChata and ghostishev.
1160     * UPDATE Turkish (tr) translations.
1161       Thanks to volkangezer.
1163     * UPDATE Brazilian Portuguese (pt_BR) translations.
1164       Thanks to Communia, Humberto Sartini, Anastasia01, and recognitium.
1166     * UPDATE Polish (pl) translations.
1167       Thanks to hoek, yodaa, maxxx, and sebx.
1169     * UPDATE Dutch (nl) translations.
1170       Thanks to Ann Boen, erwindelaat, guryman, and BBLN.
1171       You guys are extra awesome for translating the phrase:
1172           "Uh oh, spaghettios!"
1173       into the Dutch:
1174           "Helaas pindakaas!"
1175       which, in English, literally means:
1176           "Unfortunately, peanut butter!"
1177       You guys totally just made my day. Thanks.
1179     * UPDATE Japanese (ja) translations.
1180       Thanks to plazmism, who is extra awesome for translating the phrase:
1181           "Uh oh, spaghettios!"
1182       into the Japanese:
1183           "おっとスパゲッティ!"
1184       which apparently the literal English translation is:
1185           "Husband spaghetti!"
1187     * UPDATE Italian (it) translations.
1188       Thanks to Random_R.
1190     * UPDATE Canadian French (fr_CA) translations.
1191       Thanks to Lunar.
1193     * UPDATE Spanish (es) translations.
1194       Thanks to dark_yoshi and strel.
1196     * UPDATE Greek (el) translations.
1197       Thanks to pappasadrian.
1199     * UPDATE German (de) translations.
1200       Thanks to trantor and unknwon_anonymous.
1202     * UPDATE Danish (da) translations.
1203       Thanks to autofunk78 and DavidNielsen.
1205 Changes in version 0.2.1 - 2014-05-16
1206     * FIXES #5463 https://bugs.torproject.org/5463
1207     Emails sent from BridgeDB's email distributor should now be signed.
1208       - BridgeDB's emails will be signed with its online GnuPG keypair. The
1209         public key has the following fingerprint:
1210             DF81 1109 E17C 8BF1 34B5  EEB6 8DC4 3A28 4882 1E32
1211         The online keypair rotates (a new one is placed on the server once per
1212         year), and it will ALWAYS be signed with BridgeDB's offline keypair.
1213       - The online keypair above contains two subkeys. The signing subkey has
1214         the fingerprint:
1215             9FE3 9D1A 7438 9223 3B3F  66F2 21B5 54E9 5938 F4D0
1216       - BridgeDB's offline keypair has the following fingerprint:
1217             7B78 4370 15E6 3DF4 7BB1  270A CBD9 7AA2 4E8E 472E
1218     All of BridgeDB's keys may be found on the public keyservers, as well as at
1219     https://bridges.torproject.org/keys
1221     * FIXES #7547 https://bugs.torproject.org/7547
1222     BridgeDB's email distributor will now send you a message explaining how to
1223     use it, including valid commands and the list of Pluggable Transport TYPES
1224     currently supported. To receive help with the email distributor, simply send
1225     an email to mailto:bridges@torproject.org.
1226       - Any emails which do not contain a valid command will receive the help
1227         text in response.
1228       - Otherwise, to specifically request the help text, just say "get help" in
1229         the body of your email.
1231     * FIXES #7550 https://bugs.torproject.org/7550
1232     BridgeDB's email responder is now interactive, as described in the above
1233     entry for ticket #7547.
1235     * FIXES #8241 https://bugs.torproject.org/8241
1236     BridgeDB's HTTP distributor won't tell you how to get obfs3 bridges through
1237     email, although a blank email, or an email containing "get help" will.
1239     * CLOSES #9678 https://bugs.torproject.org/9678
1240     A "Select Language" button was requested for the HTTP distributor on
1241     https://bridges.torproject.org. Instead, translated pages are distributed
1242     automatically (via detecting the "Accept-Language" header which can be set
1243     in the Settings panel of all modern browers).
1244       - To request a specific translation, the "lang=LOCALE" argument can be
1245         added to the URL of any page. For example:
1246         https://bridges.torproject.org/options?lang=ar will provide the bridge
1247         options selection page in Arabic.
1249     * FIXES #11215 https://bugs.torproject.org/11215
1250     BridgeDB's usage of gimp-captcha, which creates a local cache of CAPTCHA for
1251     use on the HTTP distributor, now supports timeouts. If a CAPTCHA is not
1252     solved within 30 minutes of being served to a client, the solution is
1253     invalid regardless of its correctness.
1255     * FIXES #11475 https://bugs.torproject.org/11475
1256     BridgeDB's email responder, up until this point, explained how to use
1257     bridges with Vidalia. It now uses the same help text as found at
1258     https://bridges.torproject.org/howto which explains how to enter bridges
1259     into TorLauncher (used by Tor Browser and Tails).
1261     * FIXES #11522 https://bugs.torproject.org/11522
1262     There were several errors and bugs in BridgeDB's email distributor. The
1263     entire system of server supporting BridgeDB's email distribution system was
1264     rewritten.
1266     * FIXES #11664 https://bugs.torproject.org/11664
1267     Due to changes in the Python language builtin `buffer` in Python3, which
1268     were backported to Python 2.7.6, but neither backported to Python 2.6.x nor
1269     to Python <= 2.7.5, BridgeDB's use of `io.StringIO` and `io.BytesIO`
1270     combined with buffers had to be revised to support both the new and old
1271     Python `buffer` APIs.
1273     * FIXES #11753 https://bugs.torproject.org/11753
1274     BridgeDB's emails should now be translated.
1275       - The translations system for BridgeDB, as well as the template system for
1276         emails, was completely rewritten.  By default, email responses are in
1277         English. To receive an alternate translation, send an email to
1278         bridges+LOCALE@torproject.org, where "LOCALE" is a locale specifier.
1279       - For example, to receive BridgeDB emails translated into Chinese, use
1280         mailto:bridges+zh_CN@torproject.org.
1281       - Or for Farsi translations, use mailto:bridges+fa@torproject.org.
1282       - For the full list of currently supported LOCALE codes, see
1283         https://gitweb.torproject.org/user/isis/bridgedb.git/tree/HEAD:/lib/bridgedb/i18n/
1285 And includes the following general changes:
1286     * UPDATES the Italian (it) gettext file.
1287       Thanks to Francesca Ciceri.
1288     * ADD Welsh (cy) translations.
1289       Thanks to huwwaters and littlegreykida.
1290     * ADD Slovak (sk) translations.
1291       Thanks to Michelozzo and Svistwarrior273.
1292     * UPDATES the bridgedb.pot translation template file. All the new
1293     strings in the email and HTTP user interfaces will now need
1294     translation! To help out with translations, please see:
1295     https://www.transifex.com/projects/p/torproject/resource/2-bridgedb-bridgedb-pot/
1296     * FIXES several typos in the BridgeDB's code documentation.
1297     * ADDS code documentation for several previously undocumented modules.
1299 Changes in version 0.2.0 - 2014-04-19
1300     * FIXES #5232 Perform long running and blocking transactions in
1301             background threads. Primarily this moves bridge descriptor reparsing
1302             into another thread, which significantly increases the availability
1303             of BridgeDB.
1304     * FIXES #9119 BridgeDB's logger now automatically sanitises all email
1305             and IP addresses when the SAFELOGGING config option is enabled.
1306     * FIXES #9875 BridgeDB logger now has 100% unittest coverage.  FIXES #10803
1307     * Vidalia is no longer mentioned on
1308             https://bridges.torproject.org, and instead there are new
1309             instructions on how to enter bridges into TBB>=3.5 (with
1310             TorLauncher).
1311     * FIXES #11346 The web interface now has a homepage link. By clicking
1312             "BridgeDB" in the upper left corner, users can go back to the start
1313             of TBB downloading and bridge selection instructions at
1314             https://bridges.torproject.org.
1315     * FIXES #11370 We were using an old (and deprecated) module when we
1316             created our email responses. Now we use the newer version.
1317     * FIXES #11377 CAPTCHAs on BridgeDB's HTTPS interface are now
1318             case-insensitive.  Thanks to Kostas Jakeliunas for the patch.
1319     * FIXES #11522 fixes several issues with encodings and exception
1320             handling in the email distributor.
1322 And includes the following general changes:
1323     * NEW interface design for https://bridges.torproject.org, including
1324             updated CSS stylesheets, fonts, and HTML templates. In particular,
1325             the https://bridges.torproject.org/options page has been redesigned
1326             completely.  Thanks to Xengi for providing a modified design of the
1327             "roots" Tor Project logo, which is used to link to
1328             https://www.torproject.org.
1329     * CHANGES the TBB download link on the main web interface page to link
1330             to the new TBB-3.6.x-beta bundles, which include patches by David
1331             Fifield to unify TBB and PTTBB into one browser, so that Pluggable
1332             Transports (PTs) are only enabled when the user includes a bridge
1333             line which uses that PT.
1334     * FIXES plaintext responses on https://bridges.torproject.org,
1335             these can be requested by using the 'format' HTTP parameter, like
1336             so: https://bridges.torproject.org/bridges?format=plain
1337     * FIXES the logging of all lines of (including headers!) of incoming
1338             emails.
1339     * FIXES logfile rotation so that the files are only reable/writable
1340             by the running process owner, and no other user.
1341     * CHANGES the data format used for encrypted-then-HMACed CAPTCHAs
1342             to assume that the HMAC is the first 20 bytes. Before we assumed
1343             that the HMAC was separated from the encrypted data with a ';'
1344             character, which causes intermittent issues with some encoding and
1345             CAPTCHA solution values.
1346     * REFACTORS some of the translations handling code, so that soon emails
1347             will be translated (see #7550), and https://bridges.torproject.org
1348             should have a "Select Language" button (see #9678).
1349     * BUMPS leekspin version to 0.1.3.
1351 Changes in version 0.1.6 - 2014-03-26
1352 BridgeDB 0.1.6 includes fixes for the following bugs:
1353     * FIXES #11196 BridgeDB should use leekspin
1354     * FIXES #11218 ReCaptchaProtectedResource.checkSolution()
1355             doesn't expect a deferred
1356     * FIXES #11219 BridgeDB's twisted version doesn´t have a
1357             `t.w.client.HTTPConnectionPool` class
1358     * FIXES #11231 BridgeDB's txrecaptcha returns the "No bridges
1359             available!" page if 'captcha_response_field' is blank
1361 And includes the following general changes:
1362     * ADDS several new translations languages.
1364 Changes in version 0.1.5 - 2014-02-27
1365 BridgeDB 0.1.5 includes fixes for the following bugs:
1366     * FIXES #9264 Problem with transport lines in BridgeDB's bridge
1367             pool assignment files
1368     * FIXES #10809 reCAPTCHA on bridges.torproject.org are impossible
1369             to solve for humans
1370     * FIXES #10834 Configurable reCAPTCHA remoteip
1371     * FIXES #11127 reCaptcha verification is hardcoded to use
1372             plaintext HTTP
1374 And includes the following general changes:
1375     * CHANGES the way the client's IP address is reported to the
1376     reCaptcha API server. Previously, for each client request, a completely
1377     random IP address was generated, and BridgeDB lied to the reCaptcha server
1378     by sending this random IP and saying that it was the client's IP. With these
1379     changes, BridgeDB can be configured to report a static IP address (it's own
1380     IP) as the client's IP, in the hopes that the IP whitelisting used by
1381     reCaptcha makes the returned CAPTCHAs less impossible to solve.
1382     * ADDS the ability to use a local cache of CAPTCHAs created by
1383     scripting Gimp with Python. See:
1384     https://github.com/isislovecruft/gimp-captcha
1385     * USES TLS during CAPTCHA solution verification when using
1386     reCaptcha.
1388 Changes in version 0.1.4 - 2014-02-21
1389 BridgeDB 0.1.4 includes fixes for the following bugs:
1390     * FIXES an RTL encoding issue in the "Step 2" text on index.html
1391             of the HTTPS distributor.
1393 Changes in version 0.1.3 - 2014-02-21
1394 BridgeDB 0.1.3 includes fixes for the following bugs:
1395     * FIXES #9264 Problem with transport lines in BridgeDB's bridge
1396             pool assignment files
1397     * FIXES a bug caused by attempts to convert descriptor digests
1398             which could not be parsed into hexadecimal.
1399     * FIXES a unicode decoding error within the bridgedb.persistent
1400             module.
1401     * REMOVES continuous integration testing for Python 2.6.
1403 Including the following general changes:
1404     * ADD volunteer page text for GSoC 2014 applications.
1406 Changes in version 0.1.2 - 2014-02-05
1407 BridgeDB 0.1.2 includes fixes for the following bugs:
1408     * FIXES #10811 BridgeDB's assignments.log files are not being updated
1410 Changes in version 0.1.1 - 2014-02-03
1411 BridgeDB 0.1.1 includes fixes for the following bugs:
1412     * FIXES #9127 Users can't ask for ipv6 bridges with the new bridgedb
1413             interface
1414     * FIXES #9988 Refactor BridgeDB's use of `sha` module to use `hashlib`
1415     * FIXES #10724 Most of the time spent in testing, as well as most
1416             of the time spent when "BridgeDB is down" (i.e. when I reply
1417             with "BridgeDB is single-threaded (see #5232) and is parsing
1418             millions of descriptors"), is within the same
1419             `bridgedb.Stability.addOrUpdateBridgeHistory()` function (see
1420             #10724). This function is pretty brutal on CPU and memory, is
1421             blocking, and it needs to runs thousands and thousands of
1422             times whenever BridgeDB is restarted (every half hour). The
1423             algorithm within that function has a time complexity increasing
1424             linearithmically relative to the number of bridges and timestamps
1425             already within the database. [0]
1426             This patch adds a config option to disable/enable running
1427             the `addOrUpdateBridgeHistory()` function.
1428             [0]: https://en.wikipedia.org/wiki/Time_complexity#Linearithmic_time
1429     * FIXES #10737 POST arguments to bridges.torproject.org are dropped if
1430             entering a CAPTCHA fails
1432 Including the following general changes:
1433     * ADDS A general simple error page to display rather than
1434             webserver tracebacks. See #6127.
1435     * MOVES The recently added BridgeDB specification file
1436             ('doc/bridge-db-spec.txt') to the torspec repo:
1437             https://gitweb.torproject.org/torspec.git
1438     * FIXES template caching for the web interface.
1440 Changes in version 0.1.0 - 2014-01-14
1441 BridgeDB 0.1.0 includes fixes for the following bugs:
1442     * FIXES #1606 Write a BridgeDB spec
1443     * FIXES #3573 bridges.torproject.org doesn't have a robots.txt
1444     * FIXES #6127 bridges.tpo runs in development mode
1445     * FIXES #9013 BridgeDB should pass pluggable transport
1446             shared-secrets to clients
1447     * FIXES #9157 Persian and Arabic should be right aligned on bridges.tpo
1448     * FIXES #9462 BridgeDB netstatus descriptor parsers need refactoring
1449     * FIXES #9959 BridgeDB seems to be missing English translations
1450     * FIXES #9865 Add automated code coverage report generation
1451     * FIXES #9872 Create a test runner for BridgeDB unittests
1452     * FIXES #9873 Convert BridgeDB's old unittests to use twisted.trial
1453     * FIXES #9937 Create fake non-sanitised bridge descriptors for
1454             BridgeDB testing purposes
1455     * FIXES #10333 Indexing list-like objects by 0L in
1456             Bridges.getConfigLine
1457     * FIXES #10446 BridgeDB is/was using a GeoIP module which is
1458             incompatible with virtualenvs
1459     * FIXES #10559 BridgeDB writes `keyid=` before fingerprints
1461 Including the following general changes:
1462     * ADD Numerous unittests and automated continuous integration testing.
1463     * ADD Patches by sysrqb to correctly render right-to-left languages.
1464     * FIXES fallback languages for translations.
1465     * ADD Sphinx makefiles, substantial amounts of documentation.
1466     * ADD Documentations builds (currently at
1467           https://para.noid.cat/bridgedb)
1469 Changes in version 0.0.1 - 2013-08-20
1470 BridgeDB 0.0.1 includes fixes for the following bugs:
1471     * FIXES #5332 Update BridgeDB documentation with deployment
1472             instructions
1473     * FIXES #9156 BridgeDB: Users try to add obfsbridges to their
1474             normal TBB
1475     These commits were added to fix a compatibility issue with
1476     Vidalia, though they may be reverted to switch back to the old
1477     behaviour of returning bridge lines in the form:
1478       Bridge [transport_method] address:port [keyid=fingerprint] [K=v] […]
1479     in order to work with torrc files and the new TBB-3.x packages
1480     which use TorLauncher instead of Vidalia.
1481     * PARTIAL FIX #9264 Problem with transport lines in BridgeDB's
1482               bridge pool assignment files.
1483     * FIXES #9425 Create and document a better BridgeDB (re)deployment
1484             strategy
1486 Including the following general changes:
1487     * UPDATE translations files with finished files from Transifex for
1488     the strings for the newly-refactored web interface created by
1489     gsathya.
1490     * ADD an automatic version-numbering system as part of developing
1491     a better deployment strategy.
1492     * CHANGE setup.py script to automatically install Python-based
1493     dependencies from requirements.txt.
1494     * REMOVE MANIFEST.in and put equivalent 'include' directives into
1495     setup.py (the less places we have for manually keeping track of
1496     files, the better).
1497     * REMOVE the "bridge " prefix from the lines returned on the web
1498     interface.