Merge pull request #186 from Connorhd/https-through-proxy-support

First attempt at supporting https connections through proxy

.rubocop.yml

@@ -3,7 +3,7 @@ Metrics/BlockNesting:
 
 Metrics/ClassLength:
   CountComments: false
-  Max: 110
+  Max: 120
 
 Metrics/PerceivedComplexity:
   Max: 8

lib/http/client.rb

@@ -72,8 +72,11 @@ def make_request(req, options)
       @state = :dirty
 
       @connection ||= HTTP::Connection.new(req, options)
-      @connection.send_request(req)
-      @connection.read_headers!
+
+      unless @connection.failed_proxy_connect?
+        @connection.send_request(req)
+        @connection.read_headers!
+      end
 
       res = Response.new(
         @connection.status_code,

lib/http/connection.rb

@@ -6,6 +6,7 @@ module HTTP
   # A connection to the HTTP server
   class Connection
     extend Forwardable
+
     # Attempt to read this much data
     BUFFER_SIZE = 16_384
 
@@ -18,16 +19,18 @@ class Connection
     # @param [HTTP::Request] req
     # @param [HTTP::Options] options
     def initialize(req, options)
-      @persistent         = options.persistent?
-      @keep_alive_timeout = options[:keep_alive_timeout].to_f
-      @pending_request    = false
-      @pending_response   = false
+      @persistent           = options.persistent?
+      @keep_alive_timeout   = options[:keep_alive_timeout].to_f
+      @pending_request      = false
+      @pending_response     = false
+      @failed_proxy_connect = false
 
       @parser = Response::Parser.new
 
       @socket = options[:timeout_class].new(options[:timeout_options])
       @socket.connect(options[:socket_class], req.socket_host, req.socket_port)
 
+      send_proxy_connect_request(req)
       start_tls(req, options)
       reset_timer
     end
@@ -41,6 +44,11 @@ def initialize(req, options)
     # @see (HTTP::Response::Parser#headers)
     def_delegator :@parser, :headers
 
+    # @return [Boolean] whenever proxy connect failed
+    def failed_proxy_connect?
+      @failed_proxy_connect
+    end
+
     # Send a request to the server
     #
     # @param [Request] Request to send to the server
@@ -129,7 +137,7 @@ def expired?
     # @param (see #initialize)
     # @return [void]
     def start_tls(req, options)
-      return unless req.uri.https? && !req.using_proxy?
+      return unless req.uri.https? && !failed_proxy_connect?
 
       ssl_context = options[:ssl_context]
 
@@ -141,6 +149,28 @@ def start_tls(req, options)
       @socket.start_tls(req.uri.host, options[:ssl_socket_class], ssl_context)
     end
 
+    # Open tunnel through proxy
+    def send_proxy_connect_request(req)
+      return unless req.uri.https? && req.using_proxy?
+
+      @pending_request = true
+
+      req.connect_using_proxy @socket
+
+      @pending_request = false
+      @pending_response = true
+
+      read_headers!
+
+      if @parser.status_code == 200
+        @parser.reset
+        @pending_response = false
+        return
+      end
+
+      @failed_proxy_connect = true
+    end
+
     # Resets expiration of persistent connection.
     # @return [void]
     def reset_timer

lib/http/request.rb

@@ -97,7 +97,7 @@ def redirect(uri, verb = @verb)
 
     # Stream the request to a socket
     def stream(socket)
-      include_proxy_authorization_header if using_authenticated_proxy?
+      include_proxy_authorization_header if using_authenticated_proxy? && !@uri.https?
       Request::Writer.new(socket, body, headers, request_header).stream
     end
 
@@ -113,15 +113,39 @@ def using_authenticated_proxy?
 
     # Compute and add the Proxy-Authorization header
     def include_proxy_authorization_header
-      digest = Base64.encode64("#{proxy[:proxy_username]}:#{proxy[:proxy_password]}").chomp
-      headers["Proxy-Authorization"] = "Basic #{digest}"
+      headers["Proxy-Authorization"] = proxy_authorization_header
+    end
+
+    def proxy_authorization_header
+      digest = Base64.strict_encode64("#{proxy[:proxy_username]}:#{proxy[:proxy_password]}")
+      "Basic #{digest}"
+    end
+
+    # Setup tunnel through proxy for SSL request
+    def connect_using_proxy(socket)
+      Request::Writer.new(socket, nil, proxy_connect_headers, proxy_connect_header).connect_through_proxy
     end
 
     # Compute HTTP request header for direct or proxy request
     def request_header
       "#{verb.to_s.upcase} #{uri.normalize} HTTP/#{version}"
     end
 
+    # Compute HTTP request header SSL proxy connection
+    def proxy_connect_header
+      "CONNECT #{@uri.host}:#{@uri.port} HTTP/#{version}"
+    end
+
+    # Headers to send with proxy connect request
+    def proxy_connect_headers
+      connect_headers = HTTP::Headers.coerce(
+        "Host" => headers["Host"],
+        "User-Agent" => headers["User-Agent"]
+      )
+      connect_headers["Proxy-Authorization"] = proxy_authorization_header if using_authenticated_proxy?
+      connect_headers
+    end
+
     # Host for tcp socket
     def socket_host
       using_proxy? ? proxy[:proxy_address] : host

lib/http/request/writer.rb

@@ -29,6 +29,12 @@ def stream
         send_request_body
       end
 
+      # Send headers needed to connect through proxy
+      def connect_through_proxy
+        add_headers
+        @socket << join_headers
+      end
+
       # Adds the headers to the header array for the given request body we are working
       # with
       def add_body_type_headers
@@ -50,9 +56,8 @@ def join_headers
       def send_request_header
         add_headers
         add_body_type_headers
-        header = join_headers
 
-        @socket << header
+        @socket << join_headers
       end
 
       def send_request_body

spec/lib/http_spec.rb

@@ -5,6 +5,11 @@
 
 RSpec.describe HTTP do
   run_server(:dummy) { DummyServer.new }
+  run_server(:dummy_ssl) { DummyServer.new(:ssl => true) }
+
+  let(:ssl_client) do
+    HTTP::Client.new :ssl_context => SSLHelper.client_context
+  end
 
   context "getting resources" do
     it "is easy" do
@@ -63,6 +68,18 @@
         response = HTTP.via(proxy.addr, proxy.port, "username", "password").get dummy.endpoint
         expect(response.to_s).to match(/<!doctype html>/)
       end
+
+      context "ssl" do
+        it "responds with the endpoint's body" do
+          response = ssl_client.via(proxy.addr, proxy.port).get dummy_ssl.endpoint
+          expect(response.to_s).to match(/<!doctype html>/)
+        end
+
+        it "ignores credentials" do
+          response = ssl_client.via(proxy.addr, proxy.port, "username", "password").get dummy_ssl.endpoint
+          expect(response.to_s).to match(/<!doctype html>/)
+        end
+      end
     end
 
     context "proxy with authentication" do
@@ -87,6 +104,23 @@
         response = HTTP.via(proxy.addr, proxy.port).get dummy.endpoint
         expect(response.status).to eq(407)
       end
+
+      context "ssl" do
+        it "responds with the endpoint's body" do
+          response = ssl_client.via(proxy.addr, proxy.port, "username", "password").get dummy_ssl.endpoint
+          expect(response.to_s).to match(/<!doctype html>/)
+        end
+
+        it "responds with 407 when wrong credentials given" do
+          response = ssl_client.via(proxy.addr, proxy.port, "user", "pass").get dummy_ssl.endpoint
+          expect(response.status).to eq(407)
+        end
+
+        it "responds with 407 if no credentials given" do
+          response = ssl_client.via(proxy.addr, proxy.port).get dummy_ssl.endpoint
+          expect(response.status).to eq(407)
+        end
+      end
     end
   end