@push.rocks/smartproxy 16.0.2 → 16.0.3

package/ts/core/utils/route-utils.ts

@@ -0,0 +1,312 @@
+/**
+ * Route matching utilities for SmartProxy components
+ * 
+ * Contains shared logic for domain matching, path matching, and IP matching
+ * to be used by different proxy components throughout the system.
+ */
+
+/**
+ * Match a domain pattern against a domain
+ * 
+ * @param pattern Domain pattern with optional wildcards (e.g., "*.example.com")
+ * @param domain Domain to match against the pattern
+ * @returns Whether the domain matches the pattern
+ */
+export function matchDomain(pattern: string, domain: string): boolean {
+  // Handle exact match (case-insensitive)
+  if (pattern.toLowerCase() === domain.toLowerCase()) {
+    return true;
+  }
+
+  // Handle wildcard pattern
+  if (pattern.includes('*')) {
+    const regexPattern = pattern
+      .replace(/\./g, '\\.')  // Escape dots
+      .replace(/\*/g, '.*');  // Convert * to .*
+
+    const regex = new RegExp(`^${regexPattern}$`, 'i');
+    return regex.test(domain);
+  }
+
+  return false;
+}
+
+/**
+ * Match domains from a route against a given domain
+ * 
+ * @param domains Array or single domain pattern to match against
+ * @param domain Domain to match
+ * @returns Whether the domain matches any of the patterns
+ */
+export function matchRouteDomain(domains: string | string[] | undefined, domain: string | undefined): boolean {
+  // If no domains specified in the route, match all domains
+  if (!domains) {
+    return true;
+  }
+
+  // If no domain in the request, can't match domain-specific routes
+  if (!domain) {
+    return false;
+  }
+  
+  const patterns = Array.isArray(domains) ? domains : [domains];
+  return patterns.some(pattern => matchDomain(pattern, domain));
+}
+
+/**
+ * Match a path pattern against a path
+ * 
+ * @param pattern Path pattern with optional wildcards
+ * @param path Path to match against the pattern
+ * @returns Whether the path matches the pattern
+ */
+export function matchPath(pattern: string, path: string): boolean {
+  // Handle exact match
+  if (pattern === path) {
+    return true;
+  }
+
+  // Handle simple wildcard at the end (like /api/*)
+  if (pattern.endsWith('*')) {
+    const prefix = pattern.slice(0, -1);
+    return path.startsWith(prefix);
+  }
+
+  // Handle more complex wildcard patterns
+  if (pattern.includes('*')) {
+    const regexPattern = pattern
+      .replace(/\./g, '\\.')   // Escape dots
+      .replace(/\*/g, '.*')    // Convert * to .*
+      .replace(/\//g, '\\/');  // Escape slashes
+    
+    const regex = new RegExp(`^${regexPattern}$`);
+    return regex.test(path);
+  }
+
+  return false;
+}
+
+/**
+ * Parse CIDR notation into subnet and mask bits
+ * 
+ * @param cidr CIDR string (e.g., "192.168.1.0/24")
+ * @returns Object with subnet and bits, or null if invalid
+ */
+export function parseCidr(cidr: string): { subnet: string; bits: number } | null {
+  try {
+    const [subnet, bitsStr] = cidr.split('/');
+    const bits = parseInt(bitsStr, 10);
+    
+    if (isNaN(bits) || bits < 0 || bits > 32) {
+      return null;
+    }
+    
+    return { subnet, bits };
+  } catch (e) {
+    return null;
+  }
+}
+
+/**
+ * Convert an IP address to a numeric value
+ * 
+ * @param ip IPv4 address string (e.g., "192.168.1.1")
+ * @returns Numeric representation of the IP
+ */
+export function ipToNumber(ip: string): number {
+  // Handle IPv6-mapped IPv4 addresses (::ffff:192.168.1.1)
+  if (ip.startsWith('::ffff:')) {
+    ip = ip.slice(7);
+  }
+  
+  const parts = ip.split('.').map(part => parseInt(part, 10));
+  return (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8) | parts[3];
+}
+
+/**
+ * Match an IP against a CIDR pattern
+ * 
+ * @param cidr CIDR pattern (e.g., "192.168.1.0/24")
+ * @param ip IP to match against the pattern
+ * @returns Whether the IP is in the CIDR range
+ */
+export function matchIpCidr(cidr: string, ip: string): boolean {
+  const parsed = parseCidr(cidr);
+  if (!parsed) {
+    return false;
+  }
+  
+  try {
+    const { subnet, bits } = parsed;
+    
+    // Normalize IPv6-mapped IPv4 addresses
+    const normalizedIp = ip.startsWith('::ffff:') ? ip.substring(7) : ip;
+    const normalizedSubnet = subnet.startsWith('::ffff:') ? subnet.substring(7) : subnet;
+    
+    // Convert IP addresses to numeric values
+    const ipNum = ipToNumber(normalizedIp);
+    const subnetNum = ipToNumber(normalizedSubnet);
+    
+    // Calculate subnet mask
+    const maskNum = ~(2 ** (32 - bits) - 1);
+    
+    // Check if IP is in subnet
+    return (ipNum & maskNum) === (subnetNum & maskNum);
+  } catch (e) {
+    return false;
+  }
+}
+
+/**
+ * Match an IP pattern against an IP
+ * 
+ * @param pattern IP pattern (exact, CIDR, or with wildcards)
+ * @param ip IP to match against the pattern
+ * @returns Whether the IP matches the pattern
+ */
+export function matchIpPattern(pattern: string, ip: string): boolean {
+  // Normalize IPv6-mapped IPv4 addresses
+  const normalizedIp = ip.startsWith('::ffff:') ? ip.substring(7) : ip;
+  const normalizedPattern = pattern.startsWith('::ffff:') ? pattern.substring(7) : pattern;
+  
+  // Handle exact match with all variations
+  if (pattern === ip || normalizedPattern === normalizedIp || 
+      pattern === normalizedIp || normalizedPattern === ip) {
+    return true;
+  }
+  
+  // Handle "all" wildcard
+  if (pattern === '*' || normalizedPattern === '*') {
+    return true;
+  }
+  
+  // Handle CIDR notation (e.g., 192.168.1.0/24)
+  if (pattern.includes('/')) {
+    return matchIpCidr(pattern, normalizedIp) || 
+           (normalizedPattern !== pattern && matchIpCidr(normalizedPattern, normalizedIp));
+  }
+  
+  // Handle glob pattern (e.g., 192.168.1.*)
+  if (pattern.includes('*')) {
+    const regexPattern = pattern.replace(/\./g, '\\.').replace(/\*/g, '.*');
+    const regex = new RegExp(`^${regexPattern}$`);
+    if (regex.test(ip) || regex.test(normalizedIp)) {
+      return true;
+    }
+    
+    // If pattern was normalized, also test with normalized pattern
+    if (normalizedPattern !== pattern) {
+      const normalizedRegexPattern = normalizedPattern.replace(/\./g, '\\.').replace(/\*/g, '.*');
+      const normalizedRegex = new RegExp(`^${normalizedRegexPattern}$`);
+      return normalizedRegex.test(ip) || normalizedRegex.test(normalizedIp);
+    }
+  }
+  
+  return false;
+}
+
+/**
+ * Match an IP against allowed and blocked IP patterns
+ * 
+ * @param ip IP to check
+ * @param allowedIps Array of allowed IP patterns
+ * @param blockedIps Array of blocked IP patterns
+ * @returns Whether the IP is allowed
+ */
+export function isIpAuthorized(
+  ip: string, 
+  allowedIps: string[] = ['*'], 
+  blockedIps: string[] = []
+): boolean {
+  // Check blocked IPs first
+  if (blockedIps.length > 0) {
+    for (const pattern of blockedIps) {
+      if (matchIpPattern(pattern, ip)) {
+        return false; // IP is blocked
+      }
+    }
+  }
+  
+  // If there are allowed IPs, check them
+  if (allowedIps.length > 0) {
+    // Special case: if '*' is in allowed IPs, all non-blocked IPs are allowed
+    if (allowedIps.includes('*')) {
+      return true;
+    }
+    
+    for (const pattern of allowedIps) {
+      if (matchIpPattern(pattern, ip)) {
+        return true; // IP is allowed
+      }
+    }
+    return false; // IP not in allowed list
+  }
+  
+  // No allowed IPs specified, so IP is allowed by default
+  return true;
+}
+
+/**
+ * Match an HTTP header pattern against a header value
+ * 
+ * @param pattern Expected header value (string or RegExp)
+ * @param value Actual header value
+ * @returns Whether the header matches the pattern
+ */
+export function matchHeader(pattern: string | RegExp, value: string): boolean {
+  if (typeof pattern === 'string') {
+    return pattern === value;
+  } else if (pattern instanceof RegExp) {
+    return pattern.test(value);
+  }
+  return false;
+}
+
+/**
+ * Calculate route specificity score
+ * Higher score means more specific matching criteria
+ * 
+ * @param match Match criteria to evaluate
+ * @returns Numeric specificity score
+ */
+export function calculateRouteSpecificity(match: {
+  domains?: string | string[];
+  path?: string;
+  clientIp?: string[];
+  tlsVersion?: string[];
+  headers?: Record<string, string | RegExp>;
+}): number {
+  let score = 0;
+  
+  // Path is very specific
+  if (match.path) {
+    // More specific if it doesn't use wildcards
+    score += match.path.includes('*') ? 3 : 4;
+  }
+  
+  // Domain is next most specific
+  if (match.domains) {
+    const domains = Array.isArray(match.domains) ? match.domains : [match.domains];
+    // More domains or more specific domains (without wildcards) increase specificity
+    score += domains.length;
+    // Add bonus for exact domains (without wildcards)
+    score += domains.some(d => !d.includes('*')) ? 1 : 0;
+  }
+  
+  // Headers are quite specific
+  if (match.headers) {
+    score += Object.keys(match.headers).length * 2;
+  }
+  
+  // Client IP adds some specificity
+  if (match.clientIp && match.clientIp.length > 0) {
+    score += 1;
+  }
+  
+  // TLS version adds minimal specificity
+  if (match.tlsVersion && match.tlsVersion.length > 0) {
+    score += 1;
+  }
+  
+  return score;
+}

package/ts/core/utils/security-utils.ts

@@ -0,0 +1,309 @@
+import * as plugins from '../../plugins.js';
+import { 
+  matchIpPattern, 
+  ipToNumber,
+  matchIpCidr
+} from './route-utils.js';
+
+/**
+ * Security utilities for IP validation, rate limiting, 
+ * authentication, and other security features
+ */
+
+/**
+ * Result of IP validation
+ */
+export interface IIpValidationResult {
+  allowed: boolean;
+  reason?: string;
+}
+
+/**
+ * IP connection tracking information
+ */
+export interface IIpConnectionInfo {
+  connections: Set<string>;  // ConnectionIDs
+  timestamps: number[];      // Connection timestamps
+  ipVariants: string[];      // Normalized IP variants (e.g., ::ffff:127.0.0.1 and 127.0.0.1)
+}
+
+/**
+ * Rate limit tracking
+ */
+export interface IRateLimitInfo {
+  count: number;
+  expiry: number;
+}
+
+/**
+ * Logger interface for security utilities
+ */
+export interface ISecurityLogger {
+  info: (message: string, ...args: any[]) => void;
+  warn: (message: string, ...args: any[]) => void;
+  error: (message: string, ...args: any[]) => void;
+  debug?: (message: string, ...args: any[]) => void;
+}
+
+/**
+ * Normalize IP addresses for comparison
+ * Handles IPv4-mapped IPv6 addresses (::ffff:127.0.0.1)
+ * 
+ * @param ip IP address to normalize
+ * @returns Array of equivalent IP representations
+ */
+export function normalizeIP(ip: string): string[] {
+  if (!ip) return [];
+  
+  // Handle IPv4-mapped IPv6 addresses (::ffff:127.0.0.1)
+  if (ip.startsWith('::ffff:')) {
+    const ipv4 = ip.slice(7);
+    return [ip, ipv4];
+  }
+  
+  // Handle IPv4 addresses by also checking IPv4-mapped form
+  if (/^\d{1,3}(\.\d{1,3}){3}$/.test(ip)) {
+    return [ip, `::ffff:${ip}`];
+  }
+  
+  return [ip];
+}
+
+/**
+ * Check if an IP is authorized based on allow and block lists
+ *
+ * @param ip - The IP address to check
+ * @param allowedIPs - Array of allowed IP patterns
+ * @param blockedIPs - Array of blocked IP patterns
+ * @returns Whether the IP is authorized
+ */
+export function isIPAuthorized(
+  ip: string, 
+  allowedIPs: string[] = ['*'], 
+  blockedIPs: string[] = []
+): boolean {
+  // Skip IP validation if no rules
+  if (!ip || (allowedIPs.length === 0 && blockedIPs.length === 0)) {
+    return true;
+  }
+
+  // First check if IP is blocked - blocked IPs take precedence
+  if (blockedIPs.length > 0) {
+    for (const pattern of blockedIPs) {
+      if (matchIpPattern(pattern, ip)) {
+        return false;
+      }
+    }
+  }
+
+  // If allowed IPs list has wildcard, all non-blocked IPs are allowed
+  if (allowedIPs.includes('*')) {
+    return true;
+  }
+
+  // Then check if IP is allowed in the explicit allow list
+  if (allowedIPs.length > 0) {
+    for (const pattern of allowedIPs) {
+      if (matchIpPattern(pattern, ip)) {
+        return true;
+      }
+    }
+    // If allowedIPs is specified but no match, deny access
+    return false;
+  }
+
+  // Default allow if no explicit allow list
+  return true;
+}
+
+/**
+ * Check if an IP exceeds maximum connections
+ *
+ * @param ip - The IP address to check
+ * @param ipConnectionsMap - Map of IPs to connection info
+ * @param maxConnectionsPerIP - Maximum allowed connections per IP
+ * @returns Result with allowed status and reason if blocked
+ */
+export function checkMaxConnections(
+  ip: string,
+  ipConnectionsMap: Map<string, IIpConnectionInfo>,
+  maxConnectionsPerIP: number
+): IIpValidationResult {
+  if (!ipConnectionsMap.has(ip)) {
+    return { allowed: true };
+  }
+
+  const connectionCount = ipConnectionsMap.get(ip)!.connections.size;
+  
+  if (connectionCount >= maxConnectionsPerIP) {
+    return {
+      allowed: false,
+      reason: `Maximum connections per IP (${maxConnectionsPerIP}) exceeded`
+    };
+  }
+
+  return { allowed: true };
+}
+
+/**
+ * Check if an IP exceeds connection rate limit
+ *
+ * @param ip - The IP address to check
+ * @param ipConnectionsMap - Map of IPs to connection info
+ * @param rateLimit - Maximum connections per minute
+ * @returns Result with allowed status and reason if blocked
+ */
+export function checkConnectionRate(
+  ip: string,
+  ipConnectionsMap: Map<string, IIpConnectionInfo>,
+  rateLimit: number
+): IIpValidationResult {
+  const now = Date.now();
+  const minute = 60 * 1000;
+
+  // Get or create connection info
+  if (!ipConnectionsMap.has(ip)) {
+    const info: IIpConnectionInfo = {
+      connections: new Set(),
+      timestamps: [now],
+      ipVariants: normalizeIP(ip)
+    };
+    ipConnectionsMap.set(ip, info);
+    return { allowed: true };
+  }
+
+  // Get timestamps and filter out entries older than 1 minute
+  const info = ipConnectionsMap.get(ip)!;
+  const timestamps = info.timestamps.filter(time => now - time < minute);
+  timestamps.push(now);
+  info.timestamps = timestamps;
+
+  // Check if rate exceeds limit
+  if (timestamps.length > rateLimit) {
+    return {
+      allowed: false,
+      reason: `Connection rate limit (${rateLimit}/min) exceeded`
+    };
+  }
+
+  return { allowed: true };
+}
+
+/**
+ * Track a connection for an IP
+ *
+ * @param ip - The IP address
+ * @param connectionId - The connection ID to track
+ * @param ipConnectionsMap - Map of IPs to connection info
+ */
+export function trackConnection(
+  ip: string,
+  connectionId: string,
+  ipConnectionsMap: Map<string, IIpConnectionInfo>
+): void {
+  if (!ipConnectionsMap.has(ip)) {
+    ipConnectionsMap.set(ip, {
+      connections: new Set([connectionId]),
+      timestamps: [Date.now()],
+      ipVariants: normalizeIP(ip)
+    });
+    return;
+  }
+
+  const info = ipConnectionsMap.get(ip)!;
+  info.connections.add(connectionId);
+}
+
+/**
+ * Remove connection tracking for an IP
+ *
+ * @param ip - The IP address
+ * @param connectionId - The connection ID to remove
+ * @param ipConnectionsMap - Map of IPs to connection info
+ */
+export function removeConnection(
+  ip: string,
+  connectionId: string,
+  ipConnectionsMap: Map<string, IIpConnectionInfo>
+): void {
+  if (!ipConnectionsMap.has(ip)) return;
+
+  const info = ipConnectionsMap.get(ip)!;
+  info.connections.delete(connectionId);
+
+  if (info.connections.size === 0) {
+    ipConnectionsMap.delete(ip);
+  }
+}
+
+/**
+ * Clean up expired rate limits
+ *
+ * @param rateLimits - Map of rate limits to clean up
+ * @param logger - Logger for debug messages
+ */
+export function cleanupExpiredRateLimits(
+  rateLimits: Map<string, Map<string, IRateLimitInfo>>,
+  logger?: ISecurityLogger
+): void {
+  const now = Date.now();
+  let totalRemoved = 0;
+
+  for (const [routeId, routeLimits] of rateLimits.entries()) {
+    let removed = 0;
+    for (const [key, limit] of routeLimits.entries()) {
+      if (limit.expiry < now) {
+        routeLimits.delete(key);
+        removed++;
+        totalRemoved++;
+      }
+    }
+    
+    if (removed > 0 && logger?.debug) {
+      logger.debug(`Cleaned up ${removed} expired rate limits for route ${routeId}`);
+    }
+  }
+  
+  if (totalRemoved > 0 && logger?.info) {
+    logger.info(`Cleaned up ${totalRemoved} expired rate limits total`);
+  }
+}
+
+/**
+ * Generate basic auth header value from username and password
+ *
+ * @param username - The username
+ * @param password - The password
+ * @returns Base64 encoded basic auth string
+ */
+export function generateBasicAuthHeader(username: string, password: string): string {
+  return `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
+}
+
+/**
+ * Parse basic auth header
+ *
+ * @param authHeader - The Authorization header value
+ * @returns Username and password, or null if invalid
+ */
+export function parseBasicAuthHeader(
+  authHeader: string
+): { username: string; password: string } | null {
+  if (!authHeader || !authHeader.startsWith('Basic ')) {
+    return null;
+  }
+
+  try {
+    const base64 = authHeader.slice(6); // Remove 'Basic '
+    const decoded = Buffer.from(base64, 'base64').toString();
+    const [username, password] = decoded.split(':');
+    
+    if (!username || !password) {
+      return null;
+    }
+
+    return { username, password };
+  } catch (err) {
+    return null;
+  }
+}