rack-detect-tor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7963c9ae710b9b5f9a6b47ea251aa6bddc644aac
+  data.tar.gz: 45b6a0b4c6c9d3a2c6ed6a57b6c088b7b4bd6fa6
+SHA512:
+  metadata.gz: 35a6e8440ae33e266e6f7d70259f3aab97185fc6251b66b6d724740ea7cbc843be81442f5924883fcd3b27e66cd8ecbaa903994b8ef38445b5ec5932559b3d81
+  data.tar.gz: 9edc60fbfb0c4698b061a81dbd0ec01b282caf37502113cb330cb0886cde470852fb7ba8f381a93e5ec3d52cb2cd700bb46687565473976196a196a7f46ec441

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (C) 2015 Warren Guy <warren@guy.net.au>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Rack::DetectTor
+
+Rack middleware for detecting Tor exits.
+
+Rack::DetectTor determines whether a user is connecting via a Tor exit
+relay. It adds an environment variable `tor_exit_user` to the
+`request.env` object with a value of `true` or `false`.
+
+## Usage
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'rack-detect-tor'
+```
+
+and add it to your middleware stack. In `config.ru`:
+
+```ruby
+require 'rack-detect-tor'
+
+use Rack::DetectTor, 'external_ip' => [ip],
+                     'external_port' => [port],
+                     'update_frequency' => 3600
+```
+
+It is *recommended* to provide `external_ip` and `external_port` (see
+below). `update_frequency` is how often Rack::DetectTor will update its
+list of Tor exits. It defaults to one hour (3600 seconds).
+
+### Note on `external_ip` and `external_port`
+
+You are not *required* to provide these. However:
+
+It's important to provide the `external_ip` and `external_port` values,
+corresponding with the external IP and port of your web server. Many Tor
+relays are configured not to allow connections on port 80/443/etc. If you
+don't provide or are unable to provide the external IP of your web server,
+the value added to `request.env['tor_exit_user']` will tell you only that
+the IP corresponds with **A** Tor exit, not necessarily one that is
+configured to relay connections to your website.
+
+## License
+
+MIT license. See [LICENSE](https://github.com/warrenguy/sinatra-rate-limiter/blob/master/LICENSE).
+
+## Author
+
+Warren Guy <warren@guy.net.au>
+
+https://warrenguy.me

data/lib/rack-detect-tor.rb

@@ -0,0 +1,85 @@
+require 'open-uri'
+require 'eventmachine'
+
+module Rack
+  class DetectTor
+
+    def initialize(app, options={})
+      @app = app
+
+      @options = {
+        'external_ip'      => nil, 
+        'external_port'    => nil,
+        'update_frequency' => 60*60
+      }.merge(options)
+
+      @identifier = Hash[@options.select{|k,v| k =~ /^external_/}.
+                         sort_by{|k,v| k}].values.map{|v| v.to_s == '' ? '*' : v}.join('/')
+
+      log_message 'Fetching initial list of tor exits...'
+      @tor_exits = fetch_tor_exits || {}
+
+      unless @options['update_frequency'].to_i == 0
+        log_message "Starting update timer... (updating every #{@options['update_frequency']} seconds)"
+        run_update_timer
+      end
+    end
+
+    def call(env)
+      env['tor_exit_user'] = @tor_exits.include? env['REMOTE_ADDR']
+      @app.call(env)
+    end
+
+    private
+
+    def fetch_tor_exits
+      if @options.select{|k,v| k =~ /^external_/}.values.map{|v| v.to_s}.include? ''
+        log_message "WARNING: external_ip/external_port not specified. Results will NOT be accurate"
+
+        begin
+          tor_exit_list = open('https://check.torproject.org/exit-addresses').read
+        rescue OpenURI::HTTPError => e
+          log_error "Error fetching list of tor exits: #{e}"
+        end
+
+        tor_exits = tor_exit_list.split("\n").select{|i| i =~ /^ExitAddress/}.
+          map{|j| j.split(' ')[1]}
+      else
+        check_url = "https://check.torproject.org/cgi-bin/TorBulkExitList.py?" +
+          "ip=#{@options['external_ip']}" +
+          (@options['external_port'].nil? ? '' : "&port=#{@options['external_port']}")
+
+        begin
+          tor_exit_list = open(check_url).read
+        rescue OpenURI::HTTPError => e
+          log_error "Error fetching list of tor exits: #{e}"
+        end
+
+        tor_exits = tor_exit_list.split("\n").select{|i| !(i =~ /^\#/)}
+      end
+
+      log_message "Found #{tor_exits.count} exits."
+      return tor_exits
+    end
+
+    def run_update_timer
+      Thread.new do
+        EventMachine.run do
+          @update_timer = EventMachine::PeriodicTimer.new(@options['update_frequency']) do
+            log_message 'Updating list of tor exits...'
+            @tor_exits = fetch_tor_exits || @tor_exits
+          end
+        end
+      end
+    end
+
+    def log_message(message)
+      $stdout.puts "Rack::DetectTor [#{@identifier}]: #{message}"
+    end
+
+    def log_error(message)
+      $stderr.puts "Rack::DetectTor [#{@identifier}]: ERROR: #{message}"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: rack-detect-tor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Warren Guy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware for detecting Tor exits
+email: warren@guy.net.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rack-detect-tor.rb
+homepage: https://github.com/warrenguy/rack-detect-tor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware for detecting Tor exits
+test_files: []