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