https-proxy-agent

What is https-proxy-agent?

The https-proxy-agent package is a Node.js module that provides an http.Agent implementation that connects to a specified HTTP or HTTPS proxy server, and can be used with the http or https modules to make requests. It is particularly useful for making requests from behind a corporate firewall or when you need to use a proxy for requests for any other reason.

What are https-proxy-agent's main functionalities?

Creating an HTTPS proxy agent

This code sample demonstrates how to create an HTTPS proxy agent using the https-proxy-agent package and use it to make an HTTPS request.

const HttpsProxyAgent = require('https-proxy-agent');
const https = require('https');

const proxy = 'http://proxy-server:port';
const agent = new HttpsProxyAgent(proxy);

https.get({
  hostname: 'encrypted.google.com',
  path: '/',
  agent: agent
}, (res) => {
  console.log(`Got response: ${res.statusCode}`);
  // consume response body
  res.resume();
}).on('error', (e) => {
  console.error(`Got error: ${e.message}`);
});

Other packages similar to https-proxy-agent

http-proxy-agent

This package provides an http.Agent implementation for HTTP, similar to https-proxy-agent but for non-encrypted HTTP connections. It is useful when you need to proxy HTTP requests specifically.

socks-proxy-agent

The socks-proxy-agent package is similar to https-proxy-agent but is designed to work with SOCKS proxy servers. It provides an http.Agent implementation that connects to a SOCKS proxy server, which can be used for both HTTP and HTTPS requests.

tunnel-agent

Tunnel-agent is another Node.js module that allows you to tunnel HTTP and HTTPS requests through HTTP proxies. It is similar to https-proxy-agent but offers more customization options for creating tunnels, such as allowing you to specify headers for CONNECT requests.

README

https-proxy-agent

An HTTP(s) proxy http.Agent implementation for HTTPS

This module provides an http.Agent implementation that connects to a specified HTTP or HTTPS proxy server, and can be used with the built-in https module.

Specifically, this Agent implementation connects to an intermediary "proxy" server and issues the CONNECT HTTP method, which tells the proxy to open a direct TCP connection to the destination server.

Since this agent implements the CONNECT HTTP method, it also works with other protocols that use this method when connecting over proxies (i.e. WebSockets). See the "Examples" section below for more.

Installation

Install with npm:

$ npm install https-proxy-agent

Examples

https module example

var url = require('url');
var https = require('https');
var HttpsProxyAgent = require('https-proxy-agent');

// HTTP/HTTPS proxy to connect to
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
console.log('using proxy server %j', proxy);

// HTTPS endpoint for the proxy to connect to
var endpoint = process.argv[2] || 'https://graph.facebook.com/tootallnate';
console.log('attempting to GET %j', endpoint);
var opts = url.parse(endpoint);

// create an instance of the `HttpsProxyAgent` class with the proxy server information
var agent = new HttpsProxyAgent(proxy);
opts.agent = agent;

https.get(opts, function (res) {
  console.log('"response" event!', res.headers);
  res.pipe(process.stdout);
});

ws WebSocket connection example

var url = require('url');
var WebSocket = require('ws');
var HttpsProxyAgent = require('https-proxy-agent');

// HTTP/HTTPS proxy to connect to
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
console.log('using proxy server %j', proxy);

// WebSocket endpoint for the proxy to connect to
var endpoint = process.argv[2] || 'ws://echo.websocket.org';
var parsed = url.parse(endpoint);
console.log('attempting to connect to WebSocket %j', endpoint);

// create an instance of the `HttpsProxyAgent` class with the proxy server information
var opts = url.parse(proxy);

// IMPORTANT! Set the `secureEndpoint` option to `false` when connecting
//            over "ws://", but `true` when connecting over "wss://"
opts.secureEndpoint = parsed.protocol ? parsed.protocol == 'wss:' : false;

var agent = new HttpsProxyAgent(opts);

// finally, initiate the WebSocket connection
var socket = new WebSocket(endpoint, { agent: agent });

socket.on('open', function () {
  console.log('"open" event!');
  socket.send('hello world');
});

socket.on('message', function (data, flags) {
  console.log('"message" event! %j %j', data, flags);
  socket.close();
});

API

new HttpsProxyAgent(opts)

The HttpsProxyAgent class implements an http.Agent subclass that connects to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket requests. This is achieved by using the HTTP CONNECT method.

The opts argument may either be a string URI of the proxy server to use, or an "options" object with more specific properties:

• host - String - Proxy host to connect to (may use hostname as well). Required.
• port - Number - Proxy port to connect to. Required.
• secureProxy - Boolean - If true, then use TLS to connect to the proxy. Defaults to false.
• secureEndpoint - Boolean - If true then then a TLS connection to the endpoint will be established on top of the proxy socket. Defaults to true.
• Any other options given are passed to the net.connect()/tls.connect() functions.

License

(The MIT License)

Copyright (c) 2013 Nathan Rajlich <[e-mail]>

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.