March 2014 - tor-commits - lists.torproject.org

[bridgedb/develop] Change ReCaptchaProtectedResource.checkResponse() to also return request.
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 1bc823d54b507438972b53cc6774de7c6d626ab4 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Mar 25 22:24:10 2014 +0000 Change ReCaptchaProtectedResource.checkResponse() to also return request. We need to return the original request, not just the boolean representing the validity of the CAPTCHA solution, if we want to be able to interact with the original request while rendering it. --- lib/bridgedb/HTTPServer.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 26bfb6d..e2f1059 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -419,8 +419,11 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): ``'captcha_challenge_field'``, and the other, ``'captcha_response_field'``. These POST arguments should be obtained from :meth:`render_GET`. - :rtupe: bool - :returns: True, if the CAPTCHA solution was valid; False otherwise. + :rtupe: :api:`twisted.internet.defer.Deferred` + :returns: the returned deferred will callback with a tuple of + (``bool``, :api:`twisted.web.server.Request`). If the CAPTCHA + solution was valid, a tuple will contain ``(True, request)``; + otherwise, it will contain ``(False, request)``. """ challenge, response = self.extractClientSolution(request) clientIP = self.getClientIP(request) @@ -429,18 +432,18 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): logging.debug("Captcha from %r. Parameters: %r" % (Util.logSafely(clientIP), request.args)) - def checkResponse(solution, clientIP): + def checkResponse(solution, request): if solution.is_valid: logging.info("Valid CAPTCHA solution from %r." % Util.logSafely(clientIP)) - return True + return (True, request) else: logging.info("Invalid CAPTCHA solution from %r: %r" % (Util.logSafely(clientIP), solution.error_code)) - return False + return (False, request) d = txrecaptcha.submit(challenge, response, self.recaptchaPrivKey, - remoteIP).addCallback(checkResponse, clientIP) + remoteIP).addCallback(checkResponse, request) return d def render_GET(self, request):

1 0

[bridgedb/develop] A couple PEP8 whitespace fixes in docstrings for HTTPServer.
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 30c63975d03dd2ab26c9ecf35fa190d7e732512b Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Mar 25 22:23:13 2014 +0000 A couple PEP8 whitespace fixes in docstrings for HTTPServer. --- lib/bridgedb/HTTPServer.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 7e7df98..26bfb6d 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -206,7 +206,6 @@ class CaptchaProtectedResource(resource.Resource): request. Otherwise, redirect them back to a new CAPTCHA page. :type request: :api:`twisted.web.http.Request` - :param request: A ``Request`` object, including POST arguments which should include two key/value pairs: one key being ``'captcha_challenge_field'``, and the other, @@ -214,7 +213,7 @@ class CaptchaProtectedResource(resource.Resource): obtained from :meth:`render_GET`. :rtype: str :returns: A rendered HTML page containing a ReCaptcha challenge image - for the client to solve. + for the client to solve. """ if self.checkSolution(request) is True: try: @@ -451,7 +450,7 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): :param request: A ``Request`` object for 'bridges.html'. :rtype: str :returns: A rendered HTML page containing a ReCaptcha challenge image - for the client to solve. + for the client to solve. """ return CaptchaProtectedResource.render_GET(self, request) @@ -463,7 +462,6 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): request. Otherwise, redirect them back to a new CAPTCHA page. :type request: :api:`twisted.web.http.Request` - :param request: A ``Request`` object, including POST arguments which should include two key/value pairs: one key being ``'captcha_challenge_field'``, and the other,

1 0

[bridgedb/develop] Add ReCaptchaProtectedResource._renderDeferred() to render deferred resources.
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit db8eef49536f0c18891bdf1f5151733e07ffc8d3 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Mar 25 22:28:45 2014 +0000 Add ReCaptchaProtectedResource._renderDeferred() to render deferred resources. --- lib/bridgedb/HTTPServer.py | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index e2f1059..4c5d414 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -367,6 +367,39 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): self.recaptchaPubKey = recaptchaPubKey self.recaptchaRemoteIP = remoteip + def _renderDeferred(self, checkedRequest): + """Render this resource asynchronously. + + :type checkedRequest: tuple + :param checkedRequest: A tuple of ``(bool, request)``, as returned + from :meth:`checkSolution`. + """ + try: + valid, request = checkedRequest + except Exception as err: + logging.error("Error in _renderDeferred(): %s" % err) + return + + logging.debug("Attemping to render %svalid request %r" + % ('' if valid else 'in', request)) + if valid is True: + try: + rendered = self.resource.render(request) + except Exception as err: # pragma: no cover + rendered = replaceErrorPage(err) + else: + logging.info("Client failed a CAPTCHA; redirecting to %s" + % request.uri) + rendered = redirectTo(request.uri, request) + + try: + request.write(rendered) + request.finish() + except Exception as err: # pragma: no cover + logging.exception(err) + + return request + def getCaptchaImage(self, request): """Get a CAPTCHA image from the remote reCaptcha server.

1 0

[bridgedb/develop] Add coverage pragma lines to blanket excepts in HTTPServer.
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 4eb7ef398e2e2c28f19031fca6595c679c613fe9 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 26 04:56:31 2014 +0000 Add coverage pragma lines to blanket excepts in HTTPServer. They are gross, but we have to have these general excepts everywhere, otherwise users could be shown a traceback. --- lib/bridgedb/HTTPServer.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index d7b56b3..f4ab592 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -64,7 +64,7 @@ _geoipdb = '/usr/share/GeoIP/GeoIP.dat' try: # Make sure we have the database before trying to import the module: - if not os.path.isfile(_geoipdb): + if not os.path.isfile(_geoipdb): # pragma: no cover raise EnvironmentError("Could not find %r. On Debian-based systems, "\ "please install the geoip-database package." % _geoipdb) @@ -74,7 +74,7 @@ try: import pygeoip geoip = pygeoip.GeoIP(_geoipdb, flags=pygeoip.MEMORY_CACHE) logging.info("GeoIP database loaded") -except Exception as err: +except Exception as err: # pragma: no cover logging.warn("Error while loading geoip module: %r" % err) geoip = None @@ -162,7 +162,7 @@ class CaptchaProtectedResource(resource.Resource): try: challenge = request.args['captcha_challenge_field'][0] response = request.args['captcha_response_field'][0] - except: + except Exception: # pragma: no cover return redirectTo(request.URLPath(), request) return (challenge, response) @@ -314,7 +314,7 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): capt.get() except captcha.GimpCaptchaError as error: logging.error(error) - except Exception as error: + except Exception as error: # pragma: no cover logging.error("Unhandled error while retrieving Gimp captcha!") logging.exception(error) @@ -466,7 +466,7 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): % (Util.logSafely(clientIP), request.args)) def checkResponse(solution, request): - if solution.is_valid: + if solution.is_valid: # pragma: no cover logging.info("Valid CAPTCHA solution from %r." % Util.logSafely(clientIP)) return (True, request) @@ -531,7 +531,7 @@ class WebResourceOptions(resource.Resource): try: rtl = usingRTLLang(request) - except Exception as err: + except Exception as err: # pragma: no cover logging.exception(err) logging.error("The gettext files were not properly installed.") logging.info("To install translations, try doing `python " \

1 0

[bridgedb/develop] Change ReCaptchaProtectedResource.render_POST() to call _renderDeferred().
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 454e0f7870575a362d1d162918519f1e1fda5179 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Mar 25 22:30:19 2014 +0000 Change ReCaptchaProtectedResource.render_POST() to call _renderDeferred(). * FIXES #11218 (again). --- lib/bridgedb/HTTPServer.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 4c5d414..d7b56b3 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -503,11 +503,15 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): ``'captcha_challenge_field'``, and the other, ``'captcha_response_field'``. These POST arguments should be obtained from :meth:`render_GET`. - :rtype: str - :returns: A rendered HTML page containing a ReCaptcha challenge image - for the client to solve. + :returns: :api:`twisted.web.server.NOT_DONE_YET`, in order to handle + the ``Deferred`` returned from :meth:`checkSolution`. Eventually, + when the ``Deferred`` request is done being processed, + :meth:`_renderDeferred` will handle rendering and displaying the + HTML to the client. """ - return CaptchaProtectedResource.render_POST(self, request) + d = self.checkSolution(request) + d.addCallback(self._renderDeferred) + return server.NOT_DONE_YET class WebResourceOptions(resource.Resource):

1 0

[bridgedb/develop] Add --rcfile option to additional coverage lines in Makefile.
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit eabc57bdb24dec6d4693463a7029b1106bf71778 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 26 04:59:13 2014 +0000 Add --rcfile option to additional coverage lines in Makefile. --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index edfc69f..22a231e 100644 --- a/Makefile +++ b/Makefile @@ -45,5 +45,5 @@ clean: coverage: -coverage run --rcfile=".coveragerc" $(TRIAL) ./lib/bridgedb/test/test_*.py - -coverage report - -coverage html + -coverage report --rcfile=".coveragerc" + -coverage html --rcfile=".coveragerc"

1 0

[bridgedb/develop] Add a docstring and comment to checkResponse() in ReCaptchaProtectedResource.
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 228d7e0856cb88723531cb76db12c3a9b32acd5a Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 26 04:57:56 2014 +0000 Add a docstring and comment to checkResponse() in ReCaptchaProtectedResource. --- lib/bridgedb/HTTPServer.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index f4ab592..24a970f 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -466,6 +466,17 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): % (Util.logSafely(clientIP), request.args)) def checkResponse(solution, request): + """Check the :class:`txrecaptcha.RecaptchaResponse`. + + :type solution: :class:`txrecaptcha.RecaptchaResponse`. + :param solution: The client's CAPTCHA solution, after it has been + submitted to the reCaptcha API server. + """ + # This valid CAPTCHA result from this function cannot be reliably + # unittested, because it's callbacked to from the deferred + # returned by ``txrecaptcha.submit``, the latter of which would + # require networking (as well as automated CAPTCHA + # breaking). Hence, the 'no cover' pragma. if solution.is_valid: # pragma: no cover logging.info("Valid CAPTCHA solution from %r." % Util.logSafely(clientIP))

1 0

[bridgedb/develop] Remove a superfluous error message about gettext files.
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 31ec211fd62da1d816d3ecf73986f30c021bf097 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 26 04:58:31 2014 +0000 Remove a superfluous error message about gettext files. --- lib/bridgedb/HTTPServer.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 24a970f..3809f2d 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -544,9 +544,6 @@ class WebResourceOptions(resource.Resource): rtl = usingRTLLang(request) except Exception as err: # pragma: no cover logging.exception(err) - logging.error("The gettext files were not properly installed.") - logging.info("To install translations, try doing `python " \ - "setup.py compile_catalog`.") request.setHeader("Content-Type", "text/html; charset=utf-8") return lookup.get_template('options.html').render(rtl=rtl)

1 0

[bridgedb/develop] Remove gimp captcha unittest code from recaptcha unittest setUp().
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 2c41a3f7c1606ccc26812db913e11808ffabc0f8 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 26 05:00:20 2014 +0000 Remove gimp captcha unittest code from recaptcha unittest setUp(). --- lib/bridgedb/test/test_HTTPServer.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/lib/bridgedb/test/test_HTTPServer.py b/lib/bridgedb/test/test_HTTPServer.py index 57f0d80..ea2f6e4 100644 --- a/lib/bridgedb/test/test_HTTPServer.py +++ b/lib/bridgedb/test/test_HTTPServer.py @@ -266,11 +266,6 @@ class ReCaptchaProtectedResourceTests(unittest.TestCase): """Create a :class:`HTTPServer.WebResourceBridges` and protect it with a :class:`ReCaptchaProtectedResource`. """ - # Create our cached CAPTCHA directory: - self.captchaDir = 'captchas' - if not os.path.isdir(self.captchaDir): - os.makedirs(self.captchaDir) - # Set up our resources to fake a minimal HTTP(S) server: self.pagename = b'captcha.html' self.root = Resource()

1 0

[bridgedb/develop] Add unittests for _renderDeferred().
by isis＠torproject.org 26 Mar '14

26 Mar '14

commit 3fe40199972595895c05d8760dade246e8134fe4 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 26 05:01:04 2014 +0000 Add unittests for _renderDeferred(). --- lib/bridgedb/test/test_HTTPServer.py | 53 ++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/lib/bridgedb/test/test_HTTPServer.py b/lib/bridgedb/test/test_HTTPServer.py index ea2f6e4..4e6c86b 100644 --- a/lib/bridgedb/test/test_HTTPServer.py +++ b/lib/bridgedb/test/test_HTTPServer.py @@ -23,6 +23,7 @@ import ipaddr from BeautifulSoup import BeautifulSoup from twisted.internet import reactor +from twisted.internet import task from twisted.trial import unittest from twisted.web.resource import Resource from twisted.web.test import requesthelper @@ -297,6 +298,58 @@ class ReCaptchaProtectedResourceTests(unittest.TestCase): except (AlreadyCalled, AlreadyCancelled): pass + def test_renderDeferred_invalid(self): + """:meth:`_renderDeferred` should redirect a ``Request`` (after the + CAPTCHA was NOT xsuccessfully solved) which results from a + ``Deferred``'s callback. + """ + self.request.method = b'POST' + + def testCB(request): + """Check the ``Request`` returned from ``_renderDeferred``.""" + self.assertIsInstance(request, DummyRequest) + soup = BeautifulSoup(b''.join(request.written)).find('meta')['http-equiv'] + self.assertEqual(soup, 'refresh') + + d = task.deferLater(reactor, 0, lambda x: x, (False, self.request)) + d.addCallback(self.captchaResource._renderDeferred) + d.addCallback(testCB) + return d + + def test_renderDeferred_valid(self): + """:meth:`_renderDeferred` should correctly render a ``Request`` (after + the CAPTCHA has been successfully solved) which results from a + ``Deferred``'s callback. + """ + self.request.method = b'POST' + + def testCB(request): + """Check the ``Request`` returned from ``_renderDeferred``.""" + self.assertIsInstance(request, DummyRequest) + html = b''.join(request.written) + self.assertSubstring('No bridges currently available', html) + + d = task.deferLater(reactor, 0, lambda x: x, (True, self.request)) + d.addCallback(self.captchaResource._renderDeferred) + d.addCallback(testCB) + return d + + def test_renderDeferred_nontuple(self): + """:meth:`_renderDeferred` should correctly render a ``Request`` (after + the CAPTCHA has been successfully solved) which results from a + ``Deferred``'s callback. + """ + self.request.method = b'POST' + + def testCB(request): + """Check the ``Request`` returned from ``_renderDeferred``.""" + self.assertIs(request, None) + + d = task.deferLater(reactor, 0, lambda x: x, (self.request)) + d.addCallback(self.captchaResource._renderDeferred) + d.addCallback(testCB) + return d + def test_checkSolution_blankFields(self): """:meth:`HTTPServer.ReCaptchaProtectedResource.checkSolution` should return a redirect if is the solution field is blank.

1 0