forward-proxy 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2f3ade2ec039aaadb19726b347d6cddb7db0f2590b91ab5d6eb69b8fd5c0aee
-  data.tar.gz: 0733602e8b7bab9e95df20cff04bc11981964260db17242460a2c26341a9032b
+  metadata.gz: 1d2b9dbd7abcfa81bcdbd29b6dd2045e6d2210e92b303f7cfcdc4ab35ab0b868
+  data.tar.gz: 729d4b7d964c8a5a3bec860f6bceb669a12225900a01b4737de8fdf6ba02a049
 SHA512:
-  metadata.gz: 9c25af1d60872d711a475028eddc06bc54ee7dd609cd3cbd1858ff667a1facb5e1cfb7ca38889ab7a8603d018a6c69e4b56ee11eaba525818f2cd0bf0a7b59c5
-  data.tar.gz: d105d9a16183951129e62ed1b905a12e12f251541154e90869bb9a74449c10925ec19e3f3fce8d9300f7af38a00dcf6aa26e0a4f2d37ca9882a1bc64a494cba8
+  metadata.gz: 70c0b51f0313e4ffedd1146ae93035db45bc8fe3a7cee647ea11cb0397d6862e99047befbc39aee6a08b17fd1e3d16394eb59ad9ad092140ea9354da10feadf6
+  data.tar.gz: b0f3587f3c08b255be222f8f59530e19b5fcc6e589f93eafb1eaa21fac832a0f01847dfcf309ed443e51fdafd96a516241143c1a75795b3d09f0ce7088eedac0

data/lib/forward_proxy/server.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'socket'
 require 'webrick'
 require 'net/http'
@@ -7,9 +8,10 @@ require 'forward_proxy/thread_pool'
 
 module ForwardProxy
   class Server
-    attr_reader :bind_address, :bind_port
+    attr_reader :bind_address, :bind_port, :logger
 
-    def initialize(bind_address: "127.0.0.1", bind_port: 9292, threads: 32)
+    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)
       @bind_address = bind_address
       @bind_port = bind_port
@@ -20,14 +22,14 @@ 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)
 
-            log(req.request_line)
+            logger.info(req.request_line)
 
             case req.request_method
             when METHOD_CONNECT then handle_tunnel(client_conn, req)
@@ -45,12 +47,12 @@ 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
       end
@@ -60,10 +62,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
@@ -96,7 +106,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,
@@ -113,11 +126,30 @@ 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|
-          headers= resp.to_hash.merge(Via: [HEADER_VIA, resp['Via']].compact.join(', '))
+          # 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}
-            #{headers.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:
@@ -137,10 +169,12 @@ module ForwardProxy
       client_conn.puts <<~eos.chomp
         HTTP/1.1 502
         Via: #{HEADER_VIA}
+        #{HEADER_EOP}
       eos
 
-      log(err.message, "ERROR")
-      puts err.backtrace.map { |line| "  #{line}" }
+      logger.error(err.message)
+
+      logger.debug(err.backtrace.join("\n"))
     end
 
     def map_webrick_to_net_http_req(req)
@@ -159,7 +193,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)
@@ -169,9 +203,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/version.rb

@@ -1,3 +1,3 @@
 module ForwardProxy
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forward-proxy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Moriarty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-07-04 00:00:00.000000000 Z
 dependencies: []
 description: Forward proxy using just Ruby standard libraries.
 email: