pac-proxy-agent

What is pac-proxy-agent?

The pac-proxy-agent npm package is a module for Node.js that allows HTTP/HTTPS requests to respect PAC (Proxy Auto-Configuration) files. PAC files are used to determine the appropriate proxy server when making network requests. This package is useful for applications that need to handle network requests in environments with complex proxy configurations.

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

HTTP/HTTPS request handling with PAC file

This code sample demonstrates how to use the pac-proxy-agent to make an HTTP request that respects a PAC file located at a specified URL. The agent is then used with the HTTP request options to ensure the request follows the proxy rules defined in the PAC file.

const PacProxyAgent = require('pac-proxy-agent');
const url = require('url');

const agent = new PacProxyAgent('http://example.com/proxy.pac');
const opts = url.parse('http://nodejs.org/api/');
opts.agent = agent;

require('http').get(opts, (res) => {
  console.log('Got response: ' + res.statusCode);
}).on('error', (e) => {
  console.error('Got error: ' + e.message);
});

Other packages similar to pac-proxy-agent

proxy-agent

The proxy-agent package is similar to pac-proxy-agent in that it provides a way to resolve proxy configurations for HTTP/HTTPS requests. However, proxy-agent supports multiple proxy protocols like HTTP, HTTPS, SOCKS, and PAC, making it more versatile for different proxy scenarios.

http-proxy-agent

The http-proxy-agent package is designed to provide an HTTP agent capable of connecting to an HTTP proxy. Unlike pac-proxy-agent, it does not handle PAC files but is specifically tailored for HTTP proxy connections.

https-proxy-agent

Similar to http-proxy-agent, the https-proxy-agent package is focused on providing an HTTPS agent for proxy connections. It is specifically for HTTPS requests and does not support PAC file resolution like pac-proxy-agent.

socks-proxy-agent

The socks-proxy-agent package is a SOCKS (Socket Secure) proxy `http.Agent` implementation for HTTP and HTTPS. This package is useful for routing traffic through SOCKS proxy servers, which is a different use case compared to the PAC file support provided by pac-proxy-agent.

README

pac-proxy-agent

A PAC file proxy http.Agent implementation for HTTP and HTTPS

This module provides an http.Agent implementation that retreives the specified PAC proxy file and uses it to resolve which HTTP, HTTPS, or SOCKS proxy, or if a direct connection should be used to connect to the HTTP endpoint.

It is designed to be be used with the built-in http and https modules.

Installation

Install with npm:

$ npm install pac-proxy-agent

Example

var url = require('url');
var http = require('http');
var PacProxyAgent = require('pac-proxy-agent');

// URI to a PAC proxy file to use (the "pac+" prefix is stripped)
var proxy = 'pac+https://cloudup.com/ceGH2yZ0Bjp+';
console.log('using PAC proxy proxy file at %j', proxy);

// HTTP endpoint for the proxy to connect to
var endpoint = 'http://nodejs.org/api/';
console.log('attempting to GET %j', endpoint);
var opts = url.parse(endpoint);

// create an instance of the `PacProxyAgent` class with the PAC file location
var agent = new PacProxyAgent(proxy);
opts.agent = agent;

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

License

(The MIT License)

Copyright (c) 2014 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.