@push.rocks/smartproxy 12.0.0 → 13.1.2

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartproxy',
-  version: '12.0.0',
+  version: '13.1.2',
   description: 'A powerful proxy package that effectively handles high traffic, with features such as SSL/TLS support, port proxying, WebSocket handling, dynamic routing with authentication options, and automatic ACME certificate management.'
 }

package/ts/certificate/acme/acme-factory.ts

@@ -0,0 +1,48 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import type { IAcmeOptions } from '../models/certificate-types.js';
+import { ensureCertificateDirectory } from '../utils/certificate-helpers.js';
+// We'll need to update this import when we move the Port80Handler
+import { Port80Handler } from '../../http/port80/port80-handler.js';
+
+/**
+ * Factory to create a Port80Handler with common setup.
+ * Ensures the certificate store directory exists and instantiates the handler.
+ * @param options Port80Handler configuration options
+ * @returns A new Port80Handler instance
+ */
+export function buildPort80Handler(
+  options: IAcmeOptions
+): Port80Handler {
+  if (options.certificateStore) {
+    ensureCertificateDirectory(options.certificateStore);
+    console.log(`Ensured certificate store directory: ${options.certificateStore}`);
+  }
+  return new Port80Handler(options);
+}
+
+/**
+ * Creates default ACME options with sensible defaults
+ * @param email Account email for ACME provider
+ * @param certificateStore Path to store certificates
+ * @param useProduction Whether to use production ACME servers
+ * @returns Configured ACME options
+ */
+export function createDefaultAcmeOptions(
+  email: string,
+  certificateStore: string,
+  useProduction: boolean = false
+): IAcmeOptions {
+  return {
+    accountEmail: email,
+    enabled: true,
+    port: 80,
+    useProduction,
+    httpsRedirectPort: 443,
+    renewThresholdDays: 30,
+    renewCheckIntervalHours: 24,
+    autoRenew: true,
+    certificateStore,
+    skipConfiguredCerts: false
+  };
+}

package/ts/certificate/acme/challenge-handler.ts

@@ -0,0 +1,110 @@
+import * as plugins from '../../plugins.js';
+import type { IAcmeOptions, ICertificateData } from '../models/certificate-types.js';
+import { CertificateEvents } from '../events/certificate-events.js';
+
+/**
+ * Manages ACME challenges and certificate validation
+ */
+export class AcmeChallengeHandler extends plugins.EventEmitter {
+  private options: IAcmeOptions;
+  private client: any; // ACME client from plugins
+  private pendingChallenges: Map<string, any>;
+
+  /**
+   * Creates a new ACME challenge handler
+   * @param options ACME configuration options
+   */
+  constructor(options: IAcmeOptions) {
+    super();
+    this.options = options;
+    this.pendingChallenges = new Map();
+
+    // Initialize ACME client if needed
+    // This is just a placeholder implementation since we don't use the actual
+    // client directly in this implementation - it's handled by Port80Handler
+    this.client = null;
+    console.log('Created challenge handler with options:',
+      options.accountEmail,
+      options.useProduction ? 'production' : 'staging'
+    );
+  }
+
+  /**
+   * Gets or creates the ACME account key
+   */
+  private getAccountKey(): Buffer {
+    // Implementation details would depend on plugin requirements
+    // This is a simplified version
+    if (!this.options.certificateStore) {
+      throw new Error('Certificate store is required for ACME challenges');
+    }
+    
+    // This is just a placeholder - actual implementation would check for
+    // existing account key and create one if needed
+    return Buffer.from('account-key-placeholder');
+  }
+
+  /**
+   * Validates a domain using HTTP-01 challenge
+   * @param domain Domain to validate
+   * @param challengeToken ACME challenge token
+   * @param keyAuthorization Key authorization for the challenge
+   */
+  public async handleHttpChallenge(
+    domain: string,
+    challengeToken: string,
+    keyAuthorization: string
+  ): Promise<void> {
+    // Store challenge for response
+    this.pendingChallenges.set(challengeToken, keyAuthorization);
+    
+    try {
+      // Wait for challenge validation - this would normally be handled by the ACME client
+      await new Promise(resolve => setTimeout(resolve, 1000));
+      this.emit(CertificateEvents.CERTIFICATE_ISSUED, {
+        domain,
+        success: true
+      });
+    } catch (error) {
+      this.emit(CertificateEvents.CERTIFICATE_FAILED, {
+        domain,
+        error: error instanceof Error ? error.message : String(error),
+        isRenewal: false
+      });
+      throw error;
+    } finally {
+      // Clean up the challenge
+      this.pendingChallenges.delete(challengeToken);
+    }
+  }
+
+  /**
+   * Responds to an HTTP-01 challenge request
+   * @param token Challenge token from the request path
+   * @returns The key authorization if found
+   */
+  public getChallengeResponse(token: string): string | null {
+    return this.pendingChallenges.get(token) || null;
+  }
+
+  /**
+   * Checks if a request path is an ACME challenge
+   * @param path Request path
+   * @returns True if this is an ACME challenge request
+   */
+  public isAcmeChallenge(path: string): boolean {
+    return path.startsWith('/.well-known/acme-challenge/');
+  }
+
+  /**
+   * Extracts the challenge token from an ACME challenge path
+   * @param path Request path
+   * @returns The challenge token if valid
+   */
+  public extractChallengeToken(path: string): string | null {
+    if (!this.isAcmeChallenge(path)) return null;
+    
+    const parts = path.split('/');
+    return parts[parts.length - 1] || null;
+  }
+}

package/ts/certificate/acme/index.ts

@@ -0,0 +1,3 @@
+/**
+ * ACME certificate provisioning
+ */

package/ts/certificate/events/certificate-events.ts

@@ -0,0 +1,36 @@
+/**
+ * Certificate-related events emitted by certificate management components
+ */
+export enum CertificateEvents {
+  CERTIFICATE_ISSUED = 'certificate-issued',
+  CERTIFICATE_RENEWED = 'certificate-renewed',
+  CERTIFICATE_FAILED = 'certificate-failed',
+  CERTIFICATE_EXPIRING = 'certificate-expiring',
+  CERTIFICATE_APPLIED = 'certificate-applied',
+  // Events moved from Port80Handler for compatibility
+  MANAGER_STARTED = 'manager-started',
+  MANAGER_STOPPED = 'manager-stopped',
+}
+
+/**
+ * Port80Handler-specific events including certificate-related ones
+ * @deprecated Use CertificateEvents and HttpEvents instead
+ */
+export enum Port80HandlerEvents {
+  CERTIFICATE_ISSUED = 'certificate-issued',
+  CERTIFICATE_RENEWED = 'certificate-renewed',
+  CERTIFICATE_FAILED = 'certificate-failed',
+  CERTIFICATE_EXPIRING = 'certificate-expiring',
+  MANAGER_STARTED = 'manager-started',
+  MANAGER_STOPPED = 'manager-stopped',
+  REQUEST_FORWARDED = 'request-forwarded',
+}
+
+/**
+ * Certificate provider events
+ */
+export enum CertProvisionerEvents {
+  CERTIFICATE_ISSUED = 'certificate',
+  CERTIFICATE_RENEWED = 'certificate',
+  CERTIFICATE_FAILED = 'certificate-failed'
+}

package/ts/certificate/index.ts

@@ -0,0 +1,67 @@
+/**
+ * Certificate management module for SmartProxy
+ * Provides certificate provisioning, storage, and management capabilities
+ */
+
+// Certificate types and models
+export * from './models/certificate-types.js';
+
+// Certificate events
+export * from './events/certificate-events.js';
+
+// Certificate providers
+export * from './providers/cert-provisioner.js';
+
+// ACME related exports
+export * from './acme/acme-factory.js';
+export * from './acme/challenge-handler.js';
+
+// Certificate utilities
+export * from './utils/certificate-helpers.js';
+
+// Certificate storage
+export * from './storage/file-storage.js';
+
+// Convenience function to create a certificate provisioner with common settings
+import { CertProvisioner } from './providers/cert-provisioner.js';
+import { buildPort80Handler } from './acme/acme-factory.js';
+import type { IAcmeOptions, IDomainForwardConfig } from './models/certificate-types.js';
+import type { IDomainConfig } from '../forwarding/config/domain-config.js';
+
+/**
+ * Creates a complete certificate provisioning system with default settings
+ * @param domainConfigs Domain configurations
+ * @param acmeOptions ACME options for certificate provisioning
+ * @param networkProxyBridge Bridge to apply certificates to network proxy
+ * @param certProvider Optional custom certificate provider
+ * @returns Configured CertProvisioner
+ */
+export function createCertificateProvisioner(
+  domainConfigs: IDomainConfig[],
+  acmeOptions: IAcmeOptions,
+  networkProxyBridge: any, // Placeholder until NetworkProxyBridge is migrated
+  certProvider?: any // Placeholder until cert provider type is properly defined
+): CertProvisioner {
+  // Build the Port80Handler for ACME challenges
+  const port80Handler = buildPort80Handler(acmeOptions);
+
+  // Extract ACME-specific configuration
+  const {
+    renewThresholdDays = 30,
+    renewCheckIntervalHours = 24,
+    autoRenew = true,
+    domainForwards = []
+  } = acmeOptions;
+
+  // Create and return the certificate provisioner
+  return new CertProvisioner(
+    domainConfigs,
+    port80Handler,
+    networkProxyBridge,
+    certProvider,
+    renewThresholdDays,
+    renewCheckIntervalHours,
+    autoRenew,
+    domainForwards
+  );
+}

package/ts/certificate/models/certificate-types.ts

@@ -0,0 +1,88 @@
+import * as plugins from '../../plugins.js';
+
+/**
+ * Certificate data structure containing all necessary information
+ * about a certificate
+ */
+export interface ICertificateData {
+  domain: string;
+  certificate: string;
+  privateKey: string;
+  expiryDate: Date;
+  // Optional source and renewal information for event emissions
+  source?: 'static' | 'http01' | 'dns01';
+  isRenewal?: boolean;
+}
+
+/**
+ * Certificates pair (private and public keys)
+ */
+export interface ICertificates {
+  privateKey: string;
+  publicKey: string;
+}
+
+/**
+ * Certificate failure payload type
+ */
+export interface ICertificateFailure {
+  domain: string;
+  error: string;
+  isRenewal: boolean;
+}
+
+/**
+ * Certificate expiry payload type
+ */
+export interface ICertificateExpiring {
+  domain: string;
+  expiryDate: Date;
+  daysRemaining: number;
+}
+
+/**
+ * Domain forwarding configuration
+ */
+export interface IForwardConfig {
+  ip: string;
+  port: number;
+}
+
+/**
+ * Domain-specific forwarding configuration for ACME challenges
+ */
+export interface IDomainForwardConfig {
+  domain: string;
+  forwardConfig?: IForwardConfig;
+  acmeForwardConfig?: IForwardConfig;
+  sslRedirect?: boolean;
+}
+
+/**
+ * Domain configuration options
+ */
+export interface IDomainOptions {
+  domainName: string;
+  sslRedirect: boolean;   // if true redirects the request to port 443
+  acmeMaintenance: boolean; // tries to always have a valid cert for this domain
+  forward?: IForwardConfig; // forwards all http requests to that target
+  acmeForward?: IForwardConfig; // forwards letsencrypt requests to this config
+}
+
+/**
+ * Unified ACME configuration options used across proxies and handlers
+ */
+export interface IAcmeOptions {
+  accountEmail?: string;          // Email for Let's Encrypt account
+  enabled?: boolean;              // Whether ACME is enabled
+  port?: number;                  // Port to listen on for ACME challenges (default: 80)
+  useProduction?: boolean;        // Use production environment (default: staging)
+  httpsRedirectPort?: number;     // Port to redirect HTTP requests to HTTPS (default: 443)
+  renewThresholdDays?: number;    // Days before expiry to renew certificates
+  renewCheckIntervalHours?: number; // How often to check for renewals (in hours)
+  autoRenew?: boolean;            // Whether to automatically renew certificates
+  certificateStore?: string;      // Directory to store certificates
+  skipConfiguredCerts?: boolean;  // Skip domains with existing certificates
+  domainForwards?: IDomainForwardConfig[]; // Domain-specific forwarding configs
+}
+

package/ts/certificate/providers/cert-provisioner.ts

@@ -0,0 +1,326 @@
+import * as plugins from '../../plugins.js';
+import type { IDomainConfig } from '../../forwarding/config/domain-config.js';
+import type { ICertificateData, IDomainForwardConfig, IDomainOptions } from '../models/certificate-types.js';
+import { Port80HandlerEvents, CertProvisionerEvents } from '../events/certificate-events.js';
+import { Port80Handler } from '../../http/port80/port80-handler.js';
+// We need to define this interface until we migrate NetworkProxyBridge
+interface INetworkProxyBridge {
+  applyExternalCertificate(certData: ICertificateData): void;
+}
+
+// This will be imported after NetworkProxyBridge is migrated
+// import type { NetworkProxyBridge } from '../../proxies/smart-proxy/network-proxy-bridge.js';
+
+// For backward compatibility
+export type TSmartProxyCertProvisionObject = plugins.tsclass.network.ICert | 'http01';
+
+/**
+ * Type for static certificate provisioning
+ */
+export type TCertProvisionObject = plugins.tsclass.network.ICert | 'http01' | 'dns01';
+
+/**
+ * CertProvisioner manages certificate provisioning and renewal workflows,
+ * unifying static certificates and HTTP-01 challenges via Port80Handler.
+ */
+export class CertProvisioner extends plugins.EventEmitter {
+  private domainConfigs: IDomainConfig[];
+  private port80Handler: Port80Handler;
+  private networkProxyBridge: INetworkProxyBridge;
+  private certProvisionFunction?: (domain: string) => Promise<TCertProvisionObject>;
+  private forwardConfigs: IDomainForwardConfig[];
+  private renewThresholdDays: number;
+  private renewCheckIntervalHours: number;
+  private autoRenew: boolean;
+  private renewManager?: plugins.taskbuffer.TaskManager;
+  // Track provisioning type per domain
+  private provisionMap: Map<string, 'http01' | 'dns01' | 'static'>;
+
+  /**
+   * @param domainConfigs Array of domain configuration objects
+   * @param port80Handler HTTP-01 challenge handler instance
+   * @param networkProxyBridge Bridge for applying external certificates
+   * @param certProvider Optional callback returning a static cert or 'http01'
+   * @param renewThresholdDays Days before expiry to trigger renewals
+   * @param renewCheckIntervalHours Interval in hours to check for renewals
+   * @param autoRenew Whether to automatically schedule renewals
+   * @param forwardConfigs Domain forwarding configurations for ACME challenges
+   */
+  constructor(
+    domainConfigs: IDomainConfig[],
+    port80Handler: Port80Handler,
+    networkProxyBridge: INetworkProxyBridge,
+    certProvider?: (domain: string) => Promise<TCertProvisionObject>,
+    renewThresholdDays: number = 30,
+    renewCheckIntervalHours: number = 24,
+    autoRenew: boolean = true,
+    forwardConfigs: IDomainForwardConfig[] = []
+  ) {
+    super();
+    this.domainConfigs = domainConfigs;
+    this.port80Handler = port80Handler;
+    this.networkProxyBridge = networkProxyBridge;
+    this.certProvisionFunction = certProvider;
+    this.renewThresholdDays = renewThresholdDays;
+    this.renewCheckIntervalHours = renewCheckIntervalHours;
+    this.autoRenew = autoRenew;
+    this.provisionMap = new Map();
+    this.forwardConfigs = forwardConfigs;
+  }
+
+  /**
+   * Start initial provisioning and schedule renewals.
+   */
+  public async start(): Promise<void> {
+    // Subscribe to Port80Handler certificate events
+    this.setupEventSubscriptions();
+
+    // Apply external forwarding for ACME challenges
+    this.setupForwardingConfigs();
+
+    // Initial provisioning for all domains
+    await this.provisionAllDomains();
+
+    // Schedule renewals if enabled
+    if (this.autoRenew) {
+      this.scheduleRenewals();
+    }
+  }
+
+  /**
+   * Set up event subscriptions for certificate events
+   */
+  private setupEventSubscriptions(): void {
+    // We need to reimplement subscribeToPort80Handler here
+    this.port80Handler.on(Port80HandlerEvents.CERTIFICATE_ISSUED, (data: ICertificateData) => {
+      this.emit(CertProvisionerEvents.CERTIFICATE_ISSUED, { ...data, source: 'http01', isRenewal: false });
+    });
+
+    this.port80Handler.on(Port80HandlerEvents.CERTIFICATE_RENEWED, (data: ICertificateData) => {
+      this.emit(CertProvisionerEvents.CERTIFICATE_RENEWED, { ...data, source: 'http01', isRenewal: true });
+    });
+
+    this.port80Handler.on(Port80HandlerEvents.CERTIFICATE_FAILED, (error) => {
+      this.emit(CertProvisionerEvents.CERTIFICATE_FAILED, error);
+    });
+  }
+
+  /**
+   * Set up forwarding configurations for the Port80Handler
+   */
+  private setupForwardingConfigs(): void {
+    for (const config of this.forwardConfigs) {
+      const domainOptions: IDomainOptions = {
+        domainName: config.domain,
+        sslRedirect: config.sslRedirect || false,
+        acmeMaintenance: false,
+        forward: config.forwardConfig,
+        acmeForward: config.acmeForwardConfig
+      };
+      this.port80Handler.addDomain(domainOptions);
+    }
+  }
+
+  /**
+   * Provision certificates for all configured domains
+   */
+  private async provisionAllDomains(): Promise<void> {
+    const domains = this.domainConfigs.flatMap(cfg => cfg.domains);
+
+    for (const domain of domains) {
+      await this.provisionDomain(domain);
+    }
+  }
+
+  /**
+   * Provision a certificate for a single domain
+   * @param domain Domain to provision
+   */
+  private async provisionDomain(domain: string): Promise<void> {
+    const isWildcard = domain.includes('*');
+    let provision: TCertProvisionObject = 'http01';
+
+    // Try to get a certificate from the provision function
+    if (this.certProvisionFunction) {
+      try {
+        provision = await this.certProvisionFunction(domain);
+      } catch (err) {
+        console.error(`certProvider error for ${domain}:`, err);
+      }
+    } else if (isWildcard) {
+      // No certProvider: cannot handle wildcard without DNS-01 support
+      console.warn(`Skipping wildcard domain without certProvisionFunction: ${domain}`);
+      return;
+    }
+
+    // Handle different provisioning methods
+    if (provision === 'http01') {
+      if (isWildcard) {
+        console.warn(`Skipping HTTP-01 for wildcard domain: ${domain}`);
+        return;
+      }
+
+      this.provisionMap.set(domain, 'http01');
+      this.port80Handler.addDomain({
+        domainName: domain,
+        sslRedirect: true,
+        acmeMaintenance: true
+      });
+    } else if (provision === 'dns01') {
+      // DNS-01 challenges would be handled by the certProvisionFunction
+      this.provisionMap.set(domain, 'dns01');
+      // DNS-01 handling would go here if implemented
+    } else {
+      // Static certificate (e.g., DNS-01 provisioned or user-provided)
+      this.provisionMap.set(domain, 'static');
+      const certObj = provision as plugins.tsclass.network.ICert;
+      const certData: ICertificateData = {
+        domain: certObj.domainName,
+        certificate: certObj.publicKey,
+        privateKey: certObj.privateKey,
+        expiryDate: new Date(certObj.validUntil),
+        source: 'static',
+        isRenewal: false
+      };
+
+      this.networkProxyBridge.applyExternalCertificate(certData);
+      this.emit(CertProvisionerEvents.CERTIFICATE_ISSUED, certData);
+    }
+  }
+
+  /**
+   * Schedule certificate renewals using a task manager
+   */
+  private scheduleRenewals(): void {
+    this.renewManager = new plugins.taskbuffer.TaskManager();
+
+    const renewTask = new plugins.taskbuffer.Task({
+      name: 'CertificateRenewals',
+      taskFunction: async () => await this.performRenewals()
+    });
+
+    const hours = this.renewCheckIntervalHours;
+    const cronExpr = `0 0 */${hours} * * *`;
+
+    this.renewManager.addAndScheduleTask(renewTask, cronExpr);
+    this.renewManager.start();
+  }
+
+  /**
+   * Perform renewals for all domains that need it
+   */
+  private async performRenewals(): Promise<void> {
+    for (const [domain, type] of this.provisionMap.entries()) {
+      // Skip wildcard domains for HTTP-01 challenges
+      if (domain.includes('*') && type === 'http01') continue;
+
+      try {
+        await this.renewDomain(domain, type);
+      } catch (err) {
+        console.error(`Renewal error for ${domain}:`, err);
+      }
+    }
+  }
+
+  /**
+   * Renew a certificate for a specific domain
+   * @param domain Domain to renew
+   * @param provisionType Type of provisioning for this domain
+   */
+  private async renewDomain(domain: string, provisionType: 'http01' | 'dns01' | 'static'): Promise<void> {
+    if (provisionType === 'http01') {
+      await this.port80Handler.renewCertificate(domain);
+    } else if ((provisionType === 'static' || provisionType === 'dns01') && this.certProvisionFunction) {
+      const provision = await this.certProvisionFunction(domain);
+
+      if (provision !== 'http01' && provision !== 'dns01') {
+        const certObj = provision as plugins.tsclass.network.ICert;
+        const certData: ICertificateData = {
+          domain: certObj.domainName,
+          certificate: certObj.publicKey,
+          privateKey: certObj.privateKey,
+          expiryDate: new Date(certObj.validUntil),
+          source: 'static',
+          isRenewal: true
+        };
+
+        this.networkProxyBridge.applyExternalCertificate(certData);
+        this.emit(CertProvisionerEvents.CERTIFICATE_RENEWED, certData);
+      }
+    }
+  }
+
+  /**
+   * Stop all scheduled renewal tasks.
+   */
+  public async stop(): Promise<void> {
+    if (this.renewManager) {
+      this.renewManager.stop();
+    }
+  }
+
+  /**
+   * Request a certificate on-demand for the given domain.
+   * @param domain Domain name to provision
+   */
+  public async requestCertificate(domain: string): Promise<void> {
+    const isWildcard = domain.includes('*');
+
+    // Determine provisioning method
+    let provision: TCertProvisionObject = 'http01';
+
+    if (this.certProvisionFunction) {
+      provision = await this.certProvisionFunction(domain);
+    } else if (isWildcard) {
+      // Cannot perform HTTP-01 on wildcard without certProvider
+      throw new Error(`Cannot request certificate for wildcard domain without certProvisionFunction: ${domain}`);
+    }
+
+    if (provision === 'http01') {
+      if (isWildcard) {
+        throw new Error(`Cannot request HTTP-01 certificate for wildcard domain: ${domain}`);
+      }
+      await this.port80Handler.renewCertificate(domain);
+    } else if (provision === 'dns01') {
+      // DNS-01 challenges would be handled by external mechanisms
+      // This is a placeholder for future implementation
+      console.log(`DNS-01 challenge requested for ${domain}`);
+    } else {
+      // Static certificate (e.g., DNS-01 provisioned) supports wildcards
+      const certObj = provision as plugins.tsclass.network.ICert;
+      const certData: ICertificateData = {
+        domain: certObj.domainName,
+        certificate: certObj.publicKey,
+        privateKey: certObj.privateKey,
+        expiryDate: new Date(certObj.validUntil),
+        source: 'static',
+        isRenewal: false
+      };
+
+      this.networkProxyBridge.applyExternalCertificate(certData);
+      this.emit(CertProvisionerEvents.CERTIFICATE_ISSUED, certData);
+    }
+  }
+
+  /**
+   * Add a new domain for certificate provisioning
+   * @param domain Domain to add
+   * @param options Domain configuration options
+   */
+  public async addDomain(domain: string, options?: {
+    sslRedirect?: boolean;
+    acmeMaintenance?: boolean;
+  }): Promise<void> {
+    const domainOptions: IDomainOptions = {
+      domainName: domain,
+      sslRedirect: options?.sslRedirect || true,
+      acmeMaintenance: options?.acmeMaintenance || true
+    };
+
+    this.port80Handler.addDomain(domainOptions);
+    await this.provisionDomain(domain);
+  }
+}
+
+// For backward compatibility
+export { CertProvisioner as CertificateProvisioner }

package/ts/certificate/providers/index.ts

@@ -0,0 +1,3 @@
+/**
+ * Certificate providers
+ */