@push.rocks/smartproxy 12.0.0 → 13.1.2

package/ts/core/utils/validation-utils.ts

@@ -0,0 +1,177 @@
+import * as plugins from '../../plugins.js';
+import type { IDomainOptions, IAcmeOptions } from '../models/common-types.js';
+
+/**
+ * Collection of validation utilities for configuration and domain options
+ */
+export class ValidationUtils {
+  /**
+   * Validates domain configuration options
+   * 
+   * @param domainOptions The domain options to validate
+   * @returns An object with validation result and error message if invalid
+   */
+  public static validateDomainOptions(domainOptions: IDomainOptions): { isValid: boolean; error?: string } {
+    if (!domainOptions) {
+      return { isValid: false, error: 'Domain options cannot be null or undefined' };
+    }
+
+    if (!domainOptions.domainName) {
+      return { isValid: false, error: 'Domain name is required' };
+    }
+
+    // Check domain pattern
+    if (!this.isValidDomainName(domainOptions.domainName)) {
+      return { isValid: false, error: `Invalid domain name: ${domainOptions.domainName}` };
+    }
+
+    // Validate forward config if provided
+    if (domainOptions.forward) {
+      if (!domainOptions.forward.ip) {
+        return { isValid: false, error: 'Forward IP is required when forward is specified' };
+      }
+
+      if (!domainOptions.forward.port) {
+        return { isValid: false, error: 'Forward port is required when forward is specified' };
+      }
+
+      if (!this.isValidPort(domainOptions.forward.port)) {
+        return { isValid: false, error: `Invalid forward port: ${domainOptions.forward.port}` };
+      }
+    }
+
+    // Validate ACME forward config if provided
+    if (domainOptions.acmeForward) {
+      if (!domainOptions.acmeForward.ip) {
+        return { isValid: false, error: 'ACME forward IP is required when acmeForward is specified' };
+      }
+
+      if (!domainOptions.acmeForward.port) {
+        return { isValid: false, error: 'ACME forward port is required when acmeForward is specified' };
+      }
+
+      if (!this.isValidPort(domainOptions.acmeForward.port)) {
+        return { isValid: false, error: `Invalid ACME forward port: ${domainOptions.acmeForward.port}` };
+      }
+    }
+
+    return { isValid: true };
+  }
+
+  /**
+   * Validates ACME configuration options
+   * 
+   * @param acmeOptions The ACME options to validate
+   * @returns An object with validation result and error message if invalid
+   */
+  public static validateAcmeOptions(acmeOptions: IAcmeOptions): { isValid: boolean; error?: string } {
+    if (!acmeOptions) {
+      return { isValid: false, error: 'ACME options cannot be null or undefined' };
+    }
+
+    if (acmeOptions.enabled) {
+      if (!acmeOptions.accountEmail) {
+        return { isValid: false, error: 'Account email is required when ACME is enabled' };
+      }
+
+      if (!this.isValidEmail(acmeOptions.accountEmail)) {
+        return { isValid: false, error: `Invalid email: ${acmeOptions.accountEmail}` };
+      }
+
+      if (acmeOptions.port && !this.isValidPort(acmeOptions.port)) {
+        return { isValid: false, error: `Invalid ACME port: ${acmeOptions.port}` };
+      }
+
+      if (acmeOptions.httpsRedirectPort && !this.isValidPort(acmeOptions.httpsRedirectPort)) {
+        return { isValid: false, error: `Invalid HTTPS redirect port: ${acmeOptions.httpsRedirectPort}` };
+      }
+
+      if (acmeOptions.renewThresholdDays && acmeOptions.renewThresholdDays < 1) {
+        return { isValid: false, error: 'Renew threshold days must be greater than 0' };
+      }
+
+      if (acmeOptions.renewCheckIntervalHours && acmeOptions.renewCheckIntervalHours < 1) {
+        return { isValid: false, error: 'Renew check interval hours must be greater than 0' };
+      }
+    }
+
+    return { isValid: true };
+  }
+
+  /**
+   * Validates a port number
+   * 
+   * @param port The port to validate
+   * @returns true if the port is valid, false otherwise
+   */
+  public static isValidPort(port: number): boolean {
+    return typeof port === 'number' && port > 0 && port <= 65535 && Number.isInteger(port);
+  }
+
+  /**
+   * Validates a domain name
+   * 
+   * @param domain The domain name to validate
+   * @returns true if the domain name is valid, false otherwise
+   */
+  public static isValidDomainName(domain: string): boolean {
+    if (!domain || typeof domain !== 'string') {
+      return false;
+    }
+
+    // Wildcard domain check (*.example.com)
+    if (domain.startsWith('*.')) {
+      domain = domain.substring(2);
+    }
+
+    // Simple domain validation pattern
+    const domainPattern = /^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$/;
+    return domainPattern.test(domain);
+  }
+
+  /**
+   * Validates an email address
+   * 
+   * @param email The email to validate
+   * @returns true if the email is valid, false otherwise
+   */
+  public static isValidEmail(email: string): boolean {
+    if (!email || typeof email !== 'string') {
+      return false;
+    }
+    
+    // Basic email validation pattern
+    const emailPattern = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+    return emailPattern.test(email);
+  }
+
+  /**
+   * Validates a certificate format (PEM)
+   * 
+   * @param cert The certificate content to validate
+   * @returns true if the certificate appears to be in PEM format, false otherwise
+   */
+  public static isValidCertificate(cert: string): boolean {
+    if (!cert || typeof cert !== 'string') {
+      return false;
+    }
+    
+    return cert.includes('-----BEGIN CERTIFICATE-----') && 
+           cert.includes('-----END CERTIFICATE-----');
+  }
+
+  /**
+   * Validates a private key format (PEM)
+   * 
+   * @param key The private key content to validate
+   * @returns true if the key appears to be in PEM format, false otherwise
+   */
+  public static isValidPrivateKey(key: string): boolean {
+    if (!key || typeof key !== 'string') {
+      return false;
+    }
+    
+    return key.includes('-----BEGIN PRIVATE KEY-----') && 
+           key.includes('-----END PRIVATE KEY-----');
+  }
+}

package/ts/{smartproxy/forwarding → forwarding/config}/domain-config.ts

@@ -1,4 +1,4 @@
-import type { IForwardConfig } from '../types/forwarding.types.js';
+import type { IForwardConfig } from './forwarding-types.js';
 
 /**
  * Domain configuration with unified forwarding configuration

package/ts/{smartproxy/forwarding → forwarding/config}/domain-manager.ts

@@ -1,8 +1,8 @@
 import * as plugins from '../../plugins.js';
 import type { IDomainConfig } from './domain-config.js';
-import type { IForwardingHandler } from '../types/forwarding.types.js';
-import { ForwardingHandlerEvents } from '../types/forwarding.types.js';
-import { ForwardingHandlerFactory } from './forwarding.factory.js';
+import { ForwardingHandler } from '../handlers/base-handler.js';
+import { ForwardingHandlerEvents } from './forwarding-types.js';
+import { ForwardingHandlerFactory } from '../factory/forwarding-factory.js';
 
 /**
  * Events emitted by the DomainManager
@@ -22,8 +22,8 @@ export enum DomainManagerEvents {
  */
 export class DomainManager extends plugins.EventEmitter {
   private domainConfigs: IDomainConfig[] = [];
-  private domainHandlers: Map<string, IForwardingHandler> = new Map();
-  
+  private domainHandlers: Map<string, ForwardingHandler> = new Map();
+
   /**
    * Create a new DomainManager
    * @param initialDomains Optional initial domain configurations
@@ -116,7 +116,7 @@ export class DomainManager extends plugins.EventEmitter {
    * @param domain The domain to find a handler for
    * @returns The handler or undefined if no match
    */
-  public findHandlerForDomain(domain: string): IForwardingHandler | undefined {
+  public findHandlerForDomain(domain: string): ForwardingHandler | undefined {
     // Try exact match
     if (this.domainHandlers.has(domain)) {
       return this.domainHandlers.get(domain);
@@ -221,7 +221,7 @@ export class DomainManager extends plugins.EventEmitter {
    * @param handler The handler
    * @param config The domain configuration for this handler
    */
-  private setupHandlerEvents(handler: IForwardingHandler, config: IDomainConfig): void {
+  private setupHandlerEvents(handler: ForwardingHandler, config: IDomainConfig): void {
     // Forward relevant events
     handler.on(ForwardingHandlerEvents.CERTIFICATE_NEEDED, (data) => {
       this.emit(DomainManagerEvents.CERTIFICATE_NEEDED, {
@@ -250,7 +250,7 @@ export class DomainManager extends plugins.EventEmitter {
    * @param domain The domain to find a handler for
    * @returns The handler or undefined if no match
    */
-  private findWildcardHandler(domain: string): IForwardingHandler | undefined {
+  private findWildcardHandler(domain: string): ForwardingHandler | undefined {
     // Exact match already checked in findHandlerForDomain
     
     // Try subdomain wildcard (*.example.com)

package/ts/{smartproxy/types/forwarding.types.ts → forwarding/config/forwarding-types.ts}

@@ -3,7 +3,7 @@ import type * as plugins from '../../plugins.js';
 /**
  * The primary forwarding types supported by SmartProxy
  */
-export type ForwardingType =
+export type TForwardingType =
   | 'http-only'                // HTTP forwarding only (no HTTPS)
   | 'https-passthrough'        // Pass-through TLS traffic (SNI forwarding)
   | 'https-terminate-to-http'  // Terminate TLS and forward to HTTP backend
@@ -41,7 +41,7 @@ export interface IHttpsOptions {
  * ACME certificate handling options
  */
 export interface IAcmeForwardingOptions {
-  enabled?: boolean;                // Enable ACME certificate provisioning  
+  enabled?: boolean;                // Enable ACME certificate provisioning
   maintenance?: boolean;            // Auto-renew certificates
   production?: boolean;             // Use production ACME servers
   forwardChallenges?: {             // Forward ACME challenges
@@ -76,16 +76,16 @@ export interface IAdvancedOptions {
  */
 export interface IForwardConfig {
   // Define the primary forwarding type - use-case driven approach
-  type: ForwardingType;
-  
+  type: TForwardingType;
+
   // Target configuration
   target: ITargetConfig;
-  
+
   // Protocol options
   http?: IHttpOptions;
   https?: IHttpsOptions;
   acme?: IAcmeForwardingOptions;
-  
+
   // Security and advanced options
   security?: ISecurityOptions;
   advanced?: IAdvancedOptions;

package/ts/forwarding/config/index.ts

@@ -0,0 +1,7 @@
+/**
+ * Forwarding configuration exports
+ */
+
+export * from './forwarding-types.js';
+export * from './domain-config.js';
+export * from './domain-manager.js';

package/ts/{smartproxy/forwarding/forwarding.factory.ts → forwarding/factory/forwarding-factory.ts}

@@ -1,8 +1,9 @@
-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';
+import type { IForwardConfig } from '../config/forwarding-types.js';
+import { ForwardingHandler } from '../handlers/base-handler.js';
+import { HttpForwardingHandler } from '../handlers/http-handler.js';
+import { HttpsPassthroughHandler } from '../handlers/https-passthrough-handler.js';
+import { HttpsTerminateToHttpHandler } from '../handlers/https-terminate-to-http-handler.js';
+import { HttpsTerminateToHttpsHandler } from '../handlers/https-terminate-to-https-handler.js';
 
 /**
  * Factory for creating forwarding handlers based on the configuration type
@@ -13,27 +14,27 @@ export class ForwardingHandlerFactory {
    * @param config The forwarding configuration
    * @returns The appropriate forwarding handler
    */
-  public static createHandler(config: IForwardConfig): IForwardingHandler {
+  public static createHandler(config: IForwardConfig): ForwardingHandler {
     // 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

package/ts/forwarding/factory/index.ts

@@ -0,0 +1,5 @@
+/**
+ * Forwarding factory implementations
+ */
+
+export { ForwardingHandlerFactory } from './forwarding-factory.js';

package/ts/{smartproxy/forwarding/forwarding.handler.ts → forwarding/handlers/base-handler.ts}

@@ -2,8 +2,8 @@ import * as plugins from '../../plugins.js';
 import type {
   IForwardConfig,
   IForwardingHandler
-} from '../types/forwarding.types.js';
-import { ForwardingHandlerEvents } from '../types/forwarding.types.js';
+} from '../config/forwarding-types.js';
+import { ForwardingHandlerEvents } from '../config/forwarding-types.js';
 
 /**
  * Base class for all forwarding handlers

package/ts/{smartproxy/forwarding/http.handler.ts → forwarding/handlers/http-handler.ts}

@@ -1,7 +1,7 @@
 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';
+import { ForwardingHandler } from './base-handler.js';
+import type { IForwardConfig } from '../config/forwarding-types.js';
+import { ForwardingHandlerEvents } from '../config/forwarding-types.js';
 
 /**
  * Handler for HTTP-only forwarding
@@ -13,12 +13,21 @@ export class HttpForwardingHandler extends ForwardingHandler {
    */
   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}`);
     }
   }
+
+  /**
+   * Initialize the handler
+   * HTTP handler doesn't need special initialization
+   */
+  public async initialize(): Promise<void> {
+    // Basic initialization from parent class
+    await super.initialize();
+  }
   
   /**
    * Handle a raw socket connection

package/ts/{smartproxy/forwarding/https-passthrough.handler.ts → forwarding/handlers/https-passthrough-handler.ts}

@@ -1,7 +1,7 @@
 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';
+import { ForwardingHandler } from './base-handler.js';
+import type { IForwardConfig } from '../config/forwarding-types.js';
+import { ForwardingHandlerEvents } from '../config/forwarding-types.js';
 
 /**
  * Handler for HTTPS passthrough (SNI forwarding without termination)
@@ -13,12 +13,21 @@ export class HttpsPassthroughHandler extends ForwardingHandler {
    */
   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}`);
     }
   }
+
+  /**
+   * Initialize the handler
+   * HTTPS passthrough handler doesn't need special initialization
+   */
+  public async initialize(): Promise<void> {
+    // Basic initialization from parent class
+    await super.initialize();
+  }
   
   /**
    * Handle a TLS/SSL socket connection by forwarding it without termination

package/ts/{smartproxy/forwarding/https-terminate-to-http.handler.ts → forwarding/handlers/https-terminate-to-http-handler.ts}

@@ -1,7 +1,7 @@
 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';
+import { ForwardingHandler } from './base-handler.js';
+import type { IForwardConfig } from '../config/forwarding-types.js';
+import { ForwardingHandlerEvents } from '../config/forwarding-types.js';
 
 /**
  * Handler for HTTPS termination with HTTP backend

package/ts/{smartproxy/forwarding/https-terminate-to-https.handler.ts → forwarding/handlers/https-terminate-to-https-handler.ts}

@@ -1,7 +1,7 @@
 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';
+import { ForwardingHandler } from './base-handler.js';
+import type { IForwardConfig } from '../config/forwarding-types.js';
+import { ForwardingHandlerEvents } from '../config/forwarding-types.js';
 
 /**
  * Handler for HTTPS termination with HTTPS backend

package/ts/forwarding/handlers/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Forwarding handler implementations
+ */
+
+export { ForwardingHandler } from './base-handler.js';
+export { HttpForwardingHandler } from './http-handler.js';
+export { HttpsPassthroughHandler } from './https-passthrough-handler.js';
+export { HttpsTerminateToHttpHandler } from './https-terminate-to-http-handler.js';
+export { HttpsTerminateToHttpsHandler } from './https-terminate-to-https-handler.js';

package/ts/forwarding/index.ts

@@ -0,0 +1,34 @@
+/**
+ * Forwarding system module
+ * Provides a flexible and type-safe way to configure and manage various forwarding strategies
+ */
+
+// Export types and configuration
+export * from './config/forwarding-types.js';
+export * from './config/domain-config.js';
+export * from './config/domain-manager.js';
+
+// Export handlers
+export { ForwardingHandler } from './handlers/base-handler.js';
+export * from './handlers/http-handler.js';
+export * from './handlers/https-passthrough-handler.js';
+export * from './handlers/https-terminate-to-http-handler.js';
+export * from './handlers/https-terminate-to-https-handler.js';
+
+// Export factory
+export * from './factory/forwarding-factory.js';
+
+// Helper functions as a convenience object
+import {
+  httpOnly,
+  tlsTerminateToHttp,
+  tlsTerminateToHttps,
+  httpsPassthrough
+} from './config/forwarding-types.js';
+
+export const helpers = {
+  httpOnly,
+  tlsTerminateToHttp,
+  tlsTerminateToHttps,
+  httpsPassthrough
+};

package/ts/http/index.ts

@@ -0,0 +1,23 @@
+/**
+ * HTTP functionality module
+ */
+
+// Export types and models
+export * from './models/http-types.js';
+
+// Export submodules
+export * from './port80/index.js';
+export * from './router/index.js';
+export * from './redirects/index.js';
+
+// Import the components we need for the namespace
+import { Port80Handler } from './port80/port80-handler.js';
+import { ChallengeResponder } from './port80/challenge-responder.js';
+
+// Convenience namespace exports
+export const Http = {
+  Port80: {
+    Handler: Port80Handler,
+    ChallengeResponder: ChallengeResponder
+  }
+};

package/ts/http/models/http-types.ts

@@ -0,0 +1,105 @@
+import * as plugins from '../../plugins.js';
+import type {
+  IForwardConfig,
+  IDomainOptions,
+  IAcmeOptions
+} from '../../certificate/models/certificate-types.js';
+
+/**
+ * HTTP-specific event types
+ */
+export enum HttpEvents {
+  REQUEST_RECEIVED = 'request-received',
+  REQUEST_FORWARDED = 'request-forwarded',
+  REQUEST_HANDLED = 'request-handled',
+  REQUEST_ERROR = 'request-error',
+}
+
+/**
+ * HTTP status codes as an enum for better type safety
+ */
+export enum HttpStatus {
+  OK = 200,
+  MOVED_PERMANENTLY = 301,
+  FOUND = 302,
+  TEMPORARY_REDIRECT = 307,
+  PERMANENT_REDIRECT = 308,
+  BAD_REQUEST = 400,
+  NOT_FOUND = 404,
+  METHOD_NOT_ALLOWED = 405,
+  INTERNAL_SERVER_ERROR = 500,
+  NOT_IMPLEMENTED = 501,
+  SERVICE_UNAVAILABLE = 503,
+}
+
+/**
+ * Represents a domain configuration with certificate status information
+ */
+export interface IDomainCertificate {
+  options: IDomainOptions;
+  certObtained: boolean;
+  obtainingInProgress: boolean;
+  certificate?: string;
+  privateKey?: string;
+  expiryDate?: Date;
+  lastRenewalAttempt?: Date;
+}
+
+/**
+ * Base error class for HTTP-related errors
+ */
+export class HttpError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'HttpError';
+  }
+}
+
+/**
+ * Error related to certificate operations
+ */
+export class CertificateError extends HttpError {
+  constructor(
+    message: string,
+    public readonly domain: string,
+    public readonly isRenewal: boolean = false
+  ) {
+    super(`${message} for domain ${domain}${isRenewal ? ' (renewal)' : ''}`);
+    this.name = 'CertificateError';
+  }
+}
+
+/**
+ * Error related to server operations
+ */
+export class ServerError extends HttpError {
+  constructor(message: string, public readonly code?: string) {
+    super(message);
+    this.name = 'ServerError';
+  }
+}
+
+/**
+ * Redirect configuration for HTTP requests
+ */
+export interface IRedirectConfig {
+  source: string;           // Source path or pattern
+  destination: string;      // Destination URL
+  type: HttpStatus;         // Redirect status code
+  preserveQuery?: boolean;  // Whether to preserve query parameters
+}
+
+/**
+ * HTTP router configuration
+ */
+export interface IRouterConfig {
+  routes: Array<{
+    path: string;
+    handler: (req: plugins.http.IncomingMessage, res: plugins.http.ServerResponse) => void;
+  }>;
+  notFoundHandler?: (req: plugins.http.IncomingMessage, res: plugins.http.ServerResponse) => void;
+}
+
+// Backward compatibility interfaces
+export { HttpError as Port80HandlerError };
+export { CertificateError as CertError };