forward-proxy 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf19df114eeec55eaef8765999561904d8f5b6cd91b7ed2016053ec9e717408
-  data.tar.gz: ce712f520c0ed32b93ea211ff658d330bef7eeb26c2ddfcea1246d955ce78175
+  metadata.gz: 3018291ebebbfa87a02ba1409fa3f0c0af9b5d0ffb8917636dd4f8e397d8a4fb
+  data.tar.gz: dd3420d19ee1ac89064d7fd965768072cc25ce100555a4dc59881530fc2b6d66
 SHA512:
-  metadata.gz: b71608455b079161950b09521d8fd99496767463f3e2aa0f0d293f21e3955b03d7b0ba12f06f3b3df1ff6674d598ed2e7eec7492ffb8fd9047ebb19771625251
-  data.tar.gz: '092035474f162e29d2c7d0735b43cd38e41580aadca7ae50e97e02dee8e6f3825f50393497c0a8db8a5e0b3622d3e44e25e69e03ae02b56eba1cad55abdc1388'
+  metadata.gz: c1676662f33627745b09c2049957a4232885862bac77ba4f1ecb48b085683ef832825d2a0b15c725bdf6553456bb710c1b847f4027e55e8ed31c1c31aa1b307f
+  data.tar.gz: '08652da6a675acfb0c371d571bad140d3a50673d76d2aae74ea6a33f2b4f1e21b07f3378fcaaf74099d6fe93de29cc923108c1d278a9364b885b80a405951643'

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

@@ -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,12 @@ OptionParser.new do |parser|
     options[:bind_address] = bind_address
   end
 
-  parser.on("-tTHREADS", "--threads=THREADS", Integer,
+  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: 128, logger: default_logger)
+    def initialize(bind_address: "127.0.0.1", bind_port: 9292, threads: 128, 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.strip)
+              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
-            handle_error(e, client_conn)
+            handle_error(client_conn, e)
           ensure
             client_conn.close
           end
@@ -62,14 +67,14 @@ 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"
 
+    # 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
+
     # 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"
@@ -165,9 +170,15 @@ 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

data/lib/forward_proxy/thread_pool.rb

@@ -1,24 +1,29 @@
 module ForwardProxy
   class ThreadPool
-    attr_reader :queue, :size
+    attr_reader :queue, :size, :threads
 
     def initialize(size)
-      @size  = size
-      @queue = Queue.new
+      @queue   = Queue.new
+      @size    = size
+      @threads = []
     end
 
     def start
       size.times do
-        Thread.new do
+        thread = Thread.new do
           loop do
             job, args = queue.pop
             job.call(*args)
           end
         end
+
+        threads.push(thread)
       end
     end
 
     def schedule(*args, &block)
+      raise Exception, "no threads" unless threads.any?(&:alive?)
+
       queue.push([block, args])
     end
   end

data/lib/forward_proxy/version.rb

@@ -1,3 +1,3 @@
 module ForwardProxy
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forward-proxy
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - James Moriarty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-07-23 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