prox-chain 2.5.4

package/README.md

@@ -0,0 +1,476 @@
+# Programmable HTTP proxy server for Node.js
+
+[![npm version](https://badge.fury.io/js/proxy-chain.svg)](http://badge.fury.io/js/proxy-chain)
+
+A programmable proxy server (think Squid) with support for SSL/TLS, authentication, upstream proxy chaining, SOCKS4/5 protocol,
+custom HTTP responses, and traffic statistics.
+The authentication and proxy chaining configuration is defined in code and can be fully dynamic, giving you a high level of customization for your use case.
+
+For example, the proxy-chain package is useful if you need to use headless Chrome web browser and proxies with authentication,
+because Chrome doesn't support proxy URLs with password, such as `http://username:password@proxy.example.com:8080`.
+With this package, you can set up a local proxy server without any password
+that will forward requests to the upstream proxy with password.
+For details, read [How to make headless Chrome and Puppeteer use a proxy server with authentication](https://blog.apify.com/how-to-make-headless-chrome-and-puppeteer-use-a-proxy-server-with-authentication-249a21a79212/).
+
+The proxy-chain package is developed by [Apify](https://apify.com/), the full-stack web scraping and data extraction platform, to support their [Apify Proxy](https://apify.com/proxy) product,
+which provides an easy access to a large pool of datacenter and residential IP addresses all around the world. The proxy-chain package is also used by [Crawlee](https://crawlee.dev/),
+the world's most popular web craling library for Node.js.
+
+The proxy-chain package currently supports HTTP/SOCKS forwarding and HTTP CONNECT tunneling to forward arbitrary protocols such as HTTPS or FTP ([learn more](https://blog.apify.com/tunneling-arbitrary-protocols-over-http-proxy-with-static-ip-address-b3a2222191ff)). The HTTP CONNECT tunneling also supports the SOCKS protocol. Also, proxy-chain only supports the Basic [Proxy-Authorization](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Proxy-Authorization).
+
+## Run a simple HTTP/HTTPS proxy server
+
+```javascript
+const ProxyChain = require('proxy-chain');
+
+const server = new ProxyChain.Server({ port: 8000 });
+
+server.listen(() => {
+    console.log(`Proxy server is listening on port ${8000}`);
+});
+```
+
+## Run a HTTP/HTTPS proxy server with credentials and upstream proxy
+
+```javascript
+const ProxyChain = require('proxy-chain');
+
+const server = new ProxyChain.Server({
+    // Port where the server will listen. By default 8000.
+    port: 8000,
+
+    // Optional host where the proxy server will listen.
+    // If not specified, the sever listens on an unspecified IP address (0.0.0.0 in IPv4, :: in IPv6)
+    // You can use this option to limit the access to the proxy server.
+    host: 'localhost',
+
+    // Enables verbose logging
+    verbose: true,
+
+    // Custom user-defined function to authenticate incoming proxy requests,
+    // and optionally provide the URL to chained upstream proxy.
+    // The function must return an object (or promise resolving to the object) with the following signature:
+    // { requestAuthentication: boolean, upstreamProxyUrl: string, failMsg?: string, customTag?: unknown }
+    // If the function is not defined or is null, the server runs in simple mode.
+    // Note that the function takes a single argument with the following properties:
+    // * request      - An instance of http.IncomingMessage class with information about the client request
+    //                  (which is either HTTP CONNECT for SSL protocol, or other HTTP request)
+    // * username     - Username parsed from the Proxy-Authorization header. Might be empty string.
+    // * password     - Password parsed from the Proxy-Authorization header. Might be empty string.
+    // * hostname     - Hostname of the target server
+    // * port         - Port of the target server
+    // * isHttp       - If true, this is a HTTP request, otherwise it's a HTTP CONNECT tunnel for SSL
+    //                  or other protocols
+    // * connectionId - Unique ID of the HTTP connection. It can be used to obtain traffic statistics.
+    prepareRequestFunction: ({ request, username, password, hostname, port, isHttp, connectionId }) => {
+        return {
+            // If set to true, the client is sent HTTP 407 resposne with the Proxy-Authenticate header set,
+            // requiring Basic authentication. Here you can verify user credentials.
+            requestAuthentication: username !== 'bob' || password !== 'TopSecret',
+
+            // Sets up an upstream HTTP/SOCKS proxy to which all the requests are forwarded.
+            // If null, the proxy works in direct mode, i.e. the connection is forwarded directly
+            // to the target server. This field is ignored if "requestAuthentication" is true.
+            // The username and password must be URI-encoded.
+            upstreamProxyUrl: `http://username:password@proxy.example.com:3128`,
+            // Or use SOCKS4/5 proxy, e.g.
+            // upstreamProxyUrl: `socks://username:password@proxy.example.com:1080`,
+
+            // If "requestAuthentication" is true, you can use the following property
+            // to define a custom error message to return to the client instead of the default "Proxy credentials required"
+            failMsg: 'Bad username or password, please try again.',
+
+            // Optional custom tag that will be passed back via
+            // `tunnelConnectResponded` or `tunnelConnectFailed` events
+            // Can be used to pass information between proxy-chain
+            // and any external code or application using it
+            customTag: { userId: '123' },
+        };
+    },
+});
+
+server.listen(() => {
+  console.log(`Proxy server is listening on port ${server.port}`);
+});
+
+// Emitted when HTTP connection is closed
+server.on('connectionClosed', ({ connectionId, stats }) => {
+  console.log(`Connection ${connectionId} closed`);
+  console.dir(stats);
+});
+
+// Emitted when HTTP request fails
+server.on('requestFailed', ({ request, error }) => {
+  console.log(`Request ${request.url} failed`);
+  console.error(error);
+});
+```
+
+## SOCKS support
+SOCKS protocol is supported for versions 4 and 5, specifically: `['socks', 'socks4', 'socks4a', 'socks5', 'socks5h']`, where `socks` will default to version 5.
+
+You can use an `upstreamProxyUrl` like `socks://username:password@proxy.example.com:1080`.
+
+## Error status codes
+
+The `502 Bad Gateway` HTTP status code is not comprehensive enough. Therefore, the server may respond with `590-599` instead:
+
+### `590 Non Successful`
+
+Upstream responded with non-200 status code.
+
+### `591 RESERVED`
+
+*This status code is reserved for further use.*
+
+### `592 Status Code Out Of Range`
+
+Upstream respondend with status code different than 100-999.
+
+### `593 Not Found`
+
+DNS lookup failed - [`EAI_NODATA`](https://github.com/libuv/libuv/blob/cdbba74d7a756587a696fb3545051f9a525b85ac/include/uv.h#L82) or [`EAI_NONAME`](https://github.com/libuv/libuv/blob/cdbba74d7a756587a696fb3545051f9a525b85ac/include/uv.h#L83).
+
+### `594 Connection Refused`
+
+Upstream refused connection.
+
+### `595 Connection Reset`
+
+Connection reset due to loss of connection or timeout.
+
+### `596 Broken Pipe`
+
+Trying to write on a closed socket.
+
+### `597 Auth Failed`
+
+Incorrect upstream credentials.
+
+### `598 RESERVED`
+
+*This status code is reserved for further use.*
+
+### `599 Upstream Error`
+
+Generic upstream error.
+
+---
+
+`590` and `592` indicate an issue on the upstream side. \
+`593` indicates an incorrect `proxy-chain` configuration.\
+`594`, `595` and `596` may occur due to connection loss.\
+`597` indicates incorrect upstream credentials.\
+`599` is a generic error, where the above is not applicable.
+
+## Custom error responses
+
+To return a custom HTTP response to indicate an error to the client,
+you can throw the `RequestError` from inside of the `prepareRequestFunction` function.
+The class constructor has the following parameters: `RequestError(body, statusCode, headers)`.
+By default, the response will have `Content-Type: text/plain; charset=utf-8`.
+
+```javascript
+const ProxyChain = require('proxy-chain');
+
+const server = new ProxyChain.Server({
+    prepareRequestFunction: ({ request, username, password, hostname, port, isHttp, connectionId }) => {
+        if (username !== 'bob') {
+           throw new ProxyChain.RequestError('Only Bob can use this proxy!', 400);
+        }
+    },
+});
+```
+
+## Measuring traffic statistics
+
+To get traffic statistics for a certain HTTP connection, you can use:
+```javascript
+const stats = server.getConnectionStats(connectionId);
+console.dir(stats);
+```
+
+The resulting object looks like:
+```javascript
+{
+    // Number of bytes sent to client
+    srcTxBytes: Number,
+    // Number of bytes received from client
+    srcRxBytes: Number,
+    // Number of bytes sent to target server (proxy or website)
+    trgTxBytes: Number,
+    // Number of bytes received from target server (proxy or website)
+    trgRxBytes: Number,
+}
+```
+
+If the underlying sockets were closed, the corresponding values will be `null`,
+rather than `0`.
+
+## Custom responses
+
+Custom responses allow you to override the response to a HTTP requests to the proxy, without contacting any target host.
+For example, this is useful if you want to provide a HTTP proxy-style interface
+to an external API or respond with some custom page to certain requests.
+Note that this feature is only available for HTTP connections. That's because HTTPS
+connections cannot be intercepted without access to the target host's private key.
+
+To provide a custom response, the result of the `prepareRequestFunction` function must
+define the `customResponseFunction` property, which contains a function that generates the custom response.
+The function is passed no parameters and it must return an object (or a promise resolving to an object)
+with the following properties:
+
+```javascript
+{
+  // Optional HTTP status code of the response. By default it is 200.
+  statusCode: 200,
+
+  // Optional HTTP headers of the response
+  headers: {
+    'X-My-Header': 'bla bla',
+  }
+
+  // Optional string with the body of the HTTP response
+  body: 'My custom response',
+
+  // Optional encoding of the body. If not provided, defaults to 'UTF-8'
+  encoding: 'UTF-8',
+}
+```
+
+Here is a simple example:
+
+```javascript
+const ProxyChain = require('proxy-chain');
+
+const server = new ProxyChain.Server({
+    port: 8000,
+    prepareRequestFunction: ({ request, username, password, hostname, port, isHttp }) => {
+        return {
+            customResponseFunction: () => {
+                return {
+                    statusCode: 200,
+                    body: `My custom response to ${request.url}`,
+                };
+            },
+        };
+    },
+});
+
+server.listen(() => {
+  console.log(`Proxy server is listening on port ${server.port}`);
+});
+```
+
+## Routing CONNECT to another HTTP server
+
+While `customResponseFunction` enables custom handling methods such as `GET` and `POST`, many HTTP clients rely on `CONNECT` tunnels.
+It's possible to route those requests differently using the `customConnectServer` option. It accepts an instance of Node.js HTTP server.
+
+```javascript
+const http = require('http');
+const ProxyChain = require('proxy-chain');
+
+const exampleServer = http.createServer((request, response) => {
+    response.end('Hello from a custom server!');
+});
+
+const server = new ProxyChain.Server({
+    port: 8000,
+    prepareRequestFunction: ({ request, username, password, hostname, port, isHttp }) => {
+        if (request.url.toLowerCase() === 'example.com:80') {
+            return {
+                customConnectServer: exampleServer,
+            };
+        }
+
+        return {};
+    },
+});
+
+server.listen(() => {
+  console.log(`Proxy server is listening on port ${server.port}`);
+});
+```
+
+In the example above, all CONNECT tunnels to `example.com` are overridden.
+This is an unsecure server, so it accepts only `http:` requests.
+
+In order to intercept `https:` requests, `https.createServer` should be used instead, along with a self signed certificate.
+
+```javascript
+const https = require('https');
+const fs = require('fs');
+const key = fs.readFileSync('./test/ssl.key');
+const cert = fs.readFileSync('./test/ssl.crt');
+
+const exampleServer = https.createServer({
+    key,
+    cert,
+}, (request, response) => {
+    response.end('Hello from a custom server!');
+});
+```
+
+## Closing the server
+
+To shut down the proxy server, call the `close([destroyConnections], [callback])` function. For example:
+
+```javascript
+server.close(true, () => {
+  console.log('Proxy server was closed.');
+});
+```
+
+The `closeConnections` parameter indicates whether pending proxy connections should be forcibly closed.
+If it's `false`, the function will wait until all connections are closed, which can take a long time.
+If the `callback` parameter is omitted, the function returns a promise.
+
+
+## Accessing the CONNECT response headers for proxy tunneling
+
+Some upstream proxy providers might include valuable debugging information in the CONNECT response
+headers when establishing the proxy tunnel, for they may not modify future data in the tunneled
+connection.
+
+The proxy server would emit a `tunnelConnectResponded` event for exposing such information, where
+the parameter types of the event callback are described in [Node.js's documentation][1]. Example:
+
+[1]: https://nodejs.org/api/http.html#http_event_connect
+
+```javascript
+server.on('tunnelConnectResponded', ({ proxyChainId, response, socket, head, customTag }) => {
+    console.log(`CONNECT response headers received: ${response.headers}`);
+});
+```
+
+Alternatively a [helper function](##helper-functions) may be used:
+
+```javascript
+listenConnectAnonymizedProxy(anonymizedProxyUrl, ({ response, socket, head }) => {
+    console.log(`CONNECT response headers received: ${response.headers}`);
+});
+```
+
+You can also listen to CONNECT requests that receive response with status code different from 200.
+The proxy server would emit a `tunnelConnectFailed` event.
+
+```javascript
+server.on('tunnelConnectFailed', ({ proxyChainId, response, socket, head, customTag }) => {
+    console.log(`CONNECT response failed with status code: ${response.statusCode}`);
+});
+```
+
+## Helper functions
+
+The package also provides several utility functions.
+
+
+### `anonymizeProxy({ url, port }, callback)`
+
+Parses and validates a HTTP proxy URL. If the proxy requires authentication,
+then the function starts an open local proxy server that forwards to the proxy.
+The port (on which the local proxy server will start) can be set via the `port` property of the first argument, if not provided, it will be chosen randomly.
+
+The function takes an optional callback that receives the anonymous proxy URL.
+If no callback is supplied, the function returns a promise that resolves to a String with
+anonymous proxy URL or the original URL if it was already anonymous.
+
+The following example shows how you can use a proxy with authentication
+from headless Chrome and [Puppeteer](https://github.com/GoogleChrome/puppeteer).
+For details, read this [blog post](https://blog.apify.com/how-to-make-headless-chrome-and-puppeteer-use-a-proxy-server-with-authentication-249a21a79212).
+
+```javascript
+const puppeteer = require('puppeteer');
+const proxyChain = require('proxy-chain');
+
+(async() => {
+    const oldProxyUrl = 'http://bob:password123@proxy.example.com:8000';
+    const newProxyUrl = await proxyChain.anonymizeProxy(oldProxyUrl);
+
+    // Prints something like "http://127.0.0.1:45678"
+    console.log(newProxyUrl);
+
+    const browser = await puppeteer.launch({
+        args: [`--proxy-server=${newProxyUrl}`],
+    });
+
+    // Do your magic here...
+    const page = await browser.newPage();
+    await page.goto('https://www.example.com');
+    await page.screenshot({ path: 'example.png' });
+    await browser.close();
+
+    // Clean up
+    await proxyChain.closeAnonymizedProxy(newProxyUrl, true);
+})();
+```
+
+### `closeAnonymizedProxy(anonymizedProxyUrl, closeConnections, callback)`
+
+Closes anonymous proxy previously started by `anonymizeProxy()`.
+If proxy was not found or was already closed, the function has no effect
+and its result is `false`. Otherwise the result is `true`.
+
+The `closeConnections` parameter indicates whether pending proxy connections are forcibly closed.
+If it's `false`, the function will wait until all connections are closed, which can take a long time.
+
+The function takes an optional callback that receives the result Boolean from the function.
+If callback is not provided, the function returns a promise instead.
+
+### `createTunnel(proxyUrl, targetHost, options, callback)`
+
+Creates a TCP tunnel to `targetHost` that goes through a HTTP proxy server
+specified by the `proxyUrl` parameter.
+
+The optional `options` parameter is an object with the following properties:
+- `port: Number` - Enables specifying the local port to listen at. By default `0`,
+   which means a random port will be selected.
+- `hostname: String` - Local hostname to listen at. By default `localhost`.
+- `verbose: Boolean` - If `true`, the functions logs a lot. By default `false`.
+
+The result of the function is a local endpoint in a form of `hostname:port`.
+All TCP connections made to the local endpoint will be tunneled through the proxy to the target host and port.
+For example, this is useful if you want to access a certain service from a specific IP address.
+
+The tunnel should be eventually closed by calling the `closeTunnel()` function.
+
+The `createTunnel()` function accepts an optional Node.js-style callback that receives the path to the local endpoint.
+If no callback is supplied, the function returns a promise that resolves to a String with
+the path to the local endpoint.
+
+For more information, read this [blog post](https://blog.apify.com/tunneling-arbitrary-protocols-over-http-proxy-with-static-ip-address-b3a2222191ff).
+
+Example:
+
+```javascript
+const host = await createTunnel('http://bob:pass123@proxy.example.com:8000', 'service.example.com:356');
+// Prints something like "localhost:56836"
+console.log(host);
+```
+
+### `closeTunnel(tunnelString, closeConnections, callback)`
+
+Closes tunnel previously started by `createTunnel()`.
+The result value is `false` if the tunnel was not found or was already closed, otherwise it is `true`.
+
+The `closeConnections` parameter indicates whether pending connections are forcibly closed.
+If it's `false`, the function will wait until all connections are closed, which can take a long time.
+
+The function takes an optional callback that receives the result of the function.
+If the callback is not provided, the function returns a promise instead.
+
+### `listenConnectAnonymizedProxy(anonymizedProxyUrl, tunnelConnectRespondedCallback)`
+
+Allows to configure a callback on the anonymized proxy URL for the CONNECT response headers. See the
+above section [Accessing the CONNECT response headers for proxy tunneling](#accessing-the-connect-response-headers-for-proxy-tunneling)
+for details.
+
+### `redactUrl(url, passwordReplacement)`
+
+Takes a URL and hides the password from it. For example:
+
+```javascript
+// Prints 'http://bob:<redacted>@example.com'
+console.log(redactUrl('http://bob:pass123@example.com'));
+```

package/dist/anonymize_proxy.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import net from 'net';
+import http from 'http';
+import { Buffer } from 'buffer';
+export interface AnonymizeProxyOptions {
+    url: string;
+    port: number;
+}
+/**
+ * Parses and validates a HTTP proxy URL. If the proxy requires authentication, then the function
+ * starts an open local proxy server that forwards to the upstream proxy.
+ */
+export declare const anonymizeProxy: (options: string | AnonymizeProxyOptions, callback?: ((error: Error | null) => void) | undefined) => Promise<string>;
+/**
+ * Closes anonymous proxy previously started by `anonymizeProxy()`.
+ * If proxy was not found or was already closed, the function has no effect
+ * and its result if `false`. Otherwise the result is `true`.
+ * @param closeConnections If true, pending proxy connections are forcibly closed.
+ */
+export declare const closeAnonymizedProxy: (anonymizedProxyUrl: string, closeConnections: boolean, callback?: ((error: Error | null, result?: boolean) => void) | undefined) => Promise<boolean>;
+type Callback = ({ response, socket, head, }: {
+    response: http.IncomingMessage;
+    socket: net.Socket;
+    head: Buffer;
+}) => void;
+/**
+ * Add a callback on 'tunnelConnectResponded' Event in order to get headers from CONNECT tunnel to proxy
+ * Useful for some proxies that are using headers to send information like ProxyMesh
+ * @returns `true` if the callback is successfully configured, otherwise `false` (e.g. when an
+ * invalid proxy URL is given).
+ */
+export declare const listenConnectAnonymizedProxy: (anonymizedProxyUrl: string, tunnelConnectRespondedCallback: Callback) => boolean;
+export {};
+//# sourceMappingURL=anonymize_proxy.d.ts.map

package/dist/anonymize_proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"anonymize_proxy.d.ts","sourceRoot":"","sources":["../src/anonymize_proxy.ts"],"names":[],"mappings":";;;;AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAQhC,MAAM,WAAW,qBAAqB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,YACd,MAAM,GAAG,qBAAqB,sBACpB,KAAK,GAAG,IAAI,KAAK,IAAI,kBACzC,QAAQ,MAAM,CAuDhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,uBACT,MAAM,oBACR,OAAO,sBACN,KAAK,GAAG,IAAI,WAAW,OAAO,KAAK,IAAI,kBAC3D,QAAQ,OAAO,CAgBjB,CAAC;AAEF,KAAK,QAAQ,GAAG,CAAC,EACb,QAAQ,EACR,MAAM,EACN,IAAI,GACP,EAAE;IACC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC;IAC/B,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CAChB,KAAK,IAAI,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,uBACjB,MAAM,kCACM,QAAQ,KACzC,OASF,CAAC"}

package/dist/anonymize_proxy.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listenConnectAnonymizedProxy = exports.closeAnonymizedProxy = exports.anonymizeProxy = void 0;
+const url_1 = require("url");
+const server_1 = require("./server");
+const nodeify_1 = require("./utils/nodeify");
+// Dictionary, key is value returned from anonymizeProxy(), value is Server instance.
+const anonymizedProxyUrlToServer = {};
+/**
+ * Parses and validates a HTTP proxy URL. If the proxy requires authentication, then the function
+ * starts an open local proxy server that forwards to the upstream proxy.
+ */
+const anonymizeProxy = (options, callback) => {
+    let proxyUrl;
+    let port = 0;
+    if (typeof options === 'string') {
+        proxyUrl = options;
+    }
+    else {
+        proxyUrl = options.url;
+        port = options.port;
+        if (port < 0 || port > 65535) {
+            throw new Error('Invalid "port" option: only values equals or between 0-65535 are valid');
+        }
+    }
+    const parsedProxyUrl = new url_1.URL(proxyUrl);
+    if (!['http:', ...server_1.SOCKS_PROTOCOLS].includes(parsedProxyUrl.protocol)) {
+        // eslint-disable-next-line max-len
+        throw new Error(`Invalid "proxyUrl" provided: URL must have one of the following protocols: "http", ${server_1.SOCKS_PROTOCOLS.map((p) => `"${p.replace(':', '')}"`).join(', ')} (was "${parsedProxyUrl}")`);
+    }
+    // If upstream proxy requires no password, return it directly
+    if (!parsedProxyUrl.username && !parsedProxyUrl.password) {
+        return (0, nodeify_1.nodeify)(Promise.resolve(proxyUrl), callback);
+    }
+    let server;
+    const startServer = () => {
+        return Promise.resolve().then(() => {
+            server = new server_1.Server({
+                // verbose: true,
+                port,
+                host: '127.0.0.1',
+                prepareRequestFunction: () => {
+                    return {
+                        requestAuthentication: false,
+                        upstreamProxyUrl: proxyUrl,
+                    };
+                },
+            });
+            return server.listen();
+        });
+    };
+    const promise = startServer().then(() => {
+        const url = `http://127.0.0.1:${server.port}`;
+        anonymizedProxyUrlToServer[url] = server;
+        return url;
+    });
+    return (0, nodeify_1.nodeify)(promise, callback);
+};
+exports.anonymizeProxy = anonymizeProxy;
+/**
+ * Closes anonymous proxy previously started by `anonymizeProxy()`.
+ * If proxy was not found or was already closed, the function has no effect
+ * and its result if `false`. Otherwise the result is `true`.
+ * @param closeConnections If true, pending proxy connections are forcibly closed.
+ */
+const closeAnonymizedProxy = (anonymizedProxyUrl, closeConnections, callback) => {
+    if (typeof anonymizedProxyUrl !== 'string') {
+        throw new Error('The "anonymizedProxyUrl" parameter must be a string');
+    }
+    const server = anonymizedProxyUrlToServer[anonymizedProxyUrl];
+    if (!server) {
+        return (0, nodeify_1.nodeify)(Promise.resolve(false), callback);
+    }
+    delete anonymizedProxyUrlToServer[anonymizedProxyUrl];
+    const promise = server.close(closeConnections).then(() => {
+        return true;
+    });
+    return (0, nodeify_1.nodeify)(promise, callback);
+};
+exports.closeAnonymizedProxy = closeAnonymizedProxy;
+/**
+ * Add a callback on 'tunnelConnectResponded' Event in order to get headers from CONNECT tunnel to proxy
+ * Useful for some proxies that are using headers to send information like ProxyMesh
+ * @returns `true` if the callback is successfully configured, otherwise `false` (e.g. when an
+ * invalid proxy URL is given).
+ */
+const listenConnectAnonymizedProxy = (anonymizedProxyUrl, tunnelConnectRespondedCallback) => {
+    const server = anonymizedProxyUrlToServer[anonymizedProxyUrl];
+    if (!server) {
+        return false;
+    }
+    server.on('tunnelConnectResponded', ({ response, socket, head }) => {
+        tunnelConnectRespondedCallback({ response, socket, head });
+    });
+    return true;
+};
+exports.listenConnectAnonymizedProxy = listenConnectAnonymizedProxy;
+//# sourceMappingURL=anonymize_proxy.js.map

package/dist/anonymize_proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"anonymize_proxy.js","sourceRoot":"","sources":["../src/anonymize_proxy.ts"],"names":[],"mappings":";;;AAGA,6BAA0B;AAC1B,qCAAmD;AACnD,6CAA0C;AAE1C,qFAAqF;AACrF,MAAM,0BAA0B,GAA2B,EAAE,CAAC;AAO9D;;;GAGG;AACI,MAAM,cAAc,GAAG,CAC1B,OAAuC,EACvC,QAAwC,EACzB,EAAE;IACjB,IAAI,QAAgB,CAAC;IACrB,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC7B,QAAQ,GAAG,OAAO,CAAC;KACtB;SAAM;QACH,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAEpB,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,KAAK,EAAE;YAC1B,MAAM,IAAI,KAAK,CACX,wEAAwE,CAC3E,CAAC;SACL;KACJ;IAED,MAAM,cAAc,GAAG,IAAI,SAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,wBAAe,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QAClE,mCAAmC;QACnC,MAAM,IAAI,KAAK,CAAC,sFAAsF,wBAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,cAAc,IAAI,CAAC,CAAC;KACvM;IAED,6DAA6D;IAC7D,IAAI,CAAC,cAAc,CAAC,QAAQ,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE;QACtD,OAAO,IAAA,iBAAO,EAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;KACvD;IAED,IAAI,MAAiC,CAAC;IAEtC,MAAM,WAAW,GAAG,GAAG,EAAE;QACrB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;YAC/B,MAAM,GAAG,IAAI,eAAM,CAAC;gBAChB,iBAAiB;gBACjB,IAAI;gBACJ,IAAI,EAAE,WAAW;gBACjB,sBAAsB,EAAE,GAAG,EAAE;oBACzB,OAAO;wBACH,qBAAqB,EAAE,KAAK;wBAC5B,gBAAgB,EAAE,QAAQ;qBAC7B,CAAC;gBACN,CAAC;aACJ,CAA8B,CAAC;YAEhC,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,WAAW,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;QACpC,MAAM,GAAG,GAAG,oBAAoB,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9C,0BAA0B,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;QACzC,OAAO,GAAG,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,OAAO,IAAA,iBAAO,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC,CAAC;AA1DW,QAAA,cAAc,kBA0DzB;AAEF;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,CAChC,kBAA0B,EAC1B,gBAAyB,EACzB,QAA0D,EAC1C,EAAE;IAClB,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;KAC1E;IAED,MAAM,MAAM,GAAG,0BAA0B,CAAC,kBAAkB,CAAC,CAAC;IAC9D,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,IAAA,iBAAO,EAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;KACpD;IAED,OAAO,0BAA0B,CAAC,kBAAkB,CAAC,CAAC;IAEtD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACrD,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,OAAO,IAAA,iBAAO,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC,CAAC;AApBW,QAAA,oBAAoB,wBAoB/B;AAYF;;;;;GAKG;AACI,MAAM,4BAA4B,GAAG,CACxC,kBAA0B,EAC1B,8BAAwC,EACjC,EAAE;IACT,MAAM,MAAM,GAAG,0BAA0B,CAAC,kBAAkB,CAAC,CAAC;IAC9D,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,KAAK,CAAC;KAChB;IACD,MAAM,CAAC,EAAE,CAAC,wBAAwB,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE;QAC/D,8BAA8B,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAZW,QAAA,4BAA4B,gCAYvC"}

package/dist/chain.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import dns from 'dns';
+import { URL } from 'url';
+import { EventEmitter } from 'events';
+import { Buffer } from 'buffer';
+import { Socket } from './socket';
+export interface HandlerOpts {
+    upstreamProxyUrlParsed: URL;
+    localAddress?: string;
+    ipFamily?: number;
+    dnsLookup?: typeof dns['lookup'];
+    customTag?: unknown;
+}
+interface ChainOpts {
+    request: {
+        url?: string;
+    };
+    sourceSocket: Socket;
+    head?: Buffer;
+    handlerOpts: HandlerOpts;
+    server: EventEmitter & {
+        log: (connectionId: unknown, str: string) => void;
+    };
+    isPlain: boolean;
+}
+/**
+ * Passes the traffic to upstream HTTP proxy server.
+ * Client -> Apify -> Upstream -> Web
+ * Client <- Apify <- Upstream <- Web
+ */
+export declare const chain: ({ request, sourceSocket, head, handlerOpts, server, isPlain, }: ChainOpts) => void;
+export {};
+//# sourceMappingURL=chain.d.ts.map

package/dist/chain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain.d.ts","sourceRoot":"","sources":["../src/chain.ts"],"names":[],"mappings":";;;;;AACA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAYlC,MAAM,WAAW,WAAW;IACxB,sBAAsB,EAAE,GAAG,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,SAAS;IACf,OAAO,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,YAAY,GAAG;QAAE,GAAG,EAAE,CAAC,YAAY,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,CAAC;IAC7E,OAAO,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,eAAO,MAAM,KAAK,mEAQX,SAAS,KACb,IAgJF,CAAC"}