tor 0.1.0 → 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7be2c2b80fea90e1b3e9567624a442d4b3d1a92946f72d6b465280ad4b5d0ec8
+  data.tar.gz: 96358536b8479ea4fba83fb236dabb6b743074c058a48a6fbfe435bf00ab5bbc
+SHA512:
+  metadata.gz: b961dc19ac6f692cbade5226a895782c311cf6463fd228595ee4044085de9340f6948e852c981649c63abfd0abd01665d3fd7cabf2970815be6f87541b8158ee
+  data.tar.gz: cbecd4beddfd8d543d79233ea2f116609204550f0366a091aacac9573eae593e08c2d5c663020b56713ea6fc46b6dbb2ca39aa6b4e0e1686bb30d6ae7c7b2a7c

data/AUTHORS

@@ -1 +1,2 @@
 * Arto Bendiken <arto.bendiken@gmail.com>
+* Łukasz Wieczorek <wieczorek1990@gmail.com>

data/README

@@ -0,0 +1 @@
+./README.md

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.5

data/lib/tor.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 if RUBY_VERSION < '1.8.7'
   # @see http://rubygems.org/gems/backports
   begin
@@ -15,8 +17,32 @@ end
 ##
 # @see https://www.torproject.org/
 module Tor
-  autoload :DNSEL,   'tor/dnsel'
-  autoload :VERSION, 'tor/version'
+  require_relative 'tor/config'
+  require_relative 'tor/control'
+  require_relative 'tor/dnsel'
+  require_relative 'tor/version'
+
+  ##
+  # Returns `true` if the Tor process is running locally, `false` otherwise.
+  #
+  # This works by attempting to establish a Tor Control Protocol (TC)
+  # connection to the standard control port 9051 on `localhost`. If Tor
+  # hasn't been configured with the `ControlPort 9051` option, this will
+  # return `false`.
+  #
+  # @example
+  #   Tor.running?      #=> false
+  #
+  # @return [Boolean]
+  # @since  0.1.2
+  def self.running?
+    begin
+      Tor::Controller.new.quit
+      true
+    rescue Errno::ECONNREFUSED
+      false
+    end
+  end
 
   ##
   # Returns `true` if Tor is available, `false` otherwise.
@@ -39,6 +65,8 @@ module Tor
   def self.version
     if available? && `#{program_path} --version` =~ /Tor v(\d+)\.(\d+)\.(\d+)\.(\d+)/
       [$1, $2, $3, $4].join('.')
+    elsif available? && `#{program_path} --version` =~ /Tor version (\d+)\.(\d+)\.(\d+)\.(\d+)/
+      [$1, $2, $3, $4].join('.')
     end
   end
 

data/lib/tor/config.rb

@@ -0,0 +1,103 @@
+module Tor
+  ##
+  # Tor configuration.
+  #
+  # @example Parsing a Tor configuration file (1)
+  #   torrc = Tor::Config.load("/etc/tor/torrc")
+  #
+  # @example Parsing a Tor configuration file (2)
+  #   Tor::Config.open("/etc/tor/torrc") do |torrc|
+  #     puts "Tor SOCKS port: #{torrc['SocksPort']}"
+  #     puts "Tor control port: #{torrc['ControlPort']}"
+  #     puts "Tor exit policy:"
+  #     torrc.each('ExitPolicy') do |key, value|
+  #       puts "  #{value}"
+  #     end
+  #   end
+  #
+  # @see   https://www.torproject.org/tor-manual.html.en
+  # @since 0.1.2
+  class Config
+    CONFDIR = '/etc/tor' unless defined?(CONFDIR)
+
+    ##
+    # Opens a Tor configuration file.
+    #
+    # @param  [String, #to_s]          filename
+    # @param  [Hash{Symbol => Object}] options
+    # @yield  [config]
+    # @yieldparam [Config] config
+    # @return [Config]
+    def self.open(filename, options = {}, &block)
+      if block_given?
+        block.call(self.load(filename, options))
+      else
+        self.load(filename, options)
+      end
+    end
+
+    ##
+    # Loads the configuration options from a Tor configuration file.
+    #
+    # @param  [String, #to_s]          filename
+    # @param  [Hash{Symbol => Object}] options
+    # @return [Config]
+    def self.load(filename, options = {})
+      self.new(options) do |config|
+        File.open(filename.to_s, 'rb') do |file|
+          file.each_line do |line|
+            case line = line.strip.chomp.strip
+              when ''   then next # skip empty lines
+              when /^#/ then next # skip comments
+              else line = line.split('#').first.strip
+            end
+            # TODO: support for unquoting and unescaping values
+            config << line.split(/\s+/, 2)
+          end
+        end
+      end
+    end
+
+    ##
+    # @param  [Hash{Symbol => Object}] options
+    # @yield  [config]
+    # @yieldparam [Config] config
+    def initialize(options = {}, &block)
+      @lines, @options = [], options.dup
+      block.call(self) if block_given?
+    end
+
+    ##
+    # Appends a new configuration option.
+    #
+    # @param  [Array(String, String)]
+    # @return [Config]
+    def <<(kv)
+      @lines << kv
+      self
+    end
+
+    ##
+    # Looks up the last value of a particular configuration option.
+    #
+    # @param  [String, Regexp] key
+    # @return [String]
+    def [](key)
+      values = each(key).map(&:last)
+      values.empty? ? nil : values.last
+    end
+
+    ##
+    # Enumerates configuration options.
+    #
+    # @param  [String, Regexp] key
+    # @yield  [key, value]
+    # @yieldparam [String] key
+    # @yieldparam [String] value
+    # @return [Enumerator]
+    def each(key = nil, &block)
+      return enum_for(:each, key) unless block_given?
+      key ? @lines.find_all { |k, v| key === k }.each(&block) : @lines.each(&block)
+    end
+  end
+end

data/lib/tor/control.rb

@@ -0,0 +1,310 @@
+require 'socket' unless defined?(Socket)
+
+module Tor
+  ##
+  # Tor Control Protocol (TC) client.
+  #
+  # 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/tor/dnsel.rb

@@ -1,66 +1,26 @@
 require 'resolv' unless defined?(Resolv)
 
 module Tor
-  ##
-  # Tor DNS Exit List (DNSEL) client.
-  #
-  # Unless the target IP address and port are explicitly specified, the
-  # query will be performed using a target IP address of "8.8.8.8" and a
-  # target port of 53. These correspond to the DNS protocol port on one of
-  # the [Google Public DNS](http://code.google.com/speed/public-dns/)
-  # servers, and they are guaranteed to be reachable from Tor's default exit
-  # policy.
-  #
-  # @example Checking source IP addresses
-  #   Tor::DNSEL.include?("208.75.57.100")               #=> true
-  #   Tor::DNSEL.include?("1.2.3.4")                     #=> false
-  #
-  # @example Checking source hostnames
-  #   Tor::DNSEL.include?("ennui.lostinthenoise.net")    #=> true
-  #   Tor::DNSEL.include?("myhost.example.org")          #=> false
-  #
-  # @example Specifying an explicit target port
-  #   Tor::DNSEL.include?("208.75.57.100", :port => 80)  #=> true
-  #   Tor::DNSEL.include?("208.75.57.100", :port => 25)  #=> false
-  #
-  # @example Specifying an explicit target IP address and port
-  #   Tor::DNSEL.include?(source_addr, :addr => target_addr, :port => target_port)
-  #   Tor::DNSEL.include?("208.75.57.100", :addr => myip, :port => myport)
-  #
-  # @example Using from a Rack application
-  #   Tor::DNSEL.include?(env['REMOTE_ADDR'] || env['REMOTE_HOST'], {
-  #     :addr => env['SERVER_NAME'],
-  #     :port => env['SERVER_PORT'],
-  #   })
-  #
-  # @see https://www.torproject.org/tordnsel/
-  # @see https://trac.torproject.org/projects/tor/wiki/TheOnionRouter/TorDNSExitList
-  # @see http://gitweb.torproject.org/tor.git?a=blob_plain;hb=HEAD;f=doc/contrib/torel-design.txt
   module DNSEL
     RESOLVER    = Resolv::DefaultResolver unless defined?(RESOLVER)
-    TARGET_ADDR = '8.8.8.8'.freeze        unless defined?(TARGET_ADDR)     # Google Public DNS
-    TARGET_PORT = 53                      unless defined?(TARGET_PORT)     # DNS
-    DNS_SUFFIX  = 'ip-port.exitlist.torproject.org'.freeze
+    DNS_SUFFIX  = 'dnsel.torproject.org'.freeze
 
     ##
-    # Returns `true` if the Tor DNSEL includes `host`, `false` otherwise.
+    # Returns `true` if `host` is a Tor Exit Node, `false` otherwise.
     #
     # If the DNS server is unreachable or the DNS query times out, returns
     # `nil` to indicate that we don't have a definitive answer one way or
     # another.
     #
     # @example
-    #   Tor::DNSEL.include?("208.75.57.100")    #=> true
+    #   Tor::DNSEL.include?("185.220.101.21")    #=> true
     #   Tor::DNSEL.include?("1.2.3.4")          #=> false
     #
     # @param  [String, #to_s]          host
-    # @param  [Hash{Symbol => Object}] options
-    # @option options [String, #to_s]  :addr ("8.8.8.8")
-    # @option options [Integer, #to_i] :port (53)
     # @return [Boolean]
-    def self.include?(host, options = {})
+    def self.include?(host)
       begin
-        query(host, options) == '127.0.0.2'
+        query(host) == '127.0.0.2'
       rescue Resolv::ResolvError   # NXDOMAIN
         false
       rescue Resolv::ResolvTimeout
@@ -77,35 +37,27 @@ module Tor
     # exit node and raising a `Resolv::ResolvError` if it isn't.
     #
     # @example
-    #   Tor::DNSEL.query("208.75.57.100")       #=> "127.0.0.2"
+    #   Tor::DNSEL.query("185.220.101.21")       #=> "127.0.0.2"
     #   Tor::DNSEL.query("1.2.3.4")             #=> Resolv::ResolvError
     #
     # @param  [String, #to_s]          host
-    # @param  [Hash{Symbol => Object}] options
-    # @option options [String, #to_s]  :addr ("8.8.8.8")
-    # @option options [Integer, #to_i] :port (53)
     # @return [String]
     # @raise  [Resolv::ResolvError] for an NXDOMAIN response
-    def self.query(host, options = {})
-      getaddress(dnsname(host, options))
+    def self.query(host)
+      getaddress(dnsname(host))
     end
 
     ##
     # Returns the DNS name used for Tor DNSEL queries of `host`.
     #
     # @example
-    #   Tor::DNSEL.dnsname("1.2.3.4")           #=> "4.3.2.1.53.8.8.8.8.ip-port.exitlist.torproject.org"
+    #   Tor::DNSEL.dnsname("1.2.3.4")           #=> "4.3.2.1.dnsel.torproject.org"
     #
     # @param  [String, #to_s]          host
-    # @param  [Hash{Symbol => Object}] options
-    # @option options [String, #to_s]  :addr ("8.8.8.8")
-    # @option options [Integer, #to_i] :port (53)
     # @return [String]
-    def self.dnsname(host, options = {})
+    def self.dnsname(host)
       source_addr = getaddress(host, true)
-      target_addr = getaddress(options[:addr] || TARGET_ADDR, true)
-      target_port = options[:port] || TARGET_PORT
-      [source_addr, target_port, target_addr, DNS_SUFFIX].join('.')
+      "#{source_addr}.#{DNS_SUFFIX}"
     end
     class << self; alias_method :hostname, :dnsname; end
 

data/lib/tor/version.rb

@@ -2,7 +2,7 @@ module Tor
   module VERSION
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 4
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')

metadata

@@ -1,98 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tor
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.1.5
 platform: ruby
-authors: 
+authors:
 - Arto Bendiken
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-01 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2021-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 8
-        version: 0.5.8
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
-  version_requirements: *id002
-description: Tor.rb is a pure-Ruby library for interacting with the Tor anonymity network.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Tor.rb is a Ruby library for interacting with the Tor anonymity network.
 email: or-talk@seul.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - AUTHORS
-- CONTRIBUTORS
+- CREDITS
 - README
 - UNLICENSE
 - VERSION
+- lib/tor.rb
+- lib/tor/config.rb
+- lib/tor/control.rb
 - lib/tor/dnsel.rb
 - lib/tor/version.rb
-- lib/tor.rb
-has_rdoc: false
-homepage: http://github.com/bendiken/tor-ruby
-licenses: 
-- Public Domain
+homepage: http://cypherpunk.rubyforge.org/tor/
+licenses:
+- Unlicense
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 1
+    - !ruby/object:Gem::Version
       version: 1.8.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
 - Tor (>= 0.2.1.25)
-rubyforge_project: cypherpunk
-rubygems_version: 1.3.6
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Onion routing for Ruby.
 test_files: []
-

data/README

@@ -1,77 +0,0 @@
-Tor.rb: Onion Routing for Ruby
-==============================
-
-This is a Ruby library for interacting with the [Tor][] anonymity network.
-
-* <http://github.com/bendiken/tor-ruby>
-
-Features
---------
-
-* Supports checking whether Tor is installed in the user's current `PATH`,
-  and if it is, returning the version number.
-* Supports querying the [Tor DNS Exit List (DNSEL)][TorDNSEL] to determine
-  whether a particular host is a Tor exit node or not.
-
-Examples
---------
-
-    require 'rubygems'
-    require 'tor'
-
-### Checking whether Tor is installed and which version it is
-
-    Tor.available?                                     #=> true
-    Tor.version                                        #=> "0.2.1.25"
-
-### Checking whether a particular host is a Tor exit node
-
-    Tor::DNSEL.include?("208.75.57.100")               #=> true
-    Tor::DNSEL.include?("1.2.3.4")                     #=> false
-
-Documentation
--------------
-
-* <http://cypherpunk.rubyforge.org/tor/>
-
-Dependencies
-------------
-
-* [Ruby](http://ruby-lang.org/) (>= 1.8.7) or (>= 1.8.1 with [Backports][])
-
-Installation
-------------
-
-The recommended installation method is via [RubyGems](http://rubygems.org/).
-To install the latest official release of Tor.rb, do:
-
-    % [sudo] gem install tor                 # Ruby 1.8.7+ or 1.9.x
-    % [sudo] gem install backports tor       # Ruby 1.8.1+
-
-Download
---------
-
-To get a local working copy of the development repository, do:
-
-    % git clone git://github.com/bendiken/tor-ruby.git
-
-Alternatively, you can download the latest development version as a tarball
-as follows:
-
-    % wget http://github.com/bendiken/tor-ruby/tarball/master
-
-Author
-------
-
-* [Arto Bendiken](mailto:arto.bendiken@gmail.com) - <http://ar.to/>
-
-License
--------
-
-Tor.rb is free and unencumbered public domain software. For more
-information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
-
-[Tor]:       https://www.torproject.org/
-[TorDNSEL]:  https://www.torproject.org/tordnsel/
-[OR]:        http://en.wikipedia.org/wiki/Onion_routing
-[Backports]: http://rubygems.org/gems/backports