@push.rocks/smartproxy 15.0.2 → 16.0.2

package/ts/proxies/smart-proxy/utils/index.ts

@@ -0,0 +1,40 @@
+/**
+ * SmartProxy Route Utilities
+ *
+ * This file exports all route-related utilities for the SmartProxy module,
+ * including helpers, validators, utilities, and patterns for working with routes.
+ */
+
+// Export route helpers for creating routes
+export * from './route-helpers.js';
+
+// Export route validators for validating route configurations
+export * from './route-validators.js';
+
+// Export route utilities for route operations
+export * from './route-utils.js';
+
+// Export route patterns with renamed exports to avoid conflicts
+import {
+  createWebSocketRoute as createWebSocketPatternRoute,
+  createLoadBalancerRoute as createLoadBalancerPatternRoute,
+  createApiGatewayRoute,
+  createStaticFileServerRoute,
+  addRateLimiting,
+  addBasicAuth,
+  addJwtAuth
+} from './route-patterns.js';
+
+export {
+  createWebSocketPatternRoute,
+  createLoadBalancerPatternRoute,
+  createApiGatewayRoute,
+  createStaticFileServerRoute,
+  addRateLimiting,
+  addBasicAuth,
+  addJwtAuth
+};
+
+// Export migration utilities for transitioning from domain-based to route-based configs
+// Note: These will be removed in a future version once migration is complete
+export * from './route-migration-utils.js';

package/ts/proxies/smart-proxy/utils/route-helpers.ts

@@ -0,0 +1,455 @@
+/**
+ * Route Helper Functions
+ *
+ * This file provides utility functions for creating route configurations for common scenarios.
+ * These functions aim to simplify the creation of route configurations for typical use cases.
+ *
+ * This module includes helper functions for creating:
+ * - HTTP routes (createHttpRoute)
+ * - HTTPS routes with TLS termination (createHttpsTerminateRoute)
+ * - HTTP to HTTPS redirects (createHttpToHttpsRedirect)
+ * - HTTPS passthrough routes (createHttpsPassthroughRoute)
+ * - Complete HTTPS servers with redirects (createCompleteHttpsServer)
+ * - Load balancer routes (createLoadBalancerRoute)
+ * - Static file server routes (createStaticFileRoute)
+ * - API routes (createApiRoute)
+ * - WebSocket routes (createWebSocketRoute)
+ */
+
+import type { IRouteConfig, IRouteMatch, IRouteAction, IRouteTarget, TPortRange } from '../models/route-types.js';
+
+/**
+ * Create an HTTP-only route configuration
+ * @param domains Domain(s) to match
+ * @param target Target host and port
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createHttpRoute(
+  domains: string | string[],
+  target: { host: string | string[]; port: number },
+  options: Partial<IRouteConfig> = {}
+): IRouteConfig {
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.match?.ports || 80,
+    domains
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'forward',
+    target
+  };
+
+  // Create the route config
+  return {
+    match,
+    action,
+    name: options.name || `HTTP Route for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    ...options
+  };
+}
+
+/**
+ * Create an HTTPS route with TLS termination (including HTTP redirect to HTTPS)
+ * @param domains Domain(s) to match
+ * @param target Target host and port
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createHttpsTerminateRoute(
+  domains: string | string[],
+  target: { host: string | string[]; port: number },
+  options: {
+    certificate?: 'auto' | { key: string; cert: string };
+    httpPort?: number | number[];
+    httpsPort?: number | number[];
+    reencrypt?: boolean;
+    name?: string;
+    [key: string]: any;
+  } = {}
+): IRouteConfig {
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.httpsPort || 443,
+    domains
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'forward',
+    target,
+    tls: {
+      mode: options.reencrypt ? 'terminate-and-reencrypt' : 'terminate',
+      certificate: options.certificate || 'auto'
+    }
+  };
+
+  // Create the route config
+  return {
+    match,
+    action,
+    name: options.name || `HTTPS Route for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    ...options
+  };
+}
+
+/**
+ * Create an HTTP to HTTPS redirect route
+ * @param domains Domain(s) to match
+ * @param httpsPort HTTPS port to redirect to (default: 443)
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createHttpToHttpsRedirect(
+  domains: string | string[],
+  httpsPort: number = 443,
+  options: Partial<IRouteConfig> = {}
+): IRouteConfig {
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.match?.ports || 80,
+    domains
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'redirect',
+    redirect: {
+      to: `https://{domain}:${httpsPort}{path}`,
+      status: 301
+    }
+  };
+
+  // Create the route config
+  return {
+    match,
+    action,
+    name: options.name || `HTTP to HTTPS Redirect for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    ...options
+  };
+}
+
+/**
+ * Create an HTTPS passthrough route (SNI-based forwarding without TLS termination)
+ * @param domains Domain(s) to match
+ * @param target Target host and port
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createHttpsPassthroughRoute(
+  domains: string | string[],
+  target: { host: string | string[]; port: number },
+  options: Partial<IRouteConfig> = {}
+): IRouteConfig {
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.match?.ports || 443,
+    domains
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'forward',
+    target,
+    tls: {
+      mode: 'passthrough'
+    }
+  };
+
+  // Create the route config
+  return {
+    match,
+    action,
+    name: options.name || `HTTPS Passthrough for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    ...options
+  };
+}
+
+/**
+ * Create a complete HTTPS server with HTTP to HTTPS redirects
+ * @param domains Domain(s) to match
+ * @param target Target host and port
+ * @param options Additional configuration options
+ * @returns Array of two route configurations (HTTPS and HTTP redirect)
+ */
+export function createCompleteHttpsServer(
+  domains: string | string[],
+  target: { host: string | string[]; port: number },
+  options: {
+    certificate?: 'auto' | { key: string; cert: string };
+    httpPort?: number | number[];
+    httpsPort?: number | number[];
+    reencrypt?: boolean;
+    name?: string;
+    [key: string]: any;
+  } = {}
+): IRouteConfig[] {
+  // Create the HTTPS route
+  const httpsRoute = createHttpsTerminateRoute(domains, target, options);
+  
+  // Create the HTTP redirect route
+  const httpRedirectRoute = createHttpToHttpsRedirect(
+    domains,
+    // Extract the HTTPS port from the HTTPS route - ensure it's a number
+    typeof options.httpsPort === 'number' ? options.httpsPort :
+      Array.isArray(options.httpsPort) ? options.httpsPort[0] : 443,
+    {
+      // Set the HTTP port
+      match: {
+        ports: options.httpPort || 80,
+        domains
+      },
+      name: `HTTP to HTTPS Redirect for ${Array.isArray(domains) ? domains.join(', ') : domains}`
+    }
+  );
+  
+  return [httpsRoute, httpRedirectRoute];
+}
+
+/**
+ * Create a load balancer route (round-robin between multiple backend hosts)
+ * @param domains Domain(s) to match
+ * @param hosts Array of backend hosts to load balance between
+ * @param port Backend port
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createLoadBalancerRoute(
+  domains: string | string[],
+  hosts: string[],
+  port: number,
+  options: {
+    tls?: {
+      mode: 'passthrough' | 'terminate' | 'terminate-and-reencrypt';
+      certificate?: 'auto' | { key: string; cert: string };
+    };
+    [key: string]: any;
+  } = {}
+): IRouteConfig {
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.match?.ports || (options.tls ? 443 : 80),
+    domains
+  };
+
+  // Create route target
+  const target: IRouteTarget = {
+    host: hosts,
+    port
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'forward',
+    target
+  };
+
+  // Add TLS configuration if provided
+  if (options.tls) {
+    action.tls = {
+      mode: options.tls.mode,
+      certificate: options.tls.certificate || 'auto'
+    };
+  }
+
+  // Create the route config
+  return {
+    match,
+    action,
+    name: options.name || `Load Balancer for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    ...options
+  };
+}
+
+/**
+ * Create a static file server route
+ * @param domains Domain(s) to match
+ * @param rootDir Root directory path for static files
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createStaticFileRoute(
+  domains: string | string[],
+  rootDir: string,
+  options: {
+    indexFiles?: string[];
+    serveOnHttps?: boolean;
+    certificate?: 'auto' | { key: string; cert: string };
+    httpPort?: number | number[];
+    httpsPort?: number | number[];
+    name?: string;
+    [key: string]: any;
+  } = {}
+): IRouteConfig {
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.serveOnHttps
+      ? (options.httpsPort || 443)
+      : (options.httpPort || 80),
+    domains
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'static',
+    static: {
+      root: rootDir,
+      index: options.indexFiles || ['index.html', 'index.htm']
+    }
+  };
+
+  // Add TLS configuration if serving on HTTPS
+  if (options.serveOnHttps) {
+    action.tls = {
+      mode: 'terminate',
+      certificate: options.certificate || 'auto'
+    };
+  }
+
+  // Create the route config
+  return {
+    match,
+    action,
+    name: options.name || `Static Files for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    ...options
+  };
+}
+
+/**
+ * Create an API route configuration
+ * @param domains Domain(s) to match
+ * @param apiPath API base path (e.g., "/api")
+ * @param target Target host and port
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createApiRoute(
+  domains: string | string[],
+  apiPath: string,
+  target: { host: string | string[]; port: number },
+  options: {
+    useTls?: boolean;
+    certificate?: 'auto' | { key: string; cert: string };
+    addCorsHeaders?: boolean;
+    httpPort?: number | number[];
+    httpsPort?: number | number[];
+    name?: string;
+    [key: string]: any;
+  } = {}
+): IRouteConfig {
+  // Normalize API path
+  const normalizedPath = apiPath.startsWith('/') ? apiPath : `/${apiPath}`;
+  const pathWithWildcard = normalizedPath.endsWith('/')
+    ? `${normalizedPath}*`
+    : `${normalizedPath}/*`;
+
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.useTls
+      ? (options.httpsPort || 443)
+      : (options.httpPort || 80),
+    domains,
+    path: pathWithWildcard
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'forward',
+    target
+  };
+
+  // Add TLS configuration if using HTTPS
+  if (options.useTls) {
+    action.tls = {
+      mode: 'terminate',
+      certificate: options.certificate || 'auto'
+    };
+  }
+
+  // Add CORS headers if requested
+  const headers: Record<string, Record<string, string>> = {};
+  if (options.addCorsHeaders) {
+    headers.response = {
+      'Access-Control-Allow-Origin': '*',
+      'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
+      'Access-Control-Allow-Headers': 'Content-Type, Authorization',
+      'Access-Control-Max-Age': '86400'
+    };
+  }
+
+  // Create the route config
+  return {
+    match,
+    action,
+    headers: Object.keys(headers).length > 0 ? headers : undefined,
+    name: options.name || `API Route ${normalizedPath} for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    priority: options.priority || 100, // Higher priority for specific path matches
+    ...options
+  };
+}
+
+/**
+ * Create a WebSocket route configuration
+ * @param domains Domain(s) to match
+ * @param wsPath WebSocket path (e.g., "/ws")
+ * @param target Target WebSocket server host and port
+ * @param options Additional route options
+ * @returns Route configuration object
+ */
+export function createWebSocketRoute(
+  domains: string | string[],
+  wsPath: string,
+  target: { host: string | string[]; port: number },
+  options: {
+    useTls?: boolean;
+    certificate?: 'auto' | { key: string; cert: string };
+    httpPort?: number | number[];
+    httpsPort?: number | number[];
+    pingInterval?: number;
+    pingTimeout?: number;
+    name?: string;
+    [key: string]: any;
+  } = {}
+): IRouteConfig {
+  // Normalize WebSocket path
+  const normalizedPath = wsPath.startsWith('/') ? wsPath : `/${wsPath}`;
+
+  // Create route match
+  const match: IRouteMatch = {
+    ports: options.useTls
+      ? (options.httpsPort || 443)
+      : (options.httpPort || 80),
+    domains,
+    path: normalizedPath
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'forward',
+    target,
+    websocket: {
+      enabled: true,
+      pingInterval: options.pingInterval || 30000, // 30 seconds
+      pingTimeout: options.pingTimeout || 5000    // 5 seconds
+    }
+  };
+
+  // Add TLS configuration if using HTTPS
+  if (options.useTls) {
+    action.tls = {
+      mode: 'terminate',
+      certificate: options.certificate || 'auto'
+    };
+  }
+
+  // Create the route config
+  return {
+    match,
+    action,
+    name: options.name || `WebSocket Route ${normalizedPath} for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
+    priority: options.priority || 100, // Higher priority for WebSocket routes
+    ...options
+  };
+}

package/ts/proxies/smart-proxy/utils/route-migration-utils.ts

@@ -0,0 +1,165 @@
+/**
+ * Route Migration Utilities
+ * 
+ * This file provides utility functions for migrating from legacy domain-based
+ * configuration to the new route-based configuration system. These functions
+ * are temporary and will be removed after the migration is complete.
+ */
+
+import type { TForwardingType } from '../../../forwarding/config/forwarding-types.js';
+import type { IRouteConfig, IRouteMatch, IRouteAction, IRouteTarget } from '../models/route-types.js';
+
+/**
+ * Legacy domain config interface (for migration only)
+ * @deprecated This interface will be removed in a future version
+ */
+export interface ILegacyDomainConfig {
+  domains: string[];
+  forwarding: {
+    type: TForwardingType;
+    target: {
+      host: string | string[];
+      port: number;
+    };
+    [key: string]: any;
+  };
+}
+
+/**
+ * Convert a legacy domain config to a route-based config
+ * @param domainConfig Legacy domain configuration
+ * @param additionalOptions Additional options to add to the route
+ * @returns Route configuration
+ * @deprecated This function will be removed in a future version
+ */
+export function domainConfigToRouteConfig(
+  domainConfig: ILegacyDomainConfig,
+  additionalOptions: Partial<IRouteConfig> = {}
+): IRouteConfig {
+  // Default port based on forwarding type
+  let defaultPort = 80;
+  let tlsMode: 'passthrough' | 'terminate' | 'terminate-and-reencrypt' | undefined;
+
+  switch (domainConfig.forwarding.type) {
+    case 'http-only':
+      defaultPort = 80;
+      break;
+    case 'https-passthrough':
+      defaultPort = 443;
+      tlsMode = 'passthrough';
+      break;
+    case 'https-terminate-to-http':
+      defaultPort = 443;
+      tlsMode = 'terminate';
+      break;
+    case 'https-terminate-to-https':
+      defaultPort = 443;
+      tlsMode = 'terminate-and-reencrypt';
+      break;
+  }
+
+  // Create route match criteria
+  const match: IRouteMatch = {
+    ports: additionalOptions.match?.ports || defaultPort,
+    domains: domainConfig.domains
+  };
+
+  // Create route target
+  const target: IRouteTarget = {
+    host: domainConfig.forwarding.target.host,
+    port: domainConfig.forwarding.target.port
+  };
+
+  // Create route action
+  const action: IRouteAction = {
+    type: 'forward',
+    target
+  };
+
+  // Add TLS configuration if needed
+  if (tlsMode) {
+    action.tls = {
+      mode: tlsMode,
+      certificate: 'auto'
+    };
+
+    // If the legacy config has custom certificates, use them
+    if (domainConfig.forwarding.https?.customCert) {
+      action.tls.certificate = {
+        key: domainConfig.forwarding.https.customCert.key,
+        cert: domainConfig.forwarding.https.customCert.cert
+      };
+    }
+  }
+
+  // Add security options if present
+  if (domainConfig.forwarding.security) {
+    action.security = domainConfig.forwarding.security;
+  }
+
+  // Create the route config
+  const routeConfig: IRouteConfig = {
+    match,
+    action,
+    // Include a name based on domains if not provided
+    name: additionalOptions.name || `Legacy route for ${domainConfig.domains.join(', ')}`,
+    // Include a note that this was converted from a legacy config
+    description: additionalOptions.description || 'Converted from legacy domain configuration'
+  };
+
+  // Add optional properties if provided
+  if (additionalOptions.priority !== undefined) {
+    routeConfig.priority = additionalOptions.priority;
+  }
+  
+  if (additionalOptions.tags) {
+    routeConfig.tags = additionalOptions.tags;
+  }
+
+  return routeConfig;
+}
+
+/**
+ * Convert an array of legacy domain configs to route configurations
+ * @param domainConfigs Array of legacy domain configurations
+ * @returns Array of route configurations
+ * @deprecated This function will be removed in a future version
+ */
+export function domainConfigsToRouteConfigs(
+  domainConfigs: ILegacyDomainConfig[]
+): IRouteConfig[] {
+  return domainConfigs.map(config => domainConfigToRouteConfig(config));
+}
+
+/**
+ * Extract domains from a route configuration
+ * @param route Route configuration
+ * @returns Array of domains
+ */
+export function extractDomainsFromRoute(route: IRouteConfig): string[] {
+  if (!route.match.domains) {
+    return [];
+  }
+  
+  return Array.isArray(route.match.domains)
+    ? route.match.domains
+    : [route.match.domains];
+}
+
+/**
+ * Extract domains from an array of route configurations
+ * @param routes Array of route configurations
+ * @returns Array of unique domains
+ */
+export function extractDomainsFromRoutes(routes: IRouteConfig[]): string[] {
+  const domains = new Set<string>();
+  
+  for (const route of routes) {
+    const routeDomains = extractDomainsFromRoute(route);
+    for (const domain of routeDomains) {
+      domains.add(domain);
+    }
+  }
+  
+  return Array.from(domains);
+}