tormanager 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e956978c37191217d4f787f613f4610565014d4
-  data.tar.gz: cfc30d398e0d4dcdef237dca49f2d7195122cae0
+  metadata.gz: f4f5f15e6d06ba9f2ea927a1a09e492cb06fcdb8
+  data.tar.gz: fcffe0b51611f91a85c4bd17407de5ee364acd98
 SHA512:
-  metadata.gz: eef0f639f64e0111f5208d4b76a37c53f37852618f86a62bfcfad2fb1eb8dfb47e22943763c2b8aae0e8fee339c2867f7c68ff3a6d915c453b1996e140d689a3
-  data.tar.gz: c7e77748b8c2412d1eb4280219988e596fc6ec33d3c25b334a70cce62a7f2beafb5c55e830949e10ac7ee435c4c47aa9a129c65a6553199f1ba1590c6d3a9cb2
+  metadata.gz: f781d354d3d9a0ecc9740568c58fe308ae540b18ad63e6162dc46ea92e2dba5d71a0e9a789a79bf4c074c7b9019699ba69a8d034a122ffb33fe6dbd80a385b18
+  data.tar.gz: 09b546d6a5ce6f314b2de9972a283ae8043167e78988521346c67ea6de6333b0e653308fba1611d5a73366b1416b2b35ea9e687feb362087199c1cff5db216fa

data/Gemfile

@@ -3,8 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in tormanager.gemspec
 gemspec
 
-gem 'tor', :git => 'https://github.com/bendiken/tor-ruby.git', :ref => '08e589d17196a5dc640e7b38cb1acc5b4c5ced05'
-#gem 'tor', :git => 'https://github.com/dryruby/tor.rb.git'
 group :development, :test do
   gem "rb-fsevent", :require => false if RUBY_PLATFORM =~ /darwin/i
   gem "guard-rspec"

data/lib/tormanager/control.rb

@@ -0,0 +1,313 @@
+require 'socket' unless defined?(Socket)
+
+module Tor
+  ##
+  # Tor Control Protocol (TC) client.
+  # pulled from tor.rb:
+  # https://github.com/dryruby/tor.rb/blob/master/lib/tor/control.rb
+  # because latest version was not pushed to rubygems and needed to bundle into my gem
+  #
+  # The Tor control protocol is used by other programs (such as frontend
+  # user interfaces) to communicate with a locally running Tor process. It
+  # is not part of the Tor onion routing protocol.
+  #
+  # @example Establishing a controller connection (1)
+  #   tor = Tor::Controller.new
+  #
+  # @example Establishing a controller connection (2)
+  #   tor = Tor::Controller.new(:host => '127.0.0.1', :port => 9051)
+  #
+  # @example Authenticating the controller connection
+  #   tor.authenticate
+  #
+  # @example Obtaining information about the Tor process
+  #   tor.version      #=> "0.2.1.25"
+  #   tor.config_file  #=> #<Pathname:/opt/local/etc/tor/torrc>
+  #
+  # @see   http://gitweb.torproject.org/tor.git?a=blob_plain;hb=HEAD;f=doc/spec/control-spec.txt
+  # @see   http://www.thesprawl.org/memdump/?entry=8
+  # @since 0.1.1
+  class Controller
+    PROTOCOL_VERSION = 1
+
+    ##
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [String, #to_s]  :host    ("127.0.0.1")
+    # @option options [Integer, #to_i] :port    (9051)
+    # @option options [String, #to_s]  :cookie  (nil)
+    # @option options [Integer, #to_i] :version (PROTOCOL_VERSION)
+    def self.connect(options = {}, &block)
+      if block_given?
+        result = block.call(tor = self.new(options))
+        tor.quit
+        result
+      else
+        self.new(options)
+      end
+    end
+
+    ##
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [String, #to_s]  :host    ("127.0.0.1")
+    # @option options [Integer, #to_i] :port    (9051)
+    # @option options [String, #to_s]  :cookie  (nil)
+    # @option options [Integer, #to_i] :version (PROTOCOL_VERSION)
+    def initialize(options = {}, &block)
+      @options = options.dup
+      @host    = (@options.delete(:host)    || '127.0.0.1').to_s
+      @port    = (@options.delete(:port)    || 9051).to_i
+      @version = (@options.delete(:version) || PROTOCOL_VERSION).to_i
+      connect
+      if block_given?
+        block.call(self)
+        quit
+      end
+    end
+
+    attr_reader :host, :port
+
+    ##
+    # Establishes the socket connection to the Tor process.
+    #
+    # @example
+    #   tor.close
+    #   tor.connect
+    #
+    # @return [void]
+    def connect
+      close
+      @socket = TCPSocket.new(@host, @port)
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+      self
+    end
+
+    ##
+    # Returns `true` if the controller connection is active.
+    #
+    # @example
+    #   tor.connected?             #=> true
+    #   tor.close
+    #   tor.connected?             #=> false
+    #
+    # @return [Boolean]
+    def connected?
+      !!@socket
+    end
+
+    ##
+    # Closes the socket connection to the Tor process.
+    #
+    # @example
+    #   tor.close
+    #
+    # @return [void]
+    def close
+      @socket.close if @socket
+      @socket = nil
+      self
+    end
+
+    ##
+    # Tells the Tor process to hang up on this controller connection.
+    #
+    # This command can be used before authenticating.
+    #
+    # @example
+    #   C: QUIT
+    #   S: 250 closing connection
+    #   ^D
+    #
+    # @example
+    #   tor.quit
+    #
+    # @return [void]
+    def quit
+      send_line('QUIT')
+      reply = read_reply
+      close
+      reply
+    end
+
+    ##
+    # Returns information about the authentication method required by the
+    # Tor process.
+    #
+    # This command may be used before authenticating.
+    #
+    # @example
+    #     C: PROTOCOLINFO
+    #     S: 250-PROTOCOLINFO 1
+    #     S: 250-AUTH METHODS=NULL
+    #     S: 250-VERSION Tor="0.2.1.25"
+    #     S: 250 OK
+    #
+    # @example
+    #   tor.authentication_method  #=> nil
+    #   tor.authentication_method  #=> :hashedpassword
+    #   tor.authentication_method  #=> :cookie
+    #
+    # @return [Symbol]
+    # @since  0.1.2
+    def authentication_method
+      @authentication_method ||= begin
+        method = nil
+        send_line('PROTOCOLINFO')
+        loop do
+          # TODO: support for reading multiple authentication methods
+          case reply = read_reply
+            when /^250-AUTH METHODS=(\w*)/
+              method = $1.strip.downcase.to_sym
+              method = method.eql?(:null) ? nil : method
+            when /^250-/  then next
+            when '250 OK' then break
+          end
+        end
+        method
+      end
+    end
+
+    ##
+    # Returns `true` if the controller connection has been authenticated.
+    #
+    # @example
+    #   tor.authenticated?         #=> false
+    #   tor.authenticate
+    #   tor.authenticated?         #=> true
+    #
+    # @return [Boolean]
+    def authenticated?
+      @authenticated || false
+    end
+
+    ##
+    # Authenticates the controller connection.
+    #
+    # @example
+    #   C: AUTHENTICATE
+    #   S: 250 OK
+    #
+    # @example
+    #   tor.authenticate
+    #
+    # @return [void]
+    # @raise  [AuthenticationError] if authentication failed
+    def authenticate(cookie = nil)
+      cookie ||= @options[:cookie]
+      send(:send_line, cookie ? "AUTHENTICATE \"#{cookie}\"" : "AUTHENTICATE")
+      case reply = read_reply
+        when '250 OK' then @authenticated = true
+        else raise AuthenticationError.new(reply)
+      end
+      self
+    end
+
+    ##
+    # Returns the version number of the Tor process.
+    #
+    # @example
+    #   C: GETINFO version
+    #   S: 250-version=0.2.1.25
+    #   S: 250 OK
+    #
+    # @example
+    #   tor.version                #=> "0.2.1.25"
+    #
+    # @return [String]
+    def version
+      send_command(:getinfo, 'version')
+      reply = read_reply.split('=').last
+      read_reply # skip "250 OK"
+      reply
+    end
+
+    ##
+    # Returns the path to the Tor configuration file.
+    #
+    # @example
+    #   C: GETINFO config-file
+    #   S: 250-config-file=/opt/local/etc/tor/torrc
+    #   S: 250 OK
+    #
+    # @example
+    #   tor.config_file            #=> #<Pathname:/opt/local/etc/tor/torrc>
+    #
+    # @return [Pathname]
+    def config_file
+      send_command(:getinfo, 'config-file')
+      reply = read_reply.split('=').last
+      read_reply # skip "250 OK"
+      Pathname(reply)
+    end
+
+    ##
+    # Returns the current (in-memory) Tor configuration.
+    # Response is terminated with a "."
+    #
+    # @example
+    #   C: GETINFO config-text
+    #   S: 250+config-text=
+    #   S: ControlPort 9051
+    #   S: RunAsDaemon 1
+    #   S: .
+    def config_text
+      send_command(:getinfo, 'config-text')
+      reply = ""
+      read_reply # skip "250+config-text="
+      while line = read_reply
+        break unless line != "."
+        reply.concat(line + "\n")
+      end
+      read_reply # skip "250 OK"
+      return reply
+    end
+
+    ##
+    # Send a signal to the server
+    #
+    # @example
+    # tor.signal("newnym")
+    #
+    # @return [String]
+    def signal(name)
+      send_command(:signal, name)
+      read_reply
+    end
+
+    protected
+
+    ##
+    # Sends a command line over the socket.
+    #
+    # @param  [Symbol, #to_s] command
+    # @param  [Array<String>] args
+    # @return [void]
+    def send_command(command, *args)
+      authenticate unless authenticated?
+      send_line(["#{command.to_s.upcase}", *args].join(' '))
+    end
+
+    ##
+    # Sends a text line over the socket.
+    #
+    # @param  [String, #to_s] line
+    # @return [void]
+    def send_line(line)
+      @socket.write(line.to_s + "\r\n")
+      @socket.flush
+    end
+
+    ##
+    # Reads a reply line from the socket.
+    #
+    # @return [String]
+    def read_reply
+      @socket.readline.chomp
+    end
+
+    ##
+    # Used to signal an authentication error.
+    #
+    # @see Tor::Controller#authenticate
+    class AuthenticationError < StandardError; end
+  end
+end

data/lib/tormanager/ip_address_control.rb

@@ -1,4 +1,3 @@
-require 'tor'
 require 'rest-client'
 
 module TorManager

data/lib/tormanager/version.rb

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

data/lib/tormanager.rb

@@ -1,7 +1,6 @@
 require "tormanager/version"
 require "tormanager/process_helper"
+require "tormanager/control"
 require "tormanager/tor_process"
 require "tormanager/proxy"
 require "tormanager/ip_address_control"
-require "tor"
-

data/tormanager.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-rails", "~> 3.5"
+  spec.add_development_dependency "gem-release"
   spec.add_dependency "rest-client"
   spec.add_dependency "eye"
   spec.add_dependency "eyemanager"
-  spec.add_dependency "gem-release"
   spec.add_dependency "socksify"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tormanager
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - joshweir
@@ -67,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: eye
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: eyemanager
+  name: eye
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: eyemanager
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -154,6 +154,7 @@ files:
 - bin/console
 - bin/setup
 - lib/tormanager.rb
+- lib/tormanager/control.rb
 - lib/tormanager/eye/eye.tor.test.rb
 - lib/tormanager/eye/sugar.rb
 - lib/tormanager/eye/tor.god.rb