summaryrefslogtreecommitdiff
path: root/lib/net/ssh/proxy/http.rb
blob: e6edb6fa0a865a5910b8f180a5ba01adcf17dce0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
require 'socket'
require 'net/ssh/proxy/errors'

module Net 
  module SSH 
    module Proxy

      # An implementation of an HTTP proxy. To use it, instantiate it, then
      # pass the instantiated object via the :proxy key to Net::SSH.start:
      #
      #   require 'net/ssh/proxy/http'
      #
      #   proxy = Net::SSH::Proxy::HTTP.new('proxy_host', proxy_port)
      #   Net::SSH.start('host', 'user', :proxy => proxy) do |ssh|
      #     ...
      #   end
      #
      # If the proxy requires authentication, you can pass :user and :password
      # to the proxy's constructor:
      #
      #   proxy = Net::SSH::Proxy::HTTP.new('proxy_host', proxy_port,
      #      :user => "user", :password => "password")
      #
      # Note that HTTP digest authentication is not supported; Basic only at
      # this point.
      class HTTP
        # The hostname or IP address of the HTTP proxy.
        attr_reader :proxy_host
    
        # The port number of the proxy.
        attr_reader :proxy_port
    
        # The map of additional options that were given to the object at
        # initialization.
        attr_reader :options
    
        # Create a new socket factory that tunnels via the given host and
        # port. The +options+ parameter is a hash of additional settings that
        # can be used to tweak this proxy connection. Specifically, the following
        # options are supported:
        #
        # * :user => the user name to use when authenticating to the proxy
        # * :password => the password to use when authenticating
        def initialize(proxy_host, proxy_port=80, options={})
          @proxy_host = proxy_host
          @proxy_port = proxy_port
          @options = options
        end
    
        # Return a new socket connected to the given host and port via the
        # proxy that was requested when the socket factory was instantiated.
        def open(host, port, connection_options)
          socket = establish_connection(connection_options[:timeout])
          socket.write "CONNECT #{host}:#{port} HTTP/1.0\r\n"
    
          if options[:user]
            credentials = ["#{options[:user]}:#{options[:password]}"].pack("m*").gsub(/\s/, "")
            socket.write "Proxy-Authorization: Basic #{credentials}\r\n"
          end
    
          socket.write "\r\n"
    
          resp = parse_response(socket)
    
          return socket if resp[:code] == 200
    
          socket.close
          raise ConnectError, resp.inspect
        end
    
        protected
    
        def establish_connection(connect_timeout)
          Socket.tcp(proxy_host, proxy_port, nil, nil,
                     connect_timeout: connect_timeout)
        end
    
        def parse_response(socket)
          version, code, reason = socket.gets.chomp.split(/ /, 3)
          headers = {}
    
          while (line = socket.gets) && (line.chomp! != "")
            name, value = line.split(/:/, 2)
            headers[name.strip] = value.strip
          end
    
          body = socket.read(headers["Content-Length"].to_i) if headers["Content-Length"]
    
          return { version: version,
                   code: code.to_i,
                   reason: reason,
                   headers: headers,
                   body: body }
        end
      end

end; end; end