feat: Add option to specify server's host

README.md

@@ -39,6 +39,10 @@ const server = new ProxyChain.Server({
     // Port where the server will listen. By default 8000.
     port: 8000,
 
+    // Hostname where the server will listen.
+    // optional, defaults to unspecified IP address, see e.g. https://en.wikipedia.org/wiki/IPv6_address#Unspecified_address
+    hostname: 'localhost',
+
     // Enables verbose logging
     verbose: true,
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "proxy-chain",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Node.js implementation of a proxy server (think Squid) with support for SSL, authentication, upstream proxy chaining, and protocol tunneling.",
   "main": "dist/index.js",
   "keywords": [

src/server.ts

@@ -88,6 +88,8 @@
 export class Server extends EventEmitter {
     port: number;
 
+    hostname?: string;
+
     prepareRequestFunction?: PrepareRequestFunction;
 
     authRealm: unknown;
@@ -138,6 +140,7 @@
      */
     constructor(options: {
         port?: number,
+        hostname?: string,
         prepareRequestFunction?: PrepareRequestFunction,
         verbose?: boolean,
         authRealm?: unknown,
@@ -150,6 +153,7 @@
             this.port = options.port;
         }
 
+        this.hostname = options.hostname;
         this.prepareRequestFunction = options.prepareRequestFunction;
         this.authRealm = options.authRealm || DEFAULT_AUTH_REALM;
         this.verbose = !!options.verbose;
@@ -172,7 +176,7 @@
     log(connectionId: unknown, str: string): void {
         if (this.verbose) {
             const logPrefix = connectionId ? `${String(connectionId)} | ` : '';
             console.log(`ProxyServer[${this.port}]: ${logPrefix}${str}`);
         }
     }
 
@@ -537,8 +541,6 @@
 
     /**
      * Starts listening at a port specified in the constructor.
-     * @param callback Optional callback
-     * @return {(Promise|undefined)}
      */
     listen(callback?: (error: NodeJS.ErrnoException | null) => void): Promise<void> {
         const promise = new Promise<void>((resolve, reject) => {
@@ -562,7 +564,7 @@
 
             this.server.on('error', onError);
             this.server.on('listening', onListening);
-            this.server.listen(this.port);
+            this.server.listen(this.port, this.hostname);
         });
 
         return nodeify(promise, callback);