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