forward-proxy 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d2b9dbd7abcfa81bcdbd29b6dd2045e6d2210e92b303f7cfcdc4ab35ab0b868
-  data.tar.gz: 729d4b7d964c8a5a3bec860f6bceb669a12225900a01b4737de8fdf6ba02a049
+  metadata.gz: a1fe517be17887550c0afe7d8ad757227d79667083ad5530aa714a8e0b2398be
+  data.tar.gz: 574b65e5fd8bf6e324f0657f8bfc87342481c5f177c87f1e9f2cffe49953db17
 SHA512:
-  metadata.gz: 70c0b51f0313e4ffedd1146ae93035db45bc8fe3a7cee647ea11cb0397d6862e99047befbc39aee6a08b17fd1e3d16394eb59ad9ad092140ea9354da10feadf6
-  data.tar.gz: b0f3587f3c08b255be222f8f59530e19b5fcc6e589f93eafb1eaa21fac832a0f01847dfcf309ed443e51fdafd96a516241143c1a75795b3d09f0ce7088eedac0
+  metadata.gz: 34d36e4bfc21abaf59a75ecec4fa86b5d9157beb5e7f7437201f15689f584fb92076f6db5095929d52062b6c543a53d65bc81393bc5013204206d8f2c041c4d2
+  data.tar.gz: 4e7c99b2485929fe9fb93da86256bd642ff56f8f93207b3cdd0eccc6606d4c6f53d64514adbf550831062185390ae5b1327619bfa26dcd2631ca817acab6c36d

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
@@ -38,7 +38,8 @@ 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
+    -t, --timeout=TIMEOUT            Specify the connection timeout in seconds. Default: 300
+    -c, --threads=THREADS            Specify the number of client threads. Default: 128
     -h, --help                       Prints this help.
 ```
 

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 timeout 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/errors/connection_timeout_error.rb

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

data/lib/forward_proxy/server.rb

@@ -1,20 +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, :logger
+    attr_reader :bind_address, :bind_port, :logger, :timeout
 
-    def initialize(bind_address: "127.0.0.1", bind_port: 9292, threads: 32, logger: Logger.new(STDOUT, level: :info))
-      @logger = logger
-      @thread_pool = ThreadPool.new(threads)
+    def initialize(bind_address: "127.0.0.1", bind_port: 9292, threads: 4, timeout: 300, logger: default_logger)
       @bind_address = bind_address
       @bind_port = bind_port
+      @logger = logger
+      @thread_pool = ThreadPool.new(threads)
+      @timeout = timeout
     end
 
     def start
@@ -27,18 +30,20 @@ module ForwardProxy
       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)
 
-            logger.info(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 => err
-            handle_error(err, client_conn)
+          rescue => e
+            handle_error(client_conn, e)
           ensure
             client_conn.close
           end
@@ -130,20 +135,20 @@ module ForwardProxy
           # "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,
+          # 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
+          #   Via: 1.0 ricky, 1.1 ethel, 1.1 fred, 1.0 lucy
           #
-          #  could be collapsed to
+          # could be collapsed to
           #
-          #    Via: 1.0 ricky, 1.1 mertz, 1.0 lucy
+          #   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.
+          # 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
@@ -165,18 +170,27 @@ module ForwardProxy
       end
     end
 
-    def handle_error(err, client_conn)
+    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 502
+        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] }]
 

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.4.0"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forward-proxy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - James Moriarty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-04 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