tormanager 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4f5f15e6d06ba9f2ea927a1a09e492cb06fcdb8
-  data.tar.gz: fcffe0b51611f91a85c4bd17407de5ee364acd98
+  metadata.gz: a1d766b2c286eacb7f7efa82f21dc1662e212f4d
+  data.tar.gz: 32410bc4be8b53b6b655bb769d670685bf822a98
 SHA512:
-  metadata.gz: f781d354d3d9a0ecc9740568c58fe308ae540b18ad63e6162dc46ea92e2dba5d71a0e9a789a79bf4c074c7b9019699ba69a8d034a122ffb33fe6dbd80a385b18
-  data.tar.gz: 09b546d6a5ce6f314b2de9972a283ae8043167e78988521346c67ea6de6333b0e653308fba1611d5a73366b1416b2b35ea9e687feb362087199c1cff5db216fa
+  metadata.gz: a82a54925256086092b0077286a4d550367281dcad947ffbe31aeb022643c215c34042fbf2ab2d75d63f76225d9eb24e8843792446a67a01f49f2116aada385b
+  data.tar.gz: f5abb39b3cec9703b81731696d8e9e36f1c3103f65ec47202b2436081e6b445e8b24a517d9b80439f02f1c1e913c82d96098f94dcaf5b8f78d2ef22e1fdcf2bd

data/lib/tormanager.rb

@@ -4,3 +4,4 @@ require "tormanager/control"
 require "tormanager/tor_process"
 require "tormanager/proxy"
 require "tormanager/ip_address_control"
+require "tormanager/create_eye_config"

data/lib/tormanager/create_eye_config.rb

@@ -0,0 +1,27 @@
+module TorManager
+  class CreateEyeConfig
+    def initialize params={}
+      @settings = params
+    end
+
+    def create
+      File.open(@settings[:eye_tor_config_path], "w") do |file|
+        file.puts read_eye_tor_config_template_and_substitute_keywords
+      end
+    end
+
+    private
+
+    def read_eye_tor_config_template_and_substitute_keywords
+      text = File.read(@settings[:eye_tor_config_template])
+      eye_tor_config_template_substitution_keywords.each do |keyword|
+        text = text.gsub(/\[\[\[#{keyword}\]\]\]/, @settings[keyword.to_sym].to_s)
+      end
+      text
+    end
+
+    def eye_tor_config_template_substitution_keywords
+      @settings.keys.map(&:to_s)
+    end
+  end
+end

data/lib/tormanager/ip_address_control.rb

@@ -1,6 +1,8 @@
 require 'rest-client'
 
 module TorManager
+  TorUnavailable = Class.new(StandardError)
+
   class IpAddressControl
     attr_accessor :ip
 
@@ -24,7 +26,7 @@ module TorManager
     private
 
     def ensure_tor_is_available
-      raise "Cannot proceed, Tor is not running on port " +
+      raise TorUnavailable, "Cannot proceed, Tor is not running on port " +
                 "#{@tor_process.settings[:tor_port]}" unless
           TorProcess.tor_running_on? port: @tor_process.settings[:tor_port],
               parent_pid: @tor_process.settings[:parent_pid]
@@ -70,7 +72,7 @@ module TorManager
 
     def tor_switch_endpoint
       Tor::Controller.connect(:port => @tor_process.settings[:control_port]) do |tor|
-        tor.authenticate("")
+        tor.authenticate(@tor_process.settings[:control_password])
         tor.signal("newnym")
         sleep 10
       end

data/lib/tormanager/process_helper.rb

@@ -1,6 +1,8 @@
 require 'socket'
 
 module TorManager
+  CannotKillProcess = Class.new(StandardError)
+
   class ProcessHelper
     class << self
       def query_process query
@@ -12,14 +14,14 @@ module TorManager
 
       def kill_process pids
         to_array(pids).each do |pid|
-          try_to_kill pid: pid, attempts: 5
+          try_to_kill pid: Integer(pid), attempts: 5
         end
       end
 
       def process_pid_running? pid
         begin
           return false if pid.to_s == ''.freeze
-          ipid = pid.to_i
+          ipid = Integer(pid)
           return false if ipid <= 0
           Process.kill(0, ipid)
           return true
@@ -63,12 +65,12 @@ module TorManager
       def try_to_kill params={}
         pid = params.fetch(:pid, nil)
         return unless pid && process_pid_running?(pid)
-        params.fetch(:attempts, 5).times do |k|
-          k < 3 ? Process.kill('TERM', pid) :
+        params.fetch(:attempts, 5).times do |i|
+          i < 3 ? Process.kill('TERM', pid) :
             Process.kill('KILL', pid)
           sleep 0.5
           break unless process_pid_running? pid
-          raise "Couldnt kill pid: #{pid}" if k >= 4
+          raise CannotKillProcess, "Couldnt kill pid: #{pid}" if i >= 4
         end
       end
     end

data/lib/tormanager/tor_process.rb

@@ -4,6 +4,12 @@ require 'fileutils'
 require 'securerandom'
 
 module TorManager
+  Error = Class.new(StandardError)
+  TorPortInUse = Class.new(Error)
+  TorControlPortInUse = Class.new(Error)
+  TorFailedToStart = Class.new(Error)
+  TorFailedToStop = Class.new(Error)
+
   class TorProcess
     attr_accessor :settings
 
@@ -88,31 +94,29 @@ module TorManager
     end
 
     def tor_port_is_open?
-      raise "Cannot spawn Tor process as port " +
+      raise TorPortInUse, "Cannot spawn Tor process as port " +
                 "#{@settings[:tor_port]} is in use" unless
           ProcessHelper.port_is_open?(@settings[:tor_port])
       true
     end
 
     def control_port_is_open?
-      raise "Cannot spawn Tor process as control port " +
+      raise TorControlPortInUse, "Cannot spawn Tor process as control port " +
                 "#{@settings[:control_port]} is in use" unless
           ProcessHelper.port_is_open?(@settings[:control_port])
       true
     end
 
     def prepare_tor_start_and_monitor
-      build_eye_config_from_template
+      #build_eye_config_from_template
+      eye_config = CreateEyeConfig.new(
+          @settings.merge(
+              eye_tor_config_path: eye_config_filename))
+      eye_config.create
       make_dirs
       start_tor_and_monitor
     end
 
-    def build_eye_config_from_template
-      File.open(eye_config_filename, "w") do |file|
-        file.puts read_eye_tor_config_template_and_substitute_keywords
-      end
-    end
-
     def eye_config_filename
       @eye_config_filename || File.join(@settings[:log_dir],
                 "tormanager.tor.#{@settings[:tor_port]}.#{Process.pid}.eye.rb")
@@ -122,23 +126,6 @@ module TorManager
       @eye_app_name || "tormanager-tor-#{@settings[:tor_port]}-#{Process.pid}"
     end
 
-    def read_eye_tor_config_template_and_substitute_keywords
-      text = File.read(@settings[:eye_tor_config_template])
-      eye_tor_config_template_substitution_keywords.each do |keyword|
-        text = text.gsub(/\[\[\[#{keyword}\]\]\]/, @settings[keyword.to_sym].to_s)
-      end
-      text
-    end
-
-    def eye_tor_config_template_substitution_keywords
-      remove_settings_that_are_not_eye_tor_config_template_keywords(
-          @settings.keys.map(&:to_s))
-    end
-
-    def remove_settings_that_are_not_eye_tor_config_template_keywords keywords
-      keywords - ['eye_tor_config_template', 'control_password', 'dont_remove_tor_config']
-    end
-
     def make_dirs
       [@settings[:log_dir], @settings[:pid_dir],
        @settings[:tor_data_dir]].each do |path|
@@ -159,7 +146,7 @@ module TorManager
                 application: eye_app_name,
                 process: 'tor') == 'up'
         sleep 2
-        raise "Tor didnt start up after 20 seconds! See log: " +
+        raise TorFailedToStart, "Tor didnt start up after 20 seconds! See log: " +
                   "#{File.join(@settings[:log_dir],
                                eye_app_name + ".log")}" if i >= 9
       end
@@ -172,7 +159,8 @@ module TorManager
             process: 'tor')
         break if ['unknown','unmonitored'].include?(tor_status)
         sleep 2
-        raise "Tor didnt stop after 20 seconds! Last status: #{tor_status} See log: " +
+        raise TorFailedToStop,
+              "Tor didnt stop after 20 seconds! Last status: #{tor_status} See log: " +
                   "#{File.join(@settings[:log_dir],
                                eye_app_name + ".log")}" if i >= 9
       end

data/lib/tormanager/version.rb

@@ -1,3 +1,3 @@
 module TorManager
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tormanager
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - joshweir
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,9 +155,9 @@ files:
 - bin/setup
 - lib/tormanager.rb
 - lib/tormanager/control.rb
+- lib/tormanager/create_eye_config.rb
 - lib/tormanager/eye/eye.tor.test.rb
 - lib/tormanager/eye/sugar.rb
-- lib/tormanager/eye/tor.god.rb
 - lib/tormanager/eye/tor.template.eye.rb
 - lib/tormanager/ip_address_control.rb
 - lib/tormanager/process_helper.rb

data/lib/tormanager/eye/tor.god.rb

@@ -1,105 +0,0 @@
-require 'fileutils'
-
-opts = {}
-opts[:parent_id] = ARGV[0]
-opts[:tor_port] = ARGV[1] || 9050
-opts[:control_port] = ARGV[2] || 50500
-opts[:pid_dir] = ARGV[3] || "/tmp"
-opts[:log_dir] = ARGV[4] || "/tmp"
-opts[:tor_data_dir] = ARGV[5] || "/tmp/tor_data/"
-opts[:tor_new_circuit_period] = ARGV[6] || 60
-opts[:max_tor_memory_usage_mb] = ARGV[7] || 200
-opts[:max_tor_cpu_percentage] = ARGV[8] || 10
-opts[:max_tor_memory_usage_times] = [3,5]
-opts[:max_tor_cpu_percentage_times] = [3,5]
-
-raise 'parent_id is required' unless opts[:parent_id]
-
-module God
-  module Behaviors
-    class WaitBehavior < Behavior
-      attr_accessor :delay
-
-      def after_start
-        sleep delay.to_i if delay.to_i > 0
-      end
-    end
-  end
-end
-
-God.watch do |w|
-  the_name = "tormanager-tor-#{opts[:tor_port]}-#{opts[:parent_id]}"
-  w.name = the_name
-  w.start = "tor --SocksPort #{opts[:tor_port]} --ControlPort #{opts[:control_port]} " +
-      "--CookieAuthentication 0 --HashedControlPassword \"16:3E49D6163CCA95F2605B339" +
-      "E07F753C8F567DE4200E33FDF4CC6B84E44\" --NewCircuitPeriod " +
-      "#{opts[:tor_new_circuit_period]} --DataDirectory " +
-      File.join(opts[:tor_data_dir], opts[:tor_port]) + " --Log \"notice syslog\""
-  #w.pid_file = File.join(opts[:pid_dir], "#{the_name}.pid")
-  #w.log = File.join(opts[:log_dir], "#{the_name}.log") if opts[:log_dir].length > 0
-  w.keepalive
-
-  # clean pid files before start if necessary
-  w.behavior(:clean_pid_file)
-  w.behavior(:wait_behavior) do |b|
-    b.delay = 10
-  end
-
-=begin
-  # determine the state on startup
-  w.transition(:init, { true => :up, false => :start }) do |on|
-    sleep 5
-    on.condition(:process_running) do |c|
-      c.interval = 5
-      c.running = true
-    end
-  end
-
-  # determine when process has finished starting
-  w.transition([:start, :restart], :up) do |on|
-    on.condition(:process_running) do |c|
-      c.interval = 20
-      c.running = true
-    end
-
-    # failsafe
-    on.condition(:tries) do |c|
-      c.interval = 20
-      c.times = 5
-      c.transition = :start
-    end
-  end
-
-  # start if process is not running
-  #w.transition(:up, :start) do |on|
-  #  on.condition(:process_exits) do |c|
-  #    c.interval = 20
-  #  end
-  #end
-
-  # restart if memory or cpu is too high
-  w.transition(:up, :restart) do |on|
-    on.condition(:memory_usage) do |c|
-      c.interval = 20
-      c.above = opts[:max_tor_memory_usage_mb]
-      c.times = opts[:max_tor_memory_usage_times]
-    end
-
-    on.condition(:cpu_usage) do |c|
-      c.interval = 10
-      c.above = opts[:max_tor_cpu_percentage]
-      c.times = opts[:max_tor_cpu_percentage_times]
-    end
-  end
-
-  # lifecycle
-  w.lifecycle do |on|
-    on.condition(:flapping) do |c|
-      c.to_state = [:start, :restart]
-      c.times = 5
-      c.within = 5.minute
-      c.transition = :unmonitored
-    end
-  end
-=end
-end