forward-proxy 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6af22f5d41a5a3b702233f8a13b67533451a411b
+  data.tar.gz: 850669c9081a84975689e17d0e92b6b9adb5f29a
+SHA512:
+  metadata.gz: 0eba287e90bd3369421aa16401b2958203058047900f1b496e5c690bb15b5b58c018340118a76d18a39c3dcb054f5b034b2a5c3c6a94bc1a95a71b1f5ace78fd
+  data.tar.gz: c71b4cb6d19cdf9e9bad3605b03d4a8d2cc73933bb3b575ddf3be75d4408d266627dc97421b50c71578ede837a24417d00f243e5ad05cabebbd1c21c2d3a2d4f

data/.github/workflows/ci.yaml

@@ -0,0 +1,19 @@
+name: Continuous Integration
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [ '2.3', '2.7' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at james.moriarty@innablr.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in forward-proxy.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "minitest-reporters", "~> 1.4"
+gem "simplecov", "~> 0.17"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,72 @@
+# ForwardProxy
+
+Ruby Forward Proxy implemented with only standard libraries.
+
+```
+$ forward-proxy --binding 0.0.0.0 --port 3182 --threads 2
+[2021-01-14 19:37:47 +1100] INFO Listening 0.0.0.0:3182
+[2021-01-14 19:38:24 +1100] INFO CONNECT raw.githubusercontent.com:443 HTTP/1.1
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forward-proxy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install forward-proxy
+
+## Usage
+
+### CLI
+
+```
+forward-proxy
+```
+
+```
+Usage: forward-proxy [options]
+    -p, --port=PORT                  Bind to specified port. Default: 9292
+    -b, --binding=BINDING            Bind to the specified IP. Default: 127.0.0.1
+    -t, --threads=THREADS            Specify the number of client threads. Default: 32
+    -h, --help                       Prints this help
+```
+
+### Library
+
+```ruby
+require 'forward_proxy'
+
+proxy = ForwardProxy::Server.new(
+  bind_address: "127.0.0.1",
+  bind_port: 3000
+)
+
+proxy.start
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jamesmoriarty/forward-proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jamesmoriarty/forward-proxy/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ForwardProxy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jamesmoriarty/forward-proxy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "forward_proxy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/forward-proxy

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |parser|
+  parser.banner = "Usage: forward-proxy [options]"
+
+  parser.on("-pPORT", "--port=PORT", "Bind to specified port. Default: 9292", String) do |bind_port|
+    options[:bind_port] = bind_port
+  end
+
+  parser.on("-bBINDING", "--binding=BINDING", String, "Bind to the specified IP. Default: 127.0.0.1") do |bind_address|
+    options[:bind_address] = bind_address
+  end
+
+  parser.on("-tTHREADS", "--threads=THREADS", Integer, "Specify the number of client threads. Default: 32") do |threads|
+    options[:threads] = threads
+  end
+
+  parser.on("-h", "--help", "Prints this help") do
+    puts parser
+    exit
+  end
+end.parse!
+
+require_relative '../lib/forward_proxy'
+
+server = ForwardProxy::Server.new(options)
+server.start

data/forward-proxy.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/forward_proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forward-proxy"
+  spec.version       = ForwardProxy::VERSION
+  spec.authors       = ["James Moriarty"]
+  spec.email         = ["jamespaulmoriarty@gmail.com"]
+
+  spec.summary       = %q{Forward proxy.}
+  spec.description   = %q{Forward proxy using just Ruby standard libraries.}
+  spec.homepage      = "https://github.com/jamesmoriarty/forward-proxy"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jamesmoriarty/forward-proxy"
+  spec.metadata["changelog_uri"] = "https://github.com/jamesmoriarty/forward-proxy/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/forward_proxy.rb

@@ -0,0 +1,4 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'forward_proxy/version'
+require 'forward_proxy/server'

data/lib/forward_proxy/server.rb

@@ -0,0 +1,154 @@
+require 'forward_proxy/thread_pool'
+require 'socket'
+require 'webrick'
+require 'net/http'
+
+module ForwardProxy
+  class HTTPMethodNotImplemented < StandardError; end
+
+  class Server
+    attr_reader :bind_address, :bind_port
+
+    def initialize(bind_address: "127.0.0.1", bind_port: 9292, threads: 32)
+      @thread_pool = ThreadPool.new(threads)
+      @bind_address = bind_address
+      @bind_port = bind_port
+    end
+
+    def start
+      @server = TCPServer.new(bind_address, bind_port)
+
+      thread_pool.start
+
+      log("Listening #{bind_address}:#{bind_port}")
+
+      loop do
+        client = server.accept
+
+        thread_pool.schedule(client) do |client_conn|
+          begin
+            req = parse_req(client_conn)
+
+            log(req.request_line)
+
+            case req.request_method
+            when METHOD_CONNECT then handle_tunnel(client_conn, req)
+            when METHOD_GET, METHOD_POST then handle(client_conn, req)
+            else
+              raise HTTPMethodNotImplemented
+            end
+          rescue => e
+            client_conn.puts <<~eos.chomp
+              HTTP/1.1 502
+            eos
+
+            puts e.message
+            puts e.backtrace.map { |line| "  #{line}" }
+          ensure
+            client_conn.close
+          end
+        end
+      end
+    rescue Interrupt
+    end
+
+    def shutdown
+      log("Closing client connections...")
+      thread_pool.shutdown
+
+      log("Stoping server...")
+      server.close if server
+    end
+
+    private
+
+    attr_reader :server, :thread_pool
+
+    METHOD_CONNECT = "CONNECT"
+    METHOD_GET = "GET"
+    METHOD_POST = "POST"
+
+    def handle_tunnel(client_conn, req)
+      # The following comments are from the IETF document
+      # "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"
+      # https://tools.ietf.org/html/rfc7231#section-4.3.6
+
+      # A client sending a CONNECT request MUST send the authority form of
+      # request-target (Section 5.3 of [RFC7230]); i.e., the request-target
+      # consists of only the host name and port number of the tunnel
+      # destination, separated by a colon.  For example,
+      #
+      #   CONNECT server.example.com:80 HTTP/1.1
+      #   Host: server.example.com:80
+      #
+      host, port = *req['Host'].split(':')
+      dest_conn = TCPSocket.new(host, port)
+
+      # Any 2xx (Successful) response indicates that the sender (and all
+      # inbound proxies) will switch to tunnel mode immediately after the
+      # blank line that concludes the successful response's header section;
+      # data received after that blank line is from the server identified by
+      # the request-target.
+      client_conn.write "HTTP/1.1 200 OK\n\n"
+
+      # The CONNECT method requests that the recipient establish a tunnel to
+      # the destination origin server identified by the request-target and,
+      # if successful, thereafter restrict its behavior to blind forwarding
+      # of packets, in both directions, until the tunnel is closed.
+      [
+        Thread.new { transfer(client_conn, dest_conn) },
+        Thread.new { transfer(dest_conn, client_conn) }
+      ].each(&:join)
+    ensure
+      dest_conn.close
+    end
+
+    def handle(client_conn, req)
+      resp = Net::HTTP.start(req.host, req.port) do |http|
+        http.request map_webrick_to_net_http_req(req)
+      end
+
+      # A proxy MUST send an appropriate Via header field, as described
+      # below, in each message that it forwards.  An HTTP-to-HTTP gateway
+      # MUST send an appropriate Via header field in each inbound request
+      # message and MAY send a Via header field in forwarded response
+      # messages.
+      client_conn.puts <<~eos.chomp
+        HTTP/1.1 #{resp.code}
+        Via: #{["1.1 ForwardProxy", resp['Via']].compact.join(', ')}
+        #{resp.each.map { |header, value| "#{header}: #{value}" }.join("\n")}
+
+        #{resp.body}
+      eos
+    end
+
+    def map_webrick_to_net_http_req(req)
+      req_headers = Hash[req.header.map { |k, v| [k, v.first] }]
+
+      klass = case req.request_method
+              when METHOD_GET then Net::HTTP::Get
+              when METHOD_POST then Net::HTTP::Post
+              else
+                raise HTTPMethodNotImplemented
+              end
+
+      klass.new(req.path, req_headers)
+    end
+
+    def transfer(dest_conn, src_conn)
+      IO.copy_stream(src_conn, dest_conn)
+    rescue => e
+      log(e.message, "WARNING")
+    end
+
+    def parse_req(client_conn)
+      WEBrick::HTTPRequest.new(WEBrick::Config::HTTP).tap do |req|
+        req.parse(client_conn)
+      end
+    end
+
+    def log(str, level = 'INFO')
+      puts "[#{Time.now}] #{level} #{str}"
+    end
+  end
+end

data/lib/forward_proxy/thread_pool.rb

@@ -0,0 +1,34 @@
+class ThreadPool
+  attr_reader :queue, :threads, :size
+
+  def initialize(size)
+    @size    = size
+    @queue   = Queue.new
+    @threads = []
+  end
+
+  def start
+    size.times do
+      threads << Thread.new do
+        catch(:exit) do
+          loop do
+            job, args = queue.pop
+            job.call(*args)
+          end
+        end
+      end
+    end
+  end
+
+  def schedule(*args, &block)
+    queue.push([block, args])
+  end
+
+  def shutdown
+    threads.each do
+      schedule { throw :exit }
+    end
+
+    threads.each(&:join)
+  end
+end

data/lib/forward_proxy/version.rb

@@ -0,0 +1,3 @@
+module ForwardProxy
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: forward-proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- James Moriarty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-14 00:00:00.000000000 Z
+dependencies: []
+description: Forward proxy using just Ruby standard libraries.
+email:
+- jamespaulmoriarty@gmail.com
+executables:
+- forward-proxy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yaml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/forward-proxy
+- forward-proxy.gemspec
+- lib/forward_proxy.rb
+- lib/forward_proxy/server.rb
+- lib/forward_proxy/thread_pool.rb
+- lib/forward_proxy/version.rb
+homepage: https://github.com/jamesmoriarty/forward-proxy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jamesmoriarty/forward-proxy
+  source_code_uri: https://github.com/jamesmoriarty/forward-proxy
+  changelog_uri: https://github.com/jamesmoriarty/forward-proxy/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Forward proxy.
+test_files: []