Class: Falcon::Middleware::Proxy

Inherits:
Protocol::HTTP::Middleware
  • Object
show all
Defined in:
lib/falcon/middleware/proxy.rb

Overview

A HTTP middleware for proxying requests to a given set of hosts. Typically used for implementing virtual servers.

Constant Summary collapse

FORWARDED = 
'forwarded'
X_FORWARDED_FOR = 
'x-forwarded-for'
X_FORWARDED_PROTO = 
'x-forwarded-proto'
VIA = 
'via'
CONNECTION = 
'connection'
HOP_HEADERS =

HTTP hop headers which should not be passed through the proxy.

[
	'connection',
	'keep-alive',
	'public',
	'proxy-authenticate',
	'transfer-encoding',
	'upgrade',
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, hosts) ⇒ Proxy

Initialize the proxy middleware.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/falcon/middleware/proxy.rb', line 45

def initialize(app, hosts)
	super(app)
	
	@server_context = nil
	
	@hosts = hosts
	@clients = {}
	
	@count = 0
end

Instance Attribute Details

#count ⇒ Object (readonly)

The number of requests that have been proxied.



58
59
60
 
# File 'lib/falcon/middleware/proxy.rb', line 58

def count
  @count
end

Instance Method Details

#call(request) ⇒ Object

Proxy the request if the authority matches a specific host.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/falcon/middleware/proxy.rb', line 131

def call(request)
	if host = lookup(request)
		@count += 1
		
		request = self.prepare_request(request, host)
		
		client = connect(host.endpoint)
		
		client.call(request)
	else
		super
	end
rescue
	Console.logger.error(self) {$!}
	return Protocol::HTTP::Response[502, {'content-type' => 'text/plain'}, ["#{$!.inspect}: #{$!.backtrace.join("\n")}"]]
end

#close ⇒ Object

Close all the connections to the upstream hosts.



61
62
63
64
65
 
# File 'lib/falcon/middleware/proxy.rb', line 61

def close
	@clients.each_value(&:close)
	
	super
end

#connect(endpoint) ⇒ Object

Establish a connection to the specified upstream endpoint.



69
70
71
 
# File 'lib/falcon/middleware/proxy.rb', line 69

def connect(endpoint)
	@clients[endpoint] ||= Async::HTTP::Client.new(endpoint)
end

#lookup(request) ⇒ Object

Lookup the appropriate host for the given request.



76
77
78
79
80
81
 
# File 'lib/falcon/middleware/proxy.rb', line 76

def lookup(request)
	# Trailing dot and port is ignored/normalized.
	if authority = request.authority&.sub(/(\.)?(:\d+)?$/, '')
		return @hosts[authority]
	end
end

#prepare_headers(headers) ⇒ Object

Prepare the headers to be sent to an upstream host. In particular, we delete all connection and hop headers.



85
86
87
88
89
90
91
 
# File 'lib/falcon/middleware/proxy.rb', line 85

def prepare_headers(headers)
	if connection = headers[CONNECTION]
		headers.extract(connection)
	end
	
	headers.extract(HOP_HEADERS)
end

#prepare_request(request, host) ⇒ Object

Prepare the request to be proxied to the specified host. In particular, we set appropriate VIA, FORWARDED, X_FORWARDED_FOR and X_FORWARDED_PROTO headers.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/falcon/middleware/proxy.rb', line 95

def prepare_request(request, host)
	forwarded = []
	
	Console.logger.debug(self) do |buffer|
		buffer.puts "Request authority: #{request.authority}"
		buffer.puts "Host authority: #{host.authority}"
		buffer.puts "Request: #{request.method} #{request.path} #{request.version}"
		buffer.puts "Request headers: #{request.headers.inspect}"
	end
	
	# The authority of the request must match the authority of the endpoint we are proxying to, otherwise SNI and other things won't work correctly.
	request.authority = host.authority
	
	if address = request.remote_address
		request.headers.add(X_FORWARDED_FOR, address.ip_address)
		forwarded << "for=#{address.ip_address}"
	end
	
	if scheme = request.scheme
		request.headers.add(X_FORWARDED_PROTO, scheme)
		forwarded << "proto=#{scheme}"
	end
	
	unless forwarded.empty?
		request.headers.add(FORWARDED, forwarded.join(';'))
	end
	
	request.headers.add(VIA, "#{request.version} #{self.class}")
	
	self.prepare_headers(request.headers)
	
	return request
end