How can I use an http proxy with node.js http.Client? – Stack …
I bought private proxy server, after purchase I got:
255. 255. 255 // IP address of proxy server
99999 // port of proxy server
username // authentication username of proxy server
password // authentication password of proxy server
And I wanted to use it. First answer and second answer worked only for (proxy) -> (destination), however I wanted (proxy) -> (destination).
And for destination it would be better to use HTTP tunnel directly.
I found solution here.
Node v8:
const = require(”)
const username = ‘username’
const password = ‘password’
const auth = ‘Basic ‘ + (username + ‘:’ + password). toString(‘base64’)
quest({
host: ‘255. 255’, // IP address of proxy server
port: 99999, // port of proxy server
method: ‘CONNECT’,
path: ”, // some destination, add 443 port for!
headers: {
‘Proxy-Authorization’: auth}, })(‘connect’, (res, socket) => {
if (atusCode === 200) { // connected to proxy server
({
host: ”,
socket: socket, // using a tunnel
agent: false, // cannot use a default agent
path: ‘/your/url’ // specify path to get from server}, (res) => {
let chunks = []
(‘data’, chunk => (chunk))
(‘end’, () => {
(‘DONE’, (chunks). toString(‘utf8’))})})}})(‘error’, (err) => {
(‘error’, err)})()
Node v14:
const = require(”);
const username = ‘username’;
const password = ‘password’;
const auth = ‘Basic ‘ + (username + ‘:’ + password). toString(‘base64’);
const agent = new ({ socket});
path: ‘/’,
agent, // cannot use a default agent}, (res) => {
(‘error’, err)})();
A full-featured http proxy for node.js – GitHub
node–proxy is an HTTP programmable proxying library that supports
websockets. It is suitable for implementing components such as reverse
proxies and load balancers.
Table of Contents
Installation
Upgrading from 0. 8. x?
Core Concept
Use Cases
Setup a basic stand-alone proxy server
Setup a stand-alone proxy server with custom server logic
Setup a stand-alone proxy server with proxy request header re-writing
Modify a response from a proxied server
Setup a stand-alone proxy server with latency
Using HTTPS
Proxying WebSockets
Options
Listening for proxy events
Shutdown
Miscellaneous
Test
ProxyTable API
Logo
Contributing and Issues
License
npm install -proxy –save
Back to top
Click here
A new proxy is created by calling createProxyServer and passing
an options object as argument (valid properties are available here)
var Proxy = require(‘-proxy’);
var proxy = eateProxyServer(options); // See (†)
†Unless listen(.. ) is invoked on the object, this does not create a webserver. See below.
An object will be returned with four methods:
web req, res, [options] (used for proxying regular HTTP(S) requests)
ws req, socket, head, [options] (used for proxying WS(S) requests)
listen port (a function that wraps the object in a webserver, for your convenience)
close [callback] (a function that closes the inner webserver and stops listening on given port)
It is then possible to proxy requests by calling these functions
eateServer(function(req, res) {
(req, res, { target: ”});});
Errors can be listened on either using the Event Emitter API
(‘error’, function(e) {… });
or using the callback API
(req, res, { target: ”}, function(e) {… });
When a request is proxied it follows two different pipelines (available here)
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 second pipeline (outgoing) is responsible for the creation and manipulation of the stream that, from your target, returns data
to the client.
var = require(”),
Proxy = require(‘-proxy’);
//
// Create your proxy server and set the target in the options.
eateProxyServer({target:’localhost:9000′})(8000); // See (†)
// Create your target server
eateServer(function (req, res) {
res. writeHead(200, { ‘Content-Type’: ‘text/plain’});
(‘request successfully proxied! ‘ + ‘\n’ + ringify(req. headers, true, 2));
();})(9000);
†Invoking listen(.. ) triggers the creation of a web server. Otherwise, just the proxy instance is created.
This example shows how you can proxy a request using your own HTTP server
and also you can put your own logic to handle the request.
// Create a proxy server with custom application logic
var proxy = eateProxyServer({});
// Create your custom server and just call `()` to proxy
// a web request to the target passed in the options
// also you can use `()` to proxy a websockets request
var server = eateServer(function(req, res) {
// You can define here your custom logic to handle the request
// and then proxy the request.
(“listening on port 5050″)
(5050);
This example shows how you can proxy a request using your own HTTP server that
modifies the outgoing proxy request by adding a special header.
// To modify the proxy connection before data is sent, you can listen
// for the ‘proxyReq’ event. When the event is fired, you will receive
// the following arguments:
// (ientRequest proxyReq, comingMessage req,
// rverResponse res, Object options). This mechanism is useful when
// you need to modify the proxy request before the proxy connection
// is made to the target.
(‘proxyReq’, function(proxyReq, req, res, options) {
tHeader(‘X-Special-Proxy-Header’, ‘foobar’);});
(req, res, {
target: ”});});
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 allows you to do this in a streaming style so as to keep the pressure on the proxy to a minimum.
// Create a proxy server with latency
var proxy = eateProxyServer();
// Create your server that makes an operation that waits a while
// and then proxies the request
// This simulates an operation that takes 500ms to execute
setTimeout(function () {
target: ‘localhost:9008’});}, 500);})(8008);
(‘request successfully proxied to: ‘ + + ‘\n’ + ringify(req. headers, true, 2));
();})(9008);
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
// Create the HTTPS proxy server in front of a HTTP server
eateServer({
target: {
host: ‘localhost’,
port: 9009},
ssl: {
key: adFileSync(”, ‘utf8’),
cert: adFileSync(”, ‘utf8’)}})(8009);
HTTPS -> HTTPS
// Create the proxy server listening on port 443
cert: adFileSync(”, ‘utf8’)},
target: ‘localhost:9010’,
secure: true // Depends on your needs, could be false. })(443);
HTTP -> HTTPS (using a PKCS12 client certificate)
// Create an HTTP proxy server with an HTTPS target
eateProxyServer({
protocol: ‘:’,
host: ‘my-domain-name’,
port: 443,
pfx: adFileSync(‘path/to/certificate. p12’),
passphrase: ‘password’, },
changeOrigin: true, })(8000);
You can activate the websocket support for the proxy using ws:true in the options.
// Create a proxy server for websockets
target: ‘wslocalhost:9014’,
ws: true})(8014);
Also you can proxy the websocket requests just calling the ws(req, socket, head) method.
// Setup our server to proxy standard HTTP requests
var proxy = new eateProxyServer({
port: 9015}});
var proxyServer = eateServer(function (req, res) {
(req, res);});
// Listen to the `upgrade` event and proxy the
// WebSocket requests as well.
(‘upgrade’, function (req, socket, head) {
(req, socket, head);});
(8015);
eateProxyServer 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 (s). request (see Node’s agent and agent objects)
ssl: object to be passed to eateServer()
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 ” or ”. Default: null.
cookieDomainRewrite: rewrites domain of set-cookie headers. Possible values:
false (default): disable cookie rewriting
String: new domain, for example cookieDomainRewrite: “”. 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: {
“”: “”,
“*”: “”}
cookiePathRewrite: rewrites path of set-cookie headers. Possible values:
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: {
“/”: “/”,
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(‘-proxy’);
const proxy = new HttpProxy();
module. exports = (req, res, next) => {
target: ‘localhost:4003/’,
buffer: streamify(req. rawBody)}, next);};
NOTE:
and are optional.
and rward cannot both be missing
If you are using the method, the following options are also applicable:
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. Applies to “websocket” connections
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.
close: This event is emitted once the proxy websocket was closed.
(DEPRECATED) proxySocket: Deprecated in favor of open.
// Error example
// Http Proxy Server with bad target
var proxy = eateServer({
target:’localhost:9005′});
(8005);
// Listen for the `error` event on `proxy`.
(‘error’, function (err, req, res) {
res. writeHead(500, {
‘Content-Type’: ‘text/plain’});
(‘Something went wrong. And we are reporting a custom error message. ‘);});
// Listen for the `proxyRes` event on `proxy`.
(‘proxyRes’, function (proxyRes, req, res) {
(‘RAW Response from the target’, ringify(proxyRes. headers, true, 2));});
// Listen for the `open` event on `proxy`.
(‘open’, function (proxySocket) {
// listen for messages coming FROM the target here
(‘data’, hybiParseAndLogMessage);});
// Listen for the `close` event on `proxy`.
(‘close’, function (res, socket, head) {
// view disconnected websocket connections
(‘Client disconnected’);});
When testing or running server within another program it may be necessary to close the proxy.
This will stop the proxy from accepting new connections.
port: 1337}});
();
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
var option = {
target: target,
selfHandleResponse: true};
var body = [];
(‘data’, function (chunk) {
(chunk);});
(‘end’, function () {
body = (body). toString();
(“res from proxied server:”, body);
(“my response to cli”);});});
(req, res, option);
A proxy table API is available through this add-on module, which lets you define a set of rules to translate matching routes to target routes that the reverse proxy will talk to.
Logo created by Diego Pasquali
Read carefully our Code Of Conduct
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)
The MIT License (MIT)
Copyright (c) 2010 – 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.
Node.js – Simple Proxy to Pass Through HTTP Requests to an …
This is a quick example of how to proxy an HTTP request through a server to an external URL and return the response.
The below example is a super simple HTTP server that returns a random image that’s been proxied from the Lorem Picsum sample image website (). The server is built with the library, and uses the request library from npm to send the external HTTP request that is proxied.
code to proxy a request
Before jumping into the example, this is the line of code to proxy a request in
(request(‘[URL_TO_PROXY]’))(res);
HTTP Proxy Server Demo
An random image proxied from Lorem Picsum through
(See on CodeSandbox at)
Node Proxy Server Code
As you can see there’s not much to the example server code, it contains the minimal required to demonstrate rendering a proxied image in the browser.
The default route (e. g. for the root / path) returns an with the source attribute pointing to the relative /random-image/${()} URL, the random number is to ensure a new image is displayed on each page refresh.
The /random-image/* route is where the proxying happens, the HTTP request received by the server (req) is piped into a new request to the picsum image URL () sent with the request library, which is then piped back into the original response (res).
const = require(”);
const request = require(‘request’);
eateServer(function (req, res) {
if ((‘/random-image’)) {
// proxy random image from picsum website
const imageUrl = ”;
(request(imageUrl))(res);} else {
// default page with image tag that renders random image
tHeader(‘Content-type’, ‘text/html’);
(``);
();}})(8080);
Subscribe or Follow Me For Updates
Subscribe to my YouTube channel or follow me on Twitter, Facebook or GitHub to be notified when I post new content.
Subscribe on YouTube at Follow me on Twitter at Follow me on Facebook at Follow me on GitHub at
Feed formats available:
RSS,
Atom,
JSON
Other than coding…
I’m currently attempting to travel around Australia by motorcycle with my wife Tina on a pair of Royal Enfield Himalayans. You can follow our adventures on YouTube, Instagram and Facebook.
Subscribe on YouTube at Follow us on Instagram at Follow us on Facebook at
Need Some NodeJS Help?
Search fiverr to find help quickly from experienced NodeJS developers.
Frequently Asked Questions about node http request proxy
What is node http proxy?
node-http-proxy. node-http-proxy is an HTTP programmable proxying library that supports websockets. It is suitable for implementing components such as reverse proxies and load balancers.
How can I use an HTTP proxy with node js HTTP client?
var http = require(“http”); var options = { host: “proxy”, port: 8080, path: “http://www.google.com”, headers: { Host: “www.google.com” } }; http. get(options, function(res) { console. log(res); res. pipe(process.Jan 22, 2014
How do I install HTTP proxy?
Apache HTTP Proxy installation – LinuxInstall Apache HTTP Server (at least version 2.4. … Verify that the following modules are loaded: … Add the caching configuration: … If the directory /var/cache/apache2/mod_cache_disk does not exist, create it and assign Apache privileges (r,w,x).Add Proxy configuration:More items…