An HTTP Proxy server which proxies GET, HEAD and POST requests.

Methods
C
D
N
P
S
Constants
HopByHop = %w( connection keep-alive proxy-authenticate upgrade proxy-authorization te trailers transfer-encoding )
 

Some header fields should not be transferred.

ShouldNotTransfer = %w( set-cookie proxy-connection )
 
Class Public methods
new(config={}, default=Config::HTTP)

Proxy server configurations. The proxy server handles the following configuration items in addition to those supported by HTTPServer:

:ProxyAuthProc

Called with a request and response to authorize a request

:ProxyVia

Appended to the via header

:ProxyURI

The proxy server's URI

:ProxyContentHandler

Called with a request and resopnse and allows modification of the response

:ProxyTimeout

Sets the proxy timeouts to 30 seconds for open and 60 seconds for read operations

# File ../ruby/lib/webrick/httpproxy.rb, line 54
def initialize(config={}, default=Config::HTTP)
  super(config, default)
  c = @config
  @via = "#{c[:HTTPVersion]} #{c[:ServerName]}:#{c[:Port]}"
end
Instance Public methods
do_CONNECT(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 102
def do_CONNECT(req, res)
  # Proxy Authentication
  proxy_auth(req, res)

  ua = Thread.current[:WEBrickSocket]  # User-Agent
  raise HTTPStatus::InternalServerError,
    "[BUG] cannot get socket" unless ua

  host, port = req.unparsed_uri.split(":", 2)
  # Proxy authentication for upstream proxy server
  if proxy = proxy_uri(req, res)
    proxy_request_line = "CONNECT #{host}:#{port} HTTP/1.0"
    if proxy.userinfo
      credentials = "Basic " + [proxy.userinfo].pack("m").delete("\n")
    end
    host, port = proxy.host, proxy.port
  end

  begin
    @logger.debug("CONNECT: upstream proxy is `#{host}:#{port}'.")
    os = TCPSocket.new(host, port)     # origin server

    if proxy
      @logger.debug("CONNECT: sending a Request-Line")
      os << proxy_request_line << CRLF
      @logger.debug("CONNECT: > #{proxy_request_line}")
      if credentials
        @logger.debug("CONNECT: sending a credentials")
        os << "Proxy-Authorization: " << credentials << CRLF
      end
      os << CRLF
      proxy_status_line = os.gets(LF)
      @logger.debug("CONNECT: read a Status-Line form the upstream server")
      @logger.debug("CONNECT: < #{proxy_status_line}")
      if %r{^HTTP/\d+\.\d+\s+200\s*} =~ proxy_status_line
        while line = os.gets(LF)
          break if /\A(#{CRLF}|#{LF})\z/om =~ line
        end
      else
        raise HTTPStatus::BadGateway
      end
    end
    @logger.debug("CONNECT #{host}:#{port}: succeeded")
    res.status = HTTPStatus::RC_OK
  rescue => ex
    @logger.debug("CONNECT #{host}:#{port}: failed `#{ex.message}'")
    res.set_error(ex)
    raise HTTPStatus::EOFError
  ensure
    if handler = @config[:ProxyContentHandler]
      handler.call(req, res)
    end
    res.send_response(ua)
    access_log(@config, req, res)

    # Should clear request-line not to send the sesponse twice.
    # see: HTTPServer#run
    req.parse(NullReader) rescue nil
  end

  begin
    while fds = IO::select([ua, os])
      if fds[0].member?(ua)
        buf = ua.sysread(1024);
        @logger.debug("CONNECT: #{buf.bytesize} byte from User-Agent")
        os.syswrite(buf)
      elsif fds[0].member?(os)
        buf = os.sysread(1024);
        @logger.debug("CONNECT: #{buf.bytesize} byte from #{host}:#{port}")
        ua.syswrite(buf)
      end
    end
  rescue => ex
    os.close
    @logger.debug("CONNECT #{host}:#{port}: closed")
  end

  raise HTTPStatus::EOFError
end
do_GET(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 182
def do_GET(req, res)
  perform_proxy_request(req, res) do |http, path, header|
    http.get(path, header)
  end
end
do_HEAD(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 188
def do_HEAD(req, res)
  perform_proxy_request(req, res) do |http, path, header|
    http.head(path, header)
  end
end
do_OPTIONS(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 200
def do_OPTIONS(req, res)
  res['allow'] = "GET,HEAD,POST,OPTIONS,CONNECT"
end
do_POST(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 194
def do_POST(req, res)
  perform_proxy_request(req, res) do |http, path, header|
    http.post(path, req.body || "", header)
  end
end
proxy_auth(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 70
def proxy_auth(req, res)
  if proc = @config[:ProxyAuthProc]
    proc.call(req, res)
  end
  req.header.delete("proxy-authorization")
end
proxy_service(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 82
def proxy_service(req, res)
  # Proxy Authentication
  proxy_auth(req, res)

  begin
    self.send("do_#{req.request_method}", req, res)
  rescue NoMethodError
    raise HTTPStatus::MethodNotAllowed,
      "unsupported method `#{req.request_method}'."
  rescue => err
    logger.debug("#{err.class}: #{err.message}")
    raise HTTPStatus::ServiceUnavailable, err.message
  end

  # Process contents
  if handler = @config[:ProxyContentHandler]
    handler.call(req, res)
  end
end
proxy_uri(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 77
def proxy_uri(req, res)
  # should return upstream proxy server's URI
  return @config[:ProxyURI]
end
service(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 60
def service(req, res)
  if req.request_method == "CONNECT"
    do_CONNECT(req, res)
  elsif req.unparsed_uri =~ %r^http://!
    proxy_service(req, res)
  else
    super(req, res)
  end
end
Instance Private methods
choose_header(src, dst)
# File ../ruby/lib/webrick/httpproxy.rb, line 212
def choose_header(src, dst)
  connections = split_field(src['connection'])
  src.each{|key, value|
    key = key.downcase
    if HopByHop.member?(key)          || # RFC2616: 13.5.1
       connections.member?(key)       || # RFC2616: 14.10
       ShouldNotTransfer.member?(key)    # pragmatics
      @logger.debug("choose_header: `#{key}: #{value}'")
      next
    end
    dst[key] = value
  }
end
perform_proxy_request(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 273
def perform_proxy_request(req, res)
  uri = req.request_uri
  path = uri.path.dup
  path << "?" << uri.query if uri.query
  header = setup_proxy_header(req, res)
  upstream = setup_upstream_proxy_authentication(req, res, header)
  response = nil

  http = Net::HTTP.new(uri.host, uri.port, upstream.host, upstream.port)
  http.start do
    if @config[:ProxyTimeout]
      ##################################   these issues are
      http.open_timeout = 30   # secs  #   necessary (maybe bacause
      http.read_timeout = 60   # secs  #   Ruby's bug, but why?)
      ##################################
    end
    response = yield(http, path, header)
  end

  # Persistent connection requirements are mysterious for me.
  # So I will close the connection in every response.
  res['proxy-connection'] = "close"
  res['connection'] = "close"

  # Convert Net::HTTP::HTTPResponse to WEBrick::HTTPResponse
  res.status = response.code.to_i
  choose_header(response, res)
  set_cookie(response, res)
  set_via(res)
  res.body = response.body
end

Net::HTTP is stupid about the multiple header fields. Here is workaround:

set_via(h)
# File ../ruby/lib/webrick/httpproxy.rb, line 244
def set_via(h)
  if @config[:ProxyVia]
    if  h['via']
      h['via'] << ", " << @via
    else
      h['via'] = @via
    end
  end
end
setup_proxy_header(req, res)
# File ../ruby/lib/webrick/httpproxy.rb, line 254
def setup_proxy_header(req, res)
  # Choose header fields to transfer
  header = Hash.new
  choose_header(req, header)
  set_via(header)
  return header
end
setup_upstream_proxy_authentication(req, res, header)
# File ../ruby/lib/webrick/httpproxy.rb, line 262
def setup_upstream_proxy_authentication(req, res, header)
  if upstream = proxy_uri(req, res)
    if upstream.userinfo
      header['proxy-authorization'] =
        "Basic " + [upstream.userinfo].pack("m").delete("\n")
    end
    return upstream
  end
  return FakeProxyURI
end
split_field(f)
# File ../ruby/lib/webrick/httpproxy.rb, line 210
def split_field(f) f ? f.split(/,\s+/).collect{|i| i.downcase } : [] end