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

[bridgedb/master] Split general and reCaptcha functionality into separate classes.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 75f5895e729c79fcf585f7b0fc18313f4d9ea53f Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 1 03:01:35 2014 +0000 Split general and reCaptcha functionality into separate classes. * CHANGE captcha.CaptchaProtectedResource class to only implement general CAPTCHA functionality. * CHANGE render_* methods in captcha.CaptchaProtectedResource to call subclass overridable methods for actions which are implementation specific, i.e. only the reCaptcha class needs to create a fake IP address for a client (see the new ReCaptchaProtectedResource.getRemoteIP() method), so this functionality should be in a separate method rather than in captcha.CaptchaProtectedResource.render_POST(). See methods getCaptchaImage(), extractClientSolution(), and checkSolution(). * ADD new captcha.ReCaptchaProtectedResource class which is a subclass of captcha.CaptchaProtectedResource, and which implements reCaptcha-specific functionality. * CHANGE lib/bridgedb/templates/captcha.html to use HTTP parameters 'captcha_challenge_field' and 'captcha_response_field', rather than 'recaptcha_challenge_field' and 'recaptcha_response_field' respectively. --- lib/bridgedb/HTTPServer.py | 222 +++++++++++++++++++++++++++-------- lib/bridgedb/templates/captcha.html | 18 +-- 2 files changed, 184 insertions(+), 56 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 63e48c9..ae14f62 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -112,14 +112,12 @@ def replaceErrorPage(error, template_name=None): class CaptchaProtectedResource(twisted.web.resource.Resource): - def __init__(self, useRecaptcha=False, recaptchaPrivKey='', - recaptchaPubKey='', remoteip='', useForwardedHeader=False, - resource=None): + """A general resource protected by some form of CAPTCHA.""" + + def __init__(self, useForwardedHeader=False, resource=None): + twisted.web.resource.Resource.__init__(self) self.isLeaf = resource.isLeaf self.useForwardedHeader = useForwardedHeader - self.recaptchaPrivKey = recaptchaPrivKey - self.recaptchaPubKey = recaptchaPubKey - self.recaptchaRemoteIP = remoteip self.resource = resource def getClientIP(self, request): @@ -135,84 +133,212 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): ip = request.getClientIP() return ip + def getCaptchaImage(self): + """Get a CAPTCHA image. + + :returns: A 2-tuple of ``(image, challenge)``, where ``image`` is a + binary, JPEG-encoded image, and ``challenge`` is a unique + string. If unable to retrieve a CAPTCHA, returns + ``(None, None)``. + """ + return (None, None) + + def extractClientSolution(self, request): + """Extract the client's CAPTCHA solution from a POST request. + + This is used after receiving a POST request from a client (which + should contain their solution to the CAPTCHA), to extract the solution + and challenge strings. + + :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. + """ + try: + challenge = request.args['captcha_challenge_field'][0] + response = request.args['captcha_response_field'][0] + except: + return redirectTo(request.URLPath(), request) + return (challenge, response) + + def checkSolution(self, request): + """Override this method to check a client's CAPTCHA solution. + + :rtype: bool + :returns: ``True`` if the client correctly solved the CAPTCHA; + ``False`` otherwise. + """ + return False + def render_GET(self, request): """Retrieve a ReCaptcha from the API server and serve it to the client. :type request: :api:`twisted.web.http.Request` - :param request: A ``Request`` object for 'bridges.html'. + :param request: A ``Request`` object for a page which should be + protected by a CAPTCHA. :rtype: str :returns: A rendered HTML page containing a ReCaptcha challenge image for the client to solve. """ - c = captcha.ReCaptcha(self.recaptchaPubKey, self.recaptchaPrivKey) - - try: - c.get() - except Exception as error: - logging.fatal("Connection to Recaptcha server failed: %s" % error) - - if c.image is None: - logging.warn("No CAPTCHA image received from ReCaptcha server!") + image, challenge = self.getCaptchaImage() try: # TODO: this does not work for versions of IE < 8.0 - imgstr = 'data:image/jpeg;base64,%s' % base64.b64encode(c.image) + imgstr = 'data:image/jpeg;base64,%s' % base64.b64encode(image) template = lookup.get_template('captcha.html') rendered = template.render(imgstr=imgstr, - challenge_field=c.challenge) + challenge_field=challenge) except Exception as err: rendered = replaceErrorPage(err, 'captcha.html') return rendered def render_POST(self, request): - """Process a client CAPTCHA by sending it to the ReCaptcha server. + """Process a client's CAPTCHA solution. - The client's IP address is not sent to the ReCaptcha server; instead, - a completely random IP is generated and sent instead. + If the client's CAPTCHA solution is valid (according to + :meth:`checkSolution`), process and serve their original + request. Otherwise, redirect them back to a new CAPTCHA page. :type request: :api:`twisted.web.http.Request` - :param request: A ``Request`` object containing the POST arguments + :param request: A ``Request`` object, including POST arguments which should include two key/value pairs: one key being - ``'recaptcha_challange_field'``, and the other, - ``'recaptcha_response_field'``. These POST arguments + ``'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. """ - try: - challenge = request.args['recaptcha_challenge_field'][0] - response = request.args['recaptcha_response_field'][0] - except: - return redirectTo(request.URLPath(), request) - - if self.recaptchaRemoteIP: - remote_ip = self.recaptchaRemoteIP - else: - # generate a random IP for the captcha submission - remote_ip = '%d.%d.%d.%d' % (randint(1,255),randint(1,255), - randint(1,255),randint(1,255)) - - recaptcha_response = recaptcha.submit(challenge, response, - self.recaptchaPrivKey, remote_ip) - logging.debug("Captcha from client with masked IP %r. Parameters:\n%r" - % (remote_ip, request.args)) - - if recaptcha_response.is_valid: - logging.info("Valid recaptcha from client with masked IP %r." - % remote_ip) + if self.checkSolution(request): try: rendered = self.resource.render(request) except Exception as err: rendered = replaceErrorPage(err) return rendered - else: - logging.info("Invalid recaptcha from client with masked IP %r: %r" - % (remote_ip, recaptcha_response.error_code)) logging.debug("Client failed a recaptcha; returning redirect to %s" % request.uri) return redirectTo(request.uri, request) +class ReCaptchaProtectedResource(CaptchaProtectedResource): + """A web resource which uses the reCaptcha_ service. + + .. _reCaptcha: http://www.google.com/recaptcha + """ + + def __init__(self, recaptchaPrivKey='', recaptchaPubKey='', remoteip='', + useForwardedHeader=False, resource=None): + CaptchaProtectedResource.__init__(self, useForwardedHeader, resource) + self.recaptchaPrivKey = recaptchaPrivKey + self.recaptchaPubKey = recaptchaPubKey + self.recaptchaRemoteIP = remoteip + + def getCaptchaImage(self): + """Get a CAPTCHA image from the remote reCaptcha server. + + :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. + """ + c = captcha.ReCaptcha(self.recaptchaPubKey, self.recaptchaPrivKey) + + try: + c.get() + except Exception as error: + logging.fatal("Connection to Recaptcha server failed: %s" % error) + + if c.image is None: + logging.warn("No CAPTCHA image received from ReCaptcha server!") + + return (c.image, c.challenge) + + def getRemoteIP(self): + """Mask the client's real IP address with a faked one. + + The fake client IP address is sent to the reCaptcha server, and it is + either the public IP address of bridges.torproject.org (if + ``RECAPTCHA_REMOTE_IP`` is configured), or a random IP. + + :rtype: str + :returns: A fake IP address to report to the reCaptcha API server. + """ + if self.recaptchaRemoteIP: + remoteIP = self.recaptchaRemoteIP + else: + # generate a random IP for the captcha submission + remoteIP = '%d.%d.%d.%d' % (randint(1,255),randint(1,255), + randint(1,255),randint(1,255)) + return remoteIP + + def checkSolution(self, request): + """Process a solved CAPTCHA by sending it to the ReCaptcha server. + + The client's IP address is not sent to the ReCaptcha server; instead, + 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, + ``'captcha_response_field'``. These POST arguments + should be obtained from :meth:`render_GET`. + :rtupe: bool + :returns: XXX + """ + challenge, response = self.extractClientSolution(request) + clientIP = self.getClientIP(request) + remoteIP = self.getRemoteIP() + solution = recaptcha.submit(challenge, response, + self.recaptchaPrivKey, remoteIP) + logging.debug("Captcha from %r. Parameters: %r" + % (Util.logSafely(clientIP), request.args)) + + if solution.is_valid: + logging.info("Valid CAPTCHA solution from %r." + % Util.logSafely(clientIP)) + return True + else: + logging.info("Invalid CAPTCHA solution from %r: %r" + % (Util.logSafely(clientIP), solution.error_code)) + return False + + def render_GET(self, request): + """Retrieve a ReCaptcha from the API server and serve it to the client. + + :type request: :api:`twisted.web.http.Request` + :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. + """ + return CaptchaProtectedResource.render_GET(self, request) + + def render_POST(self, request): + """Process a client's CAPTCHA solution. + + If the client's CAPTCHA solution is valid (according to + :meth:`checkSolution`), process and serve their original + 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`. + :rtype: str + :returns: A rendered HTML page containing a ReCaptcha challenge image + for the client to solve. + """ + 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 diff --git a/lib/bridgedb/templates/captcha.html b/lib/bridgedb/templates/captcha.html index dcb8adb..a670072 100644 --- a/lib/bridgedb/templates/captcha.html +++ b/lib/bridgedb/templates/captcha.html @@ -1,14 +1,16 @@ -## -*- coding: utf-8 -*- +## -*- coding: utf-8 -*- <%inherit file="base.html"/> <div class="captcha"> <form action="" method="POST"> - <input type="hidden" name="recaptcha_challenge_field" - id="recaptcha_challenge_field" value="${challenge_field}"> - <img width="300" height="57" alt="${_('Upgrade your browser to Firefox')}" src="${imgstr}"> - <div class="recaptcha_input_area"> - <label for="recaptcha_response_field">${_("Type the two words")}</label></div> - <input name="recaptcha_response_field" id="recaptcha_response_field" - type="text" autocomplete="off"> + <input type="hidden" name="captcha_challenge_field" + id="captcha_challenge_field" value="${challenge_field}"> + <img width="300" height="57" + alt="${_('Your browser is not displaying images properly.')}" + src="${imgstr}"> + <div class="captcha_input_area"> + <label for="captcha_response_field">${_("Type the two words")}</label></div> + <input name="captcha_response_field" id="captcha_response_field" + type="text" autocomplete="off"> <input class="btn btn-success" type="submit" name="submit" value="I am human"> </form> </div>

1 0

[bridgedb/master] Rename lib/bridgedb/Raptcha.py → lib/bridgedb/captcha.py.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 4709c1536a18cfe629ea196cb9eccdc2ddf92d79 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Feb 27 21:56:36 2014 +0000 Rename lib/bridgedb/Raptcha.py → lib/bridgedb/captcha.py. * CHANGE imports of ``recaptcha.client.captcha`` to ``from recaptcha.client import captcha as recaptcha``, to avoid name conflict. * Update Sphinx source configuration and build files to reflect module name change. --- doc/sphinx/source/bridgedb.Raptcha.rst | 4 +-- doc/sphinx/source/bridgedb.rst | 2 +- doc/sphinx/source/conf.py | 2 +- lib/bridgedb/HTTPServer.py | 6 ++-- lib/bridgedb/Raptcha.py | 51 ------------------------------- lib/bridgedb/captcha.py | 52 ++++++++++++++++++++++++++++++++ 6 files changed, 59 insertions(+), 58 deletions(-) diff --git a/doc/sphinx/source/bridgedb.Raptcha.rst b/doc/sphinx/source/bridgedb.Raptcha.rst index 374286f..633fa61 100644 --- a/doc/sphinx/source/bridgedb.Raptcha.rst +++ b/doc/sphinx/source/bridgedb.Raptcha.rst @@ -1,7 +1,7 @@ -bridgedb.Raptcha +bridgedb.captcha ---------------- -.. automodule:: bridgedb.Raptcha +.. automodule:: bridgedb.captcha :members: :undoc-members: :private-members: diff --git a/doc/sphinx/source/bridgedb.rst b/doc/sphinx/source/bridgedb.rst index afb7a0c..38dc9a2 100644 --- a/doc/sphinx/source/bridgedb.rst +++ b/doc/sphinx/source/bridgedb.rst @@ -7,6 +7,7 @@ bridgedb bridgedb.Bridges bridgedb.Bucket + bridgedb.captcha bridgedb.crypto bridgedb.Dist bridgedb.EmailServer @@ -16,7 +17,6 @@ bridgedb bridgedb.Main bridgedb.parse bridgedb.persistent - bridgedb.Raptcha bridgedb.runner bridgedb.Stability bridgedb.Storage diff --git a/doc/sphinx/source/conf.py b/doc/sphinx/source/conf.py index eab7673..de44db4 100644 --- a/doc/sphinx/source/conf.py +++ b/doc/sphinx/source/conf.py @@ -27,6 +27,7 @@ sys.path.insert(0, os.path.abspath(os.path.join( import bridgedb +import bridgedb.captcha import bridgedb.Bridges import bridgedb.Bucket import bridgedb.crypto @@ -37,7 +38,6 @@ import bridgedb.HTTPServer import bridgedb.I18n import bridgedb.Main import bridgedb.persistent -import bridgedb.Raptcha import bridgedb.runner import bridgedb.Stability import bridgedb.Storage diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index b679ff5..175fd24 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -26,8 +26,8 @@ import bridgedb.Dist import bridgedb.I18n as I18n import bridgedb.Util as Util -from recaptcha.client import captcha -from bridgedb.Raptcha import Raptcha +from recaptcha.client import captcha as recaptcha +from bridgedb.captcha import Raptcha from bridgedb.Filters import filterBridgesByIP6, filterBridgesByIP4 from bridgedb.Filters import filterBridgesByTransport from bridgedb.Filters import filterBridgesByNotBlockedIn @@ -191,7 +191,7 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): remote_ip = '%d.%d.%d.%d' % (randint(1,255),randint(1,255), randint(1,255),randint(1,255)) - recaptcha_response = captcha.submit(challenge, response, + recaptcha_response = recaptcha.submit(challenge, response, self.recaptchaPrivKey, remote_ip) logging.debug("Captcha from client with masked IP %r. Parameters:\n%r" % (remote_ip, request.args)) diff --git a/lib/bridgedb/Raptcha.py b/lib/bridgedb/Raptcha.py deleted file mode 100644 index 9a35b08..0000000 --- a/lib/bridgedb/Raptcha.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- encoding: utf-8 -*- -#_____________________________________________________________________________ -# -# This file is part of BridgeDB, a Tor bridge distribution system. -# -# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> -# Aaron Gibson 0x2C4B239DD876C9F6 <aagbsn(a)torproject.org> -# Nick Mathewson 0x21194EBB165733EA <nickm(a)torproject.org> -# please also see AUTHORS file -# :copyright: (c) 2007-2014, The Tor Project, Inc. -# (c) 2007-2014, all entities within the AUTHORS file -# (c) 2014, Isis Lovecruft -# :license: see LICENSE for licensing information -#_____________________________________________________________________________ - -""" -This module wraps the recaptcha api and proxies requests to protect privacy. -""" -import recaptcha.client.captcha as captcha -from BeautifulSoup import BeautifulSoup -import urllib2 - -class Raptcha(): - """ A recaptcha captcha and method to request them """ - - def __init__(self, pubkey=None, privkey=None): - self.pubkey = pubkey - self.privkey = privkey - self.image = None - self.challenge = None - - def get(self): - """ gets a fresh captcha """ - - if (self.pubkey == '') or (self.privkey == ''): - raise RaptchaKeyError - urlbase = captcha.API_SERVER - form = "/noscript?k=%s" % self.pubkey - - # extract and store image from captcha - html = urllib2.urlopen(urlbase+form).read() - soup = BeautifulSoup(html) - imgurl = urlbase+"/"+ soup.find('img')['src'] - self.challenge = str(soup.find('input', {'name' : 'recaptcha_challenge_field'})['value']) - self.image = urllib2.urlopen(imgurl).read() - -class RaptchaKeyError(Exception): - """ Exception raised when recaptcha API keys are not supplied""" - def __init__(self): - msg = 'You must supply recaptcha API keys' - Exception.__init__(self, msg) diff --git a/lib/bridgedb/captcha.py b/lib/bridgedb/captcha.py new file mode 100644 index 0000000..9936343 --- /dev/null +++ b/lib/bridgedb/captcha.py @@ -0,0 +1,52 @@ +# -*- encoding: utf-8 -*- +#_____________________________________________________________________________ +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# Aaron Gibson 0x2C4B239DD876C9F6 <aagbsn(a)torproject.org> +# Nick Mathewson 0x21194EBB165733EA <nickm(a)torproject.org> +# please also see AUTHORS file +# :copyright: (c) 2007-2014, The Tor Project, Inc. +# (c) 2007-2014, all entities within the AUTHORS file +# (c) 2014, Isis Lovecruft +# :license: see LICENSE for licensing information +#_____________________________________________________________________________ + +""" +This module wraps the recaptcha api and proxies requests to protect privacy. +""" + +from recaptcha.client import captcha as recaptcha +from BeautifulSoup import BeautifulSoup +import urllib2 + +class Raptcha(): + """ A recaptcha captcha and method to request them """ + + def __init__(self, pubkey=None, privkey=None): + self.pubkey = pubkey + self.privkey = privkey + self.image = None + self.challenge = None + + def get(self): + """ gets a fresh captcha """ + + if (self.pubkey == '') or (self.privkey == ''): + raise RaptchaKeyError + urlbase = recaptcha.API_SERVER + form = "/noscript?k=%s" % self.pubkey + + # extract and store image from captcha + html = urllib2.urlopen(urlbase+form).read() + soup = BeautifulSoup(html) + imgurl = urlbase+"/"+ soup.find('img')['src'] + self.challenge = str(soup.find('input', {'name' : 'recaptcha_challenge_field'})['value']) + self.image = urllib2.urlopen(imgurl).read() + +class RaptchaKeyError(Exception): + """ Exception raised when recaptcha API keys are not supplied""" + def __init__(self): + msg = 'You must supply recaptcha API keys' + Exception.__init__(self, msg)

1 0

[bridgedb/master] Rename reCaptcha classes.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit 1cadbf4de48d827e094d905065c197a4ca1184ab Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Feb 28 02:47:33 2014 +0000 Rename reCaptcha classes. * RENAME captcha.Raptcha → captcha.ReCaptcha * RENAME captcha.RaptchaKeyError → captcha.ReCaptchaKeyError --- lib/bridgedb/HTTPServer.py | 4 ++-- lib/bridgedb/captcha.py | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 175fd24..2d5fd72 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -27,7 +27,7 @@ import bridgedb.I18n as I18n import bridgedb.Util as Util from recaptcha.client import captcha as recaptcha -from bridgedb.captcha import Raptcha +from bridgedb.captcha import ReCaptcha from bridgedb.Filters import filterBridgesByIP6, filterBridgesByIP4 from bridgedb.Filters import filterBridgesByTransport from bridgedb.Filters import filterBridgesByNotBlockedIn @@ -144,7 +144,7 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): :returns: A rendered HTML page containing a ReCaptcha challenge image for the client to solve. """ - c = Raptcha(self.recaptchaPubKey, self.recaptchaPrivKey) + c = ReCaptcha(self.recaptchaPubKey, self.recaptchaPrivKey) try: c.get() diff --git a/lib/bridgedb/captcha.py b/lib/bridgedb/captcha.py index 0d3bf35..430643c 100644 --- a/lib/bridgedb/captcha.py +++ b/lib/bridgedb/captcha.py @@ -19,8 +19,8 @@ .. captcha - |_RaptchaKeyError - \_Raptcha - Class for obtaining reCaptcha images and challenge strings + |_ReCaptchaKeyError + \_ReCaptcha - Class for obtaining reCaptcha images and challenge strings .. There are two types of CAPTCHAs which BridgeDB knows how to serve: those @@ -38,7 +38,7 @@ from BeautifulSoup import BeautifulSoup from recaptcha.client import captcha as recaptcha -class Raptcha(object): +class ReCaptcha(object): """ A recaptcha captcha and method to request them """ def __init__(self, pubkey=None, privkey=None): @@ -51,7 +51,7 @@ class Raptcha(object): """ gets a fresh captcha """ if (self.pubkey == '') or (self.privkey == ''): - raise RaptchaKeyError + raise ReCaptchaKeyError urlbase = recaptcha.API_SERVER form = "/noscript?k=%s" % self.pubkey @@ -62,7 +62,7 @@ class Raptcha(object): self.challenge = str(soup.find('input', {'name' : 'recaptcha_challenge_field'})['value']) self.image = urllib2.urlopen(imgurl).read() -class RaptchaKeyError(Exception): +class ReCaptchaKeyError(Exception): """ Exception raised when recaptcha API keys are not supplied""" def __init__(self): msg = 'You must supply recaptcha API keys'

1 0

[bridgedb/master] Add bridgedb.captcha.GimpCaptcha implementation.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit f387a0a4d4bc5eeba6d0d8c965ebe35959ff5ce7 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Mar 4 08:28:51 2014 +0000 Add bridgedb.captcha.GimpCaptcha implementation. * ADD GimpCaptcha class, which handles retrieving cached CAPTCHAs from a local directory, creating challenge strings from the CAPTCHA answers, and later checking a client's proposed solution against the challenge. * FIXES #10809. --- lib/bridgedb/captcha.py | 74 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/lib/bridgedb/captcha.py b/lib/bridgedb/captcha.py index 07b06d4..a76303f 100644 --- a/lib/bridgedb/captcha.py +++ b/lib/bridgedb/captcha.py @@ -32,6 +32,10 @@ gimp-captcha_ and then cached locally. .. _gimp-captcha: https://github.com/isislovecruft/gimp-captcha """ +import hashlib +import logging +import random +import os import urllib2 from BeautifulSoup import BeautifulSoup @@ -46,6 +50,9 @@ class ReCaptchaKeyError(Exception): msg = 'You must supply recaptcha API keys' Exception.__init__(self, msg) +class GimpCaptchaError(Exception): + """General exception raised when a Gimp CAPTCHA cannot be retrieved.""" + class ICaptcha(Interface): """Interface specification for CAPTCHAs.""" image = Attribute("A CAPTCHA image.") @@ -64,6 +71,7 @@ class Captcha(object): def get(self): return self.image + class ReCaptcha(Captcha): """A reCaptcha CAPTCHA.""" @@ -94,3 +102,69 @@ class ReCaptcha(Captcha): self.challenge = str(soup.find('input', {'name' : 'recaptcha_challenge_field'})['value']) self.image = urllib2.urlopen(imgurl).read() + +class GimpCaptcha(Captcha): + """A cached CAPTCHA image which was created with Gimp.""" + + def __init__(self, cacheDir=None, clientIP=None): + """Create a ``GimpCaptcha`` which retrieves images from **cacheDir**. + + :raises GimpCaptchaError: if **cacheDir** is not a directory. + """ + if not os.path.isdir(cacheDir): + raise GimpCaptchaError("Gimp captcha cache isn't a directory: %r" + % cacheDir) + + self.image = None + self.challenge = None + self.cacheDir = cacheDir + self.clientIP = clientIP + super(GimpCaptcha, self).__init__() + + @classmethod + def check(cls, challenge, answer, clientIP=None): + """Check a client's CAPTCHA solution against the **challenge**. + + :rtype: bool + :returns: True if the CAPTCHA solution was correct. + """ + logging.debug("Checking CAPTCHA solution %r against challenge %r" + % (answer, challenge)) + solution = cls.createChallenge(answer, clientIP) + if (not challenge) or (challenge != solution): + return False + return True + + @classmethod + def createChallenge(cls, answer, clientIP=None): + """Hash a CAPTCHA answer together with a **clientIP**, if given. + + :param str answer: The answer (either actual, or a client's proposed + solution) to a CAPTCHA. + :param str clientIP: The client's IP address. + """ + challenge = '\n'.join([answer, str(clientIP)]) + return hashlib.sha256(challenge).hexdigest() + + def get(self): + """Get a random CAPTCHA from the cache directory. + + :raises GimpCaptchaError: if the chosen CAPTCHA image file could not + be read. + :returns: A 2-tuple of ``(captcha, None)``, where ``captcha`` is the + image file contents. + """ + imageFilename = random.choice(os.listdir(self.cacheDir)) + imagePath = os.path.join(self.cacheDir, imageFilename) + + try: + with open(imagePath) as imageFile: + self.image = imageFile.read() + except (OSError, IOError) as err: + raise GimpCaptchaError("Could not read Gimp captcha image file: %r" + % imageFilename) + + captchaAnswer = imageFilename.rsplit(os.path.extsep, 1)[0] + self.challenge = self.createChallenge(captchaAnswer, self.clientIP) + + return (self.image, self.challenge)

1 0

[bridgedb/master] Make a log message in CaptchaProtectedResource more general.
by isis＠torproject.org 16 Mar '14

16 Mar '14

commit a16b663ae13482ad144edf5f44ae8f84d62d2754 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Mar 4 08:27:32 2014 +0000 Make a log message in CaptchaProtectedResource more general. --- 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 ae14f62..5a9d5a3 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -220,7 +220,7 @@ class CaptchaProtectedResource(twisted.web.resource.Resource): rendered = replaceErrorPage(err) return rendered - logging.debug("Client failed a recaptcha; returning redirect to %s" + logging.debug("Client failed a CAPTCHA; returning redirect to %s" % request.uri) return redirectTo(request.uri, request)

1 0

[stem/master] Don't cite features as coming in '1.1.0-dev'
by atagar＠torproject.org 16 Mar '14

16 Mar '14

commit fe88fa7dce85741f0e42bba33d5b24b2892cdd65 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Mar 16 10:41:40 2014 -0700 Don't cite features as coming in '1.1.0-dev' I've been inconsistent when mentioning when features are introduced. Sometimes I say '1.1.0-dev' while elsewhere I say '1.2.0'. The theory on the former was that the '-dev' suffix would mean 'unreleased things'. However, we know what the next version is gonna be so we might as well just say that. --- stem/response/events.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/stem/response/events.py b/stem/response/events.py index 082ecb1..234cfde 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -709,7 +709,7 @@ class ORConnEvent(Event): introduced in tor version 0.1.1.1-alpha. Its id attribute was added in version 0.2.5.2-alpha. - .. versionchanged:: 1.1.0-dev + .. versionchanged:: 1.2.0 Added the id attribute. :var str id: connection identifier @@ -967,7 +967,7 @@ class ConnectionBandwidthEvent(Event): The CONN_BW event was introduced in tor version 0.2.5.2-alpha. - .. versionadded:: 1.1.0-dev + .. versionadded:: 1.2.0 :var str id: connection identifier :var stem.ConnectionType type: connection type @@ -1011,7 +1011,7 @@ class CircuitBandwidthEvent(Event): The CIRC_BW event was introduced in tor version 0.2.5.2-alpha. - .. versionadded:: 1.1.0-dev + .. versionadded:: 1.2.0 :var str id: circuit identifier :var long read: bytes received by tor that second @@ -1050,7 +1050,7 @@ class CellStatsEvent(Event): The CELL_STATS event was introduced in tor version 0.2.5.2-alpha. - .. versionadded:: 1.1.0-dev + .. versionadded:: 1.2.0 :var str id: circuit identifier :var str inbound_queue: inbound queue identifier @@ -1108,7 +1108,7 @@ class TokenBucketEmptyEvent(Event): The TB_EMPTY event was introduced in tor version 0.2.5.2-alpha. - .. versionadded:: 1.1.0-dev + .. versionadded:: 1.2.0 :var stem.TokenBucket bucket: bucket being refilled :var str id: connection identifier

1 0

[stem/master] Noting when HS_DESC support was added
by atagar＠torproject.org 16 Mar '14

16 Mar '14

commit 9aadf0e989b8ecaa41628ddd8ce8edc099539ec4 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Mar 16 11:12:57 2014 -0700 Noting when HS_DESC support was added Oops, forgot to note when we added HS_DESC event support. Spotted by wfn. --- docs/change_log.rst | 1 + stem/response/events.py | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/change_log.rst b/docs/change_log.rst index dc43e4f..5e82005 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -48,6 +48,7 @@ The following are only available within stem's `git repository * Added `support for CIRC_BW events <api/response.html#stem.response.events.CircuitBandwidthEvent>`_ (:spec:`6f2919a`) * Added `support for CELL_STATS events <api/response.html#stem.response.events.CellStatsEvent>`_ (:spec:`6f2919a`) * Added `support for TB_EMPTY events <api/response.html#stem.response.events.TokenBucketEmptyEvent>`_ (:spec:`6f2919a`) + * Added `support for HS_DESC events <api/response.html#stem.response.events.HSDescEvent>`_ (:spec:`a67ac4d`, :trac:`10807`) * **Utilities** diff --git a/stem/response/events.py b/stem/response/events.py index 234cfde..b0bebfb 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -576,6 +576,8 @@ class HSDescEvent(Event): The HS_DESC event was introduced in tor version 0.2.5.2-alpha. + .. versionadded:: 1.2.0 + :var stem.HSDescAction action: what is happening with the descriptor :var str address: hidden service address :var stem.HSAuth authentication: service's authentication method

1 0

[arm/master] Dropping excess header docs
by atagar＠torproject.org 16 Mar '14

16 Mar '14

commit 1aa58b91a221a999a2cac478e24e5cfeb5af92bc Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Mar 12 08:11:14 2014 -0700 Dropping excess header docs The header panel's docs gave examples of what the panel looks like. Interesting thing to include, but both easily gets out of date an not that useful since I'm running an arm instance for development anyway. --- arm/header_panel.py | 32 +++++--------------------------- 1 file changed, 5 insertions(+), 27 deletions(-) diff --git a/arm/header_panel.py b/arm/header_panel.py index f9573b3..0c7e669 100644 --- a/arm/header_panel.py +++ b/arm/header_panel.py @@ -1,17 +1,7 @@ """ Top panel for every page, containing basic system and tor related information. -If there's room available then this expands to present its information in two -columns, otherwise it's laid out as follows: - arm - <hostname> (<os> <sys/version>) Tor <tor/version> (<new, old, recommended, etc>) - <nickname> - <address>:<or_port>, [Dir Port: <dir_port>, ]Control Port (<open, password, cookie>): <control_port> - cpu: <cpu%> mem: <mem> (<mem%>) uid: <uid> uptime: <upmin>:<upsec> - fingerprint: <fingerprint> - -Example: - arm - odin (Linux 2.6.24-24-generic) Tor 0.2.1.19 (recommended) - odin - 76.104.132.98:9001, Dir Port: 9030, Control Port (cookie): 9051 - cpu: 14.6% mem: 42 MB (4.2%) pid: 20060 uptime: 48:27 - fingerprint: BDAD31F6F318E0413833E8EBDA956F76E4D66788 +This expands the information it presents to two columns if there's room +available. """ import os @@ -32,10 +22,7 @@ import arm.controller from util import panel, ui_tools, tor_controller -# minimum width for which panel attempts to double up contents (two columns to -# better use screen real estate) - -MIN_DUAL_COL_WIDTH = 141 +MIN_DUAL_COL_WIDTH = 141 # minimum width where we'll show two columns CONFIG = conf.config_dict('arm', { 'attr.flag_colors': {}, @@ -78,20 +65,11 @@ Sampling = collections.namedtuple('Sampling', [ class HeaderPanel(panel.Panel, threading.Thread): """ - Top area contenting tor settings and system information. Stats are stored in - the vals mapping, keys including: - tor/ version, versionStatus, nickname, or_port, dir_port, control_port, - socketPath, exit_policy, isAuthPassword (bool), isAuthCookie (bool), - orListenAddr, *address, *fingerprint, *flags, pid, start_time, - *fd_used, fd_limit - sys/ hostname, os, version - stat/ *%torCpu, *%armCpu, *rss, *%mem - - * volatile parameter that'll be reset on each update + Top area containing tor settings and system information. """ def __init__(self, stdscr, start_time): - panel.Panel.__init__(self, stdscr, "header", 0) + panel.Panel.__init__(self, stdscr, 'header', 0) threading.Thread.__init__(self) self.setDaemon(True)

1 0

[arm/master] Changing header samplings to a named tuple
by atagar＠torproject.org 16 Mar '14

16 Mar '14

commit 0b7c951d014c95d691eae9a1aa2dab1904361eaf Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 8 15:54:11 2014 -0800 Changing header samplings to a named tuple Swapping from a dict to named tuple for the header panel's samplings. This makes usage a little nice, and makes errors from removed or renamed attributes more obvious. --- arm/header_panel.py | 179 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 108 insertions(+), 71 deletions(-) diff --git a/arm/header_panel.py b/arm/header_panel.py index dcdbeda..f9573b3 100644 --- a/arm/header_panel.py +++ b/arm/header_panel.py @@ -16,6 +16,7 @@ Example: import os import time +import collections import curses import threading @@ -42,6 +43,38 @@ CONFIG = conf.config_dict('arm', { 'features.showFdUsage': False, }) +Sampling = collections.namedtuple('Sampling', [ + 'address', + 'fingerprint', + 'nickname', + 'or_address', + 'or_port', + 'dir_port', + + 'control_port', + 'socket_path', + 'is_password_auth', + 'is_cookie_auth', + + 'exit_policy', + 'flags', + 'version', + 'version_status', + + 'pid', + 'start_time', + 'fd_limit', + 'fd_used', + + 'tor_cpu', + 'arm_cpu', + 'rss', + 'memory', + 'hostname', + 'os_name', + 'os_version', +]) + class HeaderPanel(panel.Panel, threading.Thread): """ @@ -114,7 +147,7 @@ class HeaderPanel(panel.Panel, threading.Thread): is_wide = self.get_parent().getmaxyx()[1] >= MIN_DUAL_COL_WIDTH - if self.vals["tor/or_port"]: + if self.vals.or_port: return 4 if is_wide else 6 else: return 3 if is_wide else 4 @@ -201,11 +234,11 @@ class HeaderPanel(panel.Panel, threading.Thread): # Line 1 / Line 1 Left (system and tor version information) - sys_name_label = "arm - %s" % self.vals["sys/hostname"] + sys_name_label = "arm - %s" % self.vals.hostname content_space = min(left_width, 40) if len(sys_name_label) + 10 <= content_space: - sys_type_label = "%s %s" % (self.vals["sys/os"], self.vals["sys/version"]) + sys_type_label = "%s %s" % (self.vals.os_name, self.vals.os_version) sys_type_label = ui_tools.crop_str(sys_type_label, content_space - len(sys_name_label) - 3, 4) self.addstr(0, 0, "%s (%s)" % (sys_name_label, sys_type_label)) else: @@ -213,34 +246,34 @@ class HeaderPanel(panel.Panel, threading.Thread): content_space = left_width - 43 - if 7 + len(self.vals["tor/version"]) + len(self.vals["tor/versionStatus"]) <= content_space: - if self.vals["tor/version"] != "Unknown": - version_color = CONFIG['attr.version_status_colors'].get(self.vals["tor/versionStatus"], 'white') + if 7 + len(self.vals.version) + len(self.vals.version_status) <= content_space: + if self.vals.version != "Unknown": + version_color = CONFIG['attr.version_status_colors'].get(self.vals.version_status, 'white') - label_prefix = "Tor %s (" % self.vals["tor/version"] + label_prefix = "Tor %s (" % self.vals.version self.addstr(0, 43, label_prefix) - self.addstr(0, 43 + len(label_prefix), self.vals["tor/versionStatus"], ui_tools.get_color(version_color)) - self.addstr(0, 43 + len(label_prefix) + len(self.vals["tor/versionStatus"]), ")") + self.addstr(0, 43 + len(label_prefix), self.vals.version_status, ui_tools.get_color(version_color)) + self.addstr(0, 43 + len(label_prefix) + len(self.vals.version_status), ")") elif 11 <= content_space: - self.addstr(0, 43, ui_tools.crop_str("Tor %s" % self.vals["tor/version"], content_space, 4)) + self.addstr(0, 43, ui_tools.crop_str("Tor %s" % self.vals.version, content_space, 4)) # Line 2 / Line 2 Left (tor ip/port information) x, include_control_port = 0, True - if self.vals["tor/or_port"]: + if self.vals.or_port: my_address = "Unknown" - if self.vals["tor/orListenAddr"]: - my_address = self.vals["tor/orListenAddr"] - elif self.vals["tor/address"]: - my_address = self.vals["tor/address"] + if self.vals.or_address: + my_address = self.vals.or_address + elif self.vals.address: + my_address = self.vals.address # acting as a relay (we can assume certain parameters are set - dir_port_label = ", Dir Port: %s" % self.vals["tor/dir_port"] if self.vals["tor/dir_port"] != "0" else "" + dir_port_label = ", Dir Port: %s" % self.vals.dir_port if self.vals.dir_port != "0" else "" - for label in (self.vals["tor/nickname"], " - " + my_address, ":" + self.vals["tor/or_port"], dir_port_label): + for label in (self.vals.nickname, " - " + my_address, ":" + self.vals.or_port, dir_port_label): if x + len(label) <= left_width: self.addstr(1, x, label) x += len(label) @@ -266,46 +299,46 @@ class HeaderPanel(panel.Panel, threading.Thread): include_control_port = False if include_control_port: - if self.vals["tor/control_port"] == "0": + if self.vals.control_port == "0": # connected via a control socket - self.addstr(1, x, ", Control Socket: %s" % self.vals["tor/socketPath"]) + self.addstr(1, x, ", Control Socket: %s" % self.vals.socket_path) else: - if self.vals["tor/isAuthPassword"]: + if self.vals.is_password_auth: auth_type = "password" - elif self.vals["tor/isAuthCookie"]: + elif self.vals.is_cookie_auth: auth_type = "cookie" else: auth_type = "open" - if x + 19 + len(self.vals["tor/control_port"]) + len(auth_type) <= left_width: + if x + 19 + len(self.vals.control_port) + len(auth_type) <= left_width: auth_color = "red" if auth_type == "open" else "green" self.addstr(1, x, ", Control Port (") self.addstr(1, x + 16, auth_type, ui_tools.get_color(auth_color)) - self.addstr(1, x + 16 + len(auth_type), "): %s" % self.vals["tor/control_port"]) - elif x + 16 + len(self.vals["tor/control_port"]) <= left_width: - self.addstr(1, 0, ", Control Port: %s" % self.vals["tor/control_port"]) + self.addstr(1, x + 16 + len(auth_type), "): %s" % self.vals.control_port) + elif x + 16 + len(self.vals.control_port) <= left_width: + self.addstr(1, 0, ", Control Port: %s" % self.vals.control_port) # Line 3 / Line 1 Right (system usage info) y, x = (0, left_width) if is_wide else (2, 0) - if self.vals["stat/rss"] != "0": - memory_label = str_tools.get_size_label(int(self.vals["stat/rss"])) + if self.vals.rss != "0": + memory_label = str_tools.get_size_label(int(self.vals.rss)) else: memory_label = "0" uptime_label = "" - if self.vals["tor/start_time"]: + if self.vals.start_time: if self.is_paused() or not self._is_tor_connected: # freeze the uptime when paused or the tor process is stopped - uptime_label = str_tools.get_short_time_label(self.get_pause_time() - self.vals["tor/start_time"]) + uptime_label = str_tools.get_short_time_label(self.get_pause_time() - self.vals.start_time) else: - uptime_label = str_tools.get_short_time_label(time.time() - self.vals["tor/start_time"]) + uptime_label = str_tools.get_short_time_label(time.time() - self.vals.start_time) - sys_fields = ((0, "cpu: %s%% tor, %s%% arm" % (self.vals["stat/%torCpu"], self.vals["stat/%armCpu"])), - (27, "mem: %s (%s%%)" % (memory_label, self.vals["stat/%mem"])), - (47, "pid: %s" % (self.vals["tor/pid"] if self._is_tor_connected else "")), + sys_fields = ((0, "cpu: %s%% tor, %s%% arm" % (self.vals.tor_cpu, self.vals.arm_cpu)), + (27, "mem: %s (%s%%)" % (memory_label, self.vals.memory)), + (47, "pid: %s" % (self.vals.pid if self._is_tor_connected else "")), (59, "uptime: %s" % uptime_label)) for (start, label) in sys_fields: @@ -314,22 +347,22 @@ class HeaderPanel(panel.Panel, threading.Thread): else: break - if self.vals["tor/or_port"]: + if self.vals.or_port: # Line 4 / Line 2 Right (fingerprint, and possibly file descriptor usage) y, x = (1, left_width) if is_wide else (3, 0) - fingerprint_label = ui_tools.crop_str("fingerprint: %s" % self.vals["tor/fingerprint"], width) + fingerprint_label = ui_tools.crop_str("fingerprint: %s" % self.vals.fingerprint, width) self.addstr(y, x, fingerprint_label) # if there's room and we're able to retrieve both the file descriptor # usage and limit then it might be presented - if width - x - 59 >= 20 and self.vals["tor/fd_used"] and self.vals["tor/fd_limit"]: + if width - x - 59 >= 20 and self.vals.fd_used and self.vals.fd_limit: # display file descriptor usage if we're either configured to do so or # running out - fd_percent = 100 * self.vals["tor/fd_used"] / self.vals["tor/fd_limit"] + fd_percent = 100 * self.vals.fd_used / self.vals.fd_limit if fd_percent >= 60 or CONFIG["features.showFdUsage"]: fd_percentLabel, fd_percent_format = "%i%%" % fd_percent, curses.A_NORMAL @@ -341,7 +374,7 @@ class HeaderPanel(panel.Panel, threading.Thread): elif fd_percent >= 60: fd_percent_format = ui_tools.get_color("yellow") - base_label = "file desc: %i / %i (" % (self.vals["tor/fd_used"], self.vals["tor/fd_limit"]) + base_label = "file desc: %i / %i (" % (self.vals.fd_used, self.vals.fd_limit) self.addstr(y, x + 59, base_label) self.addstr(y, x + 59 + len(base_label), fd_percentLabel, fd_percent_format) @@ -354,15 +387,15 @@ class HeaderPanel(panel.Panel, threading.Thread): self.addstr(y, x, "flags: ") x += 7 - if len(self.vals["tor/flags"]) > 0: - for i in range(len(self.vals["tor/flags"])): - flag = self.vals["tor/flags"][i] + if len(self.vals.flags) > 0: + for i in range(len(self.vals.flags)): + flag = self.vals.flags[i] flag_color = CONFIG['attr.flag_colors'].get(flag, 'white') self.addstr(y, x, flag, curses.A_BOLD | ui_tools.get_color(flag_color)) x += len(flag) - if i < len(self.vals["tor/flags"]) - 1: + if i < len(self.vals.flags) - 1: self.addstr(y, x, ", ") x += 2 else: @@ -377,7 +410,7 @@ class HeaderPanel(panel.Panel, threading.Thread): # Undisplayed / Line 3 Right (exit policy) if is_wide: - exit_policy = self.vals["tor/exit_policy"] + exit_policy = self.vals.exit_policy # adds note when default exit policy is appended @@ -467,7 +500,7 @@ class HeaderPanel(panel.Panel, threading.Thread): is_changed = False - if self.vals["tor/pid"]: + if self.vals.pid: resource_tracker = arm.util.tracker.get_resource_tracker() is_changed = self._last_resource_fetch != resource_tracker.run_counter() @@ -604,33 +637,37 @@ class HeaderPanel(panel.Panel, threading.Thread): self._last_update = current_time - return { - 'tor/address': controller.get_info('address', ''), - 'tor/fingerprint': controller.get_info('fingerprint', 'Unknown'), - 'tor/version': str(controller.get_version('Unknown')).split()[0], - 'tor/versionStatus': controller.get_info('status/version/current', 'Unknown'), - 'tor/nickname': controller.get_conf('Nickname', ''), - 'tor/orListenAddr': or_address, - 'tor/or_port': or_port, - 'tor/exit_policy': str(controller.get_exit_policy), - 'tor/flags': flags, - 'tor/dir_port': controller.get_conf('DirPort', '0'), - 'tor/control_port': controller.get_conf('ControlPort', '0'), - 'tor/socketPath': controller.get_conf('ControlSocket', ''), - 'tor/isAuthPassword': controller.get_conf('HashedControlPassword', None) is not None, - 'tor/isAuthCookie': controller.get_conf('CookieAuthentication', None) == '1', - 'tor/fd_limit': fd_limit, - 'tor/fd_used': fd_used, - 'tor/pid': controller.get_pid(''), - 'tor/start_time': start_time if start_time else '', - 'stat/%torCpu': tor_cpu, - 'stat/%armCpu': arm_cpu, - 'stat/rss': tor_rss, - 'stat/%mem': tor_memory, - 'sys/hostname': uname_vals[1], - 'sys/os': uname_vals[0], - 'sys/version': uname_vals[2], - } + return Sampling( + address = controller.get_info('address', ''), + fingerprint = controller.get_info('fingerprint', 'Unknown'), + nickname = controller.get_conf('Nickname', ''), + or_address = or_address, + or_port = or_port, + dir_port = controller.get_conf('DirPort', '0'), + + control_port = controller.get_conf('ControlPort', '0'), + socket_path = controller.get_conf('ControlSocket', ''), + is_password_auth = controller.get_conf('HashedControlPassword', None) is not None, + is_cookie_auth = controller.get_conf('CookieAuthentication', None) == '1', + + exit_policy = str(controller.get_exit_policy()), + flags = flags, + version = str(controller.get_version('Unknown')).split()[0], + version_status = controller.get_info('status/version/current', 'Unknown'), + + pid = controller.get_pid(''), + start_time = start_time if start_time else '', + fd_limit = fd_limit, + fd_used = fd_used, + + tor_cpu = tor_cpu, + arm_cpu = arm_cpu, + rss = tor_rss, + memory = tor_memory, + hostname = uname_vals[1], + os_name = uname_vals[0], + os_version = uname_vals[2], + ) def get_file_descriptor_usage(pid):

1 0

[arm/master] Revising header panel's method of fetching attributes
by atagar＠torproject.org 16 Mar '14

16 Mar '14

commit 02ca417cf0d2fab7c8f49bbfdb9cc0d41e8eb1d4 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 8 15:04:01 2014 -0800 Revising header panel's method of fetching attributes Rearranging and minor tweaks to the header panel's method for polling information. --- arm/connections/circ_entry.py | 2 +- arm/header_panel.py | 163 +++++++++++++++++------------------------ 2 files changed, 68 insertions(+), 97 deletions(-) diff --git a/arm/connections/circ_entry.py b/arm/connections/circ_entry.py index 4aa3fc8..7f9c47b 100644 --- a/arm/connections/circ_entry.py +++ b/arm/connections/circ_entry.py @@ -109,7 +109,7 @@ class CircHeaderLine(conn_entry.ConnectionLine): shown completely (not enough room) is dropped. """ - etc_attr = ["Purpose: %s" % self.purpose, "Circuit ID: %i" % self.circuit_id] + etc_attr = ["Purpose: %s" % self.purpose, "Circuit ID: %s" % self.circuit_id] for i in range(len(etc_attr), -1, -1): etc_label = ", ".join(etc_attr[:i]) diff --git a/arm/header_panel.py b/arm/header_panel.py index 2affaad..dcdbeda 100644 --- a/arm/header_panel.py +++ b/arm/header_panel.py @@ -22,7 +22,7 @@ import threading import arm.util.tracker from stem import Signal -from stem.control import State +from stem.control import Listener, State from stem.util import conf, log, proc, str_tools, system import arm.starter @@ -98,7 +98,9 @@ class HeaderPanel(panel.Panel, threading.Thread): self.vals = {} self.vals_lock = threading.RLock() - self._update() + + with self.vals_lock: + self.vals = self._get_attributes() # listens for tor reload (sighup) events @@ -470,7 +472,8 @@ class HeaderPanel(panel.Panel, threading.Thread): is_changed = self._last_resource_fetch != resource_tracker.run_counter() if is_changed or current_time - self._last_update >= 20: - self._update() + with self.vals_lock: + self.vals = self._get_attributes() self.redraw(True) last_draw += 1 @@ -494,7 +497,9 @@ class HeaderPanel(panel.Panel, threading.Thread): initial_height = self.get_height() self._is_tor_connected = True self._halt_time = None - self._update() + + with self.vals_lock: + self.vals = self._get_attributes() if self.get_height() != initial_height: # We're toggling between being a relay and client, causing the height @@ -508,57 +513,24 @@ class HeaderPanel(panel.Panel, threading.Thread): elif event_type == State.CLOSED: self._is_tor_connected = False self._halt_time = time.time() - self._update() - self.redraw(True) - - def _update(self): - """ - Updates stats in the vals mapping. By default this just revises volatile - attributes. - """ - self.vals_lock.acquire() - controller = tor_controller() + with self.vals_lock: + self.vals = self._get_attributes() - # version is truncated to first part, for instance: - # 0.2.2.13-alpha (git-feb8c1b5f67f2c6f) -> 0.2.2.13-alpha - - self.vals['tor/version'] = str(controller.get_version('Unknown')).split()[0] - self.vals['tor/versionStatus'] = controller.get_info('status/version/current', 'Unknown') - self.vals['tor/nickname'] = controller.get_conf('Nickname', '') - self.vals['tor/or_port'] = controller.get_conf('ORPort', '0') - self.vals['tor/dir_port'] = controller.get_conf('DirPort', '0') - self.vals['tor/control_port'] = controller.get_conf('ControlPort', '0') - self.vals['tor/socketPath'] = controller.get_conf('ControlSocket', '') - self.vals['tor/isAuthPassword'] = controller.get_conf('HashedControlPassword', None) is not None - self.vals['tor/isAuthCookie'] = controller.get_conf('CookieAuthentication', None) == '1' - - # orport is reported as zero if unset - - if self.vals['tor/or_port'] == '0': - self.vals['tor/or_port'] = '' - - # overwrite address if ORListenAddress is set (and possibly or_port too) - - self.vals['tor/orListenAddr'] = '' - listen_addr = controller.get_conf('ORListenAddress', None) - - if listen_addr: - if ':' in listen_addr: - # both ip and port overwritten - self.vals['tor/orListenAddr'] = listen_addr[:listen_addr.find(':')] - self.vals['tor/or_port'] = listen_addr[listen_addr.find(':') + 1:] - else: - self.vals['tor/orListenAddr'] = listen_addr + self.redraw(True) - # fetch exit policy (might span over multiple lines) + def _get_attributes(self): + controller = tor_controller() - policy_entries = [] + or_listeners = controller.get_listeners(Listener.OR, []) - for exit_policy in controller.get_conf('ExitPolicy', [], True): - policy_entries += [policy.strip() for policy in exit_policy.split(',')] + if not or_listeners: + or_address, or_port = '', '' + else: + # TODO: Relays can bind to multiple ports to listen for OR connections. + # Not sure how we'd like to surface that... - self.vals['tor/exit_policy'] = ', '.join(policy_entries) + or_address, or_port = or_listeners[0] # file descriptor limit for the process, if this can't be determined # then the limit is None @@ -566,66 +538,40 @@ class HeaderPanel(panel.Panel, threading.Thread): fd_limit = controller.get_info('process/descriptor-limit', '-1') if fd_limit != '-1' and fd_limit.isdigit(): - self.vals['tor/fd_limit'] = int(fd_limit) + fd_limit = int(fd_limit) else: - self.vals['tor/fd_limit'] = None - - # system information + fd_limit = None uname_vals = os.uname() - self.vals['sys/hostname'] = uname_vals[1] - self.vals['sys/os'] = uname_vals[0] - self.vals['sys/version'] = uname_vals[2] - - self.vals['tor/pid'] = controller.get_pid('') try: start_time = system.get_start_time(controller.get_pid()) except: start_time = None - self.vals['tor/start_time'] = start_time if start_time else '' - - # reverts volatile parameters to defaults - - self.vals['tor/fingerprint'] = 'Unknown' - self.vals['tor/flags'] = [] - self.vals['tor/fd_used'] = 0 - self.vals['stat/%torCpu'] = '0' - self.vals['stat/%armCpu'] = '0' - self.vals['stat/rss'] = '0' - self.vals['stat/%mem'] = '0' - - # sets volatile parameters - # TODO: This can change, being reported by STATUS_SERVER -> EXTERNAL_ADDRESS - # events. Introduce caching via tor_tools? - - self.vals['tor/address'] = controller.get_info('address', '') - - self.vals['tor/fingerprint'] = controller.get_info('fingerprint', self.vals['tor/fingerprint']) - + flags = [] my_fingerprint = controller.get_info('fingerprint', None) if my_fingerprint: my_status_entry = controller.get_network_status(my_fingerprint) if my_status_entry: - self.vals['tor/flags'] = my_status_entry.flags + flags = my_status_entry.flags # Updates file descriptor usage and logs if the usage is high. If we don't # have a known limit or it's obviously faulty (being lower than our # current usage) then omit file descriptor functionality. - if self.vals['tor/fd_limit']: + fd_used = 0 + + if fd_limit: fd_used = get_file_descriptor_usage(controller.get_pid(None)) - if fd_used and fd_used <= self.vals['tor/fd_limit']: - self.vals['tor/fd_used'] = fd_used - else: - self.vals['tor/fd_used'] = 0 + if not fd_used or fd_used > fd_limit: + fd_used = 0 - if self.vals['tor/fd_used'] and self.vals['tor/fd_limit']: - fd_percent = 100 * self.vals['tor/fd_used'] / self.vals['tor/fd_limit'] + if fd_used and fd_limit: + fd_percent = 100 * fd_used / fd_limit msg = "Tor's file descriptor usage is at %i%%." % fd_percent if fd_percent >= 90 and not self._is_fd_ninety_percent_warned: @@ -636,16 +582,14 @@ class HeaderPanel(panel.Panel, threading.Thread): self._is_fd_sixty_percent_warned = True log.notice(msg) - # ps or proc derived resource usage stats + resource_tracker = arm.util.tracker.get_resource_tracker() - if self.vals['tor/pid']: - resource_tracker = arm.util.tracker.get_resource_tracker() + resources = resource_tracker.get_resource_usage() + self._last_resource_fetch = resource_tracker.run_counter() - resources = resource_tracker.get_resource_usage() - self._last_resource_fetch = resource_tracker.run_counter() - self.vals['stat/%torCpu'] = '%0.1f' % (100 * resources.cpu_sample) - self.vals['stat/rss'] = str(resources.memory_bytes) - self.vals['stat/%mem'] = '%0.1f' % (100 * resources.memory_percent) + tor_cpu = '%0.1f' % (100 * resources.cpu_sample) + tor_rss = str(resources.memory_bytes) + tor_memory = '%0.1f' % (100 * resources.memory_percent) # determines the cpu time for the arm process (including user and system # time of both the primary and child processes) @@ -655,11 +599,38 @@ class HeaderPanel(panel.Panel, threading.Thread): arm_time_delta = current_time - self._arm_cpu_sampling[1] python_cpu_time = arm_cpu_telta / arm_time_delta sys_call_cpu_time = 0.0 # TODO: add a wrapper around call() to get this - self.vals['stat/%armCpu'] = '%0.1f' % (100 * (python_cpu_time + sys_call_cpu_time)) + arm_cpu = '%0.1f' % (100 * (python_cpu_time + sys_call_cpu_time)) self._arm_cpu_sampling = (total_arm_cpu_time, current_time) self._last_update = current_time - self.vals_lock.release() + + return { + 'tor/address': controller.get_info('address', ''), + 'tor/fingerprint': controller.get_info('fingerprint', 'Unknown'), + 'tor/version': str(controller.get_version('Unknown')).split()[0], + 'tor/versionStatus': controller.get_info('status/version/current', 'Unknown'), + 'tor/nickname': controller.get_conf('Nickname', ''), + 'tor/orListenAddr': or_address, + 'tor/or_port': or_port, + 'tor/exit_policy': str(controller.get_exit_policy), + 'tor/flags': flags, + 'tor/dir_port': controller.get_conf('DirPort', '0'), + 'tor/control_port': controller.get_conf('ControlPort', '0'), + 'tor/socketPath': controller.get_conf('ControlSocket', ''), + 'tor/isAuthPassword': controller.get_conf('HashedControlPassword', None) is not None, + 'tor/isAuthCookie': controller.get_conf('CookieAuthentication', None) == '1', + 'tor/fd_limit': fd_limit, + 'tor/fd_used': fd_used, + 'tor/pid': controller.get_pid(''), + 'tor/start_time': start_time if start_time else '', + 'stat/%torCpu': tor_cpu, + 'stat/%armCpu': arm_cpu, + 'stat/rss': tor_rss, + 'stat/%mem': tor_memory, + 'sys/hostname': uname_vals[1], + 'sys/os': uname_vals[0], + 'sys/version': uname_vals[2], + } def get_file_descriptor_usage(pid):

1 0