@ffflorian/https-proxy 1.10.4 → 1.11.0

package/README.md

@@ -9,7 +9,7 @@ A simple HTTPS proxy for Node.js with authentication support.
 
 ## Installation
 
-ℹ️ This is a hybrid [CommonJS](https://nodejs.org/docs/latest/api/modules.html#modules-commonjs-modules) / [ESM](https://nodejs.org/api/esm.html#introduction) module.
+ℹ️ This is a pure [ESM](https://nodejs.org/api/esm.html#introduction) module.
 
 Run `yarn global add @ffflorian/https-proxy` or `npm install -g @ffflorian/https-proxy`.
 

package/dist/{esm/HttpsProxy.js → HttpsProxy.js}

@@ -1,9 +1,9 @@
+import http from 'node:http';
+import net from 'node:net';
+import url from 'node:url';
 import basicAuth from 'basic-auth';
-import http from 'http';
 import logdown from 'logdown';
-import net from 'net';
 import compare from 'tsscmp';
-import url from 'url';
 import { StatusCodes as HTTP_STATUS } from 'http-status-codes';
 const defaultOptions = {
     password: '',
@@ -78,7 +78,7 @@ export class HttpsProxy {
             res.end('Bad Request');
             this.logger.warn(`Rejected "${req.method}" request from "${req.socket.remoteAddress}"`);
         };
-        this.options = Object.assign(Object.assign({}, defaultOptions), options);
+        this.options = { ...defaultOptions, ...options };
         this.logger = logdown('https-proxy', {
             logger: console,
             markdown: false,

package/dist/{esm/cli.js → cli.js}

@@ -1,9 +1,13 @@
 #!/usr/bin/env node
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { program as commander } from 'commander';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
 import { HttpsProxy } from './HttpsProxy.js';
-const { description, name, version } = require('../package.json');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageJsonPath = path.join(__dirname, '../package.json');
+const { description, name, version } = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
 commander
     .name(name.replace(/^@[^/]+\//, ''))
     .description(`${description}\nIf password and username are not set, no authentication will be required.`)
@@ -20,4 +24,9 @@ if ((commanderOptions.password && !commanderOptions.username) ||
     commander.outputHelp();
     process.exit(1);
 }
-new HttpsProxy(Object.assign(Object.assign(Object.assign(Object.assign({}, (commanderOptions.password && { password: commanderOptions.password })), (commanderOptions.port && { port: commanderOptions.port })), (commanderOptions.target && { target: commanderOptions.target })), (commanderOptions.username && { username: commanderOptions.username }))).start();
+new HttpsProxy({
+    ...(commanderOptions.password && { password: commanderOptions.password }),
+    ...(commanderOptions.port && { port: commanderOptions.port }),
+    ...(commanderOptions.target && { target: commanderOptions.target }),
+    ...(commanderOptions.username && { username: commanderOptions.username }),
+}).start();

package/package.json

@@ -1,6 +1,6 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
-  "bin": "dist/cjs/cli.js",
+  "bin": "dist/cli.js",
   "dependencies": {
     "basic-auth": "2.0.1",
     "commander": "12.1.0",
@@ -12,18 +12,13 @@
   "devDependencies": {
     "@types/basic-auth": "1.1.8",
     "@types/tsscmp": "1.0.2",
-    "rimraf": "5.0.7",
-    "typescript": "5.4.5"
+    "rimraf": "6.0.1",
+    "typescript": "5.5.4"
   },
   "engines": {
     "node": ">= 18.0"
   },
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    }
-  },
+  "exports": "./dist/index.js",
   "files": [
     "dist"
   ],
@@ -32,20 +27,16 @@
     "typescript"
   ],
   "license": "GPL-3.0",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "module": "dist/index.js",
   "name": "@ffflorian/https-proxy",
   "repository": "https://github.com/ffflorian/node-packages/tree/main/packages/https-proxy",
   "scripts": {
-    "build": "yarn build:cjs && yarn build:esm && yarn generate:packagejson",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
-    "generate:packagejson": "../../bin/generate-hybrid-package-json.sh",
     "start": "node --loader ts-node/esm src/cli.ts"
   },
   "type": "module",
-  "version": "1.10.4",
-  "gitHead": "28c184f53a87d8eb082cc27c923ef7b352bbe875"
+  "version": "1.11.0",
+  "gitHead": "f1a74d8ec9721d5b52a00e41b2ec73278e048290"
 }

package/dist/cjs/HttpsProxy.js

@@ -1,112 +0,0 @@
-import basicAuth from 'basic-auth';
-import http from 'http';
-import logdown from 'logdown';
-import net from 'net';
-import compare from 'tsscmp';
-import url from 'url';
-import { StatusCodes as HTTP_STATUS } from 'http-status-codes';
-const defaultOptions = {
-    password: '',
-    port: 8080,
-    target: '',
-    username: '',
-};
-export class HttpsProxy {
-    constructor(options) {
-        this.onConnect = (req, clientSocket) => {
-            this.logger.info(clientSocket.remoteAddress, clientSocket.remotePort, req.method, req.url);
-            const authorizationHeader = req.headers['proxy-authorization'];
-            if (this.authenticationEnabled) {
-                if (!authorizationHeader) {
-                    clientSocket.write(this.getClosingProxyMessage(HTTP_STATUS.PROXY_AUTHENTICATION_REQUIRED, 'Proxy Authentication Required'));
-                    clientSocket.end('\r\n\r\n');
-                    this.logger.warn(`Responded to proxy request from "${clientSocket.remoteAddress}" with authorization request`);
-                    return;
-                }
-                if (!this.validateAuthorization(authorizationHeader)) {
-                    clientSocket.write(this.getClosingProxyMessage(HTTP_STATUS.UNAUTHORIZED, 'Unauthorized'));
-                    clientSocket.end('\r\n\r\n');
-                    this.logger.warn(`Rejected proxy request with invalid authorization from "${clientSocket.remoteAddress}".`);
-                    return;
-                }
-            }
-            const { port, hostname } = url.parse(this.options.target || `//${req.url}`, false, true);
-            const parsedPort = parseInt(port || '443', 10);
-            if (!hostname) {
-                clientSocket.end('HTTP/1.1 400 Bad Request\r\n');
-                clientSocket.destroy();
-                this.logger.warn(`Rejected proxy request without hostname from "${clientSocket.remoteAddress}".`);
-                return;
-            }
-            const serverSocket = net.connect({ host: hostname, port: parsedPort });
-            clientSocket
-                .on('end', () => {
-                if (serverSocket) {
-                    serverSocket.end();
-                }
-            })
-                .on('error', (err) => {
-                this.logger.error(`ClientSocket error: "${err.message}"`);
-                if (serverSocket) {
-                    serverSocket.end();
-                }
-            });
-            serverSocket
-                .on('connect', () => {
-                clientSocket.write(['HTTP/1.1 200 Connection Established', 'Proxy-agent: Node-Proxy'].join('\r\n'));
-                clientSocket.write('\r\n\r\n');
-                serverSocket.pipe(clientSocket, { end: false });
-                clientSocket.pipe(serverSocket, { end: false });
-                this.logger.info(`Proxying data between "${clientSocket.remoteAddress}" and "${req.headers.host}".`);
-            })
-                .on('end', () => {
-                if (clientSocket) {
-                    clientSocket.end(`HTTP/1.1 500 External Server End\r\n`);
-                }
-                this.logger.info(`Ended proxy between "${clientSocket.remoteAddress}" and "${req.headers.host}".`);
-            })
-                .on('error', (err) => {
-                this.logger.error(`ServerSocket error: "${err.message}"`);
-                if (clientSocket) {
-                    clientSocket.end(`HTTP/1.1 500 ${err.message}\r\n`);
-                }
-            });
-        };
-        this.onCreate = (req, res) => {
-            // discard all request to proxy server except HTTP/1.1 CONNECT method
-            res.writeHead(HTTP_STATUS.BAD_REQUEST, { 'Content-Type': 'text/plain' });
-            res.end('Bad Request');
-            this.logger.warn(`Rejected "${req.method}" request from "${req.socket.remoteAddress}"`);
-        };
-        this.options = Object.assign(Object.assign({}, defaultOptions), options);
-        this.logger = logdown('https-proxy', {
-            logger: console,
-            markdown: false,
-        });
-        this.logger.state.isEnabled = true;
-        this.authenticationEnabled = Boolean(this.options.username && this.options.password);
-        this.server = http
-            .createServer(this.onCreate)
-            .on('connect', this.onConnect)
-            .on('error', error => this.logger.error(`Server error: "${error.message}"`));
-    }
-    start() {
-        const authenticationStatus = this.authenticationEnabled ? 'ON' : 'OFF';
-        this.server.listen(this.options.port);
-        this.logger.info(`Proxy server is listening on port ${this.options.port} (authentication: ${authenticationStatus}).`);
-    }
-    getClosingProxyMessage(code, httpMessage) {
-        return [
-            `HTTP/1.1 ${code} ${httpMessage}`,
-            `Date: ${new Date().toUTCString()}`,
-            'Proxy-Authenticate: Basic realm="proxy"',
-            'Proxy-Connection: close',
-        ].join('\r\n');
-    }
-    validateAuthorization(auth) {
-        const credentials = basicAuth.parse(auth);
-        return (!!credentials &&
-            compare(credentials.name, this.options.username) &&
-            compare(credentials.pass, this.options.password));
-    }
-}

package/dist/cjs/cli.js

@@ -1,23 +0,0 @@
-#!/usr/bin/env node
-import { program as commander } from 'commander';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-import { HttpsProxy } from './HttpsProxy.js';
-const { description, name, version } = require('../package.json');
-commander
-    .name(name.replace(/^@[^/]+\//, ''))
-    .description(`${description}\nIf password and username are not set, no authentication will be required.`)
-    .option('-p, --password <password>', 'set the password')
-    .option('-P, --port <port>', 'set the port', '8080')
-    .option('-t, --target <url>', 'set the target URL to forward users to')
-    .option('-u, --username <username>', 'set the username')
-    .version(version, '-v, --version')
-    .parse(process.argv);
-const commanderOptions = commander.opts();
-if ((commanderOptions.password && !commanderOptions.username) ||
-    (!commanderOptions.password && commanderOptions.username)) {
-    console.error('Password and username are both required for authentication.');
-    commander.outputHelp();
-    process.exit(1);
-}
-new HttpsProxy(Object.assign(Object.assign(Object.assign(Object.assign({}, (commanderOptions.password && { password: commanderOptions.password })), (commanderOptions.port && { port: commanderOptions.port })), (commanderOptions.target && { target: commanderOptions.target })), (commanderOptions.username && { username: commanderOptions.username }))).start();

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/esm/HttpsProxy.d.ts

@@ -1,28 +0,0 @@
-export interface Options {
-    /** Default is `8080`. */
-    port?: number;
-    /** If not set, the requested URL will be used. */
-    target?: string;
-}
-export interface AuthenticationOptions extends Options {
-    /** If not set, no authentication will be required. */
-    password: string;
-    /** Default is `8080`. */
-    port?: number;
-    /** If not set, the requested URL will be used. */
-    target?: string;
-    /** If not set, no authentication will be required. */
-    username: string;
-}
-export declare class HttpsProxy {
-    private readonly authenticationEnabled;
-    private readonly logger;
-    private readonly options;
-    private readonly server;
-    constructor(options?: Options | AuthenticationOptions);
-    start(): void;
-    private getClosingProxyMessage;
-    private readonly onConnect;
-    private readonly onCreate;
-    private validateAuthorization;
-}

package/dist/esm/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/esm/index.d.ts

@@ -1 +0,0 @@
-export * from './HttpsProxy.js';

package/dist/esm/index.js

@@ -1 +0,0 @@
-export * from './HttpsProxy.js';

package/dist/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}