[or-cvs] r16799: {torflow} a detailed 'how to get soat running' section for arma (torflow/branches/gsoc2008)

[aleksei@xxxxxxxx]

Author: aleksei
Date: 2008-09-08 15:34:20 -0400 (Mon, 08 Sep 2008)
New Revision: 16799

Modified:
   torflow/branches/gsoc2008/soat.py
Log:
a detailed 'how to get soat running' section for arma

Modified: torflow/branches/gsoc2008/soat.py
===================================================================
--- torflow/branches/gsoc2008/soat.py	2008-09-08 18:46:22 UTC (rev 16798)
+++ torflow/branches/gsoc2008/soat.py	2008-09-08 19:34:20 UTC (rev 16799)
@@ -5,17 +5,20 @@
 '''
 Snakes on a Tor exit node scanner
 
-The SOAT scanner checks whether exit nodes behave by initiating connections
+The SoaT scanner checks whether exit nodes behave by initiating connections
 to semi-randomly chosen targets using several protocols (http, https, ssh, smtp, imap, etc)
 and comparing content received directly and via tor.
 
 It interacts with metatroller and the control port to be aware of the tor network status.
 
-If run from the console, soat will loop over all available nodes,
-trying to provide test coverage for the tor network.
-The test results can be viewed using the soatstats.py script.
+To run SoaT: 
+1) make sure you have py-openssl packages installed (see README)
+2) open Tor control port in the torrc
+3) start metatroller in the background (./python metatroller.py)
+4) start soat (./python soat.py) with some testing flags (run it without any flags
+    to see which options are available)
+5) check the results later by running soatstats (./python soatstats.py)
 
-See also python soatstats.py
 '''
 
 __all__ = ["ExitNodeScanner", "DNSRebindScanner", "load_wordlist", "get_urls"]