Compare commits

..

No commits in common. "master" and "1.11.3" have entirely different histories.

53 changed files with 475 additions and 5525 deletions

View File

@ -1,6 +0,0 @@
{
"output": "CHANGELOG.md",
"template": "keepachangelog",
"unreleased": true,
"commitLimit": false
}

1
.gitattributes vendored
View File

@ -1 +0,0 @@
package-lock.json binary

2
.gitignore vendored
View File

@ -6,5 +6,3 @@ notes
primus-proxy.js primus-proxy.js
tes.js tes.js
npm-debug.log npm-debug.log
.nyc_output
coverage

View File

@ -2,8 +2,6 @@ test
examples examples
doc doc
benchmark benchmark
coverage
.nyc_output
.travis.yml .travis.yml
CHANGELOG.md CHANGELOG.md
UPGRADING.md UPGRADING.md

View File

@ -1,12 +1,22 @@
sudo: false sudo: false
language: node_js language: node_js
node_js: node_js:
- "8" - "0.10"
- "10" - "0.12"
- "12" - "4.1"
before_install:
- travis_retry npm install -g npm@2.14.5
- travis_retry npm install
script: script:
- npm test - npm test
after_success:
- bash <(curl -s https://codecov.io/bash)
matrix: matrix:
fast_finish: true allow_failures:
- node_js: "4.1"
notifications:
email:
- travis@nodejitsu.com
irc: "irc.freenode.org#nodejitsu"

File diff suppressed because it is too large Load Diff

View File

@ -1,74 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at <https://github.com/http-party/node-http-proxy>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

View File

@ -1,7 +1,7 @@
node-http-proxy node-http-proxy
Copyright (c) 2010-2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

443
README.md
View File

@ -1,60 +1,41 @@
<p align="center"> <p align="center">
<img src="https://raw.github.com/http-party/node-http-proxy/master/doc/logo.png"/> <img src="https://raw.github.com/nodejitsu/node-http-proxy/master/doc/logo.png"/>
</p> </p>
# node-http-proxy [![Build Status](https://travis-ci.org/http-party/node-http-proxy.svg?branch=master)](https://travis-ci.org/http-party/node-http-proxy) [![codecov](https://codecov.io/gh/http-party/node-http-proxy/branch/master/graph/badge.svg)](https://codecov.io/gh/http-party/node-http-proxy) node-http-proxy
=======
`node-http-proxy` is an HTTP programmable proxying library that supports `node-http-proxy` is an HTTP programmable proxying library that supports
websockets. It is suitable for implementing components such as reverse websockets. It is suitable for implementing components such as
proxies and load balancers. proxies and load balancers.
### Table of Contents
* [Installation](#installation)
* [Upgrading from 0.8.x ?](#upgrading-from-08x-)
* [Core Concept](#core-concept)
* [Use Cases](#use-cases)
* [Setup a basic stand-alone proxy server](#setup-a-basic-stand-alone-proxy-server)
* [Setup a stand-alone proxy server with custom server logic](#setup-a-stand-alone-proxy-server-with-custom-server-logic)
* [Setup a stand-alone proxy server with proxy request header re-writing](#setup-a-stand-alone-proxy-server-with-proxy-request-header-re-writing)
* [Modify a response from a proxied server](#modify-a-response-from-a-proxied-server)
* [Setup a stand-alone proxy server with latency](#setup-a-stand-alone-proxy-server-with-latency)
* [Using HTTPS](#using-https)
* [Proxying WebSockets](#proxying-websockets)
* [Options](#options)
* [Listening for proxy events](#listening-for-proxy-events)
* [Shutdown](#shutdown)
* [Miscellaneous](#miscellaneous)
* [Test](#test)
* [ProxyTable API](#proxytable-api)
* [Logo](#logo)
* [Contributing and Issues](#contributing-and-issues)
* [License](#license)
### Installation ### Installation
`npm install http-proxy --save` `npm install http-proxy --save`
**[Back to top](#table-of-contents)** ### Build Status
### Upgrading from 0.8.x ? <p align="center">
<a href="https://travis-ci.org/nodejitsu/node-http-proxy" target="_blank">
<img src="https://travis-ci.org/nodejitsu/node-http-proxy.png"/></a>&nbsp;&nbsp;
<a href="https://coveralls.io/r/nodejitsu/node-http-proxy" target="_blank">
<img src="https://coveralls.io/repos/nodejitsu/node-http-proxy/badge.png"/></a>
</p>
Click [here](UPGRADING.md) ### Looking to Upgrade from 0.8.x ? Click [here](UPGRADING.md)
**[Back to top](#table-of-contents)**
### Core Concept ### Core Concept
A new proxy is created by calling `createProxyServer` and passing A new proxy is created by calling `createProxyServer` and passing
an `options` object as argument ([valid properties are available here](lib/http-proxy.js#L26-L42)) an `options` object as argument ([valid properties are available here](lib/http-proxy.js#L33-L50))
```javascript ```javascript
var httpProxy = require('http-proxy'); var httpProxy = require('http-proxy');
var proxy = httpProxy.createProxyServer(options); // See (†) var proxy = httpProxy.createProxyServer(options);
``` ```
†Unless listen(..) is invoked on the object, this does not create a webserver. See below.
An object will be returned with four methods: An object will be returned with four values:
* web `req, res, [options]` (used for proxying regular HTTP(S) requests) * web `req, res, [options]` (used for proxying regular HTTP(S) requests)
* ws `req, socket, head, [options]` (used for proxying WS(S) requests) * ws `req, socket, head, [options]` (used for proxying WS(S) requests)
@ -85,13 +66,10 @@ proxy.web(req, res, { target: 'http://mytarget.com:8080' }, function(e) { ... })
When a request is proxied it follows two different pipelines ([available here](lib/http-proxy/passes)) When a request is proxied it follows two different pipelines ([available here](lib/http-proxy/passes))
which apply transformations to both the `req` and `res` object. which apply transformations to both the `req` and `res` object.
The first pipeline (incoming) is responsible for the creation and manipulation of the stream that connects your client to the target. The first pipeline (ingoing) is responsible for the creation and manipulation of the stream that connects your client to the target.
The second pipeline (outgoing) is responsible for the creation and manipulation of the stream that, from your target, returns data The second pipeline (outgoing) is responsible for the creation and manipulation of the stream that, from your target, returns data
to the client. to the client.
**[Back to top](#table-of-contents)**
### Use Cases
#### Setup a basic stand-alone proxy server #### Setup a basic stand-alone proxy server
@ -101,7 +79,7 @@ var http = require('http'),
// //
// Create your proxy server and set the target in the options. // Create your proxy server and set the target in the options.
// //
httpProxy.createProxyServer({target:'http://localhost:9000'}).listen(8000); // See (†) httpProxy.createProxyServer({target:'http://localhost:9000'}).listen(8000);
// //
// Create your target server // Create your target server
@ -112,12 +90,9 @@ http.createServer(function (req, res) {
res.end(); res.end();
}).listen(9000); }).listen(9000);
``` ```
†Invoking listen(..) triggers the creation of a web server. Otherwise, just the proxy instance is created.
**[Back to top](#table-of-contents)**
#### Setup a stand-alone proxy server with custom server logic #### Setup a stand-alone proxy server with custom server logic
This example shows how you can proxy a request using your own HTTP server This example show how you can proxy a request using your own HTTP server
and also you can put your own logic to handle the request. and also you can put your own logic to handle the request.
```js ```js
@ -137,14 +112,17 @@ var proxy = httpProxy.createProxyServer({});
var server = http.createServer(function(req, res) { var server = http.createServer(function(req, res) {
// You can define here your custom logic to handle the request // You can define here your custom logic to handle the request
// and then proxy the request. // and then proxy the request.
proxy.web(req, res, { target: 'http://127.0.0.1:5050' }); proxy.web(req, res, { target: 'http://127.0.0.1:5060' });
}); });
console.log("listening on port 5050") console.log("listening on port 5050")
server.listen(5050); server.listen(5050);
``` ```
#### Modify a response from a proxied server
Sometimes when you have received a HTML/XML document from the server of origin you would like to modify it before forwarding it on.
[Harmon](https://github.com/No9/harmon) allows you to do this in a streaming style so as to keep the pressure on the proxy to a minimum.
**[Back to top](#table-of-contents)**
#### Setup a stand-alone proxy server with proxy request header re-writing #### Setup a stand-alone proxy server with proxy request header re-writing
This example shows how you can proxy a request using your own HTTP server that This example shows how you can proxy a request using your own HTTP server that
@ -175,7 +153,7 @@ var server = http.createServer(function(req, res) {
// You can define here your custom logic to handle the request // You can define here your custom logic to handle the request
// and then proxy the request. // and then proxy the request.
proxy.web(req, res, { proxy.web(req, res, {
target: 'http://127.0.0.1:5050' target: 'http://127.0.0.1:5060'
}); });
}); });
@ -183,15 +161,6 @@ console.log("listening on port 5050")
server.listen(5050); server.listen(5050);
``` ```
**[Back to top](#table-of-contents)**
#### Modify a response from a proxied server
Sometimes when you have received a HTML/XML document from the server of origin you would like to modify it before forwarding it on.
[Harmon](https://github.com/No9/harmon) allows you to do this in a streaming style so as to keep the pressure on the proxy to a minimum.
**[Back to top](#table-of-contents)**
#### Setup a stand-alone proxy server with latency #### Setup a stand-alone proxy server with latency
```js ```js
@ -226,193 +195,9 @@ http.createServer(function (req, res) {
}).listen(9008); }).listen(9008);
``` ```
**[Back to top](#table-of-contents)** #### Listening for proxy events
#### Using HTTPS * `error`: The error event is emitted if the request to the target fail.
You can activate the validation of a secure SSL certificate to the target connection (avoid self-signed certs), just set `secure: true` in the options.
##### HTTPS -> HTTP
```js
//
// Create the HTTPS proxy server in front of a HTTP server
//
httpProxy.createServer({
target: {
host: 'localhost',
port: 9009
},
ssl: {
key: fs.readFileSync('valid-ssl-key.pem', 'utf8'),
cert: fs.readFileSync('valid-ssl-cert.pem', 'utf8')
}
}).listen(8009);
```
##### HTTPS -> HTTPS
```js
//
// Create the proxy server listening on port 443
//
httpProxy.createServer({
ssl: {
key: fs.readFileSync('valid-ssl-key.pem', 'utf8'),
cert: fs.readFileSync('valid-ssl-cert.pem', 'utf8')
},
target: 'https://localhost:9010',
secure: true // Depends on your needs, could be false.
}).listen(443);
```
##### HTTP -> HTTPS (using a PKCS12 client certificate)
```js
//
// Create an HTTP proxy server with an HTTPS target
//
httpProxy.createProxyServer({
target: {
protocol: 'https:',
host: 'my-domain-name',
port: 443,
pfx: fs.readFileSync('path/to/certificate.p12'),
passphrase: 'password',
},
changeOrigin: true,
}).listen(8000);
```
**[Back to top](#table-of-contents)**
#### Proxying WebSockets
You can activate the websocket support for the proxy using `ws:true` in the options.
```js
//
// Create a proxy server for websockets
//
httpProxy.createServer({
target: 'ws://localhost:9014',
ws: true
}).listen(8014);
```
Also you can proxy the websocket requests just calling the `ws(req, socket, head)` method.
```js
//
// Setup our server to proxy standard HTTP requests
//
var proxy = new httpProxy.createProxyServer({
target: {
host: 'localhost',
port: 9015
}
});
var proxyServer = http.createServer(function (req, res) {
proxy.web(req, res);
});
//
// Listen to the `upgrade` event and proxy the
// WebSocket requests as well.
//
proxyServer.on('upgrade', function (req, socket, head) {
proxy.ws(req, socket, head);
});
proxyServer.listen(8015);
```
**[Back to top](#table-of-contents)**
### Options
`httpProxy.createProxyServer` supports the following options:
* **target**: url string to be parsed with the url module
* **forward**: url string to be parsed with the url module
* **agent**: object to be passed to http(s).request (see Node's [https agent](http://nodejs.org/api/https.html#https_class_https_agent) and [http agent](http://nodejs.org/api/http.html#http_class_http_agent) objects)
* **ssl**: object to be passed to https.createServer()
* **ws**: true/false, if you want to proxy websockets
* **xfwd**: true/false, adds x-forward headers
* **secure**: true/false, if you want to verify the SSL Certs
* **toProxy**: true/false, passes the absolute URL as the `path` (useful for proxying to proxies)
* **prependPath**: true/false, Default: true - specify whether you want to prepend the target's path to the proxy path
* **ignorePath**: true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required).
* **localAddress**: Local interface string to bind for outgoing connections
* **changeOrigin**: true/false, Default: false - changes the origin of the host header to the target URL
* **preserveHeaderKeyCase**: true/false, Default: false - specify whether you want to keep letter case of response header key
* **auth**: Basic authentication i.e. 'user:password' to compute an Authorization header.
* **hostRewrite**: rewrites the location hostname on (201/301/302/307/308) redirects.
* **autoRewrite**: rewrites the location host/port on (201/301/302/307/308) redirects based on requested host/port. Default: false.
* **protocolRewrite**: rewrites the location protocol on (201/301/302/307/308) redirects to 'http' or 'https'. Default: null.
* **cookieDomainRewrite**: rewrites domain of `set-cookie` headers. Possible values:
* `false` (default): disable cookie rewriting
* String: new domain, for example `cookieDomainRewrite: "new.domain"`. To remove the domain, use `cookieDomainRewrite: ""`.
* Object: mapping of domains to new domains, use `"*"` to match all domains.
For example keep one domain unchanged, rewrite one domain and remove other domains:
```
cookieDomainRewrite: {
"unchanged.domain": "unchanged.domain",
"old.domain": "new.domain",
"*": ""
}
```
* **cookiePathRewrite**: rewrites path of `set-cookie` headers. Possible values:
* `false` (default): disable cookie rewriting
* String: new path, for example `cookiePathRewrite: "/newPath/"`. To remove the path, use `cookiePathRewrite: ""`. To set path to root use `cookiePathRewrite: "/"`.
* Object: mapping of paths to new paths, use `"*"` to match all paths.
For example, to keep one path unchanged, rewrite one path and remove other paths:
```
cookiePathRewrite: {
"/unchanged.path/": "/unchanged.path/",
"/old.path/": "/new.path/",
"*": ""
}
```
* **headers**: object with extra headers to be added to target requests.
* **proxyTimeout**: timeout (in millis) for outgoing proxy requests
* **timeout**: timeout (in millis) for incoming requests
* **followRedirects**: true/false, Default: false - specify whether you want to follow redirects
* **selfHandleResponse** true/false, if set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the `proxyRes` event
* **buffer**: stream of data to send as the request body. Maybe you have some middleware that consumes the request stream before proxying it on e.g. If you read the body of a request into a field called 'req.rawbody' you could restream this field in the buffer option:
```
'use strict';
const streamify = require('stream-array');
const HttpProxy = require('http-proxy');
const proxy = new HttpProxy();
module.exports = (req, res, next) => {
proxy.web(req, res, {
target: 'http://localhost:4003/',
buffer: streamify(req.rawBody)
}, next);
};
```
**NOTE:**
`options.ws` and `options.ssl` are optional.
`options.target` and `options.forward` cannot both be missing
If you are using the `proxyServer.listen` method, the following options are also applicable:
* **ssl**: object to be passed to https.createServer()
* **ws**: true/false, if you want to proxy websockets
**[Back to top](#table-of-contents)**
### Listening for proxy events
* `error`: The error event is emitted if the request to the target fail. **We do not do any error handling of messages passed between client and proxy, and messages passed between proxy and target, so it is recommended that you listen on errors and handle them.**
* `proxyReq`: This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to "web" connections
* `proxyReqWs`: This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to "websocket" connections
* `proxyRes`: This event is emitted if the request to the target got a response. * `proxyRes`: This event is emitted if the request to the target got a response.
* `open`: This event is emitted once the proxy websocket was created and piped into the target websocket. * `open`: This event is emitted once the proxy websocket was created and piped into the target websocket.
* `close`: This event is emitted once the proxy websocket was closed. * `close`: This event is emitted once the proxy websocket was closed.
@ -458,13 +243,126 @@ proxy.on('open', function (proxySocket) {
// //
// Listen for the `close` event on `proxy`. // Listen for the `close` event on `proxy`.
// //
proxy.on('close', function (res, socket, head) { proxy.on('close', function (req, socket, head) {
// view disconnected websocket connections // view disconnected websocket connections
console.log('Client disconnected'); console.log('Client disconnected');
}); });
``` ```
**[Back to top](#table-of-contents)** #### Using HTTPS
You can activate the validation of a secure SSL certificate to the target connection (avoid self signed certs), just set `secure: true` in the options.
##### HTTPS -> HTTP
```js
//
// Create the HTTPS proxy server in front of a HTTP server
//
httpProxy.createServer({
target: {
host: 'localhost',
port: 9009
},
ssl: {
key: fs.readFileSync('valid-ssl-key.pem', 'utf8'),
cert: fs.readFileSync('valid-ssl-cert.pem', 'utf8')
}
}).listen(8009);
```
##### HTTPS -> HTTPS
```js
//
// Create the proxy server listening on port 443
//
httpProxy.createServer({
ssl: {
key: fs.readFileSync('valid-ssl-key.pem', 'utf8'),
cert: fs.readFileSync('valid-ssl-cert.pem', 'utf8')
},
target: 'https://localhost:9010',
secure: true // Depends on your needs, could be false.
}).listen(443);
```
#### Proxying WebSockets
You can activate the websocket support for the proxy using `ws:true` in the options.
```js
//
// Create a proxy server for websockets
//
httpProxy.createServer({
target: 'ws://localhost:9014',
ws: true
}).listen(8014);
```
Also you can proxy the websocket requests just calling the `ws(req, socket, head)` method.
```js
//
// Setup our server to proxy standard HTTP requests
//
var proxy = new httpProxy.createProxyServer({
target: {
host: 'localhost',
port: 9015
}
});
var proxyServer = http.createServer(function (req, res) {
proxy.web(req, res);
});
//
// Listen to the `upgrade` event and proxy the
// WebSocket requests as well.
//
proxyServer.on('upgrade', function (req, socket, head) {
proxy.ws(req, socket, head);
});
proxyServer.listen(8015);
```
### Contributing and Issues
* Search on Google/Github
* If you can't find anything, open an issue
* If you feel comfortable about fixing the issue, fork the repo
* Commit to your local branch (which must be different from `master`)
* Submit your Pull Request (be sure to include tests and update documentation)
### Options
`httpProxy.createProxyServer` supports the following options:
* **target**: url string to be parsed with the url module
* **forward**: url string to be parsed with the url module
* **agent**: object to be passed to http(s).request (see Node's [https agent](http://nodejs.org/api/https.html#https_class_https_agent) and [http agent](http://nodejs.org/api/http.html#http_class_http_agent) objects)
* **ssl**: object to be passed to https.createServer()
* **ws**: true/false, if you want to proxy websockets
* **xfwd**: true/false, adds x-forward headers
* **secure**: true/false, if you want to verify the SSL Certs
* **toProxy**: passes the absolute URL as the `path` (useful for proxying to proxies)
* **prependPath**: true/false, Default: true - specify whether you want to prepend the target's path to the proxy path
* **ignorePath**: true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request
* **localAddress**: Local interface string to bind for outgoing connections
* **changeOrigin**: true/false, Default: false - changes the origin of the host header to the target URL
* **auth**: Basic authentication i.e. 'user:password' to compute an Authorization header.
* **hostRewrite**: rewrites the location hostname on (301/302/307/308) redirects.
* **autoRewrite**: rewrites the location host/port on (301/302/307/308) redirects based on requested host/port. Default: false.
* **protocolRewrite**: rewrites the location protocol on (301/302/307/308) redirects to 'http' or 'https'. Default: null.
**NOTE:**
`options.ws` and `options.ssl` are optional.
`options.target` and `options.forward` cannot both be missing
If you are using the `proxyServer.listen` method, the following options are also applicable:
* **ssl**: object to be passed to https.createServer()
* **ws**: true/false, if you want to proxy websockets
### Shutdown ### Shutdown
@ -482,72 +380,21 @@ var proxy = new httpProxy.createProxyServer({
proxy.close(); proxy.close();
``` ```
**[Back to top](#table-of-contents)** ### Test
### Miscellaneous
If you want to handle your own response after receiving the `proxyRes`, you can do
so with `selfHandleResponse`. As you can see below, if you use this option, you
are able to intercept and read the `proxyRes` but you must also make sure to
reply to the `res` itself otherwise the original client will never receive any
data.
### Modify response
```js
var option = {
target: target,
selfHandleResponse : true
};
proxy.on('proxyRes', function (proxyRes, req, res) {
var body = [];
proxyRes.on('data', function (chunk) {
body.push(chunk);
});
proxyRes.on('end', function () {
body = Buffer.concat(body).toString();
console.log("res from proxied server:", body);
res.end("my response to cli");
});
});
proxy.web(req, res, option);
```
#### ProxyTable API
A proxy table API is available through this add-on [module](https://github.com/donasaur/http-proxy-rules), which lets you define a set of rules to translate matching routes to target routes that the reverse proxy will talk to.
#### Test
``` ```
$ npm test $ npm test
``` ```
#### Logo ### Logo
Logo created by [Diego Pasquali](http://dribbble.com/diegopq) Logo created by [Diego Pasquali](http://dribbble.com/diegopq)
**[Back to top](#table-of-contents)**
### Contributing and Issues
* Read carefully our [Code Of Conduct](https://github.com/http-party/node-http-proxy/blob/master/CODE_OF_CONDUCT.md)
* Search on Google/Github
* If you can't find anything, open an issue
* If you feel comfortable about fixing the issue, fork the repo
* Commit to your local branch (which must be different from `master`)
* Submit your Pull Request (be sure to include tests and update documentation)
**[Back to top](#table-of-contents)**
### License ### License
>The MIT License (MIT) >The MIT License (MIT)
> >
>Copyright (c) 2010 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. >Copyright (c) 2010 - 2013 Nodejitsu Inc.
> >
>Permission is hereby granted, free of charge, to any person obtaining a copy >Permission is hereby granted, free of charge, to any person obtaining a copy
>of this software and associated documentation files (the "Software"), to deal >of this software and associated documentation files (the "Software"), to deal
@ -566,3 +413,5 @@ Logo created by [Diego Pasquali](http://dribbble.com/diegopq)
>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, >LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN >OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
>THE SOFTWARE. >THE SOFTWARE.

View File

@ -12,11 +12,11 @@ httpProxy.createServer({
}).listen(8003); }).listen(8003);
``` ```
Check the [README.md](https://github.com/http-party/node-http-proxy/blob/caronte/README.md) for a more detailed explanation of the parameters. Check the [README.md](https://github.com/nodejitsu/node-http-proxy/blob/caronte/README.md) for a more detailed explanation of the parameters.
## Proxying ## Proxying
Web proxying is done by calling the `.web()` method on a Proxy instance. You can check among some use cases in the [examples folder](https://github.com/http-party/node-http-proxy/tree/caronte/examples/http) Web proxying is done by calling the `.web()` method on a Proxy instance. You can check among some use cases in the [examples folder](https://github.com/nodejitsu/node-http-proxy/tree/caronte/examples/http)
```javascript ```javascript
// //
@ -32,7 +32,7 @@ httpProxy.createProxyServer({
``` ```
Websockets are proxied by the `.ws()` method. The [examples folder](https://github.com/http-party/node-http-proxy/tree/caronte/examples/websocket) again provides a lot of useful snippets! Websockets are proxied by the `.ws()` method. The [examples folder](https://github.com/nodejitsu/node-http-proxy/tree/caronte/examples/websocket) again provides a lot of useful snippets!
```javascript ```javascript
var proxy = new httpProxy.createProxyServer({ var proxy = new httpProxy.createProxyServer({
@ -90,8 +90,8 @@ which were in the core and delegate them to eventual "userland" modules.
### Middleware API ### Middleware API
The new API makes it really easy to implement code that behaves like the old Middleware API. You can check some examples [here](https://github.com/http-party/node-http-proxy/tree/caronte/examples/middleware) The new API makes it really easy to implement code that behaves like the old Middleware API. You can check some examples [here](https://github.com/nodejitsu/node-http-proxy/tree/caronte/examples/middleware)
### ProxyTable API ### ProxyTable API
See this [link](https://github.com/donasaur/http-proxy-rules/) for an add-on proxy rules module that you can use to simulate the old ProxyTable API. See this [link](http://blog.nodejitsu.com/node-http-proxy-1dot0/) for an example of how to add proxy table functionality using the new API.

View File

@ -1,10 +0,0 @@
coverage:
parsers:
javascript:
enable_partials: yes
status:
project:
default:
target: "70%"
patch:
enabled: false

View File

@ -1,7 +1,7 @@
/* /*
simple-balancer.js: Example of a simple round robin balancer for websockets simple-balancer.js: Example of a simple round robin balancer for websockets
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the
@ -81,3 +81,4 @@ server.on('upgrade', function (req, socket, head) {
}); });
server.listen(8001); server.listen(8001);

View File

@ -1,7 +1,7 @@
/* /*
simple-balancer.js: Example of a simple round robin balancer simple-balancer.js: Example of a simple round robin balancer
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
basic-proxy.js: Basic example of proxying over HTTP basic-proxy.js: Basic example of proxying over HTTP
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
concurrent-proxy.js: check levelof concurrency through proxy. concurrent-proxy.js: check levelof concurrency through proxy.
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
custom-proxy-error.js: Example of using the custom `proxyError` event. custom-proxy-error.js: Example of using the custom `proxyError` event.
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
error-handling.js: Example of handle erros for HTTP and WebSockets error-handling.js: Example of handle erros for HTTP and WebSockets
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
forward-and-target-proxy.js: Example of proxying over HTTP with additional forward proxy forward-and-target-proxy.js: Example of proxying over HTTP with additional forward proxy
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
forward-proxy.js: Example of proxying over HTTP with additional forward proxy forward-proxy.js: Example of proxying over HTTP with additional forward proxy
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
latent-proxy.js: Example of proxying over HTTP with latency latent-proxy.js: Example of proxying over HTTP with latency
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,26 +0,0 @@
var httpProxy = require('../../lib/http-proxy');
var Agent = require('agentkeepalive');
var agent = new Agent({
maxSockets: 100,
keepAlive: true,
maxFreeSockets: 10,
keepAliveMsecs:1000,
timeout: 60000,
keepAliveTimeout: 30000 // free socket keepalive for 30 seconds
});
var proxy = httpProxy.createProxy({ target: 'http://whatever.com', agent: agent });
//
// Modify headers of the response before it gets sent
// So that we handle the NLTM authentication response
//
proxy.on('proxyRes', function (proxyRes) {
var key = 'www-authenticate';
proxyRes.headers[key] = proxyRes.headers[key] && proxyRes.headers[key].split(',');
});
require('http').createServer(function (req, res) {
proxy.web(req, res);
}).listen(3000);

View File

@ -1,7 +1,7 @@
/* /*
proxy-http-to-https.js: Basic example of proxying over HTTP to a target HTTPS server proxy-http-to-https.js: Basic example of proxying over HTTP to a target HTTPS server
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
proxy-https-to-http.js: Basic example of proxying over HTTPS to a target HTTP server proxy-https-to-http.js: Basic example of proxying over HTTPS to a target HTTP server
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
proxy-https-to-https.js: Basic example of proxying over HTTPS to a target HTTPS server proxy-https-to-https.js: Basic example of proxying over HTTPS to a target HTTPS server
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,55 +0,0 @@
/*
reverse-proxy.js: Example of reverse proxying (with HTTPS support)
Copyright (c) 2015 Alberto Pose <albertopose@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
var http = require('http'),
net = require('net'),
httpProxy = require('../../lib/http-proxy'),
url = require('url'),
util = require('util');
var proxy = httpProxy.createServer();
var server = http.createServer(function (req, res) {
util.puts('Receiving reverse proxy request for:' + req.url);
var parsedUrl = url.parse(req.url);
var target = parsedUrl.protocol + '//' + parsedUrl.hostname;
proxy.web(req, res, {target: target, secure: false});
}).listen(8213);
server.on('connect', function (req, socket) {
util.puts('Receiving reverse proxy request for:' + req.url);
var serverUrl = url.parse('https://' + req.url);
var srvSocket = net.connect(serverUrl.port, serverUrl.hostname, function() {
socket.write('HTTP/1.1 200 Connection Established\r\n' +
'Proxy-agent: Node-Proxy\r\n' +
'\r\n');
srvSocket.pipe(socket);
socket.pipe(srvSocket);
});
});
// Test with:
// curl -vv -x http://127.0.0.1:8213 https://www.google.com
// curl -vv -x http://127.0.0.1:8213 http://www.google.com

View File

@ -1,67 +0,0 @@
/*
sse.js: Basic example of proxying over HTTP
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
var util = require('util'),
colors = require('colors'),
http = require('http'),
httpProxy = require('../../lib/http-proxy'),
SSE = require('sse');
//
// Basic Http Proxy Server
//
var proxy = new httpProxy.createProxyServer();
http.createServer(function (req, res) {
proxy.web(req, res, {
target: 'http://localhost:9003'
});
}).listen(8003);
//
// Target Http Server
//
var server = http.createServer(function(req, res) {
res.writeHead(200, {'Content-Type': 'text/html'});
res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
res.end();
});
//
// Use SSE
//
var sse = new SSE(server, {path: '/'});
sse.on('connection', function(client) {
var count = 0;
setInterval(function(){
client.send('message #' + count++);
}, 1500);
});
server.listen(9003);
util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8003'.yellow);
util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9003 '.yellow);

View File

@ -1,7 +1,7 @@
/* /*
standalone-proxy.js: Example of proxying over HTTP with a standalone HTTP server. standalone-proxy.js: Example of proxying over HTTP with a standalone HTTP server.
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the
@ -51,4 +51,4 @@ http.createServer(function (req, res) {
}).listen(9002); }).listen(9002);
util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '8002 '.yellow + 'with proxy.web() handler'.cyan.underline + ' and latency'.magenta); util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '8002 '.yellow + 'with proxy.web() handler'.cyan.underline + ' and latency'.magenta);
util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9002 '.yellow); util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9001 '.yellow);

View File

@ -1,7 +1,7 @@
/* /*
bodyDecoder-middleware.js: Basic example of `connect.bodyParser()` middleware in node-http-proxy bodyDecoder-middleware.js: Basic example of `connect.bodyParser()` middleware in node-http-proxy
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the
@ -29,42 +29,33 @@ var http = require('http'),
request = require('request'), request = require('request'),
colors = require('colors'), colors = require('colors'),
util = require('util'), util = require('util'),
queryString = require('querystring'),
bodyParser = require('body-parser'), bodyParser = require('body-parser'),
httpProxy = require('../../lib/http-proxy'), httpProxy = require('../../lib/http-proxy'),
proxy = httpProxy.createProxyServer({}); proxy = httpProxy.createProxyServer({});
//restream parsed body before proxying //restreame
proxy.on('proxyReq', function(proxyReq, req, res, options) { var restreamer = function (){
if (!req.body || !Object.keys(req.body).length) { return function (req, res, next) { //restreame
return; req.removeAllListeners('data')
req.removeAllListeners('end')
next()
process.nextTick(function () {
if(req.body) {
req.emit('data', JSON.stringify(req.body))
} }
req.emit('end')
var contentType = proxyReq.getHeader('Content-Type'); })
var bodyData;
if (contentType === 'application/json') {
bodyData = JSON.stringify(req.body);
} }
if (contentType === 'application/x-www-form-urlencoded') {
bodyData = queryString.stringify(req.body);
} }
if (bodyData) {
proxyReq.setHeader('Content-Length', Buffer.byteLength(bodyData));
proxyReq.write(bodyData);
}
});
// //
// Basic Http Proxy Server // Basic Http Proxy Server
// //
var app = connect() var app = connect()
.use(bodyParser.json())//json parser .use(bodyParser.json())//json
.use(bodyParser.urlencoded())//urlencoded parser .use(restreamer())//restreame
.use(function(req, res){ .use(function(req, res){
// modify body here, // modify body here,
// eg: req.body = {a: 1}. // eg: req.body = {a: 1}.
@ -93,16 +84,10 @@ http.createServer(app1).listen(9013, function(){
//request to 8013 to proxy //request to 8013 to proxy
request.post({// request.post({//
url: 'http://127.0.0.1:8013', url: 'http://127.0.0.1:8013',
json: {content: 123, type: "greeting from json request"} json: {content: 123, type: "greeting"}
},function(err, res,data){ },function(err, res,data){
console.log('return for json request:' ,err, data) console.log('return:' ,err, data)
})
// application/x-www-form-urlencoded request
request.post({//
url: 'http://127.0.0.1:8013',
form: {content: 123, type: "greeting from urlencoded request"}
},function(err, res,data){
console.log('return for urlencoded request:' ,err, data)
}) })
}); });

View File

@ -1,7 +1,7 @@
/* /*
gzip-middleware.js: Basic example of `connect-gzip` middleware in node-http-proxy gzip-middleware.js: Basic example of `connect-gzip` middleware in node-http-proxy
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
modifyBody-middleware.js: Example of middleware which modifies response modifyBody-middleware.js: Example of middleware which modifies response
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the
@ -28,26 +28,24 @@ var util = require('util'),
colors = require('colors'), colors = require('colors'),
http = require('http'), http = require('http'),
connect = require('connect'), connect = require('connect'),
app = connect(),
httpProxy = require('../../lib/http-proxy'); httpProxy = require('../../lib/http-proxy');
// //
// Basic Connect App // Basic Connect App
// //
app.use(function (req, res, next) { connect.createServer(
function (req, res, next) {
var _write = res.write; var _write = res.write;
res.write = function (data) { res.write = function (data) {
_write.call(res, data.toString().replace("Ruby", "http-party")); _write.call(res, data.toString().replace("Ruby", "nodejitsu"));
} }
next(); next();
}); },
function (req, res) {
app.use(function (req, res) { proxy.web(req, res);
proxy.web(req, res) }
}); ).listen(8013);
http.createServer(app).listen(8013);
// //
// Basic Http Proxy Server // Basic Http Proxy Server
@ -61,7 +59,7 @@ var proxy = httpProxy.createProxyServer({
// //
http.createServer(function (req, res) { http.createServer(function (req, res) {
res.writeHead(200, { 'Content-Type': 'text/plain' }); res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end('Hello, I love Ruby\n'); res.end('Hello, I know Ruby\n');
}).listen(9013); }).listen(9013);
util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8013'.yellow); util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8013'.yellow);

View File

@ -3,12 +3,11 @@
"description": "packages required to run the examples", "description": "packages required to run the examples",
"version": "0.0.0", "version": "0.0.0",
"dependencies": { "dependencies": {
"agentkeepalive": "^4.0.0", "colors": "~0.6.2",
"colors": "~1.3.0",
"connect-restreamer": "~1.0.0",
"request": "~2.88.0",
"socket.io": "~0.9.16", "socket.io": "~0.9.16",
"socket.io-client": "~0.9.16", "socket.io-client": "~0.9.16",
"sse": "0.0.8" "connect": "~2.11.0",
"request": "~2.27.0",
"connect-restreamer": "~1.0.0"
} }
} }

View File

@ -1,7 +1,7 @@
/* /*
standalone-websocket-proxy.js: Example of proxying websockets over HTTP with a standalone HTTP server. standalone-websocket-proxy.js: Example of proxying websockets over HTTP with a standalone HTTP server.
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
standalone-websocket-proxy.js: Example of proxying websockets over HTTP with a standalone HTTP server. standalone-websocket-proxy.js: Example of proxying websockets over HTTP with a standalone HTTP server.
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,7 +1,7 @@
/* /*
web-socket-proxy.js: Example of proxying over HTTP and WebSockets. web-socket-proxy.js: Example of proxying over HTTP and WebSockets.
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the

View File

@ -1,6 +1,12 @@
// Use explicit /index.js to help browserify negociation in require '/lib/http-proxy' (!) var http = require('http'),
var ProxyServer = require('./http-proxy/index.js').Server; https = require('https'),
url = require('url'),
httpProxy = require('./http-proxy/');
/**
* Export the proxy "Server" as the main export.
*/
module.exports = httpProxy.Server;
/** /**
* Creates the proxy server. * Creates the proxy server.
@ -17,8 +23,9 @@ var ProxyServer = require('./http-proxy/index.js').Server;
* @api public * @api public
*/ */
module.exports.createProxyServer =
function createProxyServer(options) { module.exports.createServer =
module.exports.createProxy = function createProxyServer(options) {
/* /*
* `options` is needed and it must have the following layout: * `options` is needed and it must have the following layout:
* *
@ -35,11 +42,10 @@ function createProxyServer(options) {
* ignorePath: <true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request> * ignorePath: <true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request>
* localAddress : <Local interface string to bind for outgoing connections> * localAddress : <Local interface string to bind for outgoing connections>
* changeOrigin: <true/false, Default: false - changes the origin of the host header to the target URL> * changeOrigin: <true/false, Default: false - changes the origin of the host header to the target URL>
* preserveHeaderKeyCase: <true/false, Default: false - specify whether you want to keep letter case of response header key >
* auth : Basic authentication i.e. 'user:password' to compute an Authorization header. * auth : Basic authentication i.e. 'user:password' to compute an Authorization header.
* hostRewrite: rewrites the location hostname on (201/301/302/307/308) redirects, Default: null. * hostRewrite: rewrites the location hostname on (301/302/307/308) redirects, Default: null.
* autoRewrite: rewrites the location host/port on (201/301/302/307/308) redirects based on requested host/port. Default: false. * autoRewrite: rewrites the location host/port on (301/302/307/308) redirects based on requested host/port. Default: false.
* protocolRewrite: rewrites the location protocol on (201/301/302/307/308) redirects to 'http' or 'https'. Default: null. * protocolRewrite: rewrites the location protocol on (301/302/307/308) redirects to 'http' or 'https'. Default: null.
* } * }
* *
* NOTE: `options.ws` and `options.ssl` are optional. * NOTE: `options.ws` and `options.ssl` are optional.
@ -48,19 +54,6 @@ function createProxyServer(options) {
* } * }
*/ */
return new ProxyServer(options); return new httpProxy.Server(options);
} };
ProxyServer.createProxyServer = createProxyServer;
ProxyServer.createServer = createProxyServer;
ProxyServer.createProxy = createProxyServer;
/**
* Export the proxy "Server" as the main export.
*/
module.exports = ProxyServer;

View File

@ -39,7 +39,7 @@ common.setupOutgoing = function(outgoing, options, req, forward) {
function(e) { outgoing[e] = options[forward || 'target'][e]; } function(e) { outgoing[e] = options[forward || 'target'][e]; }
); );
outgoing.method = options.method || req.method; outgoing.method = req.method;
outgoing.headers = extend({}, req.headers); outgoing.headers = extend({}, req.headers);
if (options.headers){ if (options.headers){
@ -50,10 +50,6 @@ common.setupOutgoing = function(outgoing, options, req, forward) {
outgoing.auth = options.auth; outgoing.auth = options.auth;
} }
if (options.ca) {
outgoing.ca = options.ca;
}
if (isSSL.test(options[forward || 'target'].protocol)) { if (isSSL.test(options[forward || 'target'].protocol)) {
outgoing.rejectUnauthorized = (typeof options.secure === "undefined") ? true : options.secure; outgoing.rejectUnauthorized = (typeof options.secure === "undefined") ? true : options.secure;
} }
@ -92,7 +88,7 @@ common.setupOutgoing = function(outgoing, options, req, forward) {
// path is. This can be labeled as FOOT-GUN material if you do not know what // path is. This can be labeled as FOOT-GUN material if you do not know what
// you are doing and are using conflicting options. // you are doing and are using conflicting options.
// //
outgoingPath = !options.ignorePath ? outgoingPath : ''; outgoingPath = !options.ignorePath ? outgoingPath : '/';
outgoing.path = common.urlJoin(targetPath, outgoingPath); outgoing.path = common.urlJoin(targetPath, outgoingPath);
@ -186,10 +182,7 @@ common.urlJoin = function() {
// joining e.g. ['', 'am'] // joining e.g. ['', 'am']
// //
retSegs = [ retSegs = [
args.filter(Boolean).join('/') args.filter(Boolean).join('/').replace(/\/+/g, '/').replace(/:\//g, '://')
.replace(/\/+/g, '/')
.replace('http:/', 'http://')
.replace('https:/', 'https://')
]; ];
// Only join the query string if it exists so we don't have trailing a '?' // Only join the query string if it exists so we don't have trailing a '?'
@ -201,41 +194,6 @@ common.urlJoin = function() {
return retSegs.join('?') return retSegs.join('?')
}; };
/**
* Rewrites or removes the domain of a cookie header
*
* @param {String|Array} Header
* @param {Object} Config, mapping of domain to rewritten domain.
* '*' key to match any domain, null value to remove the domain.
*
* @api private
*/
common.rewriteCookieProperty = function rewriteCookieProperty(header, config, property) {
if (Array.isArray(header)) {
return header.map(function (headerElement) {
return rewriteCookieProperty(headerElement, config, property);
});
}
return header.replace(new RegExp("(;\\s*" + property + "=)([^;]+)", 'i'), function(match, prefix, previousValue) {
var newValue;
if (previousValue in config) {
newValue = config[previousValue];
} else if ('*' in config) {
newValue = config['*'];
} else {
//no match, return previous value
return match;
}
if (newValue) {
//replace value
return prefix + newValue;
} else {
//remove value
return '';
}
});
};
/** /**
* Check the host and see if it potentially has a port in it (keep it simple) * Check the host and see if it potentially has a port in it (keep it simple)
* *

View File

@ -1,4 +1,4 @@
var httpProxy = module.exports, var httpProxy = exports,
extend = require('util')._extend, extend = require('util')._extend,
parse_url = require('url').parse, parse_url = require('url').parse,
EE3 = require('eventemitter3'), EE3 = require('eventemitter3'),
@ -41,15 +41,14 @@ function createRightProxy(type) {
cntr--; cntr--;
} }
var requestOptions = options;
if( if(
!(args[cntr] instanceof Buffer) && !(args[cntr] instanceof Buffer) &&
args[cntr] !== res args[cntr] !== res
) { ) {
//Copy global options //Copy global options
requestOptions = extend({}, options); options = extend({}, options);
//Overwrite with request options //Overwrite with request options
extend(requestOptions, args[cntr]); extend(options, args[cntr]);
cntr--; cntr--;
} }
@ -61,11 +60,11 @@ function createRightProxy(type) {
/* optional args parse end */ /* optional args parse end */
['target', 'forward'].forEach(function(e) { ['target', 'forward'].forEach(function(e) {
if (typeof requestOptions[e] === 'string') if (typeof options[e] === 'string')
requestOptions[e] = parse_url(requestOptions[e]); options[e] = parse_url(options[e]);
}); });
if (!requestOptions.target && !requestOptions.forward) { if (!options.target && !options.forward) {
return this.emit('error', new Error('Must provide a proper URL as target')); return this.emit('error', new Error('Must provide a proper URL as target'));
} }
@ -78,7 +77,7 @@ function createRightProxy(type) {
* refer to the connection socket * refer to the connection socket
* pass(req, socket, options, head) * pass(req, socket, options, head)
*/ */
if(passes[i](req, res, requestOptions, head, this, cbl)) { // passes can return a truthy value to halt the loop if(passes[i](req, res, options, head, this, cbl)) { // passes can return a truthy value to halt the loop
break; break;
} }
} }

View File

@ -1,15 +1,13 @@
var httpNative = require('http'), var http = require('http'),
httpsNative = require('https'), https = require('https'),
web_o = require('./web-outgoing'), web_o = require('./web-outgoing'),
common = require('../common'), common = require('../common'),
followRedirects = require('follow-redirects'); passes = exports;
web_o = Object.keys(web_o).map(function(pass) { web_o = Object.keys(web_o).map(function(pass) {
return web_o[pass]; return web_o[pass];
}); });
var nativeAgents = { http: httpNative, https: httpsNative };
/*! /*!
* Array of passes. * Array of passes.
* *
@ -18,8 +16,7 @@ var nativeAgents = { http: httpNative, https: httpsNative };
* flexible. * flexible.
*/ */
[ // <--
module.exports = {
/** /**
* Sets `content-length` to '0' if request is of DELETE type. * Sets `content-length` to '0' if request is of DELETE type.
@ -31,11 +28,10 @@ module.exports = {
* @api private * @api private
*/ */
deleteLength: function deleteLength(req, res, options) { function deleteLength(req, res, options) {
if((req.method === 'DELETE' || req.method === 'OPTIONS') if((req.method === 'DELETE' || req.method === 'OPTIONS')
&& !req.headers['content-length']) { && !req.headers['content-length']) {
req.headers['content-length'] = '0'; req.headers['content-length'] = '0';
delete req.headers['transfer-encoding'];
} }
}, },
@ -49,7 +45,7 @@ module.exports = {
* @api private * @api private
*/ */
timeout: function timeout(req, res, options) { function timeout(req, res, options) {
if(options.timeout) { if(options.timeout) {
req.socket.setTimeout(options.timeout); req.socket.setTimeout(options.timeout);
} }
@ -65,7 +61,7 @@ module.exports = {
* @api private * @api private
*/ */
XHeaders: function XHeaders(req, res, options) { function XHeaders(req, res, options) {
if(!options.xfwd) return; if(!options.xfwd) return;
var encrypted = req.isSpdy || common.hasEncryptedConnection(req); var encrypted = req.isSpdy || common.hasEncryptedConnection(req);
@ -81,8 +77,6 @@ module.exports = {
(req.headers['x-forwarded-' + header] ? ',' : '') + (req.headers['x-forwarded-' + header] ? ',' : '') +
values[header]; values[header];
}); });
req.headers['x-forwarded-host'] = req.headers['x-forwarded-host'] || req.headers['host'] || '';
}, },
/** /**
@ -97,27 +91,15 @@ module.exports = {
* @api private * @api private
*/ */
stream: function stream(req, res, options, _, server, clb) { function stream(req, res, options, _, server, clb) {
// And we begin! // And we begin!
server.emit('start', req, res, options.target || options.forward); server.emit('start', req, res, options.target)
var agents = options.followRedirects ? followRedirects : nativeAgents;
var http = agents.http;
var https = agents.https;
if(options.forward) { if(options.forward) {
// If forward enable, so just pipe the request // If forward enable, so just pipe the request
var forwardReq = (options.forward.protocol === 'https:' ? https : http).request( var forwardReq = (options.forward.protocol === 'https:' ? https : http).request(
common.setupOutgoing(options.ssl || {}, options, req, 'forward') common.setupOutgoing(options.ssl || {}, options, req, 'forward')
); );
// error handler (e.g. ECONNRESET, ECONNREFUSED)
// Handle errors on incoming request as well as it makes sense to
var forwardError = createErrorHandler(forwardReq, options.forward);
req.on('error', forwardError);
forwardReq.on('error', forwardError);
(options.buffer || req).pipe(forwardReq); (options.buffer || req).pipe(forwardReq);
if(!options.target) { return res.end(); } if(!options.target) { return res.end(); }
} }
@ -129,9 +111,7 @@ module.exports = {
// Enable developers to modify the proxyReq before headers are sent // Enable developers to modify the proxyReq before headers are sent
proxyReq.on('socket', function(socket) { proxyReq.on('socket', function(socket) {
if(server && !proxyReq.getHeader('expect')) { if(server) { server.emit('proxyReq', proxyReq, req, res, options); }
server.emit('proxyReq', proxyReq, req, res, options);
}
}); });
// allow outgoing socket to timeout so that we could // allow outgoing socket to timeout so that we could
@ -147,23 +127,17 @@ module.exports = {
proxyReq.abort(); proxyReq.abort();
}); });
// handle errors in proxy and incoming request, just like for forward proxy // Handle errors on incoming request as well as it makes sense to
var proxyError = createErrorHandler(proxyReq, options.target);
req.on('error', proxyError); req.on('error', proxyError);
// Error Handler
proxyReq.on('error', proxyError); proxyReq.on('error', proxyError);
function createErrorHandler(proxyReq, url) { function proxyError (err){
return function proxyError(err) {
if (req.socket.destroyed && err.code === 'ECONNRESET') {
server.emit('econnreset', err, req, res, url);
return proxyReq.abort();
}
if (clb) { if (clb) {
clb(err, req, res, url); clb(err, req, res, options.target);
} else { } else {
server.emit('error', err, req, res, url); server.emit('error', err, req, res, options.target);
}
} }
} }
@ -171,24 +145,22 @@ module.exports = {
proxyReq.on('response', function(proxyRes) { proxyReq.on('response', function(proxyRes) {
if(server) { server.emit('proxyRes', proxyRes, req, res); } if(server) { server.emit('proxyRes', proxyRes, req, res); }
if(!res.headersSent && !options.selfHandleResponse) {
for(var i=0; i < web_o.length; i++) { for(var i=0; i < web_o.length; i++) {
if(web_o[i](req, res, proxyRes, options)) { break; } if(web_o[i](req, res, proxyRes, options)) { break; }
} }
}
if (!res.finished) {
// Allow us to listen when the proxy has completed // Allow us to listen when the proxy has completed
proxyRes.on('end', function () { proxyRes.on('end', function () {
if (server) server.emit('end', req, res, proxyRes); server.emit('end', req, res, proxyRes);
}); });
// We pipe to the response unless its expected to be handled by the user
if (!options.selfHandleResponse) proxyRes.pipe(res); proxyRes.pipe(res);
} else {
if (server) server.emit('end', req, res, proxyRes);
}
}); });
//proxyReq.end();
} }
}; ] // <--
.forEach(function(func) {
passes[func.name] = func;
});

View File

@ -1,8 +1,7 @@
var url = require('url'), var url = require('url'),
common = require('../common'); passes = exports;
var redirectRegex = /^30(1|2|7|8)$/;
var redirectRegex = /^201|30(1|2|7|8)$/;
/*! /*!
* Array of passes. * Array of passes.
@ -12,7 +11,7 @@ var redirectRegex = /^201|30(1|2|7|8)$/;
* flexible. * flexible.
*/ */
module.exports = { // <-- [ // <--
/** /**
* If is a HTTP 1.0 request, remove chunk headers * If is a HTTP 1.0 request, remove chunk headers
@ -23,7 +22,7 @@ module.exports = { // <--
* *
* @api private * @api private
*/ */
removeChunked: function removeChunked(req, res, proxyRes) { function removeChunked(req, res, proxyRes) {
if (req.httpVersion === '1.0') { if (req.httpVersion === '1.0') {
delete proxyRes.headers['transfer-encoding']; delete proxyRes.headers['transfer-encoding'];
} }
@ -39,15 +38,15 @@ module.exports = { // <--
* *
* @api private * @api private
*/ */
setConnection: function setConnection(req, res, proxyRes) { function setConnection(req, res, proxyRes) {
if (req.httpVersion === '1.0') { if (req.httpVersion === '1.0') {
proxyRes.headers.connection = req.headers.connection || 'close'; proxyRes.headers.connection = req.headers.connection || 'close';
} else if (req.httpVersion !== '2.0' && !proxyRes.headers.connection) { } else if (!proxyRes.headers.connection) {
proxyRes.headers.connection = req.headers.connection || 'keep-alive'; proxyRes.headers.connection = req.headers.connection || 'keep-alive';
} }
}, },
setRedirectHostRewrite: function setRedirectHostRewrite(req, res, proxyRes, options) { function setRedirectHostRewrite(req, res, proxyRes, options) {
if ((options.hostRewrite || options.autoRewrite || options.protocolRewrite) if ((options.hostRewrite || options.autoRewrite || options.protocolRewrite)
&& proxyRes.headers['location'] && proxyRes.headers['location']
&& redirectRegex.test(proxyRes.statusCode)) { && redirectRegex.test(proxyRes.statusCode)) {
@ -78,50 +77,12 @@ module.exports = { // <--
* @param {ClientRequest} Req Request object * @param {ClientRequest} Req Request object
* @param {IncomingMessage} Res Response object * @param {IncomingMessage} Res Response object
* @param {proxyResponse} Res Response object from the proxy request * @param {proxyResponse} Res Response object from the proxy request
* @param {Object} Options options.cookieDomainRewrite: Config to rewrite cookie domain
* *
* @api private * @api private
*/ */
writeHeaders: function writeHeaders(req, res, proxyRes, options) { function writeHeaders(req, res, proxyRes) {
var rewriteCookieDomainConfig = options.cookieDomainRewrite,
rewriteCookiePathConfig = options.cookiePathRewrite,
preserveHeaderKeyCase = options.preserveHeaderKeyCase,
rawHeaderKeyMap,
setHeader = function(key, header) {
if (header == undefined) return;
if (rewriteCookieDomainConfig && key.toLowerCase() === 'set-cookie') {
header = common.rewriteCookieProperty(header, rewriteCookieDomainConfig, 'domain');
}
if (rewriteCookiePathConfig && key.toLowerCase() === 'set-cookie') {
header = common.rewriteCookieProperty(header, rewriteCookiePathConfig, 'path');
}
res.setHeader(String(key).trim(), header);
};
if (typeof rewriteCookieDomainConfig === 'string') { //also test for ''
rewriteCookieDomainConfig = { '*': rewriteCookieDomainConfig };
}
if (typeof rewriteCookiePathConfig === 'string') { //also test for ''
rewriteCookiePathConfig = { '*': rewriteCookiePathConfig };
}
// message.rawHeaders is added in: v0.11.6
// https://nodejs.org/api/http.html#http_message_rawheaders
if (preserveHeaderKeyCase && proxyRes.rawHeaders != undefined) {
rawHeaderKeyMap = {};
for (var i = 0; i < proxyRes.rawHeaders.length; i += 2) {
var key = proxyRes.rawHeaders[i];
rawHeaderKeyMap[key.toLowerCase()] = key;
}
}
Object.keys(proxyRes.headers).forEach(function(key) { Object.keys(proxyRes.headers).forEach(function(key) {
var header = proxyRes.headers[key]; res.setHeader(key, proxyRes.headers[key]);
if (preserveHeaderKeyCase && rawHeaderKeyMap) {
key = rawHeaderKeyMap[key] || key;
}
setHeader(key, header);
}); });
}, },
@ -134,14 +95,11 @@ module.exports = { // <--
* *
* @api private * @api private
*/ */
writeStatusCode: function writeStatusCode(req, res, proxyRes) { function writeStatusCode(req, res, proxyRes) {
// From Node.js docs: response.writeHead(statusCode[, statusMessage][, headers]) res.writeHead(proxyRes.statusCode);
if(proxyRes.statusMessage) {
res.statusCode = proxyRes.statusCode;
res.statusMessage = proxyRes.statusMessage;
} else {
res.statusCode = proxyRes.statusCode;
}
} }
}; ] // <--
.forEach(function(func) {
passes[func.name] = func;
});

View File

@ -1,6 +1,7 @@
var http = require('http'), var http = require('http'),
https = require('https'), https = require('https'),
common = require('../common'); common = require('../common'),
passes = exports;
/*! /*!
* Array of passes. * Array of passes.
@ -15,8 +16,9 @@ var http = require('http'),
* *
*/ */
var passes = exports;
module.exports = { [
/** /**
* WebSocket requests must have the `GET` method and * WebSocket requests must have the `GET` method and
* the `upgrade:websocket` header * the `upgrade:websocket` header
@ -27,7 +29,7 @@ module.exports = {
* @api private * @api private
*/ */
checkMethodAndHeader : function checkMethodAndHeader(req, socket) { function checkMethodAndHeader (req, socket) {
if (req.method !== 'GET' || !req.headers.upgrade) { if (req.method !== 'GET' || !req.headers.upgrade) {
socket.destroy(); socket.destroy();
return true; return true;
@ -49,7 +51,7 @@ module.exports = {
* @api private * @api private
*/ */
XHeaders : function XHeaders(req, socket, options) { function XHeaders(req, socket, options) {
if(!options.xfwd) return; if(!options.xfwd) return;
var values = { var values = {
@ -76,25 +78,7 @@ module.exports = {
* *
* @api private * @api private
*/ */
stream : function stream(req, socket, options, head, server, clb) { function stream(req, socket, options, head, server, clb) {
var createHttpHeader = function(line, headers) {
return Object.keys(headers).reduce(function (head, key) {
var value = headers[key];
if (!Array.isArray(value)) {
head.push(key + ': ' + value);
return head;
}
for (var i = 0; i < value.length; i++) {
head.push(key + ': ' + value[i]);
}
return head;
}, [line])
.join('\r\n') + '\r\n\r\n';
}
common.setupSocket(socket); common.setupSocket(socket);
if (head && head.length) socket.unshift(head); if (head && head.length) socket.unshift(head);
@ -103,18 +87,11 @@ module.exports = {
var proxyReq = (common.isSSL.test(options.target.protocol) ? https : http).request( var proxyReq = (common.isSSL.test(options.target.protocol) ? https : http).request(
common.setupOutgoing(options.ssl || {}, options, req) common.setupOutgoing(options.ssl || {}, options, req)
); );
// Enable developers to modify the proxyReq before headers are sent
if (server) { server.emit('proxyReqWs', proxyReq, req, socket, options, head); }
// Error Handler // Error Handler
proxyReq.on('error', onOutgoingError); proxyReq.on('error', onOutgoingError);
proxyReq.on('response', function (res) { proxyReq.on('response', function (res) {
// if upgrade event isn't going to happen, close the socket // if upgrade event isn't going to happen, close the socket
if (!res.upgrade) { if (!res.upgrade) socket.end();
socket.write(createHttpHeader('HTTP/' + res.httpVersion + ' ' + res.statusCode + ' ' + res.statusMessage, res.headers));
res.pipe(socket);
}
}); });
proxyReq.on('upgrade', function(proxyRes, proxySocket, proxyHead) { proxyReq.on('upgrade', function(proxyRes, proxySocket, proxyHead) {
@ -140,7 +117,22 @@ module.exports = {
// Remark: Handle writing the headers to the socket when switching protocols // Remark: Handle writing the headers to the socket when switching protocols
// Also handles when a header is an array // Also handles when a header is an array
// //
socket.write(createHttpHeader('HTTP/1.1 101 Switching Protocols', proxyRes.headers)); socket.write(
Object.keys(proxyRes.headers).reduce(function (head, key) {
var value = proxyRes.headers[key];
if (!Array.isArray(value)) {
head.push(key + ': ' + value);
return head;
}
for (var i = 0; i < value.length; i++) {
head.push(key + ': ' + value[i]);
}
return head;
}, ['HTTP/1.1 101 Switching Protocols'])
.join('\r\n') + '\r\n\r\n'
);
proxySocket.pipe(socket).pipe(proxySocket); proxySocket.pipe(socket).pipe(proxySocket);
@ -159,4 +151,8 @@ module.exports = {
socket.end(); socket.end();
} }
} }
};
] // <--
.forEach(function(func) {
passes[func.name] = func;
});

2028
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,41 +1,44 @@
{ {
"name": "http-proxy", "name": "http-proxy",
"version": "1.18.1", "version": "1.11.3",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/http-party/node-http-proxy.git" "url": "https://github.com/nodejitsu/node-http-proxy.git"
}, },
"description": "HTTP proxying for the masses", "description": "HTTP proxying for the masses",
"author": "Charlie Robbins <charlie.robbins@gmail.com>", "author": "Nodejitsu Inc. <info@nodejitsu.com>",
"maintainers": [ "maintainers": [
"jcrugzz <jcrugzz@gmail.com>" "yawnt <yawnt@nodejitsu.com>",
"indexzero <charlie@nodejitsu.com>"
], ],
"main": "index.js", "main": "index.js",
"dependencies": { "dependencies": {
"eventemitter3": "^4.0.0", "eventemitter3": "1.x.x",
"requires-port": "^1.0.0", "requires-port": "0.x.x"
"follow-redirects": "^1.0.0"
}, },
"devDependencies": { "devDependencies": {
"async": "^3.0.0", "async": "*",
"auto-changelog": "^1.15.0", "blanket": "*",
"concat-stream": "^2.0.0", "coveralls": "*",
"expect.js": "~0.3.1", "dox": "*",
"mocha": "^3.5.3", "expect.js": "*",
"nyc": "^14.0.0", "mocha": "*",
"semver": "^5.0.3", "mocha-lcov-reporter": "*",
"socket.io": "^2.1.0", "semver": "^4.3.3",
"socket.io-client": "^2.1.0", "socket.io": "*",
"sse": "0.0.8", "socket.io-client": "*",
"ws": "^3.0.0" "ws": "~0.5.0"
}, },
"scripts": { "scripts": {
"mocha": "mocha test/*-test.js", "coveralls": "mocha --require blanket --reporter mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js",
"test": "nyc --reporter=text --reporter=lcov npm run mocha", "blanket": {
"version": "auto-changelog -p && git add CHANGELOG.md" "pattern": "lib/http-proxy"
},
"test": "mocha -R landing test/*-test.js",
"test-cov": "mocha --require blanket -R html-cov > cov/coverage.html"
}, },
"engines": { "engines": {
"node": ">=8.0.0" "node": ">=0.10.0"
}, },
"license": "MIT" "license": "MIT"
} }

View File

@ -1,19 +0,0 @@
{
"platform": "github",
"autodiscover": false,
"requireConfig": true,
"ignoreNpmrcFile": true,
"rangeStrategy": "replace",
"packageRules": [
{
"packagePatterns": [
"*"
],
"minor": {
"groupName": "all non-major dependencies",
"groupSlug": "all-minor-patch"
}
}
],
"commitMessagePrefix": "[dist]"
}

View File

@ -1,7 +1,7 @@
/* /*
examples-test.js: Test to run all the examples examples-test.js: Test to run all the examples
Copyright (c) 2013 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors. Copyright (c) Nodejitsu 2013
*/ */
var path = require('path'), var path = require('path'),

View File

@ -1,25 +1,13 @@
-----BEGIN CERTIFICATE----- -----BEGIN CERTIFICATE-----
MIIEIDCCAggCCQChRDh/XiBF+zANBgkqhkiG9w0BAQsFADBUMQswCQYDVQQGEwJ1 MIIB7DCCAZYCCQC7gs0MDNn6MTANBgkqhkiG9w0BAQUFADB9MQswCQYDVQQGEwJV
czETMBEGA1UECAwKV2FzaGluZ3RvbjEQMA4GA1UEBwwHU2VhdHRsZTEeMBwGA1UE UzELMAkGA1UECBMCQ0ExCzAJBgNVBAcTAlNGMQ8wDQYDVQQKEwZKb3llbnQxEDAO
AwwVRHVtbXkgSW50ZXJtZWRpYXRlIENBMB4XDTE4MDYyMjIwMzEwNFoXDTMyMDIy BgNVBAsTB05vZGUuanMxDzANBgNVBAMTBmFnZW50MjEgMB4GCSqGSIb3DQEJARYR
OTIwMzEwNFowUDELMAkGA1UEBhMCdXMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAO cnlAdGlueWNsb3Vkcy5vcmcwHhcNMTEwMzE0MTgyOTEyWhcNMzgwNzI5MTgyOTEy
BgNVBAcMB1NlYXR0bGUxGjAYBgNVBAMMEWR1bW15LmV4YW1wbGUuY29tMIIBIjAN WjB9MQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExCzAJBgNVBAcTAlNGMQ8wDQYD
BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvSQq3d8AeZMTvtqZ13jWCckikyXJ VQQKEwZKb3llbnQxEDAOBgNVBAsTB05vZGUuanMxDzANBgNVBAMTBmFnZW50MjEg
SACvkGCQUCJqOceESbg6IHdRzQdoccE4P3sbvNsf9BlbdJKM+neCxabqKaU1PPje MB4GCSqGSIb3DQEJARYRcnlAdGlueWNsb3Vkcy5vcmcwXDANBgkqhkiG9w0BAQEF
4P0tHT57t6yJrMuUh9NxEz3Bgh1srNHVS7saKvwHmcKm79jc+wxlioPmEQvQagjn AANLADBIAkEAyXb8FrRdKbhrKLgLSsn61i1C7w7fVVVd7OQsmV/7p9WB2lWFiDlC
y7oTkyLt0sn4LGxBjrcv2JoHOC9f1pxX7l47MaiN0/ctRau7Nr3PFn+pkB4Yf6Z0 WKGU9SiIz/A6wNZDUAuc2E+VwtpCT561AQIDAQABMA0GCSqGSIb3DQEBBQUAA0EA
VyicVJbaUSz39Qo4HQWl1L2hiBP3CS1oKs2Yk0O1aOCMExWrhZQan+ZgHqL1rhgm C8HzpuNhFLCI3A5KkBS5zHAQax6TFUOhbpBCR0aTDbJ6F1liDTK1lmU/BjvPoj+9
kPpw2/zwwPt5Vf9CSakvHwg198EXuTTXtkzYduuIJAm8yp969iEIiG2xTwIDAQAB 1LHwrmh29rK8kBPEjmymCQ==
MA0GCSqGSIb3DQEBCwUAA4ICAQBnMSIo+kujkeXPh+iErFBmNtu/7EA+i/QnFPbN
lSLngclYYBJAGQI+DhirJI8ghDi6vmlHB2THewDaOJXEKvC1czE8064wioIcA9HJ
l3QJ3YYOFRctYdSHBU4TWdJbPgkLWDzYP5smjOfw8nDdr4WO/5jh9qRFcFpTFmQf
DyU3xgWLsQnNK3qXLdJjWG75pEhHR+7TGo+Ob/RUho/1RX/P89Ux7/oVbzdKqqFu
SErXAsjEIEFzWOM2uDOt6hrxDF6q+8/zudwQNEo422poEcTT9tDEFxMQ391CzZRi
nozBm4igRn1f5S3YZzLI6VEUns0s76BNy2CzvFWn40DziTqNBExAMfFFj76wiMsX
6fTIdcvkaTBa0S9SZB0vN99qahBdcG17rt4RssMHVRH1Wn7NXMwe476L0yXZ6gO7
Z4uNAPxgaI3BRP75EPfslLutCLZ+BC4Zzu6MY0Salbpfl0Go462EhsKCxvYhE2Dg
T477pICLfETZfA499Fd1tOaIsoLCrILAia/+Yd76uf94MuXUIqykDng/4H7xCc47
BZhNFJiPC6XHaXzN7NYSEUNX9VOwY8ncxKwtP6TXga96PdMUy/p98KIM8RZlDoxB
Xy9dcZBFNn/zrqjW7R0CCWCUriDIFSmEP0wDZ91YYa6BVuJMb5uL/USkTLpjZS4/
HNGvug==
-----END CERTIFICATE----- -----END CERTIFICATE-----

10
test/fixtures/agent2-csr.pem vendored Normal file
View File

@ -0,0 +1,10 @@
-----BEGIN CERTIFICATE REQUEST-----
MIIBXTCCAQcCAQAwfTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH
EwJTRjEPMA0GA1UEChMGSm95ZW50MRAwDgYDVQQLEwdOb2RlLmpzMQ8wDQYDVQQD
EwZhZ2VudDIxIDAeBgkqhkiG9w0BCQEWEXJ5QHRpbnljbG91ZHMub3JnMFwwDQYJ
KoZIhvcNAQEBBQADSwAwSAJBAMl2/Ba0XSm4ayi4C0rJ+tYtQu8O31VVXezkLJlf
+6fVgdpVhYg5QlihlPUoiM/wOsDWQ1ALnNhPlcLaQk+etQECAwEAAaAlMCMGCSqG
SIb3DQEJBzEWExRBIGNoYWxsZW5nZSBwYXNzd29yZDANBgkqhkiG9w0BAQUFAANB
AJnll2pt5l0pzskQSpjjLVTlFDFmJr/AZ3UK8v0WxBjYjCe5Jx4YehkChpxIyDUm
U3J9q9MDUf0+Y2+EGkssFfk=
-----END CERTIFICATE REQUEST-----

View File

@ -1,27 +1,9 @@
-----BEGIN RSA PRIVATE KEY----- -----BEGIN RSA PRIVATE KEY-----
MIIEpQIBAAKCAQEAvSQq3d8AeZMTvtqZ13jWCckikyXJSACvkGCQUCJqOceESbg6 MIIBOgIBAAJBAMl2/Ba0XSm4ayi4C0rJ+tYtQu8O31VVXezkLJlf+6fVgdpVhYg5
IHdRzQdoccE4P3sbvNsf9BlbdJKM+neCxabqKaU1PPje4P0tHT57t6yJrMuUh9Nx QlihlPUoiM/wOsDWQ1ALnNhPlcLaQk+etQECAwEAAQJBAMT6Bf34+UHKY1ObpsbH
Ez3Bgh1srNHVS7saKvwHmcKm79jc+wxlioPmEQvQagjny7oTkyLt0sn4LGxBjrcv 9u2jsVblFq1rWvs8GPMY6oertzvwm3DpuSUp7PTgOB1nLTLYtCERbQ4ovtN8tn3p
2JoHOC9f1pxX7l47MaiN0/ctRau7Nr3PFn+pkB4Yf6Z0VyicVJbaUSz39Qo4HQWl OHUCIQDzIEGsoCr5vlxXvy2zJwu+fxYuhTZWMVuo1397L0VyhwIhANQh+yzqUgaf
1L2hiBP3CS1oKs2Yk0O1aOCMExWrhZQan+ZgHqL1rhgmkPpw2/zwwPt5Vf9CSakv WRtSB4T2W7ADtJI35ET61jKBty3CqJY3AiAIwju7dVW3A5WeD6Qc1SZGKZvp9yCb
Hwg198EXuTTXtkzYduuIJAm8yp969iEIiG2xTwIDAQABAoIBAGPIw/C/qJF7HYyv AFI2BfVwwaY11wIgXF3PeGcvACMyMWsuSv7aPXHfliswAbkWuzcwA4TW01ECIGWa
6T+7GTiaa2o0IiehbP3/Y8NTFLWc49a8obXlHTvMr7Zr2I/tE+ojtIzkH9K1SjkN cgsDvVFxmfM5NPSuT/UDTa6R5BFISB5ea0N0AR3I
eelqsNj9tsOPDI6oIvftsflpxkxqLtclnt8m0oMhoObf4OaONDT/N8dP4SBiSdsM
ZDmacnMFx5NZVWiup4sVf2CYexx7qks9FhyN2K5PArCQ4S9LHjFhSJVH4DSEpv7E
Ykbp30rhpqV7wSwjgUsm8ZYvI2NOlmffzLSiPdt3vy2K5Q25S/MVEAicg83rfDgK
6EluHjeygRI1xU6DJ0hU7tnU7zE9KURoHPUycO3BKzZnzUH26AA36I58Pu4fXWw/
Cgmbv2ECgYEA+og9E4ziKCEi3p8gqjIfwTRgWZxDLjEzooB/K0UhEearn/xiX29A
FiSzEHKfCB4uSrw5OENg2ckDs8uy08Qmxx7xFXL7AtufAl5fIYaWa0sNSqCaIk7p
ebbUmPcaYhKiLzIEd1EYEL38sXVZ62wvSVMRSWvEMq44g1qnoRlDa/8CgYEAwUTt
talYNwVmR9ZdkVEWm9ZxirdzoM6NaM6u4Tf34ygptpapdmIFSUhfq4iOiEnRGNg/
tuNqhNCIb3LNpJbhRPEzqN7E7qiF/mp7AcJgbuxLZBm12QuLuJdG3nrisKPFXcY1
lA4A7CFmNgH3E4THFfgwzyDXsBOxVLXleTqn+rECgYEA9up1P6J3dtOJuV2d5P/3
ugRz/X173LfTSxJXw36jZDAy8D/feG19/RT4gnplcKvGNhQiVOhbOOnbw0U8n2fQ
TCmbs+cZqyxnH/+AxNsPvvk+RVHZ93xMsY/XIldP4l65B8jFDA+Zp06IESI2mEeM
pzi+bd1Phh+dRSCA2865W2MCgYEAlxYsgmQ1WyX0dFpHYU+zzfXRYzDQyrhOYc2Z
duVK+yCto1iad7pfCY/zgmRJkI+sT7DV9kJIRjXDQuTLkEyHJF8vFGe6KhxCS8aw
DIsI2g4NTd6vg1J8UryoIUqNpqsQoqNNxUVBQVdG0ReuMGsPO8R/W50AIFz0txVP
o/rP0LECgYEA7e/mOwCnR+ovmS/CAksmos3oIqvkRkXNKpKe513FVmp3TpTU38ex
cBkFNU3hEO31FyrX1hGIKp3N5mHYSQ1lyODHM6teHW0OLWWTwIe8rIGvR2jfRLe0
bbkdj40atYVkfeFmpz9uHHG24CUYxJdPc360jbXTVp4i3q8zqgL5aMY=
-----END RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----

19
test/fixtures/agent2.cnf vendored Normal file
View File

@ -0,0 +1,19 @@
[ req ]
default_bits = 1024
days = 999
distinguished_name = req_distinguished_name
attributes = req_attributes
prompt = no
[ req_distinguished_name ]
C = US
ST = CA
L = SF
O = Joyent
OU = Node.js
CN = agent2
emailAddress = ry@tinyclouds.org
[ req_attributes ]
challengePassword = A challenge password

View File

@ -241,28 +241,6 @@ describe('lib/http-proxy/common.js', function () {
expect(outgoing.path).to.eql('/' + google); expect(outgoing.path).to.eql('/' + google);
}); });
it('should not replace :\ to :\\ when no https word before', function () {
var outgoing = {};
var google = 'https://google.com:/join/join.js'
common.setupOutgoing(outgoing, {
target: url.parse('http://sometarget.com:80'),
toProxy: true,
}, { url: google });
expect(outgoing.path).to.eql('/' + google);
});
it('should not replace :\ to :\\ when no http word before', function () {
var outgoing = {};
var google = 'http://google.com:/join/join.js'
common.setupOutgoing(outgoing, {
target: url.parse('http://sometarget.com:80'),
toProxy: true,
}, { url: google });
expect(outgoing.path).to.eql('/' + google);
});
describe('when using ignorePath', function () { describe('when using ignorePath', function () {
it('should ignore the path of the `req.url` passed in but use the target path', function () { it('should ignore the path of the `req.url` passed in but use the target path', function () {
var outgoing = {}; var outgoing = {};
@ -272,7 +250,7 @@ describe('lib/http-proxy/common.js', function () {
ignorePath: true ignorePath: true
}, { url: '/more/crazy/pathness' }); }, { url: '/more/crazy/pathness' });
expect(outgoing.path).to.eql('/some/crazy/path/whoooo'); expect(outgoing.path).to.eql('/some/crazy/path/whoooo/');
}); });
it('and prependPath: false, it should ignore path of target and incoming request', function () { it('and prependPath: false, it should ignore path of target and incoming request', function () {
@ -284,7 +262,7 @@ describe('lib/http-proxy/common.js', function () {
prependPath: false prependPath: false
}, { url: '/more/crazy/pathness' }); }, { url: '/more/crazy/pathness' });
expect(outgoing.path).to.eql(''); expect(outgoing.path).to.eql('/');
}); });
}); });
@ -347,16 +325,6 @@ describe('lib/http-proxy/common.js', function () {
expect(outgoing.secureProtocol).eql('my-secure-protocol'); expect(outgoing.secureProtocol).eql('my-secure-protocol');
}); });
it('should handle overriding the `method` of the http request', function () {
var outgoing = {};
common.setupOutgoing(outgoing, {
target: url.parse('https://whooooo.com'),
method: 'POST' ,
}, { method: 'GET', url: '' });
expect(outgoing.method).eql('POST');
});
// url.parse('').path => null // url.parse('').path => null
it('should not pass null as last arg to #urlJoin', function(){ it('should not pass null as last arg to #urlJoin', function(){
var outgoing = {}; var outgoing = {};

View File

@ -1,9 +1,6 @@
var webPasses = require('../lib/http-proxy/passes/web-incoming'), var webPasses = require('../lib/http-proxy/passes/web-incoming'),
httpProxy = require('../lib/http-proxy'), httpProxy = require('../lib/http-proxy'),
expect = require('expect.js'), expect = require('expect.js'),
concat = require('concat-stream'),
async = require('async'),
url = require('url'),
http = require('http'); http = require('http');
describe('lib/http-proxy/passes/web.js', function() { describe('lib/http-proxy/passes/web.js', function() {
@ -25,18 +22,6 @@ describe('lib/http-proxy/passes/web.js', function() {
webPasses.deleteLength(stubRequest, {}, {}); webPasses.deleteLength(stubRequest, {}, {});
expect(stubRequest.headers['content-length']).to.eql('0'); expect(stubRequest.headers['content-length']).to.eql('0');
}); });
it('should remove `transfer-encoding` from empty DELETE requests', function() {
var stubRequest = {
method: 'DELETE',
headers: {
'transfer-encoding': 'chunked'
}
};
webPasses.deleteLength(stubRequest, {}, {});
expect(stubRequest.headers['content-length']).to.eql('0');
expect(stubRequest.headers).to.not.have.key('transfer-encoding');
});
}); });
describe('#timeout', function() { describe('#timeout', function() {
@ -126,50 +111,6 @@ describe('#createProxyServer.web() using own http server', function () {
http.request('http://127.0.0.1:8081', function() {}).end(); http.request('http://127.0.0.1:8081', function() {}).end();
}); });
it('should skip proxyReq event when handling a request with header "expect: 100-continue" [https://www.npmjs.com/advisories/1486]', function (done) {
var proxy = httpProxy.createProxyServer({
target: 'http://127.0.0.1:8080',
});
proxy.on('proxyReq', function(proxyReq, req, res, options) {
proxyReq.setHeader('X-Special-Proxy-Header', 'foobar');
});
function requestHandler(req, res) {
proxy.web(req, res);
}
var proxyServer = http.createServer(requestHandler);
var source = http.createServer(function(req, res) {
source.close();
proxyServer.close();
expect(req.headers['x-special-proxy-header']).to.not.eql('foobar');
done();
});
proxyServer.listen('8081');
source.listen('8080');
const postData = ''.padStart(1025, 'x');
const postOptions = {
hostname: '127.0.0.1',
port: 8081,
path: '/',
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
'Content-Length': Buffer.byteLength(postData),
'expect': '100-continue'
}
};
const req = http.request(postOptions, function() {});
req.write(postData);
req.end();
});
it('should proxy the request and handle error via callback', function(done) { it('should proxy the request and handle error via callback', function(done) {
var proxy = httpProxy.createProxyServer({ var proxy = httpProxy.createProxyServer({
target: 'http://127.0.0.1:8080' target: 'http://127.0.0.1:8080'
@ -224,35 +165,6 @@ describe('#createProxyServer.web() using own http server', function () {
}, function() {}).end(); }, function() {}).end();
}); });
it('should forward the request and handle error via event listener', function(done) {
var proxy = httpProxy.createProxyServer({
forward: 'http://127.0.0.1:8080'
});
var proxyServer = http.createServer(requestHandler);
function requestHandler(req, res) {
proxy.once('error', function (err, errReq, errRes) {
proxyServer.close();
expect(err).to.be.an(Error);
expect(errReq).to.be.equal(req);
expect(errRes).to.be.equal(res);
expect(err.code).to.be('ECONNREFUSED');
done();
});
proxy.web(req, res);
}
proxyServer.listen('8083');
http.request({
hostname: '127.0.0.1',
port: '8083',
method: 'GET',
}, function() {}).end();
});
it('should proxy the request and handle timeout error (proxyTimeout)', function(done) { it('should proxy the request and handle timeout error (proxyTimeout)', function(done) {
var proxy = httpProxy.createProxyServer({ var proxy = httpProxy.createProxyServer({
target: 'http://127.0.0.1:45000', target: 'http://127.0.0.1:45000',
@ -305,7 +217,7 @@ describe('#createProxyServer.web() using own http server', function () {
var started = new Date().getTime(); var started = new Date().getTime();
function requestHandler(req, res) { function requestHandler(req, res) {
proxy.once('econnreset', function (err, errReq, errRes) { proxy.once('error', function (err, errReq, errRes) {
proxyServer.close(); proxyServer.close();
expect(err).to.be.an(Error); expect(err).to.be.an(Error);
expect(errReq).to.be.equal(req); expect(errReq).to.be.equal(req);
@ -362,44 +274,6 @@ describe('#createProxyServer.web() using own http server', function () {
http.request('http://127.0.0.1:8086', function() {}).end(); http.request('http://127.0.0.1:8086', function() {}).end();
}); });
it('should proxy the request and provide and respond to manual user response when using modifyResponse', function(done) {
var proxy = httpProxy.createProxyServer({
target: 'http://127.0.0.1:8080',
selfHandleResponse: true
});
function requestHandler(req, res) {
proxy.once('proxyRes', function (proxyRes, pReq, pRes) {
proxyRes.pipe(concat(function (body) {
expect(body.toString('utf8')).eql('Response');
pRes.end(Buffer.from('my-custom-response'));
}))
});
proxy.web(req, res);
}
var proxyServer = http.createServer(requestHandler);
var source = http.createServer(function(req, res) {
res.end('Response');
});
async.parallel([
next => proxyServer.listen(8086, next),
next => source.listen(8080, next)
], function (err) {
http.get('http://127.0.0.1:8086', function(res) {
res.pipe(concat(function(body) {
expect(body.toString('utf8')).eql('my-custom-response');
source.close();
proxyServer.close();
done();
}));
}).once('error', done);
})
});
it('should proxy the request and handle changeOrigin option', function (done) { it('should proxy the request and handle changeOrigin option', function (done) {
var proxy = httpProxy.createProxyServer({ var proxy = httpProxy.createProxyServer({
target: 'http://127.0.0.1:8080', target: 'http://127.0.0.1:8080',
@ -452,85 +326,4 @@ describe('#createProxyServer.web() using own http server', function () {
http.request('http://127.0.0.1:8081', function() {}).end(); http.request('http://127.0.0.1:8081', function() {}).end();
}); });
it('should proxy requests to multiple servers with different options', function (done) {
var proxy = httpProxy.createProxyServer();
// proxies to two servers depending on url, rewriting the url as well
// http://127.0.0.1:8080/s1/ -> http://127.0.0.1:8081/
// http://127.0.0.1:8080/ -> http://127.0.0.1:8082/
function requestHandler(req, res) {
if (req.url.indexOf('/s1/') === 0) {
proxy.web(req, res, {
ignorePath: true,
target: 'http://127.0.0.1:8081' + req.url.substring(3)
});
} else {
proxy.web(req, res, {
target: 'http://127.0.0.1:8082'
});
}
}
var proxyServer = http.createServer(requestHandler);
var source1 = http.createServer(function(req, res) {
expect(req.method).to.eql('GET');
expect(req.headers.host.split(':')[1]).to.eql('8080');
expect(req.url).to.eql('/test1');
});
var source2 = http.createServer(function(req, res) {
source1.close();
source2.close();
proxyServer.close();
expect(req.method).to.eql('GET');
expect(req.headers.host.split(':')[1]).to.eql('8080');
expect(req.url).to.eql('/test2');
done();
});
proxyServer.listen('8080');
source1.listen('8081');
source2.listen('8082');
http.request('http://127.0.0.1:8080/s1/test1', function() {}).end();
http.request('http://127.0.0.1:8080/test2', function() {}).end();
});
});
describe('#followRedirects', function () {
it('should proxy the request follow redirects', function (done) {
var proxy = httpProxy.createProxyServer({
target: 'http://127.0.0.1:8080',
followRedirects: true
});
function requestHandler(req, res) {
proxy.web(req, res);
}
var proxyServer = http.createServer(requestHandler);
var source = http.createServer(function(req, res) {
if (url.parse(req.url).pathname === '/redirect') {
res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end('ok');
}
res.writeHead(301, { 'Location': '/redirect' });
res.end();
});
proxyServer.listen('8081');
source.listen('8080');
http.request('http://127.0.0.1:8081', function(res) {
source.close();
proxyServer.close();
expect(res.statusCode).to.eql(200);
done();
}).end();
});
}); });

View File

@ -6,25 +6,25 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
beforeEach(function() { beforeEach(function() {
this.req = { this.req = {
headers: { headers: {
host: 'ext-auto.com' host: "ext-auto.com"
} }
}; };
this.proxyRes = { this.proxyRes = {
statusCode: 301, statusCode: 301,
headers: { headers: {
location: 'http://backend.com/' location: "http://backend.com/"
} }
}; };
this.options = { this.options = {
target: 'http://backend.com' target: "http://backend.com"
}; };
}); });
context('rewrites location host with hostRewrite', function() { context('rewrites location host with hostRewrite', function() {
beforeEach(function() { beforeEach(function() {
this.options.hostRewrite = 'ext-manual.com'; this.options.hostRewrite = "ext-manual.com";
}); });
[201, 301, 302, 307, 308].forEach(function(code) { [301, 302, 307, 308].forEach(function(code) {
it('on ' + code, function() { it('on ' + code, function() {
this.proxyRes.statusCode = code; this.proxyRes.statusCode = code;
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
@ -52,14 +52,14 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
it('not when the redirected location does not match target host', function() { it('not when the redirected location does not match target host', function() {
this.proxyRes.statusCode = 302; this.proxyRes.statusCode = 302;
this.proxyRes.headers.location = 'http://some-other/'; this.proxyRes.headers.location = "http://some-other/";
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
expect(this.proxyRes.headers.location).to.eql('http://some-other/'); expect(this.proxyRes.headers.location).to.eql('http://some-other/');
}); });
it('not when the redirected location does not match target port', function() { it('not when the redirected location does not match target port', function() {
this.proxyRes.statusCode = 302; this.proxyRes.statusCode = 302;
this.proxyRes.headers.location = 'http://backend.com:8080/'; this.proxyRes.headers.location = "http://backend.com:8080/";
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
expect(this.proxyRes.headers.location).to.eql('http://backend.com:8080/'); expect(this.proxyRes.headers.location).to.eql('http://backend.com:8080/');
}); });
@ -69,7 +69,7 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
beforeEach(function() { beforeEach(function() {
this.options.autoRewrite = true; this.options.autoRewrite = true;
}); });
[201, 301, 302, 307, 308].forEach(function(code) { [301, 302, 307, 308].forEach(function(code) {
it('on ' + code, function() { it('on ' + code, function() {
this.proxyRes.statusCode = code; this.proxyRes.statusCode = code;
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
@ -91,14 +91,14 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
it('not when the redirected location does not match target host', function() { it('not when the redirected location does not match target host', function() {
this.proxyRes.statusCode = 302; this.proxyRes.statusCode = 302;
this.proxyRes.headers.location = 'http://some-other/'; this.proxyRes.headers.location = "http://some-other/";
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
expect(this.proxyRes.headers.location).to.eql('http://some-other/'); expect(this.proxyRes.headers.location).to.eql('http://some-other/');
}); });
it('not when the redirected location does not match target port', function() { it('not when the redirected location does not match target port', function() {
this.proxyRes.statusCode = 302; this.proxyRes.statusCode = 302;
this.proxyRes.headers.location = 'http://backend.com:8080/'; this.proxyRes.headers.location = "http://backend.com:8080/";
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
expect(this.proxyRes.headers.location).to.eql('http://backend.com:8080/'); expect(this.proxyRes.headers.location).to.eql('http://backend.com:8080/');
}); });
@ -108,7 +108,7 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
beforeEach(function() { beforeEach(function() {
this.options.protocolRewrite = 'https'; this.options.protocolRewrite = 'https';
}); });
[201, 301, 302, 307, 308].forEach(function(code) { [301, 302, 307, 308].forEach(function(code) {
it('on ' + code, function() { it('on ' + code, function() {
this.proxyRes.statusCode = code; this.proxyRes.statusCode = code;
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
@ -129,13 +129,13 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
}); });
it('works together with hostRewrite', function() { it('works together with hostRewrite', function() {
this.options.hostRewrite = 'ext-manual.com'; this.options.hostRewrite = 'ext-manual.com'
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
expect(this.proxyRes.headers.location).to.eql('https://ext-manual.com/'); expect(this.proxyRes.headers.location).to.eql('https://ext-manual.com/');
}); });
it('works together with autoRewrite', function() { it('works together with autoRewrite', function() {
this.options.autoRewrite = true; this.options.autoRewrite = true
httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options); httpProxy.setRedirectHostRewrite(this.req, {}, this.proxyRes, this.options);
expect(this.proxyRes.headers.location).to.eql('https://ext-auto.com/'); expect(this.proxyRes.headers.location).to.eql('https://ext-auto.com/');
}); });
@ -191,28 +191,6 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
expect(proxyRes.headers.connection).to.eql('keep-alive'); expect(proxyRes.headers.connection).to.eql('keep-alive');
}); });
it('don`t set connection with 2.0 if exist', function() {
var proxyRes = { headers: {} };
httpProxy.setConnection({
httpVersion: '2.0',
headers: {
connection: 'namstey'
}
}, {}, proxyRes);
expect(proxyRes.headers.connection).to.eql(undefined);
});
it('don`t set connection with 2.0 if doesn`t exist', function() {
var proxyRes = { headers: {} };
httpProxy.setConnection({
httpVersion: '2.0',
headers: {}
}, {}, proxyRes);
expect(proxyRes.headers.connection).to.eql(undefined);
})
}); });
describe('#writeStatusCode', function () { describe('#writeStatusCode', function () {
@ -221,189 +199,31 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
writeHead: function(n) { writeHead: function(n) {
expect(n).to.eql(200); expect(n).to.eql(200);
} }
}; }
httpProxy.writeStatusCode({}, res, { statusCode: 200 }); httpProxy.writeStatusCode({}, res, { statusCode: 200 });
}); });
}); });
describe('#writeHeaders', function() { describe('#writeHeaders', function() {
beforeEach(function() { var proxyRes = {
this.proxyRes = {
headers: { headers: {
hey: 'hello', hey: 'hello',
how: 'are you?', how: 'are you?'
'set-cookie': [
'hello; domain=my.domain; path=/',
'there; domain=my.domain; path=/'
]
} }
}; };
this.rawProxyRes = {
headers: { var res = {
hey: 'hello',
how: 'are you?',
'set-cookie': [
'hello; domain=my.domain; path=/',
'there; domain=my.domain; path=/'
]
},
rawHeaders: [
'Hey', 'hello',
'How', 'are you?',
'Set-Cookie', 'hello; domain=my.domain; path=/',
'Set-Cookie', 'there; domain=my.domain; path=/'
]
};
this.res = {
setHeader: function(k, v) { setHeader: function(k, v) {
// https://nodejs.org/api/http.html#http_message_headers this.headers[k] = v;
// Header names are lower-cased
this.headers[k.toLowerCase()] = v;
}, },
headers: {} headers: {}
}; };
});
it('writes headers', function() { httpProxy.writeHeaders({}, res, proxyRes);
var options = {};
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers.hey).to.eql('hello'); expect(res.headers.hey).to.eql('hello');
expect(this.res.headers.how).to.eql('are you?'); expect(res.headers.how).to.eql('are you?');
expect(this.res.headers).to.have.key('set-cookie');
expect(this.res.headers['set-cookie']).to.be.an(Array);
expect(this.res.headers['set-cookie']).to.have.length(2);
});
it('writes raw headers', function() {
var options = {};
httpProxy.writeHeaders({}, this.res, this.rawProxyRes, options);
expect(this.res.headers.hey).to.eql('hello');
expect(this.res.headers.how).to.eql('are you?');
expect(this.res.headers).to.have.key('set-cookie');
expect(this.res.headers['set-cookie']).to.be.an(Array);
expect(this.res.headers['set-cookie']).to.have.length(2);
});
it('rewrites path', function() {
var options = {
cookiePathRewrite: '/dummyPath'
};
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello; domain=my.domain; path=/dummyPath');
});
it('does not rewrite path', function() {
var options = {};
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello; domain=my.domain; path=/');
});
it('removes path', function() {
var options = {
cookiePathRewrite: ''
};
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello; domain=my.domain');
});
it('does not rewrite domain', function() {
var options = {};
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello; domain=my.domain; path=/');
});
it('rewrites domain', function() {
var options = {
cookieDomainRewrite: 'my.new.domain'
};
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello; domain=my.new.domain; path=/');
});
it('removes domain', function() {
var options = {
cookieDomainRewrite: ''
};
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello; path=/');
});
it('rewrites headers with advanced configuration', function() {
var options = {
cookieDomainRewrite: {
'*': '',
'my.old.domain': 'my.new.domain',
'my.special.domain': 'my.special.domain'
}
};
this.proxyRes.headers['set-cookie'] = [
'hello-on-my.domain; domain=my.domain; path=/',
'hello-on-my.old.domain; domain=my.old.domain; path=/',
'hello-on-my.special.domain; domain=my.special.domain; path=/'
];
httpProxy.writeHeaders({}, this.res, this.proxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello-on-my.domain; path=/');
expect(this.res.headers['set-cookie'])
.to.contain('hello-on-my.old.domain; domain=my.new.domain; path=/');
expect(this.res.headers['set-cookie'])
.to.contain('hello-on-my.special.domain; domain=my.special.domain; path=/');
});
it('rewrites raw headers with advanced configuration', function() {
var options = {
cookieDomainRewrite: {
'*': '',
'my.old.domain': 'my.new.domain',
'my.special.domain': 'my.special.domain'
}
};
this.rawProxyRes.headers['set-cookie'] = [
'hello-on-my.domain; domain=my.domain; path=/',
'hello-on-my.old.domain; domain=my.old.domain; path=/',
'hello-on-my.special.domain; domain=my.special.domain; path=/'
];
this.rawProxyRes.rawHeaders = this.rawProxyRes.rawHeaders.concat([
'Set-Cookie',
'hello-on-my.domain; domain=my.domain; path=/',
'Set-Cookie',
'hello-on-my.old.domain; domain=my.old.domain; path=/',
'Set-Cookie',
'hello-on-my.special.domain; domain=my.special.domain; path=/'
]);
httpProxy.writeHeaders({}, this.res, this.rawProxyRes, options);
expect(this.res.headers['set-cookie'])
.to.contain('hello-on-my.domain; path=/');
expect(this.res.headers['set-cookie'])
.to.contain('hello-on-my.old.domain; domain=my.new.domain; path=/');
expect(this.res.headers['set-cookie'])
.to.contain('hello-on-my.special.domain; domain=my.special.domain; path=/');
});
}); });
@ -421,3 +241,4 @@ describe('lib/http-proxy/passes/web-outgoing.js', function () {
}); });
}); });

View File

@ -1,10 +1,8 @@
var httpProxy = require('../lib/http-proxy'), var httpProxy = require('../lib/http-proxy'),
expect = require('expect.js'), expect = require('expect.js'),
http = require('http'), http = require('http'),
net = require('net'), ws = require('ws')
ws = require('ws'),
io = require('socket.io'), io = require('socket.io'),
SSE = require('sse'),
ioClient = require('socket.io-client'); ioClient = require('socket.io-client');
// //
@ -18,6 +16,7 @@ Object.defineProperty(gen, 'port', {
} }
}); });
describe('lib/http-proxy.js', function() { describe('lib/http-proxy.js', function() {
describe('#createProxyServer', function() { describe('#createProxyServer', function() {
it.skip('should throw without options', function() { it.skip('should throw without options', function() {
@ -63,41 +62,6 @@ describe('lib/http-proxy.js', function() {
}); });
describe('#createProxyServer using the web-incoming passes', function () { describe('#createProxyServer using the web-incoming passes', function () {
it('should proxy sse', function(done){
var ports = { source: gen.port, proxy: gen.port },
proxy = httpProxy.createProxyServer({
target: 'http://localhost:' + ports.source,
}),
proxyServer = proxy.listen(ports.proxy),
source = http.createServer(),
sse = new SSE(source, {path: '/'});
sse.on('connection', function(client) {
client.send('Hello over SSE');
client.close();
});
source.listen(ports.source);
var options = {
hostname: 'localhost',
port: ports.proxy,
};
var req = http.request(options, function(res) {
var streamData = '';
res.on('data', function (chunk) {
streamData += chunk.toString('utf8');
});
res.on('end', function (chunk) {
expect(streamData).to.equal(':ok\n\ndata: Hello over SSE\n\n');
source.close();
proxy.close();
done();
});
}).end();
});
it('should make the request on pipe and finish it', function(done) { it('should make the request on pipe and finish it', function(done) {
var ports = { source: gen.port, proxy: gen.port }; var ports = { source: gen.port, proxy: gen.port };
var proxy = httpProxy.createProxyServer({ var proxy = httpProxy.createProxyServer({
@ -130,8 +94,7 @@ describe('lib/http-proxy.js', function() {
it('should make the request, handle response and finish it', function(done) { it('should make the request, handle response and finish it', function(done) {
var ports = { source: gen.port, proxy: gen.port }; var ports = { source: gen.port, proxy: gen.port };
var proxy = httpProxy.createProxyServer({ var proxy = httpProxy.createProxyServer({
target: 'http://127.0.0.1:' + ports.source, target: 'http://127.0.0.1:' + ports.source
preserveHeaderKeyCase: true
}).listen(ports.proxy); }).listen(ports.proxy);
var source = http.createServer(function(req, res) { var source = http.createServer(function(req, res) {
@ -149,11 +112,6 @@ describe('lib/http-proxy.js', function() {
method: 'GET' method: 'GET'
}, function(res) { }, function(res) {
expect(res.statusCode).to.eql(200); expect(res.statusCode).to.eql(200);
expect(res.headers['content-type']).to.eql('text/plain');
if (res.rawHeaders != undefined) {
expect(res.rawHeaders.indexOf('Content-Type')).not.to.eql(-1);
expect(res.rawHeaders.indexOf('text/plain')).not.to.eql(-1);
}
res.on('data', function (data) { res.on('data', function (data) {
expect(data.toString()).to.eql('Hello from ' + ports.source); expect(data.toString()).to.eql('Hello from ' + ports.source);
@ -229,54 +187,11 @@ describe('lib/http-proxy.js', function() {
}); });
testReq.end(); testReq.end();
});
});
describe('#createProxyServer with xfwd option', function () {
it('should not throw on empty http host header', function (done) {
var ports = { source: gen.port, proxy: gen.port };
var proxy = httpProxy.createProxyServer({
forward: 'http://127.0.0.1:' + ports.source,
xfwd: true
}).listen(ports.proxy);
var source = http.createServer(function(req, res) {
expect(req.method).to.eql('GET');
expect(req.headers.host.split(':')[1]).to.eql(ports.source);
source.close();
proxy.close();
done();
});
source.listen(ports.source);
var socket = net.connect({port: ports.proxy}, function()
{
socket.write('GET / HTTP/1.0\r\n\r\n');
});
// handle errors
socket.on('error', function()
{
expect.fail('Unexpected socket error');
});
socket.on('data', function(data)
{
socket.end();
});
socket.on('end', function()
{
expect('Socket to finish').to.be.ok();
});
// http.request('http://127.0.0.1:' + ports.proxy, function() {}).end();
}) })
}); })
// describe('#createProxyServer using the web-incoming passes', function () { // describe('#createProxyServer using the web-incoming passes', function () {
// it('should emit events correctly', function(done) { // it('should emit events correclty', function(done) {
// var proxy = httpProxy.createProxyServer({ // var proxy = httpProxy.createProxyServer({
// target: 'http://127.0.0.1:8080' // target: 'http://127.0.0.1:8080'
// }), // }),
@ -415,11 +330,13 @@ describe('lib/http-proxy.js', function() {
client.on('error', function (err) { client.on('error', function (err) {
expect(err).to.be.an(Error); expect(err).to.be.an(Error);
expect(err.code).to.be('ECONNRESET');
proxyServer.close(); proxyServer.close();
done(); done();
}); });
}); });
it('should proxy a socket.io stream', function (done) { it('should proxy a socket.io stream', function (done) {
var ports = { source: gen.port, proxy: gen.port }, var ports = { source: gen.port, proxy: gen.port },
proxy = httpProxy.createProxyServer({ proxy = httpProxy.createProxyServer({
@ -467,7 +384,7 @@ describe('lib/http-proxy.js', function() {
var destiny = io.listen(server); var destiny = io.listen(server);
function startSocketIo() { function startSocketIo() {
var client = ioClient.connect('ws://127.0.0.1:' + ports.proxy, {rejectUnauthorized: null}); var client = ioClient.connect('ws://127.0.0.1:' + ports.proxy);
client.on('connect', function () { client.on('connect', function () {
client.disconnect(); client.disconnect();
}); });
@ -482,7 +399,6 @@ describe('lib/http-proxy.js', function() {
proxyServer.on('close', function() { proxyServer.on('close', function() {
proxyServer.close(); proxyServer.close();
server.close(); server.close();
destiny.close();
if (count == 1) { done(); } if (count == 1) { done(); }
}); });
@ -529,111 +445,5 @@ describe('lib/http-proxy.js', function() {
}); });
}); });
it('should detect a proxyReq event and modify headers', function (done) { })
var ports = { source: gen.port, proxy: gen.port },
proxy,
proxyServer,
destiny;
proxy = httpProxy.createProxyServer({
target: 'ws://127.0.0.1:' + ports.source,
ws: true
});
proxy.on('proxyReqWs', function(proxyReq, req, socket, options, head) {
proxyReq.setHeader('X-Special-Proxy-Header', 'foobar');
});
proxyServer = proxy.listen(ports.proxy);
destiny = new ws.Server({ port: ports.source }, function () {
var client = new ws('ws://127.0.0.1:' + ports.proxy);
client.on('open', function () {
client.send('hello there');
});
client.on('message', function (msg) {
expect(msg).to.be('Hello over websockets');
client.close();
proxyServer.close();
destiny.close();
done();
});
});
destiny.on('connection', function (socket, upgradeReq) {
expect(upgradeReq.headers['x-special-proxy-header']).to.eql('foobar');
socket.on('message', function (msg) {
expect(msg).to.be('hello there');
socket.send('Hello over websockets');
});
});
});
it('should forward frames with single frame payload (including on node 4.x)', function (done) {
var payload = Array(65529).join('0');
var ports = { source: gen.port, proxy: gen.port };
var proxy = httpProxy.createProxyServer({
target: 'ws://127.0.0.1:' + ports.source,
ws: true
}),
proxyServer = proxy.listen(ports.proxy),
destiny = new ws.Server({ port: ports.source }, function () {
var client = new ws('ws://127.0.0.1:' + ports.proxy);
client.on('open', function () {
client.send(payload);
});
client.on('message', function (msg) {
expect(msg).to.be('Hello over websockets');
client.close();
proxyServer.close();
destiny.close();
done();
});
});
destiny.on('connection', function (socket) {
socket.on('message', function (msg) {
expect(msg).to.be(payload);
socket.send('Hello over websockets');
});
});
});
it('should forward continuation frames with big payload (including on node 4.x)', function (done) {
var payload = Array(65530).join('0');
var ports = { source: gen.port, proxy: gen.port };
var proxy = httpProxy.createProxyServer({
target: 'ws://127.0.0.1:' + ports.source,
ws: true
}),
proxyServer = proxy.listen(ports.proxy),
destiny = new ws.Server({ port: ports.source }, function () {
var client = new ws('ws://127.0.0.1:' + ports.proxy);
client.on('open', function () {
client.send(payload);
});
client.on('message', function (msg) {
expect(msg).to.be('Hello over websockets');
client.close();
proxyServer.close();
destiny.close();
done();
});
});
destiny.on('connection', function (socket) {
socket.on('message', function (msg) {
expect(msg).to.be(payload);
socket.send('Hello over websockets');
});
});
});
});
}); });

View File

@ -168,7 +168,7 @@ describe('lib/http-proxy.js', function() {
proxy.on('error', function (err, req, res) { proxy.on('error', function (err, req, res) {
expect(err).to.be.an(Error); expect(err).to.be.an(Error);
if (semver.gt(process.versions.node, '0.12.0')) { if (semver.gt(process.versions.node, '0.12.0')) {
expect(err.toString()).to.be('Error: unable to verify the first certificate') expect(err.toString()).to.be('Error: self signed certificate')
} else { } else {
expect(err.toString()).to.be('Error: DEPTH_ZERO_SELF_SIGNED_CERT') expect(err.toString()).to.be('Error: DEPTH_ZERO_SELF_SIGNED_CERT')
} }