prxy-chain 0.0.1-security → 2.5.4

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Apify Technologies s.r.o.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,476 @@
-# Security holding package
+# Programmable HTTP proxy server for Node.js
 
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
+[![npm version](https://badge.fury.io/js/proxy-chain.svg)](http://badge.fury.io/js/proxy-chain)
 
-Please refer to www.npmjs.com/advisories?search=prxy-chain for more information.
+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'));
+```