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

[bridgedb/develop] Reformat docstrings and update some descriptions in bridgedb.HTTPServer.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit ebf0ef7c3900646de957cd73551531b33541b761 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:01:00 2014 +0000 Reformat docstrings and update some descriptions in bridgedb.HTTPServer. --- lib/bridgedb/HTTPServer.py | 123 ++++++++++++++++++++++++-------------------- 1 file changed, 66 insertions(+), 57 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 9411ec1..4deac25 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -28,6 +28,7 @@ import bridgedb.Util as Util from recaptcha.client import captcha as recaptcha from bridgedb import captcha +from bridgedb import crypto from bridgedb.Filters import filterBridgesByIP6, filterBridgesByIP4 from bridgedb.Filters import filterBridgesByTransport from bridgedb.Filters import filterBridgesByNotBlockedIn @@ -153,9 +154,9 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): :type request: :api:`twisted.web.http.Request` :param request: A ``Request`` object for 'bridges.html'. :returns: A redirect for a request for a new CAPTCHA if there was a - problem. Otherwise, returns a 2-tuple of strings, the first - is the client's CAPTCHA solution from the text input area, - and the second is the challenge string. + problem. Otherwise, returns a 2-tuple of strings, the first is the + client's CAPTCHA solution from the text input area, and the second + is the challenge string. """ try: challenge = request.args['captcha_challenge_field'][0] @@ -169,7 +170,7 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): :rtype: bool :returns: ``True`` if the client correctly solved the CAPTCHA; - ``False`` otherwise. + ``False`` otherwise. """ return False @@ -178,10 +179,10 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): :type request: :api:`twisted.web.http.Request` :param request: A ``Request`` object for a page which should be - protected by a CAPTCHA. + protected by a CAPTCHA. :rtype: str :returns: A rendered HTML page containing a ReCaptcha challenge image - for the client to solve. + for the client to solve. """ image, challenge = self.getCaptchaImage(request) @@ -204,11 +205,12 @@ class CaptchaProtectedResource(twisted.web.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, - ``'captcha_response_field'``. These POST arguments - should be obtained from :meth:`render_GET`. + should include two key/value pairs: one key being + ``'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. @@ -227,7 +229,7 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): class GimpCaptchaProtectedResource(CaptchaProtectedResource): """A web resource which uses a local cache of CAPTCHAs, generated with - gimp-captcha. + gimp-captcha_, to protect another resource. .. _gimp-captcha: https://github.com/isislovecruft/gimp-captcha """ @@ -245,7 +247,6 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): a completely random IP is generated and sent instead. :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, @@ -268,6 +269,9 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): :meth:`~bridgedb.captcha.GimpCaptcha.get` method to return a random CAPTCHA and challenge string. + :type request: :api:`twisted.web.http.Request` + :param request: A client's initial request for some other resource + which is protected by this one (i.e. protected by a CAPTCHA). :returns: A 2-tuple of ``(image, challenge)``, where:: - ``image`` is a string holding a binary, JPEG-encoded image. - ``challenge`` is a unique string associated with the request. @@ -286,14 +290,15 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): return (c.image, c.challenge) def render_GET(self, request): - """Retrieve a ReCaptcha from the API server and serve it to the client. + """Get a random CAPTCHA from our local cache directory and serve it to + the client. :type request: :api:`twisted.web.http.Request` :param request: A ``Request`` object for a page which should be - protected by a CAPTCHA. + protected by a CAPTCHA. :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) @@ -306,13 +311,13 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): :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, - ``'captcha_response_field'``. These POST arguments - should be obtained from :meth:`render_GET`. + should include two key/value pairs: one key being + ``'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. + for the client to solve. """ return CaptchaProtectedResource.render_POST(self, request) @@ -375,10 +380,10 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): :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, - ``'captcha_response_field'``. These POST arguments - should be obtained from :meth:`render_GET`. + should include two key/value pairs: one key being + ``'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. """ @@ -418,11 +423,12 @@ 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, - ``'captcha_response_field'``. These POST arguments - should be obtained from :meth:`render_GET`. + should include two key/value pairs: one key being + ``'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. @@ -430,7 +436,6 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): return CaptchaProtectedResource.render_POST(self, request) - class WebResourceOptions(twisted.web.resource.Resource): """This resource is used by Twisted Web to give a web page with additional options that the user may use to specify the criteria @@ -468,20 +473,19 @@ class WebResourceBridges(twisted.web.resource.Resource): def __init__(self, distributor, schedule, N=1, useForwardedHeader=False, includeFingerprints=True): - """Create a new WebResource. + """Create a new resource for displaying bridges to a client. :type distributor: :class:`IPBasedDistributor` :param distributor: The mechanism to retrieve bridges for this - distributor. + distributor. :type schedule: :class:`IntervalSchedule` :param schedule: The time period used to tweak the bridge selection - procedure. + procedure. :param int N: The number of bridges to hand out per query. :param bool useForwardedHeader: Whether or not we should use the the - X-Forwarded-For header instead of the - source IP address. + X-Forwarded-For header instead of the source IP address. :param bool includeFingerprints: Do we include the bridge's - fingerprint in the response? + fingerprint in the response? """ gettext.install("bridgedb", unicode=True) twisted.web.resource.Resource.__init__(self) @@ -502,7 +506,7 @@ class WebResourceBridges(twisted.web.resource.Resource): :type request: :api:`twisted.web.http.Request` :param request: A ``Request`` object containing the HTTP method, full - URI, and any URL/POST arguments and headers present. + URI, and any URL/POST arguments and headers present. :rtype: str :returns: A plaintext or HTML response to serve. """ @@ -519,7 +523,7 @@ class WebResourceBridges(twisted.web.resource.Resource): :type request: :api:`twisted.web.http.Request` :param request: A ``Request`` object containing the HTTP method, full - URI, and any URL/POST arguments and headers present. + URI, and any URL/POST arguments and headers present. :rtype: str :returns: A plaintext or HTML response to serve. """ @@ -613,17 +617,16 @@ class WebResourceBridges(twisted.web.resource.Resource): :type request: :api:`twisted.web.http.Request` :param request: A ``Request`` object containing the HTTP method, full - URI, and any URL/POST arguments and headers present. + URI, and any URL/POST arguments and headers present. :type bridgeLines: list or None :param bridgeLines: A list of strings used to configure a Tor client - to use a bridge. + to use a bridge. :param bool rtl: If ``True``, the language used for the response to - the client should be rendered right-to-left. + the client should be rendered right-to-left. :type format: str or None :param format: If ``'plain'``, return a plaintext response. Otherwise, - use the :file:`bridgedb/templates/bridges.html` - template to render an HTML response page which includes - the **bridges**. + use the :file:`bridgedb/templates/bridges.html` template to render + an HTML response page which includes the **bridges**. :rtype: str :returns: A plaintext or HTML response to serve. """ @@ -670,20 +673,26 @@ class WebRoot(twisted.web.resource.Resource): def addWebServer(cfg, dist, sched): """Set up a web server. - cfg -- a configuration object from Main. We use these options: - HTTPS_N_BRIDGES_PER_ANSWER - HTTP_UNENCRYPTED_PORT - HTTP_UNENCRYPTED_BIND_IP - HTTP_USE_IP_FROM_FORWARDED_HEADER - HTTPS_PORT - HTTPS_BIND_IP - HTTPS_USE_IP_FROM_FORWARDED_HEADER - RECAPTCHA_ENABLED - RECAPTCHA_PUB_KEY - RECAPTCHA_PRIV_KEY - RECAPTCHA_REMOTEIP - dist -- an IPBasedDistributor object. - sched -- an IntervalSchedule object. + + :param cfg: A configuration object from :mod:`bridgedb.Main`. Currently, + we use these options:: + HTTPS_N_BRIDGES_PER_ANSWER + HTTP_UNENCRYPTED_PORT + HTTP_UNENCRYPTED_BIND_IP + HTTP_USE_IP_FROM_FORWARDED_HEADER + HTTPS_PORT + HTTPS_BIND_IP + HTTPS_USE_IP_FROM_FORWARDED_HEADER + RECAPTCHA_ENABLED + RECAPTCHA_PUB_KEY + RECAPTCHA_PRIV_KEY + RECAPTCHA_REMOTEIP + GIMP_CAPTCHA_ENABLED + GIMP_CAPTCHA_DIR + :type dist: :class:`bridgedb.Dist.IPBasedDistributor` + :param dist: A bridge distributor. + :type sched: :class:`bridgedb.Time.IntervalSchedule` + :param sched: DOCDOC """ httpdist = twisted.web.resource.Resource() httpdist.putChild('', WebRoot())

1 0

[bridgedb/develop] Rewrite GimpCaptchaProtectedResource to use RSA & HMAC keys for verification.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit c9496cd45c295e292b5966ad022e2c305f2dbe37 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:03:18 2014 +0000 Rewrite GimpCaptchaProtectedResource to use RSA & HMAC keys for verification. --- lib/bridgedb/HTTPServer.py | 56 ++++++++++++++++++++++++++++++++++---------- 1 file changed, 43 insertions(+), 13 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 4deac25..ff9c7f3 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -115,9 +115,10 @@ def replaceErrorPage(error, template_name=None): class CaptchaProtectedResource(twisted.web.resource.Resource): """A general resource protected by some form of CAPTCHA.""" + isLeaf = True + def __init__(self, useForwardedHeader=False, resource=None): twisted.web.resource.Resource.__init__(self) - self.isLeaf = resource.isLeaf self.useForwardedHeader = useForwardedHeader self.resource = resource @@ -234,9 +235,33 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): .. _gimp-captcha: https://github.com/isislovecruft/gimp-captcha """ - def __init__(self, captchaDir='', - useForwardedHeader=False, resource=None): + def __init__(self, secretKey=None, publicKey=None, hmacKey=None, + captchaDir='', useForwardedHeader=False, resource=None): + """Protect a **resource** via this one, using a local CAPTCHA cache. + + :param str secretkey: A PKCS#1 OAEP-padded, private RSA key, used for + verifying the client's solution to the CAPTCHA. See + :func:`bridgedb.crypto.getRSAKey` and the + ``GIMP_CAPTCHA_RSA_KEYFILE`` config setting. + :param str publickey: A PKCS#1 OAEP-padded, public RSA key, used for + creating the ``captcha_challenge_field`` string to give to a + client. + :param bytes hmacKey: The master HMAC key, used for validating CAPTCHA + challenge strings in :meth:`captcha.GimpCaptcha.check`. The file + where this key is stored can be set via the + ``GIMP_CAPTCHA_HMAC_KEYFILE`` option in the config file. + :param str captchaDir: The directory where the cached CAPTCHA images + are stored. See the ``GIMP_CAPTCHA_DIR`` config setting. + :param bool useForwardedHeader: If ``True``, obtain the client's IP + address from the ``X-Forwarded-For`` HTTP header. + :type resource: :api:`twisted.web.resource.Resource` + :param resource: The resource to serve if the client successfully + passes the CAPTCHA challenge. + """ CaptchaProtectedResource.__init__(self, useForwardedHeader, resource) + self.secretKey = secretKey + self.publicKey = publicKey + self.hmacKey = hmacKey self.captchaDir = captchaDir def checkSolution(self, request): @@ -255,12 +280,15 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): :rtupe: bool :returns: True, if the CAPTCHA solution was valid; False otherwise. """ - challenge, response = self.extractClientSolution(request) + challenge, solution = self.extractClientSolution(request) clientIP = self.getClientIP(request) - solution = captcha.GimpCaptcha.check(challenge, response, clientIP) - logging.debug("Captcha from %r. Parameters: %r" - % (Util.logSafely(clientIP), request.args)) - return solution + clientHMACKey = crypto.getHMAC(self.hmacKey, clientIP) + valid = captcha.GimpCaptcha.check(challenge, solution, + self.secretKey, clientHMACKey) + logging.debug("%sorrect captcha from %r: %r." % ( + "C" if valid else "Inc", Util.logSafely(clientIP), solution)) + + return valid def getCaptchaImage(self, request): """Get a random CAPTCHA image from our **captchaDir**. @@ -276,18 +304,20 @@ class GimpCaptchaProtectedResource(CaptchaProtectedResource): - ``image`` is a string holding a binary, JPEG-encoded image. - ``challenge`` is a unique string associated with the request. """ + # Create a new HMAC key, specific to requests from this client: clientIP = self.getClientIP(request) - c = captcha.GimpCaptcha(self.captchaDir, clientIP) - + clientHMACKey = crypto.getHMAC(self.hmacKey, clientIP) + capt = captcha.GimpCaptcha(self.secretKey, self.publicKey, + clientHMACKey, self.captchaDir) try: - c.get() + capt.get() except captcha.GimpCaptchaError as error: logging.error(error) except Exception as error: logging.error("Unhandled error while retrieving Gimp captcha!") - logging.error(error) + logging.exception(error) - return (c.image, c.challenge) + return (capt.image, capt.challenge) def render_GET(self, request): """Get a random CAPTCHA from our local cache directory and serve it to

1 0

[bridgedb/develop] Update bridgedb.crypto.getKey() docstring.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 0110e327901725d3961623bd56f12e84eebd2006 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:24:57 2014 +0000 Update bridgedb.crypto.getKey() docstring. --- lib/bridgedb/crypto.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/bridgedb/crypto.py b/lib/bridgedb/crypto.py index dc2523b..6c0101b 100644 --- a/lib/bridgedb/crypto.py +++ b/lib/bridgedb/crypto.py @@ -133,7 +133,7 @@ def getRSAKey(filename, bits=2048): return (sk, pk) def getKey(filename): - """Load the key stored in ``filename``, or create a new key. + """Load the master key stored in ``filename``, or create a new key. If ``filename`` does not exist, create a new 32-byte key and store it in ``filename``.

1 0

[bridgedb/develop] Remove unused zope imports in bridgedb.HTTPServer.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 1002df073e43ed3d3a790f05e95c13a4c274e20b Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:32:05 2014 +0000 Remove unused zope imports in bridgedb.HTTPServer. --- lib/bridgedb/HTTPServer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index ff9c7f3..0ff9818 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -38,7 +38,7 @@ from random import randint import mako.exceptions from mako.template import Template from mako.lookup import TemplateLookup -from zope.interface import Interface, Attribute, implements + template_root = os.path.join(os.path.dirname(__file__),'templates') logging.debug("Set template root to %s" % template_root)

1 0

[bridgedb/develop] Use RSA and HMAC captcha keys in resource init in addWebServer().
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit a7efb1df76433851bd92a51166450a413a76be18 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:35:03 2014 +0000 Use RSA and HMAC captcha keys in resource init in addWebServer(). --- lib/bridgedb/HTTPServer.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 51c1351..05315de 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -747,8 +747,20 @@ def addWebServer(cfg, dist, sched): useForwardedHeader=cfg.HTTP_USE_IP_FROM_FORWARDED_HEADER, resource=resource) httpdist.putChild('bridges', protected) + elif cfg.GIMP_CAPTCHA_ENABLED: + # Get the HMAC secret key for CAPTCHA challenges and create a new key + # from it for use on the server: + captchaKey = crypto.getKey(cfg.GIMP_CAPTCHA_HMAC_KEYFILE) + hmacKey = crypto.getHMAC(captchaKey, "Captcha-Key") + + # Load or create our encryption keys: + secretKey, publicKey = crypto.getRSAKey(cfg.GIMP_CAPTCHA_RSA_KEYFILE) + protected = GimpCaptchaProtectedResource( + secretKey=secretKey, + publicKey=publicKey, + hmacKey=hmacKey, captchaDir=cfg.GIMP_CAPTCHA_DIR, useForwardedHeader=cfg.HTTP_USE_IP_FROM_FORWARDED_HEADER, resource=resource)

1 0

[bridgedb/develop] Pep8; change `c` → `capt` in ReCaptchaProtectedResource.getCaptchaImage().
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 670e3fc7dd7519e97b9fd6d22ee45f5acb910474 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:33:52 2014 +0000 Pep8; change `c` → `capt` in ReCaptchaProtectedResource.getCaptchaImage(). --- lib/bridgedb/HTTPServer.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 228f350..51c1351 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -375,17 +375,17 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): - ``image`` is a string holding a binary, JPEG-encoded image. - ``challenge`` is a unique string associated with the request. """ - c = captcha.ReCaptcha(self.recaptchaPubKey, self.recaptchaPrivKey) + capt = captcha.ReCaptcha(self.recaptchaPubKey, self.recaptchaPrivKey) try: - c.get() + capt.get() except Exception as error: logging.fatal("Connection to Recaptcha server failed: %s" % error) - if c.image is None: + if capt.image is None: logging.warn("No CAPTCHA image received from ReCaptcha server!") - return (c.image, c.challenge) + return (capt.image, capt.challenge) def getRemoteIP(self): """Mask the client's real IP address with a faked one.

1 0

[bridgedb/develop] Add example CAPTCHA for unittests.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit d4fbd5e675479f09511b8c44409a16458b39effd Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 04:25:34 2014 +0000 Add example CAPTCHA for unittests. --- captchas/Tvx74PMy.jpg | Bin 0 -> 61434 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/captchas/Tvx74PMy.jpg b/captchas/Tvx74PMy.jpg new file mode 100644 index 0000000..47e3d76 Binary files /dev/null and b/captchas/Tvx74PMy.jpg differ

1 0

[bridgedb/develop] Document `request` parameter in ReCaptchaProtectedResource.getCaptchaImage().
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 29e95448ae36b15df629ae8b904ca357e901a3be Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:32:46 2014 +0000 Document `request` parameter in ReCaptchaProtectedResource.getCaptchaImage(). --- lib/bridgedb/HTTPServer.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 0ff9818..228f350 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -368,6 +368,9 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource): def getCaptchaImage(self, request): """Get a CAPTCHA image from the remote reCaptcha server. + :type request: :api:`twisted.web.http.Request` + :param request: A client's initial request for some other resource + which is protected by this one (i.e. protected by a CAPTCHA). :returns: A 2-tuple of ``(image, challenge)``, where:: - ``image`` is a string holding a binary, JPEG-encoded image. - ``challenge`` is a unique string associated with the request.

1 0

[bridgedb/develop] Add default captcha cache directory to .gitignore.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 9aca4333526a74221b0e193ed30437788a20dd16 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 04:26:52 2014 +0000 Add default captcha cache directory to .gitignore. --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index de658ec..c214b82 100644 --- a/.gitignore +++ b/.gitignore @@ -98,3 +98,6 @@ gnupghome/* # trial test run directory: _trial_temp/* _trial_temp.lock + +# default captcha cache directory: +captchas/*

1 0

[bridgedb/develop] Add unittests for bridgedb.captcha module.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 0395fb40a8621d3c996dcb06d70915cb84ab6fb6 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 12 00:53:08 2014 +0000 Add unittests for bridgedb.captcha module. --- lib/bridgedb/test/test_captcha.py | 237 +++++++++++++++++++++++++++++++++++++ 1 file changed, 237 insertions(+) diff --git a/lib/bridgedb/test/test_captcha.py b/lib/bridgedb/test/test_captcha.py new file mode 100644 index 0000000..2e4a1cf --- /dev/null +++ b/lib/bridgedb/test/test_captcha.py @@ -0,0 +1,237 @@ +# -*- coding: utf-8 -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# :copyright: (c) 2013-2014, Isis Lovecruft +# (c) 2007-2014, The Tor Project, Inc. +# :license: 3-Clause BSD, see LICENSE for licensing information + +"""Unittests for the :mod:`bridgedb.captcha` module.""" + + +import shutil +import os + +from base64 import urlsafe_b64decode + +from twisted.trial import unittest + +from zope.interface import implementedBy +from zope.interface import providedBy + +from bridgedb import captcha +from bridgedb import crypto + + +class CaptchaTests(unittest.TestCase): + """Tests for :class:`bridgedb.captcha.Captcha`.""" + + def test_implementation(self): + """Captcha class should implement ICaptcha interface.""" + self.assertTrue(captcha.ICaptcha.implementedBy(captcha.Captcha)) + + def test_provider(self): + """ICaptcha should be provided by instances of Captcha.""" + c = captcha.Captcha() + self.assertTrue(captcha.ICaptcha.providedBy(c)) + + def test_get(self): + """Captcha.get() should return None.""" + c = captcha.Captcha() + self.assertIsNone(c.get()) + + +class ReCaptchaTests(unittest.TestCase): + """Tests for :class:`bridgedb.captcha.ReCaptcha`.""" + + def setUp(self): + self.c = captcha.ReCaptcha('publik', 'sekrit') + + def test_init(self): + """Check the ReCaptcha class stored the private and public keys.""" + self.assertEquals(self.c.privkey, 'sekrit') + self.assertEquals(self.c.pubkey, 'publik') + + def test_get(self): + """Test get() method.""" + + # Force urllib2 to do anything less idiotic than the defaults: + envkey = 'HTTPS_PROXY' + oldkey = None + if os.environ.has_key(envkey): + oldkey = os.environ[envkey] + os.environ[envkey] = '127.0.0.1:9150' + # This stupid thing searches the environment for ``<protocol>_PROXY`` + # variables, hence the above 'HTTPS_PROXY' env setting: + proxy = captcha.urllib2.ProxyHandler() + opener = captcha.urllib2.build_opener(proxy) + captcha.urllib2.install_opener(opener) + + try: + # There isn't really a reliable way to test this function! :( + self.c.get() + except Exception as error: + reason = "ReCaptcha.get() test requires an active network " + reason += "connection.\nThis test failed with: %s" % error + raise unittest.SkipTest(reason) + else: + self.assertIsInstance(self.c.image, basestring) + self.assertIsInstance(self.c.challenge, basestring) + finally: + # Replace the original environment variable if there was one: + if oldkey: + os.environ[envkey] = oldkey + else: + os.environ.pop(envkey) + + def test_get_noKeys(self): + """ReCaptcha.get() without API keys should fail.""" + c = captcha.ReCaptcha() + self.assertRaises(captcha.ReCaptchaKeyError, c.get) + + +class GimpCaptchaTests(unittest.TestCase): + """Tests for :class:`bridgedb.captcha.GimpCaptcha`.""" + + def setUp(self): + here = os.getcwd() + self.topDir = here.rstrip('_trial_temp') + self.cacheDir = os.path.join(self.topDir, 'captchas') + self.badCacheDir = os.path.join(here, 'capt') + + # Get keys for testing or create them: + self.sekrit, self.publik = crypto.getRSAKey('test_gimpCaptcha_RSAkey') + self.hmacKey = crypto.getKey('test_gimpCaptcha_HMACkey') + + def test_init_noSecretKey(self): + """Calling GimpCaptcha.__init__() without a secret key parameter should raise + a GimpCaptchaKeyError. + """ + self.assertRaises(captcha.GimpCaptchaKeyError, captcha.GimpCaptcha, + None, self.publik, self.hmacKey, self.cacheDir) + + def test_init_noPublicKey(self): + """__init__() without publicKey should raise a GimpCaptchaKeyError.""" + self.assertRaises(captcha.GimpCaptchaKeyError, captcha.GimpCaptcha, + self.sekrit, None, self.hmacKey, self.cacheDir) + + def test_init_noHMACKey(self): + """__init__() without hmacKey should raise a GimpCaptchaKeyError.""" + self.assertRaises(captcha.GimpCaptchaKeyError, captcha.GimpCaptcha, + self.sekrit, self.publik, None, self.cacheDir) + + def test_init_noCacheDir(self): + """__init__() without cacheDir should raise a GimpCaptchaKeyError.""" + self.assertRaises(captcha.GimpCaptchaError, captcha.GimpCaptcha, + self.sekrit, self.publik, self.hmacKey, None) + + def test_init_badCacheDir(self): + """GimpCaptcha with bad cacheDir should raise GimpCaptchaError.""" + self.assertRaises(captcha.GimpCaptchaError, captcha.GimpCaptcha, + self.sekrit, self.publik, self.hmacKey, + self.cacheDir.rstrip('chas')) + + def test_init(self): + """Test that __init__ correctly initialised all the values.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + self.assertIsNone(c.answer) + self.assertIsNone(c.image) + self.assertIsNone(c.challenge) + + def test_createChallenge(self): + """createChallenge() should return the encrypted CAPTCHA answer.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + challenge = c.createChallenge('w00t') + self.assertIsInstance(challenge, basestring) + + def test_createChallenge_base64(self): + """createChallenge() return value should be urlsafe base64-encoded.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + challenge = c.createChallenge('w00t') + decoded = urlsafe_b64decode(challenge) + self.assertTrue(decoded.find(';') >= 1) + + def test_createChallenge_hmacValid(self): + """The HMAC in createChallenge() return value should be valid.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + challenge = c.createChallenge('ShouldHaveAValidHMAC') + decoded = urlsafe_b64decode(challenge) + hmac, orig = decoded.split(';', 1) + correctHMAC = crypto.getHMAC(self.hmacKey, orig) + self.assertTrue(hmac == correctHMAC) + + def test_createChallenge_decryptedAnswerMatches(self): + """The HMAC in createChallenge() return value should be valid.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + answer = 'ThisAnswerShouldDecryptToThis' + challenge = c.createChallenge(answer) + decoded = urlsafe_b64decode(challenge) + hmac, orig = decoded.split(';', 1) + correctHMAC = crypto.getHMAC(self.hmacKey, orig) + self.assertEqual(hmac, correctHMAC) + decrypted = self.sekrit.decrypt(orig) + self.assertEqual(answer, decrypted) + + def test_get(self): + """GimpCaptcha.get() should return image and challenge strings.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + image, challenge = c.get() + self.assertIsInstance(image, basestring) + self.assertIsInstance(challenge, basestring) + + def test_get_emptyCacheDir(self): + """An empty cacheDir should raise GimpCaptchaError.""" + os.makedirs(self.badCacheDir) + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.badCacheDir) + self.assertRaises(captcha.GimpCaptchaError, c.get) + shutil.rmtree(self.badCacheDir) + + def test_get_unreadableCaptchaFile(self): + """An unreadable CAPTCHA file should raise GimpCaptchaError.""" + os.makedirs(self.badCacheDir) + badFile = os.path.join(self.badCacheDir, 'uNr34dA81e.jpg') + with open(badFile, 'w') as fh: + fh.write(' ') + fh.flush() + os.chmod(badFile, 0266) + + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.badCacheDir) + # This should hit the second `except:` clause in get(): + self.assertRaises(captcha.GimpCaptchaError, c.get) + shutil.rmtree(self.badCacheDir) + + def test_check(self): + """A correct answer and valid challenge should return True.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + image, challenge = c.get() + self.assertEquals( + c.check(challenge, c.answer, c.secretKey, c.hmacKey), + True) + + def test_check_blankAnswer(self): + """A blank answer and valid challenge should return False.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + image, challenge = c.get() + self.assertEquals( + c.check(challenge, None, c.secretKey, c.hmacKey), + False) + + def test_check_nonBase64(self): + """Valid answer and challenge with invalid base64 returns False.""" + c = captcha.GimpCaptcha(self.sekrit, self.publik, self.hmacKey, + self.cacheDir) + image, challenge = c.get() + self.assertEquals( + c.check(challenge.rstrip('=='), c.answer, c.secretKey, c.hmacKey), + False)

1 0