@push.rocks/smartproxy 10.2.0 → 12.0.0

package/ts/smartproxy/forwarding/forwarding.factory.ts

@@ -0,0 +1,155 @@
+import type { IForwardConfig, IForwardingHandler } from '../types/forwarding.types.js';
+import { HttpForwardingHandler } from './http.handler.js';
+import { HttpsPassthroughHandler } from './https-passthrough.handler.js';
+import { HttpsTerminateToHttpHandler } from './https-terminate-to-http.handler.js';
+import { HttpsTerminateToHttpsHandler } from './https-terminate-to-https.handler.js';
+
+/**
+ * Factory for creating forwarding handlers based on the configuration type
+ */
+export class ForwardingHandlerFactory {
+  /**
+   * Create a forwarding handler based on the configuration
+   * @param config The forwarding configuration
+   * @returns The appropriate forwarding handler
+   */
+  public static createHandler(config: IForwardConfig): IForwardingHandler {
+    // Create the appropriate handler based on the forwarding type
+    switch (config.type) {
+      case 'http-only':
+        return new HttpForwardingHandler(config);
+        
+      case 'https-passthrough':
+        return new HttpsPassthroughHandler(config);
+        
+      case 'https-terminate-to-http':
+        return new HttpsTerminateToHttpHandler(config);
+        
+      case 'https-terminate-to-https':
+        return new HttpsTerminateToHttpsHandler(config);
+        
+      default:
+        // Type system should prevent this, but just in case:
+        throw new Error(`Unknown forwarding type: ${(config as any).type}`);
+    }
+  }
+  
+  /**
+   * Apply default values to a forwarding configuration based on its type
+   * @param config The original forwarding configuration
+   * @returns A configuration with defaults applied
+   */
+  public static applyDefaults(config: IForwardConfig): IForwardConfig {
+    // Create a deep copy of the configuration
+    const result: IForwardConfig = JSON.parse(JSON.stringify(config));
+    
+    // Apply defaults based on forwarding type
+    switch (config.type) {
+      case 'http-only':
+        // Set defaults for HTTP-only mode
+        result.http = {
+          enabled: true,
+          ...config.http
+        };
+        break;
+        
+      case 'https-passthrough':
+        // Set defaults for HTTPS passthrough
+        result.https = {
+          forwardSni: true,
+          ...config.https
+        };
+        // SNI forwarding doesn't do HTTP
+        result.http = {
+          enabled: false,
+          ...config.http
+        };
+        break;
+        
+      case 'https-terminate-to-http':
+        // Set defaults for HTTPS termination to HTTP
+        result.https = {
+          ...config.https
+        };
+        // Support HTTP access by default in this mode
+        result.http = {
+          enabled: true,
+          redirectToHttps: true,
+          ...config.http
+        };
+        // Enable ACME by default
+        result.acme = {
+          enabled: true,
+          maintenance: true,
+          ...config.acme
+        };
+        break;
+        
+      case 'https-terminate-to-https':
+        // Similar to terminate-to-http but with different target handling
+        result.https = {
+          ...config.https
+        };
+        result.http = {
+          enabled: true,
+          redirectToHttps: true,
+          ...config.http
+        };
+        result.acme = {
+          enabled: true,
+          maintenance: true,
+          ...config.acme
+        };
+        break;
+    }
+    
+    return result;
+  }
+  
+  /**
+   * Validate a forwarding configuration
+   * @param config The configuration to validate
+   * @throws Error if the configuration is invalid
+   */
+  public static validateConfig(config: IForwardConfig): void {
+    // Validate common properties
+    if (!config.target) {
+      throw new Error('Forwarding configuration must include a target');
+    }
+    
+    if (!config.target.host || (Array.isArray(config.target.host) && config.target.host.length === 0)) {
+      throw new Error('Target must include a host or array of hosts');
+    }
+    
+    if (!config.target.port || config.target.port <= 0 || config.target.port > 65535) {
+      throw new Error('Target must include a valid port (1-65535)');
+    }
+    
+    // Type-specific validation
+    switch (config.type) {
+      case 'http-only':
+        // HTTP-only needs http.enabled to be true
+        if (config.http?.enabled === false) {
+          throw new Error('HTTP-only forwarding must have HTTP enabled');
+        }
+        break;
+        
+      case 'https-passthrough':
+        // HTTPS passthrough doesn't support HTTP
+        if (config.http?.enabled === true) {
+          throw new Error('HTTPS passthrough does not support HTTP');
+        }
+        
+        // HTTPS passthrough doesn't work with ACME
+        if (config.acme?.enabled === true) {
+          throw new Error('HTTPS passthrough does not support ACME');
+        }
+        break;
+        
+      case 'https-terminate-to-http':
+      case 'https-terminate-to-https':
+        // These modes support all options, nothing specific to validate
+        break;
+    }
+  }
+}

package/ts/smartproxy/forwarding/forwarding.handler.ts

@@ -0,0 +1,127 @@
+import * as plugins from '../../plugins.js';
+import type {
+  IForwardConfig,
+  IForwardingHandler
+} from '../types/forwarding.types.js';
+import { ForwardingHandlerEvents } from '../types/forwarding.types.js';
+
+/**
+ * Base class for all forwarding handlers
+ */
+export abstract class ForwardingHandler extends plugins.EventEmitter implements IForwardingHandler {
+  /**
+   * Create a new ForwardingHandler
+   * @param config The forwarding configuration
+   */
+  constructor(protected config: IForwardConfig) {
+    super();
+  }
+  
+  /**
+   * Initialize the handler
+   * Base implementation does nothing, subclasses should override as needed
+   */
+  public async initialize(): Promise<void> {
+    // Base implementation - no initialization needed
+  }
+
+  /**
+   * Handle a new socket connection
+   * @param socket The incoming socket connection
+   */
+  public abstract handleConnection(socket: plugins.net.Socket): void;
+  
+  /**
+   * Handle an HTTP request
+   * @param req The HTTP request
+   * @param res The HTTP response
+   */
+  public abstract handleHttpRequest(req: plugins.http.IncomingMessage, res: plugins.http.ServerResponse): void;
+  
+  /**
+   * Get a target from the configuration, supporting round-robin selection
+   * @returns A resolved target object with host and port
+   */
+  protected getTargetFromConfig(): { host: string, port: number } {
+    const { target } = this.config;
+    
+    // Handle round-robin host selection
+    if (Array.isArray(target.host)) {
+      if (target.host.length === 0) {
+        throw new Error('No target hosts specified');
+      }
+      
+      // Simple round-robin selection
+      const randomIndex = Math.floor(Math.random() * target.host.length);
+      return {
+        host: target.host[randomIndex],
+        port: target.port
+      };
+    }
+    
+    // Single host
+    return {
+      host: target.host,
+      port: target.port
+    };
+  }
+  
+  /**
+   * Redirect an HTTP request to HTTPS
+   * @param req The HTTP request
+   * @param res The HTTP response
+   */
+  protected redirectToHttps(req: plugins.http.IncomingMessage, res: plugins.http.ServerResponse): void {
+    const host = req.headers.host || '';
+    const path = req.url || '/';
+    const redirectUrl = `https://${host}${path}`;
+    
+    res.writeHead(301, {
+      'Location': redirectUrl,
+      'Cache-Control': 'no-cache'
+    });
+    res.end(`Redirecting to ${redirectUrl}`);
+    
+    this.emit(ForwardingHandlerEvents.HTTP_RESPONSE, {
+      statusCode: 301,
+      headers: { 'Location': redirectUrl },
+      size: 0
+    });
+  }
+  
+  /**
+   * Apply custom headers from configuration
+   * @param headers The original headers
+   * @param variables Variables to replace in the headers
+   * @returns The headers with custom values applied
+   */
+  protected applyCustomHeaders(
+    headers: Record<string, string | string[] | undefined>,
+    variables: Record<string, string>
+  ): Record<string, string | string[] | undefined> {
+    const customHeaders = this.config.advanced?.headers || {};
+    const result = { ...headers };
+    
+    // Apply custom headers with variable substitution
+    for (const [key, value] of Object.entries(customHeaders)) {
+      let processedValue = value;
+      
+      // Replace variables in the header value
+      for (const [varName, varValue] of Object.entries(variables)) {
+        processedValue = processedValue.replace(`{${varName}}`, varValue);
+      }
+      
+      result[key] = processedValue;
+    }
+    
+    return result;
+  }
+  
+  /**
+   * Get the timeout for this connection from configuration
+   * @returns Timeout in milliseconds
+   */
+  protected getTimeout(): number {
+    return this.config.advanced?.timeout || 60000; // Default: 60 seconds
+  }
+}

package/ts/smartproxy/forwarding/http.handler.ts

@@ -0,0 +1,140 @@
+import * as plugins from '../../plugins.js';
+import { ForwardingHandler } from './forwarding.handler.js';
+import type { IForwardConfig } from '../types/forwarding.types.js';
+import { ForwardingHandlerEvents } from '../types/forwarding.types.js';
+
+/**
+ * Handler for HTTP-only forwarding
+ */
+export class HttpForwardingHandler extends ForwardingHandler {
+  /**
+   * Create a new HTTP forwarding handler
+   * @param config The forwarding configuration
+   */
+  constructor(config: IForwardConfig) {
+    super(config);
+    
+    // Validate that this is an HTTP-only configuration
+    if (config.type !== 'http-only') {
+      throw new Error(`Invalid configuration type for HttpForwardingHandler: ${config.type}`);
+    }
+  }
+  
+  /**
+   * Handle a raw socket connection
+   * HTTP handler doesn't do much with raw sockets as it mainly processes
+   * parsed HTTP requests
+   */
+  public handleConnection(socket: plugins.net.Socket): void {
+    // For HTTP, we mainly handle parsed requests, but we can still set up
+    // some basic connection tracking
+    const remoteAddress = socket.remoteAddress || 'unknown';
+    
+    socket.on('close', (hadError) => {
+      this.emit(ForwardingHandlerEvents.DISCONNECTED, {
+        remoteAddress,
+        hadError
+      });
+    });
+    
+    socket.on('error', (error) => {
+      this.emit(ForwardingHandlerEvents.ERROR, {
+        remoteAddress,
+        error: error.message
+      });
+    });
+    
+    this.emit(ForwardingHandlerEvents.CONNECTED, {
+      remoteAddress
+    });
+  }
+  
+  /**
+   * Handle an HTTP request
+   * @param req The HTTP request
+   * @param res The HTTP response
+   */
+  public handleHttpRequest(req: plugins.http.IncomingMessage, res: plugins.http.ServerResponse): void {
+    // Get the target from configuration
+    const target = this.getTargetFromConfig();
+    
+    // Create a custom headers object with variables for substitution
+    const variables = {
+      clientIp: req.socket.remoteAddress || 'unknown'
+    };
+    
+    // Prepare headers, merging with any custom headers from config
+    const headers = this.applyCustomHeaders(req.headers, variables);
+    
+    // Create the proxy request options
+    const options = {
+      hostname: target.host,
+      port: target.port,
+      path: req.url,
+      method: req.method,
+      headers
+    };
+    
+    // Create the proxy request
+    const proxyReq = plugins.http.request(options, (proxyRes) => {
+      // Copy status code and headers from the proxied response
+      res.writeHead(proxyRes.statusCode || 500, proxyRes.headers);
+      
+      // Pipe the proxy response to the client response
+      proxyRes.pipe(res);
+      
+      // Track bytes for logging
+      let responseSize = 0;
+      proxyRes.on('data', (chunk) => {
+        responseSize += chunk.length;
+      });
+      
+      proxyRes.on('end', () => {
+        this.emit(ForwardingHandlerEvents.HTTP_RESPONSE, {
+          statusCode: proxyRes.statusCode,
+          headers: proxyRes.headers,
+          size: responseSize
+        });
+      });
+    });
+    
+    // Handle errors in the proxy request
+    proxyReq.on('error', (error) => {
+      this.emit(ForwardingHandlerEvents.ERROR, {
+        remoteAddress: req.socket.remoteAddress,
+        error: `Proxy request error: ${error.message}`
+      });
+      
+      // Send an error response if headers haven't been sent yet
+      if (!res.headersSent) {
+        res.writeHead(502, { 'Content-Type': 'text/plain' });
+        res.end(`Error forwarding request: ${error.message}`);
+      } else {
+        // Just end the response if headers have already been sent
+        res.end();
+      }
+    });
+    
+    // Track request details for logging
+    let requestSize = 0;
+    req.on('data', (chunk) => {
+      requestSize += chunk.length;
+    });
+    
+    // Log the request
+    this.emit(ForwardingHandlerEvents.HTTP_REQUEST, {
+      method: req.method,
+      url: req.url,
+      headers: req.headers,
+      remoteAddress: req.socket.remoteAddress,
+      target: `${target.host}:${target.port}`
+    });
+    
+    // Pipe the client request to the proxy request
+    if (req.readable) {
+      req.pipe(proxyReq);
+    } else {
+      proxyReq.end();
+    }
+  }
+}

package/ts/smartproxy/forwarding/https-passthrough.handler.ts

@@ -0,0 +1,182 @@
+import * as plugins from '../../plugins.js';
+import { ForwardingHandler } from './forwarding.handler.js';
+import type { IForwardConfig } from '../types/forwarding.types.js';
+import { ForwardingHandlerEvents } from '../types/forwarding.types.js';
+
+/**
+ * Handler for HTTPS passthrough (SNI forwarding without termination)
+ */
+export class HttpsPassthroughHandler extends ForwardingHandler {
+  /**
+   * Create a new HTTPS passthrough handler
+   * @param config The forwarding configuration
+   */
+  constructor(config: IForwardConfig) {
+    super(config);
+    
+    // Validate that this is an HTTPS passthrough configuration
+    if (config.type !== 'https-passthrough') {
+      throw new Error(`Invalid configuration type for HttpsPassthroughHandler: ${config.type}`);
+    }
+  }
+  
+  /**
+   * Handle a TLS/SSL socket connection by forwarding it without termination
+   * @param clientSocket The incoming socket from the client
+   */
+  public handleConnection(clientSocket: plugins.net.Socket): void {
+    // Get the target from configuration
+    const target = this.getTargetFromConfig();
+    
+    // Log the connection
+    const remoteAddress = clientSocket.remoteAddress || 'unknown';
+    const remotePort = clientSocket.remotePort || 0;
+    
+    this.emit(ForwardingHandlerEvents.CONNECTED, {
+      remoteAddress,
+      remotePort,
+      target: `${target.host}:${target.port}`
+    });
+    
+    // Create a connection to the target server
+    const serverSocket = plugins.net.connect(target.port, target.host);
+    
+    // Handle errors on the server socket
+    serverSocket.on('error', (error) => {
+      this.emit(ForwardingHandlerEvents.ERROR, {
+        remoteAddress,
+        error: `Target connection error: ${error.message}`
+      });
+      
+      // Close the client socket if it's still open
+      if (!clientSocket.destroyed) {
+        clientSocket.destroy();
+      }
+    });
+    
+    // Handle errors on the client socket
+    clientSocket.on('error', (error) => {
+      this.emit(ForwardingHandlerEvents.ERROR, {
+        remoteAddress,
+        error: `Client connection error: ${error.message}`
+      });
+      
+      // Close the server socket if it's still open
+      if (!serverSocket.destroyed) {
+        serverSocket.destroy();
+      }
+    });
+    
+    // Track data transfer for logging
+    let bytesSent = 0;
+    let bytesReceived = 0;
+    
+    // Forward data from client to server
+    clientSocket.on('data', (data) => {
+      bytesSent += data.length;
+      
+      // Check if server socket is writable
+      if (serverSocket.writable) {
+        const flushed = serverSocket.write(data);
+        
+        // Handle backpressure
+        if (!flushed) {
+          clientSocket.pause();
+          serverSocket.once('drain', () => {
+            clientSocket.resume();
+          });
+        }
+      }
+      
+      this.emit(ForwardingHandlerEvents.DATA_FORWARDED, {
+        direction: 'outbound',
+        bytes: data.length,
+        total: bytesSent
+      });
+    });
+    
+    // Forward data from server to client
+    serverSocket.on('data', (data) => {
+      bytesReceived += data.length;
+      
+      // Check if client socket is writable
+      if (clientSocket.writable) {
+        const flushed = clientSocket.write(data);
+        
+        // Handle backpressure
+        if (!flushed) {
+          serverSocket.pause();
+          clientSocket.once('drain', () => {
+            serverSocket.resume();
+          });
+        }
+      }
+      
+      this.emit(ForwardingHandlerEvents.DATA_FORWARDED, {
+        direction: 'inbound',
+        bytes: data.length,
+        total: bytesReceived
+      });
+    });
+    
+    // Handle connection close
+    const handleClose = () => {
+      if (!clientSocket.destroyed) {
+        clientSocket.destroy();
+      }
+      
+      if (!serverSocket.destroyed) {
+        serverSocket.destroy();
+      }
+      
+      this.emit(ForwardingHandlerEvents.DISCONNECTED, {
+        remoteAddress,
+        bytesSent,
+        bytesReceived
+      });
+    };
+    
+    // Set up close handlers
+    clientSocket.on('close', handleClose);
+    serverSocket.on('close', handleClose);
+    
+    // Set timeouts
+    const timeout = this.getTimeout();
+    clientSocket.setTimeout(timeout);
+    serverSocket.setTimeout(timeout);
+    
+    // Handle timeouts
+    clientSocket.on('timeout', () => {
+      this.emit(ForwardingHandlerEvents.ERROR, {
+        remoteAddress,
+        error: 'Client connection timeout'
+      });
+      handleClose();
+    });
+    
+    serverSocket.on('timeout', () => {
+      this.emit(ForwardingHandlerEvents.ERROR, {
+        remoteAddress,
+        error: 'Server connection timeout'
+      });
+      handleClose();
+    });
+  }
+  
+  /**
+   * Handle an HTTP request - HTTPS passthrough doesn't support HTTP
+   * @param req The HTTP request
+   * @param res The HTTP response
+   */
+  public handleHttpRequest(req: plugins.http.IncomingMessage, res: plugins.http.ServerResponse): void {
+    // HTTPS passthrough doesn't support HTTP requests
+    res.writeHead(404, { 'Content-Type': 'text/plain' });
+    res.end('HTTP not supported for this domain');
+    
+    this.emit(ForwardingHandlerEvents.HTTP_RESPONSE, {
+      statusCode: 404,
+      headers: { 'Content-Type': 'text/plain' },
+      size: 'HTTP not supported for this domain'.length
+    });
+  }
+}