def test_HowtoResource_render_GET_lang_ru(self):
"""renderGet() with ?lang=ru should return the howto page in Russian."""
request = DummyRequest([self.pagename])
request.method = b'GET'
request.addArg('lang', 'ru')
page = self.howtoResource.render_GET(request)
self.assertSubstring("следуйте инструкциям установщика", page)
def test_IndexResource_render_GET_lang_ta(self):
"""renderGet() with ?lang=ta should return the index page in Tamil."""
request = DummyRequest([self.pagename])
request.method = b'GET'
request.addArg('lang', 'ta')
page = self.indexResource.render_GET(request)
self.assertSubstring("bridge-களை Tor Browser-உள்", page)
def test_HowtoResource_render_GET_lang_ru(self):
"""renderGet() with ?lang=ru should return the howto page in Russian."""
request = DummyRequest([self.pagename])
request.method = b'GET'
request.addArg('lang', 'ru')
page = self.howtoResource.render_GET(request)
self.assertSubstring("следуйте инструкциям установщика", page)
def test_IndexResource_render_GET_lang_ta(self):
"""renderGet() with ?lang=ta should return the index page in Tamil."""
request = DummyRequest([self.pagename])
request.method = b'GET'
request.addArg('lang', 'ta')
page = self.indexResource.render_GET(request)
self.assertSubstring("bridge-களை Tor Browser-உள்", page)
def test_HowtoResource_render_GET_lang_ru(self):
"""renderGet() with ?lang=ru should return the howto page in Russian."""
if 'ru' not in _langs.get_langs():
self.skipTest("'ru' language unsupported")
request = DummyRequest([self.pagename])
request.method = b'GET'
request.addArg(b'lang', 'ru')
page = self.howtoResource.render_GET(request)
self.assertSubstring("Как использовать мосты".encode("utf-8"), page)
def test_IndexResource_render_GET_lang_ta(self):
"""renderGet() with ?lang=ta should return the index page in Tamil."""
if 'ta' not in _langs.get_langs():
self.skipTest("'ta' language unsupported")
request = DummyRequest([self.pagename])
request.method = b'GET'
request.addArg(b'lang', 'ta')
page = self.indexResource.render_GET(request)
self.assertSubstring("bridge-களை Tor Browser-உள்".encode("utf-8"),
page)
class ReCaptchaProtectedResourceTests(unittest.TestCase):
"""Tests for :mod:`bridgedb.distributors.https.server.ReCaptchaProtectedResource`."""
def setUp(self):
"""Create a :class:`server.BridgesResource` and protect it with
a :class:`ReCaptchaProtectedResource`.
"""
self.timeout = 10.0 # Can't take longer than that, right?
# Set up our resources to fake a minimal HTTP(S) server:
self.pagename = b'captcha.html'
self.root = Resource()
# (None, None) is the (distributor, scheduleInterval):
self.protectedResource = server.BridgesResource(None, None)
self.captchaResource = server.ReCaptchaProtectedResource(
publicKey='23',
secretKey='42',
remoteIP='111.111.111.111',
useForwardedHeader=True,
protectedResource=self.protectedResource)
self.root.putChild(self.pagename, self.captchaResource)
# Set up the basic parts of our faked request:
self.request = DummyRequest([self.pagename])
def tearDown(self):
"""Cleanup method for removing timed out connections on the reactor.
This seems to be the solution for the dirty reactor due to
``DelayedCall``s which is mentioned at the beginning of this
file. There doesn't seem to be any documentation anywhere which
proposes this solution, although this seems to solve the problem.
"""
for delay in reactor.getDelayedCalls():
try:
delay.cancel()
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),
features="html5lib").find(b'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(b'BridgeDB encountered an error.', 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:`server.ReCaptchaProtectedResource.checkSolution` should
return a redirect if is the solution field is blank.
"""
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', '')
self.request.addArg('captcha_response_field', '')
self.assertEqual((False, self.request),
self.successResultOf(
self.captchaResource.checkSolution(self.request)))
def test_getRemoteIP_useRandomIP(self):
"""Check that removing our remoteip setting produces a random IP."""
self.captchaResource.remoteIP = None
ip = self.captchaResource.getRemoteIP()
realishIP = ipaddress.IPv4Address(ip).compressed
self.assertTrue(realishIP)
self.assertNotEquals(realishIP, '111.111.111.111')
def test_getRemoteIP_useConfiguredIP(self):
"""Check that our remoteip setting is used if configured."""
ip = self.captchaResource.getRemoteIP()
realishIP = ipaddress.IPv4Address(ip).compressed
self.assertTrue(realishIP)
self.assertEquals(realishIP, '111.111.111.111')
def test_render_GET_missingTemplate(self):
"""render_GET() with a missing template should raise an error and
return the result of replaceErrorPage().
"""
oldLookup = server.lookup
try:
server.lookup = None
self.request.method = b'GET'
page = self.captchaResource.render_GET(self.request)
errorPage = server.replaceErrorPage(self.request,
Exception('kablam'))
self.assertEqual(page, errorPage)
finally:
server.lookup = oldLookup
def test_render_POST_blankFields(self):
"""render_POST() with a blank 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', '')
self.request.addArg('captcha_response_field', '')
page = self.captchaResource.render_POST(self.request)
self.assertEqual(page, server.NOT_DONE_YET)
def test_render_POST_wrongSolution(self):
"""render_POST() with a wrong 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
page = self.captchaResource.render_POST(self.request)
self.assertEqual(page, server.NOT_DONE_YET)
class GimpCaptchaProtectedResourceTests(unittest.TestCase):
"""Tests for :mod:`bridgedb.distributors.https.server.GimpCaptchaProtectedResource`."""
def setUp(self):
"""Create a :class:`server.BridgesResource` and protect it with
a :class:`GimpCaptchaProtectedResource`.
"""
# 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()
# (None, None) is the (distributor, scheduleInterval):
self.protectedResource = server.BridgesResource(None, None)
self.captchaResource = server.GimpCaptchaProtectedResource(
secretKey='42',
publicKey='23',
hmacKey='abcdefghijklmnopqrstuvwxyz012345',
captchaDir='captchas',
useForwardedHeader=True,
protectedResource=self.protectedResource)
self.root.putChild(self.pagename, self.captchaResource)
# Set up the basic parts of our faked request:
self.request = DummyRequest([self.pagename])
def tearDown(self):
"""Delete the cached CAPTCHA directory if it still exists."""
if os.path.isdir(self.captchaDir):
shutil.rmtree(self.captchaDir)
def test_extractClientSolution(self):
"""A (challenge, sollution) pair extracted from a request resulting
from a POST should have the same unmodified (challenge, sollution) as
the client originally POSTed.
"""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
response = self.captchaResource.extractClientSolution(self.request)
(challenge, response) = response
self.assertEqual(challenge, expectedChallenge)
self.assertEqual(response, expectedResponse)
def test_extractClientSolution_missing_arguments(self):
"""A solution with missing arguments (the solution/challenge fields)
should raise a MaliciousRequest exception.
"""
expectedChallenge = '23232323232323232323'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.assertRaises(server.MaliciousRequest,
self.captchaResource.extractClientSolution,
self.request)
def test_checkSolution(self):
"""checkSolution() should return False is the solution is invalid."""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
valid = self.captchaResource.checkSolution(self.request)
self.assertFalse(valid)
def test_getCaptchaImage(self):
"""Retrieving a (captcha, challenge) pair with an empty captchaDir
should return None for both of the (captcha, challenge) strings.
"""
self.request.method = b'GET'
response = self.captchaResource.getCaptchaImage(self.request)
(image, challenge) = response
# Because we created the directory, there weren't any CAPTCHAs to
# retrieve from it:
self.assertIs(image, None)
self.assertIs(challenge, None)
def test_getCaptchaImage_noCaptchaDir(self):
"""Retrieving a (captcha, challenge) with an missing captchaDir should
raise a bridgedb.captcha.GimpCaptchaError.
"""
shutil.rmtree(self.captchaDir)
self.request.method = b'GET'
self.assertRaises(server.captcha.GimpCaptchaError,
self.captchaResource.getCaptchaImage, self.request)
def test_render_GET_missingTemplate(self):
"""render_GET() with a missing template should raise an error and
return the result of replaceErrorPage().
"""
oldLookup = server.lookup
try:
server.lookup = None
self.request.method = b'GET'
page = self.captchaResource.render_GET(self.request)
errorPage = server.replaceErrorPage(self.request,
Exception('kablam'))
self.assertEqual(page, errorPage)
finally:
server.lookup = oldLookup
def test_render_POST_blankFields(self):
"""render_POST() with a blank 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', '')
self.request.addArg('captcha_response_field', '')
page = self.captchaResource.render_POST(self.request)
self.assertEqual(
BeautifulSoup(page,
features="html5lib").find('meta')['http-equiv'],
'refresh')
def test_render_POST_wrongSolution(self):
"""render_POST() with a wrong 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
page = self.captchaResource.render_POST(self.request)
self.assertEqual(
BeautifulSoup(page,
features="html5lib").find('meta')['http-equiv'],
'refresh')
class ReCaptchaProtectedResourceTests(unittest.TestCase):
"""Tests for :mod:`bridgedb.distributors.https.server.ReCaptchaProtectedResource`."""
def setUp(self):
"""Create a :class:`server.BridgesResource` and protect it with
a :class:`ReCaptchaProtectedResource`.
"""
self.timeout = 10.0 # Can't take longer than that, right?
# Set up our resources to fake a minimal HTTP(S) server:
self.pagename = b'captcha.html'
self.root = Resource()
# (None, None) is the (distributor, scheduleInterval):
self.protectedResource = server.BridgesResource(None, None)
self.captchaResource = server.ReCaptchaProtectedResource(
publicKey='23',
secretKey='42',
remoteIP='111.111.111.111',
useForwardedHeader=True,
protectedResource=self.protectedResource)
self.root.putChild(self.pagename, self.captchaResource)
# Set up the basic parts of our faked request:
self.request = DummyRequest([self.pagename])
def tearDown(self):
"""Cleanup method for removing timed out connections on the reactor.
This seems to be the solution for the dirty reactor due to
``DelayedCall``s which is mentioned at the beginning of this
file. There doesn't seem to be any documentation anywhere which
proposes this solution, although this seems to solve the problem.
"""
for delay in reactor.getDelayedCalls():
try:
delay.cancel()
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('Uh oh, spaghettios!', 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:`server.ReCaptchaProtectedResource.checkSolution` should
return a redirect if is the solution field is blank.
"""
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', '')
self.request.addArg('captcha_response_field', '')
self.assertEqual((False, self.request),
self.successResultOf(
self.captchaResource.checkSolution(self.request)))
def test_getRemoteIP_useRandomIP(self):
"""Check that removing our remoteip setting produces a random IP."""
self.captchaResource.remoteIP = None
ip = self.captchaResource.getRemoteIP()
realishIP = ipaddr.IPv4Address(ip).compressed
self.assertTrue(realishIP)
self.assertNotEquals(realishIP, '111.111.111.111')
def test_getRemoteIP_useConfiguredIP(self):
"""Check that our remoteip setting is used if configured."""
ip = self.captchaResource.getRemoteIP()
realishIP = ipaddr.IPv4Address(ip).compressed
self.assertTrue(realishIP)
self.assertEquals(realishIP, '111.111.111.111')
def test_render_GET_missingTemplate(self):
"""render_GET() with a missing template should raise an error and
return the result of replaceErrorPage().
"""
oldLookup = server.lookup
try:
server.lookup = None
self.request.method = b'GET'
page = self.captchaResource.render_GET(self.request)
errorPage = server.replaceErrorPage(self.request, Exception('kablam'))
self.assertEqual(page, errorPage)
finally:
server.lookup = oldLookup
def test_render_POST_blankFields(self):
"""render_POST() with a blank 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', '')
self.request.addArg('captcha_response_field', '')
page = self.captchaResource.render_POST(self.request)
self.assertEqual(page, server.NOT_DONE_YET)
def test_render_POST_wrongSolution(self):
"""render_POST() with a wrong 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
page = self.captchaResource.render_POST(self.request)
self.assertEqual(page, server.NOT_DONE_YET)
class GimpCaptchaProtectedResourceTests(unittest.TestCase):
"""Tests for :mod:`bridgedb.distributors.https.server.GimpCaptchaProtectedResource`."""
def setUp(self):
"""Create a :class:`server.BridgesResource` and protect it with
a :class:`GimpCaptchaProtectedResource`.
"""
# 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()
# (None, None) is the (distributor, scheduleInterval):
self.protectedResource = server.BridgesResource(None, None)
self.captchaResource = server.GimpCaptchaProtectedResource(
secretKey='42',
publicKey='23',
hmacKey='abcdefghijklmnopqrstuvwxyz012345',
captchaDir='captchas',
useForwardedHeader=True,
protectedResource=self.protectedResource)
self.root.putChild(self.pagename, self.captchaResource)
# Set up the basic parts of our faked request:
self.request = DummyRequest([self.pagename])
def tearDown(self):
"""Delete the cached CAPTCHA directory if it still exists."""
if os.path.isdir(self.captchaDir):
shutil.rmtree(self.captchaDir)
def test_extractClientSolution(self):
"""A (challenge, sollution) pair extracted from a request resulting
from a POST should have the same unmodified (challenge, sollution) as
the client originally POSTed.
"""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
response = self.captchaResource.extractClientSolution(self.request)
(challenge, response) = response
self.assertEqual(challenge, expectedChallenge)
self.assertEqual(response, expectedResponse)
def test_extractClientSolution_missing_arguments(self):
"""A solution with missing arguments (the solution/challenge fields)
should raise a MaliciousRequest exception.
"""
expectedChallenge = '23232323232323232323'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.assertRaises(server.MaliciousRequest,
self.captchaResource.extractClientSolution,
self.request)
def test_checkSolution(self):
"""checkSolution() should return False is the solution is invalid."""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
valid = self.captchaResource.checkSolution(self.request)
self.assertFalse(valid)
def test_getCaptchaImage(self):
"""Retrieving a (captcha, challenge) pair with an empty captchaDir
should return None for both of the (captcha, challenge) strings.
"""
self.request.method = b'GET'
response = self.captchaResource.getCaptchaImage(self.request)
(image, challenge) = response
# Because we created the directory, there weren't any CAPTCHAs to
# retrieve from it:
self.assertIs(image, None)
self.assertIs(challenge, None)
def test_getCaptchaImage_noCaptchaDir(self):
"""Retrieving a (captcha, challenge) with an missing captchaDir should
raise a bridgedb.captcha.GimpCaptchaError.
"""
shutil.rmtree(self.captchaDir)
self.request.method = b'GET'
self.assertRaises(server.captcha.GimpCaptchaError,
self.captchaResource.getCaptchaImage, self.request)
def test_render_GET_missingTemplate(self):
"""render_GET() with a missing template should raise an error and
return the result of replaceErrorPage().
"""
oldLookup = server.lookup
try:
server.lookup = None
self.request.method = b'GET'
page = self.captchaResource.render_GET(self.request)
errorPage = server.replaceErrorPage(self.request, Exception('kablam'))
self.assertEqual(page, errorPage)
finally:
server.lookup = oldLookup
def test_render_POST_blankFields(self):
"""render_POST() with a blank 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', '')
self.request.addArg('captcha_response_field', '')
page = self.captchaResource.render_POST(self.request)
self.assertEqual(BeautifulSoup(page).find('meta')['http-equiv'],
'refresh')
def test_render_POST_wrongSolution(self):
"""render_POST() with a wrong 'captcha_response_field' should return
a redirect to the CaptchaProtectedResource page.
"""
expectedChallenge = '23232323232323232323'
expectedResponse = 'awefawefaefawefaewf'
self.request.method = b'POST'
self.request.addArg('captcha_challenge_field', expectedChallenge)
self.request.addArg('captcha_response_field', expectedResponse)
page = self.captchaResource.render_POST(self.request)
self.assertEqual(BeautifulSoup(page).find('meta')['http-equiv'],
'refresh')
