exports.version = [0, 5, 7];exports.version = [0, 5, 7];Track our own list of agents internal to node-http-proxy
var _agents = {};Retreives an agent from the http or https module
and sets the maxSockets property appropriately.
function _getAgent (host, port, secure) {
- var agent = !secure ? http.getAgent(host, port) : https.getAgent({
- host: host,
- port: port
- });
-
- agent.maxSockets = maxSockets;
- return agent;
-}httpscert if they exist in secure. Returns the maximum number of sockets
allowed on every outgoing request
made by all instances of HttpProxy
exports.getMaxSockets = function () {
return maxSockets;
-};Sets the maximum number of sockets
allowed on every outgoing request
made by all instances of HttpProxy
exports.setMaxSockets = function (value) {
maxSockets = value;
-};HttpProxy
proxy = new HttpProxy(options);
handler = function (req, res) {
- if (callback) { If we were passed a callback to process the request + if (callback) {
If we were passed a callback to process the request or response in some way, then call it.
callback(req, res, proxy);
}
- else if (port && host) {If we have a target host and port for the request + else if (port && host) {
If we have a target host and port for the request then proxy to the specified location.
proxy.proxyRequest(req, res, {
port: port,
host: host
});
}
- else if (proxy.proxyTable) {If the proxy is configured with a ProxyTable + else if (proxy.proxyTable) {
If the proxy is configured with a ProxyTable instance then use that before failing.
proxy.proxyRequest(req, res);
}
- else {Otherwise this server is improperly configured.
throw new Error('Cannot proxy without port, host, or router.')
+ else {Otherwise this server is improperly configured.
throw new Error('Cannot proxy without port, host, or router.')
}
};
@@ -144,19 +154,19 @@ instance then use that before failing. WebSocket support: if callback is empty tunnel -websocket request automatically
server.on('upgrade', function(req, socket, head) {Tunnel websocket requests too
+ if (!callback) {WebSocket support: if callback is empty tunnel +websocket request automatically
server.on('upgrade', function (req, socket, head) {Tunnel websocket requests too
proxy.proxyWebSocketRequest(req, socket, head, {
port: port,
host: host
});
});
}
- Set the proxy on the server so it is available +
Set the proxy on the server so it is available to the consumer of the server
server.proxy = proxy;
return server;
-};Setup basic proxying options
this.https = options.https;
this.forward = options.forward;
- this.target = options.target;
+ this.target = options.target || {};
+ Setup additional options for WebSocket proxying. When forcing
+the WebSocket handshake to change the sec-websocket-location
+and sec-websocket-origin headers options.source MUST
+be provided or the operation will fail with an origin mismatch
+by definition.
this.source = options.source || { host: 'localhost', port: 8000 };
this.changeOrigin = options.changeOrigin || false;
if (options.router) {
@@ -193,7 +206,7 @@ for managing the life-cycle of streaming reverse proxyied HTTP requests.
self.emit('routes', routes);
});
}
-};Inherit from events.EventEmitter
util.inherits(HttpProxy, events.EventEmitter);Inherit from events.EventEmitter
util.inherits(HttpProxy, events.EventEmitter);Frees the resources associated with this instance, if they exist.
HttpProxy.prototype.close = function () {
if (this.proxyTable) this.proxyTable.close();
-};HttpProxy.prototype.proxyRequest = function (req, res, options) {
var self = this, errState = false, location, outgoing, protocol, reverseProxy;
- Create an empty options hash if none is passed. +
Create an empty options hash if none is passed. If default options have been passed to the constructor of this instance, use them by default.
options = options || {};
options.host = options.host || this.target.host;
options.port = options.port || this.target.port;
- Check the proxy table for this instance to see if we need +
Check the proxy table for this instance to see if we need
to get the proxy location for the request supplied. We will
always ignore the proxyTable if an explicit port and host
arguments are supplied to proxyRequest.
if (this.proxyTable && !options.host) {
location = this.proxyTable.getProxyLocation(req);
- If no location is returned from the ProxyTable instance +
If no location is returned from the ProxyTable instance
then respond with 404 since we do not have a valid proxy target.
if (!location) {
res.writeHead(404);
return res.end();
}
- When using the ProxyTable in conjunction with an HttpProxy instance +
When using the ProxyTable in conjunction with an HttpProxy instance only the following arguments are valid:
options.port = location.port;
options.host = location.host;
}
- Add common proxy headers to the request so that they can +
Add common proxy headers to the request so that they can be availible to the proxy target server:
req.headers['x-forwarded-for'] = req.connection.remoteAddress || req.connection.socket.remoteAddress;
req.headers['x-forwarded-port'] = req.connection.remotePort || req.connection.socket.remotePort;
req.headers['x-forwarded-proto'] = res.connection.pair ? 'https' : 'http';
- Emit the start event indicating that we have begun the proxy operation.
this.emit('start', req, res, options);
- If forwarding is enabled for this instance, foward proxy the +
Emit the start event indicating that we have begun the proxy operation.
this.emit('start', req, res, options);
+ If forwarding is enabled for this instance, foward proxy the
specified request to the address provided in this.forward
if (this.forward) {
this.emit('forward', req, res, this.forward);
this._forwardRequest(req);
}
- Short-circuits res in the event of any error when
contacting the proxy target at host / port.
function proxyError(err) {
errState = true;
- Emit an error event, allowing the application to use custom
+
Emit an error event, allowing the application to use custom
error handling. The error handler should end the response.
if (self.emit('proxyError', err, req, res)) {
return;
}
res.writeHead(500, { 'Content-Type': 'text/plain' });
- if (req.method !== 'HEAD') {This NODE_ENV=production behavior is mimics Express and + if (req.method !== 'HEAD') {
This NODE_ENV=production behavior is mimics Express and Connect.
if (process.env.NODE_ENV === 'production') {
res.write('Internal Server Error');
}
@@ -332,18 +345,18 @@ Connect. Open new HTTP request to internal resource with will act as a reverse proxy pass
reverseProxy = protocol.request(outgoing, function (response) {
- Process the reverseProxy response when it's received.
if (response.headers.connection) {
+ Open new HTTP request to internal resource with will act as a reverse proxy pass
reverseProxy = protocol.request(outgoing, function (response) {
+ Process the reverseProxy response when it's received.
if (response.headers.connection) {
if (req.headers.connection) response.headers.connection = req.headers.connection;
else response.headers.connection = 'close';
- }Set the headers of the client response
res.writeHead(response.statusCode, response.headers);response.statusCode === 304: No 'data' event and no 'end'
if (response.statusCode === 304) {
+ }Set the headers of the client response
res.writeHead(response.statusCode, response.headers);response.statusCode === 304: No 'data' event and no 'end'
if (response.statusCode === 304) {
return res.end();
- }For each data chunk received from the reverseProxy
+ }
For each data chunk received from the reverseProxy
response write it to the outgoing res.
response.on('data', function (chunk) {
if (req.method !== 'HEAD') {
res.write(chunk);
}
- });When the reverseProxy response ends, end the
+ });
When the reverseProxy response ends, end the
corresponding outgoing res unless we have entered
an error state. In which case, assume res.end() has
already been called and the 'error' event listener
@@ -351,26 +364,26 @@ removed.
Emit the end event now that we have completed proxying
self.emit('end', req, res);
+ Emit the end event now that we have completed proxying
self.emit('end', req, res);
}
});
});
- Handle 'error' events from the reverseProxy.
reverseProxy.once('error', proxyError);
- For each data chunk received from the incoming
+
Handle 'error' events from the reverseProxy.
reverseProxy.once('error', proxyError);
+ For each data chunk received from the incoming
req write it to the reverseProxy request.
req.on('data', function (chunk) {
if (!errState) {
reverseProxy.write(chunk);
}
- });When the incoming req ends, end the corresponding reverseProxy
+ });
When the incoming req ends, end the corresponding reverseProxy
request unless we have entered an error state.
req.on('end', function () {
if (!errState) {
reverseProxy.end();
}
- });If we have been passed buffered data, resume it.
if (options.buffer && !errState) {
+ });If we have been passed buffered data, resume it.
if (options.buffer && !errState) {
options.buffer.resume();
}
};
- this.forward ignoring errors and the subsequent response.
path: req.url,
headers: req.headers
};
- Force the connection header to be 'close' until
+
Force the connection header to be 'close' until
node.js core re-implements 'keep-alive'.
outgoing.headers['connection'] = 'close';
protocol = _getProtocol(this.forward.https, outgoing);
- Open new HTTP request to internal resource with will act as a reverse proxy pass
forwardProxy = protocol.request(outgoing, function (response) {Ignore the response from the forward proxy since this is a 'fire-and-forget' proxy. +
Open new HTTP request to internal resource with will act as a reverse proxy pass
forwardProxy = protocol.request(outgoing, function (response) {Ignore the response from the forward proxy since this is a 'fire-and-forget' proxy. Remark (indexzero): We will eventually emit a 'forward' event here for performance tuning.
});
- Add a listener for the connection timeout event.
+Add a listener for the connection timeout event.
Remark: Ignoring this error in the event - forward target doesn't exist.
forwardProxy.once('error', function (err) { });Chunk the client request body as chunks from the proxied request come in
req.on('data', function (chunk) {
+ forward target doesn't exist. forwardProxy.once('error', function (err) { });Chunk the client request body as chunks from the proxied request come in
req.on('data', function (chunk) {
forwardProxy.write(chunk);
- })At the end of the client request, we are going to stop the proxied request
req.on('end', function () {
+ })At the end of the client request, we are going to stop the proxied request
req.on('end', function () {
forwardProxy.end();
});
-};
+};WebSocket requests has method = GET
if (req.method !== 'GET' || req.headers.upgrade.toLowerCase() !== 'websocket') {This request is not WebSocket request
return;
+@req {ServerRequest} Websocket request to proxy.
+
+@socket {net.Socket} Socket for the underlying HTTP request
+
+@head {string} Headers for the Websocket request.
+
+@options {Object} Options to use when proxying this request.
+
+options.port {number} Port to use on the proxy target host.
+options.host {string} Host of the proxy target.
+options.buffer {Object} Result from `httpProxy.buffer(req)`
+options.https {Object|boolean} Settings for https.
+
HttpProxy.prototype.proxyWebSocketRequest = function (req, socket, head, options) {
+ var self = this,
+ listeners = {},
+ errState = false,
+ CRLF = '\r\n',
+ outgoing;WebSocket requests must have the GET method and
+the upgrade:websocket header
if (req.method !== 'GET' || req.headers.upgrade.toLowerCase() !== 'websocket') {This request is not WebSocket request
return;
}
- Turn of all bufferings -For server set KeepAlive -For client set encoding
function _socket(socket, keepAlive) {
+ Helper function for setting appropriate socket values: +1. Turn of all bufferings +2. For server set KeepAlive +3. For client set encoding
function _socket(socket, keepAlive) {
socket.setTimeout(0);
socket.setNoDelay(true);
if (keepAlive) {
@@ -425,17 +456,18 @@ For client set encoding On upgrade from the Agent socket, listen to
+the appropriate events.
function onUpgrade (reverseProxy, proxySocket) {
if (!reverseProxy) {
proxySocket.end();
socket.end();
return;
}
-
- var listeners = {};
- We're now connected to the server, so lets change server socket
proxySocket.on('data', listeners._r_data = function(data) {Pass data to client
if (reverseProxy.incoming.socket.writable) {
+ Any incoming data on this WebSocket to the proxy target
+will be written to the reverseProxy socket.
proxySocket.on('data', listeners.onIncoming = function (data) {
+ if (reverseProxy.incoming.socket.writable) {
try {
+ self.emit('websocket:outgoing', req, socket, head, data);
reverseProxy.incoming.socket.write(data);
}
catch (e) {
@@ -443,53 +475,64 @@ For client set encoding Pass data from client to server
try {
+ });Any outgoing data on this Websocket from the proxy target
+will be written to the proxySocket socket.
reverseProxy.incoming.socket.on('data', listeners.onOutgoing = function(data) {
+ try {
+ self.emit('websocket:incoming', reverseProxy, reverseProxy.incoming, head, data);
proxySocket.write(data);
}
catch (e) {
proxySocket.end();
socket.end();
}
- });Detach event listeners from reverseProxy
function detach() {
- proxySocket.removeListener('end', listeners._r_close);
- proxySocket.removeListener('data', listeners._r_data);
- reverseProxy.incoming.socket.removeListener('data', listeners._data);
- reverseProxy.incoming.socket.removeListener('end', listeners._close);
- }Hook disconnections
proxySocket.on('end', listeners._r_close = function() {
+ });
+ Helper function to detach all event listeners
+from reverseProxy and proxySocket.
function detach() {
+ proxySocket.removeListener('end', listeners.onIncomingClose);
+ proxySocket.removeListener('data', listeners.onIncoming);
+ reverseProxy.incoming.socket.removeListener('end', listeners.onOutgoingClose);
+ reverseProxy.incoming.socket.removeListener('data', listeners.onOutgoing);
+ }If the incoming proxySocket socket closes, then
+detach all event listeners.
proxySocket.on('end', listeners.onIncomingClose = function() {
reverseProxy.incoming.socket.end();
detach();
- });
-
- reverseProxy.incoming.socket.on('end', listeners._close = function() {
+ Emit the end event now that we have completed proxying
self.emit('websocket:end', req, socket, head);
+ });If the reverseProxy socket closes, then detach all
+event listeners.
reverseProxy.incoming.socket.on('end', listeners.onOutgoingClose = function() {
proxySocket.end();
detach();
});
- };Client socket
_socket(socket);
- Remote host address
var protocolName = options.https || this.target.https ? 'https' : 'http',
- agent = _getAgent(options.host, options.port, options.https || this.target.https),
- remoteHost = options.host + (options.port - 80 === 0 ? '' : ':' + options.port);Change headers
if (this.changeOrigin) {
+ };Setup the incoming client socket.
_socket(socket);
+
+ function getPort (port) {
+ port = port || 80;
+ return port - 80 === 0 ? '' : ':' + port
+ }
+ Get the protocol, and host for this request and create an instance
+of http.Agent or https.Agent from the pool managed by node-http-proxy.
var protocolName = options.https || this.target.https ? 'https' : 'http',
+ portUri = getPort(this.source.port),
+ remoteHost = options.host + portUri,
+ agent = _getAgent(options.host, options.port, options.https || this.target.https);Change headers (if requested).
if (this.changeOrigin) {
req.headers.host = remoteHost;
req.headers.origin = protocolName + '://' + remoteHost;
}
-
- outgoing = {
+ Make the outgoing WebSocket request
outgoing = {
host: options.host,
port: options.port,
method: 'GET',
path: req.url,
headers: req.headers,
- };Make the outgoing WebSocket request
var reverseProxy = agent.appendMessage(outgoing);
-
- function proxyError (err) {
+ };
+ var reverseProxy = agent.appendMessage(outgoing);On any errors from the reverseProxy emit the
+webSocketProxyError and close the appropriate
+connections.
function proxyError (err) {
reverseProxy.end();
if (self.emit('webSocketProxyError', req, socket, head)) {
return;
}
socket.end();
- }Here we set the incoming req, socket and head data to the outgoing
+ }
Here we set the incoming req, socket and head data to the outgoing
request so that we can reuse this data later on in the closure scope
available to the upgrade event. This bookkeeping is not tracked anywhere
in nodejs core and is very specific to proxying WebSockets.
reverseProxy.agent = agent;
@@ -498,49 +541,49 @@ in nodejs core and is very specific to proxying WebSockets.
socket: socket,
head: head
};
- If the agent for this particular host and port combination
+
If the agent for this particular host and port combination
is not already listening for the upgrade event, then do so once.
This will force us not to disconnect.
In addition, it's important to note the closure scope here. Since there is no mapping of the
if (!agent._events || agent._events['upgrade'].length === 0) {
- agent.on('upgrade', function (_, remoteSocket, head) {Prepare the socket for the reverseProxy request and begin to + agent.on('upgrade', function (_, remoteSocket, head) {
Prepare the socket for the reverseProxy request and begin to
stream data between the two sockets. Here it is important to
note that remoteSocket._httpMessage === reverseProxy.
_socket(remoteSocket, true);
onUpgrade(remoteSocket._httpMessage, remoteSocket);
});
}
- If the reverseProxy connection has an underlying socket, -then behing the handshake.
if (typeof reverseProxy.socket !== 'undefined') {
- reverseProxy.socket.on('data', function handshake (data) {Ok, kind of harmfull part of code. Socket.IO sends a hash +
If the reverseProxy connection has an underlying socket, +then execute the WebSocket handshake.
if (typeof reverseProxy.socket !== 'undefined') {
+ reverseProxy.socket.on('data', function handshake (data) {Ok, kind of harmfull part of code. Socket.IO sends a hash at the end of handshake if protocol === 76, but we need to replace 'host' and 'origin' in response so we split data to printable data and to non-printable. (Non-printable -will come after double-CRLF).
var sdata = data.toString();Get the Printable data
sdata = sdata.substr(0, sdata.search(CRLF + CRLF));Get the Non-Printable data
data = data.slice(Buffer.byteLength(sdata), data.length);Replace the host and origin headers in the Printable data
sdata = sdata.replace(remoteHost, options.host)
- .replace(remoteHost, options.host);
+will come after double-CRLF). var sdata = data.toString();Get the Printable data
sdata = sdata.substr(0, sdata.search(CRLF + CRLF));Get the Non-Printable data
data = data.slice(Buffer.byteLength(sdata), data.length);
- if (self.https && !self.target.https) {If the proxy server is running HTTPS but the client is running + if (self.https && !self.target.https) {
If the proxy server is running HTTPS but the client is running
HTTP then replace ws with wss in the data sent back to the client.
sdata = sdata.replace('ws:', 'wss:');
}
- try {Write the printable and non-printable data to the socket -from the original incoming request.
socket.write(sdata);
+ try {Write the printable and non-printable data to the socket +from the original incoming request.
self.emit('websocket:handshake', req, socket, head, sdata, data);
+ socket.write(sdata);
socket.write(data);
}
catch (ex) {
proxyError(ex)
- }Catch socket errors
socket.on('error', proxyError);Remove data listener now that the 'handshake' is complete
reverseProxy.socket.removeListener('data', handshake);
+ }Catch socket errors
socket.on('error', proxyError);Remove data listener now that the 'handshake' is complete
reverseProxy.socket.removeListener('data', handshake);
});
}
reverseProxy.on('error', proxyError);
- try {Attempt to write the upgrade-head to the reverseProxy request.
reverseProxy.write(head);
+ try {Attempt to write the upgrade-head to the reverseProxy request.
reverseProxy.write(head);
}
catch (ex) {
proxyError(ex);
}
- If we have been passed buffered data, resume it.
if (options.buffer && !errState) {
+ If we have been passed buffered data, resume it.
if (options.buffer && !errState) {
options.buffer.resume();
}
};