- tor-commits - lists.torproject.org

[flashproxy/master] Limit retries to 1000 to halt runaways.
by dcf＠torproject.org 10 Feb '12

10 Feb '12

commit d7d69baec734fdaad2c50a24cf11916854c44247 Author: David Fifield <david(a)bamsoftware.com> Date: Tue Feb 7 09:46:45 2012 -0800 Limit retries to 1000 to halt runaways. --- experiments/switching/local-http-alternating.sh | 4 ++-- experiments/switching/local-http-constant.sh | 4 ++-- experiments/switching/remote-tor-alternating.sh | 2 +- experiments/switching/remote-tor-constant.sh | 4 ++-- experiments/switching/remote-tor-direct.sh | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/experiments/switching/local-http-alternating.sh b/experiments/switching/local-http-alternating.sh index 696f1d5..08cca91 100755 --- a/experiments/switching/local-http-alternating.sh +++ b/experiments/switching/local-http-alternating.sh @@ -60,7 +60,7 @@ visible_sleep 2 if [ -n "$OUTPUT_FILENAME" ]; then - real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 0 -O /dev/null >> "$OUTPUT_FILENAME" + real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 1000 -O /dev/null >> "$OUTPUT_FILENAME" else - real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 0 -O /dev/null + real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 1000 -O /dev/null fi diff --git a/experiments/switching/local-http-constant.sh b/experiments/switching/local-http-constant.sh index c1a52f8..ff73c2a 100755 --- a/experiments/switching/local-http-constant.sh +++ b/experiments/switching/local-http-constant.sh @@ -54,7 +54,7 @@ PIDS_TO_KILL+=($!) visible_sleep 2 if [ -n "$OUTPUT_FILENAME" ]; then - real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 0 -O /dev/null >> "$OUTPUT_FILENAME" + real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 1000 -O /dev/null >> "$OUTPUT_FILENAME" else - real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 0 -O /dev/null + real_time wget http://127.0.0.1:2000/dump --wait=0 --waitretry=0 -t 1000 -O /dev/null fi diff --git a/experiments/switching/remote-tor-alternating.sh b/experiments/switching/remote-tor-alternating.sh index 26070d9..2dcfbcc 100755 --- a/experiments/switching/remote-tor-alternating.sh +++ b/experiments/switching/remote-tor-alternating.sh @@ -57,7 +57,7 @@ PIDS_TO_KILL+=($!) visible_sleep 15 repeat_download() { - until torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 0 -O "$DATA_FILE_NAME"; do + until torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 1000 -O "$DATA_FILE_NAME"; do echo "retrying" done } diff --git a/experiments/switching/remote-tor-constant.sh b/experiments/switching/remote-tor-constant.sh index 939aef9..9d842c8 100755 --- a/experiments/switching/remote-tor-constant.sh +++ b/experiments/switching/remote-tor-constant.sh @@ -52,7 +52,7 @@ browser_goto "$PROFILE_1" "$PROXY_URL" visible_sleep 15 if [ -n "$OUTPUT_FILENAME" ]; then - real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 0 -O "$DATA_FILE_NAME" >> "$OUTPUT_FILENAME" + real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 1000 -O "$DATA_FILE_NAME" >> "$OUTPUT_FILENAME" else - real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 0 -O "$DATA_FILE_NAME" + real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 1000 -O "$DATA_FILE_NAME" fi diff --git a/experiments/switching/remote-tor-direct.sh b/experiments/switching/remote-tor-direct.sh index 1b6bdaa..9b0740c 100755 --- a/experiments/switching/remote-tor-direct.sh +++ b/experiments/switching/remote-tor-direct.sh @@ -31,7 +31,7 @@ PIDS_TO_KILL+=($!) visible_sleep 15 if [ -n "$OUTPUT_FILENAME" ]; then - real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 0 -O "$DATA_FILE_NAME" >> "$OUTPUT_FILENAME" + real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 1000 -O "$DATA_FILE_NAME" >> "$OUTPUT_FILENAME" else - real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 0 -O "$DATA_FILE_NAME" + real_time torify wget http://torperf.torproject.org/.5mbfile --wait=0 --waitretry=0 -c -t 1000 -O "$DATA_FILE_NAME" fi

1 0

r25385: {website} i thought wml was supposed to do this, not humans, attempt t (website/trunk/projects/en)
by Andrew Lewman 10 Feb '12

10 Feb '12

Author: phobos Date: 2012-02-09 23:58:38 +0000 (Thu, 09 Feb 2012) New Revision: 25385 Modified: website/trunk/projects/en/obfsproxy-instructions.wml Log: i thought wml was supposed to do this, not humans, attempt to address ticket 5064. Modified: website/trunk/projects/en/obfsproxy-instructions.wml =================================================================== --- website/trunk/projects/en/obfsproxy-instructions.wml 2012-02-09 14:33:40 UTC (rev 25384) +++ website/trunk/projects/en/obfsproxy-instructions.wml 2012-02-09 23:58:38 UTC (rev 25385) @@ -108,7 +108,7 @@ <p> <p> - <img src="$(IMGROOT)/obfs-spawn_tor_bridge.png" alt="spawn tor" height="101" width="882"></a> + <img src="$(IMGROOT)/obfs-spawn_tor_bridge.png" alt="spawn tor" height="117" width="879"></a> </p> <p>

1 0

[flashproxy/master] Add flashproxy-exercise scripts.
by dcf＠torproject.org 10 Feb '12

10 Feb '12

commit 3fcb5457a1f105aadb2293e8a2789e80ddca6849 Author: David Fifield <david(a)bamsoftware.com> Date: Thu Feb 9 15:27:55 2012 -0800 Add flashproxy-exercise scripts. These are the hourly tests I have been running for a few months. --- experiments/exercise/exercise.sh | 30 +++++++++++++++++++++++++++ experiments/exercise/flashproxy-exercise.sh | 9 ++++++++ 2 files changed, 39 insertions(+), 0 deletions(-) diff --git a/experiments/exercise/exercise.sh b/experiments/exercise/exercise.sh new file mode 100755 index 0000000..a7c7511 --- /dev/null +++ b/experiments/exercise/exercise.sh @@ -0,0 +1,30 @@ +#!/bin/bash + +FLASHPROXY_DIR="$HOME/flashproxy" +TOR="$HOME/tor/src/or/tor" +LOCAL_PORT=1080 +REMOTE_PORT=7070 + +declare -a PIDS_TO_KILL +stop() { + if [ -n "${PIDS_TO_KILL[*]}" ]; then + echo "Kill pids ${PIDS_TO_KILL[@]}." + kill "${PIDS_TO_KILL[@]}" + fi + exit +} +trap stop EXIT + +date + +"$FLASHPROXY_DIR"/connector.py -f tor-facilitator.bamsoftware.com ":$LOCAL_PORT" ":$REMOTE_PORT" & +PIDS_TO_KILL+=($!) + +sleep 20 + +"$TOR" UseBridges 1 Bridge 127.0.0.1:9001 Socks4Proxy 127.0.0.1:$LOCAL_PORT & +PIDS_TO_KILL+=($!) + +sleep 60 + +curl --retry 5 --socks4a 127.0.0.1:9050 http://check.torproject.org/ diff --git a/experiments/exercise/flashproxy-exercise.sh b/experiments/exercise/flashproxy-exercise.sh new file mode 100755 index 0000000..ec60b8b --- /dev/null +++ b/experiments/exercise/flashproxy-exercise.sh @@ -0,0 +1,9 @@ +#!/bin/sh + +DATE=$(date +"%Y-%m-%d-%H:%M") +LOG="log-$DATE" + +# To get cron mail: +# ./exercise.sh 2>&1 | tee "$LOG" +# To not get cron mail: +./exercise.sh &> "$LOG"

1 0

[flashproxy/master] Add brief usage for flashproxy-exercise.
by dcf＠torproject.org 10 Feb '12

10 Feb '12

commit cc69f02cd17b19530d1c8fe3fb858ba2d3822ad2 Author: David Fifield <david(a)bamsoftware.com> Date: Thu Feb 9 15:30:27 2012 -0800 Add brief usage for flashproxy-exercise. --- experiments/exercise/exercise.sh | 3 +++ experiments/exercise/flashproxy-exercise.sh | 3 +++ 2 files changed, 6 insertions(+), 0 deletions(-) diff --git a/experiments/exercise/exercise.sh b/experiments/exercise/exercise.sh index a7c7511..834bd48 100755 --- a/experiments/exercise/exercise.sh +++ b/experiments/exercise/exercise.sh @@ -1,5 +1,8 @@ #!/bin/bash +# This script registers with the flash proxy facilitator, tries to download +# check.torproject.org, and saves a timestamped log file. + FLASHPROXY_DIR="$HOME/flashproxy" TOR="$HOME/tor/src/or/tor" LOCAL_PORT=1080 diff --git a/experiments/exercise/flashproxy-exercise.sh b/experiments/exercise/flashproxy-exercise.sh index ec60b8b..4db7530 100755 --- a/experiments/exercise/flashproxy-exercise.sh +++ b/experiments/exercise/flashproxy-exercise.sh @@ -1,5 +1,8 @@ #!/bin/sh +# Usage (for example in crontab for hourly tests): +# 0 * * * * cd /path/flashproxy-exercise && ./flashproxy-exercise.sh + DATE=$(date +"%Y-%m-%d-%H:%M") LOG="log-$DATE"

1 0

[translation/vidalia_alpha] Update translations for vidalia_alpha
by translation＠torproject.org 09 Feb '12

09 Feb '12

commit 67e1933b98433ec72f6a3b35742fb090da0ab3a6 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Feb 9 20:15:28 2012 +0000 Update translations for vidalia_alpha --- fr/vidalia.po | 52 ++++++++++++++++++++++++++-------------------------- 1 files changed, 26 insertions(+), 26 deletions(-) diff --git a/fr/vidalia.po b/fr/vidalia.po index 2156094..813c171 100644 --- a/fr/vidalia.po +++ b/fr/vidalia.po @@ -8,7 +8,7 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2011-05-03 14:28+0000\n" -"PO-Revision-Date: 2012-02-09 19:44+0000\n" +"PO-Revision-Date: 2012-02-09 20:02+0000\n" "Last-Translator: arpalord <arpalord(a)gmail.com>\n" "Language-Team: translations(a)vidalia-project.net\n" "MIME-Version: 1.0\n" @@ -1375,7 +1375,7 @@ msgstr "Application Proxy (optionnel)" msgctxt "GeneralPage" msgid "Start a proxy application when Tor starts" -msgstr "Lancer l'application proxy quand Tor démarre" +msgstr "Lancer une application proxy quand Tor démarre" msgctxt "GeneralPage" msgid "Proxy Application Arguments:" @@ -1724,11 +1724,11 @@ msgstr "" msgctxt "MainWindow" msgid "Loading network status" -msgstr "" +msgstr "Chargement du statut du réseau" msgctxt "MainWindow" msgid "Loading authority certificates" -msgstr "" +msgstr "Chargement des certificats d'autorité" msgctxt "MainWindow" msgid "Requesting relay information" @@ -1740,15 +1740,15 @@ msgstr "" msgctxt "MainWindow" msgid "Connecting to the Tor network" -msgstr "" +msgstr "Connexion au réseau Tor" msgctxt "MainWindow" msgid "Establishing a Tor circuit" -msgstr "" +msgstr "Réalisation d'un circuit Tor" msgctxt "MainWindow" msgid "Connected to the Tor network!" -msgstr "" +msgstr "Connecté au réseau Tor!" msgctxt "MainWindow" msgid "Unrecognized startup status" @@ -2049,11 +2049,11 @@ msgstr "" msgctxt "MainWindow" msgid ", probably Telnet," -msgstr "" +msgstr ", probablement Telnet," msgctxt "MainWindow" msgid ", probably an email client," -msgstr "" +msgstr ", probablement un client email," msgctxt "MainWindow" msgid "" @@ -2089,7 +2089,7 @@ msgstr "" msgctxt "MessageLog" msgid "Log Filename Required" -msgstr "" +msgstr "Nom du fichier journal requis" msgctxt "MessageLog" msgid "You must enter a filename to be able to save log messages to a file." @@ -2129,7 +2129,7 @@ msgstr "" msgctxt "MessageLog" msgid "Message Log" -msgstr "" +msgstr "Journal des messages" msgctxt "MessageLog" msgid "Message Filters..." @@ -2157,7 +2157,7 @@ msgstr "" msgctxt "MessageLog" msgid "Ctrl+E" -msgstr "" +msgstr "Ctrl+E" msgctxt "MessageLog" msgid "Copy" @@ -2229,7 +2229,7 @@ msgstr "Fermer" msgctxt "MessageLog" msgid "Close the Message Log" -msgstr "" +msgstr "Fermer le journal des messages" msgctxt "MessageLog" msgid "Esc" @@ -2313,7 +2313,7 @@ msgstr "messages" msgctxt "MessageLog" msgid "Browse" -msgstr "" +msgstr "Parcourir" msgctxt "MessageLog" msgid "Enable automatically saving all new log messages to a file" @@ -2463,7 +2463,7 @@ msgstr "" msgctxt "NetViewer" msgid "Full Screen" -msgstr "" +msgstr "Plein écran" msgctxt "NetViewer" msgid "View the network map as a full screen window" @@ -2475,7 +2475,7 @@ msgstr "Ctrl+F" msgctxt "NetViewer" msgid "Network Map" -msgstr "" +msgstr "Carte du réseau" msgctxt "NetViewer" msgid "Relay" @@ -2523,11 +2523,11 @@ msgstr "" msgctxt "NetworkPage" msgid "I use a proxy to access the Internet" -msgstr "" +msgstr "J'utilise un serveur mandataire (proxy) pour accéder à Internet" msgctxt "NetworkPage" msgid "Proxy Settings" -msgstr "" +msgstr "Paramètres du proxy" msgctxt "NetworkPage" msgid "Username:" @@ -2551,15 +2551,15 @@ msgstr "" msgctxt "NetworkPage" msgid "Firewall Settings" -msgstr "" +msgstr "Paramètres du pare feu" msgctxt "NetworkPage" msgid "Allowed Ports:" -msgstr "" +msgstr "Ports autorisés:" msgctxt "NetworkPage" msgid "80, 443" -msgstr "" +msgstr "80, 443" msgctxt "NetworkPage" msgid "" @@ -2611,15 +2611,15 @@ msgstr "" msgctxt "NetworkPage" msgid "Address:" -msgstr "" +msgstr "Adresse:" msgctxt "NetworkPage" msgid "Type:" -msgstr "" +msgstr "Type:" msgctxt "NetworkPage" msgid "You must select the proxy type." -msgstr "" +msgstr "Vous devez sélectionner le type de proxy." msgctxt "NetworkPage" msgid "SOCKS 4" @@ -3091,7 +3091,7 @@ msgstr "Error" msgctxt "ServicePage" msgid "Please select a Service." -msgstr "" +msgstr "Merci de sélectionner un Service." msgctxt "ServicePage" msgid "Select Service Directory" @@ -3115,7 +3115,7 @@ msgstr "" msgctxt "ServicePage" msgid "Onion Address" -msgstr "" +msgstr "Adresse de l'onion" msgctxt "ServicePage" msgid "Virtual Port"

1 0

[flashproxy/master] Make it clear that you only need the "Open Source Flex SDK."
by dcf＠torproject.org 09 Feb '12

09 Feb '12

commit 6d21f621f2a3e7c9b8e0438f081e8ee5ecc0b8b8 Author: David Fifield <david(a)bamsoftware.com> Date: Sun Feb 5 23:53:30 2012 -0800 Make it clear that you only need the "Open Source Flex SDK." --- README | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-) diff --git a/README b/README index 7f7189b..25431bb 100644 --- a/README +++ b/README @@ -161,7 +161,8 @@ See design.txt for some more technical information. === Building swfcat.swf -Download the (free software) Flex SDK. +Download the Flex SDK. You only need the "Open Source Flex SDK," not the +"Adobe Flex SDK." http://opensource.adobe.com/wiki/display/flexsdk/Flex+SDK Put its bin directory in your PATH. The important executable is mxmlc.

1 0

[flashproxy/master] Refresh the badge once a day.
by dcf＠torproject.org 09 Feb '12

09 Feb '12

commit 83979c32978259e203c029965eaf8853107e300f Author: David Fifield <david(a)bamsoftware.com> Date: Thu Feb 9 11:46:11 2012 -0800 Refresh the badge once a day. This way browsers that are left open forever will eventually check for a new badge. --- embed.html | 1 + 1 files changed, 1 insertions(+), 0 deletions(-) diff --git a/embed.html b/embed.html index 9b6b152..fde5ba8 100644 --- a/embed.html +++ b/embed.html @@ -1,6 +1,7 @@ <!DOCTYPE html> <html> <head> +<meta http-equiv="refresh" content="86400"> <script type="text/javascript"> /* Are circumstances such that we should self-disable and not be a proxy? We take a best-effort guess as to whether this device runs on

1 0

[translation/vidalia_alpha] Update translations for vidalia_alpha
by translation＠torproject.org 09 Feb '12

09 Feb '12

commit e0b591c6eab990c74ff1fa1b387a42430df7000c Author: Translation commit bot <translation(a)torproject.org> Date: Thu Feb 9 19:45:23 2012 +0000 Update translations for vidalia_alpha --- fr/vidalia.po | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) diff --git a/fr/vidalia.po b/fr/vidalia.po index 2b465ef..2156094 100644 --- a/fr/vidalia.po +++ b/fr/vidalia.po @@ -8,7 +8,7 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2011-05-03 14:28+0000\n" -"PO-Revision-Date: 2012-02-09 16:41+0000\n" +"PO-Revision-Date: 2012-02-09 19:44+0000\n" "Last-Translator: arpalord <arpalord(a)gmail.com>\n" "Language-Team: translations(a)vidalia-project.net\n" "MIME-Version: 1.0\n" @@ -1347,7 +1347,7 @@ msgstr "Exécutables (*.exe)" msgctxt "GeneralPage" msgid "Select Path to Tor" -msgstr "" +msgstr "Sélectionner le chemin de Tor" msgctxt "GeneralPage" msgid "Select Proxy Executable" @@ -1375,11 +1375,11 @@ msgstr "Application Proxy (optionnel)" msgctxt "GeneralPage" msgid "Start a proxy application when Tor starts" -msgstr "" +msgstr "Lancer l'application proxy quand Tor démarre" msgctxt "GeneralPage" msgid "Proxy Application Arguments:" -msgstr "" +msgstr "Arguments de l'application Proxy" msgctxt "GeneralPage" msgid "Software Updates"

1 0

[tor-cloud/master] We want to create private bridges for AWS as well
by runa＠torproject.org 09 Feb '12

09 Feb '12

commit 415509d2babfea8b88ec15d1f70c3fc4d42cf280 Author: Runa A. Sandvik <runa.sandvik(a)gmail.com> Date: Thu Feb 9 18:53:39 2012 +0000 We want to create private bridges for AWS as well --- ec2-prep.sh | 37 +++++++++++++++++++++++++++++++++++++ 1 files changed, 37 insertions(+), 0 deletions(-) diff --git a/ec2-prep.sh b/ec2-prep.sh index 4e6ad88..a886cb9 100644 --- a/ec2-prep.sh +++ b/ec2-prep.sh @@ -261,6 +261,43 @@ ExitPolicy reject *:* EOF fi +if [ $CONFIG == "privatebridge" ]; then +echo "Configuring Tor as a $CONFIG"; +cat << EOF > $CONFIG_FILE +# Auto generated public Tor $CONFIG config file + +# A unique handle for your server. +Nickname ec2$CONFIG$RESERVATION + +# Set "SocksPort 0" if you plan to run Tor only as a server, and not +# make any local application connections yourself. +SocksPort 0 + +# What port to advertise for Tor connections. +ORPort 443 + +# Listen on a port other than the one advertised in ORPort (that is, +# advertise 443 but bind to 9001). +ORListenAddress 0.0.0.0:9001 + +# Start Tor as a bridge. +BridgeRelay 1 + +# This is a private bridge. +PublishServerDescriptor 0 + +# Never send or receive more than 10GB of data per week. The accounting +# period runs from 10 AM on the 1st day of the week (Monday) to the same +# day and time of the next week. +AccountingStart week 1 10:00 +AccountingMax 10 GB + +# Running a bridge relay just passes data to and from the Tor network -- +# so it shouldn't expose the operator to abuse complaints. +ExitPolicy reject *:* +EOF +fi + # XXX TODO # Generally, we'll want to rm /var/lib/tor/* and remove all state from the system #

1 0

[stem/master] ControlSocket listeners for state changes
by atagar＠torproject.org 09 Feb '12

09 Feb '12

commit 1b1d48c37ae9092fdb93a76a3bc6201dad3113e4 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Feb 9 10:32:43 2012 -0800 ControlSocket listeners for state changes Adding functions to let users subscribe for state change notifications. This is something that I've found highly useful in the past, and will also be needed for the BaseController implementation. --- stem/control.py | 28 +++++-- stem/socket.py | 140 ++++++++++++++++++++++++++++++++++- test/integ/socket/control_socket.py | 83 +++++++++++++++++++-- 3 files changed, 236 insertions(+), 15 deletions(-) diff --git a/stem/control.py b/stem/control.py index c485cb9..ba18361 100644 --- a/stem/control.py +++ b/stem/control.py @@ -19,8 +19,8 @@ class BaseController(stem.socket.ControlSocket): controllers, providing basic process communication and event listing. Don't use this directly - subclasses provide higher level functionality. - Attributes: - socket - ControlSocket from which this was constructed + Do not continue to directly interacte with the ControlSocket we're + constructed from - use our wrapper methods instead. """ # TODO: Convenience methods for the BaseController are pointless since @@ -66,22 +66,34 @@ class BaseController(stem.socket.ControlSocket): from_socket_file = staticmethod(from_socket_file) def __init__(self, control_socket): - self.socket = control_socket + self._socket = control_socket + + def provide_self(): return self + self._socket._get_self = provide_self def send(self, message, raw = False): - self.socket.send(message, raw) + self._socket.send(message, raw) def recv(self): - return self.socket.recv() + return self._socket.recv() def is_alive(self): - return self.socket.is_alive() + return self._socket.is_alive() def connect(self): - self.socket.connect() + self._socket.connect() def close(self): - self.socket.close() + self._socket.close() + + def get_socket(self): + return self._socket + + def add_status_listener(self, callback, spawn = True): + self._socket.add_status_listener(callback, spawn) + + def remove_status_listener(self, callback): + self._socket.remove_status_listener(callback) def _make_socket(self): self._control_socket._make_socket() diff --git a/stem/socket.py b/stem/socket.py index 9379884..da46db2 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -15,7 +15,10 @@ ControlSocket - Socket wrapper that speaks the tor control protocol. |- recv - receives a ControlMessage from the socket |- is_alive - reports if the socket is known to be closed |- connect - connects a new socket - +- close - shuts down the socket + |- close - shuts down the socket + |- get_socket - provides socket providing base control communication + |- add_status_listener - notifies a callback of changes in the socket status + +- remove_status_listener - prevents further notification of status changes ControlMessage - Message that's read from the control socket. |- content - provides the parsed message content @@ -44,11 +47,21 @@ ControllerError - Base exception raised when using the controller. from __future__ import absolute_import import re +import time import socket +import thread import threading +import stem.util.enum import stem.util.log as log +# state changes a control socket can have +# INIT - new control connection +# RESET - received a reset/sighup signal +# CLOSED - control connection closed + +State = stem.util.enum.Enum("INIT", "RESET", "CLOSED") + KEY_ARG = re.compile("^(\S+)=") # Escape sequences from the 'esc_for_log' function of tor's 'common/util.c'. @@ -88,6 +101,9 @@ class ControlSocket: self._socket, self._socket_file = None, None self._is_alive = False + self._status_listeners = [] # tuples of the form (callback, spawn_thread) + self._status_listeners_lock = threading.RLock() + # Tracks sending and receiving separately. This should be safe, and doing # so prevents deadlock where we block writes because we're waiting to read # a message that isn't coming. @@ -179,6 +195,8 @@ class ControlSocket: self._socket = self._make_socket() self._socket_file = self._socket.makefile() self._is_alive = True + + self._notify_status_listeners(State.INIT, True) def close(self): """ @@ -186,9 +204,15 @@ class ControlSocket: """ with self._send_lock, self._recv_lock: + # Function is idempotent with one exception: we notify listeners if this + # is causing our is_alive() state to change. + + notify_listeners = self.is_alive() + if self._socket: # if we haven't yet established a connection then this raises an error # socket.error: [Errno 107] Transport endpoint is not connected + try: self._socket.shutdown(socket.SHUT_RDWR) except socket.error: pass @@ -207,6 +231,120 @@ class ControlSocket: self._socket = None self._socket_file = None self._is_alive = False + + if notify_listeners: + self._notify_status_listeners(State.CLOSED, False) + + def get_socket(self): + """ + Provides our base ControlSocket that speaks with the socket. For standard + subclasses this is simply ourselves, but for wrapper instances this is the + ContorlSocket they wrap. + + Use of this, rather than going through its wrapper instance, isn't + generally a good idea. + + Returns: + ControlSocket for base controller communications + """ + + return self + + def add_status_listener(self, callback, spawn = True): + """ + Notifies a given function when the state of our socket changes. Functions + are expected to be of the form... + + my_function(control_socket, state, timestamp) + + The state is a value from stem.socket.State, functions *must* allow for + new values in this field. The timestamp is a float for the unix time when + the change occured. + + This class only provides State.INIT and State.CLOSED notifications. + Subclasses may provide others. + + If spawn is True then the callback is notified via a new daemon thread. If + false then the notice is under our locks, within the thread where the + change occured. In general this isn't advised, especially if your callback + could block for a while. + + Arguments: + callback (function) - function to be notified when our state changes + spawn (bool) - calls function via a new thread if True, otherwise + it's part of the connect/close method call + """ + + with self._status_listeners_lock: + self._status_listeners.append((callback, spawn)) + + def remove_status_listener(self, callback): + """ + Stops listener from being notified of further events. + + Arguments: + callback (function) - function to be removed from our listeners + + Returns: + bool that's True if we removed one or more occurances of the callback, + False otherwise + """ + + with self._status_listeners_lock: + new_listeners, is_changed = [], False + + for listener, spawn in self._status_listeners: + if listener != callback: + new_listeners.append((listener, spawn)) + else: is_changed = True + + self._status_listeners = new_listeners + return is_changed + + def _notify_status_listeners(self, state, expect_alive = None): + """ + Informs our status listeners that a state change occured. + + States imply that our socket is either alive or not, which may not hold + true when multiple events occure in quick succession. For instance, a + sighup could cause two events (State.RESET for the sighup and State.CLOSE + if it causes tor to crash). However, there's no guarentee of the order in + which they occure, and it would be bad if listeners got the State.RESET + last, implying that we were alive. + + If set, the expect_alive flag will discard our event if it conflicts with + our current is_alive() state. + + Arguments: + state (stem.socket.State) - state change that has occured + expect_alive (bool) - discard event if it conflicts with our + is_alive() state + """ + + # Our own calles (the connect() and close() methods) already acquire these + # locks. However, our subclasses that use this method probably won't have + # them, so locking to prevent those from conflicting with each other and + # connect() / close(). + + with self._send_lock, self._recv_lock: + change_timestamp = time.time() + + if expect_alive != None and expect_alive != self.is_alive(): + return + + for listener, spawn in self._status_listeners: + if spawn: + thread.start_new_thread(listener, (self._get_self(), state, change_timestamp)) + else: + listener(self._get_self(), state, change_timestamp) + + def _get_self(self): + """ + Provides our self reference. For basic subclasses this is ourselves, but + for wrappers this is the instance wrapping us. + """ + + return self def __enter__(self): return self diff --git a/test/integ/socket/control_socket.py b/test/integ/socket/control_socket.py index 3a4aaeb..ec19d82 100644 --- a/test/integ/socket/control_socket.py +++ b/test/integ/socket/control_socket.py @@ -8,6 +8,7 @@ those focus on parsing and correctness of the content these are more concerned with the behavior of the socket itself. """ +import time import unittest import stem.connection @@ -15,6 +16,26 @@ import stem.control import stem.socket import test.runner +class StateObserver: + """ + Simple container for listening to ControlSocket state changes and + rembembering them for the test. + """ + + control_socket = None + state = None + timestamp = None + + def reset(self): + self.control_socket = None + self.state = None + self.timestamp = None + + def listener(self, control_socket, state, timestamp): + self.control_socket = control_socket + self.state = state + self.timestamp = timestamp + class TestControlSocket(unittest.TestCase): def setUp(self): test.runner.require_control(self) @@ -65,12 +86,7 @@ class TestControlSocket(unittest.TestCase): # If we send another message to a port based socket then it will seem to # succeed. However, a file based socket should report a failure. - if isinstance(control_socket, stem.control.BaseController): - base_socket = control_socket.socket - else: - base_socket = control_socket - - if isinstance(base_socket, stem.socket.ControlPort): + if control_socket.get_socket().__class__ == stem.socket.ControlPort: control_socket.send("blarg") self.assertTrue(control_socket.is_alive()) else: @@ -120,4 +136,59 @@ class TestControlSocket(unittest.TestCase): control_socket.close() self.assertRaises(stem.socket.SocketClosed, control_socket.send, "PROTOCOLINFO 1") control_socket.connect() + + def test_status_notifications(self): + """ + Checks basic functionality of the add_status_listener() and + remove_status_listener() methods. + """ + + state_observer = StateObserver() + + with test.runner.get_runner().get_tor_socket(False) as control_socket: + control_socket.add_status_listener(state_observer.listener, False) + + control_socket.close() + self.assertEquals(control_socket, state_observer.control_socket) + self.assertEquals(stem.socket.State.CLOSED, state_observer.state) + self.assertTrue(state_observer.timestamp < time.time()) + self.assertTrue(state_observer.timestamp > time.time() - 1.0) + state_observer.reset() + + control_socket.connect() + self.assertEquals(control_socket, state_observer.control_socket) + self.assertEquals(stem.socket.State.INIT, state_observer.state) + self.assertTrue(state_observer.timestamp < time.time()) + self.assertTrue(state_observer.timestamp > time.time() - 1.0) + state_observer.reset() + + # cause the socket to shut down without calling close() + control_socket.send("Blarg!") + control_socket.recv() + self.assertRaises(stem.socket.SocketClosed, control_socket.recv) + self.assertEquals(control_socket, state_observer.control_socket) + self.assertEquals(stem.socket.State.CLOSED, state_observer.state) + self.assertTrue(state_observer.timestamp < time.time()) + self.assertTrue(state_observer.timestamp > time.time() - 1.0) + state_observer.reset() + + # remove listener and make sure we don't get further notices + control_socket.remove_status_listener(state_observer.listener) + control_socket.connect() + self.assertEquals(None, state_observer.control_socket) + self.assertEquals(None, state_observer.state) + self.assertEquals(None, state_observer.timestamp) + state_observer.reset() + + # add with spawn as true, we need a little delay on this since we then + # get the notice asynchronously + + control_socket.add_status_listener(state_observer.listener, True) + control_socket.close() + time.sleep(0.1) # not much work going on so this doesn't need to be much + self.assertEquals(control_socket, state_observer.control_socket) + self.assertEquals(stem.socket.State.CLOSED, state_observer.state) + self.assertTrue(state_observer.timestamp < time.time()) + self.assertTrue(state_observer.timestamp > time.time() - 1.0) + state_observer.reset()

1 0