February 2015 - tor-commits - lists.torproject.org

[bridgedb/master] Clarify documentation for setting up a BridgeDB test instance.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 43f6d7b9512e23e19797c6dd398c8ad0d02d4239 Author: Alden S. Page <pagea(a)allegheny.edu> Date: Tue Dec 23 23:35:39 2014 -0500 Clarify documentation for setting up a BridgeDB test instance. * CHANGE doc/HACKING.md and README.rst to mention leekspin installation. * THANKS to Alden Page for the patch. Signed-off-by: Isis Lovecruft <isis(a)torproject.org> --- README.rst | 3 +++ doc/HACKING.md | 17 +++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.rst b/README.rst index 8a33983..617dbd1 100644 --- a/README.rst +++ b/README.rst @@ -312,6 +312,9 @@ To create a bunch of fake bridge descriptors to test BridgeDB, do:: bridgedb mock [-n NUMBER_OF_DESCRIPTORS] +Note that you will need to install ``leekspin`` in order to run the +``bridgedb mock``. See HACKING.md for details. + And finally, to run the test suites, do:: make coverage diff --git a/doc/HACKING.md b/doc/HACKING.md index 0fda25a..22f9b2b 100644 --- a/doc/HACKING.md +++ b/doc/HACKING.md @@ -9,6 +9,23 @@ big that doesn't have a ticket, you should probably make one. If you don't want to register for a Trac account, you can use the ```cypherpunks``` account with password ```writecode```. +## Generating bridge descriptors + +Developers wishing to test BridgeDB will need to generate mock bridge +descriptors. This is accomplished through the [leekspin +script](https://gitweb.torproject.org/user/isis/leekspin.git). To generate 20 +bridge descriptors, change to the bridgedb running directory and do: + + $ leekspin -n 20 + +It is recommended that you generate at least 250 descriptors for testing. +Ideally, even more descriptors should be generated, somewhere in the realm of +2000, as certain bugs do not emerge until BridgeDB is processing thousands of +descriptors. + +**Leekspin is for testing purposes only and should never be deployed on a +production server.** We do not want to distribute fake bridges. + ## Git Workflow See this article on git branching [workflow][workflow]. The only modifications

1 0

[bridgedb/master] Change test_HTTPServer.py to account for '<br />'s in bridge lines.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit d8b9815c4e612834b7bb6be35ac1476617fa31ba Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Jan 22 21:56:58 2015 +0000 Change test_HTTPServer.py to account for '<br />'s in bridge lines. * FIXES three failing unittests in test_HTTPServer.py: - test_render_GET_RTLlang - test_render_GET_RTLlang_obfs3 - test_render_GET_vanilla --- lib/bridgedb/test/test_HTTPServer.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/test/test_HTTPServer.py b/lib/bridgedb/test/test_HTTPServer.py index 42fbdef..fccbee8 100644 --- a/lib/bridgedb/test/test_HTTPServer.py +++ b/lib/bridgedb/test/test_HTTPServer.py @@ -539,7 +539,15 @@ class WebResourceBridgesTests(unittest.TestCase): soup = BeautifulSoup(page) well = soup.find('div', {'class': 'bridge-lines'}) content = well.renderContents().strip() - bridges = [b.strip() for b in content.splitlines()] + lines = content.splitlines() + + bridges = [] + for line in lines: + bridgelines = line.split('<br />') + for bridge in bridgelines: + if bridge: # It still could be an empty string at this point + bridges.append(bridge) + return bridges def test_render_GET_vanilla(self):

1 0

[bridgedb/master] Add support for generating QRCodes for bridge lines on bridges.html.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 9692235f7f08724be7bfd542553f563c8bab517d Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Jan 15 21:58:55 2015 +0000 Add support for generating QRCodes for bridge lines on bridges.html. * FIXES #11345 https://bugs.torproject.org/11345 --- lib/bridgedb/HTTPServer.py | 9 ++++- lib/bridgedb/qrcodes.py | 59 ++++++++++++++++++++++++++++++++ lib/bridgedb/templates/bridges.html | 64 ++++++++++++++++++++++++++++++++++- 3 files changed, 130 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 6aebba1..b073542 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -49,6 +49,7 @@ from bridgedb.Filters import filterBridgesByIP6 from bridgedb.Filters import filterBridgesByTransport from bridgedb.Filters import filterBridgesByNotBlockedIn from bridgedb.parse import headers +from bridgedb.qrcodes import generateQR from bridgedb.safelog import logSafely @@ -785,6 +786,11 @@ class WebResourceBridges(resource.Resource): rendered = bridgeLines else: request.setHeader("Content-Type", "text/html; charset=utf-8") + qrcode = None + qrjpeg = generateQR(bridgeLines) + + if qrjpeg: + qrcode = 'data:image/jpeg;base64,%s' % base64.b64encode(qrjpeg) try: langs = translations.getLocaleFromHTTPRequest(request) rtl = translations.usingRTLLang(langs) @@ -792,7 +798,8 @@ class WebResourceBridges(resource.Resource): rendered = template.render(strings, rtl=rtl, lang=langs[0], - answer=bridgeLines) + answer=bridgeLines, + qrcode=qrcode) except Exception as err: rendered = replaceErrorPage(err) diff --git a/lib/bridgedb/qrcodes.py b/lib/bridgedb/qrcodes.py new file mode 100644 index 0000000..ae25f06 --- /dev/null +++ b/lib/bridgedb/qrcodes.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 ; test-case-name: bridgedb.test.test_qrcodes ; -*- +#_____________________________________________________________________________ +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# please also see AUTHORS file +# :copyright: (c) 2007-2015, The Tor Project, Inc. +# (c) 2014-2015, Isis Lovecruft +# :license: see LICENSE for licensing information +#_____________________________________________________________________________ + +"""Utilities for working with QRCodes.""" + + +import cStringIO +import logging + + +def generateQR(bridgelines, imageFormat=u'JPEG'): + """Generate a QRCode for the client's bridge lines. + + :param str bridgelines: The Bridge Lines which we are distributing to the + client. + :rtype: str or ``None`` + + :returns: The generated QRCode, as a string. + """ + logging.debug("Attempting to encode bridge lines into a QRCode...") + + if not bridgelines: + return + + try: + import qrcode + + qr = qrcode.QRCode() + qr.add_data(bridgelines) + buf = cStringIO.StringIO() + img = qr.make_image().resize([350, 350]) + img.save(buf, imageFormat) + buf.seek(0) + imgstr = buf.read() + logging.debug("Got QRCode image string.") + + return imgstr + + except ImportError as error: + logging.error(str(error)) + logging.debug(("You'll need the qrcode Python module for this to " + "work. On Debian-based systems, this should be in the " + "python-qrcode package.")) + except KeyError as error: + logging.error(str(error)) + logging.debug(("It seems python-imaging doesn't understand how to " + "save in the %s format.") % imgFormat) + except Exception as error: + logging.error(("There was an error while attempting to generate the " + "QRCode: %s") % str(error)) diff --git a/lib/bridgedb/templates/bridges.html b/lib/bridgedb/templates/bridges.html index d3c10c1..8048919 100644 --- a/lib/bridgedb/templates/bridges.html +++ b/lib/bridgedb/templates/bridges.html @@ -1,7 +1,7 @@ ## -*- coding: utf-8 -*- <%inherit file="base.html"/> -<%page args="strings, rtl=False, lang='en', answer=0, **kwargs"/> +<%page args="strings, rtl=False, lang='en', answer=0, qrcode=0, **kwargs"/> </div> </div> @@ -31,6 +31,20 @@ window.alert(e); } } + + function displayOrHide(element) { + try { + e = document.getElementById(element); + + if (e.style.display === 'none') { + document.getElementById(element).style.display = 'block'; + } else if (e.style.display === 'block') { + document.getElementById(element).style.display = 'none'; + } + } catch (e) { + window.alert(e); + } + } </script> <div class="container-narrow"> @@ -66,6 +80,50 @@ ${answer.replace("\n", "<br />")} title="Select all bridge lines"> <i class="icon icon-2x icon-paste"></i>   ${_("""Select All""")} </button> +% if qrcode: + <a class="btn btn-primary" type="button" id="qrcodebtn" + href="${qrcode}" title="Show QRCode for bridge lines" + onclick="displayOrHide('qrcode')"> + <i class="icon icon-2x icon-qrcode"></i>   ${_("""Show QRCode""")} + </a> +% endif + </div> + + <div class="modal" id="qrcode" style="display: none;"> + <div class="modal-dialog modal-sm" style="width: 400px;"> + <div class="modal-content"> + <div class="modal-header"> + <button type="button" class="close" aria-hidden="true" + onclick="displayOrHide('qrcode')"> + × + </button> + <h4 class="modal-title">${_("""QRCode for your bridge lines""")}</h4> + </div> + <div class="modal-body"> +% if qrcode: + <p style="text-align: center;"> + <img width="350" height="350" + title="QRCode for your bridge lines from BridgeDB" + src="${qrcode}" /> + </p> +% else: + <p class="text-danger"> +## TRANSLATORS: Please translate this into some silly way to say +## "There was a problem!" in your language. For example, +## for Italian, you might translate this into "Mama mia!", +## or for French: "Sacrebleu!". :) +${_("""Uh oh, spaghettios!""")} +${_("""It seems there was an error getting your QRCode.""")} + <i class="icon icon-frown"></i> + </p> +% endif + <p> +${_("""This QRCode contains your bridge lines. Scan it with a QRCode """ \ + """reader to copy your bridge lines onto mobile and other devices.""")} + </p> + </div> + </div> + </div> </div> </div> @@ -133,6 +191,10 @@ ${_("""Uh oh, spaghettios!""")} <script type="text/javascript"> // Make the 'Select All' button clickable: document.getElementById('selectbtn').className = "btn btn-primary"; + + // Remove the href attribute which opens the QRCode image as a data URL if + // JS is disabled: + document.getElementById('qrcodebtn').removeAttribute('href'); </script> <hr />

1 0

[bridgedb/master] Add button to bridges.html for hilighting all text bridge lines.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 505b9cd09f136c7f2d15322253462b32675eeaa3 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Jan 15 21:39:29 2015 +0000 Add button to bridges.html for hilighting all text bridge lines. This should hopefully make copying the bridge lines elsewhere less error-prone for users. --- lib/bridgedb/templates/assets/css/custom.css | 3 +- lib/bridgedb/templates/bridges.html | 43 ++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/templates/assets/css/custom.css b/lib/bridgedb/templates/assets/css/custom.css index 3fd1065..0b2684e 100644 --- a/lib/bridgedb/templates/assets/css/custom.css +++ b/lib/bridgedb/templates/assets/css/custom.css @@ -119,4 +119,5 @@ div.bridge-lines { border-radius: 6px 6px 6px 6px; box-shadow: none; -moz-box-sizing: border-box; -} \ No newline at end of file + cursor: copy; +} diff --git a/lib/bridgedb/templates/bridges.html b/lib/bridgedb/templates/bridges.html index 7ac77dd..d3c10c1 100644 --- a/lib/bridgedb/templates/bridges.html +++ b/lib/bridgedb/templates/bridges.html @@ -6,6 +6,33 @@ </div> </div> +<script type="text/javascript"> + // Takes one argument, `element`, which should be a string specifying the id + // of the element whose text should be selected. + function selectText(element) { + try { + var doc = document; + text = doc.getElementById(element); + var range; + var selection; + + if (doc.body.createTextRange) { + range = document.body.createTextRange(); + range.moveToElementText(text); + range.select(); + } else if (window.getSelection) { + selection = window.getSelection(); + range = document.createRange(); + range.selectNodeContents(text); + selection.removeAllRanges(); + selection.addRange(range); + } + } catch (e) { + window.alert(e); + } + } +</script> + <div class="container-narrow"> <div class="container-fluid"> @@ -31,6 +58,17 @@ ${answer.replace("\n", "<br />")} </div> </div> + <div class="container-fluid" + style="width: 100%; align: center; margin: auto;"> + <div class="row" id="bridgesrow2" style="text-align: right; padding-right: 7%;"> + <button class="btn btn-primary disabled" id="selectbtn" + onclick="selectText('bridgelines')" + title="Select all bridge lines"> + <i class="icon icon-2x icon-paste"></i>   ${_("""Select All""")} + </button> + </div> + </div> + <br /> <br /> @@ -92,4 +130,9 @@ ${_("""Uh oh, spaghettios!""")} <br /> % endif +<script type="text/javascript"> + // Make the 'Select All' button clickable: + document.getElementById('selectbtn').className = "btn btn-primary"; +</script> + <hr />

1 0

[bridgedb/master] Change qrcode module import to be attempted only once.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 438021c278906a08c2a74e154673a5e26cbfbedc Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Feb 1 00:13:25 2015 +0000 Change qrcode module import to be attempted only once. --- lib/bridgedb/qrcodes.py | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/lib/bridgedb/qrcodes.py b/lib/bridgedb/qrcodes.py index ae25f06..a76cf8f 100644 --- a/lib/bridgedb/qrcodes.py +++ b/lib/bridgedb/qrcodes.py @@ -16,6 +16,14 @@ import cStringIO import logging +try: + import qrcode +except ImportError: + qrcode = False + logging.warn("Could not import Python qrcode module.") + logging.debug(("You'll need the qrcode Python module for this to " + "work. On Debian-based systems, this should be in the " + "python-qrcode package.")) def generateQR(bridgelines, imageFormat=u'JPEG'): """Generate a QRCode for the client's bridge lines. @@ -31,8 +39,10 @@ def generateQR(bridgelines, imageFormat=u'JPEG'): if not bridgelines: return + if not qrcode: + logging.info("Not creating QRCode for bridgelines; no qrcode module.") + try: - import qrcode qr = qrcode.QRCode() qr.add_data(bridgelines) @@ -45,11 +55,6 @@ def generateQR(bridgelines, imageFormat=u'JPEG'): return imgstr - except ImportError as error: - logging.error(str(error)) - logging.debug(("You'll need the qrcode Python module for this to " - "work. On Debian-based systems, this should be in the " - "python-qrcode package.")) except KeyError as error: logging.error(str(error)) logging.debug(("It seems python-imaging doesn't understand how to "

1 0

[bridgedb/master] Add support for generating QRCodes with 'bridge://' schema for Orbot.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 66ef631c51176777da212ab02f7a0d47dff00579 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Feb 1 00:15:59 2015 +0000 Add support for generating QRCodes with 'bridge://' schema for Orbot. --- lib/bridgedb/qrcodes.py | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/qrcodes.py b/lib/bridgedb/qrcodes.py index a76cf8f..8016262 100644 --- a/lib/bridgedb/qrcodes.py +++ b/lib/bridgedb/qrcodes.py @@ -25,13 +25,15 @@ except ImportError: "work. On Debian-based systems, this should be in the " "python-qrcode package.")) -def generateQR(bridgelines, imageFormat=u'JPEG'): + +def generateQR(bridgelines, imageFormat=u'JPEG', bridgeSchema=False): """Generate a QRCode for the client's bridge lines. :param str bridgelines: The Bridge Lines which we are distributing to the client. + :param bool bridgeSchema: If ``True``, prepend ``'bridge://'`` to the + beginning of each bridge line before QR encoding. :rtype: str or ``None`` - :returns: The generated QRCode, as a string. """ logging.debug("Attempting to encode bridge lines into a QRCode...") @@ -43,16 +45,26 @@ def generateQR(bridgelines, imageFormat=u'JPEG'): logging.info("Not creating QRCode for bridgelines; no qrcode module.") try: + if bridgeSchema: + # See https://bugs.torproject.org/12639 for why bridge:// is used. + # (Hopefully, Orbot will pick up the ACTION_VIEW intent.) + schema = 'bridge://' + prefixed = [] + for line in bridgelines.strip().split('\n'): + prefixed.append(schema + line) + bridgelines = '\n'.join(prefixed) + + logging.debug("QR encoding bridge lines: %s" % bridgelines) qr = qrcode.QRCode() qr.add_data(bridgelines) + buf = cStringIO.StringIO() img = qr.make_image().resize([350, 350]) img.save(buf, imageFormat) buf.seek(0) + imgstr = buf.read() - logging.debug("Got QRCode image string.") - return imgstr except KeyError as error: @@ -62,3 +74,4 @@ def generateQR(bridgelines, imageFormat=u'JPEG'): except Exception as error: logging.error(("There was an error while attempting to generate the " "QRCode: %s") % str(error)) +

1 0

[bridgedb/master] Fix word wrapping for bridgelines by adding a custom scrollbar.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit c542e055433a7b696d51e88195a025840b8852b6 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Jan 15 21:42:43 2015 +0000 Fix word wrapping for bridgelines by adding a custom scrollbar. --- lib/bridgedb/templates/assets/css/custom.css | 41 ++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/templates/assets/css/custom.css b/lib/bridgedb/templates/assets/css/custom.css index 0b2684e..f0bde6f 100644 --- a/lib/bridgedb/templates/assets/css/custom.css +++ b/lib/bridgedb/templates/assets/css/custom.css @@ -112,12 +112,47 @@ div.bridge-lines { line-height: 175%; color: rgb(44, 62, 80); word-break: break-all; - word-wrap: break-word; - white-space: pre-wrap; + word-wrap: normal; + white-space: nowrap; + overflow-x: auto; + z-index: 1000; background-color: rgb(236, 240, 241); - border: 1px solid transparent; + border: 0px solid transparent; border-radius: 6px 6px 6px 6px; + border-color: #2C3E50; box-shadow: none; + box-sizing: border-box; -moz-box-sizing: border-box; cursor: copy; } + +div.bridge-lines.-webkit-scrollbar { + width: 9px; + height: 9px; +} +div.bridge-lines.-webkit-scrollbar-button.start.decrement { + display: block; + height: 0; + background-color: transparent; +} +div.bridge-lines.-webkit-scrollbar-button.end.increment { + display: block; + height: 0; + background-color: transparent; +} +div.bridge-lines.-webkit-scrollbar-track-piece { + background-color: #FAFAFA; + -webkit-border-radius: 0; + -webkit-border-bottom-right-radius: 6px; + -webkit-border-bottom-left-radius: 6px; +} +div.bridge-lines.-webkit-scrollbar-thumb.vertical { + height: 50px; + background-color: #999; + -webkit-border-radius: 6px; +} +div.bridge-lines.-webkit-scrollbar-thumb.horizontal{ + width: 50px; + background-color: #999; + -webkit-border-radius: 6px; +}

1 0

[bridgedb/master] Add qrcode==5.0.1 and pillow>=2.6.1 to Pip requirements.txt file.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 6917daa0b38dd276a87e39d2d9f1a7f1eb90031e Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Jan 15 22:01:21 2015 +0000 Add qrcode==5.0.1 and pillow>=2.6.1 to Pip requirements.txt file. Pillow, in Debian jessie, is in the `python-imaging` package (currently version 2.6.1). However, on PyPI, Pillow is simply `pillow` (currently version 2.7.0). Both of these are backwards compatible with the python-imaging package in Debian wheezy (currently version 1.1.6, and likely to never get updated, because it is being replaced with pillow). And any of these will currently work with BridgeDB. --- requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements.txt b/requirements.txt index de393b1..6448920 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,5 +7,7 @@ pycrypto==2.6.1 pyOpenSSL==0.13.1 pygeoip==0.2.7 pygpgme==0.3 +pillow>=2.6.1 +qrcode==5.0.1 recaptcha-client==1.0.6 zope.interface==3.6.1

1 0

[bridgedb/master] Update file header for bridgedb.Main module.
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 52d2b6537d686172e95bf75e6641c7bc137bd01e Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Aug 21 05:05:17 2014 +0000 Update file header for bridgedb.Main module. --- lib/bridgedb/Main.py | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/lib/bridgedb/Main.py b/lib/bridgedb/Main.py index 4f138f0..df46ac5 100644 --- a/lib/bridgedb/Main.py +++ b/lib/bridgedb/Main.py @@ -1,12 +1,15 @@ -# -*- coding: utf-8 -*- +# -*- coding: utf-8 ; test-case-name: bridgedb.test.test_Main -*- # -# BridgeDB by Nick Mathewson. -# Copyright (c) 2007-2009, The Tor Project, Inc. -# See LICENSE for licensing information - -""" -This module sets up a bridgedb and starts the servers running. -""" +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: please see the AUTHORS file for attributions +# :copyright: (c) 2013-2014, Isis Lovecruft +# (c) 2013-2014, Matthew Finkel +# (c) 2007-2014, Nick Mathewson +# (c) 2007-2014, The Tor Project, Inc. +# :license: see LICENSE for licensing information + +"""This module sets up BridgeDB and starts the servers running.""" import os import signal

1 0

[bridgedb/master] Merge branch 'fix/9874-email' into develop
by isis＠torproject.org 03 Feb '15

03 Feb '15

commit 9eab75d36eaa42ae349aadf745e6f697f4d817c8 Merge: 34954f8 77f08d9 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Aug 27 08:05:39 2014 +0000 Merge branch 'fix/9874-email' into develop lib/bridgedb/test/test_smtp.py | 9 +++++++++ 1 file changed, 9 insertions(+)

1 0