~ubuntu-branches/ubuntu/trusty/ruby-net-ssh/trusty-proposed

« back to all changes in this revision

Viewing changes to lib/net/ssh/proxy/http.rb

  • Committer: Bazaar Package Importer
  • Author(s): Lucas Nussbaum
  • Date: 2011-04-16 09:31:22 UTC
  • Revision ID: james.westby@ubuntu.com-20110416093122-rs6psd42v2hr371a
Tags: upstream-2.1.4
ImportĀ upstreamĀ versionĀ 2.1.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
require 'socket'
 
2
require 'net/ssh/proxy/errors'
 
3
 
 
4
module Net; module SSH; module Proxy
 
5
 
 
6
  # An implementation of an HTTP proxy. To use it, instantiate it, then
 
7
  # pass the instantiated object via the :proxy key to Net::SSH.start:
 
8
  #
 
9
  #   require 'net/ssh/proxy/http'
 
10
  #
 
11
  #   proxy = Net::SSH::Proxy::HTTP.new('proxy.host', proxy_port)
 
12
  #   Net::SSH.start('host', 'user', :proxy => proxy) do |ssh|
 
13
  #     ...
 
14
  #   end
 
15
  #
 
16
  # If the proxy requires authentication, you can pass :user and :password
 
17
  # to the proxy's constructor:
 
18
  #
 
19
  #   proxy = Net::SSH::Proxy::HTTP.new('proxy.host', proxy_port,
 
20
  #      :user => "user", :password => "password")
 
21
  #
 
22
  # Note that HTTP digest authentication is not supported; Basic only at
 
23
  # this point.
 
24
  class HTTP
 
25
 
 
26
    # The hostname or IP address of the HTTP proxy.
 
27
    attr_reader :proxy_host
 
28
 
 
29
    # The port number of the proxy.
 
30
    attr_reader :proxy_port
 
31
 
 
32
    # The map of additional options that were given to the object at
 
33
    # initialization.
 
34
    attr_reader :options
 
35
 
 
36
    # Create a new socket factory that tunnels via the given host and
 
37
    # port. The +options+ parameter is a hash of additional settings that
 
38
    # can be used to tweak this proxy connection. Specifically, the following
 
39
    # options are supported:
 
40
    #
 
41
    # * :user => the user name to use when authenticating to the proxy
 
42
    # * :password => the password to use when authenticating
 
43
    def initialize(proxy_host, proxy_port=80, options={})
 
44
      @proxy_host = proxy_host
 
45
      @proxy_port = proxy_port
 
46
      @options = options
 
47
    end
 
48
 
 
49
    # Return a new socket connected to the given host and port via the
 
50
    # proxy that was requested when the socket factory was instantiated.
 
51
    def open(host, port)
 
52
      socket = TCPSocket.new(proxy_host, proxy_port)
 
53
      socket.write "CONNECT #{host}:#{port} HTTP/1.0\r\n"
 
54
 
 
55
      if options[:user]
 
56
        credentials = ["#{options[:user]}:#{options[:password]}"].pack("m*").gsub(/\s/, "")
 
57
        socket.write "Proxy-Authorization: Basic #{credentials}\r\n"
 
58
      end
 
59
 
 
60
      socket.write "\r\n"
 
61
 
 
62
      resp = parse_response(socket)
 
63
 
 
64
      return socket if resp[:code] == 200
 
65
 
 
66
      socket.close
 
67
      raise ConnectError, resp.inspect
 
68
    end
 
69
 
 
70
    private
 
71
 
 
72
      def parse_response(socket)
 
73
        version, code, reason = socket.gets.chomp.split(/ /, 3)
 
74
        headers = {}
 
75
 
 
76
        while (line = socket.gets.chomp) != ""
 
77
          name, value = line.split(/:/, 2)
 
78
          headers[name.strip] = value.strip
 
79
        end
 
80
 
 
81
        if headers["Content-Length"]
 
82
          body = socket.read(headers["Content-Length"].to_i)
 
83
        end
 
84
 
 
85
        return { :version => version,
 
86
                 :code => code.to_i,
 
87
                 :reason => reason,
 
88
                 :headers => headers,
 
89
                 :body => body }
 
90
      end
 
91
 
 
92
  end
 
93
 
 
94
end; end; end