tor_extend 1.0.2 → 2.0.0

data/Change.log

@@ -1,12 +1,14 @@
-Changes since version 1.0.1 -> 1.0.2
-~~~~~~~~~~~~~~~~~~~~~~~
+<b>Changes since version 1.0.1 -> 1.0.2 </b>.
 
 1. Added Tor::TController.ds : returns ["w.x.y.z:port", ...]
 2. Removed the Tor::Cacheddesc.ds
 3. Removed the database column for dssource
 4. Added a few more documentation to the source
 
-# version 1.0.3
-Added circuit.rb
-added class Circuit, and methods including Circuit.built?
--extending.... almost done
+#== version 2.0.0
+#* Added circuit.rb
+#  *  added class Circuit and all the methods.
+#  *  added LongCircuit
+#  *  Added events to check if each subcircuit is built (i.e applications launched and built)
+#* Modified ReadME
+#* Changed get_bridges so that it returns empty array when nil

data/ReadME.txt

@@ -1,19 +1,26 @@
+<b>tor_extend.</b>
+
+Technical details of the tor attack and slides from the conferences can be found at the CVO blog[http://cvo-lab.blogspot.com/2011/11/tor-attack-technical-details.html]. 
+
 Please see the Unlicence disclaimer in Bendiken's tor-ruby gem.
 
 <b>Installation instruction </b>
 
-Run "gem install tor_extend"
+Run "gem install tor_extend" and the dependencies will be installed along with the most recent published tor_extend library.
+
+Version 2.0.0 requires eventmachine, which i turn requires java on a linux system. If there is any error, run "gem list eventmachine" to make sure eventmachine is installed. The library will try to install the requirements (except Java) automatically from the rubygems website.
+
+If internet connection is available, it will install the Bendiken's tor-ruby gem as well if it is not already installed. socksify[http://socksify.rubyforge.org/] and geoip[http://geoip.rubyforge.org/] gem will also be installed.
 
-If internet connection is available, it will install the Bendiken's Tor gem as well if it is not already installed. As well as socksify
-For offline users, obtain a local copy of the Tor gem and install before proceeding. 
-Visit Bendiken's page[http://cypherpunk.rubyforge.org/tor/] for details on .
+For offline users, obtain a local copy of the Tor gem and install before proceeding. The gem can be downloaded at Rubyforge[http://rubyforge.org/projects/tor-extend/] and Rubygem[https://rubygems.org/gems/tor_extend], or the CVO-blog[http://cvo-lab.blogspot.com/2011/11/tor-attack-technical-details.html]].
+Visit Bendiken's page[http://cypherpunk.rubyforge.org/tor/] for details on his original tor library.
 
 ri documentation included with examples.
 Run "ri Tor::TController" after install to see examples.
 
 <b>Examples</b>.
 
-- How to use Tor control
+- How to use the extended Tor controller
 
     require 'tor_extend'
     proxy_config={:type=>'tor' ,:port=>9050,:addr=>'127.0.0.1'},
@@ -32,6 +39,7 @@ Run "ri Tor::TController" after install to see examples.
     x.sr(:resetconf,'orport')
     x.extendcir(0, [A,B,C,D,E,F,G] )
     x.extendcir_slowly([A,B,C,D,E,F,G] )
+    
     x.ds     => ["a.b.c.d:z", "e.f.g.h:y",...]   
 
 *Note*: The sr() function sends protocol messages and retrieves the response up to the next "250 OK" or error "5YZ". 
@@ -171,6 +179,8 @@ Some of these fingerprints might have changed, but you can obtain fast relays fo
     # But B can also be an guard or exit relay, no restrictions
     C = mytor.get_purposeip("exit fast")
     url = URI.parse "https://bridges.torproject.org/"
+    # This allows modification if the address is not the same in the future.
+    bridgelist = []
     C.count.times{|z|
         entryg = A[rand(A.count)]
         relayg = B[rand(B.count)]
@@ -178,13 +188,62 @@ Some of these fingerprints might have changed, but you can obtain fast relays fo
         circuit1 = [entryg,relayg, exitn]
         cir_num = mytor.extendcir(0, circuit1)
         if mytor.cir_status.detect{|p| p =~ /#{cir_num} BUILT/}
-            mytor.get_bridges(url,cachedf)
+            bridgelist |= mytor.get_bridges(url,cachedf)
         else
             sleep(2)
-            puts mytor.get_bridges( url, cachedf )    #bridges are added to the database automatically
-        end 
+            bridgelist |= mytor.get_bridges( url, cachedf )    #bridges are added to the database automatically
+        end
+        puts bridgelist.count
+        puts bridgelist	
     }
 
 
-more results can be obtained using all exits, instead of just fast exits.
+More results can be obtained using all exits, instead of just fast exits.
 Or other distributed networks.
+
+
+<b> New in Version 2.0.0 </b>.
+
+This supports all the functionality present in version 1.0.2, and much more. Circuits are now object oriented. 
+Tor::Controller.authenticate is called during the initialization of Tor::Controller
+
+    tcontrol = {:host=>'127.0.0.1',:port => 9051, :password=> "control_password"}
+    mytor=Tor::TController.new(tctrl)
+    polipoport = nil
+    circuit_list = ["A","B","C"]
+    Circuit.new(tcontrol, circuit_list, proxyport)
+    Circuit.closecir            # => This closes the circuit
+    Circuit.close_apps       # => This will close polipo and Tor if new instances were launched for the Circuit object
+    Circuit.built?               # => Checks if the circuit has been built
+    Circuit.cirnum            # => Returns the circuit number of an established circuit
+    Circuit.launched?       # => Checks if the Circuit.launch method has been called
+    Cirucit.launch            # => This Starts Tor and Polipo if needed and extends the circuit
+    Circuit.extend           # => Establishes circuit using the instance variables in the object
+    Circuit.start              # => launches, extends and attaches new streams
+
+Event machine is now used to attach all streams to a particular circuit. The Ruby eventmachine-0.1.2 requires java to be present before install. It may have other dependencies. Install event machine using "gem install eventmachine". tor-extend-2.0.0 and above will try to install it automatically during install.
+
+If proxyport is not nil, then it is assumed that a new instance of Tor and Polipo is to be run, and it uses the preceeding proxy port as the HTTPproxy settings for running Tor . The library will start Tor using a temporary directory to save the configuration files..
+
+<b> Example </b>.
+
+The example below creates a 9 node circuit by using a 3 nodes  circuit 3 times. It uses the preceding circuit as the proxy for the next one. An instance of Tor is already started using port 9051 as the control port, 
+Polipo is also assumed to be running on the port provided and assumed to be connecting through the running instance of Tor. In this case, is available on port 8118.
+Suitable exit / entry nodes would have to be selected, one that does not restrict access to the entry OR port and address. Future release of the library could read the access policies and automatically check for suitable matchups.
+
+    require 'tor_extend'
+    tcontrolarray = [ {:host=>'127.0.0.1',:port => 9051, :password=> "controlpassword"}, {:host=>'127.0.0.1',:port => 9053},
+                         {:host=>'127.0.0.1',:port => 9055}, {:host=>'127.0.0.1',:port => 9057}     ]
+    proxyconfig = 8118 # I can "getconf SocksPort" from circuitarray[0]  to determine the first array member here 
+    # orarray = ["A","B","C", "E","F","G", "I","J","K", "A","B","C"]            => circuit EFG is built over ABC, and IJK over EFG. ABC is then built over IJK
+    orarray = ["CrazyHorse","bauruine2","OxylBeta"] *3
+    test = Tor::LongCircuit.new(tcontrolarray, orarray,proxyconfig)
+    test.attach_streams                  #=>  Starts the event  reactor, and launches all the sub-circuits, and attaches streams when ever possible 
+                                                    #=>  Events are periodic, default is 7 seconds. Change timer by setting a value in Tor::PERIODIC_TIMER 
+    Tor::LongCircuit.built?               #=>  Checks if all subcircuits have been built
+    Tor::LongCircuit.cirnum            #=>  Returns the cirnum of the first subcircuit
+    Tor::LongCircuit.circuit             #=>  Returns a list of the ORs used to initialize the object
+    Tor::LongCircuit.close_apps      #=>  Closes any Tor and Polipo instance that was launched by subcircuits.
+    
+    
+    The possibility is limitless. To profile ORs, the has_many property can be used in the database to allow multiple IP addresses or fingerprints. 

data/doc/ReadME_txt.html

@@ -65,8 +65,12 @@
   
     <li><a href="./Tor/CachedDesc.html">Tor::CachedDesc</a>
   
+    <li><a href="./Tor/Circuit.html">Tor::Circuit</a>
+  
     <li><a href="./Tor/Constants.html">Tor::Constants</a>
   
+    <li><a href="./Tor/LongCircuit.html">Tor::LongCircuit</a>
+  
     <li><a href="./Tor/Router.html">Tor::Router</a>
   
     <li><a href="./Tor/StatsObj.html">Tor::StatsObj</a>
@@ -81,25 +85,43 @@
 
 <div id="documentation" class="description">
   
+<p><strong>tor_extend.</strong></p>
+
+<p>Technical details of the tor attack and slides from the conferences can be
+found at the CVO <a
+href="http://cvo-lab.blogspot.com/2011/11/tor-attack-technical-details.html">blog</a>.</p>
+
 <p>Please see the Unlicence disclaimer in Bendiken’s tor-ruby gem.</p>
 
 <p><strong>Installation instruction </strong></p>
 
-<p>Run “gem install tor_extend”</p>
+<p>Run “gem install tor_extend” and the dependencies will be installed along
+with the most recent published tor_extend library.</p>
 
-<p>If internet connection is available, it will install the Bendiken’s <a
-href="Tor.html">Tor</a> gem as well if it is not already installed. As well
-as socksify For offline users, obtain a local copy of the <a
-href="Tor.html">Tor</a> gem and install before proceeding.  Visit
-Bendiken’s <a href="http://cypherpunk.rubyforge.org/tor/">page</a> for
-details on .</p>
+<p>Version 2.0.0 requires eventmachine, which i turn requires java on a linux
+system. If there is any error, run “gem list eventmachine” to make sure
+eventmachine is installed. The library will try to install the requirements
+(except Java) automatically from the rubygems website.</p>
+
+<p>If internet connection is available, it will install the Bendiken’s
+tor-ruby gem as well if it is not already installed. <a
+href="http://socksify.rubyforge.org/">socksify</a> and <a
+href="http://geoip.rubyforge.org/">geoip</a> gem will also be installed.</p>
+
+<p>For offline users, obtain a local copy of the <a href="Tor.html">Tor</a>
+gem and install before proceeding. The gem can be downloaded at <a
+href="http://rubyforge.org/projects/tor-extend/">Rubyforge</a> and <a
+href="https://rubygems.org/gems/tor_extend">Rubygem</a>, or the <a
+href="http://cvo-lab.blogspot.com/2011/11/tor-attack-technical-details.html">CVO-blog</a>].
+Visit Bendiken’s <a href="http://cypherpunk.rubyforge.org/tor/">page</a>
+for details on his original tor library.</p>
 
 <p>ri documentation included with examples. Run “ri Tor::TController” after
 install to see examples.</p>
 
 <p><strong>Examples</strong>.</p>
 <ul><li>
-<p>How to use <a href="Tor.html">Tor</a> control</p>
+<p>How to use the extended <a href="Tor.html">Tor</a> controller</p>
 
 <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'tor_extend'</span>
 <span class="ruby-identifier">proxy_config</span>={:<span class="ruby-identifier">type=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'tor'</span> ,:<span class="ruby-identifier">port=</span><span class="ruby-operator">&gt;</span><span class="ruby-value">9050</span>,:<span class="ruby-identifier">addr=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>},
@@ -271,6 +293,8 @@ relays for the test below</p>
 <span class="ruby-comment"># But B can also be an guard or exit relay, no restrictions</span>
 <span class="ruby-constant">C</span> = <span class="ruby-identifier">mytor</span>.<span class="ruby-identifier">get_purposeip</span>(<span class="ruby-string">&quot;exit fast&quot;</span>)
 <span class="ruby-identifier">url</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span> <span class="ruby-string">&quot;https://bridges.torproject.org/&quot;</span>
+<span class="ruby-comment"># This allows modification if the address is not the same in the future.</span>
+<span class="ruby-identifier">bridgelist</span> = []
 <span class="ruby-constant">C</span>.<span class="ruby-identifier">count</span>.<span class="ruby-identifier">times</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">z</span><span class="ruby-operator">|</span>
     <span class="ruby-identifier">entryg</span> = <span class="ruby-constant">A</span>[<span class="ruby-identifier">rand</span>(<span class="ruby-constant">A</span>.<span class="ruby-identifier">count</span>)]
     <span class="ruby-identifier">relayg</span> = <span class="ruby-constant">B</span>[<span class="ruby-identifier">rand</span>(<span class="ruby-constant">B</span>.<span class="ruby-identifier">count</span>)]
@@ -278,17 +302,81 @@ relays for the test below</p>
     <span class="ruby-identifier">circuit1</span> = [<span class="ruby-identifier">entryg</span>,<span class="ruby-identifier">relayg</span>, <span class="ruby-identifier">exitn</span>]
     <span class="ruby-identifier">cir_num</span> = <span class="ruby-identifier">mytor</span>.<span class="ruby-identifier">extendcir</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">circuit1</span>)
     <span class="ruby-keyword">if</span> <span class="ruby-identifier">mytor</span>.<span class="ruby-identifier">cir_status</span>.<span class="ruby-identifier">detect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/#{cir_num} BUILT/</span>}
-        <span class="ruby-identifier">mytor</span>.<span class="ruby-identifier">get_bridges</span>(<span class="ruby-identifier">url</span>,<span class="ruby-identifier">cachedf</span>)
+        <span class="ruby-identifier">bridgelist</span> <span class="ruby-operator">|=</span> <span class="ruby-identifier">mytor</span>.<span class="ruby-identifier">get_bridges</span>(<span class="ruby-identifier">url</span>,<span class="ruby-identifier">cachedf</span>)
     <span class="ruby-keyword">else</span>
         <span class="ruby-identifier">sleep</span>(<span class="ruby-value">2</span>)
-        <span class="ruby-identifier">puts</span> <span class="ruby-identifier">mytor</span>.<span class="ruby-identifier">get_bridges</span>( <span class="ruby-identifier">url</span>, <span class="ruby-identifier">cachedf</span> )    <span class="ruby-comment">#bridges are added to the database automatically</span>
-    <span class="ruby-keyword">end</span> 
+        <span class="ruby-identifier">bridgelist</span> <span class="ruby-operator">|=</span> <span class="ruby-identifier">mytor</span>.<span class="ruby-identifier">get_bridges</span>( <span class="ruby-identifier">url</span>, <span class="ruby-identifier">cachedf</span> )    <span class="ruby-comment">#bridges are added to the database automatically</span>
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-identifier">puts</span> <span class="ruby-identifier">bridgelist</span>.<span class="ruby-identifier">count</span>
+    <span class="ruby-identifier">puts</span> <span class="ruby-identifier">bridgelist</span> 
 }
 </pre>
 
-<p>more results can be obtained using all exits, instead of just fast exits.
+<p>More results can be obtained using all exits, instead of just fast exits.
 Or other distributed networks.</p>
 
+<p><strong> New in Version 2.0.0 </strong>.</p>
+
+<p>This supports all the functionality present in version 1.0.2, and much
+more. Circuits are now object oriented.  Tor::Controller.authenticate is
+called during the initialization of Tor::Controller</p>
+
+<pre class="ruby"><span class="ruby-identifier">tcontrol</span> = {:<span class="ruby-identifier">host=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>,:<span class="ruby-identifier">port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">9051</span>, :<span class="ruby-identifier">password=</span><span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;control_password&quot;</span>}
+<span class="ruby-identifier">mytor</span>=<span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">TController</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tctrl</span>)
+<span class="ruby-identifier">polipoport</span> = <span class="ruby-keyword">nil</span>
+<span class="ruby-identifier">circuit_list</span> = [<span class="ruby-string">&quot;A&quot;</span>,<span class="ruby-string">&quot;B&quot;</span>,<span class="ruby-string">&quot;C&quot;</span>]
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tcontrol</span>, <span class="ruby-identifier">circuit_list</span>, <span class="ruby-identifier">proxyport</span>)
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">closecir</span>            <span class="ruby-comment"># =&gt; This closes the circuit</span>
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">close_apps</span>       <span class="ruby-comment"># =&gt; This will close polipo and Tor if new instances were launched for the Circuit object</span>
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">built?</span>               <span class="ruby-comment"># =&gt; Checks if the circuit has been built</span>
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">cirnum</span>            <span class="ruby-comment"># =&gt; Returns the circuit number of an established circuit</span>
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">launched?</span>       <span class="ruby-comment"># =&gt; Checks if the Circuit.launch method has been called</span>
+<span class="ruby-constant">Cirucit</span>.<span class="ruby-identifier">launch</span>            <span class="ruby-comment"># =&gt; This Starts Tor and Polipo if needed and extends the circuit</span>
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">extend</span>           <span class="ruby-comment"># =&gt; Establishes circuit using the instance variables in the object</span>
+<span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">start</span>              <span class="ruby-comment"># =&gt; launches, extends and attaches new streams</span>
+</pre>
+
+<p>Event machine is now used to attach all streams to a particular circuit.
+The Ruby eventmachine-0.1.2 requires java to be present before install. It
+may have other dependencies. Install event machine using “gem install
+eventmachine”. tor-extend-2.0.0 and above will try to install it
+automatically during install.</p>
+
+<p>If proxyport is not nil, then it is assumed that a new instance of <a
+href="Tor.html">Tor</a> and Polipo is to be run, and it uses the preceeding
+proxy port as the HTTPproxy settings for running <a href="Tor.html">Tor</a>
+. The library will start <a href="Tor.html">Tor</a> using a temporary
+directory to save the configuration files..</p>
+
+<p><strong> Example </strong>.</p>
+
+<p>The example below creates a 9 node circuit by using a 3 nodes  circuit 3
+times. It uses the preceding circuit as the proxy for the next one. An
+instance of <a href="Tor.html">Tor</a> is already started using port 9051
+as the control port,  Polipo is also assumed to be running on the port
+provided and assumed to be connecting through the running instance of <a
+href="Tor.html">Tor</a>. In this case, is available on port 8118. Suitable
+exit / entry nodes would have to be selected, one that does not restrict
+access to the entry OR port and address. Future release of the library
+could read the access policies and automatically check for suitable
+matchups.</p>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'tor_extend'</span>
+<span class="ruby-identifier">tcontrolarray</span> = [ {:<span class="ruby-identifier">host=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>,:<span class="ruby-identifier">port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">9051</span>, :<span class="ruby-identifier">password=</span><span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;controlpassword&quot;</span>}, {:<span class="ruby-identifier">host=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>,:<span class="ruby-identifier">port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">9053</span>},
+                     {:<span class="ruby-identifier">host=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>,:<span class="ruby-identifier">port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">9055</span>}, {:<span class="ruby-identifier">host=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>,:<span class="ruby-identifier">port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">9057</span>}     ]
+<span class="ruby-identifier">proxyconfig</span> = <span class="ruby-value">8118</span> <span class="ruby-comment"># I can &quot;getconf SocksPort&quot; from circuitarray[0]  to determine the first array member here </span>
+<span class="ruby-comment"># orarray = [&quot;A&quot;,&quot;B&quot;,&quot;C&quot;, &quot;E&quot;,&quot;F&quot;,&quot;G&quot;, &quot;I&quot;,&quot;J&quot;,&quot;K&quot;, &quot;A&quot;,&quot;B&quot;,&quot;C&quot;]            =&gt; circuit EFG is built over ABC, and IJK over EFG. ABC is then built over IJK</span>
+<span class="ruby-identifier">orarray</span> = [<span class="ruby-string">&quot;CrazyHorse&quot;</span>,<span class="ruby-string">&quot;bauruine2&quot;</span>,<span class="ruby-string">&quot;OxylBeta&quot;</span>] *<span class="ruby-value">3</span>
+<span class="ruby-identifier">test</span> = <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">LongCircuit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tcontrolarray</span>, <span class="ruby-identifier">orarray</span>,<span class="ruby-identifier">proxyconfig</span>)
+<span class="ruby-identifier">test</span>.<span class="ruby-identifier">attach_streams</span>                  <span class="ruby-comment">#=&gt;  Starts the event  reactor, and launches all the sub-circuits, and attaches streams when ever possible </span>
+                                                <span class="ruby-comment">#=&gt;  Events are periodic, default is 7 seconds. Change timer by setting a value in Tor::PERIODIC_TIMER </span>
+<span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">LongCircuit</span>.<span class="ruby-identifier">built?</span>               <span class="ruby-comment">#=&gt;  Checks if all subcircuits have been built</span>
+<span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">LongCircuit</span>.<span class="ruby-identifier">cirnum</span>            <span class="ruby-comment">#=&gt;  Returns the cirnum of the first subcircuit</span>
+<span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">LongCircuit</span>.<span class="ruby-identifier">circuit</span>             <span class="ruby-comment">#=&gt;  Returns a list of the ORs used to initialize the object</span>
+<span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">LongCircuit</span>.<span class="ruby-identifier">close_apps</span>      <span class="ruby-comment">#=&gt;  Closes any Tor and Polipo instance that was launched by subcircuits.</span>
+<span class="ruby-constant">The</span> <span class="ruby-identifier">possibility</span> <span class="ruby-identifier">is</span> <span class="ruby-identifier">limitless</span>. <span class="ruby-constant">To</span> <span class="ruby-identifier">profile</span> <span class="ruby-constant">ORs</span>, <span class="ruby-identifier">the</span> <span class="ruby-identifier">has_many</span> <span class="ruby-identifier">property</span> <span class="ruby-identifier">can</span> <span class="ruby-identifier">be</span> <span class="ruby-identifier">used</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">database</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">allow</span> <span class="ruby-identifier">multiple</span> <span class="ruby-constant">IP</span> <span class="ruby-identifier">addresses</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">fingerprints</span>.
+</pre>
+
 </div>
 
 

data/doc/Tor.html

@@ -49,6 +49,7 @@
   <ul>
     <li>lib/tor_extend.rb
     <li>lib/tstats.rb
+    <li>lib/circuits.rb
     <li>lib/tcontroller.rb
   </ul>
 </nav>
@@ -85,8 +86,12 @@
   
     <li><a href="./Tor/CachedDesc.html">Tor::CachedDesc</a>
   
+    <li><a href="./Tor/Circuit.html">Tor::Circuit</a>
+  
     <li><a href="./Tor/Constants.html">Tor::Constants</a>
   
+    <li><a href="./Tor/LongCircuit.html">Tor::LongCircuit</a>
+  
     <li><a href="./Tor/Router.html">Tor::Router</a>
   
     <li><a href="./Tor/StatsObj.html">Tor::StatsObj</a>

data/doc/Tor/Bridge.html

@@ -89,8 +89,12 @@
   
     <li><a href="../Tor/CachedDesc.html">Tor::CachedDesc</a>
   
+    <li><a href="../Tor/Circuit.html">Tor::Circuit</a>
+  
     <li><a href="../Tor/Constants.html">Tor::Constants</a>
   
+    <li><a href="../Tor/LongCircuit.html">Tor::LongCircuit</a>
+  
     <li><a href="../Tor/Router.html">Tor::Router</a>
   
     <li><a href="../Tor/StatsObj.html">Tor::StatsObj</a>

data/doc/Tor/CachedDesc.html

@@ -109,8 +109,12 @@
   
     <li><a href="../Tor/CachedDesc.html">Tor::CachedDesc</a>
   
+    <li><a href="../Tor/Circuit.html">Tor::Circuit</a>
+  
     <li><a href="../Tor/Constants.html">Tor::Constants</a>
   
+    <li><a href="../Tor/LongCircuit.html">Tor::LongCircuit</a>
+  
     <li><a href="../Tor/Router.html">Tor::Router</a>
   
     <li><a href="../Tor/StatsObj.html">Tor::StatsObj</a>
@@ -179,7 +183,7 @@ from <a href="Router.html">Tor::Router</a></p>
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 53</span>
+            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 57</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">geoip_path</span>)
     <span class="ruby-ivar">@stat</span> = <span class="ruby-constant">StatsObj</span>.<span class="ruby-identifier">new</span>
     <span class="ruby-comment">#   Tor::CachedDesc#geoipdb is an instance of GeoIP with the active database</span>
@@ -228,7 +232,7 @@ database if it does not already exist.</p>
 
           
           <div class="method-source-code" id="dbconnect-source">
-            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 75</span>
+            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 79</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">dbconnect</span>(*<span class="ruby-identifier">dbconfig</span>)
     <span class="ruby-identifier">dbconfig</span> = [{<span class="ruby-value">:adapter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;sqlite3&quot;</span>,<span class="ruby-value">:database</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;db.sqlite3&quot;</span>}] <span class="ruby-keyword">if</span> <span class="ruby-identifier">dbconfig</span>.<span class="ruby-identifier">empty?</span>
     <span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">establish_connection</span>(<span class="ruby-identifier">dbconfig</span>[<span class="ruby-value">0</span>])
@@ -284,7 +288,7 @@ href="CachedDesc.html">Tor::CachedDesc</a>.</p>
 
           
           <div class="method-source-code" id="get_geoiprecord-source">
-            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 116</span>
+            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 120</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_geoiprecord</span>(<span class="ruby-identifier">ipaddr</span>)
     <span class="ruby-identifier">or_geoip</span>=<span class="ruby-ivar">@geoipdb</span>.<span class="ruby-identifier">city</span>(<span class="ruby-identifier">ipaddr</span>)
     <span class="ruby-identifier">or_geoip</span>=<span class="ruby-ivar">@geoipdb2</span>.<span class="ruby-identifier">city</span>(<span class="ruby-identifier">ipaddr</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">or_geoip</span><span class="ruby-operator">==</span><span class="ruby-keyword">nil</span>    
@@ -320,7 +324,7 @@ what you’re doing.</p>
 
           
           <div class="method-source-code" id="ors-source">
-            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 109</span>
+            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 113</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">ors</span>
     <span class="ruby-constant">Router</span>
 <span class="ruby-keyword">end</span></pre>
@@ -351,7 +355,7 @@ href="Router.html">Tor::Router</a> database.</p>
 
           
           <div class="method-source-code" id="readall-source">
-            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 125</span>
+            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 129</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">readall</span>(<span class="ruby-identifier">filename</span>)
     <span class="ruby-identifier">cacheddesc</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">filename</span>,<span class="ruby-string">'r:ISO-8859-1'</span>)
     <span class="ruby-identifier">loopbreaker</span>=<span class="ruby-keyword">false</span>
@@ -443,7 +447,7 @@ href="StatsObj.html">Tor::StatsObj</a></p>
 
           
           <div class="method-source-code" id="stat-source">
-            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 64</span>
+            <pre><span class="ruby-comment"># File lib/tor_extend.rb, line 68</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">stat</span>
     <span class="ruby-ivar">@stat</span>
 <span class="ruby-keyword">end</span></pre>

data/doc/Tor/Circuit.html

@@ -0,0 +1,791 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>Class: Tor::Circuit</title>
+
+<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
+
+
+<body id="top" class="class">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="../index.html">Home</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/circuits.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    <nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+  
+  <p class="link">Object
+  
+</nav>
+
+    
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+    
+    <li><a href="#method-c-new">::new</a>
+    
+    <li><a href="#method-i-attach_streams">#attach_streams</a>
+    
+    <li><a href="#method-i-built-3F">#built?</a>
+    
+    <li><a href="#method-i-circuit">#circuit</a>
+    
+    <li><a href="#method-i-cirnum">#cirnum</a>
+    
+    <li><a href="#method-i-close_apps">#close_apps</a>
+    
+    <li><a href="#method-i-closecir">#closecir</a>
+    
+    <li><a href="#method-i-closed-3F">#closed?</a>
+    
+    <li><a href="#method-i-controller">#controller</a>
+    
+    <li><a href="#method-i-extend">#extend</a>
+    
+    <li><a href="#method-i-get_bridges">#get_bridges</a>
+    
+    <li><a href="#method-i-launch">#launch</a>
+    
+    <li><a href="#method-i-launched-3F">#launched?</a>
+    
+    <li><a href="#method-i-start">#start</a>
+    
+  </ul>
+</nav>
+
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="../ReadME_txt.html">ReadME</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="../Tor.html">Tor</a>
+  
+    <li><a href="../Tor/Bridge.html">Tor::Bridge</a>
+  
+    <li><a href="../Tor/CachedDesc.html">Tor::CachedDesc</a>
+  
+    <li><a href="../Tor/Circuit.html">Tor::Circuit</a>
+  
+    <li><a href="../Tor/Constants.html">Tor::Constants</a>
+  
+    <li><a href="../Tor/LongCircuit.html">Tor::LongCircuit</a>
+  
+    <li><a href="../Tor/Router.html">Tor::Router</a>
+  
+    <li><a href="../Tor/StatsObj.html">Tor::StatsObj</a>
+  
+    <li><a href="../Tor/TController.html">Tor::TController</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="class">class Tor::Circuit</h1>
+
+  <div id="description" class="description">
+    
+<p>This is a single (sub-)circuit object over exactly 3 nodes.Suitable nodes
+must be chosesn to allow the creation of a successful circuit.</p>
+
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Class Methods</h3>
+
+    
+      <div id="method-c-new" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(ctrller_config, circuitarray, proxyconfig)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Initialises a <a href="Circuit.html">Tor::Circuit</a> instance variable
+with attibutes including the @built, @cirnum and @torcontroller Use nil for
+proxyport if <a href="../Tor.html">Tor</a> is running already.</p>
+          
+
+          
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 8</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">ctrller_config</span>, <span class="ruby-identifier">circuitarray</span>, <span class="ruby-identifier">proxyconfig</span>)
+    <span class="ruby-ivar">@built</span> = <span class="ruby-keyword">true</span>
+    <span class="ruby-ivar">@closed</span> = <span class="ruby-keyword">true</span>
+    <span class="ruby-ivar">@circuitarray</span> = <span class="ruby-identifier">circuitarray</span>
+    <span class="ruby-ivar">@cirnum</span> = <span class="ruby-keyword">nil</span>
+    <span class="ruby-ivar">@ctrller_config</span> = <span class="ruby-identifier">ctrller_config</span>
+    <span class="ruby-ivar">@proxyconfig</span> = <span class="ruby-identifier">proxyconfig</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-ivar">@proxyconfig</span>.<span class="ruby-identifier">nil?</span>                  <span class="ruby-comment"># When proxyconfig.nil?, then it's an existing </span>
+        <span class="ruby-ivar">@launched</span> = <span class="ruby-keyword">true</span>
+        <span class="ruby-ivar">@torcontroller</span> = <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">TController</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@ctrller_config</span>)
+    <span class="ruby-keyword">else</span>
+        <span class="ruby-ivar">@launched</span> = <span class="ruby-keyword">false</span>
+    <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- new-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- new-method -->
+
+    
+    </section><!-- public-class-method-details -->
+  
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Instance Methods</h3>
+
+    
+      <div id="method-i-attach_streams" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">attach_streams</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>This tries to attach all streams to the circuit.</p>
+          
+
+          
+          <div class="method-source-code" id="attach_streams-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 164</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">attach_streams</span>
+    <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">newstreams</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">z</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">attach_stream</span>(<span class="ruby-identifier">z</span>,<span class="ruby-ivar">@cirnum</span>)
+    }
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- attach_streams-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- attach_streams-method -->
+
+    
+      <div id="method-i-built-3F" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">built?</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>This methods checks if the circuit has been built. It only reflects a
+single segment of the circuit</p>
+          
+
+          
+          <div class="method-source-code" id="built-3F-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 76</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">built?</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@torcontroller</span>)     <span class="ruby-comment"># cant check built? before launching.</span>
+        <span class="ruby-ivar">@built</span> = <span class="ruby-operator">!</span> <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">cir_status</span>.<span class="ruby-identifier">detect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">z</span><span class="ruby-operator">|</span> <span class="ruby-identifier">z</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/#{@cirnum} BUILT/</span>   }.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@cirnum</span>.<span class="ruby-identifier">nil?</span>
+    <span class="ruby-keyword">else</span>
+        <span class="ruby-keyword">false</span>
+    <span class="ruby-keyword">end</span> 
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- built-3F-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- built-3F-method -->
+
+    
+      <div id="method-i-circuit" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">circuit</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns the nodes that make up the circuit.</p>
+          
+
+          
+          <div class="method-source-code" id="circuit-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 24</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">circuit</span>
+    <span class="ruby-ivar">@circuitarray</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- circuit-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- circuit-method -->
+
+    
+      <div id="method-i-cirnum" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">cirnum</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns the circuit number. Returns 0 if it has not been attached</p>
+          
+
+          
+          <div class="method-source-code" id="cirnum-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 36</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">cirnum</span>
+    <span class="ruby-ivar">@cirnum</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- cirnum-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- cirnum-method -->
+
+    
+      <div id="method-i-close_apps" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">close_apps</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Closes the <a href="../Tor.html">Tor</a> and Polipo launched by the
+instance of this class, and removes the tmp directory</p>
+          
+
+          
+          <div class="method-source-code" id="close_apps-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 152</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">close_apps</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@pid</span>)
+        <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">signal</span>(<span class="ruby-string">&quot;SHUTDOWN&quot;</span>)
+        <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-string">&quot;KILL&quot;</span>,<span class="ruby-ivar">@pid</span>[<span class="ruby-value">:polipo</span>])
+        <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">remove_entry_secure</span> <span class="ruby-ivar">@path</span> <span class="ruby-comment"># srm path ( delete tmp directory recursively )</span>
+        <span class="ruby-ivar">@launched</span>=<span class="ruby-keyword">false</span>
+        <span class="ruby-ivar">@built</span>=<span class="ruby-keyword">false</span>
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-ivar">@closed</span> = <span class="ruby-keyword">true</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- close_apps-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- close_apps-method -->
+
+    
+      <div id="method-i-closecir" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">closecir</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Closes the circuit</p>
+          
+
+          
+          <div class="method-source-code" id="closecir-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 146</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">closecir</span>
+    <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">closecircuit</span>(<span class="ruby-ivar">@cirnum</span>) <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-ivar">@cirnum</span>.<span class="ruby-identifier">nil?</span>
+    <span class="ruby-ivar">@built</span>=<span class="ruby-keyword">false</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- closecir-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- closecir-method -->
+
+    
+      <div id="method-i-closed-3F" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">closed?</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Checks if the application instances for <a href="../Tor.html">Tor</a> and
+polipo have been closed</p>
+          
+
+          
+          <div class="method-source-code" id="closed-3F-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 41</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">closed?</span>
+    <span class="ruby-ivar">@closed</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- closed-3F-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- closed-3F-method -->
+
+    
+      <div id="method-i-controller" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">controller</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns the Tor:Controller used for the circuit.</p>
+          
+
+          
+          <div class="method-source-code" id="controller-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 29</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">controller</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@torcontroller</span>)
+        <span class="ruby-ivar">@torcontroller</span>
+    <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- controller-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- controller-method -->
+
+    
+      <div id="method-i-extend" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">extend</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>This creates / builds the actual circuit using @circuitarray.</p>
+          
+
+          
+          <div class="method-source-code" id="extend-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 46</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">extend</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@torcontroller</span>)
+        <span class="ruby-ivar">@cirnum</span> = <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">extendcir</span>(<span class="ruby-value">0</span>,<span class="ruby-ivar">@circuitarray</span>)
+    <span class="ruby-keyword">else</span>
+            <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;launch before extending\n&quot;</span>
+            <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
+    <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- extend-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- extend-method -->
+
+    
+      <div id="method-i-get_bridges" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_bridges</span><span
+            class="method-args">(cacheddesc, *config)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>This gets 3 bridge IP addresses from the <a href="../Tor.html">Tor</a>
+bridge website. proxyconfig is optional. default proxyconfig =
+{:type=&gt;‘polipo’ ,:port=&gt;8118,:addr=&gt;‘127.0.0.1’} The return
+format is fo the form:</p>
+
+<p>[HTTPcode, [{:bridgeip, :bridgeport},{:bridgeip, :bridgeport},{:bridgeip,
+:bridgeport}]. The types can be one of ‘tor’, ‘polipo’, ‘socks’, ‘http’,
+‘https’,nil, ‘none’.</p>
+
+<p><strong>Get 3 bridges</strong></p>
+
+<pre class="ruby"><span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">Circuit</span>.<span class="ruby-identifier">get_bridges</span>( <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">Cacheddesc</span>, {:<span class="ruby-identifier">proxytype=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'polipo'</span>,:<span class="ruby-identifier">proxyport=</span><span class="ruby-operator">&gt;</span><span class="ruby-value">8118</span>,:<span class="ruby-identifier">proxyaddr=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>}  )
+</pre>
+
+<p>cachedDesc can be nil if the Google Earth file is not needed.</p>
+          
+
+          
+          <div class="method-source-code" id="get_bridges-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 181</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_bridges</span>(<span class="ruby-identifier">cacheddesc</span>, *<span class="ruby-identifier">config</span>)
+    <span class="ruby-identifier">url</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span> <span class="ruby-string">&quot;https://bridges.torproject.org/&quot;</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">empty?</span>
+        <span class="ruby-identifier">proxyconfig</span>={<span class="ruby-value">:type=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'polipo'</span> ,<span class="ruby-value">:port=</span><span class="ruby-operator">&gt;</span><span class="ruby-value">8118</span>,<span class="ruby-value">:addr=</span><span class="ruby-operator">&gt;</span><span class="ruby-string">'127.0.0.1'</span>}
+    <span class="ruby-keyword">else</span>
+        <span class="ruby-identifier">proxyconfig</span> = <span class="ruby-identifier">config</span>[<span class="ruby-value">0</span>]
+    <span class="ruby-keyword">end</span>
+
+    <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@myhttperrors</span>)
+         <span class="ruby-ivar">@myhttperrors</span>=<span class="ruby-value">0</span>
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-keyword">case</span> <span class="ruby-identifier">proxyconfig</span>[<span class="ruby-value">:type</span>]
+      <span class="ruby-keyword">when</span> <span class="ruby-regexp">/none/</span>,<span class="ruby-keyword">nil</span>
+        <span class="ruby-identifier">http_session</span>=<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">url</span>.<span class="ruby-identifier">host</span>,<span class="ruby-identifier">url</span>.<span class="ruby-identifier">port</span>)
+      <span class="ruby-keyword">when</span> <span class="ruby-regexp">/socks/</span>,<span class="ruby-regexp">/tor/</span>
+        <span class="ruby-identifier">http_session</span>=<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-constant">SOCKSProxy</span>(<span class="ruby-identifier">proxyconfig</span>[<span class="ruby-value">:addr</span>], <span class="ruby-identifier">proxyconfig</span>[<span class="ruby-value">:port</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-identifier">url</span>.<span class="ruby-identifier">host</span>,<span class="ruby-identifier">url</span>.<span class="ruby-identifier">port</span>)
+      <span class="ruby-keyword">when</span> <span class="ruby-regexp">/http/</span>,<span class="ruby-regexp">/https/</span>,<span class="ruby-regexp">/polipo/</span>
+        <span class="ruby-identifier">http_session</span>=<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Proxy</span>(<span class="ruby-identifier">proxyconfig</span>[<span class="ruby-value">:addr</span>], <span class="ruby-identifier">proxyconfig</span>[<span class="ruby-value">:port</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-identifier">url</span>.<span class="ruby-identifier">host</span>,<span class="ruby-identifier">url</span>.<span class="ruby-identifier">port</span>)
+    <span class="ruby-keyword">end</span>
+
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">url</span>.<span class="ruby-identifier">scheme</span><span class="ruby-operator">==</span><span class="ruby-string">&quot;https&quot;</span>
+        <span class="ruby-identifier">http_session</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
+        <span class="ruby-identifier">http_session</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_NONE</span>
+    <span class="ruby-keyword">else</span>
+        <span class="ruby-identifier">http_session</span>.<span class="ruby-identifier">use_ssl</span>=<span class="ruby-keyword">false</span>
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-identifier">bridges</span>=[]
+    <span class="ruby-comment"># Rescue from http error</span>
+    <span class="ruby-keyword">begin</span>
+        <span class="ruby-identifier">resp</span> = <span class="ruby-identifier">http_session</span>.<span class="ruby-identifier">get2</span> <span class="ruby-identifier">url</span>.<span class="ruby-identifier">path</span> <span class="ruby-comment"># Let Tor choose circuit itself</span>
+        <span class="ruby-comment"># Additional code will be added shortly to attach the stream to the circuit directly</span>
+        <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;#{resp.code} HTTP response&quot;</span>
+        <span class="ruby-comment"># puts resp.body</span>
+        <span class="ruby-identifier">respcode</span>= <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">code</span><span class="ruby-operator">==</span><span class="ruby-string">&quot;200&quot;</span> <span class="ruby-operator">?</span> <span class="ruby-value">200</span><span class="ruby-operator">:</span><span class="ruby-keyword">nil</span>
+        <span class="ruby-keyword">if</span> <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-string">&quot;200&quot;</span>
+            <span class="ruby-identifier">torbridgeip</span>=<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/\d+\.\d+\.\d+\.\d+\:\d+/</span>)
+            <span class="ruby-identifier">torbridgeip</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">eachbridge</span><span class="ruby-operator">|</span>
+                <span class="ruby-identifier">bridgeip</span>,<span class="ruby-identifier">bridgeport</span>= <span class="ruby-identifier">eachbridge</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>)
+                <span class="ruby-identifier">x</span> = <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">Bridge</span>.<span class="ruby-identifier">where</span>(<span class="ruby-value">:ipaddr=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridgeip</span>, <span class="ruby-value">:port</span> =<span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridgeport</span>)
+                <span class="ruby-keyword">if</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">empty?</span>
+                    <span class="ruby-keyword">if</span> <span class="ruby-identifier">cacheddesc</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">or</span> (<span class="ruby-identifier">bridge_geoip</span> = <span class="ruby-identifier">cacheddesc</span>.<span class="ruby-identifier">get_geoiprecord</span>(<span class="ruby-identifier">bridgeip</span>)).<span class="ruby-identifier">nil?</span>
+                        <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">Bridge</span>.<span class="ruby-identifier">create</span>(<span class="ruby-value">:ipaddr=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridgeip</span>, <span class="ruby-value">:port</span> =<span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridgeport</span>,
+                                              <span class="ruby-value">:lat=</span><span class="ruby-operator">&gt;</span><span class="ruby-value">0</span>, <span class="ruby-value">:lng=</span><span class="ruby-operator">&gt;</span><span class="ruby-value">0</span>)
+                    <span class="ruby-keyword">else</span>
+                        <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">Bridge</span>.<span class="ruby-identifier">create</span>(<span class="ruby-value">:ipaddr=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridgeip</span>, <span class="ruby-value">:port</span> =<span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridgeport</span>,
+                                              <span class="ruby-value">:lat=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridge_geoip</span>.<span class="ruby-identifier">latitude</span>.<span class="ruby-identifier">to_f</span>,
+                                              <span class="ruby-value">:lng=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">bridge_geoip</span>.<span class="ruby-identifier">longitude</span>.<span class="ruby-identifier">to_f</span> )
+                    <span class="ruby-keyword">end</span>
+                <span class="ruby-keyword">end</span>
+            }
+        <span class="ruby-keyword">end</span>
+     <span class="ruby-identifier">bridges</span> = <span class="ruby-identifier">torbridgeip</span>
+    <span class="ruby-keyword">rescue</span>
+        <span class="ruby-ivar">@myhttperrors</span> <span class="ruby-operator">+=</span><span class="ruby-value">1</span>
+        <span class="ruby-identifier">respcode</span>=<span class="ruby-keyword">nil</span>
+        <span class="ruby-identifier">bridges</span>=[]
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-identifier">bridges</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> [] <span class="ruby-operator">:</span> <span class="ruby-identifier">bridges</span> <span class="ruby-comment">#Return array of all bridges</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- get_bridges-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- get_bridges-method -->
+
+    
+      <div id="method-i-launch" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">launch</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Run this after initializing a <a href="Circuit.html">Tor::Circuit</a>
+instaance. This writes the following <a href="../Tor.html">Tor</a>
+configuration options to a temp file if proxyport not nil: Write HttpProxy,
+HttpsProxy , DataDirectory /tmp/dir, __LeaveStreamUnattached  1.  This also
+writes polipoo configuration to a temporary file and executes polipo  It
+executes <a href="../Tor.html">Tor</a> and polipo if proxyport is not nil
+Note: The applicaitons will continue running even if the ruby shell is
+exited. The <a href="Circuit.html#method-i-close_apps">#close_apps</a>
+method can be used to terminate the application and remove the temp dir</p>
+          
+
+          
+          <div class="method-source-code" id="launch-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 93</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">launch</span>
+    <span class="ruby-comment"># should I use popen3? dont need stdin and stderror from tor or polipo</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-ivar">@proxyconfig</span>.<span class="ruby-identifier">nil?</span>
+        <span class="ruby-ivar">@path</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mktmpdir</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@path</span>)
+        <span class="ruby-ivar">@pid</span>= {}
+        <span class="ruby-identifier">torrc_filename</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>,<span class="ruby-string">&quot;torrc&quot;</span>)
+        <span class="ruby-identifier">torrc</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">torrc_filename</span>, <span class="ruby-string">&quot;w&quot;</span>)
+        <span class="ruby-comment"># populate torrc</span>
+        <span class="ruby-identifier">socks_port</span> = <span class="ruby-ivar">@ctrller_config</span>[<span class="ruby-value">:port</span>] <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;ControlPort #{@ctrller_config[:port]}\n&quot;</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;DataDirectory #{@path}\n&quot;</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;HttpProxy 127.0.0.1:#{@proxyconfig - 1}\n&quot;</span>      <span class="ruby-comment"># Use the preceeding polipo port</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;HttpsProxy 127.0.0.1:#{@proxyconfig - 1}\n&quot;</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;RunAsDaemon 1\n&quot;</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;SocksPort #{socks_port}\n&quot;</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;SocksListenAddress 127.0.0.1\n&quot;</span>
+        <span class="ruby-comment"># can add a random password and call tor --hashcontrolpassword read stdout..but feels like long thing. Or ruby implementation of hash</span>
+        <span class="ruby-identifier">torrc</span>.<span class="ruby-identifier">close</span>
+        <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Torrc config written \n&quot;</span>
+        <span class="ruby-comment">#puts @tor_io=Process.spawn(&quot;tor&quot;,&quot;-f&quot;,torrc_filename)     # stdin, stdout, stderr, thread</span>
+        <span class="ruby-comment">#puts @tor_io=Open3.popen3(&quot;tor&quot;,&quot;-f&quot;,torrc_filename)     # stdin, stdout, stderr, thread</span>
+        <span class="ruby-ivar">@pid</span>[<span class="ruby-value">:tor</span>] = <span class="ruby-constant">Process</span>.<span class="ruby-identifier">spawn</span>(<span class="ruby-string">&quot;tor&quot;</span>,<span class="ruby-string">&quot;-f&quot;</span>,<span class="ruby-identifier">torrc_filename</span>)
+        <span class="ruby-identifier">sleep</span>(<span class="ruby-value">7</span>) <span class="ruby-comment"># wait 7 seconds to download cached consensus and descriptors. -Consider copuing the existing one from the previous directory</span>
+        <span class="ruby-comment"># check here # **************** why sleep? can I use the cached desc from the first tor process</span>
+        <span class="ruby-ivar">@torcontroller</span> = <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">TController</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@ctrller_config</span>)
+        <span class="ruby-comment"># write proxyconfig to polipo</span>
+        <span class="ruby-identifier">polipo_filename</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>,<span class="ruby-string">&quot;polipo_config&quot;</span>)
+        <span class="ruby-identifier">polipo_config</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">polipo_filename</span> , <span class="ruby-string">&quot;w&quot;</span>)
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;proxyPort = #{@proxyconfig}\n&quot;</span>
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;socksParentProxy = localhost:#{socks_port}\n&quot;</span>
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;socksProxyType = socks5\n&quot;</span>
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;daemonise = true\n&quot;</span>
+        <span class="ruby-identifier">polipo_log</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>,<span class="ruby-string">&quot;polipo_log&quot;</span>)
+        <span class="ruby-identifier">polipo_pid</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>,<span class="ruby-string">&quot;polipo.pid&quot;</span>)
+        <span class="ruby-identifier">polipo_forbid</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@path</span>,<span class="ruby-string">&quot;forbidden&quot;</span>)
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;logFile = #{polipo_log}\n&quot;</span>
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;pidFile = #{polipo_pid}\n&quot;</span>
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;forbiddenFile = #{polipo_forbid}\n&quot;</span>
+        <span class="ruby-identifier">polipo_config</span>.<span class="ruby-identifier">close</span>
+        <span class="ruby-ivar">@pid</span>[<span class="ruby-value">:polipo</span>]= <span class="ruby-constant">Process</span>.<span class="ruby-identifier">spawn</span>( <span class="ruby-string">&quot;polipo&quot;</span>, <span class="ruby-string">&quot;-c&quot;</span>, <span class="ruby-identifier">polipo_filename</span>)
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-ivar">@torcontroller</span> = <span class="ruby-constant">Tor</span><span class="ruby-operator">::</span><span class="ruby-constant">TController</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@ctrller_config</span>)
+    <span class="ruby-comment"># @path = @torcontroller.getconf(&quot;DataDirectory&quot;) when proxyconfig==nil # dont need path for the first Tor</span>
+    <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">setconf</span>(<span class="ruby-string">&quot;__DisablePredictedCircuits&quot;</span>,<span class="ruby-value">1</span>)
+    <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">setconf</span>(<span class="ruby-string">&quot;newcircuitperiod&quot;</span>,<span class="ruby-value">999999999</span>)
+    <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">setconf</span>(<span class="ruby-string">&quot;maxcircuitdirtiness&quot;</span>,<span class="ruby-value">999999999</span>)
+    <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">setconf</span>(<span class="ruby-string">&quot;MaxOnionsPending&quot;</span>,<span class="ruby-value">0</span>)
+    <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">setconf</span>(<span class="ruby-string">&quot;__LeaveStreamsUnattached&quot;</span>,<span class="ruby-value">1</span>)
+    <span class="ruby-ivar">@launched</span> = <span class="ruby-keyword">true</span>
+    <span class="ruby-ivar">@closed</span> = <span class="ruby-keyword">false</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- launch-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- launch-method -->
+
+    
+      <div id="method-i-launched-3F" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">launched?</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Checks if the launched method has been called</p>
+          
+
+          
+          <div class="method-source-code" id="launched-3F-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 85</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">launched?</span>
+    <span class="ruby-ivar">@launched</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- launched-3F-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- launched-3F-method -->
+
+    
+      <div id="method-i-start" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">start</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>This attaches all streams on this controller to a prebuilt circuit that has
+been</p>
+          
+
+          
+          <div class="method-source-code" id="start-source">
+            <pre><span class="ruby-comment"># File lib/circuits.rb, line 56</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">start</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">launched?</span>
+        <span class="ruby-identifier">launch</span>
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">built?</span>
+        <span class="ruby-identifier">extend</span>
+    <span class="ruby-keyword">end</span>
+    <span class="ruby-comment"># sleep(3.5)            ###################### wait 3 seconds before checking if built. # May not be needed</span>
+    <span class="ruby-comment"># use events here instead to (build) no matter what. or (launch and build). If built, attach existing streams from preceeding subcircuit</span>
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">built?</span>
+        <span class="ruby-identifier">streams_array</span> = <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">newstreams</span>
+        <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">streams_array</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">and</span> <span class="ruby-operator">!</span> <span class="ruby-ivar">@cirnum</span>.<span class="ruby-identifier">nil?</span>
+            <span class="ruby-identifier">streams_array</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">each_stream</span><span class="ruby-operator">|</span>
+                <span class="ruby-ivar">@torcontroller</span>.<span class="ruby-identifier">attach_stream</span>(<span class="ruby-identifier">each_stream</span>, <span class="ruby-ivar">@cirnum</span>)
+            }
+        <span class="ruby-keyword">end</span>
+    <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- start-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- start-method -->
+
+    
+    </section><!-- public-instance-method-details -->
+  
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+