forward-proxy 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628359d25536c4190014c9e082fff41b2adef209f04a62d8a6b217c078f3b58b
-  data.tar.gz: 7834932b7242fd66c120d270a922e385a6a58ab63c65e8ce2b7957da43ba5a11
+  metadata.gz: 7ef1fa7e497462fc27f6b33ace589450994664c35c0e2744fae3a46c6caa0372
+  data.tar.gz: a396b7121e8a512a518a033aaa14261d7b86fd0377cf6e29d183a34ba02ff010
 SHA512:
-  metadata.gz: 8c47ab1d691807a23ba779f1ae8d4feecd32300f8d840044f66a5cc2f40ccd33c095db60ca9e3f99fb3c8fd60c02ae46d5d8d07b6a4de6298bef24731fb57cb4
-  data.tar.gz: 609a35651496d98e4977f3691c7834efd58fe736615b3b4594e0bc61d11dad0088f11f535f6b287db85f95c1cc8ab55ea2a536447028b690d92ffd0aa3e60669
+  metadata.gz: af543772c2f4159b0697f3ad02d4a330f776b73f1ccbaab6e8eb0dff9a8b5a6855b515fea99165c884132e743fd65aff7ac5973916256bcd6f476102d9dad743
+  data.tar.gz: e625cc351e9ce99744ff6ad00dac9c4e2e22c75cc0f8e4899c17736dcd06067398e1228bbebc6fb5ba07b44322f9806e62259c712f7d9bfddc89db5620045ded

data/.github/workflows/ci.yaml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [ '2.3', '2.7' ]
+        ruby: [ '2.5', '2.7' ]
 
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/cli.yaml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [ '2.3', '2.7' ]
+        ruby: [ '2.5', '2.7' ]
 
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 0.6.0
+
+- add connection timeout to stop tracking connection from saturating client threads.
+- add cli flats for connection timeout `-t` and `--timeout`.
+- change cli short flag `-t` to `-c` for `--threads`.
+
+## 0.5.0
+
+- increase default threads from `32` to `128`.
+
 ## 0.2.0
 
 - Extract errors into module.

data/README.md

@@ -6,8 +6,8 @@ Minimal forward proxy using 150LOC and only standard libraries. Useful for devel
 
 ```
 $ 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
+I, [2021-07-04T10:33:32.947653 #1790]  INFO -- : Listening 0.0.0.0:3182
+I, [2021-07-04T10:33:32.998298 #1790]  INFO -- : CONNECT raw.githubusercontent.com:443 HTTP/1.1
 ```
 
 ## Installation

data/exe/forward-proxy

@@ -15,7 +15,13 @@ OptionParser.new do |parser|
     options[:bind_address] = bind_address
   end
 
-  parser.on("-tTHREADS", "--threads=THREADS", Integer, "Specify the number of client threads. Default: 32") do |threads|
+  parser.on("-tTIMEOUT", "--timeout=TIMEOUT", Integer,
+            "Specify the connection timout in seconds. Default: 300") do |threads|
+    options[:timeout] = threads
+  end
+
+  parser.on("-cTHREADS", "--threads=THREADS", Integer,
+            "Specify the number of client threads. Default: 128") do |threads|
     options[:threads] = threads
   end
 

data/lib/forward_proxy.rb

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

data/lib/forward_proxy/errors/connection_timeout_error.rb

@@ -0,0 +1,5 @@
+module ForwardProxy
+  module Errors
+    class ConnectionTimeoutError < StandardError; end
+  end
+end

data/lib/forward_proxy/errors/http_method_not_implemented.rb

@@ -2,4 +2,4 @@ module ForwardProxy
   module Errors
     class HTTPMethodNotImplemented < StandardError; end
   end
-end
+end

data/lib/forward_proxy/errors/http_parse_error.rb

@@ -2,4 +2,4 @@ module ForwardProxy
   module Errors
     class HTTPParseError < StandardError; end
   end
-end
+end

data/lib/forward_proxy/server.rb

@@ -1,18 +1,23 @@
+require 'logger'
 require 'socket'
-require 'webrick'
+require 'timeout'
 require 'net/http'
+require 'webrick'
+require 'forward_proxy/errors/connection_timeout_error'
 require 'forward_proxy/errors/http_method_not_implemented'
 require 'forward_proxy/errors/http_parse_error'
 require 'forward_proxy/thread_pool'
 
 module ForwardProxy
   class Server
-    attr_reader :bind_address, :bind_port
+    attr_reader :bind_address, :bind_port, :logger, :timeout
 
-    def initialize(bind_address: "127.0.0.1", bind_port: 9292, threads: 32)
-      @thread_pool = ThreadPool.new(threads)
+    def initialize(bind_address: "127.0.0.1", bind_port: 9292, threads: 4, timeout: 1, logger: default_logger)
       @bind_address = bind_address
       @bind_port = bind_port
+      @logger = logger
+      @thread_pool = ThreadPool.new(threads)
+      @timeout = timeout
     end
 
     def start
@@ -20,29 +25,25 @@ module ForwardProxy
 
       @socket = TCPServer.new(bind_address, bind_port)
 
-      log("Listening #{bind_address}:#{bind_port}")
+      logger.info("Listening #{bind_address}:#{bind_port}")
 
       loop do
         thread_pool.schedule(socket.accept) do |client_conn|
           begin
-            req = parse_req(client_conn)
+            Timeout::timeout(timeout, Errors::ConnectionTimeoutError, "connection exceeded #{timeout} seconds") do
+              req = parse_req(client_conn)
 
-            log(req.request_line)
+              logger.info(req.request_line.strip)
 
-            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 Errors::HTTPMethodNotImplemented
+              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 Errors::HTTPMethodNotImplemented
+              end
             end
           rescue => e
-            client_conn.puts <<~eos.chomp
-              HTTP/1.1 502
-              Via: #{HEADER_VIA}
-            eos
-
-            puts e.message
-            puts e.backtrace.map { |line| "  #{line}" }
+            handle_error(client_conn, e)
           ensure
             client_conn.close
           end
@@ -51,14 +52,14 @@ module ForwardProxy
     rescue Interrupt
       shutdown
     rescue IOError, Errno::EBADF => e
-      log(e.message, "ERROR")
+      logger.error(e.message)
     end
 
     def shutdown
       if socket
-        log("Shutting down")
+        logger.info("Shutting down")
 
-        socket.close 
+        socket.close
       end
     end
 
@@ -66,10 +67,18 @@ module ForwardProxy
 
     attr_reader :socket, :thread_pool
 
+    # The following comments are from the IETF document
+    # "Hypertext Transfer Protocol -- HTTP/1.1: Basic Rules"
+    # https://datatracker.ietf.org/doc/html/rfc2616#section-2.2
+
     METHOD_CONNECT = "CONNECT"
     METHOD_GET = "GET"
     METHOD_POST = "POST"
 
+    # HTTP/1.1 defines the sequence CR LF as the end-of-line marker for all
+    # protocol elements except the entity-body.
+    HEADER_EOP = "\r\n"
+
     # 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
@@ -102,7 +111,10 @@ module ForwardProxy
       # 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"
+      client_conn.write <<~eos.chomp
+        HTTP/1.1 200 OK
+        #{HEADER_EOP}
+      eos
 
       # The CONNECT method requests that the recipient establish a tunnel to
       # the destination origin server identified by the request-target and,
@@ -119,17 +131,37 @@ module ForwardProxy
     def handle(client_conn, req)
       Net::HTTP.start(req.host, req.port) do |http|
         http.request(map_webrick_to_net_http_req(req)) do |resp|
+          # 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
+
+          # An intermediary MAY combine an ordered subsequence of Via header
+          # field entries into a single such entry if the entries have identical
+          # received-protocol values.  For example,
+          #
+          #   Via: 1.0 ricky, 1.1 ethel, 1.1 fred, 1.0 lucy
+          #
+          # could be collapsed to
+          #
+          #   Via: 1.0 ricky, 1.1 mertz, 1.0 lucy
+          #
+          # A sender SHOULD NOT combine multiple entries unless they are all
+          # under the same organizational control and the hosts have already been
+          # replaced by pseudonyms.  A sender MUST NOT combine entries that have
+          # different received-protocol values.
+          headers = resp.to_hash.merge(Via: [HEADER_VIA, resp['Via']].compact.join(', '))
+
           client_conn.puts <<~eos.chomp
             HTTP/1.1 #{resp.code}
-            Via: #{[HEADER_VIA, resp['Via']].compact.join(', ')}
-            #{resp.each.map { |header, value| "#{header}: #{value}" }.join("\n")}\n\n
+            #{headers.map { |header, value| "#{header}: #{value}" }.join("\n")}
+            #{HEADER_EOP}
           eos
 
-          # The following comments are taken from: 
+          # The following comments are taken from:
           # https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Streaming+Response+Bodies
-          
+
           # By default Net::HTTP reads an entire response into memory. If you are
-          # handling large files or wish to implement a progress bar you can 
+          # handling large files or wish to implement a progress bar you can
           # instead stream the body directly to an IO.
           resp.read_body do |chunk|
             client_conn << chunk
@@ -138,6 +170,27 @@ module ForwardProxy
       end
     end
 
+    def handle_error(client_conn, err)
+      status_code = case err
+                    when Errors::ConnectionTimeoutError then 504
+                    else
+                      502
+                    end
+
+      client_conn.puts <<~eos.chomp
+        HTTP/1.1 #{status_code}
+        Via: #{HEADER_VIA}
+        #{HEADER_EOP}
+      eos
+
+      logger.error(err.message)
+      logger.debug(err.backtrace.join("\n"))
+    end
+
+    def default_logger
+      Logger.new(STDOUT, level: :info)
+    end
+
     def map_webrick_to_net_http_req(req)
       req_headers = Hash[req.header.map { |k, v| [k, v.first] }]
 
@@ -154,7 +207,7 @@ module ForwardProxy
     def transfer(src_conn, dest_conn)
       IO.copy_stream(src_conn, dest_conn)
     rescue => e
-      log(e.message, "WARNING")
+      logger.warn(e.message)
     end
 
     def parse_req(client_conn)
@@ -164,9 +217,5 @@ module ForwardProxy
     rescue => e
       throw Errors::HTTPParseError.new(e.message)
     end
-
-    def log(str, level = 'INFO')
-      puts "[#{Time.now}] #{level} #{str}"
-    end
   end
 end

data/lib/forward_proxy/thread_pool.rb

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

data/lib/forward_proxy/version.rb

@@ -1,3 +1,3 @@
 module ForwardProxy
-  VERSION = "0.2.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forward-proxy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - James Moriarty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-07-17 00:00:00.000000000 Z
 dependencies: []
 description: Forward proxy using just Ruby standard libraries.
 email:
@@ -32,6 +32,7 @@ files:
 - exe/forward-proxy
 - forward-proxy.gemspec
 - lib/forward_proxy.rb
+- lib/forward_proxy/errors/connection_timeout_error.rb
 - lib/forward_proxy/errors/http_method_not_implemented.rb
 - lib/forward_proxy/errors/http_parse_error.rb
 - lib/forward_proxy/server.rb