evil-proxy 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4c501bef2b64e58b8393c8cc73a6516739f8b87
+  data.tar.gz: 9f8c54251a54e7f68cb47b04363ea746ed0956e1
+SHA512:
+  metadata.gz: dc6113ee6f3043cc8ddd8e70dc4423dc717281c5eb589cbc878531fa2019b280b09d1fbb8c9ae789d7b2c1ce8d93d4ad44f061a7c6ff8b67506838c44dc85b4c
+  data.tar.gz: c598d95d33cdbaf4ec131697f3b95015f39f5a31dda3fe8043522d912d9ed9bbf0a0ad903fa51e251def4f3f7829facaa4af45aa4bc20f5873028408312cc8e1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in evil-proxy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Theo Li <bbtfrr@gmail.com>
+
+MIT License
+
+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,114 @@
+# EvilProxy
+
+A ruby http proxy to do :imp: things.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'evil-proxy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install evil-proxy
+
+## Usage
+
+#### Basic usage: hooks
+
+```ruby
+require 'evil-proxy'
+
+# EvilProxy::HTTPProxyServer is a subclass of Webrick::HTTPProxyServer;
+#   it takes the same parameters.
+proxy = EvilProxy::HTTPProxyServer.new Port: 8080
+
+proxy.before_request do |req|
+  # Do evil things
+  # Note that, different from Webrick::HTTPProxyServer, 
+  #   `req.body` is writable.
+end
+
+proxy.before_response do |req, res|
+  # Here `res.body` is also writable.
+end
+
+trap "INT"  do proxy.shutdown end
+trap "TERM" do proxy.shutdown end
+
+proxy.start
+```
+
+Available hooks including `when_initialize`, `when_start`, `when_shutdown`, 
+  `before_request`, `before_response`, `(before|after)_(get|head|post|options|connect)`.
+
+#### Plugin: store
+  
+If you want to save the network traffic, you can use `store` plugin,
+  network traffic will be saved in `store.yml`.
+```ruby
+require 'evil-proxy'
+require 'evil-proxy/store'
+
+proxy = EvilProxy::HTTPProxyServer.new Port: 8080
+
+proxy.store_filter do |req, res|
+  # Optional, if you don't set `store_filter`, evil-proxy
+  #   will save all the network traffic.
+  res.unparsed_uri =~ /www.google.com/
+end
+
+...
+```
+
+#### Plugin: async
+Start the proxy server asnychronously, which means start server in a background thread;
+with it, you can check the `store` when runing the proxy server.
+```ruby
+require 'evil-proxy'
+require 'evil-proxy/async'
+require 'evil-proxy/store'
+require 'yaml'
+
+proxy = EvilProxy::HTTPProxyServer.new Port: 8080
+
+proxy.start
+
+loop do
+  # Do something with `proxy.store`
+  puts proxy.store.to_yaml
+  proxy.clean_store # if needed
+  sleep 10
+end
+
+...
+```
+
+#### Plugin: selenium
+Use `proxy.selenium_proxy` to create a instance of `Selenium::WebDriver::Proxy`.
+
+```ruby
+require 'evil-proxy'
+require 'evil-proxy/selenium'
+require 'selenium/webdriver'
+
+proxy = EvilProxy::HTTPProxyServer.new Port: 8080
+proxy.start
+
+driver = Selenium::WebDriver.for :chrome, proxy: proxy.selenium_proxy
+
+...
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/bbtfr/evil-proxy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/evil-proxy.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'evil-proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "evil-proxy"
+  spec.version       = EvilProxy::VERSION
+  spec.authors       = ["Theo"]
+  spec.email         = ["bbtfrr@gmail.com"]
+  spec.summary       = %q{A ruby http proxy to do EVIL things.}
+  spec.description   = %q{A ruby http proxy to do EVIL things.}
+  spec.homepage      = "https://github.com/bbtfr/evil-proxy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/evil-proxy.rb

@@ -0,0 +1,7 @@
+require "evil-proxy/version"
+require "evil-proxy/httpproxy"
+require "evil-proxy/httprequest"
+
+module EvilProxy
+  # Your code goes here...
+end

data/lib/evil-proxy/async.rb

@@ -0,0 +1,19 @@
+EvilProxy::HTTPProxyServer.class_eval do
+  attr_reader :thread
+  alias_method :original_start, :start
+  alias_method :original_shutdown, :shutdown
+
+  def start
+    @thread = Thread.new do
+      self.original_start
+    end
+  end
+
+  def shutdown
+    @thread.exit
+  end
+
+  def join
+    @thread.join
+  end
+end

data/lib/evil-proxy/httpproxy.rb

@@ -0,0 +1,83 @@
+require 'webrick'
+require 'webrick/httpproxy'
+
+class EvilProxy::HTTPProxyServer < WEBrick::HTTPProxyServer
+  VALID_CALBACKS = Array.new
+  DEFAULT_CALLBACKS = Hash.new
+
+  def initialize *args
+    initialize_callbacks
+    fire :when_initialize, *args
+    super
+  end
+
+  def start
+    begin
+      fire :when_start
+      super
+    ensure
+      fire :when_shutdown
+    end
+  end
+
+  def fire key, *args
+    return unless @callbacks[key]
+    @callbacks[key].each do |callback|
+      instance_exec *args, &callback
+    end
+  end
+
+  def proxy_service req, res
+    fire :before_request, req
+    super
+    fire :before_response, req, res
+  end
+
+  VALID_CALBACKS << :when_initialize
+  VALID_CALBACKS << :when_start
+  VALID_CALBACKS << :when_shutdown
+  VALID_CALBACKS << :before_request
+  VALID_CALBACKS << :before_response
+
+  %w(GET HEAD POST OPTIONS CONNECT).each do |method|
+    do_method = "do_#{method}".to_sym
+    do_method_without_callbacks = "#{do_method}_without_callbacks".to_sym
+    before_method = "before_#{method.downcase}".to_sym
+    after_method = "after_#{method.downcase}".to_sym
+
+    VALID_CALBACKS << before_method
+    VALID_CALBACKS << after_method
+
+    alias_method do_method_without_callbacks, do_method
+    define_method do_method do |req, res|
+      fire before_method, req
+      send do_method_without_callbacks, req, res
+      fire after_method, req, res
+    end
+  end
+
+  VALID_CALBACKS.each do |callback|
+    define_method callback do |&block|
+      @callbacks[callback] ||= []
+      @callbacks[callback] << block
+    end
+  end
+
+private
+  def initialize_callbacks
+    @callbacks = Hash.new
+    DEFAULT_CALLBACKS.each do |key, callbacks|
+      @callbacks[key] = callbacks.clone
+    end
+  end
+
+  class << self
+    VALID_CALBACKS.each do |callback|
+      define_method callback do |&block|
+        DEFAULT_CALLBACKS[callback] ||= []
+        DEFAULT_CALLBACKS[callback] << block
+      end
+    end
+  end
+
+end

data/lib/evil-proxy/httprequest.rb

@@ -0,0 +1,11 @@
+WEBrick::HTTPRequest.class_eval do
+  alias_method :original_body, :body
+  def body
+    @evil_body || original_body
+  end
+
+  def body= body
+    @evil_body = body
+  end
+
+end

data/lib/evil-proxy/selenium.rb

@@ -0,0 +1,19 @@
+require 'evil-proxy/async'
+
+EvilProxy::HTTPProxyServer.class_eval do
+  def selenium_proxy *protocols
+    require 'selenium-webdriver' unless defined?(Selenium)
+
+    protocols.push :http if protocols.empty?
+    unless (protocols - [:http, :ssl, :ftp]).empty?
+      raise "Invalid protocol specified.  Must be one of: :http, :ssl, or :ftp."
+    end
+
+    host = @config[:BindAddress] || "127.0.0.1"
+    port = @config[:Port]
+
+    proxy_mapping = Hash.new
+    protocols.each do |proto| proxy_mapping[proto] = "#{host}:#{port}" end
+    Selenium::WebDriver::Proxy.new(proxy_mapping)
+  end
+end

data/lib/evil-proxy/store.rb

@@ -0,0 +1,61 @@
+require 'yaml'
+
+EvilProxy::HTTPProxyServer.class_eval do
+  attr_reader :store
+
+  when_initialize do
+    clean_store
+  end
+
+  when_shutdown do
+    dump_store
+  end
+
+  before_response do |req, res|
+    @store << [ req, res ] if match_store_filter req, res
+  end
+
+  def store_filter &block
+    @store_filter = block
+  end
+
+  def match_store_filter req, res
+    return true unless @store_filter
+    instance_exec req, res, &@store_filter
+  end
+
+  def clean_store
+    @store = []
+  end
+
+  def dump_store filename = "store.yml"
+    previous_store = YAML.load(File.read(filename)) || [] rescue []
+    File.open filename, "w" do |file|
+      file.puts YAML.dump(previous_store + store_as_params)
+    end
+    clean_store
+  end
+
+  def store_as_params
+    @store.map do |req, res|
+      Hash.new.tap do |params|
+        params["request"] = Hash.new.tap do |request|
+          request["method"] = req.request_method
+          request["url"] = req.unparsed_uri
+          request["headers"] = Hash.new.tap do |headers|
+            req.header.each do |key, value|
+              headers[key] = value.join(",")
+            end
+          end
+          request["body"] = req.body if req.body
+          request["time"] = req.request_time
+        end
+        params["response"] = Hash.new.tap do |response|
+          response["headers"] = res.header
+          response["body"] = res.body if req.body
+          response["status"] = res.status
+        end
+      end
+    end
+  end
+end

data/lib/evil-proxy/version.rb

@@ -0,0 +1,3 @@
+module EvilProxy
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: evil-proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Theo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby http proxy to do EVIL things.
+email:
+- bbtfrr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- evil-proxy.gemspec
+- lib/evil-proxy.rb
+- lib/evil-proxy/async.rb
+- lib/evil-proxy/httpproxy.rb
+- lib/evil-proxy/httprequest.rb
+- lib/evil-proxy/selenium.rb
+- lib/evil-proxy/store.rb
+- lib/evil-proxy/version.rb
+homepage: https://github.com/bbtfr/evil-proxy
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A ruby http proxy to do EVIL things.
+test_files: []