6.0.1

changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2025-03-25 - 6.0.1 - fix(readme)
+Update README documentation: replace all outdated 'PortProxy' references with 'SmartProxy', adjust architecture diagrams, code examples, and configuration details (including correcting IPTables to NfTables) to reflect the new naming.
+
+- Renamed 'PortProxy' to 'SmartProxy' in diagrams, flow sequences, and descriptive text
+- Updated code examples and installation instructions accordingly
+- Corrected references from IPTables to NfTables for modern system support
+
 ## 2025-03-18 - 5.1.0 - feat(docs)
 docs: replace IPTablesProxy references with NfTablesProxy in README and examples, updating configuration options and diagrams for advanced nftables features
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartproxy",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "private": false,
   "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.",
   "main": "dist_ts/index.js",

readme.md

@@ -15,7 +15,7 @@ flowchart TB
         direction TB
         HTTP80[HTTP Port 80\nSslRedirect]
         HTTPS443[HTTPS Port 443\nNetworkProxy]
-        PortProxy[TCP Port Proxy\nwith SNI routing]
+        SmartProxy[SmartProxy\nwith SNI routing]
         NfTables[NfTablesProxy]
         Router[ProxyRouter]
         ACME[Port80Handler\nACME/Let's Encrypt]
@@ -31,16 +31,16 @@ flowchart TB
     Client -->|HTTP Request| HTTP80
     HTTP80 -->|Redirect| Client
     Client -->|HTTPS Request| HTTPS443
-    Client -->|TLS/TCP| PortProxy
+    Client -->|TLS/TCP| SmartProxy
     
     HTTPS443 -->|Route Request| Router
     Router -->|Proxy Request| Service1
     Router -->|Proxy Request| Service2
     
-    PortProxy -->|Direct TCP| Service2
-    PortProxy -->|Direct TCP| Service3
+    SmartProxy -->|Direct TCP| Service2
+    SmartProxy -->|Direct TCP| Service3
     
-    NfTables -.->|Low-level forwarding| PortProxy
+    NfTables -.->|Low-level forwarding| SmartProxy
     
     HTTP80 -.->|Challenge Response| ACME
     ACME -.->|Generate/Manage| Certs
@@ -51,7 +51,7 @@ flowchart TB
     classDef client fill:#dfd,stroke:#333,stroke-width:2px;
     
     class Client client;
-    class HTTP80,HTTPS443,PortProxy,IPTables,Router,ACME component;
+    class HTTP80,HTTPS443,SmartProxy,NfTables,Router,ACME component;
     class Service1,Service2,Service3 backend;
 ```
 
@@ -98,49 +98,49 @@ sequenceDiagram
     end
 ```
 
-### Port Proxy with SNI-based Routing
+### SNI-based Connection Handling
 This diagram illustrates how TCP connections with SNI (Server Name Indication) are processed and forwarded:
 
 ```mermaid
 sequenceDiagram
     participant Client
-    participant PortProxy
+    participant SmartProxy
     participant Backend
     
-    Client->>PortProxy: TLS Connection
+    Client->>SmartProxy: TLS Connection
     
     alt SNI Enabled
-        PortProxy->>Client: Accept Connection
-        Client->>PortProxy: TLS ClientHello with SNI
-        PortProxy->>PortProxy: Extract SNI Hostname
-        PortProxy->>PortProxy: Match Domain Config
-        PortProxy->>PortProxy: Validate Client IP
+        SmartProxy->>Client: Accept Connection
+        Client->>SmartProxy: TLS ClientHello with SNI
+        SmartProxy->>SmartProxy: Extract SNI Hostname
+        SmartProxy->>SmartProxy: Match Domain Config
+        SmartProxy->>SmartProxy: Validate Client IP
         
         alt IP Allowed
-            PortProxy->>Backend: Forward Connection
-            Note over PortProxy,Backend: Bidirectional Data Flow
+            SmartProxy->>Backend: Forward Connection
+            Note over SmartProxy,Backend: Bidirectional Data Flow
         else IP Rejected
-            PortProxy->>Client: Close Connection
+            SmartProxy->>Client: Close Connection
         end
     else Port-based Routing
-        PortProxy->>PortProxy: Match Port Range
-        PortProxy->>PortProxy: Find Domain Config
-        PortProxy->>PortProxy: Validate Client IP
+        SmartProxy->>SmartProxy: Match Port Range
+        SmartProxy->>SmartProxy: Find Domain Config
+        SmartProxy->>SmartProxy: Validate Client IP
         
         alt IP Allowed
-            PortProxy->>Backend: Forward Connection
-            Note over PortProxy,Backend: Bidirectional Data Flow
+            SmartProxy->>Backend: Forward Connection
+            Note over SmartProxy,Backend: Bidirectional Data Flow
         else IP Rejected
-            PortProxy->>Client: Close Connection
+            SmartProxy->>Client: Close Connection
         end
     end
     
     loop Connection Active
-        PortProxy-->>PortProxy: Monitor Activity
-        PortProxy-->>PortProxy: Check Max Lifetime
+        SmartProxy-->>SmartProxy: Monitor Activity
+        SmartProxy-->>SmartProxy: Check Max Lifetime
         alt Inactivity or Max Lifetime Exceeded
-            PortProxy->>Client: Close Connection
-            PortProxy->>Backend: Close Connection
+            SmartProxy->>Client: Close Connection
+            SmartProxy->>Backend: Close Connection
         end
     end
 ```
@@ -192,7 +192,7 @@ sequenceDiagram
 
 - **HTTPS Reverse Proxy** - Route traffic to backend services based on hostname with TLS termination
 - **WebSocket Support** - Full WebSocket proxying with heartbeat monitoring
-- **TCP Port Forwarding** - Advanced port forwarding with SNI inspection and domain-based routing
+- **TCP Connection Handling** - Advanced connection handling with SNI inspection and domain-based routing
 - **Enhanced TLS Handling** - Robust TLS handshake processing with improved certificate error handling
 - **HTTP to HTTPS Redirection** - Automatically redirect HTTP requests to HTTPS
 - **Let's Encrypt Integration** - Automatic certificate management using ACME protocol
@@ -224,15 +224,16 @@ const proxy = new NetworkProxy({
 const proxyConfigs = [
   {
     hostName: 'example.com',
-    destinationIp: '127.0.0.1',
-    destinationPort: 3000,
+    destinationIps: ['127.0.0.1'],
+    destinationPorts: [3000],
     publicKey: 'your-cert-content',
-    privateKey: 'your-key-content'
+    privateKey: 'your-key-content',
+    rewriteHostHeader: true
   },
   {
     hostName: 'api.example.com',
-    destinationIp: '127.0.0.1',
-    destinationPort: 4000,
+    destinationIps: ['127.0.0.1'],
+    destinationPorts: [4000],
     publicKey: 'your-cert-content',
     privateKey: 'your-key-content',
     // Optional basic auth
@@ -266,13 +267,13 @@ const redirector = new SslRedirect(80);
 redirector.start();
 ```
 
-### TCP Port Forwarding with Domain-based Routing
+### TCP Connection Handling with Domain-based Routing
 
 ```typescript
-import { PortProxy } from '@push.rocks/smartproxy';
+import { SmartProxy } from '@push.rocks/smartproxy';
 
-// Configure port proxy with domain-based routing
-const portProxy = new PortProxy({
+// Configure SmartProxy with domain-based routing
+const smartProxy = new SmartProxy({
   fromPort: 443,
   toPort: 8443,
   targetIP: 'localhost', // Default target host
@@ -312,7 +313,7 @@ const portProxy = new PortProxy({
   preserveSourceIP: true
 });
 
-portProxy.start();
+smartProxy.start();
 ```
 
 ### NfTables Port Forwarding
@@ -376,7 +377,13 @@ await basicProxy.start();
 import { Port80Handler } from '@push.rocks/smartproxy';
 
 // Create an ACME handler for Let's Encrypt
-const acmeHandler = new Port80Handler();
+const acmeHandler = new Port80Handler({
+  port: 80,
+  contactEmail: 'admin@example.com',
+  useProduction: true,  // Use Let's Encrypt production servers (default is staging)
+  renewThresholdDays: 30, // Renew certificates 30 days before expiry
+  httpsRedirectPort: 443 // Redirect HTTP to HTTPS on this port
+});
 
 // Add domains to manage certificates for
 acmeHandler.addDomain({
@@ -407,8 +414,14 @@ acmeHandler.addDomain({
 | Option         | Description                                       | Default |
 |----------------|---------------------------------------------------|---------|
 | `port`         | Port to listen on for HTTPS connections           | -       |
+| `maxConnections` | Maximum concurrent connections                   | 10000    |
+| `keepAliveTimeout` | Keep-alive timeout in milliseconds             | 60000    |
+| `headersTimeout` | Headers timeout in milliseconds                  | 60000    |
+| `logLevel`     | Logging level ('error', 'warn', 'info', 'debug')   | 'info'   |
+| `cors`         | CORS configuration object                         | -        |
+| `rewriteHostHeader` | Whether to rewrite the Host header           | false     |
 
-### PortProxy Settings
+### SmartProxy Settings
 
 | Option                    | Description                                            | Default     |
 |---------------------------|--------------------------------------------------------|-------------|
@@ -460,28 +473,11 @@ acmeHandler.addDomain({
 | `qos`                 | Quality of Service options (object)               | -           |
 | `netProxyIntegration` | NetworkProxy integration options (object)         | -           |
 
-#### NfTablesProxy QoS Options
-
-| Option               | Description                                       | Default |
-|----------------------|---------------------------------------------------|---------|
-| `enabled`            | Enable Quality of Service features                | false   |
-| `maxRate`            | Maximum bandwidth rate (e.g. "10mbps")           | -       |
-| `priority`           | Traffic priority (1-10, 1 is highest)            | -       |
-| `markConnections`    | Mark connections for easier management            | false   |
-
-#### NfTablesProxy NetworkProxy Integration Options
-
-| Option               | Description                                       | Default |
-|----------------------|---------------------------------------------------|---------|
-| `enabled`            | Enable NetworkProxy integration                   | false   |
-| `redirectLocalhost`  | Redirect localhost traffic to NetworkProxy        | false   |
-| `sslTerminationPort` | Port where NetworkProxy handles SSL termination   | -       |
-
 ## Advanced Features
 
 ### TLS Handshake Optimization
 
-The enhanced `PortProxy` implementation includes significant improvements for TLS handshake handling:
+The enhanced `SmartProxy` implementation includes significant improvements for TLS handshake handling:
 
 - Robust SNI extraction with improved error handling
 - Increased buffer size for complex TLS handshakes (10MB)
@@ -492,7 +488,7 @@ The enhanced `PortProxy` implementation includes significant improvements for TL
 
 ```typescript
 // Example configuration to solve Chrome certificate errors
-const portProxy = new PortProxy({
+const portProxy = new SmartProxy({
   // ... other settings
   initialDataTimeout: 60000,            // Give browser more time for handshake
   maxPendingDataSize: 10 * 1024 * 1024, // Larger buffer for complex handshakes
@@ -502,7 +498,7 @@ const portProxy = new PortProxy({
 
 ### Connection Management and Monitoring
 
-The `PortProxy` class includes built-in connection tracking and monitoring:
+The `SmartProxy` class includes built-in connection tracking and monitoring:
 
 - Automatic cleanup of idle connections with configurable timeouts
 - Timeouts for connections that exceed maximum lifetime
@@ -521,7 +517,7 @@ The `NetworkProxy` class provides WebSocket support with:
 
 ### SNI-based Routing
 
-The `PortProxy` class can inspect the SNI (Server Name Indication) field in TLS handshakes to route connections based on the requested domain:
+The `SmartProxy` class can inspect the SNI (Server Name Indication) field in TLS handshakes to route connections based on the requested domain:
 
 - Multiple backend targets per domain
 - Round-robin load balancing
@@ -530,7 +526,7 @@ The `PortProxy` class can inspect the SNI (Server Name Indication) field in TLS
 
 ### Enhanced NfTables Management
 
-The `NfTablesProxy` class offers advanced capabilities compared to the previous IPTablesProxy:
+The `NfTablesProxy` class offers advanced capabilities:
 
 - Support for multiple port ranges and individual ports
 - More efficient IP filtering using nftables sets
@@ -544,7 +540,7 @@ The `NfTablesProxy` class offers advanced capabilities compared to the previous
 
 ### Port80Handler with Glob Pattern Support
 
-The `Port80Handler` class now includes support for glob pattern domain matching:
+The `Port80Handler` class includes support for glob pattern domain matching:
 
 - Supports wildcard domains like `*.example.com` for HTTP request routing
 - Detects glob patterns and skips certificate issuance for them
@@ -566,7 +562,7 @@ If you experience certificate errors in browsers, especially in Chrome, try thes
 
 ```typescript
 // Configuration to fix Chrome certificate errors
-const portProxy = new PortProxy({
+const smartProxy = new SmartProxy({
   // ... other settings
   initialDataTimeout: 60000,
   maxPendingDataSize: 10 * 1024 * 1024,
@@ -585,14 +581,14 @@ For improved connection stability in high-traffic environments:
 4. **Monitor Connection Statistics**: Enable detailed logging to track termination reasons
 5. **Fine-tune Inactivity Checks**: Adjust `inactivityCheckInterval` based on your traffic patterns
 
-### IPTables Troubleshooting
+### NfTables Troubleshooting
 
-If you're experiencing issues with IPTablesProxy:
+If you're experiencing issues with NfTablesProxy:
 
 1. **Enable Detailed Logging**: Set `enableLogging: true` to see all rule operations
 2. **Force Clean Slate**: Use `forceCleanSlate: true` to remove any lingering rules
-3. **Use Custom Chains**: Enable `addJumpRule: true` for cleaner rule management
-4. **Check Permissions**: Ensure your process has sufficient permissions to modify iptables
+3. **Use IP Sets**: Enable `useIPSets: true` for cleaner rule management
+4. **Check Permissions**: Ensure your process has sufficient permissions to modify nftables
 5. **Verify IPv6 Support**: If using `ipv6Support: true`, ensure ip6tables is available
 
 ## License and Legal Information

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartproxy',
-  version: '5.1.0',
+  version: '6.0.1',
   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.'
 }