forward-proxy 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e621e13501a70783e49eb16c52fd937974bc7e
-  data.tar.gz: 70488fc1e2147c6c181e1dbb102929fe81eb1ecb
+  metadata.gz: 3e94626ce91d870564fcbed5db9133ddee5a1167
+  data.tar.gz: 44c9c4e4ca3a4036a8c1e9698dac6a203c3fe367
 SHA512:
-  metadata.gz: b5bd0ed7c697ea9ea8e3fb973e31f44947b2c9c5d1b7c23cc025580f82c3cdf16aaf238a9e0b831397c69bf803b5d04f02212553de968dfece8c52c5d1688104
-  data.tar.gz: 9a0b6db5127d71f0351577232d744ff0497c04c35a6a6e70580894d109dd160910b7ec4144134c295bafd35add0c3a9d6e57c6c47f63ca7ec92f16c67fa10c67
+  metadata.gz: c13a9fa915fb77699702226408cbd160d61cd375789beb947299423c788594c7f5d7af3783624fcf5fb30e8521e8a5e98c4953e7f1b5c7e477a756bda153634b
+  data.tar.gz: 609126058336e8cc597c0df21b3a3cb65c4d1216d7af11d77dec09eda104c6277811d59b942d38c46f8776c0cf1b8f137d09778793343a88c138872f65b06b54

data/.github/workflows/cli.yaml

@@ -0,0 +1,25 @@
+name: Command Line Interface
+
+on: [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: gem install forward-proxy
+    - run: |
+        exe/forward-proxy --h
+        exe/forward-proxy --help
+        exe/forward-proxy --binding 127.0.0.1 --port 3001 --threads 2 &
+        sleep 1
+        curl --fail -x http://127.0.0.1:3001 https://google.com/

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.1.5
+
+- stream http proxy requests.
+- call shutdown on `Interrupt`
+- remove waiting for the thread-pool to finish on shutdown and just close the server conn.
+
 ## 0.1.4
 
 - `accept` connections via thread pool.

data/Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
+gem "yard", "~> 0.9"
 gem "minitest", "~> 5.0"
 gem "minitest-reporters", "~> 1.4"
 gem "simplecov", "~> 0.17"

data/README.md

@@ -2,7 +2,7 @@
 
 ![Gem Version][3] ![Gem][1] ![Build Status][2]
 
-100LOC Ruby forward proxy using just standard libraries.
+100 LOC Ruby forward proxy using only standard libraries.
 
 ```
 $ forward-proxy --binding 0.0.0.0 --port 3182 --threads 2

data/Rakefile

@@ -1,5 +1,12 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README', 'CHANGELOG', 'CODE_OF_CONDUCT']
+  t.options = []
+  t.stats_options = ['--list-undoc']
+end
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +14,16 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+namespace :gh do
+  desc "Deploy yard docs to github pages"
+  task :pages => :yard do
+    `git add -f doc`
+    `git commit -am "update: $(date)"`
+    `git subtree split --prefix doc -b gh-pages`
+    `git push -f origin gh-pages:gh-pages`
+    `git branch -D gh-pages`
+    `git reset head~1`
+  end
+end
+
 task :default => :test

data/lib/forward_proxy/server.rb

@@ -24,13 +24,14 @@ module ForwardProxy
       log("Listening #{bind_address}:#{bind_port}")
 
       loop do
-        # The following comments are from "man 2 accept"
+        # The following comments are from https://stackoverflow.com/q/5124320/273101
         #
-        # The argument socket is a socket that has been created with socket(2), bound to an address with bind(2), and is listening for connections after a listen(2).  accept() extracts the
-        # first connection request on the queue of pending connections, creates a new socket with the same properties of socket, and allocates a new file descriptor for the socket.  If no
-        # pending connections are present on the queue, and the socket is not marked as non-blocking, accept() blocks the caller until a connection is present.  If the socket is marked
-        # non-blocking and no pending connections are present on the queue, accept() returns an error as described below.  The accepted socket may not be used to accept more connections.
-        # The original socket socket, remains open.
+        # accept(): POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD (accept() first appeared in 4.2BSD).
+        #
+        # We see that POSIX.1-2008 is a viable reference (check this for a description of relevant
+        # standards for Linux systems). As already said in other answers, POSIX.1 standard specifies
+        # accept function as (POSIX-)thread safe (as defined in Base Definitions, section 3.399 Thread Safe)
+        # by not listing it on System Interfaces, section 2.9.1 Thread Safety.
         thread_pool.schedule(server.accept) do |client_conn|
           begin
             req = parse_req(client_conn)
@@ -44,9 +45,16 @@ module ForwardProxy
               raise HTTPMethodNotImplemented
             end
           rescue => e
+            # The following comments are from the IETF document
+            # "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"
+            # https://tools.ietf.org/html/rfc7231#section-6.6.3
+
+            # The 502 (Bad Gateway) status code indicates that the server, while
+            # acting as a gateway or proxy, received an invalid response from an
+            # inbound server it accessed while attempting to fulfill the request.
             client_conn.puts <<~eos.chomp
               HTTP/1.1 502
-              Server: ForwardProxy
+              Via: #{HEADER_VIA}
             eos
 
             puts e.message
@@ -57,15 +65,12 @@ module ForwardProxy
         end
       end
     rescue Interrupt
-      log("Exiting...")
-    rescue Errno::EBADF => e
+      shutdown
+    rescue IOError, Errno::EBADF => e
       log(e.message, "ERROR")
     end
 
     def shutdown
-      log("Closing client connections...")
-      thread_pool.shutdown
-
       log("Stoping server...")
       server.close if server
     end
@@ -78,6 +83,17 @@ module ForwardProxy
     METHOD_GET = "GET"
     METHOD_POST = "POST"
 
+    # 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 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.
+    HEADER_VIA = "HTTP/1.1 ForwardProxy"
+
     def handle_tunnel(client_conn, req)
       # The following comments are from the IETF document
       # "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"
@@ -114,22 +130,19 @@ module ForwardProxy
     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)
+      Net::HTTP.start(req.host, req.port) do |http|
+        http.request(map_webrick_to_net_http_req(req)) do |resp|
+          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
+          eos
+
+          resp.read_body do |chunk|
+            client_conn << chunk
+          end
+        end
       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)

data/lib/forward_proxy/version.rb

@@ -1,3 +1,3 @@
 module ForwardProxy
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forward-proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - James Moriarty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies: []
 description: Forward proxy using just Ruby standard libraries.
 email:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yaml"
+- ".github/workflows/cli.yaml"
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md