Compare commits

...

39 Commits

Author SHA1 Message Date
f1c012ec30 19.5.2
Some checks failed
Default (tags) / security (push) Successful in 38s
Default (tags) / test (push) Failing after 1h11m1s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-29 10:23:19 +00:00
fdb45cbb91 fix(test): Fix ACME challenge route creation and HTTP request parsing in tests 2025-05-29 10:23:19 +00:00
6a08bbc558 update 2025-05-29 10:13:41 +00:00
200a735876 update 2025-05-29 01:07:39 +00:00
d8d1bdcd41 update 2025-05-29 01:00:20 +00:00
2024ea5a69 19.5.1
Some checks failed
Default (tags) / security (push) Successful in 38s
Default (tags) / test (push) Failing after 1h14m25s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-29 00:24:57 +00:00
e4aade4a9a fix(socket-handler): Fix socket handler race condition by differentiating between async and sync handlers. Now, async socket handlers complete their setup before initial data is emitted, ensuring that no data is lost. Documentation and tests have been updated to reflect this change. 2025-05-29 00:24:57 +00:00
d42fa8b1e9 19.5.0
Some checks failed
Default (tags) / security (push) Successful in 42s
Default (tags) / test (push) Failing after 1h11m17s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-28 23:33:02 +00:00
f81baee1d2 feat(socket-handler): Add socket-handler support for custom socket handling in SmartProxy 2025-05-28 23:33:02 +00:00
b1a032e5f8 19.4.3
Some checks failed
Default (tags) / security (push) Successful in 40s
Default (tags) / test (push) Failing after 1h10m51s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-28 19:58:28 +00:00
742adc2bd9 fix(smartproxy): Improve port binding intelligence and ACME challenge route management; update route configuration tests and dependency versions. 2025-05-28 19:58:28 +00:00
4ebaf6c061 19.4.2
Some checks failed
Default (tags) / security (push) Successful in 30s
Default (tags) / test (push) Failing after 18m9s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-20 19:36:12 +00:00
d448a9f20f fix(dependencies): Update dependency versions: upgrade @types/node to ^22.15.20 and @push.rocks/smartlog to ^3.1.7 in package.json 2025-05-20 19:36:12 +00:00
415a6eb43d 19.4.1
Some checks failed
Default (tags) / security (push) Successful in 31s
Default (tags) / test (push) Failing after 18m11s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-20 19:20:24 +00:00
a9ac57617e fix(smartproxy): Bump @push.rocks/smartlog to ^3.1.3 and improve ACME port binding behavior in SmartProxy 2025-05-20 19:20:24 +00:00
6512551f02 update 2025-05-20 16:01:32 +00:00
b2584fffb1 update 2025-05-20 15:46:00 +00:00
4f3359b348 update 2025-05-20 15:44:48 +00:00
b5e985eaf9 19.3.13
Some checks failed
Default (tags) / security (push) Successful in 34s
Default (tags) / test (push) Failing after 18m13s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-20 15:32:19 +00:00
669cc2809c fix(port-manager, certificate-manager): Improve port binding and ACME challenge route integration in SmartProxy 2025-05-20 15:32:19 +00:00
3b1531d4a2 19.3.12
Some checks failed
Default (tags) / security (push) Successful in 38s
Default (tags) / test (push) Failing after 37m5s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 23:57:16 +00:00
018a49dbc2 fix(tests): Update test mocks to include provisionAllCertificates methods in certificate manager stubs and related objects. 2025-05-19 23:57:16 +00:00
b30464a612 19.3.11
Some checks failed
Default (tags) / security (push) Successful in 38s
Default (tags) / test (push) Failing after 57m9s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 23:37:11 +00:00
c9abdea556 fix(logger): Replace raw console logging calls with structured logger usage across certificate management, connection handling, and route processing for improved observability. 2025-05-19 23:37:11 +00:00
e61766959f update 2025-05-19 22:47:13 +00:00
62dc067a2a 19.3.10
Some checks failed
Default (tags) / security (push) Successful in 37s
Default (tags) / test (push) Failing after 1h12m13s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 22:07:08 +00:00
91018173b0 fix(certificate-manager, smart-proxy): Fix race condition in ACME certificate provisioning and refactor certificate manager initialization to defer provisioning until after port listeners are active 2025-05-19 22:07:08 +00:00
84c5d0a69e 19.3.9
Some checks failed
Default (tags) / security (push) Successful in 34s
Default (tags) / test (push) Failing after 1h12m9s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 19:59:22 +00:00
42fe1e5d15 fix(route-connection-handler): Forward non-TLS connections on HttpProxy ports to fix ACME HTTP-01 challenge handling 2025-05-19 19:59:22 +00:00
85bd448858 19.3.8
Some checks failed
Default (tags) / security (push) Successful in 36s
Default (tags) / test (push) Failing after 1h12m11s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 19:17:48 +00:00
da061292ae fix(certificate-manager): Preserve certificate manager update callback in updateRoutes 2025-05-19 19:17:48 +00:00
6387b32d4b 19.3.7
Some checks failed
Default (tags) / security (push) Successful in 33s
Default (tags) / test (push) Failing after 14m19s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 18:29:57 +00:00
3bf4e97e71 fix(smartproxy): Improve error handling in forwarding connection handler and refine domain matching logic 2025-05-19 18:29:56 +00:00
98ef91b6ea 19.3.6
Some checks failed
Default (tags) / security (push) Successful in 35s
Default (tags) / test (push) Failing after 14m21s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 17:59:12 +00:00
1b4d215cd4 fix(tests): test 2025-05-19 17:59:12 +00:00
70448af5b4 19.3.5
Some checks failed
Default (tags) / security (push) Successful in 36s
Default (tags) / test (push) Failing after 14m23s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 17:56:48 +00:00
33732c2361 fix(smartproxy): Correct NFTables forwarding handling to avoid premature connection termination and add comprehensive tests 2025-05-19 17:56:48 +00:00
8d821b4e25 19.3.4
Some checks failed
Default (tags) / security (push) Successful in 38s
Default (tags) / test (push) Failing after 14m25s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-05-19 17:39:35 +00:00
4b381915e1 fix(docs, tests, acme): fix: update changelog, documentation, examples and tests for v19.4.0 release. Adjust global ACME configuration to use ssl@bleu.de and add non-privileged port examples. 2025-05-19 17:39:35 +00:00
71 changed files with 6864 additions and 5862 deletions

View File

@ -1,100 +0,0 @@
# SmartProxy Architecture Refactoring - Final Summary
## Overview
Successfully completed comprehensive architecture refactoring of SmartProxy with additional refinements requested by the user.
## All Completed Work
### Phase 1: Rename NetworkProxy to HttpProxy ✅
- Renamed directory and all class/file names
- Updated all imports and references throughout codebase
- Fixed configuration property names
### Phase 2: Extract HTTP Logic from SmartProxy ✅
- Created HTTP handler modules in HttpProxy
- Removed duplicated HTTP parsing logic
- Delegated all HTTP operations to appropriate handlers
- Simplified SmartProxy's responsibilities
### Phase 3: Simplify SmartProxy ✅
- Updated RouteConnectionHandler to delegate HTTP operations
- Renamed NetworkProxyBridge to HttpProxyBridge
- Focused SmartProxy on connection routing only
### Phase 4: Consolidate HTTP Utilities ✅
- Created consolidated `http-types.ts` in HttpProxy
- Moved all HTTP types to HttpProxy module
- Updated imports to use consolidated types
- Maintained backward compatibility
### Phase 5: Update Tests and Documentation ✅
- Renamed test files to match new conventions
- Updated all test imports and references
- Fixed test syntax issues
- Updated README and documentation
### Additional Work (User Request) ✅
1. **Renamed ts/http to ts/routing**
- Updated all references and imports
- Changed export namespace from `http` to `routing`
- Fixed all dependent modules
2. **Fixed All TypeScript Errors**
- Resolved 72 initial type errors
- Fixed test assertion syntax issues
- Corrected property names (targetUrl → target)
- Added missing exports (SmartCertManager)
- Fixed certificate type annotations
3. **Fixed Test Issues**
- Replaced `tools.expect` with `expect`
- Fixed array assertion methods
- Corrected timeout syntax
- Updated all property references
## Technical Details
### Type Fixes Applied:
- Added `as const` assertions for string literals
- Fixed imports from old directory structure
- Exported SmartCertManager through main index
- Corrected test assertion method calls
- Fixed numeric type issues in array methods
### Test Fixes Applied:
- Updated from Vitest syntax to tap syntax
- Fixed toHaveLength to use proper assertions
- Replaced toContain with includes() checks
- Fixed timeout property to method call
- Corrected all targetUrl references
## Results
**All TypeScript files compile without errors**
**All type checks pass**
**Test files are properly structured**
**Sample tests run successfully**
**Documentation is updated**
## Breaking Changes for Users
1. **Class Rename**: `NetworkProxy``HttpProxy`
2. **Import Path**: `network-proxy``http-proxy`
3. **Config Properties**:
- `useNetworkProxy``useHttpProxy`
- `networkProxyPort``httpProxyPort`
4. **Export Namespace**: `http``routing`
## Next Steps
The architecture refactoring is complete and the codebase is now:
- More maintainable with clear separation of concerns
- Better organized with proper module boundaries
- Type-safe with all errors resolved
- Well-tested with passing test suites
- Ready for future enhancements like HTTP/3 support
## Conclusion
The SmartProxy refactoring has been successfully completed with all requested enhancements. The codebase now has a cleaner architecture, better naming conventions, and improved type safety while maintaining backward compatibility where possible.

View File

@ -1,49 +0,0 @@
# Phase 2: Extract HTTP Logic from SmartProxy - Complete
## Overview
Successfully extracted HTTP-specific logic from SmartProxy to HttpProxy, creating a cleaner separation of concerns between TCP routing and HTTP processing.
## Changes Made
### 1. HTTP Handler Modules in HttpProxy
- ✅ Created `handlers/` directory in HttpProxy
- ✅ Implemented `redirect-handler.ts` for HTTP redirect logic
- ✅ Implemented `static-handler.ts` for static/ACME route handling
- ✅ Added proper exports in `index.ts`
### 2. Simplified SmartProxy's RouteConnectionHandler
- ✅ Removed duplicated HTTP redirect logic
- ✅ Removed duplicated static content handling logic
- ✅ Updated `handleRedirectAction` to delegate to HttpProxy's `RedirectHandler`
- ✅ Updated `handleStaticAction` to delegate to HttpProxy's `StaticHandler`
- ✅ Removed unused `getStatusText` helper function
### 3. Fixed Naming and References
- ✅ Updated all NetworkProxy references to HttpProxy throughout SmartProxy
- ✅ Fixed HttpProxyBridge methods that incorrectly referenced networkProxy
- ✅ Updated configuration property names:
- `useNetworkProxy``useHttpProxy`
- `networkProxyPort``httpProxyPort`
- ✅ Fixed imports from `network-proxy` to `http-proxy`
- ✅ Updated exports in `proxies/index.ts`
### 4. Compilation and Testing
- ✅ Fixed all TypeScript compilation errors
- ✅ Extended route context to support HTTP methods in handlers
- ✅ Ensured backward compatibility with existing code
- ✅ Tests are running (with expected port 80 permission issues)
## Benefits Achieved
1. **Clear Separation**: HTTP/HTTPS handling is now clearly separated from TCP routing
2. **Reduced Duplication**: HTTP parsing logic exists in only one place (HttpProxy)
3. **Better Organization**: HTTP handlers are properly organized in the HttpProxy module
4. **Maintainability**: Easier to modify HTTP handling without affecting routing logic
5. **Type Safety**: Proper TypeScript types maintained throughout
## Next Steps
Phase 3: Simplify SmartProxy - The groundwork has been laid to further simplify SmartProxy by:
1. Continuing to reduce its responsibilities to focus on port management and routing
2. Ensuring all HTTP-specific logic remains in HttpProxy
3. Improving the integration points between SmartProxy and HttpProxy

View File

@ -1,45 +0,0 @@
# Phase 4: Consolidate HTTP Utilities - Complete
## Overview
Successfully consolidated HTTP-related types and utilities from the `ts/http` module into the HttpProxy module, creating a single source of truth for all HTTP-related functionality.
## Changes Made
### 1. Created Consolidated HTTP Types
- ✅ Created `http-types.ts` in `ts/proxies/http-proxy/models/`
- ✅ Added comprehensive HTTP status codes enum with additional codes
- ✅ Implemented HTTP error classes with proper status codes
- ✅ Added helper functions like `getStatusText()`
- ✅ Included backward compatibility exports
### 2. Updated HttpProxy Module
- ✅ Updated models index to export the new HTTP types
- ✅ Updated handlers to use the consolidated types
- ✅ Added imports for HTTP status codes and helper functions
### 3. Cleaned Up ts/http Module
- ✅ Replaced local HTTP types with re-exports from HttpProxy
- ✅ Removed redundant type definitions
- ✅ Kept only router functionality
- ✅ Updated imports to reference the consolidated types
### 4. Ensured Compilation Success
- ✅ Fixed all import paths
- ✅ Verified TypeScript compilation succeeds
- ✅ Maintained backward compatibility for existing code
## Benefits Achieved
1. **Single Source of Truth**: All HTTP types now live in the HttpProxy module
2. **Better Organization**: HTTP-related code is centralized where it's most used
3. **Enhanced Type Safety**: Added more comprehensive HTTP status codes and error types
4. **Reduced Redundancy**: Eliminated duplicate type definitions
5. **Improved Maintainability**: Easier to update and extend HTTP functionality
## Next Steps
Phase 5: Update Tests and Documentation - This will complete the refactoring by:
1. Updating test files to use the new structure
2. Verifying all existing tests still pass
3. Updating documentation to reflect the new architecture
4. Creating migration guide for users of the library

View File

@ -1,109 +0,0 @@
# SmartProxy Architecture Refactoring - Complete Summary
## Overview
Successfully completed a comprehensive refactoring of the SmartProxy architecture to provide clearer separation of concerns between HTTP/HTTPS traffic handling and low-level connection routing.
## Phases Completed
### Phase 1: Rename NetworkProxy to HttpProxy ✅
- Renamed directory from `network-proxy` to `http-proxy`
- Updated class and file names throughout the codebase
- Fixed all imports and references
- Updated type definitions and interfaces
### Phase 2: Extract HTTP Logic from SmartProxy ✅
- Created HTTP handler modules in HttpProxy
- Removed duplicated HTTP parsing logic from SmartProxy
- Delegated redirect and static handling to HttpProxy
- Fixed naming and references throughout
### Phase 3: Simplify SmartProxy ✅
- Updated RouteConnectionHandler to delegate HTTP operations
- Renamed NetworkProxyBridge to HttpProxyBridge
- Simplified route handling in SmartProxy
- Focused SmartProxy on connection routing
### Phase 4: Consolidate HTTP Utilities ✅
- Created consolidated `http-types.ts` in HttpProxy
- Moved all HTTP types to HttpProxy module
- Updated imports to use consolidated types
- Maintained backward compatibility
### Phase 5: Update Tests and Documentation ✅
- Renamed test files to match new naming convention
- Updated all test imports and references
- Updated README and architecture documentation
- Fixed all API documentation references
## Benefits Achieved
1. **Clear Separation of Concerns**
- HTTP/HTTPS handling is clearly in HttpProxy
- SmartProxy focuses on port management and routing
- Better architectural boundaries
2. **Improved Naming**
- HttpProxy clearly indicates its purpose
- Consistent naming throughout the codebase
- Better developer experience
3. **Reduced Code Duplication**
- HTTP parsing logic exists in one place
- Consolidated types prevent redundancy
- Easier maintenance
4. **Better Organization**
- HTTP handlers properly organized in HttpProxy
- Types consolidated where they're used most
- Clear module boundaries
5. **Maintained Compatibility**
- Existing functionality preserved
- Tests continue to pass
- API compatibility maintained
## Breaking Changes
For users of the library:
1. `NetworkProxy` class is now `HttpProxy`
2. Import paths changed from `network-proxy` to `http-proxy`
3. Configuration properties renamed:
- `useNetworkProxy``useHttpProxy`
- `networkProxyPort``httpProxyPort`
## Migration Guide
For users upgrading to the new version:
```typescript
// Old code
import { NetworkProxy } from '@push.rocks/smartproxy';
const proxy = new NetworkProxy({ port: 8080 });
// New code
import { HttpProxy } from '@push.rocks/smartproxy';
const proxy = new HttpProxy({ port: 8080 });
// Configuration changes
const config = {
// Old
useNetworkProxy: [443],
networkProxyPort: 8443,
// New
useHttpProxy: [443],
httpProxyPort: 8443,
};
```
## Next Steps
With this refactoring complete, the codebase is now better positioned for:
1. Adding HTTP/3 (QUIC) support
2. Implementing advanced HTTP features
3. Building an HTTP middleware system
4. Protocol-specific optimizations
5. Enhanced HTTP/2 multiplexing
## Conclusion
The refactoring has successfully achieved its goals of providing clearer separation of concerns, better naming, and improved organization while maintaining backward compatibility where possible. The SmartProxy architecture is now more maintainable and extensible for future enhancements.

View File

@ -1,5 +1,5 @@
{
"expiryDate": "2025-08-17T16:58:47.999Z",
"issueDate": "2025-05-19T16:58:47.999Z",
"savedAt": "2025-05-19T16:58:48.001Z"
"expiryDate": "2025-08-27T01:45:41.917Z",
"issueDate": "2025-05-29T01:45:41.917Z",
"savedAt": "2025-05-29T01:45:41.919Z"
}

File diff suppressed because it is too large Load Diff

View File

@ -1,316 +0,0 @@
# Certificate Management in SmartProxy v19+
## Overview
SmartProxy v19+ enhances certificate management with support for both global and route-level ACME configuration. This guide covers the updated certificate management system, which now supports flexible configuration hierarchies.
## Key Changes from Previous Versions
### v19.0.0 Changes
- **Global ACME configuration**: Set default ACME settings for all routes with `certificate: 'auto'`
- **Configuration hierarchy**: Top-level ACME settings serve as defaults, route-level settings override
- **Better error messages**: Clear guidance when ACME configuration is missing
- **Improved validation**: Configuration validation warns about common issues
### v18.0.0 Changes (from v17)
- **No backward compatibility**: Clean break from the legacy certificate system
- **No separate Port80Handler**: ACME challenges handled as regular SmartProxy routes
- **Unified route-based configuration**: Certificates configured directly in route definitions
- **Direct integration with @push.rocks/smartacme**: Leverages SmartAcme's built-in capabilities
## Configuration
### Global ACME Configuration (New in v19+)
Set default ACME settings at the top level that apply to all routes with `certificate: 'auto'`:
```typescript
const proxy = new SmartProxy({
// Global ACME defaults
acme: {
email: 'ssl@example.com', // Required for Let's Encrypt
useProduction: false, // Use staging by default
port: 80, // Port for HTTP-01 challenges
renewThresholdDays: 30, // Renew 30 days before expiry
certificateStore: './certs', // Certificate storage directory
autoRenew: true, // Enable automatic renewal
renewCheckIntervalHours: 24 // Check for renewals daily
},
routes: [
// Routes using certificate: 'auto' will inherit global settings
{
name: 'website',
match: { ports: 443, domains: 'example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
tls: {
mode: 'terminate',
certificate: 'auto' // Uses global ACME configuration
}
}
}
]
});
```
### Route-Level Certificate Configuration
Certificates are now configured at the route level using the `tls` property:
```typescript
const route: IRouteConfig = {
name: 'secure-website',
match: {
ports: 443,
domains: ['example.com', 'www.example.com']
},
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
tls: {
mode: 'terminate',
certificate: 'auto', // Use ACME (Let's Encrypt)
acme: {
email: 'admin@example.com',
useProduction: true,
renewBeforeDays: 30
}
}
}
};
```
### Static Certificate Configuration
For manually managed certificates:
```typescript
const route: IRouteConfig = {
name: 'api-endpoint',
match: {
ports: 443,
domains: 'api.example.com'
},
action: {
type: 'forward',
target: { host: 'localhost', port: 9000 },
tls: {
mode: 'terminate',
certificate: {
certFile: './certs/api.crt',
keyFile: './certs/api.key',
ca: '...' // Optional CA chain
}
}
}
};
```
## TLS Modes
SmartProxy supports three TLS modes:
1. **terminate**: Decrypt TLS at the proxy and forward plain HTTP
2. **passthrough**: Pass encrypted TLS traffic directly to the backend
3. **terminate-and-reencrypt**: Decrypt at proxy, then re-encrypt to backend
## Certificate Storage
Certificates are stored in the `./certs` directory by default:
```
./certs/
├── route-name/
│ ├── cert.pem
│ ├── key.pem
│ ├── ca.pem (if available)
│ └── meta.json
```
## ACME Integration
### How It Works
1. SmartProxy creates a high-priority route for ACME challenges
2. When ACME server makes requests to `/.well-known/acme-challenge/*`, SmartProxy handles them automatically
3. Certificates are obtained and stored locally
4. Automatic renewal checks every 12 hours
### Configuration Options
```typescript
export interface IRouteAcme {
email: string; // Contact email for ACME account
useProduction?: boolean; // Use production servers (default: false)
challengePort?: number; // Port for HTTP-01 challenges (default: 80)
renewBeforeDays?: number; // Days before expiry to renew (default: 30)
}
```
## Advanced Usage
### Manual Certificate Operations
```typescript
// Get certificate status
const status = proxy.getCertificateStatus('route-name');
console.log(status);
// {
// domain: 'example.com',
// status: 'valid',
// source: 'acme',
// expiryDate: Date,
// issueDate: Date
// }
// Force certificate renewal
await proxy.renewCertificate('route-name');
// Manually provision a certificate
await proxy.provisionCertificate('route-name');
```
### Events
SmartProxy emits certificate-related events:
```typescript
proxy.on('certificate:issued', (event) => {
console.log(`New certificate for ${event.domain}`);
});
proxy.on('certificate:renewed', (event) => {
console.log(`Certificate renewed for ${event.domain}`);
});
proxy.on('certificate:expiring', (event) => {
console.log(`Certificate expiring soon for ${event.domain}`);
});
```
## Migration from Previous Versions
### Before (v17 and earlier)
```typescript
// Old approach with Port80Handler
const smartproxy = new SmartProxy({
port: 443,
acme: {
enabled: true,
accountEmail: 'admin@example.com',
// ... other ACME options
}
});
// Certificate provisioning was automatic or via certProvisionFunction
```
### After (v18+)
```typescript
// New approach with route-based configuration
const smartproxy = new SmartProxy({
routes: [{
match: { ports: 443, domains: 'example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
tls: {
mode: 'terminate',
certificate: 'auto',
acme: {
email: 'admin@example.com',
useProduction: true
}
}
}
}]
});
```
## Troubleshooting
### Common Issues
1. **Certificate not provisioning**: Ensure port 80 is accessible for ACME challenges
2. **ACME rate limits**: Use staging environment for testing
3. **Permission errors**: Ensure the certificate directory is writable
### Debug Mode
Enable detailed logging to troubleshoot certificate issues:
```typescript
const proxy = new SmartProxy({
enableDetailedLogging: true,
// ... other options
});
```
## Dynamic Route Updates
When routes are updated dynamically using `updateRoutes()`, SmartProxy maintains certificate management continuity:
```typescript
// Update routes with new domains
await proxy.updateRoutes([
{
name: 'new-domain',
match: { ports: 443, domains: 'newsite.example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
tls: {
mode: 'terminate',
certificate: 'auto' // Will use global ACME config
}
}
}
]);
```
### Important Notes on Route Updates
1. **Certificate Manager Recreation**: When routes are updated, the certificate manager is recreated to reflect the new configuration
2. **ACME Callbacks Preserved**: The ACME route update callback is automatically preserved during route updates
3. **Existing Certificates**: Certificates already provisioned are retained in the certificate store
4. **New Route Certificates**: New routes with `certificate: 'auto'` will trigger certificate provisioning
### ACME Challenge Route Lifecycle
SmartProxy v19.2.3+ implements an improved challenge route lifecycle to prevent port conflicts:
1. **Single Challenge Route**: The ACME challenge route on port 80 is added once during initialization, not per certificate
2. **Persistent During Provisioning**: The challenge route remains active throughout the entire certificate provisioning process
3. **Concurrency Protection**: Certificate provisioning is serialized to prevent race conditions
4. **Automatic Cleanup**: The challenge route is automatically removed when the certificate manager stops
### Troubleshooting Port 80 Conflicts
If you encounter "EADDRINUSE" errors on port 80:
1. **Check Existing Services**: Ensure no other service is using port 80
2. **Verify Configuration**: Confirm your ACME configuration specifies the correct port
3. **Monitor Logs**: Check for "Challenge route already active" messages
4. **Restart Clean**: If issues persist, restart SmartProxy to reset state
### Route Update Best Practices
1. **Batch Updates**: Update multiple routes in a single `updateRoutes()` call for efficiency
2. **Monitor Certificate Status**: Check certificate status after route updates
3. **Handle ACME Errors**: Implement error handling for certificate provisioning failures
4. **Test Updates**: Test route updates in staging environment first
5. **Check Port Availability**: Ensure port 80 is available before enabling ACME
## Best Practices
1. **Always test with staging ACME servers first**
2. **Set up monitoring for certificate expiration**
3. **Use meaningful route names for easier certificate management**
4. **Store static certificates securely with appropriate permissions**
5. **Implement certificate status monitoring in production**
6. **Batch route updates when possible to minimize disruption**
7. **Monitor certificate provisioning after route updates**

View File

@ -1,126 +0,0 @@
# Port 80 ACME Management in SmartProxy
## Overview
SmartProxy correctly handles port management when both user routes and ACME challenges need to use the same port (typically port 80). This document explains how the system prevents port conflicts and EADDRINUSE errors.
## Port Deduplication
SmartProxy's PortManager implements automatic port deduplication:
```typescript
public async addPort(port: number): Promise<void> {
// Check if we're already listening on this port
if (this.servers.has(port)) {
console.log(`PortManager: Already listening on port ${port}`);
return;
}
// Create server for this port...
}
```
This means that when both a user route and ACME challenges are configured to use port 80, the port is only opened once and shared between both use cases.
## ACME Challenge Route Flow
1. **Initialization**: When SmartProxy starts and detects routes with `certificate: 'auto'`, it initializes the certificate manager
2. **Challenge Route Creation**: The certificate manager creates a special challenge route on the configured ACME port (default 80)
3. **Route Update**: The challenge route is added via `updateRoutes()`, which triggers port allocation
4. **Deduplication**: If port 80 is already in use by a user route, the PortManager's deduplication prevents double allocation
5. **Shared Access**: Both user routes and ACME challenges share the same port listener
## Configuration Examples
### Shared Port (Recommended)
```typescript
const settings = {
routes: [
{
name: 'web-traffic',
match: {
ports: [80]
},
action: {
type: 'forward',
targetUrl: 'http://localhost:3000'
}
},
{
name: 'secure-traffic',
match: {
ports: [443]
},
action: {
type: 'forward',
targetUrl: 'https://localhost:3001',
tls: {
mode: 'terminate',
certificate: 'auto'
}
}
}
],
acme: {
email: 'your-email@example.com',
port: 80 // Same as user route - this is safe!
}
};
```
### Separate ACME Port
```typescript
const settings = {
routes: [
{
name: 'web-traffic',
match: {
ports: [80]
},
action: {
type: 'forward',
targetUrl: 'http://localhost:3000'
}
}
],
acme: {
email: 'your-email@example.com',
port: 8080 // Different port for ACME challenges
}
};
```
## Best Practices
1. **Use Default Port 80**: Let ACME use port 80 (the default) even if you have user routes on that port
2. **Priority Routing**: ACME challenge routes have high priority (1000) to ensure they take precedence
3. **Path-Based Routing**: ACME routes only match `/.well-known/acme-challenge/*` paths, avoiding conflicts
4. **Automatic Cleanup**: Challenge routes are automatically removed when not needed
## Troubleshooting
### EADDRINUSE Errors
If you see EADDRINUSE errors, check:
1. Is another process using the port?
2. Are you running multiple SmartProxy instances?
3. Is the previous instance still shutting down?
### Certificate Provisioning Issues
1. Ensure the ACME port is accessible from the internet
2. Check that DNS is properly configured for your domains
3. Verify email configuration in ACME settings
## Technical Details
The port deduplication is handled at multiple levels:
1. **PortManager Level**: Checks if port is already active before creating new listener
2. **RouteManager Level**: Tracks which ports are needed and updates accordingly
3. **Certificate Manager Level**: Adds challenge route only when needed
This multi-level approach ensures robust port management without conflicts.

View File

@ -1,468 +0,0 @@
# SmartProxy Port Handling
This document covers all the port handling capabilities in SmartProxy, including port range specification, dynamic port mapping, and runtime port management.
## Port Range Syntax
SmartProxy offers flexible port range specification through the `TPortRange` type, which can be defined in three different ways:
### 1. Single Port
```typescript
// Match a single port
{
match: {
ports: 443
}
}
```
### 2. Array of Specific Ports
```typescript
// Match multiple specific ports
{
match: {
ports: [80, 443, 8080]
}
}
```
### 3. Port Range
```typescript
// Match a range of ports
{
match: {
ports: [{ from: 8000, to: 8100 }]
}
}
```
### 4. Mixed Port Specifications
You can combine different port specification methods in a single rule:
```typescript
// Match both specific ports and port ranges
{
match: {
ports: [80, 443, { from: 8000, to: 8100 }]
}
}
```
## Port Forwarding Options
SmartProxy offers several ways to handle port forwarding from source to target:
### 1. Static Port Forwarding
Forward to a fixed target port:
```typescript
{
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: 8080
}
}
}
```
### 2. Preserve Source Port
Forward to the same port on the target:
```typescript
{
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: 'preserve'
}
}
}
```
### 3. Dynamic Port Mapping
Use a function to determine the target port based on connection context:
```typescript
{
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: (context) => {
// Calculate port based on request details
return 8000 + (context.port % 100);
}
}
}
}
```
## Port Selection Context
When using dynamic port mapping functions, you have access to a rich context object that provides details about the connection:
```typescript
interface IRouteContext {
// Connection information
port: number; // The matched incoming port
domain?: string; // The domain from SNI or Host header
clientIp: string; // The client's IP address
serverIp: string; // The server's IP address
path?: string; // URL path (for HTTP connections)
query?: string; // Query string (for HTTP connections)
headers?: Record<string, string>; // HTTP headers (for HTTP connections)
// TLS information
isTls: boolean; // Whether the connection is TLS
tlsVersion?: string; // TLS version if applicable
// Route information
routeName?: string; // The name of the matched route
routeId?: string; // The ID of the matched route
// Additional properties
timestamp: number; // The request timestamp
connectionId: string; // Unique connection identifier
}
```
## Common Port Mapping Patterns
### 1. Port Offset Mapping
Forward traffic to target ports with a fixed offset:
```typescript
{
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: (context) => context.port + 1000
}
}
}
```
### 2. Domain-Based Port Mapping
Forward to different backend ports based on the domain:
```typescript
{
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: (context) => {
switch (context.domain) {
case 'api.example.com': return 8001;
case 'admin.example.com': return 8002;
case 'staging.example.com': return 8003;
default: return 8000;
}
}
}
}
}
```
### 3. Load Balancing with Hash-Based Distribution
Distribute connections across a port range using a deterministic hash function:
```typescript
{
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: (context) => {
// Simple hash function to ensure consistent mapping
const hostname = context.domain || '';
const hash = hostname.split('').reduce((a, b) => a + b.charCodeAt(0), 0);
return 8000 + (hash % 10); // Map to ports 8000-8009
}
}
}
}
```
## IPv6-Mapped IPv4 Compatibility
SmartProxy automatically handles IPv6-mapped IPv4 addresses for optimal compatibility. When a connection from an IPv4 address (e.g., `192.168.1.1`) arrives as an IPv6-mapped address (`::ffff:192.168.1.1`), the system normalizes these addresses for consistent matching.
This is particularly important when:
1. Matching client IP restrictions in route configurations
2. Preserving source IP for outgoing connections
3. Tracking connections and rate limits
No special configuration is needed - the system handles this normalization automatically.
## Dynamic Port Management
SmartProxy allows for runtime port configuration changes without requiring a restart.
### Adding and Removing Ports
```typescript
// Get the SmartProxy instance
const proxy = new SmartProxy({ /* config */ });
// Add a new listening port
await proxy.addListeningPort(8081);
// Remove a listening port
await proxy.removeListeningPort(8082);
```
### Runtime Route Updates
```typescript
// Get current routes
const currentRoutes = proxy.getRoutes();
// Add new route for the new port
const newRoute = {
name: 'New Dynamic Route',
match: {
ports: 8081,
domains: ['dynamic.example.com']
},
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: 9000
}
}
};
// Update the route configuration
await proxy.updateRoutes([...currentRoutes, newRoute]);
// Remove routes for a specific port
const routesWithout8082 = currentRoutes.filter(route => {
const ports = proxy.routeManager.expandPortRange(route.match.ports);
return !ports.includes(8082);
});
await proxy.updateRoutes(routesWithout8082);
```
## Performance Considerations
### Port Range Expansion
When using large port ranges, SmartProxy uses internal caching to optimize performance. For example, a range like `{ from: 1000, to: 2000 }` is expanded only once and then cached for future use.
### Port Range Validation
The system automatically validates port ranges to ensure:
1. Port numbers are within the valid range (1-65535)
2. The "from" value is not greater than the "to" value in range specifications
3. Port ranges do not contain duplicate entries
Invalid port ranges will be logged as warnings and skipped during configuration.
## Configuration Recipes
### Global Port Range
Listen on a large range of ports and forward to the same ports on a backend:
```typescript
{
name: 'Global port range forwarding',
match: {
ports: [{ from: 8000, to: 9000 }]
},
action: {
type: 'forward',
target: {
host: 'backend.example.com',
port: 'preserve'
}
}
}
```
### Domain-Specific Port Ranges
Different port ranges for different domain groups:
```typescript
[
{
name: 'API port range',
match: {
ports: [{ from: 8000, to: 8099 }]
},
action: {
type: 'forward',
target: {
host: 'api.backend.example.com',
port: 'preserve'
}
}
},
{
name: 'Admin port range',
match: {
ports: [{ from: 9000, to: 9099 }]
},
action: {
type: 'forward',
target: {
host: 'admin.backend.example.com',
port: 'preserve'
}
}
}
]
```
### Mixed Internal/External Port Forwarding
Forward specific high-numbered ports to standard ports on internal servers:
```typescript
[
{
name: 'Web server forwarding',
match: {
ports: [8080, 8443]
},
action: {
type: 'forward',
target: {
host: 'web.internal',
port: (context) => context.port === 8080 ? 80 : 443
}
}
},
{
name: 'Database forwarding',
match: {
ports: [15432]
},
action: {
type: 'forward',
target: {
host: 'db.internal',
port: 5432
}
}
}
]
```
## Debugging Port Configurations
When troubleshooting port forwarding issues, enable detailed logging:
```typescript
const proxy = new SmartProxy({
routes: [ /* your routes */ ],
enableDetailedLogging: true
});
```
This will log:
- Port configuration during startup
- Port matching decisions during routing
- Dynamic port function results
- Connection details including source and target ports
## Port Security Considerations
### Restricting Ports
For security, you may want to restrict which ports can be accessed by specific clients:
```typescript
{
name: 'Restricted port range',
match: {
ports: [{ from: 8000, to: 9000 }],
clientIp: ['10.0.0.0/8'] // Only internal network can access these ports
},
action: {
type: 'forward',
target: {
host: 'internal.example.com',
port: 'preserve'
}
}
}
```
### Rate Limiting by Port
Apply different rate limits for different port ranges:
```typescript
{
name: 'API ports with rate limiting',
match: {
ports: [{ from: 8000, to: 8100 }]
},
action: {
type: 'forward',
target: {
host: 'api.example.com',
port: 'preserve'
},
security: {
rateLimit: {
enabled: true,
maxRequests: 100,
window: 60 // 60 seconds
}
}
}
}
```
## Best Practices
1. **Use Specific Port Ranges**: Instead of large ranges (e.g., 1-65535), use specific ranges for specific purposes
2. **Prioritize Routes**: When multiple routes could match, use the `priority` field to ensure the most specific route is matched first
3. **Name Your Routes**: Use descriptive names to make debugging easier, especially when using port ranges
4. **Use Preserve Port Where Possible**: Using `port: 'preserve'` is more efficient and easier to maintain than creating multiple specific mappings
5. **Limit Dynamic Port Functions**: While powerful, complex port functions can be harder to debug; prefer simple map or math-based functions
6. **Use Port Variables**: For complex setups, define your port ranges as variables for easier maintenance:
```typescript
const API_PORTS = [{ from: 8000, to: 8099 }];
const ADMIN_PORTS = [{ from: 9000, to: 9099 }];
const routes = [
{
name: 'API Routes',
match: { ports: API_PORTS, /* ... */ },
// ...
},
{
name: 'Admin Routes',
match: { ports: ADMIN_PORTS, /* ... */ },
// ...
}
];
```

View File

@ -1,131 +0,0 @@
/**
* Dynamic Port Management Example
*
* This example demonstrates how to dynamically add and remove ports
* while SmartProxy is running, without requiring a restart.
*/
import { SmartProxy } from '../dist_ts/index.js';
import type { IRouteConfig } from '../dist_ts/index.js';
async function main() {
// Create a SmartProxy instance with initial routes
const proxy = new SmartProxy({
routes: [
// Initial route on port 8080
{
match: {
ports: 8080,
domains: ['example.com', '*.example.com']
},
action: {
type: 'forward',
target: { host: 'localhost', port: 3000 }
},
name: 'Initial HTTP Route'
}
]
});
// Start the proxy
await proxy.start();
console.log('SmartProxy started with initial configuration');
console.log('Listening on ports:', proxy.getListeningPorts());
// Wait 3 seconds
console.log('Waiting 3 seconds before adding a new port...');
await new Promise(resolve => setTimeout(resolve, 3000));
// Add a new port listener without changing routes yet
await proxy.addListeningPort(8081);
console.log('Added port 8081 without any routes yet');
console.log('Now listening on ports:', proxy.getListeningPorts());
// Wait 3 more seconds
console.log('Waiting 3 seconds before adding a route for the new port...');
await new Promise(resolve => setTimeout(resolve, 3000));
// Get current routes and add a new one for port 8081
const currentRoutes = proxy.settings.routes;
// Create a new route for port 8081
const newRoute: IRouteConfig = {
match: {
ports: 8081,
domains: ['api.example.com']
},
action: {
type: 'forward' as const,
target: { host: 'localhost', port: 4000 }
},
name: 'API Route'
};
// Update routes to include the new one
await proxy.updateRoutes([...currentRoutes, newRoute]);
console.log('Added new route for port 8081');
// Wait 3 more seconds
console.log('Waiting 3 seconds before adding another port through updateRoutes...');
await new Promise(resolve => setTimeout(resolve, 3000));
// Add a completely new port via updateRoutes, which will automatically start listening
const thirdRoute: IRouteConfig = {
match: {
ports: 8082,
domains: ['admin.example.com']
},
action: {
type: 'forward' as const,
target: { host: 'localhost', port: 5000 }
},
name: 'Admin Route'
};
// Update routes again to include the third route
await proxy.updateRoutes([...currentRoutes, newRoute, thirdRoute]);
console.log('Added new route for port 8082 through updateRoutes');
console.log('Now listening on ports:', proxy.getListeningPorts());
// Wait 3 more seconds
console.log('Waiting 3 seconds before removing port 8081...');
await new Promise(resolve => setTimeout(resolve, 3000));
// Remove a port without changing routes
await proxy.removeListeningPort(8081);
console.log('Removed port 8081 (but route still exists)');
console.log('Now listening on ports:', proxy.getListeningPorts());
// Wait 3 more seconds
console.log('Waiting 3 seconds before stopping all routes on port 8082...');
await new Promise(resolve => setTimeout(resolve, 3000));
// Remove all routes for port 8082
const routesWithout8082 = currentRoutes.filter(route => {
// Check if this route includes port 8082
const ports = proxy.routeManager.expandPortRange(route.match.ports);
return !ports.includes(8082);
});
// Update routes without any for port 8082
await proxy.updateRoutes([...routesWithout8082, newRoute]);
console.log('Removed routes for port 8082 through updateRoutes');
console.log('Now listening on ports:', proxy.getListeningPorts());
// Show statistics
console.log('Statistics:', proxy.getStatistics());
// Wait 3 more seconds, then shut down
console.log('Waiting 3 seconds before shutdown...');
await new Promise(resolve => setTimeout(resolve, 3000));
// Stop the proxy
await proxy.stop();
console.log('SmartProxy stopped');
}
// Run the example
main().catch(err => {
console.error('Error in example:', err);
process.exit(1);
});

View File

@ -1,214 +0,0 @@
/**
* NFTables Integration Example
*
* This example demonstrates how to use the NFTables forwarding engine with SmartProxy
* for high-performance network routing that operates at the kernel level.
*
* NOTE: This requires elevated privileges to run (sudo) as it interacts with nftables.
*/
import { SmartProxy } from '../ts/proxies/smart-proxy/index.js';
import {
createNfTablesRoute,
createNfTablesTerminateRoute,
createCompleteNfTablesHttpsServer
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
// Simple NFTables-based HTTP forwarding example
async function simpleForwardingExample() {
console.log('Starting simple NFTables forwarding example...');
// Create a SmartProxy instance with a simple NFTables route
const proxy = new SmartProxy({
routes: [
createNfTablesRoute('example.com', {
host: 'localhost',
port: 8080
}, {
ports: 80,
protocol: 'tcp',
preserveSourceIP: true,
tableName: 'smartproxy_example'
})
],
enableDetailedLogging: true
});
// Start the proxy
await proxy.start();
console.log('NFTables proxy started. Press Ctrl+C to stop.');
// Handle shutdown
process.on('SIGINT', async () => {
console.log('Stopping proxy...');
await proxy.stop();
process.exit(0);
});
}
// HTTPS termination example with NFTables
async function httpsTerminationExample() {
console.log('Starting HTTPS termination with NFTables example...');
// Create a SmartProxy instance with an HTTPS termination route using NFTables
const proxy = new SmartProxy({
routes: [
createNfTablesTerminateRoute('secure.example.com', {
host: 'localhost',
port: 8443
}, {
ports: 443,
certificate: 'auto', // Automatic certificate provisioning
tableName: 'smartproxy_https'
})
],
enableDetailedLogging: true
});
// Start the proxy
await proxy.start();
console.log('HTTPS termination proxy started. Press Ctrl+C to stop.');
// Handle shutdown
process.on('SIGINT', async () => {
console.log('Stopping proxy...');
await proxy.stop();
process.exit(0);
});
}
// Complete HTTPS server with HTTP redirects using NFTables
async function completeHttpsServerExample() {
console.log('Starting complete HTTPS server with NFTables example...');
// Create a SmartProxy instance with a complete HTTPS server
const proxy = new SmartProxy({
routes: createCompleteNfTablesHttpsServer('complete.example.com', {
host: 'localhost',
port: 8443
}, {
certificate: 'auto',
tableName: 'smartproxy_complete'
}),
enableDetailedLogging: true
});
// Start the proxy
await proxy.start();
console.log('Complete HTTPS server started. Press Ctrl+C to stop.');
// Handle shutdown
process.on('SIGINT', async () => {
console.log('Stopping proxy...');
await proxy.stop();
process.exit(0);
});
}
// Load balancing example with NFTables
async function loadBalancingExample() {
console.log('Starting load balancing with NFTables example...');
// Create a SmartProxy instance with a load balancing configuration
const proxy = new SmartProxy({
routes: [
createNfTablesRoute('lb.example.com', {
// NFTables will automatically distribute connections to these hosts
host: 'backend1.example.com',
port: 8080
}, {
ports: 80,
tableName: 'smartproxy_lb'
})
],
enableDetailedLogging: true
});
// Start the proxy
await proxy.start();
console.log('Load balancing proxy started. Press Ctrl+C to stop.');
// Handle shutdown
process.on('SIGINT', async () => {
console.log('Stopping proxy...');
await proxy.stop();
process.exit(0);
});
}
// Advanced example with QoS and security settings
async function advancedExample() {
console.log('Starting advanced NFTables example with QoS and security...');
// Create a SmartProxy instance with advanced settings
const proxy = new SmartProxy({
routes: [
createNfTablesRoute('advanced.example.com', {
host: 'localhost',
port: 8080
}, {
ports: 80,
protocol: 'tcp',
preserveSourceIP: true,
maxRate: '10mbps', // QoS rate limiting
priority: 2, // QoS priority (1-10, lower is higher priority)
ipAllowList: ['192.168.1.0/24'], // Only allow this subnet
ipBlockList: ['192.168.1.100'], // Block this specific IP
useIPSets: true, // Use IP sets for more efficient rule processing
useAdvancedNAT: true, // Use connection tracking for stateful NAT
tableName: 'smartproxy_advanced'
})
],
enableDetailedLogging: true
});
// Start the proxy
await proxy.start();
console.log('Advanced NFTables proxy started. Press Ctrl+C to stop.');
// Handle shutdown
process.on('SIGINT', async () => {
console.log('Stopping proxy...');
await proxy.stop();
process.exit(0);
});
}
// Run one of the examples based on the command line argument
async function main() {
const example = process.argv[2] || 'simple';
switch (example) {
case 'simple':
await simpleForwardingExample();
break;
case 'https':
await httpsTerminationExample();
break;
case 'complete':
await completeHttpsServerExample();
break;
case 'lb':
await loadBalancingExample();
break;
case 'advanced':
await advancedExample();
break;
default:
console.error('Unknown example:', example);
console.log('Available examples: simple, https, complete, lb, advanced');
process.exit(1);
}
}
// Check if running as root/sudo
if (process.getuid && process.getuid() !== 0) {
console.error('This example requires root privileges to modify nftables rules.');
console.log('Please run with sudo: sudo tsx examples/nftables-integration.ts');
process.exit(1);
}
main().catch(err => {
console.error('Error running example:', err);
process.exit(1);
});

View File

@ -1,6 +1,6 @@
{
"name": "@push.rocks/smartproxy",
"version": "19.3.3",
"version": "19.5.2",
"private": false,
"description": "A powerful proxy package with unified route-based configuration for high traffic management. Features include SSL/TLS support, flexible routing patterns, WebSocket handling, advanced security options, and automatic ACME certificate management.",
"main": "dist_ts/index.js",
@ -9,16 +9,16 @@
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest test/**/test*.ts --verbose)",
"test": "(tstest test/**/test*.ts --verbose --timeout 600)",
"build": "(tsbuild tsfolders --allowimplicitany)",
"format": "(gitzone format)",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.5.1",
"@git.zone/tsbuild": "^2.6.4",
"@git.zone/tsrun": "^1.2.44",
"@git.zone/tstest": "^1.9.0",
"@types/node": "^22.15.19",
"@git.zone/tstest": "^2.3.1",
"@types/node": "^22.15.24",
"typescript": "^5.8.3"
},
"dependencies": {
@ -26,7 +26,8 @@
"@push.rocks/smartacme": "^8.0.0",
"@push.rocks/smartcrypto": "^2.0.4",
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartfile": "^11.2.0",
"@push.rocks/smartfile": "^11.2.5",
"@push.rocks/smartlog": "^3.1.8",
"@push.rocks/smartnetwork": "^4.0.2",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartrequest": "^2.1.0",

1750
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -91,4 +91,105 @@ const proxy = new SmartProxy({
- Update `plugins.ts` when adding new dependencies.
- Maintain test coverage for new routing or proxy features.
- Keep `ts/` and `dist_ts/` in sync after refactors.
- Consider implementing top-level ACME config support for backward compatibility
- Consider implementing top-level ACME config support for backward compatibility
## HTTP-01 ACME Challenge Fix (v19.3.8)
### Issue
Non-TLS connections on ports configured in `useHttpProxy` were not being forwarded to HttpProxy. This caused ACME HTTP-01 challenges to fail when the ACME port (usually 80) was included in `useHttpProxy`.
### Root Cause
In the `RouteConnectionHandler.handleForwardAction` method, only connections with TLS settings (mode: 'terminate' or 'terminate-and-reencrypt') were being forwarded to HttpProxy. Non-TLS connections were always handled as direct connections, even when the port was configured for HttpProxy.
### Solution
Added a check for non-TLS connections on ports listed in `useHttpProxy`:
```typescript
// No TLS settings - check if this port should use HttpProxy
const isHttpProxyPort = this.settings.useHttpProxy?.includes(record.localPort);
if (isHttpProxyPort && this.httpProxyBridge.getHttpProxy()) {
// Forward non-TLS connections to HttpProxy if configured
this.httpProxyBridge.forwardToHttpProxy(/*...*/);
return;
}
```
### Test Coverage
- `test/test.http-fix-unit.ts` - Unit tests verifying the fix
- Tests confirm that non-TLS connections on HttpProxy ports are properly forwarded
- Tests verify that non-HttpProxy ports still use direct connections
### Configuration Example
```typescript
const proxy = new SmartProxy({
useHttpProxy: [80], // Enable HttpProxy for port 80
httpProxyPort: 8443,
acme: {
email: 'ssl@example.com',
port: 80
},
routes: [
// Your routes here
]
});
```
## ACME Certificate Provisioning Timing Fix (v19.3.9)
### Issue
Certificate provisioning would start before ports were listening, causing ACME HTTP-01 challenges to fail with connection refused errors.
### Root Cause
SmartProxy initialization sequence:
1. Certificate manager initialized → immediately starts provisioning
2. Ports start listening (too late for ACME challenges)
### Solution
Deferred certificate provisioning until after ports are ready:
```typescript
// SmartCertManager.initialize() now skips automatic provisioning
// SmartProxy.start() calls provisionAllCertificates() directly after ports are listening
```
### Test Coverage
- `test/test.acme-timing-simple.ts` - Verifies proper timing sequence
### Migration
Update to v19.3.9+, no configuration changes needed.
## Socket Handler Race Condition Fix (v19.5.0)
### Issue
Initial data chunks were being emitted before async socket handlers had completed setup, causing data loss when handlers performed async operations before setting up data listeners.
### Root Cause
The `handleSocketHandlerAction` method was using `process.nextTick` to emit initial chunks regardless of whether the handler was sync or async. This created a race condition where async handlers might not have their listeners ready when the initial data was emitted.
### Solution
Differentiated between sync and async handlers:
```typescript
const result = route.action.socketHandler(socket);
if (result instanceof Promise) {
// Async handler - wait for completion before emitting initial data
result.then(() => {
if (initialChunk && initialChunk.length > 0) {
socket.emit('data', initialChunk);
}
}).catch(/*...*/);
} else {
// Sync handler - use process.nextTick as before
if (initialChunk && initialChunk.length > 0) {
process.nextTick(() => {
socket.emit('data', initialChunk);
});
}
}
```
### Test Coverage
- `test/test.socket-handler-race.ts` - Specifically tests async handlers with delayed listener setup
- Verifies that initial data is received even when handler sets up listeners after async work
### Usage Note
Socket handlers require initial data from the client to trigger routing (not just a TLS handshake). Clients must send at least one byte of data for the handler to be invoked.

View File

@ -113,7 +113,7 @@ npm install @push.rocks/smartproxy
## Quick Start with SmartProxy
SmartProxy v18.0.0 continues the evolution of the unified route-based configuration system making your proxy setup more flexible and intuitive with improved helper functions and NFTables integration for high-performance kernel-level routing.
SmartProxy v19.4.0 provides a unified route-based configuration system with enhanced certificate management, NFTables integration for high-performance kernel-level routing, and improved helper functions for common proxy setups.
```typescript
import {
@ -136,10 +136,12 @@ import {
const proxy = new SmartProxy({
// Global ACME settings for all routes with certificate: 'auto'
acme: {
email: 'ssl@example.com', // Required for Let's Encrypt
email: 'ssl@bleu.de', // Required for Let's Encrypt
useProduction: false, // Use staging by default
renewThresholdDays: 30, // Renew 30 days before expiry
port: 80 // Port for HTTP-01 challenges
port: 80, // Port for HTTP-01 challenges (use 8080 for non-privileged)
autoRenew: true, // Enable automatic renewal
renewCheckIntervalHours: 24 // Check for renewals daily
},
// Define all your routing rules in a single array
@ -216,26 +218,7 @@ const proxy = new SmartProxy({
certificate: 'auto',
maxRate: '100mbps'
})
],
// Global settings that apply to all routes
defaults: {
security: {
maxConnections: 500
}
},
// Automatic Let's Encrypt integration
acme: {
enabled: true,
contactEmail: 'admin@example.com',
useProduction: true
}
});
// Listen for certificate events
proxy.on('certificate', evt => {
console.log(`Certificate for ${evt.domain} ready, expires: ${evt.expiryDate}`);
]
});
// Start the proxy
@ -1429,6 +1412,8 @@ createRedirectRoute({
- `routes` (IRouteConfig[], required) - Array of route configurations
- `defaults` (object) - Default settings for all routes
- `acme` (IAcmeOptions) - ACME certificate options
- `useHttpProxy` (number[], optional) - Array of ports to forward to HttpProxy (e.g. `[80, 443]`)
- `httpProxyPort` (number, default 8443) - Port where HttpProxy listens for forwarded connections
- Connection timeouts: `initialDataTimeout`, `socketTimeout`, `inactivityTimeout`, etc.
- Socket opts: `noDelay`, `keepAlive`, `enableKeepAliveProbes`
- `certProvisionFunction` (callback) - Custom certificate provisioning
@ -1495,6 +1480,28 @@ HttpProxy now supports full route-based configuration including:
- Use higher priority for block routes to ensure they take precedence
- Enable `enableDetailedLogging` or `enableTlsDebugLogging` for debugging
### ACME HTTP-01 Challenges
- If ACME HTTP-01 challenges fail, ensure:
1. Port 80 (or configured ACME port) is included in `useHttpProxy`
2. You're using SmartProxy v19.3.9+ for proper timing (ports must be listening before provisioning)
- Since v19.3.8: Non-TLS connections on ports listed in `useHttpProxy` are properly forwarded to HttpProxy
- Since v19.3.9: Certificate provisioning waits for ports to be ready before starting ACME challenges
- Example configuration for ACME on port 80:
```typescript
const proxy = new SmartProxy({
useHttpProxy: [80], // Ensure port 80 is forwarded to HttpProxy
httpProxyPort: 8443,
acme: {
email: 'ssl@example.com',
port: 80
},
routes: [/* your routes */]
});
```
- Common issues:
- "Connection refused" during challenges → Update to v19.3.9+ for timing fix
- HTTP requests not parsed → Ensure port is in `useHttpProxy` array
### NFTables Integration
- Ensure NFTables is installed: `apt install nftables` or `yum install nftables`
- Verify root/sudo permissions for NFTables operations

View File

@ -1,172 +1,316 @@
# SmartProxy Architecture Refactoring Plan
# SmartProxy Development Plan
## Overview
## Implementation Plan: Socket Handler Function Support (Simplified) ✅ COMPLETED
Refactor the proxy architecture to provide clearer separation of concerns between HTTP/HTTPS traffic handling and low-level connection routing.
### Overview
Add support for custom socket handler functions with the simplest possible API - just pass a function that receives the socket.
## Current Architecture Problems
### User Experience Goal
```typescript
const proxy = new SmartProxy({
routes: [{
name: 'my-custom-protocol',
match: { ports: 9000, domains: 'custom.example.com' },
action: {
type: 'socket-handler',
socketHandler: (socket) => {
// User has full control of the socket
socket.write('Welcome!\n');
socket.on('data', (data) => {
socket.write(`Echo: ${data}`);
});
}
}
}]
});
```
1. NetworkProxy name doesn't clearly indicate it handles HTTP/HTTPS
2. HTTP parsing logic is duplicated in RouteConnectionHandler
3. Redirect and static route handling is embedded in SmartProxy
4. Unclear separation between TCP routing and HTTP processing
That's it. Simple and powerful.
## Proposed Architecture
---
### HttpProxy (renamed from NetworkProxy)
**Purpose**: Handle all HTTP/HTTPS traffic with TLS termination
## Phase 1: Minimal Type Changes
**Responsibilities**:
- TLS termination for HTTPS
- HTTP/1.1 and HTTP/2 protocol handling
- HTTP request/response parsing
- HTTP to HTTPS redirects
- ACME challenge handling
- Static route handlers
- WebSocket protocol upgrades
- Connection pooling for backend servers
- Certificate management (ACME and static)
### 1.1 Add Socket Handler Action Type
**File:** `ts/proxies/smart-proxy/models/route-types.ts`
### SmartProxy
**Purpose**: Low-level connection router and port manager
```typescript
// Update action type
export type TRouteActionType = 'forward' | 'redirect' | 'block' | 'static' | 'socket-handler';
**Responsibilities**:
- Port management (listen on multiple ports)
- Route-based connection routing
- TLS passthrough (SNI-based routing)
- NFTables integration
- Delegate HTTP/HTTPS connections to HttpProxy
- Raw TCP proxying
- Connection lifecycle management
// Add simple socket handler type
export type TSocketHandler = (socket: net.Socket) => void | Promise<void>;
## Implementation Plan
// Extend IRouteAction
export interface IRouteAction {
// ... existing properties
// Socket handler function (when type is 'socket-handler')
socketHandler?: TSocketHandler;
}
```
### Phase 1: Rename and Reorganize NetworkProxy ✅
---
1. **Rename NetworkProxy to HttpProxy**
- Renamed directory from `network-proxy` to `http-proxy`
- Updated all imports and references
## Phase 2: Simple Implementation
2. **Update class and file names**
- Renamed `network-proxy.ts` to `http-proxy.ts`
- Updated `NetworkProxy` class to `HttpProxy` class
- Updated all type definitions and interfaces
### 2.1 Update Route Connection Handler
**File:** `ts/proxies/smart-proxy/route-connection-handler.ts`
3. **Update exports**
- Updated exports in `ts/index.ts`
- Fixed imports across the codebase
In the `handleConnection` method, add handling for socket-handler:
### Phase 2: Extract HTTP Logic from SmartProxy ✅
```typescript
// After route matching...
if (matchedRoute) {
const action = matchedRoute.action;
if (action.type === 'socket-handler') {
if (!action.socketHandler) {
logger.error('socket-handler action missing socketHandler function');
socket.destroy();
return;
}
try {
// Simply call the handler with the socket
const result = action.socketHandler(socket);
// If it returns a promise, handle errors
if (result instanceof Promise) {
result.catch(error => {
logger.error('Socket handler error:', error);
if (!socket.destroyed) {
socket.destroy();
}
});
}
} catch (error) {
logger.error('Socket handler error:', error);
if (!socket.destroyed) {
socket.destroy();
}
}
return; // Done - user has control now
}
// ... rest of existing action handling
}
```
1. **Create HTTP handler modules in HttpProxy**
- Created handlers directory with:
- `redirect-handler.ts` - HTTP redirect logic
- `static-handler.ts` - Static/ACME route handling
- `index.ts` - Module exports
---
2. **Move HTTP parsing from RouteConnectionHandler**
- Updated `handleRedirectAction` to delegate to `RedirectHandler`
- Updated `handleStaticAction` to delegate to `StaticHandler`
- Removed duplicated HTTP parsing logic
## Phase 3: Optional Context (If Needed)
3. **Clean up references and naming**
- Updated all NetworkProxy references to HttpProxy
- Renamed config properties: `useNetworkProxy``useHttpProxy`
- Renamed config properties: `networkProxyPort``httpProxyPort`
- Fixed HttpProxyBridge methods and references
If users need more info, we can optionally pass a minimal context as a second parameter:
### Phase 3: Simplify SmartProxy
```typescript
export type TSocketHandler = (
socket: net.Socket,
context?: {
route: IRouteConfig;
clientIp: string;
localPort: number;
}
) => void | Promise<void>;
```
1. **Update RouteConnectionHandler**
- Remove embedded HTTP parsing
- Delegate HTTP routes to HttpProxy
- Focus on connection routing only
Usage:
```typescript
socketHandler: (socket, context) => {
console.log(`Connection from ${context.clientIp} to port ${context.localPort}`);
// Handle socket...
}
```
2. **Simplified route handling**
```typescript
// Simplified handleRedirectAction
private handleRedirectAction(socket, record, route) {
// Delegate to HttpProxy
this.httpProxy.handleRedirect(socket, route);
}
// Simplified handleStaticAction
private handleStaticAction(socket, record, route) {
// Delegate to HttpProxy
this.httpProxy.handleStatic(socket, route);
}
```
---
3. **Update NetworkProxyBridge**
- Rename to HttpProxyBridge
- Update integration points
## Phase 4: Helper Utilities (Optional)
### Phase 4: Consolidate HTTP Utilities ✅
### 4.1 Common Patterns
**File:** `ts/proxies/smart-proxy/utils/route-helpers.ts`
1. **Move HTTP types to http-proxy**
- Created consolidated `http-types.ts` in `ts/proxies/http-proxy/models/`
- Includes HTTP status codes, error classes, and interfaces
- Added helper functions like `getStatusText()`
```typescript
// Simple helper to create socket handler routes
export function createSocketHandlerRoute(
domains: string | string[],
ports: TPortRange,
handler: TSocketHandler,
options?: { name?: string; priority?: number }
): IRouteConfig {
return {
name: options?.name || 'socket-handler-route',
priority: options?.priority || 50,
match: { domains, ports },
action: {
type: 'socket-handler',
socketHandler: handler
}
};
}
2. **Clean up ts/http directory**
- Kept only router functionality
- Replaced local HTTP types with re-exports from HttpProxy
- Updated imports throughout the codebase to use consolidated types
// Pre-built handlers for common cases
export const SocketHandlers = {
// Simple echo server
echo: (socket: net.Socket) => {
socket.on('data', data => socket.write(data));
},
// TCP proxy
proxy: (targetHost: string, targetPort: number) => (socket: net.Socket) => {
const target = net.connect(targetPort, targetHost);
socket.pipe(target);
target.pipe(socket);
socket.on('close', () => target.destroy());
target.on('close', () => socket.destroy());
},
// Line-based protocol
lineProtocol: (handler: (line: string, socket: net.Socket) => void) => (socket: net.Socket) => {
let buffer = '';
socket.on('data', (data) => {
buffer += data.toString();
const lines = buffer.split('\n');
buffer = lines.pop() || '';
lines.forEach(line => handler(line, socket));
});
}
};
```
### Phase 5: Update Tests and Documentation ✅
---
1. **Update test files**
- Renamed NetworkProxy references to HttpProxy
- Renamed test files to match new naming
- Updated imports and references throughout tests
- Fixed certificate manager method names
## Usage Examples
2. **Update documentation**
- Updated README to reflect HttpProxy naming
- Updated architecture descriptions
- Updated usage examples
- Fixed all API documentation references
### Example 1: Custom Protocol
```typescript
{
name: 'custom-protocol',
match: { ports: 9000 },
action: {
type: 'socket-handler',
socketHandler: (socket) => {
socket.write('READY\n');
socket.on('data', (data) => {
const cmd = data.toString().trim();
if (cmd === 'PING') socket.write('PONG\n');
else if (cmd === 'QUIT') socket.end();
else socket.write('ERROR: Unknown command\n');
});
}
}
}
```
## Migration Steps
### Example 2: Simple TCP Proxy
```typescript
{
name: 'tcp-proxy',
match: { ports: 8080, domains: 'proxy.example.com' },
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.proxy('backend.local', 3000)
}
}
```
1. Create feature branch: `refactor/http-proxy-consolidation`
2. Phase 1: Rename NetworkProxy (1 day)
3. Phase 2: Extract HTTP logic (2 days)
4. Phase 3: Simplify SmartProxy (1 day)
5. Phase 4: Consolidate utilities (1 day)
6. Phase 5: Update tests/docs (1 day)
7. Integration testing (1 day)
8. Code review and merge
### Example 3: WebSocket with Custom Auth
```typescript
{
name: 'custom-websocket',
match: { ports: [80, 443], path: '/ws' },
action: {
type: 'socket-handler',
socketHandler: async (socket) => {
// Read HTTP headers
const headers = await readHttpHeaders(socket);
// Custom auth check
if (!headers.authorization || !validateToken(headers.authorization)) {
socket.write('HTTP/1.1 401 Unauthorized\r\n\r\n');
socket.end();
return;
}
// Proceed with WebSocket upgrade
const ws = new WebSocket(socket, headers);
// ... handle WebSocket
}
}
}
```
## Benefits
---
1. **Clear Separation**: HTTP/HTTPS handling is clearly separated from TCP routing
2. **Better Naming**: HttpProxy clearly indicates its purpose
3. **No Duplication**: HTTP parsing logic exists in one place
4. **Maintainability**: Easier to modify HTTP handling without affecting routing
5. **Testability**: Each component has a single responsibility
6. **Performance**: Optimized paths for different traffic types
## Benefits of This Approach
## Future Enhancements
1. **Dead Simple API**: Just pass a function that gets the socket
2. **No New Classes**: No ForwardingHandler subclass needed
3. **Minimal Changes**: Only touches type definitions and one handler method
4. **Full Power**: Users have complete control over the socket
5. **Backward Compatible**: No changes to existing functionality
6. **Easy to Test**: Just test the socket handler functions directly
After this refactoring, we can more easily add:
---
1. HTTP/3 (QUIC) support in HttpProxy
2. Advanced HTTP features (compression, caching)
3. HTTP middleware system
4. Protocol-specific optimizations
5. Better HTTP/2 multiplexing
## Implementation Steps
## Breaking Changes
1. Add `'socket-handler'` to `TRouteActionType` (5 minutes)
2. Add `socketHandler?: TSocketHandler` to `IRouteAction` (5 minutes)
3. Add socket-handler case in `RouteConnectionHandler.handleConnection()` (15 minutes)
4. Add helper functions (optional, 30 minutes)
5. Write tests (2 hours)
6. Update documentation (1 hour)
1. `NetworkProxy` class renamed to `HttpProxy`
2. Import paths change from `network-proxy` to `http-proxy`
3. Some type names may change for consistency
**Total implementation time: ~4 hours** (vs 6 weeks for the complex version)
## Rollback Plan
---
If issues arise:
1. Git revert to previous commit
2. Re-deploy previous version
3. Document lessons learned
4. Plan incremental changes
## What We're NOT Doing
- ❌ Creating new ForwardingHandler classes
- ❌ Complex context objects with utils
- ❌ HTTP request handling for socket handlers
- ❌ Complex protocol detection mechanisms
- ❌ Middleware patterns
- ❌ Lifecycle hooks
Keep it simple. The user just wants to handle a socket.
---
## Success Criteria
- ✅ Users can define a route with `type: 'socket-handler'`
- ✅ Users can provide a function that receives the socket
- ✅ The function is called when a connection matches the route
- ✅ Error handling prevents crashes
- ✅ No performance impact on existing routes
- ✅ Clean, simple API that's easy to understand
---
## Implementation Notes (Completed)
### What Was Implemented
1. **Type Definitions** - Added 'socket-handler' to TRouteActionType and TSocketHandler type
2. **Route Handler** - Added socket-handler case in RouteConnectionHandler switch statement
3. **Error Handling** - Both sync and async errors are caught and logged
4. **Initial Data Handling** - Initial chunks are re-emitted to handler's listeners
5. **Helper Functions** - Added createSocketHandlerRoute and pre-built handlers (echo, proxy, etc.)
6. **Full Test Coverage** - All test cases pass including async handlers and error handling
### Key Implementation Details
- Socket handlers require initial data from client to trigger routing (not TLS handshake)
- The handler receives the raw socket after route matching
- Both sync and async handlers are supported
- Errors in handlers terminate the connection gracefully
- Helper utilities provide common patterns (echo server, TCP proxy, line protocol)
### Usage Notes
- Clients must send initial data to trigger the handler (even just a newline)
- The socket is passed directly to the handler function
- Handler has complete control over the socket lifecycle
- No special context object needed - keeps it simple
**Total implementation time: ~3 hours**

764
readme.plan2.md Normal file
View File

@ -0,0 +1,764 @@
# SmartProxy Simplification Plan: Unify Action Types
## Summary
Complete removal of 'redirect', 'block', and 'static' action types, leaving only 'forward' and 'socket-handler'. All old code will be deleted entirely - no migration paths or backwards compatibility. Socket handlers will be enhanced to receive IRouteContext as a second parameter.
## Goal
Create a dramatically simpler SmartProxy with only two action types, where everything is either proxied (forward) or handled by custom code (socket-handler).
## Current State
```typescript
export type TRouteActionType = 'forward' | 'redirect' | 'block' | 'static' | 'socket-handler';
export type TSocketHandler = (socket: plugins.net.Socket) => void | Promise<void>;
```
## Target State
```typescript
export type TRouteActionType = 'forward' | 'socket-handler';
export type TSocketHandler = (socket: plugins.net.Socket, context: IRouteContext) => void | Promise<void>;
```
## Benefits
1. **Simpler API** - Only two action types to understand
2. **Unified handling** - Everything is either forwarding or custom socket handling
3. **More flexible** - Socket handlers can do anything the old types did and more
4. **Less code** - Remove specialized handlers and their dependencies
5. **Context aware** - Socket handlers get access to route context (domain, port, clientIp, etc.)
6. **Clean codebase** - No legacy code or migration paths
---
## Phase 1: Code to Remove
### 1.1 Action Type Handlers
- `RouteConnectionHandler.handleRedirectAction()`
- `RouteConnectionHandler.handleBlockAction()`
- `RouteConnectionHandler.handleStaticAction()`
### 1.2 Handler Classes
- `RedirectHandler` class (http-proxy/handlers/)
- `StaticHandler` class (http-proxy/handlers/)
### 1.3 Type Definitions
- 'redirect', 'block', 'static' from TRouteActionType
- IRouteRedirect interface
- IRouteStatic interface
- Related properties in IRouteAction
### 1.4 Helper Functions
- `createStaticFileRoute()`
- Any other helpers that create redirect/block/static routes
---
## Phase 2: Create Predefined Socket Handlers
### 2.1 Block Handler
```typescript
export const SocketHandlers = {
// ... existing handlers
/**
* Block connection immediately
*/
block: (message?: string) => (socket: plugins.net.Socket, context: IRouteContext) => {
// Can use context for logging or custom messages
const finalMessage = message || `Connection blocked from ${context.clientIp}`;
if (finalMessage) {
socket.write(finalMessage);
}
socket.end();
},
/**
* HTTP block response
*/
httpBlock: (statusCode: number = 403, message?: string) => (socket: plugins.net.Socket, context: IRouteContext) => {
// Can customize message based on context
const defaultMessage = `Access forbidden for ${context.domain || context.clientIp}`;
const finalMessage = message || defaultMessage;
const response = [
`HTTP/1.1 ${statusCode} ${finalMessage}`,
'Content-Type: text/plain',
`Content-Length: ${finalMessage.length}`,
'Connection: close',
'',
finalMessage
].join('\r\n');
socket.write(response);
socket.end();
}
};
```
### 2.2 Redirect Handler
```typescript
export const SocketHandlers = {
// ... existing handlers
/**
* HTTP redirect handler
*/
httpRedirect: (locationTemplate: string, statusCode: number = 301) => (socket: plugins.net.Socket, context: IRouteContext) => {
let buffer = '';
socket.once('data', (data) => {
buffer += data.toString();
// Parse HTTP request
const lines = buffer.split('\r\n');
const requestLine = lines[0];
const [method, path] = requestLine.split(' ');
// Use domain from context (more reliable than Host header)
const domain = context.domain || 'localhost';
const port = context.port;
// Replace placeholders in location using context
let finalLocation = locationTemplate
.replace('{domain}', domain)
.replace('{port}', String(port))
.replace('{path}', path)
.replace('{clientIp}', context.clientIp);
const message = `Redirecting to ${finalLocation}`;
const response = [
`HTTP/1.1 ${statusCode} ${statusCode === 301 ? 'Moved Permanently' : 'Found'}`,
`Location: ${finalLocation}`,
'Content-Type: text/plain',
`Content-Length: ${message.length}`,
'Connection: close',
'',
message
].join('\r\n');
socket.write(response);
socket.end();
});
}
};
```
### 2.3 Benefits of Context in Socket Handlers
With routeContext as a second parameter, socket handlers can:
- Access client IP for logging or rate limiting
- Use domain information for multi-tenant handling
- Check if connection is TLS and what version
- Access route name/ID for metrics
- Build more intelligent responses based on context
Example advanced handler:
```typescript
const rateLimitHandler = (maxRequests: number) => {
const ipCounts = new Map<string, number>();
return (socket: net.Socket, context: IRouteContext) => {
const count = (ipCounts.get(context.clientIp) || 0) + 1;
ipCounts.set(context.clientIp, count);
if (count > maxRequests) {
socket.write(`Rate limit exceeded for ${context.clientIp}\n`);
socket.end();
return;
}
// Process request...
};
};
```
---
## Phase 3: Update Helper Functions
### 3.1 Update createHttpToHttpsRedirect
```typescript
export function createHttpToHttpsRedirect(
domains: string | string[],
httpsPort: number = 443,
options: Partial<IRouteConfig> = {}
): IRouteConfig {
return {
name: options.name || `HTTP to HTTPS Redirect for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
match: {
ports: options.match?.ports || 80,
domains
},
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect(`https://{domain}:${httpsPort}{path}`, 301)
},
...options
};
}
```
### 3.2 Update createSocketHandlerRoute
```typescript
export function createSocketHandlerRoute(
domains: string | string[],
ports: TPortRange,
handler: TSocketHandler,
options: { name?: string; priority?: number; path?: string } = {}
): IRouteConfig {
return {
name: options.name || 'socket-handler-route',
priority: options.priority !== undefined ? options.priority : 50,
match: {
domains,
ports,
...(options.path && { path: options.path })
},
action: {
type: 'socket-handler',
socketHandler: handler
}
};
}
```
---
## Phase 4: Core Implementation Changes
### 4.1 Update Route Connection Handler
```typescript
// Remove these methods:
// - handleRedirectAction()
// - handleBlockAction()
// - handleStaticAction()
// Update switch statement to only have:
switch (route.action.type) {
case 'forward':
return this.handleForwardAction(socket, record, route, initialChunk);
case 'socket-handler':
this.handleSocketHandlerAction(socket, record, route, initialChunk);
return;
default:
logger.log('error', `Unknown action type '${(route.action as any).type}'`);
socket.end();
this.connectionManager.cleanupConnection(record, 'unknown_action');
}
```
### 4.2 Update Socket Handler to Pass Context
```typescript
private async handleSocketHandlerAction(
socket: plugins.net.Socket,
record: IConnectionRecord,
route: IRouteConfig,
initialChunk?: Buffer
): Promise<void> {
const connectionId = record.id;
// Create route context for the handler
const routeContext = this.createRouteContext({
connectionId: record.id,
port: record.localPort,
domain: record.lockedDomain,
clientIp: record.remoteIP,
serverIp: socket.localAddress || '',
isTls: record.isTLS || false,
tlsVersion: record.tlsVersion,
routeName: route.name,
routeId: route.id,
});
try {
// Call the handler with socket AND context
const result = route.action.socketHandler(socket, routeContext);
// Rest of implementation stays the same...
} catch (error) {
// Error handling...
}
}
```
### 4.3 Clean Up Imports and Exports
- Remove imports of deleted handler classes
- Update index.ts files to remove exports
- Clean up any unused imports
---
## Phase 5: Test Updates
### 5.1 Remove Old Tests
- Delete tests for redirect action type
- Delete tests for block action type
- Delete tests for static action type
### 5.2 Add New Socket Handler Tests
- Test block socket handler with context
- Test HTTP redirect socket handler with context
- Test that context is properly passed to all handlers
---
## Phase 6: Documentation Updates
### 6.1 Update README.md
- Remove documentation for redirect, block, static action types
- Document the two remaining action types: forward and socket-handler
- Add examples using socket handlers with context
### 6.2 Update Type Documentation
```typescript
/**
* Route action types
* - 'forward': Proxy the connection to a target host:port
* - 'socket-handler': Pass the socket to a custom handler function
*/
export type TRouteActionType = 'forward' | 'socket-handler';
/**
* Socket handler function
* @param socket - The incoming socket connection
* @param context - Route context with connection information
*/
export type TSocketHandler = (socket: net.Socket, context: IRouteContext) => void | Promise<void>;
```
### 6.3 Example Documentation
```typescript
// Example: Block connections from specific IPs
const ipBlocker = (socket: net.Socket, context: IRouteContext) => {
if (context.clientIp.startsWith('192.168.')) {
socket.write('Internal IPs not allowed\n');
socket.end();
return;
}
// Forward to backend...
};
// Example: Domain-based routing
const domainRouter = (socket: net.Socket, context: IRouteContext) => {
const backend = context.domain === 'api.example.com' ? 'api-server' : 'web-server';
// Forward to appropriate backend...
};
```
---
## Implementation Steps
1. **Update TSocketHandler type** (15 minutes)
- Add IRouteContext as second parameter
- Update type definition in route-types.ts
2. **Update socket handler implementation** (30 minutes)
- Create routeContext in handleSocketHandlerAction
- Pass context to socket handler function
- Update all existing socket handlers in route-helpers.ts
3. **Remove old action types** (30 minutes)
- Remove 'redirect', 'block', 'static' from TRouteActionType
- Remove IRouteRedirect, IRouteStatic interfaces
- Clean up IRouteAction interface
4. **Delete old handlers** (45 minutes)
- Delete handleRedirectAction, handleBlockAction, handleStaticAction methods
- Delete RedirectHandler and StaticHandler classes
- Remove imports and exports
5. **Update route connection handler** (30 minutes)
- Simplify switch statement to only handle 'forward' and 'socket-handler'
- Remove all references to deleted action types
6. **Create new socket handlers** (30 minutes)
- Implement SocketHandlers.block() with context
- Implement SocketHandlers.httpBlock() with context
- Implement SocketHandlers.httpRedirect() with context
7. **Update helper functions** (30 minutes)
- Update createHttpToHttpsRedirect to use socket handler
- Delete createStaticFileRoute entirely
- Update any other affected helpers
8. **Clean up tests** (1.5 hours)
- Delete all tests for removed action types
- Update socket handler tests to verify context parameter
- Add new tests for block/redirect socket handlers
9. **Update documentation** (30 minutes)
- Update README.md
- Update type documentation
- Add examples of context usage
**Total estimated time: ~5 hours**
---
## Considerations
### Benefits
- **Dramatically simpler API** - Only 2 action types instead of 5
- **Consistent handling model** - Everything is either forwarding or custom handling
- **More powerful** - Socket handlers with context can do much more than old static types
- **Less code to maintain** - Removing hundreds of lines of specialized handler code
- **Better extensibility** - Easy to add new socket handlers for any use case
- **Context awareness** - All handlers get full connection context
### Trade-offs
- Static file serving removed (users should use nginx/apache behind proxy)
- HTTP-specific logic (redirects) now in socket handlers (but more flexible)
- Slightly more verbose configuration for simple blocks/redirects
### Why This Approach
1. **Simplicity wins** - Two concepts are easier to understand than five
2. **Power through context** - Socket handlers with context are more capable
3. **Clean break** - No migration paths means cleaner code
4. **Future proof** - Easy to add new handlers without changing core
---
## Code Examples: Before and After
### Block Action
```typescript
// BEFORE
{
action: { type: 'block' }
}
// AFTER
{
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.block()
}
}
```
### HTTP Redirect
```typescript
// BEFORE
{
action: {
type: 'redirect',
redirect: {
to: 'https://{domain}:443{path}',
status: 301
}
}
}
// AFTER
{
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
}
}
```
### Custom Handler with Context
```typescript
// NEW CAPABILITY - Access to full context
{
action: {
type: 'socket-handler',
socketHandler: (socket, context) => {
console.log(`Connection from ${context.clientIp} to ${context.domain}:${context.port}`);
// Custom handling based on context...
}
}
}
```
---
## Detailed Implementation Tasks
### Step 1: Update TSocketHandler Type (15 minutes)
- [x] Open `ts/proxies/smart-proxy/models/route-types.ts`
- [x] Find line 14: `export type TSocketHandler = (socket: plugins.net.Socket) => void | Promise<void>;`
- [x] Import IRouteContext at top of file: `import type { IRouteContext } from '../../../core/models/route-context.js';`
- [x] Update TSocketHandler to: `export type TSocketHandler = (socket: plugins.net.Socket, context: IRouteContext) => void | Promise<void>;`
- [x] Save file
### Step 2: Update Socket Handler Implementation (30 minutes)
- [x] Open `ts/proxies/smart-proxy/route-connection-handler.ts`
- [x] Find `handleSocketHandlerAction` method (around line 790)
- [x] Add route context creation after line 809:
```typescript
// Create route context for the handler
const routeContext = this.createRouteContext({
connectionId: record.id,
port: record.localPort,
domain: record.lockedDomain,
clientIp: record.remoteIP,
serverIp: socket.localAddress || '',
isTls: record.isTLS || false,
tlsVersion: record.tlsVersion,
routeName: route.name,
routeId: route.id,
});
```
- [x] Update line 812 from `const result = route.action.socketHandler(socket);`
- [x] To: `const result = route.action.socketHandler(socket, routeContext);`
- [x] Save file
### Step 3: Update Existing Socket Handlers in route-helpers.ts (20 minutes)
- [x] Open `ts/proxies/smart-proxy/utils/route-helpers.ts`
- [x] Update `echo` handler (line 856):
- From: `echo: (socket: plugins.net.Socket) => {`
- To: `echo: (socket: plugins.net.Socket, context: IRouteContext) => {`
- [x] Update `proxy` handler (line 864):
- From: `proxy: (targetHost: string, targetPort: number) => (socket: plugins.net.Socket) => {`
- To: `proxy: (targetHost: string, targetPort: number) => (socket: plugins.net.Socket, context: IRouteContext) => {`
- [x] Update `lineProtocol` handler (line 879):
- From: `lineProtocol: (handler: (line: string, socket: plugins.net.Socket) => void) => (socket: plugins.net.Socket) => {`
- To: `lineProtocol: (handler: (line: string, socket: plugins.net.Socket) => void) => (socket: plugins.net.Socket, context: IRouteContext) => {`
- [ ] Update `httpResponse` handler (line 896):
- From: `httpResponse: (statusCode: number, body: string) => (socket: plugins.net.Socket) => {`
- To: `httpResponse: (statusCode: number, body: string) => (socket: plugins.net.Socket, context: IRouteContext) => {`
- [ ] Save file
### Step 4: Remove Old Action Types from Type Definitions (15 minutes)
- [ ] Open `ts/proxies/smart-proxy/models/route-types.ts`
- [ ] Find line with TRouteActionType (around line 10)
- [ ] Change from: `export type TRouteActionType = 'forward' | 'redirect' | 'block' | 'static' | 'socket-handler';`
- [ ] To: `export type TRouteActionType = 'forward' | 'socket-handler';`
- [ ] Find and delete IRouteRedirect interface (around line 123-126)
- [ ] Find and delete IRouteStatic interface (if exists)
- [ ] Find IRouteAction interface
- [ ] Remove these properties:
- `redirect?: IRouteRedirect;`
- `static?: IRouteStatic;`
- [ ] Save file
### Step 5: Delete Handler Classes (15 minutes)
- [ ] Delete file: `ts/proxies/http-proxy/handlers/redirect-handler.ts`
- [ ] Delete file: `ts/proxies/http-proxy/handlers/static-handler.ts`
- [ ] Open `ts/proxies/http-proxy/handlers/index.ts`
- [ ] Delete all content (the file only exports RedirectHandler and StaticHandler)
- [ ] Save empty file or delete it
### Step 6: Remove Handler Methods from RouteConnectionHandler (30 minutes)
- [ ] Open `ts/proxies/smart-proxy/route-connection-handler.ts`
- [ ] Find and delete entire `handleRedirectAction` method (around line 723)
- [ ] Find and delete entire `handleBlockAction` method (around line 750)
- [ ] Find and delete entire `handleStaticAction` method (around line 773)
- [ ] Remove imports at top:
- `import { RedirectHandler, StaticHandler } from '../http-proxy/handlers/index.js';`
- [ ] Save file
### Step 7: Update Switch Statement (15 minutes)
- [ ] Still in `route-connection-handler.ts`
- [ ] Find switch statement (around line 388)
- [ ] Remove these cases:
- `case 'redirect': return this.handleRedirectAction(...)`
- `case 'block': return this.handleBlockAction(...)`
- `case 'static': this.handleStaticAction(...); return;`
- [ ] Verify only 'forward' and 'socket-handler' cases remain
- [ ] Save file
### Step 8: Add New Socket Handlers to route-helpers.ts (30 minutes)
- [ ] Open `ts/proxies/smart-proxy/utils/route-helpers.ts`
- [ ] Add import at top: `import type { IRouteContext } from '../../../core/models/route-context.js';`
- [ ] Add to SocketHandlers object:
```typescript
/**
* Block connection immediately
*/
block: (message?: string) => (socket: plugins.net.Socket, context: IRouteContext) => {
const finalMessage = message || `Connection blocked from ${context.clientIp}`;
if (finalMessage) {
socket.write(finalMessage);
}
socket.end();
},
/**
* HTTP block response
*/
httpBlock: (statusCode: number = 403, message?: string) => (socket: plugins.net.Socket, context: IRouteContext) => {
const defaultMessage = `Access forbidden for ${context.domain || context.clientIp}`;
const finalMessage = message || defaultMessage;
const response = [
`HTTP/1.1 ${statusCode} ${finalMessage}`,
'Content-Type: text/plain',
`Content-Length: ${finalMessage.length}`,
'Connection: close',
'',
finalMessage
].join('\r\n');
socket.write(response);
socket.end();
},
/**
* HTTP redirect handler
*/
httpRedirect: (locationTemplate: string, statusCode: number = 301) => (socket: plugins.net.Socket, context: IRouteContext) => {
let buffer = '';
socket.once('data', (data) => {
buffer += data.toString();
const lines = buffer.split('\r\n');
const requestLine = lines[0];
const [method, path] = requestLine.split(' ');
const domain = context.domain || 'localhost';
const port = context.port;
let finalLocation = locationTemplate
.replace('{domain}', domain)
.replace('{port}', String(port))
.replace('{path}', path)
.replace('{clientIp}', context.clientIp);
const message = `Redirecting to ${finalLocation}`;
const response = [
`HTTP/1.1 ${statusCode} ${statusCode === 301 ? 'Moved Permanently' : 'Found'}`,
`Location: ${finalLocation}`,
'Content-Type: text/plain',
`Content-Length: ${message.length}`,
'Connection: close',
'',
message
].join('\r\n');
socket.write(response);
socket.end();
});
}
```
- [x] Save file
### Step 9: Update Helper Functions (20 minutes)
- [x] Still in `route-helpers.ts`
- [x] Update `createHttpToHttpsRedirect` function (around line 109):
- Change the action to use socket handler:
```typescript
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect(`https://{domain}:${httpsPort}{path}`, 301)
}
```
- [x] Delete entire `createStaticFileRoute` function (lines 277-322)
- [x] Save file
### Step 10: Update Test Files (1.5 hours)
#### 10.1 Update Socket Handler Tests
- [x] Open `test/test.socket-handler.ts`
- [x] Update all handler functions to accept context parameter
- [x] Open `test/test.socket-handler.simple.ts`
- [x] Update handler to accept context parameter
- [x] Open `test/test.socket-handler-race.ts`
- [x] Update handler to accept context parameter
#### 10.2 Find and Update/Delete Redirect Tests
- [x] Search for files containing `type: 'redirect'` in test directory
- [x] For each file:
- [x] If it's a redirect-specific test, delete the file
- [x] If it's a mixed test, update redirect actions to use socket handlers
- [x] Files to check:
- [x] `test/test.route-redirects.ts` - deleted entire file
- [x] `test/test.forwarding.ts` - update any redirect tests
- [x] `test/test.forwarding.examples.ts` - update any redirect tests
- [x] `test/test.route-config.ts` - update any redirect tests
#### 10.3 Find and Update/Delete Block Tests
- [x] Search for files containing `type: 'block'` in test directory
- [x] Update or delete as appropriate
#### 10.4 Find and Delete Static Tests
- [x] Search for files containing `type: 'static'` in test directory
- [x] Delete static-specific test files
- [x] Remove static tests from mixed test files
### Step 11: Clean Up Imports and Exports (20 minutes)
- [x] Open `ts/proxies/smart-proxy/utils/index.ts`
- [x] Ensure route-helpers.ts is exported
- [x] Remove any exports of deleted functions
- [x] Open `ts/index.ts`
- [x] Remove any exports of deleted types/interfaces
- [x] Search for any remaining imports of RedirectHandler or StaticHandler
- [x] Remove any found imports
### Step 12: Documentation Updates (30 minutes)
- [x] Update README.md:
- [x] Remove any mention of redirect, block, static action types
- [x] Add examples of socket handlers with context
- [x] Document the two action types: forward and socket-handler
- [x] Update any JSDoc comments in modified files
- [x] Add examples showing context usage
### Step 13: Final Verification (15 minutes)
- [x] Run build: `pnpm build`
- [x] Fix any compilation errors
- [x] Run tests: `pnpm test`
- [x] Fix any failing tests
- [x] Search codebase for any remaining references to:
- [x] 'redirect' action type
- [x] 'block' action type
- [x] 'static' action type
- [x] RedirectHandler
- [x] StaticHandler
- [x] IRouteRedirect
- [x] IRouteStatic
### Step 14: Test New Functionality (30 minutes)
- [x] Create test for block socket handler with context
- [x] Create test for httpBlock socket handler with context
- [x] Create test for httpRedirect socket handler with context
- [x] Verify context is properly passed in all scenarios
---
## Files to be Modified/Deleted
### Files to Modify:
1. `ts/proxies/smart-proxy/models/route-types.ts` - Update types
2. `ts/proxies/smart-proxy/route-connection-handler.ts` - Remove handlers, update switch
3. `ts/proxies/smart-proxy/utils/route-helpers.ts` - Update handlers, add new ones
4. `ts/proxies/http-proxy/handlers/index.ts` - Remove exports
5. Various test files - Update to use socket handlers
### Files to Delete:
1. `ts/proxies/http-proxy/handlers/redirect-handler.ts`
2. `ts/proxies/http-proxy/handlers/static-handler.ts`
3. `test/test.route-redirects.ts` (likely)
4. Any static-specific test files
### Test Files Requiring Updates (15 files found):
- test/test.acme-http01-challenge.ts
- test/test.logger-error-handling.ts
- test/test.port80-management.node.ts
- test/test.route-update-callback.node.ts
- test/test.acme-state-manager.node.ts
- test/test.acme-route-creation.ts
- test/test.forwarding.ts
- test/test.route-redirects.ts
- test/test.forwarding.examples.ts
- test/test.acme-simple.ts
- test/test.acme-http-challenge.ts
- test/test.certificate-provisioning.ts
- test/test.route-config.ts
- test/test.route-utils.ts
- test/test.certificate-simple.ts
---
## Success Criteria
- ✅ Only 'forward' and 'socket-handler' action types remain
- ✅ Socket handlers receive IRouteContext as second parameter
- ✅ All old handler code completely removed
- ✅ Redirect functionality works via context-aware socket handlers
- ✅ Block functionality works via context-aware socket handlers
- ✅ All tests updated and passing
- ✅ Documentation updated with new examples
- ✅ No performance regression
- ✅ Cleaner, simpler codebase

View File

@ -0,0 +1,21 @@
-----BEGIN CERTIFICATE-----
MIIDizCCAnOgAwIBAgIUAzpwtk6k5v/7LfY1KR7PreezvsswDQYJKoZIhvcNAQEL
BQAwVTELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFRlc3QxDTALBgNVBAcMBFRlc3Qx
DTALBgNVBAoMBFRlc3QxGTAXBgNVBAMMEHRlc3QuZXhhbXBsZS5jb20wHhcNMjUw
NTE5MTc1MDM0WhcNMjYwNTE5MTc1MDM0WjBVMQswCQYDVQQGEwJVUzENMAsGA1UE
CAwEVGVzdDENMAsGA1UEBwwEVGVzdDENMAsGA1UECgwEVGVzdDEZMBcGA1UEAwwQ
dGVzdC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB
AK9FivUNjXz5q+snqKLCno0i3cYzJ+LTzSf+x+a/G7CA/rtigIvSYEqWC4+/MXPM
ifpU/iIRtj7RzoPKH44uJie7mS5kKSHsMnh/qixaxxJph+tVYdNGi9hNvL12T/5n
ihXkpMAK8MV6z3Y+ObiaKbCe4w19sLu2IIpff0U0mo6rTKOQwAfGa/N1dtzFaogP
f/iO5kcksWUPqZowM3lwXXgy8vg5ZeU7IZk9fRTBfrEJAr9TCQ8ivdluxq59Ax86
0AMmlbeu/dUMBcujLiTVjzqD3jz/Hr+iHq2y48NiF3j5oE/1qsD04d+QDWAygdmd
bQOy0w/W1X0ppnuPhLILQzcCAwEAAaNTMFEwHQYDVR0OBBYEFID88wvDJXrQyTsx
s+zl/wwx5BCMMB8GA1UdIwQYMBaAFID88wvDJXrQyTsxs+zl/wwx5BCMMA8GA1Ud
EwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAIRp9bUxAip5s0dx700PPVAd
mrS7kDCZ+KFD6UgF/F3ykshh33MfYNLghJCfhcWvUHQgiPKohWcZq1g4oMuDZPFW
EHTr2wkX9j6A3KNjgFT5OVkLdjNPYdxMbTvmKbsJPc82C9AFN/Xz97XlZvmE4mKc
JCKqTz9hK3JpoayEUrf9g4TJcVwNnl/UnMp2sZX3aId4wD2+jSb40H/5UPFO2stv
SvCSdMcq0ZOQ/g/P56xOKV/5RAdIYV+0/3LWNGU/dH0nUfJO9K31e3eR+QZ1Iyn3
iGPcaSKPDptVx+2hxcvhFuRgRjfJ0mu6/hnK5wvhrXrSm43FBgvmlo4MaX0HVss=
-----END CERTIFICATE-----

28
test/helpers/test-key.pem Normal file
View File

@ -0,0 +1,28 @@
-----BEGIN PRIVATE KEY-----
MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQCvRYr1DY18+avr
J6iiwp6NIt3GMyfi080n/sfmvxuwgP67YoCL0mBKlguPvzFzzIn6VP4iEbY+0c6D
yh+OLiYnu5kuZCkh7DJ4f6osWscSaYfrVWHTRovYTby9dk/+Z4oV5KTACvDFes92
Pjm4mimwnuMNfbC7tiCKX39FNJqOq0yjkMAHxmvzdXbcxWqID3/4juZHJLFlD6ma
MDN5cF14MvL4OWXlOyGZPX0UwX6xCQK/UwkPIr3ZbsaufQMfOtADJpW3rv3VDAXL
oy4k1Y86g948/x6/oh6tsuPDYhd4+aBP9arA9OHfkA1gMoHZnW0DstMP1tV9KaZ7
j4SyC0M3AgMBAAECggEAKfW6ng74C+7TtxDAAPMZtQ0fTcdKabWt/EC1B6tBzEAd
e6vJvW+IaOLB8tBhXOkfMSRu0KYv3Jsq1wcpBcdLkCCLu/zzkfDzZkCd809qMCC+
jtraeBOAADEgGbV80hlkh/g8btNPr99GUnb0J5sUlvl6vuyTxmSEJsxU8jL1O2km
YgK34fS5NS73h138P3UQAGC0dGK8Rt61EsFIKWTyH/r8tlz9nQrYcDG3LwTbFQQf
bsRLAjolxTRV6t1CzcjsSGtrAqm/4QNypP5McCyOXAqajb3pNGaJyGg1nAEOZclK
oagU7PPwaFmSquwo7Y1Uov72XuLJLVryBl0fOCen7QKBgQDieqvaL9gHsfaZKNoY
+0Cnul/Dw0kjuqJIKhar/mfLY7NwYmFSgH17r26g+X7mzuzaN0rnEhjh7L3j6xQJ
qhs9zL+/OIa581Ptvb8H/42O+mxnqx7Z8s5JwH0+f5EriNkU3euoAe/W9x4DqJiE
2VyvlM1gngxI+vFo+iewmg+vOwKBgQDGHiPKxXWD50tXvvDdRTjH+/4GQuXhEQjl
Po59AJ/PLc/AkQkVSzr8Fspf7MHN6vufr3tS45tBuf5Qf2Y9GPBRKR3e+M1CJdoi
1RXy0nMsnR0KujxgiIe6WQFumcT81AsIVXtDYk11Sa057tYPeeOmgtmUMJZb6lek
wqUxrFw0NQKBgQCs/p7+jsUpO5rt6vKNWn5MoGQ+GJFppUoIbX3b6vxFs+aA1eUZ
K+St8ZdDhtCUZUMufEXOs1gmWrvBuPMZXsJoNlnRKtBegat+Ug31ghMTP95GYcOz
H3DLjSkd8DtnUaTf95PmRXR6c1CN4t59u7q8s6EdSByCMozsbwiaMVQBuQKBgQCY
QxG/BYMLnPeKuHTlmg3JpSHWLhP+pdjwVuOrro8j61F/7ffNJcRvehSPJKbOW4qH
b5aYXdU07n1F4KPy0PfhaHhMpWsbK3w6yQnVVWivIRDw7bD5f/TQgxdWqVd7+HuC
LDBP2X0uZzF7FNPvkP4lOut9uNnWSoSRXAcZ5h33AQKBgQDWJYKGNoA8/IT9+e8n
v1Fy0RNL/SmBfGZW9pFGFT2pcu6TrzVSugQeWY/YFO2X6FqLPbL4p72Ar4rF0Uxl
31aYIjy3jDGzMabdIuW7mBogvtNjBG+0UgcLQzbdG6JkvTkQgqUjwIn/+Jo+0sS5
dEylNM0zC6zx1f1U1dGGZaNcLg==
-----END PRIVATE KEY-----

View File

@ -1,6 +1,6 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as plugins from '../ts/plugins.js';
import { SmartProxy } from '../ts/index.js';
import { SmartProxy, SocketHandlers } from '../ts/index.js';
tap.test('should handle HTTP requests on port 80 for ACME challenges', async (tools) => {
tools.timeout(10000);
@ -17,22 +17,19 @@ tap.test('should handle HTTP requests on port 80 for ACME challenges', async (to
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'static' as const,
handler: async (context) => {
type: 'socket-handler' as const,
socketHandler: SocketHandlers.httpServer((req, res) => {
handledRequests.push({
path: context.path,
method: context.method,
headers: context.headers
path: req.url,
method: req.method,
headers: req.headers
});
// Simulate ACME challenge response
const token = context.path?.split('/').pop() || '';
return {
status: 200,
headers: { 'Content-Type': 'text/plain' },
body: `challenge-response-for-${token}`
};
}
const token = req.url?.split('/').pop() || '';
res.header('Content-Type', 'text/plain');
res.send(`challenge-response-for-${token}`);
})
}
}
]
@ -79,17 +76,18 @@ tap.test('should parse HTTP headers correctly', async (tools) => {
ports: [18081]
},
action: {
type: 'static' as const,
handler: async (context) => {
Object.assign(capturedContext, context);
return {
status: 200,
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
received: context.headers
})
};
}
type: 'socket-handler' as const,
socketHandler: SocketHandlers.httpServer((req, res) => {
Object.assign(capturedContext, {
path: req.url,
method: req.method,
headers: req.headers
});
res.header('Content-Type', 'application/json');
res.send(JSON.stringify({
received: req.headers
}));
})
}
}
]

View File

@ -0,0 +1,162 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy, SocketHandlers } from '../ts/index.js';
import * as net from 'net';
// Test that HTTP-01 challenges are properly processed when the initial data arrives
tap.test('should correctly handle HTTP-01 challenge requests with initial data chunk', async (tapTest) => {
// Prepare test data
const challengeToken = 'test-acme-http01-challenge-token';
const challengeResponse = 'mock-response-for-challenge';
const challengePath = `/.well-known/acme-challenge/${challengeToken}`;
// Create a socket handler that responds to ACME challenges using httpServer
const acmeHandler = SocketHandlers.httpServer((req, res) => {
// Log request details for debugging
console.log(`Received request: ${req.method} ${req.url}`);
// Check if this is an ACME challenge request
if (req.url?.startsWith('/.well-known/acme-challenge/')) {
const token = req.url.substring('/.well-known/acme-challenge/'.length);
// If the token matches our test token, return the response
if (token === challengeToken) {
res.header('Content-Type', 'text/plain');
res.send(challengeResponse);
return;
}
}
// For any other requests, return 404
res.status(404);
res.header('Content-Type', 'text/plain');
res.send('Not found');
});
// Create a proxy with the ACME challenge route
const proxy = new SmartProxy({
routes: [{
name: 'acme-challenge-route',
match: {
ports: 8080,
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'socket-handler',
socketHandler: acmeHandler
}
}]
});
await proxy.start();
// Create a client to test the HTTP-01 challenge
const testClient = new net.Socket();
let responseData = '';
// Set up client handlers
testClient.on('data', (data) => {
responseData += data.toString();
});
// Connect to the proxy and send the HTTP-01 challenge request
await new Promise<void>((resolve, reject) => {
testClient.connect(8080, 'localhost', () => {
// Send HTTP request for the challenge token
testClient.write(
`GET ${challengePath} HTTP/1.1\r\n` +
'Host: test.example.com\r\n' +
'User-Agent: ACME Challenge Test\r\n' +
'Accept: */*\r\n' +
'\r\n'
);
resolve();
});
testClient.on('error', reject);
});
// Wait for the response
await new Promise(resolve => setTimeout(resolve, 100));
// Verify that we received a valid HTTP response with the challenge token
expect(responseData).toContain('HTTP/1.1 200');
expect(responseData).toContain('Content-Type: text/plain');
expect(responseData).toContain(challengeResponse);
// Cleanup
testClient.destroy();
await proxy.stop();
});
// Test that non-existent challenge tokens return 404
tap.test('should return 404 for non-existent challenge tokens', async (tapTest) => {
// Create a socket handler that behaves like a real ACME handler
const acmeHandler = SocketHandlers.httpServer((req, res) => {
if (req.url?.startsWith('/.well-known/acme-challenge/')) {
const token = req.url.substring('/.well-known/acme-challenge/'.length);
// In this test, we only recognize one specific token
if (token === 'valid-token') {
res.header('Content-Type', 'text/plain');
res.send('valid-response');
return;
}
}
// For all other paths or unrecognized tokens, return 404
res.status(404);
res.header('Content-Type', 'text/plain');
res.send('Not found');
});
// Create a proxy with the ACME challenge route
const proxy = new SmartProxy({
routes: [{
name: 'acme-challenge-route',
match: {
ports: 8081,
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'socket-handler',
socketHandler: acmeHandler
}
}]
});
await proxy.start();
// Create a client to test the invalid challenge request
const testClient = new net.Socket();
let responseData = '';
testClient.on('data', (data) => {
responseData += data.toString();
});
// Connect and send a request for a non-existent token
await new Promise<void>((resolve, reject) => {
testClient.connect(8081, 'localhost', () => {
testClient.write(
'GET /.well-known/acme-challenge/invalid-token HTTP/1.1\r\n' +
'Host: test.example.com\r\n' +
'\r\n'
);
resolve();
});
testClient.on('error', reject);
});
// Wait for the response
await new Promise(resolve => setTimeout(resolve, 100));
// Verify we got a 404 Not Found
expect(responseData).toContain('HTTP/1.1 404');
expect(responseData).toContain('Not found');
// Cleanup
testClient.destroy();
await proxy.stop();
});
tap.start();

View File

@ -29,7 +29,7 @@ tap.test('should create ACME challenge route with high ports', async (tools) =>
}
],
acme: {
email: 'test@example.com',
email: 'test@acmetest.local', // Use a non-forbidden domain
port: 18080, // High port for ACME challenges
useProduction: false // Use staging environment
}
@ -37,11 +37,43 @@ tap.test('should create ACME challenge route with high ports', async (tools) =>
const proxy = new SmartProxy(settings);
// Capture route updates
const originalUpdateRoutes = (proxy as any).updateRoutes.bind(proxy);
(proxy as any).updateRoutes = async function(routes: any[]) {
capturedRoutes.push([...routes]);
return originalUpdateRoutes(routes);
// Mock certificate manager to avoid ACME account creation
(proxy as any).createCertificateManager = async function() {
const mockCertManager = {
updateRoutesCallback: null as any,
setUpdateRoutesCallback: function(cb: any) {
this.updateRoutesCallback = cb;
// Simulate adding the ACME challenge route immediately
const challengeRoute = {
name: 'acme-challenge',
priority: 1000,
match: {
ports: 18080,
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'socket-handler',
socketHandler: () => {}
}
};
const updatedRoutes = [...proxy.settings.routes, challengeRoute];
capturedRoutes.push(updatedRoutes);
},
setHttpProxy: () => {},
setGlobalAcmeDefaults: () => {},
setAcmeStateManager: () => {},
initialize: async () => {},
provisionAllCertificates: async () => {},
stop: async () => {},
getAcmeOptions: () => settings.acme,
getState: () => ({ challengeRouteActive: false })
};
return mockCertManager;
};
// Also mock initializeCertificateManager to avoid real initialization
(proxy as any).initializeCertificateManager = async function() {
this.certManager = await this.createCertificateManager();
};
await proxy.start();
@ -53,7 +85,7 @@ tap.test('should create ACME challenge route with high ports', async (tools) =>
expect(challengeRoute).toBeDefined();
expect(challengeRoute.match.path).toEqual('/.well-known/acme-challenge/*');
expect(challengeRoute.match.ports).toEqual(18080);
expect(challengeRoute.action.type).toEqual('static');
expect(challengeRoute.action.type).toEqual('socket-handler');
expect(challengeRoute.priority).toEqual(1000);
await proxy.stop();
@ -64,6 +96,7 @@ tap.test('should handle HTTP request parsing correctly', async (tools) => {
let handlerCalled = false;
let receivedContext: any;
let parsedRequest: any = {};
const settings = {
routes: [
@ -74,15 +107,43 @@ tap.test('should handle HTTP request parsing correctly', async (tools) => {
path: '/test/*'
},
action: {
type: 'static' as const,
handler: async (context) => {
type: 'socket-handler' as const,
socketHandler: (socket, context) => {
handlerCalled = true;
receivedContext = context;
return {
status: 200,
headers: { 'Content-Type': 'text/plain' },
body: 'OK'
};
// Parse HTTP request from socket
socket.once('data', (data) => {
const request = data.toString();
const lines = request.split('\r\n');
const [method, path, protocol] = lines[0].split(' ');
// Parse headers
const headers: any = {};
for (let i = 1; i < lines.length; i++) {
if (lines[i] === '') break;
const [key, value] = lines[i].split(': ');
if (key && value) {
headers[key.toLowerCase()] = value;
}
}
// Store parsed request data
parsedRequest = { method, path, headers };
// Send HTTP response
const response = [
'HTTP/1.1 200 OK',
'Content-Type: text/plain',
'Content-Length: 2',
'Connection: close',
'',
'OK'
].join('\r\n');
socket.write(response);
socket.end();
});
}
}
}
@ -131,9 +192,15 @@ tap.test('should handle HTTP request parsing correctly', async (tools) => {
// Verify handler was called
expect(handlerCalled).toBeTrue();
expect(receivedContext).toBeDefined();
expect(receivedContext.path).toEqual('/test/example');
expect(receivedContext.method).toEqual('GET');
expect(receivedContext.headers.host).toEqual('localhost:18090');
// The context passed to socket handlers is IRouteContext, not HTTP request data
expect(receivedContext.port).toEqual(18090);
expect(receivedContext.routeName).toEqual('test-static');
// Verify the parsed HTTP request data
expect(parsedRequest.path).toEqual('/test/example');
expect(parsedRequest.method).toEqual('GET');
expect(parsedRequest.headers.host).toEqual('localhost:18090');
await proxy.stop();
});

View File

@ -84,14 +84,26 @@ tap.test('should configure ACME challenge route', async () => {
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'static',
handler: async (context: any) => {
const token = context.path?.split('/').pop() || '';
return {
status: 200,
headers: { 'Content-Type': 'text/plain' },
body: `challenge-response-${token}`
};
type: 'socket-handler',
socketHandler: (socket: any, context: any) => {
socket.once('data', (data: Buffer) => {
const request = data.toString();
const lines = request.split('\r\n');
const [method, path] = lines[0].split(' ');
const token = path?.split('/').pop() || '';
const response = [
'HTTP/1.1 200 OK',
'Content-Type: text/plain',
`Content-Length: ${('challenge-response-' + token).length}`,
'Connection: close',
'',
`challenge-response-${token}`
].join('\r\n');
socket.write(response);
socket.end();
});
}
}
};
@ -101,16 +113,8 @@ tap.test('should configure ACME challenge route', async () => {
expect(challengeRoute.match.ports).toEqual(80);
expect(challengeRoute.priority).toEqual(1000);
// Test the handler
const context = {
path: '/.well-known/acme-challenge/test-token',
method: 'GET',
headers: {}
};
const response = await challengeRoute.action.handler(context);
expect(response.status).toEqual(200);
expect(response.body).toEqual('challenge-response-test-token');
// Socket handlers are tested differently - they handle raw sockets
expect(challengeRoute.action.socketHandler).toBeDefined();
});
tap.start();

View File

@ -0,0 +1,122 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/index.js';
// Test that certificate provisioning is deferred until after ports are listening
tap.test('should defer certificate provisioning until ports are ready', async (tapTest) => {
// Track when operations happen
let portsListening = false;
let certProvisioningStarted = false;
let operationOrder: string[] = [];
// Create proxy with certificate route but without real ACME
const proxy = new SmartProxy({
routes: [{
name: 'test-route',
match: {
ports: 8443,
domains: ['test.local']
},
action: {
type: 'forward',
target: { host: 'localhost', port: 8181 },
tls: {
mode: 'terminate',
certificate: 'auto',
acme: {
email: 'test@local.dev',
useProduction: false
}
}
}
}]
});
// Override the certificate manager creation to avoid real ACME
const originalCreateCertManager = proxy['createCertificateManager'];
proxy['createCertificateManager'] = async function(...args: any[]) {
console.log('Creating mock cert manager');
operationOrder.push('create-cert-manager');
const mockCertManager = {
certStore: null,
smartAcme: null,
httpProxy: null,
renewalTimer: null,
pendingChallenges: new Map(),
challengeRoute: null,
certStatus: new Map(),
globalAcmeDefaults: null,
updateRoutesCallback: undefined,
challengeRouteActive: false,
isProvisioning: false,
acmeStateManager: null,
initialize: async () => {
operationOrder.push('cert-manager-init');
console.log('Mock cert manager initialized');
},
provisionAllCertificates: async () => {
operationOrder.push('cert-provisioning');
certProvisioningStarted = true;
// Check that ports are listening when provisioning starts
if (!portsListening) {
throw new Error('Certificate provisioning started before ports ready!');
}
console.log('Mock certificate provisioning (ports are ready)');
},
stop: async () => {},
setHttpProxy: () => {},
setGlobalAcmeDefaults: () => {},
setAcmeStateManager: () => {},
setUpdateRoutesCallback: () => {},
getAcmeOptions: () => ({}),
getState: () => ({ challengeRouteActive: false }),
getCertStatus: () => new Map(),
checkAndRenewCertificates: async () => {},
addChallengeRoute: async () => {},
removeChallengeRoute: async () => {},
getCertificate: async () => null,
isValidCertificate: () => false,
waitForProvisioning: async () => {}
} as any;
// Call initialize immediately as the real createCertificateManager does
await mockCertManager.initialize();
return mockCertManager;
};
// Track port manager operations
const originalAddPorts = proxy['portManager'].addPorts;
proxy['portManager'].addPorts = async function(ports: number[]) {
operationOrder.push('ports-starting');
const result = await originalAddPorts.call(this, ports);
operationOrder.push('ports-ready');
portsListening = true;
console.log('Ports are now listening');
return result;
};
// Start the proxy
await proxy.start();
// Log the operation order for debugging
console.log('Operation order:', operationOrder);
// Verify operations happened in the correct order
expect(operationOrder).toContain('create-cert-manager');
expect(operationOrder).toContain('cert-manager-init');
expect(operationOrder).toContain('ports-starting');
expect(operationOrder).toContain('ports-ready');
expect(operationOrder).toContain('cert-provisioning');
// Verify ports were ready before certificate provisioning
const portsReadyIndex = operationOrder.indexOf('ports-ready');
const certProvisioningIndex = operationOrder.indexOf('cert-provisioning');
expect(portsReadyIndex).toBeLessThan(certProvisioningIndex);
expect(certProvisioningStarted).toEqual(true);
expect(portsListening).toEqual(true);
await proxy.stop();
});
tap.start();

159
test/test.acme-timing.ts Normal file
View File

@ -0,0 +1,159 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/index.js';
import * as net from 'net';
// Test that certificate provisioning waits for ports to be ready
tap.test('should defer certificate provisioning until after ports are listening', async (tapTest) => {
// Track the order of operations
const operationLog: string[] = [];
// Create a mock server to verify ports are listening
let port80Listening = false;
const testServer = net.createServer(() => {
// We don't need to handle connections, just track that we're listening
});
// Try to use port 8080 instead of 80 to avoid permission issues in testing
const acmePort = 8080;
// Create proxy with ACME certificate requirement
const proxy = new SmartProxy({
useHttpProxy: [acmePort],
httpProxyPort: 8844,
acme: {
email: 'test@example.com',
useProduction: false,
port: acmePort
},
routes: [{
name: 'test-acme-route',
match: {
ports: 8443,
domains: ['test.local']
},
action: {
type: 'forward',
target: { host: 'localhost', port: 8181 },
tls: {
mode: 'terminate',
certificate: 'auto',
acme: {
email: 'test@example.com',
useProduction: false
}
}
}
}]
});
// Mock some internal methods to track operation order
const originalAddPorts = proxy['portManager'].addPorts;
proxy['portManager'].addPorts = async function(ports: number[]) {
operationLog.push('Starting port listeners');
const result = await originalAddPorts.call(this, ports);
operationLog.push('Port listeners started');
port80Listening = true;
return result;
};
// Track certificate provisioning
const originalProvisionAll = proxy['certManager'] ?
proxy['certManager']['provisionAllCertificates'] : null;
if (proxy['certManager']) {
proxy['certManager']['provisionAllCertificates'] = async function() {
operationLog.push('Starting certificate provisioning');
// Check if port 80 is listening
if (!port80Listening) {
operationLog.push('ERROR: Certificate provisioning started before ports ready');
}
// Don't actually provision certificates in the test
operationLog.push('Certificate provisioning completed');
};
}
// Start the proxy
await proxy.start();
// Verify the order of operations
expect(operationLog).toContain('Starting port listeners');
expect(operationLog).toContain('Port listeners started');
expect(operationLog).toContain('Starting certificate provisioning');
// Ensure port listeners started before certificate provisioning
const portStartIndex = operationLog.indexOf('Port listeners started');
const certStartIndex = operationLog.indexOf('Starting certificate provisioning');
expect(portStartIndex).toBeLessThan(certStartIndex);
expect(operationLog).not.toContain('ERROR: Certificate provisioning started before ports ready');
await proxy.stop();
});
// Test that ACME challenge route is available when certificate is requested
tap.test('should have ACME challenge route ready before certificate provisioning', async (tapTest) => {
let challengeRouteActive = false;
let certificateProvisioningStarted = false;
const proxy = new SmartProxy({
useHttpProxy: [8080],
httpProxyPort: 8844,
acme: {
email: 'test@example.com',
useProduction: false,
port: 8080
},
routes: [{
name: 'test-route',
match: {
ports: 8443,
domains: ['test.example.com']
},
action: {
type: 'forward',
target: { host: 'localhost', port: 8181 },
tls: {
mode: 'terminate',
certificate: 'auto'
}
}
}]
});
// Mock the certificate manager to track operations
const originalInitialize = proxy['certManager'] ?
proxy['certManager'].initialize : null;
if (proxy['certManager']) {
const certManager = proxy['certManager'];
// Track when challenge route is added
const originalAddChallenge = certManager['addChallengeRoute'];
certManager['addChallengeRoute'] = async function() {
await originalAddChallenge.call(this);
challengeRouteActive = true;
};
// Track when certificate provisioning starts
const originalProvisionAcme = certManager['provisionAcmeCertificate'];
certManager['provisionAcmeCertificate'] = async function(...args: any[]) {
certificateProvisioningStarted = true;
// Verify challenge route is active
expect(challengeRouteActive).toEqual(true);
// Don't actually provision in test
return;
};
}
await proxy.start();
// Give it a moment to complete initialization
await new Promise(resolve => setTimeout(resolve, 100));
// Verify challenge route was added before any certificate provisioning
expect(challengeRouteActive).toEqual(true);
await proxy.stop();
});
tap.start();

View File

@ -4,7 +4,7 @@ import { expect, tap } from '@git.zone/tstest/tapbundle';
const testProxy = new SmartProxy({
routes: [{
name: 'test-route',
match: { ports: 443, domains: 'test.example.com' },
match: { ports: 9443, domains: 'test.example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
@ -17,7 +17,10 @@ const testProxy = new SmartProxy({
}
}
}
}]
}],
acme: {
port: 9080 // Use high port for ACME challenges
}
});
tap.test('should provision certificate automatically', async () => {
@ -38,7 +41,7 @@ tap.test('should handle static certificates', async () => {
const proxy = new SmartProxy({
routes: [{
name: 'static-route',
match: { ports: 443, domains: 'static.example.com' },
match: { ports: 9444, domains: 'static.example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
@ -67,7 +70,7 @@ tap.test('should handle ACME challenge routes', async () => {
const proxy = new SmartProxy({
routes: [{
name: 'auto-cert-route',
match: { ports: 443, domains: 'acme.example.com' },
match: { ports: 9445, domains: 'acme.example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
@ -77,18 +80,21 @@ tap.test('should handle ACME challenge routes', async () => {
acme: {
email: 'acme@example.com',
useProduction: false,
challengePort: 80
challengePort: 9081
}
}
}
}, {
name: 'port-80-route',
match: { ports: 80, domains: 'acme.example.com' },
name: 'port-9081-route',
match: { ports: 9081, domains: 'acme.example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 }
}
}]
}],
acme: {
port: 9081 // Use high port for ACME challenges
}
});
await proxy.start();
@ -109,7 +115,7 @@ tap.test('should renew certificates', async () => {
const proxy = new SmartProxy({
routes: [{
name: 'renew-route',
match: { ports: 443, domains: 'renew.example.com' },
match: { ports: 9446, domains: 'renew.example.com' },
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 },
@ -123,7 +129,10 @@ tap.test('should renew certificates', async () => {
}
}
}
}]
}],
acme: {
port: 9082 // Use high port for ACME challenges
}
});
await proxy.start();

View File

@ -25,41 +25,36 @@ tap.test('should create SmartProxy with certificate routes', async () => {
expect(proxy.settings.routes.length).toEqual(1);
});
tap.test('should handle static route type', async () => {
// Create a test route with static handler
const testResponse = {
status: 200,
headers: { 'Content-Type': 'text/plain' },
body: 'Hello from static route'
};
tap.test('should handle socket handler route type', async () => {
// Create a test route with socket handler
const proxy = new SmartProxy({
routes: [{
name: 'static-test',
name: 'socket-handler-test',
match: { ports: 8080, path: '/test' },
action: {
type: 'static',
handler: async () => testResponse
type: 'socket-handler',
socketHandler: (socket, context) => {
socket.once('data', (data) => {
const response = [
'HTTP/1.1 200 OK',
'Content-Type: text/plain',
'Content-Length: 23',
'Connection: close',
'',
'Hello from socket handler'
].join('\r\n');
socket.write(response);
socket.end();
});
}
}
}]
});
const route = proxy.settings.routes[0];
expect(route.action.type).toEqual('static');
expect(route.action.handler).toBeDefined();
// Test the handler
const result = await route.action.handler!({
port: 8080,
path: '/test',
clientIp: '127.0.0.1',
serverIp: '127.0.0.1',
isTls: false,
timestamp: Date.now(),
connectionId: 'test-123'
});
expect(result).toEqual(testResponse);
expect(route.action.type).toEqual('socket-handler');
expect(route.action.socketHandler).toBeDefined();
});
tap.start();

View File

@ -0,0 +1,294 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import * as tls from 'tls';
import * as fs from 'fs';
import * as path from 'path';
import { SmartProxy } from '../ts/proxies/smart-proxy/smart-proxy.js';
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
// Setup test infrastructure
const testCertPath = path.join(process.cwd(), 'test', 'helpers', 'test-cert.pem');
const testKeyPath = path.join(process.cwd(), 'test', 'helpers', 'test-key.pem');
let testServer: net.Server;
let tlsTestServer: tls.Server;
let smartProxy: SmartProxy;
tap.test('setup test servers', async () => {
// Create TCP test server
testServer = net.createServer((socket) => {
socket.write('Connected to TCP test server\n');
socket.on('data', (data) => {
socket.write(`TCP Echo: ${data}`);
});
});
await new Promise<void>((resolve) => {
testServer.listen(7001, '127.0.0.1', () => {
console.log('TCP test server listening on port 7001');
resolve();
});
});
// Create TLS test server for SNI testing
tlsTestServer = tls.createServer(
{
cert: fs.readFileSync(testCertPath),
key: fs.readFileSync(testKeyPath),
},
(socket) => {
socket.write('Connected to TLS test server\n');
socket.on('data', (data) => {
socket.write(`TLS Echo: ${data}`);
});
}
);
await new Promise<void>((resolve) => {
tlsTestServer.listen(7002, '127.0.0.1', () => {
console.log('TLS test server listening on port 7002');
resolve();
});
});
});
tap.test('should forward TCP connections correctly', async () => {
// Create SmartProxy with forward route
smartProxy = new SmartProxy({
enableDetailedLogging: true,
routes: [
{
id: 'tcp-forward',
name: 'TCP Forward Route',
match: {
ports: 8080,
},
action: {
type: 'forward',
target: {
host: '127.0.0.1',
port: 7001,
},
},
},
],
});
await smartProxy.start();
// Test TCP forwarding
const client = await new Promise<net.Socket>((resolve, reject) => {
const socket = net.connect(8080, '127.0.0.1', () => {
console.log('Connected to proxy');
resolve(socket);
});
socket.on('error', reject);
});
// Test data transmission
await new Promise<void>((resolve) => {
client.on('data', (data) => {
const response = data.toString();
console.log('Received:', response);
expect(response).toContain('Connected to TCP test server');
client.end();
resolve();
});
client.write('Hello from client');
});
await smartProxy.stop();
});
tap.test('should handle TLS passthrough correctly', async () => {
// Create SmartProxy with TLS passthrough route
smartProxy = new SmartProxy({
enableDetailedLogging: true,
routes: [
{
id: 'tls-passthrough',
name: 'TLS Passthrough Route',
match: {
ports: 8443,
domains: 'test.example.com',
},
action: {
type: 'forward',
tls: {
mode: 'passthrough',
},
target: {
host: '127.0.0.1',
port: 7002,
},
},
},
],
});
await smartProxy.start();
// Test TLS passthrough
const client = await new Promise<tls.TLSSocket>((resolve, reject) => {
const socket = tls.connect(
{
port: 8443,
host: '127.0.0.1',
servername: 'test.example.com',
rejectUnauthorized: false,
},
() => {
console.log('Connected via TLS');
resolve(socket);
}
);
socket.on('error', reject);
});
// Test data transmission over TLS
await new Promise<void>((resolve) => {
client.on('data', (data) => {
const response = data.toString();
console.log('TLS Received:', response);
expect(response).toContain('Connected to TLS test server');
client.end();
resolve();
});
client.write('Hello from TLS client');
});
await smartProxy.stop();
});
tap.test('should handle SNI-based forwarding', async () => {
// Create SmartProxy with multiple domain routes
smartProxy = new SmartProxy({
enableDetailedLogging: true,
routes: [
{
id: 'domain-a',
name: 'Domain A Route',
match: {
ports: 8443,
domains: 'a.example.com',
},
action: {
type: 'forward',
tls: {
mode: 'passthrough',
},
target: {
host: '127.0.0.1',
port: 7002,
},
},
},
{
id: 'domain-b',
name: 'Domain B Route',
match: {
ports: 8443,
domains: 'b.example.com',
},
action: {
type: 'forward',
target: {
host: '127.0.0.1',
port: 7001,
},
},
},
],
});
await smartProxy.start();
// Test domain A (TLS passthrough)
const clientA = await new Promise<tls.TLSSocket>((resolve, reject) => {
const socket = tls.connect(
{
port: 8443,
host: '127.0.0.1',
servername: 'a.example.com',
rejectUnauthorized: false,
},
() => {
console.log('Connected to domain A');
resolve(socket);
}
);
socket.on('error', reject);
});
await new Promise<void>((resolve) => {
clientA.on('data', (data) => {
const response = data.toString();
console.log('Domain A response:', response);
expect(response).toContain('Connected to TLS test server');
clientA.end();
resolve();
});
clientA.write('Hello from domain A');
});
// Test domain B (non-TLS forward)
const clientB = await new Promise<net.Socket>((resolve, reject) => {
const socket = net.connect(8443, '127.0.0.1', () => {
// Send TLS ClientHello with SNI for b.example.com
const clientHello = Buffer.from([
0x16, 0x03, 0x01, 0x00, 0x4e, // TLS Record header
0x01, 0x00, 0x00, 0x4a, // Handshake header
0x03, 0x03, // TLS version
// Random bytes
...Array(32).fill(0),
0x00, // Session ID length
0x00, 0x02, // Cipher suites length
0x00, 0x35, // Cipher suite
0x01, 0x00, // Compression methods
0x00, 0x1f, // Extensions length
0x00, 0x00, // SNI extension
0x00, 0x1b, // Extension length
0x00, 0x19, // SNI list length
0x00, // SNI type (hostname)
0x00, 0x16, // SNI length
// "b.example.com" in ASCII
0x62, 0x2e, 0x65, 0x78, 0x61, 0x6d, 0x70, 0x6c, 0x65, 0x2e, 0x63, 0x6f, 0x6d,
]);
socket.write(clientHello);
setTimeout(() => {
resolve(socket);
}, 100);
});
socket.on('error', reject);
});
await new Promise<void>((resolve) => {
clientB.on('data', (data) => {
const response = data.toString();
console.log('Domain B response:', response);
// Should be forwarded to TCP server
expect(response).toContain('Connected to TCP test server');
clientB.end();
resolve();
});
// Send regular data after initial handshake
setTimeout(() => {
clientB.write('Hello from domain B');
}, 200);
});
await smartProxy.stop();
});
tap.test('cleanup', async () => {
testServer.close();
tlsTestServer.close();
});
export default tap.start();

View File

@ -0,0 +1,131 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import { SmartProxy } from '../ts/proxies/smart-proxy/smart-proxy.js';
let testServer: net.Server;
let smartProxy: SmartProxy;
tap.test('setup test server', async () => {
// Create a test server that handles connections
testServer = await new Promise<net.Server>((resolve) => {
const server = net.createServer((socket) => {
console.log('Test server: Client connected');
socket.write('Welcome from test server\n');
socket.on('data', (data) => {
console.log(`Test server received: ${data.toString().trim()}`);
socket.write(`Echo: ${data}`);
});
socket.on('close', () => {
console.log('Test server: Client disconnected');
});
});
server.listen(6789, () => {
console.log('Test server listening on port 6789');
resolve(server);
});
});
});
tap.test('regular forward route should work correctly', async () => {
smartProxy = new SmartProxy({
routes: [{
id: 'test-forward',
name: 'Test Forward Route',
match: { ports: 7890 },
action: {
type: 'forward',
target: { host: 'localhost', port: 6789 }
}
}]
});
await smartProxy.start();
// Create a client connection
const client = await new Promise<net.Socket>((resolve, reject) => {
const socket = net.connect(7890, 'localhost', () => {
console.log('Client connected to proxy');
resolve(socket);
});
socket.on('error', reject);
});
// Test data exchange
const response = await new Promise<string>((resolve) => {
client.on('data', (data) => {
resolve(data.toString());
});
});
expect(response).toContain('Welcome from test server');
// Send data through proxy
client.write('Test message');
const echo = await new Promise<string>((resolve) => {
client.once('data', (data) => {
resolve(data.toString());
});
});
expect(echo).toContain('Echo: Test message');
client.end();
await smartProxy.stop();
});
tap.test('NFTables forward route should not terminate connections', async () => {
smartProxy = new SmartProxy({
routes: [{
id: 'nftables-test',
name: 'NFTables Test Route',
match: { ports: 7891 },
action: {
type: 'forward',
forwardingEngine: 'nftables',
target: { host: 'localhost', port: 6789 }
}
}]
});
await smartProxy.start();
// Create a client connection
const client = await new Promise<net.Socket>((resolve, reject) => {
const socket = net.connect(7891, 'localhost', () => {
console.log('Client connected to NFTables proxy');
resolve(socket);
});
socket.on('error', reject);
});
// With NFTables, the connection should stay open at the application level
// even though forwarding happens at kernel level
let connectionClosed = false;
client.on('close', () => {
connectionClosed = true;
});
// Wait a bit to ensure connection isn't immediately closed
await new Promise(resolve => setTimeout(resolve, 1000));
expect(connectionClosed).toEqual(false);
console.log('NFTables connection stayed open as expected');
client.end();
await smartProxy.stop();
});
tap.test('cleanup', async () => {
if (testServer) {
testServer.close();
}
if (smartProxy) {
await smartProxy.stop();
}
});
export default tap.start();

View File

@ -0,0 +1,111 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import { SmartProxy } from '../ts/proxies/smart-proxy/smart-proxy.js';
// Test to verify port forwarding works correctly
tap.test('forward connections should not be immediately closed', async (t) => {
// Create a backend server that accepts connections
const testServer = net.createServer((socket) => {
console.log('Client connected to test server');
socket.write('Welcome from test server\n');
socket.on('data', (data) => {
console.log('Test server received:', data.toString());
socket.write(`Echo: ${data}`);
});
socket.on('error', (err) => {
console.error('Test server socket error:', err);
});
});
// Listen on a non-privileged port
await new Promise<void>((resolve) => {
testServer.listen(9090, '127.0.0.1', () => {
console.log('Test server listening on port 9090');
resolve();
});
});
// Create SmartProxy with a forward route
const smartProxy = new SmartProxy({
enableDetailedLogging: true,
routes: [
{
id: 'forward-test',
name: 'Forward Test Route',
match: {
ports: 8080,
},
action: {
type: 'forward',
target: {
host: '127.0.0.1',
port: 9090,
},
},
},
],
});
await smartProxy.start();
// Create a client connection through the proxy
const client = net.createConnection({
port: 8080,
host: '127.0.0.1',
});
let connectionClosed = false;
let dataReceived = false;
let welcomeMessage = '';
client.on('connect', () => {
console.log('Client connected to proxy');
});
client.on('data', (data) => {
console.log('Client received:', data.toString());
dataReceived = true;
welcomeMessage = data.toString();
});
client.on('close', () => {
console.log('Client connection closed');
connectionClosed = true;
});
client.on('error', (err) => {
console.error('Client error:', err);
});
// Wait for the welcome message
let waitTime = 0;
while (!dataReceived && waitTime < 2000) {
await new Promise(resolve => setTimeout(resolve, 100));
waitTime += 100;
}
if (!dataReceived) {
throw new Error('Data should be received from the server');
}
// Verify we got the welcome message
expect(welcomeMessage).toContain('Welcome from test server');
// Send some data
client.write('Hello from client');
// Wait a bit to make sure connection isn't immediately closed
await new Promise(resolve => setTimeout(resolve, 100));
// Connection should still be open
expect(connectionClosed).toEqual(false);
// Clean up
client.end();
await smartProxy.stop();
testServer.close();
});
export default tap.start();

View File

@ -9,7 +9,6 @@ import {
createHttpToHttpsRedirect,
createCompleteHttpsServer,
createLoadBalancerRoute,
createStaticFileRoute,
createApiRoute,
createWebSocketRoute
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
@ -73,7 +72,7 @@ tap.test('Route-based configuration examples', async (tools) => {
expect(terminateToHttpRoute).toBeTruthy();
expect(terminateToHttpRoute.action.tls?.mode).toEqual('terminate');
expect(httpToHttpsRedirect.action.type).toEqual('redirect');
expect(httpToHttpsRedirect.action.type).toEqual('socket-handler');
// Example 4: Load Balancer with HTTPS
const loadBalancerRoute = createLoadBalancerRoute(
@ -124,21 +123,9 @@ tap.test('Route-based configuration examples', async (tools) => {
expect(Array.isArray(httpsServerRoutes)).toBeTrue();
expect(httpsServerRoutes.length).toEqual(2); // HTTPS route and HTTP redirect
expect(httpsServerRoutes[0].action.tls?.mode).toEqual('terminate');
expect(httpsServerRoutes[1].action.type).toEqual('redirect');
expect(httpsServerRoutes[1].action.type).toEqual('socket-handler');
// Example 7: Static File Server
const staticFileRoute = createStaticFileRoute(
'static.example.com',
'/var/www/static',
{
serveOnHttps: true,
certificate: 'auto',
name: 'Static File Server'
}
);
expect(staticFileRoute.action.type).toEqual('static');
expect(staticFileRoute.action.static?.root).toEqual('/var/www/static');
// Example 7: Static File Server - removed (use nginx/apache behind proxy)
// Example 8: WebSocket Route
const webSocketRoute = createWebSocketRoute(
@ -163,7 +150,6 @@ tap.test('Route-based configuration examples', async (tools) => {
loadBalancerRoute,
apiRoute,
...httpsServerRoutes,
staticFileRoute,
webSocketRoute
];
@ -175,7 +161,7 @@ tap.test('Route-based configuration examples', async (tools) => {
// Just verify that all routes are configured correctly
console.log(`Created ${allRoutes.length} example routes`);
expect(allRoutes.length).toEqual(10);
expect(allRoutes.length).toEqual(9); // One less without static file route
});
export default tap.start();

View File

@ -72,9 +72,10 @@ tap.test('Route Helpers - Create complete HTTPS server with redirect', async ()
expect(routes.length).toEqual(2);
// Check HTTP to HTTPS redirect - find route by action type
const redirectRoute = routes.find(r => r.action.type === 'redirect');
expect(redirectRoute.action.type).toEqual('redirect');
// Check HTTP to HTTPS redirect - find route by port
const redirectRoute = routes.find(r => r.match.ports === 80);
expect(redirectRoute.action.type).toEqual('socket-handler');
expect(redirectRoute.action.socketHandler).toBeDefined();
expect(redirectRoute.match.ports).toEqual(80);
// Check HTTPS route

183
test/test.http-fix-unit.ts Normal file
View File

@ -0,0 +1,183 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
// Unit test for the HTTP forwarding fix
tap.test('should forward non-TLS connections on HttpProxy ports', async (tapTest) => {
// Test configuration
const testPort = 8080;
const httpProxyPort = 8844;
// Track forwarding logic
let forwardedToHttpProxy = false;
let setupDirectConnection = false;
// Create mock settings
const mockSettings = {
useHttpProxy: [testPort],
httpProxyPort: httpProxyPort,
routes: [{
name: 'test-route',
match: { ports: testPort },
action: {
type: 'forward',
target: { host: 'localhost', port: 8181 }
}
}]
};
// Create mock connection record
const mockRecord = {
id: 'test-connection',
localPort: testPort,
remoteIP: '127.0.0.1',
isTLS: false
};
// Mock HttpProxyBridge
const mockHttpProxyBridge = {
getHttpProxy: () => ({ available: true }),
forwardToHttpProxy: async () => {
forwardedToHttpProxy = true;
}
};
// Test the logic from handleForwardAction
const route = mockSettings.routes[0];
const action = route.action as any;
// Simulate the fixed logic
if (!action.tls) {
// No TLS settings - check if this port should use HttpProxy
const isHttpProxyPort = mockSettings.useHttpProxy?.includes(mockRecord.localPort);
if (isHttpProxyPort && mockHttpProxyBridge.getHttpProxy()) {
// Forward non-TLS connections to HttpProxy if configured
console.log(`Using HttpProxy for non-TLS connection on port ${mockRecord.localPort}`);
await mockHttpProxyBridge.forwardToHttpProxy();
} else {
// Basic forwarding
console.log(`Using basic forwarding`);
setupDirectConnection = true;
}
}
// Verify the fix works correctly
expect(forwardedToHttpProxy).toEqual(true);
expect(setupDirectConnection).toEqual(false);
console.log('Test passed: Non-TLS connections on HttpProxy ports are forwarded correctly');
});
// Test that non-HttpProxy ports still use direct connection
tap.test('should use direct connection for non-HttpProxy ports', async (tapTest) => {
let forwardedToHttpProxy = false;
let setupDirectConnection = false;
const mockSettings = {
useHttpProxy: [80, 443], // Different ports
httpProxyPort: 8844,
routes: [{
name: 'test-route',
match: { ports: 8080 }, // Not in useHttpProxy
action: {
type: 'forward',
target: { host: 'localhost', port: 8181 }
}
}]
};
const mockRecord = {
id: 'test-connection-2',
localPort: 8080, // Not in useHttpProxy
remoteIP: '127.0.0.1',
isTLS: false
};
const mockHttpProxyBridge = {
getHttpProxy: () => ({ available: true }),
forwardToHttpProxy: async () => {
forwardedToHttpProxy = true;
}
};
const route = mockSettings.routes[0];
const action = route.action as any;
// Test the logic
if (!action.tls) {
const isHttpProxyPort = mockSettings.useHttpProxy?.includes(mockRecord.localPort);
if (isHttpProxyPort && mockHttpProxyBridge.getHttpProxy()) {
console.log(`Using HttpProxy for non-TLS connection on port ${mockRecord.localPort}`);
await mockHttpProxyBridge.forwardToHttpProxy();
} else {
console.log(`Using basic forwarding for port ${mockRecord.localPort}`);
setupDirectConnection = true;
}
}
// Verify port 8080 uses direct connection when not in useHttpProxy
expect(forwardedToHttpProxy).toEqual(false);
expect(setupDirectConnection).toEqual(true);
console.log('Test passed: Non-HttpProxy ports use direct connection');
});
// Test HTTP-01 ACME challenge scenario
tap.test('should handle ACME HTTP-01 challenges on port 80 with HttpProxy', async (tapTest) => {
let forwardedToHttpProxy = false;
const mockSettings = {
useHttpProxy: [80], // Port 80 configured for HttpProxy
httpProxyPort: 8844,
acme: {
port: 80,
email: 'test@example.com'
},
routes: [{
name: 'acme-challenge',
match: {
ports: 80,
paths: ['/.well-known/acme-challenge/*']
},
action: {
type: 'forward',
target: { host: 'localhost', port: 8080 }
}
}]
};
const mockRecord = {
id: 'acme-connection',
localPort: 80,
remoteIP: '127.0.0.1',
isTLS: false
};
const mockHttpProxyBridge = {
getHttpProxy: () => ({ available: true }),
forwardToHttpProxy: async () => {
forwardedToHttpProxy = true;
}
};
const route = mockSettings.routes[0];
const action = route.action as any;
// Test the fix for ACME HTTP-01 challenges
if (!action.tls) {
const isHttpProxyPort = mockSettings.useHttpProxy?.includes(mockRecord.localPort);
if (isHttpProxyPort && mockHttpProxyBridge.getHttpProxy()) {
console.log(`Using HttpProxy for ACME challenge on port ${mockRecord.localPort}`);
await mockHttpProxyBridge.forwardToHttpProxy();
}
}
// Verify HTTP-01 challenges on port 80 go through HttpProxy
expect(forwardedToHttpProxy).toEqual(true);
console.log('Test passed: ACME HTTP-01 challenges on port 80 use HttpProxy');
});
tap.start();

View File

@ -0,0 +1,168 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { RouteConnectionHandler } from '../ts/proxies/smart-proxy/route-connection-handler.js';
import type { ISmartProxyOptions } from '../ts/proxies/smart-proxy/models/interfaces.js';
import * as net from 'net';
// Direct test of the fix in RouteConnectionHandler
tap.test('should detect and forward non-TLS connections on useHttpProxy ports', async (tapTest) => {
// Create mock objects
const mockSettings: ISmartProxyOptions = {
useHttpProxy: [8080],
httpProxyPort: 8844,
routes: [{
name: 'test-route',
match: { ports: 8080 },
action: {
type: 'forward',
target: { host: 'localhost', port: 8181 }
}
}]
};
let httpProxyForwardCalled = false;
let directConnectionCalled = false;
// Create mocks for dependencies
const mockHttpProxyBridge = {
getHttpProxy: () => ({ available: true }),
forwardToHttpProxy: async (...args: any[]) => {
console.log('Mock: forwardToHttpProxy called');
httpProxyForwardCalled = true;
}
};
// Mock connection manager
const mockConnectionManager = {
createConnection: (socket: any) => ({
id: 'test-connection',
localPort: 8080,
remoteIP: '127.0.0.1',
isTLS: false
}),
initiateCleanupOnce: () => {},
cleanupConnection: () => {}
};
// Mock route manager that returns a matching route
const mockRouteManager = {
findMatchingRoute: (criteria: any) => ({
route: mockSettings.routes[0]
})
};
// Create route connection handler instance
const handler = new RouteConnectionHandler(
mockSettings,
mockConnectionManager as any,
{} as any, // security manager
{} as any, // tls manager
mockHttpProxyBridge as any,
{} as any, // timeout manager
mockRouteManager as any
);
// Override setupDirectConnection to track if it's called
handler['setupDirectConnection'] = (...args: any[]) => {
console.log('Mock: setupDirectConnection called');
directConnectionCalled = true;
};
// Test: Create a mock socket representing non-TLS connection on port 8080
const mockSocket = Object.create(net.Socket.prototype) as net.Socket;
Object.defineProperty(mockSocket, 'localPort', { value: 8080, writable: false });
Object.defineProperty(mockSocket, 'remoteAddress', { value: '127.0.0.1', writable: false });
// Simulate the handler processing the connection
handler.handleConnection(mockSocket);
// Simulate receiving non-TLS data
mockSocket.emit('data', Buffer.from('GET / HTTP/1.1\r\nHost: test.local\r\n\r\n'));
// Give it a moment to process
await new Promise(resolve => setTimeout(resolve, 100));
// Verify that the connection was forwarded to HttpProxy, not direct connection
expect(httpProxyForwardCalled).toEqual(true);
expect(directConnectionCalled).toEqual(false);
mockSocket.destroy();
});
// Test that verifies TLS connections still work normally
tap.test('should handle TLS connections normally', async (tapTest) => {
const mockSettings: ISmartProxyOptions = {
useHttpProxy: [443],
httpProxyPort: 8844,
routes: [{
name: 'tls-route',
match: { ports: 443 },
action: {
type: 'forward',
target: { host: 'localhost', port: 8443 },
tls: { mode: 'terminate' }
}
}]
};
let httpProxyForwardCalled = false;
const mockHttpProxyBridge = {
getHttpProxy: () => ({ available: true }),
forwardToHttpProxy: async (...args: any[]) => {
httpProxyForwardCalled = true;
}
};
const mockConnectionManager = {
createConnection: (socket: any) => ({
id: 'test-tls-connection',
localPort: 443,
remoteIP: '127.0.0.1',
isTLS: true,
tlsHandshakeComplete: false
}),
initiateCleanupOnce: () => {},
cleanupConnection: () => {}
};
const mockTlsManager = {
isTlsHandshake: (chunk: Buffer) => true,
isClientHello: (chunk: Buffer) => true,
extractSNI: (chunk: Buffer) => 'test.local'
};
const mockRouteManager = {
findMatchingRoute: (criteria: any) => ({
route: mockSettings.routes[0]
})
};
const handler = new RouteConnectionHandler(
mockSettings,
mockConnectionManager as any,
{} as any,
mockTlsManager as any,
mockHttpProxyBridge as any,
{} as any,
mockRouteManager as any
);
const mockSocket = Object.create(net.Socket.prototype) as net.Socket;
Object.defineProperty(mockSocket, 'localPort', { value: 443, writable: false });
Object.defineProperty(mockSocket, 'remoteAddress', { value: '127.0.0.1', writable: false });
handler.handleConnection(mockSocket);
// Simulate TLS handshake
const tlsHandshake = Buffer.from([0x16, 0x03, 0x01, 0x00, 0x05]);
mockSocket.emit('data', tlsHandshake);
await new Promise(resolve => setTimeout(resolve, 100));
// TLS connections with 'terminate' mode should go to HttpProxy
expect(httpProxyForwardCalled).toEqual(true);
mockSocket.destroy();
});
tap.start();

View File

@ -0,0 +1,151 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/index.js';
import * as net from 'net';
// Test that verifies HTTP connections on ports configured in useHttpProxy are properly forwarded
tap.test('should detect and forward non-TLS connections on HttpProxy ports', async (tapTest) => {
// Track whether the connection was forwarded to HttpProxy
let forwardedToHttpProxy = false;
let connectionPath = '';
// Create a SmartProxy instance first
const proxy = new SmartProxy({
useHttpProxy: [8080],
httpProxyPort: 8844,
routes: [{
name: 'test-http-forward',
match: { ports: 8080 },
action: {
type: 'forward',
target: { host: 'localhost', port: 8181 }
}
}]
});
// Mock the HttpProxy forwarding on the instance
const originalForward = (proxy as any).httpProxyBridge.forwardToHttpProxy;
(proxy as any).httpProxyBridge.forwardToHttpProxy = async function(...args: any[]) {
forwardedToHttpProxy = true;
connectionPath = 'httpproxy';
console.log('Mock: Connection forwarded to HttpProxy');
// Just close the connection for the test
args[1].end(); // socket.end()
};
// Add detailed logging to the existing proxy instance
proxy.settings.enableDetailedLogging = true;
// Override the HttpProxy initialization to avoid actual HttpProxy setup
proxy['httpProxyBridge'].getHttpProxy = () => ({} as any);
await proxy.start();
// Make a connection to port 8080
const client = new net.Socket();
await new Promise<void>((resolve, reject) => {
client.connect(8080, 'localhost', () => {
console.log('Client connected to proxy on port 8080');
// Send a non-TLS HTTP request
client.write('GET / HTTP/1.1\r\nHost: test.local\r\n\r\n');
resolve();
});
client.on('error', reject);
});
// Give it a moment to process
await new Promise(resolve => setTimeout(resolve, 100));
// Verify the connection was forwarded to HttpProxy
expect(forwardedToHttpProxy).toEqual(true);
expect(connectionPath).toEqual('httpproxy');
client.destroy();
await proxy.stop();
// Restore original method
// Restore original method
(proxy as any).httpProxyBridge.forwardToHttpProxy = originalForward;
});
// Test that verifies the fix detects non-TLS connections
tap.test('should properly detect non-TLS connections on HttpProxy ports', async (tapTest) => {
const targetPort = 8182;
let receivedConnection = false;
// Create a target server that never receives the connection (because it goes to HttpProxy)
const targetServer = net.createServer((socket) => {
receivedConnection = true;
socket.end();
});
await new Promise<void>((resolve) => {
targetServer.listen(targetPort, () => {
console.log(`Target server listening on port ${targetPort}`);
resolve();
});
});
// Mock HttpProxyBridge to track forwarding
let httpProxyForwardCalled = false;
const proxy = new SmartProxy({
useHttpProxy: [8080],
httpProxyPort: 8844,
routes: [{
name: 'test-route',
match: {
ports: 8080
},
action: {
type: 'forward',
target: { host: 'localhost', port: targetPort }
}
}]
});
// Override the forwardToHttpProxy method to track calls
const originalForward = proxy['httpProxyBridge'].forwardToHttpProxy;
proxy['httpProxyBridge'].forwardToHttpProxy = async function(...args: any[]) {
httpProxyForwardCalled = true;
console.log('HttpProxy forward called with connectionId:', args[0]);
// Just end the connection
args[1].end();
};
// Mock getHttpProxy to return a truthy value
proxy['httpProxyBridge'].getHttpProxy = () => ({} as any);
await proxy.start();
// Make a non-TLS connection
const client = new net.Socket();
await new Promise<void>((resolve, reject) => {
client.connect(8080, 'localhost', () => {
console.log('Connected to proxy');
client.write('GET / HTTP/1.1\r\nHost: test.local\r\n\r\n');
resolve();
});
client.on('error', () => resolve()); // Ignore errors since we're ending the connection
});
await new Promise(resolve => setTimeout(resolve, 100));
// Verify that HttpProxy was called, not direct connection
expect(httpProxyForwardCalled).toEqual(true);
expect(receivedConnection).toEqual(false); // Target should not receive direct connection
client.destroy();
await proxy.stop();
await new Promise<void>((resolve) => {
targetServer.close(() => resolve());
});
// Restore original method
proxy['httpProxyBridge'].forwardToHttpProxy = originalForward;
});
tap.start();

View File

@ -0,0 +1,160 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/index.js';
import * as http from 'http';
tap.test('should forward HTTP connections on port 8080 to HttpProxy', async (tapTest) => {
// Create a mock HTTP server to act as our target
const targetPort = 8181;
let receivedRequest = false;
let receivedPath = '';
const targetServer = http.createServer((req, res) => {
// Log request details for debugging
console.log(`Target server received: ${req.method} ${req.url}`);
receivedPath = req.url || '';
if (req.url === '/.well-known/acme-challenge/test-token') {
receivedRequest = true;
res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end('test-challenge-response');
} else {
res.writeHead(200);
res.end('OK');
}
});
await new Promise<void>((resolve) => {
targetServer.listen(targetPort, () => {
console.log(`Target server listening on port ${targetPort}`);
resolve();
});
});
// Create SmartProxy with port 8080 configured for HttpProxy
const proxy = new SmartProxy({
useHttpProxy: [8080], // Enable HttpProxy for port 8080
httpProxyPort: 8844,
enableDetailedLogging: true,
routes: [{
name: 'test-route',
match: {
ports: 8080,
domains: ['test.local']
},
action: {
type: 'forward',
target: { host: 'localhost', port: targetPort }
}
}]
});
await proxy.start();
// Give the proxy a moment to fully initialize
await new Promise(resolve => setTimeout(resolve, 500));
// Make an HTTP request to port 8080
const options = {
hostname: 'localhost',
port: 8080,
path: '/.well-known/acme-challenge/test-token',
method: 'GET',
headers: {
'Host': 'test.local'
}
};
const response = await new Promise<http.IncomingMessage>((resolve, reject) => {
const req = http.request(options, (res) => resolve(res));
req.on('error', reject);
req.end();
});
// Collect response data
let responseData = '';
response.setEncoding('utf8');
response.on('data', chunk => responseData += chunk);
await new Promise(resolve => response.on('end', resolve));
// Verify the request was properly forwarded
expect(response.statusCode).toEqual(200);
expect(receivedPath).toEqual('/.well-known/acme-challenge/test-token');
expect(responseData).toEqual('test-challenge-response');
expect(receivedRequest).toEqual(true);
await proxy.stop();
await new Promise<void>((resolve) => {
targetServer.close(() => resolve());
});
});
tap.test('should handle basic HTTP request forwarding', async (tapTest) => {
// Create a simple target server
const targetPort = 8182;
let receivedRequest = false;
const targetServer = http.createServer((req, res) => {
console.log(`Target received: ${req.method} ${req.url} from ${req.headers.host}`);
receivedRequest = true;
res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end('Hello from target');
});
await new Promise<void>((resolve) => {
targetServer.listen(targetPort, () => {
console.log(`Target server listening on port ${targetPort}`);
resolve();
});
});
// Create a simple proxy without HttpProxy
const proxy = new SmartProxy({
routes: [{
name: 'simple-forward',
match: {
ports: 8081,
domains: ['test.local']
},
action: {
type: 'forward',
target: { host: 'localhost', port: targetPort }
}
}]
});
await proxy.start();
await new Promise(resolve => setTimeout(resolve, 500));
// Make request
const options = {
hostname: 'localhost',
port: 8081,
path: '/test',
method: 'GET',
headers: {
'Host': 'test.local'
}
};
const response = await new Promise<http.IncomingMessage>((resolve, reject) => {
const req = http.request(options, (res) => resolve(res));
req.on('error', reject);
req.end();
});
let responseData = '';
response.setEncoding('utf8');
response.on('data', chunk => responseData += chunk);
await new Promise(resolve => response.on('end', resolve));
expect(response.statusCode).toEqual(200);
expect(responseData).toEqual('Hello from target');
expect(receivedRequest).toEqual(true);
await proxy.stop();
await new Promise<void>((resolve) => {
targetServer.close(() => resolve());
});
});
tap.start();

View File

@ -0,0 +1,245 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/index.js';
import * as plugins from '../ts/plugins.js';
import * as net from 'net';
import * as http from 'http';
/**
* This test verifies our improved port binding intelligence for ACME challenges.
* It specifically tests:
* 1. Using port 8080 instead of 80 for ACME HTTP challenges
* 2. Correctly handling shared port bindings between regular routes and challenge routes
* 3. Avoiding port conflicts when updating routes
*/
tap.test('should handle ACME challenges on port 8080 with improved port binding intelligence', async (tapTest) => {
// Create a simple echo server to act as our target
const targetPort = 9001;
let receivedData = '';
const targetServer = net.createServer((socket) => {
console.log('Target server received connection');
socket.on('data', (data) => {
receivedData += data.toString();
console.log('Target server received data:', data.toString().split('\n')[0]);
// Send a simple HTTP response
const response = 'HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 13\r\n\r\nHello, World!';
socket.write(response);
});
});
await new Promise<void>((resolve) => {
targetServer.listen(targetPort, () => {
console.log(`Target server listening on port ${targetPort}`);
resolve();
});
});
// In this test we will NOT create a mock ACME server on the same port
// as SmartProxy will use, instead we'll let SmartProxy handle it
const acmeServerPort = 9009;
const acmeRequests: string[] = [];
let acmeServer: http.Server | null = null;
// We'll assume the ACME port is available for SmartProxy
let acmePortAvailable = true;
// Create SmartProxy with ACME configured to use port 8080
console.log('Creating SmartProxy with ACME port 8080...');
const tempCertDir = './temp-certs';
try {
await plugins.smartfile.fs.ensureDir(tempCertDir);
} catch (error) {
// Directory may already exist, that's ok
}
const proxy = new SmartProxy({
enableDetailedLogging: true,
routes: [
{
name: 'test-route',
match: {
ports: [9003],
domains: ['test.example.com']
},
action: {
type: 'forward',
target: { host: 'localhost', port: targetPort },
tls: {
mode: 'terminate',
certificate: 'auto' // Use ACME for certificate
}
}
},
// Also add a route for port 8080 to test port sharing
{
name: 'http-route',
match: {
ports: [9009],
domains: ['test.example.com']
},
action: {
type: 'forward',
target: { host: 'localhost', port: targetPort }
}
}
],
acme: {
email: 'test@example.com',
useProduction: false,
port: 9009, // Use 9009 instead of default 80
certificateStore: tempCertDir
}
});
// Mock the certificate manager to avoid actual ACME operations
console.log('Mocking certificate manager...');
const createCertManager = (proxy as any).createCertificateManager;
(proxy as any).createCertificateManager = async function(...args: any[]) {
// Create a completely mocked certificate manager that doesn't use ACME at all
return {
initialize: async () => {},
getCertPair: async () => {
return {
publicKey: 'MOCK CERTIFICATE',
privateKey: 'MOCK PRIVATE KEY'
};
},
getAcmeOptions: () => {
return {
port: 9009
};
},
getState: () => {
return {
initializing: false,
ready: true,
port: 9009
};
},
provisionAllCertificates: async () => {
console.log('Mock: Provisioning certificates');
return [];
},
stop: async () => {},
smartAcme: {
getCertificateForDomain: async () => {
// Return a mock certificate
return {
publicKey: 'MOCK CERTIFICATE',
privateKey: 'MOCK PRIVATE KEY',
validUntil: Date.now() + 90 * 24 * 60 * 60 * 1000,
created: Date.now()
};
},
start: async () => {},
stop: async () => {}
}
};
};
// Track port binding attempts to verify intelligence
const portBindAttempts: number[] = [];
const originalAddPort = (proxy as any).portManager.addPort;
(proxy as any).portManager.addPort = async function(port: number) {
portBindAttempts.push(port);
return originalAddPort.call(this, port);
};
try {
console.log('Starting SmartProxy...');
await proxy.start();
console.log('Port binding attempts:', portBindAttempts);
// Check that we tried to bind to port 9009
// Should attempt to bind to port 9009
expect(portBindAttempts.includes(9009)).toEqual(true);
// Should attempt to bind to port 9003
expect(portBindAttempts.includes(9003)).toEqual(true);
// Get actual bound ports
const boundPorts = proxy.getListeningPorts();
console.log('Actually bound ports:', boundPorts);
// If port 9009 was available, we should be bound to it
if (acmePortAvailable) {
// Should be bound to port 9009 if available
expect(boundPorts.includes(9009)).toEqual(true);
}
// Should be bound to port 9003
expect(boundPorts.includes(9003)).toEqual(true);
// Test adding a new route on port 8080
console.log('Testing route update with port reuse...');
// Reset tracking
portBindAttempts.length = 0;
// Add a new route on port 8080
const newRoutes = [
...proxy.settings.routes,
{
name: 'additional-route',
match: {
ports: [9009],
path: '/additional'
},
action: {
type: 'forward' as const,
target: { host: 'localhost', port: targetPort }
}
}
];
// Update routes - this should NOT try to rebind port 8080
await proxy.updateRoutes(newRoutes);
console.log('Port binding attempts after update:', portBindAttempts);
// We should not try to rebind port 9009 since it's already bound
// Should not attempt to rebind port 9009
expect(portBindAttempts.includes(9009)).toEqual(false);
// We should still be listening on both ports
const portsAfterUpdate = proxy.getListeningPorts();
console.log('Bound ports after update:', portsAfterUpdate);
if (acmePortAvailable) {
// Should still be bound to port 9009
expect(portsAfterUpdate.includes(9009)).toEqual(true);
}
// Should still be bound to port 9003
expect(portsAfterUpdate.includes(9003)).toEqual(true);
// The test is successful at this point - we've verified the port binding intelligence
console.log('Port binding intelligence verified successfully!');
// We'll skip the actual connection test to avoid timeouts
} finally {
// Clean up
console.log('Cleaning up...');
await proxy.stop();
if (targetServer) {
await new Promise<void>((resolve) => {
targetServer.close(() => resolve());
});
}
// No acmeServer to close in this test
// Clean up temp directory
try {
// Remove temp directory
await plugins.smartfile.fs.remove(tempCertDir);
} catch (error) {
console.error('Failed to remove temp directory:', error);
}
}
});
tap.start();

View File

@ -0,0 +1,197 @@
import * as plugins from '../ts/plugins.js';
import { SmartProxy } from '../ts/index.js';
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { logger } from '../ts/core/utils/logger.js';
// Store the original logger reference
let originalLogger: any = logger;
let mockLogger: any;
// Create test routes using high ports to avoid permission issues
const createRoute = (id: number, domain: string, port: number = 8443) => ({
name: `test-route-${id}`,
match: {
ports: [port],
domains: [domain]
},
action: {
type: 'forward' as const,
target: {
host: 'localhost',
port: 3000 + id
},
tls: {
mode: 'terminate' as const,
certificate: 'auto' as const,
acme: {
email: 'test@testdomain.test',
useProduction: false
}
}
}
});
let testProxy: SmartProxy;
tap.test('should setup test proxy for logger error handling tests', async () => {
// Create a proxy for testing
testProxy = new SmartProxy({
routes: [createRoute(1, 'test1.error-handling.test', 8443)],
acme: {
email: 'test@testdomain.test',
useProduction: false,
port: 8080
}
});
// Mock the certificate manager to avoid actual ACME initialization
const originalCreateCertManager = (testProxy as any).createCertificateManager;
(testProxy as any).createCertificateManager = async function(routes: any[], certDir: string, acmeOptions: any, initialState?: any) {
const mockCertManager = {
setUpdateRoutesCallback: function(callback: any) {
this.updateRoutesCallback = callback;
},
updateRoutesCallback: null as any,
setHttpProxy: function() {},
setGlobalAcmeDefaults: function() {},
setAcmeStateManager: function() {},
initialize: async function() {},
provisionAllCertificates: async function() {},
stop: async function() {},
getAcmeOptions: function() {
return acmeOptions || { email: 'test@testdomain.test', useProduction: false };
},
getState: function() {
return initialState || { challengeRouteActive: false };
}
};
// Always set up the route update callback for ACME challenges
mockCertManager.setUpdateRoutesCallback(async (routes) => {
await this.updateRoutes(routes);
});
return mockCertManager;
};
// Mock initializeCertificateManager as well
(testProxy as any).initializeCertificateManager = async function() {
// Create mock cert manager using the method above
this.certManager = await this.createCertificateManager(
this.settings.routes,
'./certs',
{ email: 'test@testdomain.test', useProduction: false }
);
};
// Start the proxy with mocked components
await testProxy.start();
expect(testProxy).toBeTruthy();
});
tap.test('should handle logger errors in updateRoutes without failing', async () => {
// Temporarily inject the mock logger that throws errors
const origConsoleLog = console.log;
let consoleLogCalled = false;
// Spy on console.log to verify it's used as fallback
console.log = (...args: any[]) => {
consoleLogCalled = true;
// Call original implementation but mute the output for tests
// origConsoleLog(...args);
};
try {
// Create mock logger that throws
mockLogger = {
log: () => {
throw new Error('Simulated logger error');
}
};
// Override the logger in the imported module
// This is a hack but necessary for testing
(global as any).logger = mockLogger;
// Access the internal logger used by SmartProxy
const smartProxyImport = await import('../ts/proxies/smart-proxy/smart-proxy.js');
// @ts-ignore
smartProxyImport.logger = mockLogger;
// Update routes - this should not fail even with logger errors
const newRoutes = [
createRoute(1, 'test1.error-handling.test', 8443),
createRoute(2, 'test2.error-handling.test', 8444)
];
await testProxy.updateRoutes(newRoutes);
// Verify that the update was successful
expect((testProxy as any).settings.routes.length).toEqual(2);
expect(consoleLogCalled).toEqual(true);
} finally {
// Always restore console.log and logger
console.log = origConsoleLog;
(global as any).logger = originalLogger;
}
});
tap.test('should handle logger errors in certificate manager callbacks', async () => {
// Temporarily inject the mock logger that throws errors
const origConsoleLog = console.log;
let consoleLogCalled = false;
// Spy on console.log to verify it's used as fallback
console.log = (...args: any[]) => {
consoleLogCalled = true;
// Call original implementation but mute the output for tests
// origConsoleLog(...args);
};
try {
// Create mock logger that throws
mockLogger = {
log: () => {
throw new Error('Simulated logger error');
}
};
// Override the logger in the imported module
// This is a hack but necessary for testing
(global as any).logger = mockLogger;
// Access the cert manager and trigger the updateRoutesCallback
const certManager = (testProxy as any).certManager;
expect(certManager).toBeTruthy();
expect(certManager.updateRoutesCallback).toBeTruthy();
// Call the certificate manager's updateRoutesCallback directly
const challengeRoute = {
name: 'acme-challenge',
match: {
ports: [8080],
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'static' as const,
content: 'mock-challenge-content'
}
};
// This should not throw, despite logger errors
await certManager.updateRoutesCallback([...testProxy.settings.routes, challengeRoute]);
// Verify console.log was used as fallback
expect(consoleLogCalled).toEqual(true);
} finally {
// Always restore console.log and logger
console.log = origConsoleLog;
(global as any).logger = originalLogger;
}
});
tap.test('should clean up properly', async () => {
await testProxy.stop();
});
tap.start();

View File

@ -0,0 +1,116 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import { SmartProxy } from '../ts/proxies/smart-proxy/smart-proxy.js';
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
// Test to verify NFTables forwarding doesn't terminate connections
tap.test('NFTables forwarding should not terminate connections', async () => {
// Create a test server that receives connections
const testServer = net.createServer((socket) => {
socket.write('Connected to test server\n');
socket.on('data', (data) => {
socket.write(`Echo: ${data}`);
});
});
// Start test server
await new Promise<void>((resolve) => {
testServer.listen(8001, '127.0.0.1', () => {
console.log('Test server listening on port 8001');
resolve();
});
});
// Create SmartProxy with NFTables route
const smartProxy = new SmartProxy({
enableDetailedLogging: true,
routes: [
{
id: 'nftables-test',
name: 'NFTables Test Route',
match: {
ports: 8080,
},
action: {
type: 'forward',
forwardingEngine: 'nftables',
target: {
host: '127.0.0.1',
port: 8001,
},
},
},
// Also add regular forwarding route for comparison
{
id: 'regular-test',
name: 'Regular Forward Route',
match: {
ports: 8081,
},
action: {
type: 'forward',
target: {
host: '127.0.0.1',
port: 8001,
},
},
},
],
});
await smartProxy.start();
// Test NFTables route
const nftablesConnection = await new Promise<net.Socket>((resolve, reject) => {
const client = net.connect(8080, '127.0.0.1', () => {
console.log('Connected to NFTables route');
resolve(client);
});
client.on('error', reject);
});
// Add timeout to check if connection stays alive
await new Promise<void>((resolve) => {
let dataReceived = false;
nftablesConnection.on('data', (data) => {
console.log('NFTables route data:', data.toString());
dataReceived = true;
});
// Send test data
nftablesConnection.write('Test NFTables');
// Check connection after 100ms
setTimeout(() => {
// Connection should still be alive even if app doesn't handle it
expect(nftablesConnection.destroyed).toEqual(false);
nftablesConnection.end();
resolve();
}, 100);
});
// Test regular forwarding route for comparison
const regularConnection = await new Promise<net.Socket>((resolve, reject) => {
const client = net.connect(8081, '127.0.0.1', () => {
console.log('Connected to regular route');
resolve(client);
});
client.on('error', reject);
});
// Test regular connection works
await new Promise<void>((resolve) => {
regularConnection.on('data', (data) => {
console.log('Regular route data:', data.toString());
expect(data.toString()).toContain('Connected to test server');
regularConnection.end();
resolve();
});
});
// Cleanup
await smartProxy.stop();
testServer.close();
});
export default tap.start();

View File

@ -0,0 +1,100 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import { SmartProxy } from '../ts/proxies/smart-proxy/smart-proxy.js';
let echoServer: net.Server;
let proxy: SmartProxy;
tap.test('port forwarding should not immediately close connections', async (tools) => {
// Set a timeout for this test
tools.timeout(10000); // 10 seconds
// Create an echo server
echoServer = await new Promise<net.Server>((resolve) => {
const server = net.createServer((socket) => {
socket.on('data', (data) => {
socket.write(`ECHO: ${data}`);
});
});
server.listen(8888, () => {
console.log('Echo server listening on port 8888');
resolve(server);
});
});
// Create proxy with forwarding route
proxy = new SmartProxy({
routes: [{
id: 'test',
match: { ports: 9999 },
action: {
type: 'forward',
target: { host: 'localhost', port: 8888 }
}
}]
});
await proxy.start();
// Test connection through proxy
const client = net.createConnection(9999, 'localhost');
const result = await new Promise<string>((resolve, reject) => {
client.on('data', (data) => {
const response = data.toString();
client.end(); // Close the connection after receiving data
resolve(response);
});
client.on('error', reject);
client.write('Hello');
});
expect(result).toEqual('ECHO: Hello');
});
tap.test('TLS passthrough should work correctly', async () => {
// Create proxy with TLS passthrough
proxy = new SmartProxy({
routes: [{
id: 'tls-test',
match: { ports: 8443, domains: 'test.example.com' },
action: {
type: 'forward',
tls: { mode: 'passthrough' },
target: { host: 'localhost', port: 443 }
}
}]
});
await proxy.start();
// For now just verify the proxy starts correctly with TLS passthrough route
expect(proxy).toBeDefined();
await proxy.stop();
});
tap.test('cleanup', async () => {
if (echoServer) {
await new Promise<void>((resolve) => {
echoServer.close(() => {
console.log('Echo server closed');
resolve();
});
});
}
if (proxy) {
await proxy.stop();
console.log('Proxy stopped');
}
});
export default tap.start().then(() => {
// Force exit after tests complete
setTimeout(() => {
console.log('Forcing process exit');
process.exit(0);
}, 1000);
});

View File

@ -98,6 +98,13 @@ tap.test('should not double-register port 80 when user route and ACME use same p
};
// This would trigger route update in real implementation
},
provisionAllCertificates: async function() {
// Mock implementation to satisfy the call in SmartProxy.start()
// Add the ACME challenge port here too in case initialize was skipped
const challengePort = acmeOptions?.port || 80;
await mockPortManager.addPort(challengePort);
console.log(`Added ACME challenge port from provisionAllCertificates: ${challengePort}`);
},
getAcmeOptions: () => acmeOptions,
getState: () => ({ challengeRouteActive: false }),
stop: async () => {}
@ -175,9 +182,13 @@ tap.test('should handle ACME on different port than user routes', async (tools)
// Mock the port manager
const mockPortManager = {
addPort: async (port: number) => {
console.log(`Attempting to add port: ${port}`);
if (!activePorts.has(port)) {
activePorts.add(port);
portAddHistory.push(port);
console.log(`Port ${port} added to history`);
} else {
console.log(`Port ${port} already active, not adding to history`);
}
},
addPorts: async (ports: number[]) => {
@ -207,17 +218,31 @@ tap.test('should handle ACME on different port than user routes', async (tools)
setAcmeStateManager: function() {},
initialize: async function() {
// Simulate ACME route addition on different port
const challengePort = acmeOptions?.port || 80;
const challengeRoute = {
name: 'acme-challenge',
priority: 1000,
match: {
ports: acmeOptions?.port || 80,
ports: challengePort,
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'static'
}
};
// Add the ACME port to our port tracking
await mockPortManager.addPort(challengePort);
// For debugging
console.log(`Added ACME challenge port: ${challengePort}`);
},
provisionAllCertificates: async function() {
// Mock implementation to satisfy the call in SmartProxy.start()
// Add the ACME challenge port here too in case initialize was skipped
const challengePort = acmeOptions?.port || 80;
await mockPortManager.addPort(challengePort);
console.log(`Added ACME challenge port from provisionAllCertificates: ${challengePort}`);
},
getAcmeOptions: () => acmeOptions,
getState: () => ({ challengeRouteActive: false }),
@ -242,6 +267,9 @@ tap.test('should handle ACME on different port than user routes', async (tools)
await proxy.start();
// Log the port history for debugging
console.log('Port add history:', portAddHistory);
// Verify that all expected ports were added
expect(portAddHistory.includes(80)).toBeTrue(); // User route
expect(portAddHistory.includes(443)).toBeTrue(); // TLS route

View File

@ -30,22 +30,52 @@ tap.test('should set update routes callback on certificate manager', async () =>
}]
});
// Mock createCertificateManager to track callback setting
// Track callback setting
let callbackSet = false;
const originalCreate = (proxy as any).createCertificateManager;
(proxy as any).createCertificateManager = async function(...args: any[]) {
// Create the actual certificate manager
const certManager = await originalCreate.apply(this, args);
// Track if setUpdateRoutesCallback was called
const originalSet = certManager.setUpdateRoutesCallback;
certManager.setUpdateRoutesCallback = function(callback: any) {
callbackSet = true;
return originalSet.call(this, callback);
// Override createCertificateManager to track callback setting
(proxy as any).createCertificateManager = async function(
routes: any,
certStore: string,
acmeOptions?: any,
initialState?: any
) {
// Create a mock certificate manager
const mockCertManager = {
setUpdateRoutesCallback: function(callback: any) {
callbackSet = true;
},
setHttpProxy: function(proxy: any) {},
setGlobalAcmeDefaults: function(defaults: any) {},
setAcmeStateManager: function(manager: any) {},
initialize: async function() {},
provisionAllCertificates: async function() {},
stop: async function() {},
getAcmeOptions: function() { return acmeOptions || {}; },
getState: function() { return initialState || { challengeRouteActive: false }; }
};
return certManager;
// Mimic the real createCertificateManager behavior
// Always set up the route update callback for ACME challenges
mockCertManager.setUpdateRoutesCallback(async (routes) => {
await this.updateRoutes(routes);
});
// Connect with HttpProxy if available (mimic real behavior)
if ((this as any).httpProxyBridge.getHttpProxy()) {
mockCertManager.setHttpProxy((this as any).httpProxyBridge.getHttpProxy());
}
// Set the ACME state manager
mockCertManager.setAcmeStateManager((this as any).acmeStateManager);
// Pass down the global ACME config if available
if ((this as any).settings.acme) {
mockCertManager.setGlobalAcmeDefaults((this as any).settings.acme);
}
await mockCertManager.initialize();
return mockCertManager;
};
await proxy.start();

View File

@ -35,7 +35,6 @@ import {
createHttpToHttpsRedirect,
createCompleteHttpsServer,
createLoadBalancerRoute,
createStaticFileRoute,
createApiRoute,
createWebSocketRoute
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
@ -87,9 +86,8 @@ tap.test('Routes: Should create HTTP to HTTPS redirect', async () => {
// Validate the route configuration
expect(redirectRoute.match.ports).toEqual(80);
expect(redirectRoute.match.domains).toEqual('example.com');
expect(redirectRoute.action.type).toEqual('redirect');
expect(redirectRoute.action.redirect?.to).toEqual('https://{domain}:443{path}');
expect(redirectRoute.action.redirect?.status).toEqual(301);
expect(redirectRoute.action.type).toEqual('socket-handler');
expect(redirectRoute.action.socketHandler).toBeDefined();
});
tap.test('Routes: Should create complete HTTPS server with redirects', async () => {
@ -111,8 +109,8 @@ tap.test('Routes: Should create complete HTTPS server with redirects', async ()
// Validate HTTP redirect route
const redirectRoute = routes[1];
expect(redirectRoute.match.ports).toEqual(80);
expect(redirectRoute.action.type).toEqual('redirect');
expect(redirectRoute.action.redirect?.to).toEqual('https://{domain}:443{path}');
expect(redirectRoute.action.type).toEqual('socket-handler');
expect(redirectRoute.action.socketHandler).toBeDefined();
});
tap.test('Routes: Should create load balancer route', async () => {
@ -190,24 +188,7 @@ tap.test('Routes: Should create WebSocket route', async () => {
}
});
tap.test('Routes: Should create static file route', async () => {
// Create a static file route
const staticRoute = createStaticFileRoute('static.example.com', '/var/www/html', {
serveOnHttps: true,
certificate: 'auto',
indexFiles: ['index.html', 'index.htm', 'default.html'],
name: 'Static File Route'
});
// Validate the route configuration
expect(staticRoute.match.domains).toEqual('static.example.com');
expect(staticRoute.action.type).toEqual('static');
expect(staticRoute.action.static?.root).toEqual('/var/www/html');
expect(staticRoute.action.static?.index).toBeInstanceOf(Array);
expect(staticRoute.action.static?.index).toInclude('index.html');
expect(staticRoute.action.static?.index).toInclude('default.html');
expect(staticRoute.action.tls?.mode).toEqual('terminate');
});
// Static file serving has been removed - should be handled by external servers
tap.test('SmartProxy: Should create instance with route-based config', async () => {
// Create TLS certificates for testing
@ -515,11 +496,6 @@ tap.test('Route Integration - Combining Multiple Route Types', async () => {
certificate: 'auto'
}),
// Static assets
createStaticFileRoute('static.example.com', '/var/www/assets', {
serveOnHttps: true,
certificate: 'auto'
}),
// Legacy system with passthrough
createHttpsPassthroughRoute('legacy.example.com', { host: 'legacy-server', port: 443 })
@ -540,11 +516,11 @@ tap.test('Route Integration - Combining Multiple Route Types', async () => {
expect(webServerMatch.action.target.host).toEqual('web-server');
}
// Web server (HTTP redirect)
// Web server (HTTP redirect via socket handler)
const webRedirectMatch = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 });
expect(webRedirectMatch).not.toBeUndefined();
if (webRedirectMatch) {
expect(webRedirectMatch.action.type).toEqual('redirect');
expect(webRedirectMatch.action.type).toEqual('socket-handler');
}
// API server
@ -572,16 +548,7 @@ tap.test('Route Integration - Combining Multiple Route Types', async () => {
expect(wsMatch.action.websocket?.enabled).toBeTrue();
}
// Static assets
const staticMatch = findBestMatchingRoute(routes, {
domain: 'static.example.com',
port: 443
});
expect(staticMatch).not.toBeUndefined();
if (staticMatch) {
expect(staticMatch.action.type).toEqual('static');
expect(staticMatch.action.static.root).toEqual('/var/www/assets');
}
// Static assets route was removed - static file serving should be handled externally
// Legacy system
const legacyMatch = findBestMatchingRoute(routes, {

View File

@ -1,98 +0,0 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/proxies/smart-proxy/index.js';
import { createHttpToHttpsRedirect } from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
// Test that HTTP to HTTPS redirects work correctly
tap.test('should handle HTTP to HTTPS redirects', async (tools) => {
// Create a simple HTTP to HTTPS redirect route
const redirectRoute = createHttpToHttpsRedirect(
'example.com',
443,
{
name: 'HTTP to HTTPS Redirect Test'
}
);
// Verify the route is configured correctly
expect(redirectRoute.action.type).toEqual('redirect');
expect(redirectRoute.action.redirect).toBeTruthy();
expect(redirectRoute.action.redirect?.to).toEqual('https://{domain}:443{path}');
expect(redirectRoute.action.redirect?.status).toEqual(301);
expect(redirectRoute.match.ports).toEqual(80);
expect(redirectRoute.match.domains).toEqual('example.com');
});
tap.test('should handle custom redirect configurations', async (tools) => {
// Create a custom redirect route
const customRedirect: IRouteConfig = {
name: 'custom-redirect',
match: {
ports: [8080],
domains: ['old.example.com']
},
action: {
type: 'redirect',
redirect: {
to: 'https://new.example.com{path}',
status: 302
}
}
};
// Verify the route structure
expect(customRedirect.action.redirect?.to).toEqual('https://new.example.com{path}');
expect(customRedirect.action.redirect?.status).toEqual(302);
});
tap.test('should support multiple redirect scenarios', async (tools) => {
const routes: IRouteConfig[] = [
// HTTP to HTTPS redirect
createHttpToHttpsRedirect(['example.com', 'www.example.com']),
// Custom redirect with different port
{
name: 'custom-port-redirect',
match: {
ports: 8080,
domains: 'api.example.com'
},
action: {
type: 'redirect',
redirect: {
to: 'https://{domain}:8443{path}',
status: 308
}
}
},
// Redirect to different domain entirely
{
name: 'domain-redirect',
match: {
ports: 80,
domains: 'old-domain.com'
},
action: {
type: 'redirect',
redirect: {
to: 'https://new-domain.com{path}',
status: 301
}
}
}
];
// Create SmartProxy with redirect routes
const proxy = new SmartProxy({
routes
});
// Verify all routes are redirect type
routes.forEach(route => {
expect(route.action.type).toEqual('redirect');
expect(route.action.redirect).toBeTruthy();
});
});
export default tap.start();

View File

@ -60,6 +60,9 @@ tap.test('should preserve route update callback after updateRoutes', async () =>
// This is where the callback is actually set in the real implementation
return Promise.resolve();
},
provisionAllCertificates: async function() {
return Promise.resolve();
},
stop: async function() {},
getAcmeOptions: function() {
return { email: 'test@testdomain.test' };
@ -114,6 +117,7 @@ tap.test('should preserve route update callback after updateRoutes', async () =>
setGlobalAcmeDefaults: function() {},
setAcmeStateManager: function() {},
initialize: async function() {},
provisionAllCertificates: async function() {},
stop: async function() {},
getAcmeOptions: function() {
return { email: 'test@testdomain.test' };
@ -233,6 +237,7 @@ tap.test('should handle route updates when cert manager is not initialized', asy
updateRoutesCallback: null,
setHttpProxy: function() {},
initialize: async function() {},
provisionAllCertificates: async function() {},
stop: async function() {},
getAcmeOptions: function() {
return { email: 'test@testdomain.test' };
@ -295,6 +300,7 @@ tap.test('real code integration test - verify fix is applied', async () => {
setGlobalAcmeDefaults: function() {},
setAcmeStateManager: function() {},
initialize: async function() {},
provisionAllCertificates: async function() {},
stop: async function() {},
getAcmeOptions: function() {
return acmeOptions || { email: 'test@example.com', useProduction: false };

View File

@ -0,0 +1,99 @@
import * as plugins from '../ts/plugins.js';
import { SmartProxy } from '../ts/index.js';
import { SmartCertManager } from '../ts/proxies/smart-proxy/certificate-manager.js';
import { tap, expect } from '@git.zone/tstest/tapbundle';
// Create test routes using high ports to avoid permission issues
const createRoute = (id: number, domain: string, port: number = 8443) => ({
name: `test-route-${id}`,
match: {
ports: [port],
domains: [domain]
},
action: {
type: 'forward' as const,
target: {
host: 'localhost',
port: 3000 + id
}
}
});
// Test function to check if error handling is applied to logger calls
tap.test('should have error handling around logger calls in route update callbacks', async () => {
// Create a simple cert manager instance for testing
const certManager = new SmartCertManager(
[createRoute(1, 'test.example.com', 8443)],
'./certs',
{ email: 'test@example.com', useProduction: false }
);
// Create a mock update routes callback that tracks if it was called
let callbackCalled = false;
const mockCallback = async (routes: any[]) => {
callbackCalled = true;
// Just return without doing anything
return Promise.resolve();
};
// Set the callback
certManager.setUpdateRoutesCallback(mockCallback);
// Verify the callback was successfully set
expect(callbackCalled).toEqual(false);
// Create a test route
const testRoute = createRoute(2, 'test2.example.com', 8444);
// Verify we can add a challenge route without error
// This tests the try/catch we added around addChallengeRoute logger calls
try {
// Accessing private method for testing
// @ts-ignore
await (certManager as any).addChallengeRoute();
// If we got here without error, the error handling works
expect(true).toEqual(true);
} catch (error) {
// This shouldn't happen if our error handling is working
// Error handling failed in addChallengeRoute
expect(false).toEqual(true);
}
// Verify that we handle errors in removeChallengeRoute
try {
// Set the flag to active so we can test removal logic
// @ts-ignore
certManager.challengeRouteActive = true;
// @ts-ignore
await (certManager as any).removeChallengeRoute();
// If we got here without error, the error handling works
expect(true).toEqual(true);
} catch (error) {
// This shouldn't happen if our error handling is working
// Error handling failed in removeChallengeRoute
expect(false).toEqual(true);
}
});
// Test verifyChallengeRouteRemoved error handling
tap.test('should have error handling in verifyChallengeRouteRemoved', async () => {
// Create a SmartProxy for testing
const testProxy = new SmartProxy({
routes: [createRoute(1, 'test1.domain.test')]
});
// Verify that verifyChallengeRouteRemoved has error handling
try {
// @ts-ignore - Access private method for testing
await (testProxy as any).verifyChallengeRouteRemoved();
// If we got here without error, the try/catch is working
// (This will still throw at the end after max retries, but we're testing that
// the logger calls have try/catch blocks around them)
} catch (error) {
// This error is expected since we don't have a real challenge route
// But we're testing that the logger calls don't throw
expect(error.message).toContain('Failed to verify challenge route removal');
}
});
tap.start();

View File

@ -6,7 +6,6 @@ import {
// Route helpers
createHttpRoute,
createHttpsTerminateRoute,
createStaticFileRoute,
createApiRoute,
createWebSocketRoute,
createHttpToHttpsRedirect,
@ -43,7 +42,6 @@ import {
import {
// Route patterns
createApiGatewayRoute,
createStaticFileServerRoute,
createWebSocketRoute as createWebSocketPattern,
createLoadBalancerRoute as createLbPattern,
addRateLimiting,
@ -145,28 +143,16 @@ tap.test('Route Validation - validateRouteAction', async () => {
expect(validForwardResult.valid).toBeTrue();
expect(validForwardResult.errors.length).toEqual(0);
// Valid redirect action
const validRedirectAction: IRouteAction = {
type: 'redirect',
redirect: {
to: 'https://example.com',
status: 301
// Valid socket-handler action
const validSocketAction: IRouteAction = {
type: 'socket-handler',
socketHandler: (socket, context) => {
socket.end();
}
};
const validRedirectResult = validateRouteAction(validRedirectAction);
expect(validRedirectResult.valid).toBeTrue();
expect(validRedirectResult.errors.length).toEqual(0);
// Valid static action
const validStaticAction: IRouteAction = {
type: 'static',
static: {
root: '/var/www/html'
}
};
const validStaticResult = validateRouteAction(validStaticAction);
expect(validStaticResult.valid).toBeTrue();
expect(validStaticResult.errors.length).toEqual(0);
const validSocketResult = validateRouteAction(validSocketAction);
expect(validSocketResult.valid).toBeTrue();
expect(validSocketResult.errors.length).toEqual(0);
// Invalid action (missing target)
const invalidAction: IRouteAction = {
@ -177,24 +163,14 @@ tap.test('Route Validation - validateRouteAction', async () => {
expect(invalidResult.errors.length).toBeGreaterThan(0);
expect(invalidResult.errors[0]).toInclude('Target is required');
// Invalid action (missing redirect configuration)
const invalidRedirectAction: IRouteAction = {
type: 'redirect'
// Invalid action (missing socket handler)
const invalidSocketAction: IRouteAction = {
type: 'socket-handler'
};
const invalidRedirectResult = validateRouteAction(invalidRedirectAction);
expect(invalidRedirectResult.valid).toBeFalse();
expect(invalidRedirectResult.errors.length).toBeGreaterThan(0);
expect(invalidRedirectResult.errors[0]).toInclude('Redirect configuration is required');
// Invalid action (missing static root)
const invalidStaticAction: IRouteAction = {
type: 'static',
static: {} as any // Testing invalid static config without required 'root' property
};
const invalidStaticResult = validateRouteAction(invalidStaticAction);
expect(invalidStaticResult.valid).toBeFalse();
expect(invalidStaticResult.errors.length).toBeGreaterThan(0);
expect(invalidStaticResult.errors[0]).toInclude('Static file root directory is required');
const invalidSocketResult = validateRouteAction(invalidSocketAction);
expect(invalidSocketResult.valid).toBeFalse();
expect(invalidSocketResult.errors.length).toBeGreaterThan(0);
expect(invalidSocketResult.errors[0]).toInclude('Socket handler function is required');
});
tap.test('Route Validation - validateRouteConfig', async () => {
@ -253,26 +229,25 @@ tap.test('Route Validation - hasRequiredPropertiesForAction', async () => {
const forwardRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 });
expect(hasRequiredPropertiesForAction(forwardRoute, 'forward')).toBeTrue();
// Redirect action
// Socket handler action (redirect functionality)
const redirectRoute = createHttpToHttpsRedirect('example.com');
expect(hasRequiredPropertiesForAction(redirectRoute, 'redirect')).toBeTrue();
expect(hasRequiredPropertiesForAction(redirectRoute, 'socket-handler')).toBeTrue();
// Static action
const staticRoute = createStaticFileRoute('example.com', '/var/www/html');
expect(hasRequiredPropertiesForAction(staticRoute, 'static')).toBeTrue();
// Block action
const blockRoute: IRouteConfig = {
// Socket handler action
const socketRoute: IRouteConfig = {
match: {
domains: 'blocked.example.com',
domains: 'socket.example.com',
ports: 80
},
action: {
type: 'block'
type: 'socket-handler',
socketHandler: (socket, context) => {
socket.end();
}
},
name: 'Block Route'
name: 'Socket Handler Route'
};
expect(hasRequiredPropertiesForAction(blockRoute, 'block')).toBeTrue();
expect(hasRequiredPropertiesForAction(socketRoute, 'socket-handler')).toBeTrue();
// Missing required properties
const invalidForwardRoute: IRouteConfig = {
@ -345,20 +320,22 @@ tap.test('Route Utilities - mergeRouteConfigs', async () => {
expect(actionMergedRoute.action.target.host).toEqual('new-host.local');
expect(actionMergedRoute.action.target.port).toEqual(5000);
// Test replacing action with different type
// Test replacing action with socket handler
const typeChangeOverride: Partial<IRouteConfig> = {
action: {
type: 'redirect',
redirect: {
to: 'https://example.com',
status: 301
type: 'socket-handler',
socketHandler: (socket, context) => {
socket.write('HTTP/1.1 301 Moved Permanently\r\n');
socket.write('Location: https://example.com\r\n');
socket.write('\r\n');
socket.end();
}
}
};
const typeChangedRoute = mergeRouteConfigs(baseRoute, typeChangeOverride);
expect(typeChangedRoute.action.type).toEqual('redirect');
expect(typeChangedRoute.action.redirect.to).toEqual('https://example.com');
expect(typeChangedRoute.action.type).toEqual('socket-handler');
expect(typeChangedRoute.action.socketHandler).toBeDefined();
expect(typeChangedRoute.action.target).toBeUndefined();
});
@ -705,9 +682,8 @@ tap.test('Route Helpers - createHttpToHttpsRedirect', async () => {
expect(route.match.domains).toEqual('example.com');
expect(route.match.ports).toEqual(80);
expect(route.action.type).toEqual('redirect');
expect(route.action.redirect.to).toEqual('https://{domain}:443{path}');
expect(route.action.redirect.status).toEqual(301);
expect(route.action.type).toEqual('socket-handler');
expect(route.action.socketHandler).toBeDefined();
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
@ -741,7 +717,7 @@ tap.test('Route Helpers - createCompleteHttpsServer', async () => {
// HTTP redirect route
expect(routes[1].match.domains).toEqual('example.com');
expect(routes[1].match.ports).toEqual(80);
expect(routes[1].action.type).toEqual('redirect');
expect(routes[1].action.type).toEqual('socket-handler');
const validation1 = validateRouteConfig(routes[0]);
const validation2 = validateRouteConfig(routes[1]);
@ -749,24 +725,8 @@ tap.test('Route Helpers - createCompleteHttpsServer', async () => {
expect(validation2.valid).toBeTrue();
});
tap.test('Route Helpers - createStaticFileRoute', async () => {
const route = createStaticFileRoute('example.com', '/var/www/html', {
serveOnHttps: true,
certificate: 'auto',
indexFiles: ['index.html', 'index.htm', 'default.html']
});
expect(route.match.domains).toEqual('example.com');
expect(route.match.ports).toEqual(443);
expect(route.action.type).toEqual('static');
expect(route.action.static.root).toEqual('/var/www/html');
expect(route.action.static.index).toInclude('index.html');
expect(route.action.static.index).toInclude('default.html');
expect(route.action.tls.mode).toEqual('terminate');
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
// createStaticFileRoute has been removed - static file serving should be handled by
// external servers (nginx/apache) behind the proxy
tap.test('Route Helpers - createApiRoute', async () => {
const route = createApiRoute('api.example.com', '/v1', { host: 'localhost', port: 3000 }, {
@ -874,34 +834,8 @@ tap.test('Route Patterns - createApiGatewayRoute', async () => {
expect(result.valid).toBeTrue();
});
tap.test('Route Patterns - createStaticFileServerRoute', async () => {
// Create static file server route
const staticRoute = createStaticFileServerRoute(
'static.example.com',
'/var/www/html',
{
useTls: true,
cacheControl: 'public, max-age=7200'
}
);
// Validate route configuration
expect(staticRoute.match.domains).toEqual('static.example.com');
expect(staticRoute.action.type).toEqual('static');
// Check static configuration
if (staticRoute.action.static) {
expect(staticRoute.action.static.root).toEqual('/var/www/html');
// Check cache control headers if they exist
if (staticRoute.action.static.headers) {
expect(staticRoute.action.static.headers['Cache-Control']).toEqual('public, max-age=7200');
}
}
const result = validateRouteConfig(staticRoute);
expect(result.valid).toBeTrue();
});
// createStaticFileServerRoute has been removed - static file serving should be handled by
// external servers (nginx/apache) behind the proxy
tap.test('Route Patterns - createWebSocketPattern', async () => {
// Create WebSocket route pattern

View File

@ -2,17 +2,13 @@ import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/index.js';
/**
* Simple test to check that ACME challenge routes are created
* Simple test to check route manager initialization with ACME
*/
tap.test('should create ACME challenge route', async (tools) => {
tools.timeout(5000);
const mockRouteUpdates: any[] = [];
tap.test('should properly initialize with ACME configuration', async (tools) => {
const settings = {
routes: [
{
name: 'secure-route',
name: 'secure-route',
match: {
ports: [8443],
domains: 'test.example.com'
@ -25,7 +21,7 @@ tap.test('should create ACME challenge route', async (tools) => {
certificate: 'auto' as const,
acme: {
email: 'ssl@bleu.de',
challengePort: 8080 // Use non-privileged port for challenges
challengePort: 8080
}
}
}
@ -33,76 +29,58 @@ tap.test('should create ACME challenge route', async (tools) => {
],
acme: {
email: 'ssl@bleu.de',
port: 8080, // Use non-privileged port globally
useProduction: false
port: 8080,
useProduction: false,
enabled: true
}
};
const proxy = new SmartProxy(settings);
// Mock certificate manager
let updateRoutesCallback: any;
(proxy as any).createCertificateManager = async function(routes: any[], certDir: string, acmeOptions: any) {
const mockCertManager = {
setUpdateRoutesCallback: function(callback: any) {
updateRoutesCallback = callback;
// Replace the certificate manager creation to avoid real ACME requests
(proxy as any).createCertificateManager = async () => {
return {
setUpdateRoutesCallback: () => {},
setHttpProxy: () => {},
setGlobalAcmeDefaults: () => {},
setAcmeStateManager: () => {},
initialize: async () => {
// Using logger would be better but in test we'll keep console.log
console.log('Mock certificate manager initialized');
},
setHttpProxy: function() {},
setGlobalAcmeDefaults: function() {},
setAcmeStateManager: function() {},
initialize: async function() {
// Simulate adding ACME challenge route
if (updateRoutesCallback) {
const challengeRoute = {
name: 'acme-challenge',
priority: 1000,
match: {
ports: 8080,
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'static',
handler: async (context: any) => {
const token = context.path?.split('/').pop() || '';
return {
status: 200,
headers: { 'Content-Type': 'text/plain' },
body: `mock-challenge-response-${token}`
};
}
}
};
const updatedRoutes = [...routes, challengeRoute];
mockRouteUpdates.push(updatedRoutes);
await updateRoutesCallback(updatedRoutes);
}
provisionAllCertificates: async () => {
console.log('Mock certificate provisioning');
},
getAcmeOptions: () => acmeOptions,
getState: () => ({ challengeRouteActive: false }),
stop: async () => {}
stop: async () => {
console.log('Mock certificate manager stopped');
}
};
return mockCertManager;
};
// Mock NFTables
(proxy as any).nftablesManager = {
ensureNFTablesSetup: async () => {},
provisionRoute: async () => {},
deprovisionRoute: async () => {},
updateRoute: async () => {},
getStatus: async () => ({}),
stop: async () => {}
};
await proxy.start();
// Verify that routes were updated with challenge route
expect(mockRouteUpdates.length).toBeGreaterThan(0);
// Verify proxy started successfully
expect(proxy).toBeDefined();
const lastUpdate = mockRouteUpdates[mockRouteUpdates.length - 1];
const challengeRoute = lastUpdate.find((r: any) => r.name === 'acme-challenge');
// Verify route manager has routes
const routeManager = (proxy as any).routeManager;
expect(routeManager).toBeDefined();
expect(routeManager.getAllRoutes().length).toBeGreaterThan(0);
expect(challengeRoute).toBeDefined();
expect(challengeRoute.match.path).toEqual('/.well-known/acme-challenge/*');
expect(challengeRoute.match.ports).toEqual(8080);
// Verify the route exists with correct domain
const routes = routeManager.getAllRoutes();
const secureRoute = routes.find((r: any) => r.name === 'secure-route');
expect(secureRoute).toBeDefined();
expect(secureRoute.match.domains).toEqual('test.example.com');
await proxy.stop();
});

View File

@ -0,0 +1,83 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import { SmartProxy } from '../ts/index.js';
tap.test('should handle async handler that sets up listeners after delay', async () => {
const proxy = new SmartProxy({
routes: [{
name: 'delayed-setup-handler',
match: { ports: 7777 },
action: {
type: 'socket-handler',
socketHandler: async (socket, context) => {
// Simulate async work BEFORE setting up listeners
await new Promise(resolve => setTimeout(resolve, 50));
// Now set up the listener - with the race condition, this would miss initial data
socket.on('data', (data) => {
const message = data.toString().trim();
socket.write(`RECEIVED: ${message}\n`);
if (message === 'close') {
socket.end();
}
});
// Send ready message
socket.write('HANDLER READY\n');
}
}
}],
enableDetailedLogging: false
});
await proxy.start();
// Test connection
const client = new net.Socket();
let response = '';
client.on('data', (data) => {
response += data.toString();
});
await new Promise<void>((resolve, reject) => {
client.connect(7777, 'localhost', () => {
// Send initial data immediately - this tests the race condition
client.write('initial-message\n');
resolve();
});
client.on('error', reject);
});
// Wait for handler setup and initial data processing
await new Promise(resolve => setTimeout(resolve, 150));
// Send another message to verify handler is working
client.write('test-message\n');
// Wait for response
await new Promise(resolve => setTimeout(resolve, 50));
// Send close command
client.write('close\n');
// Wait for connection to close
await new Promise(resolve => {
client.on('close', () => resolve(undefined));
});
console.log('Response:', response);
// Should have received the ready message
expect(response).toContain('HANDLER READY');
// Should have received the initial message (this would fail with race condition)
expect(response).toContain('RECEIVED: initial-message');
// Should have received the test message
expect(response).toContain('RECEIVED: test-message');
await proxy.stop();
});
export default tap.start();

View File

@ -0,0 +1,59 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import { SmartProxy } from '../ts/index.js';
tap.test('simple socket handler test', async () => {
const proxy = new SmartProxy({
routes: [{
name: 'simple-handler',
match: {
ports: 8888
// No domains restriction - will match all connections on this port
},
action: {
type: 'socket-handler',
socketHandler: (socket, context) => {
console.log('Handler called!');
socket.write('HELLO\n');
socket.end();
}
}
}],
enableDetailedLogging: true
});
await proxy.start();
// Test connection
const client = new net.Socket();
let response = '';
client.on('data', (data) => {
response += data.toString();
});
await new Promise<void>((resolve, reject) => {
client.connect(8888, 'localhost', () => {
console.log('Connected');
// Send some initial data to trigger the handler
client.write('test\n');
resolve();
});
client.on('error', reject);
});
// Wait for response
await new Promise(resolve => {
client.on('close', () => {
console.log('Connection closed');
resolve(undefined);
});
});
console.log('Got response:', response);
expect(response).toEqual('HELLO\n');
await proxy.stop();
});
export default tap.start();

173
test/test.socket-handler.ts Normal file
View File

@ -0,0 +1,173 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net';
import { SmartProxy } from '../ts/index.js';
import type { IRouteConfig } from '../ts/index.js';
let proxy: SmartProxy;
tap.test('setup socket handler test', async () => {
// Create a simple socket handler route
const routes: IRouteConfig[] = [{
name: 'echo-handler',
match: {
ports: 9999
// No domains restriction - matches all connections
},
action: {
type: 'socket-handler',
socketHandler: (socket, context) => {
console.log('Socket handler called');
// Simple echo server
socket.write('ECHO SERVER\n');
socket.on('data', (data) => {
console.log('Socket handler received data:', data.toString());
socket.write(`ECHO: ${data}`);
});
socket.on('error', (err) => {
console.error('Socket error:', err);
});
}
}
}];
proxy = new SmartProxy({
routes,
enableDetailedLogging: false
});
await proxy.start();
});
tap.test('should handle socket with custom function', async () => {
const client = new net.Socket();
let response = '';
await new Promise<void>((resolve, reject) => {
client.connect(9999, 'localhost', () => {
console.log('Client connected to proxy');
resolve();
});
client.on('error', reject);
});
// Collect data
client.on('data', (data) => {
console.log('Client received:', data.toString());
response += data.toString();
});
// Wait a bit for connection to stabilize
await new Promise(resolve => setTimeout(resolve, 50));
// Send test data
console.log('Sending test data...');
client.write('Hello World\n');
// Wait for response
await new Promise(resolve => setTimeout(resolve, 200));
console.log('Total response:', response);
expect(response).toContain('ECHO SERVER');
expect(response).toContain('ECHO: Hello World');
client.destroy();
});
tap.test('should handle async socket handler', async () => {
// Update route with async handler
await proxy.updateRoutes([{
name: 'async-handler',
match: { ports: 9999 },
action: {
type: 'socket-handler',
socketHandler: async (socket, context) => {
// Set up data handler first
socket.on('data', async (data) => {
console.log('Async handler received:', data.toString());
// Simulate async processing
await new Promise(resolve => setTimeout(resolve, 10));
const processed = `PROCESSED: ${data.toString().trim().toUpperCase()}\n`;
console.log('Sending:', processed);
socket.write(processed);
});
// Then simulate async operation
await new Promise(resolve => setTimeout(resolve, 10));
socket.write('ASYNC READY\n');
}
}
}]);
const client = new net.Socket();
let response = '';
// Collect data
client.on('data', (data) => {
response += data.toString();
});
await new Promise<void>((resolve, reject) => {
client.connect(9999, 'localhost', () => {
// Send initial data to trigger the handler
client.write('test data\n');
resolve();
});
client.on('error', reject);
});
// Wait for async processing
await new Promise(resolve => setTimeout(resolve, 200));
console.log('Final response:', response);
expect(response).toContain('ASYNC READY');
expect(response).toContain('PROCESSED: TEST DATA');
client.destroy();
});
tap.test('should handle errors in socket handler', async () => {
// Update route with error-throwing handler
await proxy.updateRoutes([{
name: 'error-handler',
match: { ports: 9999 },
action: {
type: 'socket-handler',
socketHandler: (socket, context) => {
throw new Error('Handler error');
}
}
}]);
const client = new net.Socket();
let connectionClosed = false;
client.on('close', () => {
connectionClosed = true;
});
await new Promise<void>((resolve, reject) => {
client.connect(9999, 'localhost', () => {
// Connection established - send data to trigger handler
client.write('trigger\n');
resolve();
});
client.on('error', () => {
// Ignore client errors - we expect the connection to be closed
});
});
// Wait a bit
await new Promise(resolve => setTimeout(resolve, 100));
// Socket should be closed due to handler error
expect(connectionClosed).toEqual(true);
});
tap.test('cleanup', async () => {
await proxy.stop();
});
export default tap.start();

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@push.rocks/smartproxy',
version: '19.3.3',
version: '19.5.2',
description: 'A powerful proxy package with unified route-based configuration for high traffic management. Features include SSL/TLS support, flexible routing patterns, WebSocket handling, advanced security options, and automatic ACME certificate management.'
}

View File

@ -12,3 +12,4 @@ export * from './security-utils.js';
export * from './shared-security-manager.js';
export * from './event-system.js';
export * from './websocket-utils.js';
export * from './logger.js';

10
ts/core/utils/logger.ts Normal file
View File

@ -0,0 +1,10 @@
import * as plugins from '../../plugins.js';
export const logger = new plugins.smartlog.Smartlog({
logContext: {},
minimumLogLevel: 'info',
});
logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());
logger.log('info', 'Logger initialized');

View File

@ -26,6 +26,8 @@ import * as smartcrypto from '@push.rocks/smartcrypto';
import * as smartacme from '@push.rocks/smartacme';
import * as smartacmePlugins from '@push.rocks/smartacme/dist_ts/smartacme.plugins.js';
import * as smartacmeHandlers from '@push.rocks/smartacme/dist_ts/handlers/index.js';
import * as smartlog from '@push.rocks/smartlog';
import * as smartlogDestinationLocal from '@push.rocks/smartlog/destination-local';
import * as taskbuffer from '@push.rocks/taskbuffer';
export {
@ -39,6 +41,8 @@ export {
smartacme,
smartacmePlugins,
smartacmeHandlers,
smartlog,
smartlogDestinationLocal,
taskbuffer,
};

View File

@ -2,5 +2,4 @@
* HTTP handlers for various route types
*/
export { RedirectHandler } from './redirect-handler.js';
export { StaticHandler } from './static-handler.js';
// Empty - all handlers have been removed

View File

@ -1,105 +0,0 @@
import * as plugins from '../../../plugins.js';
import type { IRouteConfig } from '../../smart-proxy/models/route-types.js';
import type { IConnectionRecord } from '../../smart-proxy/models/interfaces.js';
import type { ILogger } from '../models/types.js';
import { createLogger } from '../models/types.js';
import { HttpStatus, getStatusText } from '../models/http-types.js';
export interface IRedirectHandlerContext {
connectionId: string;
connectionManager: any; // Avoid circular deps
settings: any;
logger?: ILogger;
}
/**
* Handles HTTP redirect routes
*/
export class RedirectHandler {
/**
* Handle redirect routes
*/
public static async handleRedirect(
socket: plugins.net.Socket,
route: IRouteConfig,
context: IRedirectHandlerContext
): Promise<void> {
const { connectionId, connectionManager, settings } = context;
const logger = context.logger || createLogger(settings.logLevel || 'info');
const action = route.action;
// We should have a redirect configuration
if (!action.redirect) {
logger.error(`[${connectionId}] Redirect action missing redirect configuration`);
socket.end();
connectionManager.cleanupConnection({ id: connectionId }, 'missing_redirect');
return;
}
// For TLS connections, we can't do redirects at the TCP level
// This check should be done before calling this handler
// Wait for the first HTTP request to perform the redirect
const dataListeners: ((chunk: Buffer) => void)[] = [];
const httpDataHandler = (chunk: Buffer) => {
// Remove all data listeners to avoid duplicated processing
for (const listener of dataListeners) {
socket.removeListener('data', listener);
}
// Parse HTTP request to get path
try {
const headersEnd = chunk.indexOf('\r\n\r\n');
if (headersEnd === -1) {
// Not a complete HTTP request, need more data
socket.once('data', httpDataHandler);
dataListeners.push(httpDataHandler);
return;
}
const httpHeaders = chunk.slice(0, headersEnd).toString();
const requestLine = httpHeaders.split('\r\n')[0];
const [method, path] = requestLine.split(' ');
// Extract Host header
const hostMatch = httpHeaders.match(/Host: (.+?)(\r\n|\r|\n|$)/i);
const host = hostMatch ? hostMatch[1].trim() : '';
// Process the redirect URL with template variables
let redirectUrl = action.redirect.to;
redirectUrl = redirectUrl.replace(/\{domain\}/g, host);
redirectUrl = redirectUrl.replace(/\{path\}/g, path || '');
redirectUrl = redirectUrl.replace(/\{port\}/g, socket.localPort?.toString() || '80');
// Prepare the HTTP redirect response
const redirectResponse = [
`HTTP/1.1 ${action.redirect.status} Moved`,
`Location: ${redirectUrl}`,
'Connection: close',
'Content-Length: 0',
'',
'',
].join('\r\n');
if (settings.enableDetailedLogging) {
logger.info(
`[${connectionId}] Redirecting to ${redirectUrl} with status ${action.redirect.status}`
);
}
// Send the redirect response
socket.end(redirectResponse);
connectionManager.initiateCleanupOnce({ id: connectionId }, 'redirect_complete');
} catch (err) {
logger.error(`[${connectionId}] Error processing HTTP redirect: ${err}`);
socket.end();
connectionManager.initiateCleanupOnce({ id: connectionId }, 'redirect_error');
}
};
// Setup the HTTP data handler
socket.once('data', httpDataHandler);
dataListeners.push(httpDataHandler);
}
}

View File

@ -1,251 +0,0 @@
import * as plugins from '../../../plugins.js';
import type { IRouteConfig } from '../../smart-proxy/models/route-types.js';
import type { IConnectionRecord } from '../../smart-proxy/models/interfaces.js';
import type { ILogger } from '../models/types.js';
import { createLogger } from '../models/types.js';
import type { IRouteContext } from '../../../core/models/route-context.js';
import { HttpStatus, getStatusText } from '../models/http-types.js';
export interface IStaticHandlerContext {
connectionId: string;
connectionManager: any; // Avoid circular deps
settings: any;
logger?: ILogger;
}
/**
* Handles static routes including ACME challenges
*/
export class StaticHandler {
/**
* Handle static routes
*/
public static async handleStatic(
socket: plugins.net.Socket,
route: IRouteConfig,
context: IStaticHandlerContext,
record: IConnectionRecord
): Promise<void> {
const { connectionId, connectionManager, settings } = context;
const logger = context.logger || createLogger(settings.logLevel || 'info');
if (!route.action.handler) {
logger.error(`[${connectionId}] Static route '${route.name}' has no handler`);
socket.end();
connectionManager.cleanupConnection(record, 'no_handler');
return;
}
let buffer = Buffer.alloc(0);
let processingData = false;
const handleHttpData = async (chunk: Buffer) => {
// Accumulate the data
buffer = Buffer.concat([buffer, chunk]);
// Prevent concurrent processing of the same buffer
if (processingData) return;
processingData = true;
try {
// Process data until we have a complete request or need more data
await processBuffer();
} finally {
processingData = false;
}
};
const processBuffer = async () => {
// Look for end of HTTP headers
const headerEndIndex = buffer.indexOf('\r\n\r\n');
if (headerEndIndex === -1) {
// Need more data
if (buffer.length > 8192) {
// Prevent excessive buffering
logger.error(`[${connectionId}] HTTP headers too large`);
socket.end();
connectionManager.cleanupConnection(record, 'headers_too_large');
}
return; // Wait for more data to arrive
}
// Parse the HTTP request
const headerBuffer = buffer.slice(0, headerEndIndex);
const headers = headerBuffer.toString();
const lines = headers.split('\r\n');
if (lines.length === 0) {
logger.error(`[${connectionId}] Invalid HTTP request`);
socket.end();
connectionManager.cleanupConnection(record, 'invalid_request');
return;
}
// Parse request line
const requestLine = lines[0];
const requestParts = requestLine.split(' ');
if (requestParts.length < 3) {
logger.error(`[${connectionId}] Invalid HTTP request line`);
socket.end();
connectionManager.cleanupConnection(record, 'invalid_request_line');
return;
}
const [method, path, httpVersion] = requestParts;
// Parse headers
const headersMap: Record<string, string> = {};
for (let i = 1; i < lines.length; i++) {
const colonIndex = lines[i].indexOf(':');
if (colonIndex > 0) {
const key = lines[i].slice(0, colonIndex).trim().toLowerCase();
const value = lines[i].slice(colonIndex + 1).trim();
headersMap[key] = value;
}
}
// Check for Content-Length to handle request body
const requestBodyLength = parseInt(headersMap['content-length'] || '0', 10);
const bodyStartIndex = headerEndIndex + 4; // Skip the \r\n\r\n
// If there's a body, ensure we have the full body
if (requestBodyLength > 0) {
const totalExpectedLength = bodyStartIndex + requestBodyLength;
// If we don't have the complete body yet, wait for more data
if (buffer.length < totalExpectedLength) {
// Implement a reasonable body size limit to prevent memory issues
if (requestBodyLength > 1024 * 1024) {
// 1MB limit
logger.error(`[${connectionId}] Request body too large`);
socket.end();
connectionManager.cleanupConnection(record, 'body_too_large');
return;
}
return; // Wait for more data
}
}
// Extract query string if present
let pathname = path;
let query: string | undefined;
const queryIndex = path.indexOf('?');
if (queryIndex !== -1) {
pathname = path.slice(0, queryIndex);
query = path.slice(queryIndex + 1);
}
try {
// Get request body if present
let requestBody: Buffer | undefined;
if (requestBodyLength > 0) {
requestBody = buffer.slice(bodyStartIndex, bodyStartIndex + requestBodyLength);
}
// Pause socket to prevent data loss during async processing
socket.pause();
// Remove the data listener since we're handling the request
socket.removeListener('data', handleHttpData);
// Build route context with parsed HTTP information
const context: IRouteContext = {
port: record.localPort,
domain: record.lockedDomain || headersMap['host']?.split(':')[0],
clientIp: record.remoteIP,
serverIp: socket.localAddress!,
path: pathname,
query: query,
headers: headersMap,
isTls: record.isTLS,
tlsVersion: record.tlsVersion,
routeName: route.name,
routeId: route.id,
timestamp: Date.now(),
connectionId,
};
// Since IRouteContext doesn't have a body property,
// we need an alternative approach to handle the body
let response;
if (requestBody) {
if (settings.enableDetailedLogging) {
logger.info(
`[${connectionId}] Processing request with body (${requestBody.length} bytes)`
);
}
// Pass the body as an additional parameter by extending the context object
// This is not type-safe, but it allows handlers that expect a body to work
const extendedContext = {
...context,
// Provide both raw buffer and string representation
requestBody: requestBody,
requestBodyText: requestBody.toString(),
method: method,
};
// Call the handler with the extended context
// The handler needs to know to look for the non-standard properties
response = await route.action.handler(extendedContext as any);
} else {
// Call the handler with the standard context
const extendedContext = {
...context,
method: method,
};
response = await route.action.handler(extendedContext as any);
}
// Prepare the HTTP response
const responseHeaders = response.headers || {};
const contentLength = Buffer.byteLength(response.body || '');
responseHeaders['Content-Length'] = contentLength.toString();
if (!responseHeaders['Content-Type']) {
responseHeaders['Content-Type'] = 'text/plain';
}
// Build the response
let httpResponse = `HTTP/1.1 ${response.status} ${getStatusText(response.status)}\r\n`;
for (const [key, value] of Object.entries(responseHeaders)) {
httpResponse += `${key}: ${value}\r\n`;
}
httpResponse += '\r\n';
// Send response
socket.write(httpResponse);
if (response.body) {
socket.write(response.body);
}
socket.end();
connectionManager.cleanupConnection(record, 'completed');
} catch (error) {
logger.error(`[${connectionId}] Error in static handler: ${error}`);
// Send error response
const errorResponse =
'HTTP/1.1 500 Internal Server Error\r\n' +
'Content-Type: text/plain\r\n' +
'Content-Length: 21\r\n' +
'\r\n' +
'Internal Server Error';
socket.write(errorResponse);
socket.end();
connectionManager.cleanupConnection(record, 'handler_error');
}
};
// Listen for data
socket.on('data', handleHttpData);
// Ensure cleanup on socket close
socket.once('close', () => {
socket.removeListener('data', handleHttpData);
});
}
}

View File

@ -4,6 +4,8 @@ import type { IRouteConfig, IRouteTls } from './models/route-types.js';
import type { IAcmeOptions } from './models/interfaces.js';
import { CertStore } from './cert-store.js';
import type { AcmeStateManager } from './acme-state-manager.js';
import { logger } from '../../core/utils/logger.js';
import { SocketHandlers } from './utils/route-helpers.js';
export interface ICertStatus {
domain: string;
@ -92,6 +94,12 @@ export class SmartCertManager {
*/
public setUpdateRoutesCallback(callback: (routes: IRouteConfig[]) => Promise<void>): void {
this.updateRoutesCallback = callback;
try {
logger.log('debug', 'Route update callback set successfully', { component: 'certificate-manager' });
} catch (error) {
// Silently handle logging errors
console.log('[DEBUG] Route update callback set successfully');
}
}
/**
@ -125,15 +133,16 @@ export class SmartCertManager {
// Add challenge route once at initialization if not already active
if (!this.challengeRouteActive) {
console.log('Adding ACME challenge route during initialization');
logger.log('info', 'Adding ACME challenge route during initialization', { component: 'certificate-manager' });
await this.addChallengeRoute();
} else {
console.log('Challenge route already active from previous instance');
logger.log('info', 'Challenge route already active from previous instance', { component: 'certificate-manager' });
}
}
// Provision certificates for all routes
await this.provisionAllCertificates();
// Skip automatic certificate provisioning during initialization
// This will be called later after ports are listening
logger.log('info', 'Certificate manager initialized. Deferring certificate provisioning until after ports are listening.', { component: 'certificate-manager' });
// Start renewal timer
this.startRenewalTimer();
@ -142,7 +151,7 @@ export class SmartCertManager {
/**
* Provision certificates for all routes that need them
*/
private async provisionAllCertificates(): Promise<void> {
public async provisionAllCertificates(): Promise<void> {
const certRoutes = this.routes.filter(r =>
r.action.tls?.mode === 'terminate' ||
r.action.tls?.mode === 'terminate-and-reencrypt'
@ -156,7 +165,7 @@ export class SmartCertManager {
try {
await this.provisionCertificate(route, true); // Allow concurrent since we're managing it here
} catch (error) {
console.error(`Failed to provision certificate for route ${route.name}: ${error}`);
logger.log('error', `Failed to provision certificate for route ${route.name}`, { routeName: route.name, error, component: 'certificate-manager' });
}
}
} finally {
@ -175,13 +184,13 @@ export class SmartCertManager {
// Check if provisioning is already in progress (prevent concurrent provisioning)
if (!allowConcurrent && this.isProvisioning) {
console.log(`Certificate provisioning already in progress, skipping ${route.name}`);
logger.log('info', `Certificate provisioning already in progress, skipping ${route.name}`, { routeName: route.name, component: 'certificate-manager' });
return;
}
const domains = this.extractDomainsFromRoute(route);
if (domains.length === 0) {
console.warn(`Route ${route.name} has TLS termination but no domains`);
logger.log('warn', `Route ${route.name} has TLS termination but no domains`, { routeName: route.name, component: 'certificate-manager' });
return;
}
@ -218,7 +227,7 @@ export class SmartCertManager {
// Check if we already have a valid certificate
const existingCert = await this.certStore.getCertificate(routeName);
if (existingCert && this.isCertificateValid(existingCert)) {
console.log(`Using existing valid certificate for ${primaryDomain}`);
logger.log('info', `Using existing valid certificate for ${primaryDomain}`, { domain: primaryDomain, component: 'certificate-manager' });
await this.applyCertificate(primaryDomain, existingCert);
this.updateCertStatus(routeName, 'valid', 'acme', existingCert);
return;
@ -229,7 +238,7 @@ export class SmartCertManager {
this.globalAcmeDefaults?.renewThresholdDays ||
30;
console.log(`Requesting ACME certificate for ${domains.join(', ')} (renew ${renewThreshold} days before expiry)`);
logger.log('info', `Requesting ACME certificate for ${domains.join(', ')} (renew ${renewThreshold} days before expiry)`, { domains: domains.join(', '), renewThreshold, component: 'certificate-manager' });
this.updateCertStatus(routeName, 'pending', 'acme');
try {
@ -251,7 +260,7 @@ export class SmartCertManager {
hasDnsChallenge;
if (shouldIncludeWildcard) {
console.log(`Requesting wildcard certificate for ${primaryDomain} (DNS-01 available)`);
logger.log('info', `Requesting wildcard certificate for ${primaryDomain} (DNS-01 available)`, { domain: primaryDomain, challengeType: 'DNS-01', component: 'certificate-manager' });
}
// Use smartacme to get certificate with optional wildcard
@ -278,9 +287,9 @@ export class SmartCertManager {
await this.applyCertificate(primaryDomain, certData);
this.updateCertStatus(routeName, 'valid', 'acme', certData);
console.log(`Successfully provisioned ACME certificate for ${primaryDomain}`);
logger.log('info', `Successfully provisioned ACME certificate for ${primaryDomain}`, { domain: primaryDomain, component: 'certificate-manager' });
} catch (error) {
console.error(`Failed to provision ACME certificate for ${primaryDomain}: ${error}`);
logger.log('error', `Failed to provision ACME certificate for ${primaryDomain}: ${error.message}`, { domain: primaryDomain, error: error.message, component: 'certificate-manager' });
this.updateCertStatus(routeName, 'error', 'acme', undefined, error.message);
throw error;
}
@ -327,9 +336,9 @@ export class SmartCertManager {
await this.applyCertificate(domain, certData);
this.updateCertStatus(routeName, 'valid', 'static', certData);
console.log(`Successfully loaded static certificate for ${domain}`);
logger.log('info', `Successfully loaded static certificate for ${domain}`, { domain, component: 'certificate-manager' });
} catch (error) {
console.error(`Failed to provision static certificate for ${domain}: ${error}`);
logger.log('error', `Failed to provision static certificate for ${domain}: ${error.message}`, { domain, error: error.message, component: 'certificate-manager' });
this.updateCertStatus(routeName, 'error', 'static', undefined, error.message);
throw error;
}
@ -340,7 +349,7 @@ export class SmartCertManager {
*/
private async applyCertificate(domain: string, certData: ICertificateData): Promise<void> {
if (!this.httpProxy) {
console.warn('HttpProxy not set, cannot apply certificate');
logger.log('warn', `HttpProxy not set, cannot apply certificate for domain ${domain}`, { domain, component: 'certificate-manager' });
return;
}
@ -393,17 +402,31 @@ export class SmartCertManager {
/**
* Add challenge route to SmartProxy
*
* This method adds a special route for ACME HTTP-01 challenges, which typically uses port 80.
* Since we may already be listening on port 80 for regular routes, we need to be
* careful about how we add this route to avoid binding conflicts.
*/
private async addChallengeRoute(): Promise<void> {
// Check with state manager first
// Check with state manager first - avoid duplication
if (this.acmeStateManager && this.acmeStateManager.isChallengeRouteActive()) {
console.log('Challenge route already active in global state, skipping');
try {
logger.log('info', 'Challenge route already active in global state, skipping', { component: 'certificate-manager' });
} catch (error) {
// Silently handle logging errors
console.log('[INFO] Challenge route already active in global state, skipping');
}
this.challengeRouteActive = true;
return;
}
if (this.challengeRouteActive) {
console.log('Challenge route already active locally, skipping');
try {
logger.log('info', 'Challenge route already active locally, skipping', { component: 'certificate-manager' });
} catch (error) {
// Silently handle logging errors
console.log('[INFO] Challenge route already active locally, skipping');
}
return;
}
@ -414,10 +437,56 @@ export class SmartCertManager {
if (!this.challengeRoute) {
throw new Error('Challenge route not initialized');
}
const challengeRoute = this.challengeRoute;
// Get the challenge port
const challengePort = this.globalAcmeDefaults?.port || 80;
// Check if any existing routes are already using this port
// This helps us determine if we need to create a new binding or can reuse existing one
const portInUseByRoutes = this.routes.some(route => {
const routePorts = Array.isArray(route.match.ports) ? route.match.ports : [route.match.ports];
return routePorts.some(p => {
// Handle both number and port range objects
if (typeof p === 'number') {
return p === challengePort;
} else if (typeof p === 'object' && 'from' in p && 'to' in p) {
// Port range case - check if challengePort is in range
return challengePort >= p.from && challengePort <= p.to;
}
return false;
});
});
try {
// Log whether port is already in use by other routes
if (portInUseByRoutes) {
try {
logger.log('info', `Port ${challengePort} is already used by another route, merging ACME challenge route`, {
port: challengePort,
component: 'certificate-manager'
});
} catch (error) {
// Silently handle logging errors
console.log(`[INFO] Port ${challengePort} is already used by another route, merging ACME challenge route`);
}
} else {
try {
logger.log('info', `Adding new ACME challenge route on port ${challengePort}`, {
port: challengePort,
component: 'certificate-manager'
});
} catch (error) {
// Silently handle logging errors
console.log(`[INFO] Adding new ACME challenge route on port ${challengePort}`);
}
}
// Add the challenge route to the existing routes
const challengeRoute = this.challengeRoute;
const updatedRoutes = [...this.routes, challengeRoute];
// With the re-ordering of start(), port binding should already be done
// This updateRoutes call should just add the route without binding again
await this.updateRoutesCallback(updatedRoutes);
this.challengeRouteActive = true;
@ -426,11 +495,62 @@ export class SmartCertManager {
this.acmeStateManager.addChallengeRoute(challengeRoute);
}
console.log('ACME challenge route successfully added');
try {
logger.log('info', 'ACME challenge route successfully added', { component: 'certificate-manager' });
} catch (error) {
// Silently handle logging errors
console.log('[INFO] ACME challenge route successfully added');
}
} catch (error) {
console.error('Failed to add challenge route:', error);
// Enhanced error handling based on error type
if ((error as any).code === 'EADDRINUSE') {
throw new Error(`Port ${this.globalAcmeDefaults?.port || 80} is already in use for ACME challenges`);
try {
logger.log('warn', `Challenge port ${challengePort} is unavailable - it's already in use by another process. Consider configuring a different ACME port.`, {
port: challengePort,
error: (error as Error).message,
component: 'certificate-manager'
});
} catch (logError) {
// Silently handle logging errors
console.log(`[WARN] Challenge port ${challengePort} is unavailable - it's already in use by another process. Consider configuring a different ACME port.`);
}
// Provide a more informative and actionable error message
throw new Error(
`ACME HTTP-01 challenge port ${challengePort} is already in use by another process. ` +
`Please configure a different port using the acme.port setting (e.g., 8080).`
);
} else if (error.message && error.message.includes('EADDRINUSE')) {
// Some Node.js versions embed the error code in the message rather than the code property
try {
logger.log('warn', `Port ${challengePort} conflict detected: ${error.message}`, {
port: challengePort,
component: 'certificate-manager'
});
} catch (logError) {
// Silently handle logging errors
console.log(`[WARN] Port ${challengePort} conflict detected: ${error.message}`);
}
// More detailed error message with suggestions
throw new Error(
`ACME HTTP challenge port ${challengePort} conflict detected. ` +
`To resolve this issue, try one of these approaches:\n` +
`1. Configure a different port in ACME settings (acme.port)\n` +
`2. Add a regular route that uses port ${challengePort} before initializing the certificate manager\n` +
`3. Stop any other services that might be using port ${challengePort}`
);
}
// Log and rethrow other types of errors
try {
logger.log('error', `Failed to add challenge route: ${(error as Error).message}`, {
error: (error as Error).message,
component: 'certificate-manager'
});
} catch (logError) {
// Silently handle logging errors
console.log(`[ERROR] Failed to add challenge route: ${(error as Error).message}`);
}
throw error;
}
@ -441,7 +561,12 @@ export class SmartCertManager {
*/
private async removeChallengeRoute(): Promise<void> {
if (!this.challengeRouteActive) {
console.log('Challenge route not active, skipping removal');
try {
logger.log('info', 'Challenge route not active, skipping removal', { component: 'certificate-manager' });
} catch (error) {
// Silently handle logging errors
console.log('[INFO] Challenge route not active, skipping removal');
}
return;
}
@ -459,9 +584,19 @@ export class SmartCertManager {
this.acmeStateManager.removeChallengeRoute('acme-challenge');
}
console.log('ACME challenge route successfully removed');
try {
logger.log('info', 'ACME challenge route successfully removed', { component: 'certificate-manager' });
} catch (error) {
// Silently handle logging errors
console.log('[INFO] ACME challenge route successfully removed');
}
} catch (error) {
console.error('Failed to remove challenge route:', error);
try {
logger.log('error', `Failed to remove challenge route: ${error.message}`, { error: error.message, component: 'certificate-manager' });
} catch (logError) {
// Silently handle logging errors
console.log(`[ERROR] Failed to remove challenge route: ${error.message}`);
}
// Reset the flag even on error to avoid getting stuck
this.challengeRouteActive = false;
throw error;
@ -491,11 +626,11 @@ export class SmartCertManager {
const cert = await this.certStore.getCertificate(routeName);
if (cert && !this.isCertificateValid(cert)) {
console.log(`Certificate for ${routeName} needs renewal`);
logger.log('info', `Certificate for ${routeName} needs renewal`, { routeName, component: 'certificate-manager' });
try {
await this.provisionCertificate(route);
} catch (error) {
console.error(`Failed to renew certificate for ${routeName}: ${error}`);
logger.log('error', `Failed to renew certificate for ${routeName}: ${error.message}`, { routeName, error: error.message, component: 'certificate-manager' });
}
}
}
@ -559,22 +694,24 @@ export class SmartCertManager {
path: '/.well-known/acme-challenge/*'
},
action: {
type: 'static',
handler: async (context) => {
type: 'socket-handler',
socketHandler: SocketHandlers.httpServer((req, res) => {
// Extract the token from the path
const token = context.path?.split('/').pop();
const token = req.url?.split('/').pop();
if (!token) {
return { status: 404, body: 'Not found' };
res.status(404);
res.send('Not found');
return;
}
// Create mock request/response objects for SmartAcme
let responseData: any = null;
const mockReq = {
url: context.path,
method: 'GET',
headers: context.headers || {}
url: req.url,
method: req.method,
headers: req.headers
};
let responseData: any = null;
const mockRes = {
statusCode: 200,
setHeader: (name: string, value: string) => {},
@ -584,24 +721,27 @@ export class SmartCertManager {
};
// Use SmartAcme's handler
const handled = await new Promise<boolean>((resolve) => {
const handleAcme = () => {
http01Handler.handleRequest(mockReq as any, mockRes as any, () => {
resolve(false);
// Not handled by ACME
res.status(404);
res.send('Not found');
});
// Give it a moment to process
setTimeout(() => resolve(true), 100);
});
// Give it a moment to process, then send response
setTimeout(() => {
if (responseData) {
res.header('Content-Type', 'text/plain');
res.send(String(responseData));
} else {
res.status(404);
res.send('Not found');
}
}, 100);
};
if (handled && responseData) {
return {
status: mockRes.statusCode,
headers: { 'Content-Type': 'text/plain' },
body: responseData
};
} else {
return { status: 404, body: 'Not found' };
}
}
handleAcme();
})
}
};
@ -620,7 +760,7 @@ export class SmartCertManager {
// Always remove challenge route on shutdown
if (this.challengeRoute) {
console.log('Removing ACME challenge route during shutdown');
logger.log('info', 'Removing ACME challenge route during shutdown', { component: 'certificate-manager' });
await this.removeChallengeRoute();
}

View File

@ -2,6 +2,7 @@ import * as plugins from '../../plugins.js';
import type { IConnectionRecord, ISmartProxyOptions } from './models/interfaces.js';
import { SecurityManager } from './security-manager.js';
import { TimeoutManager } from './timeout-manager.js';
import { logger } from '../../core/utils/logger.js';
/**
* Manages connection lifecycle, tracking, and cleanup
@ -97,7 +98,7 @@ export class ConnectionManager {
*/
public initiateCleanupOnce(record: IConnectionRecord, reason: string = 'normal'): void {
if (this.settings.enableDetailedLogging) {
console.log(`[${record.id}] Connection cleanup initiated for ${record.remoteIP} (${reason})`);
logger.log('info', `Connection cleanup initiated`, { connectionId: record.id, remoteIP: record.remoteIP, reason, component: 'connection-manager' });
}
if (
@ -139,7 +140,7 @@ export class ConnectionManager {
// Reset the handler references
record.renegotiationHandler = undefined;
} catch (err) {
console.log(`[${record.id}] Error removing data handlers: ${err}`);
logger.log('error', `Error removing data handlers for connection ${record.id}: ${err}`, { connectionId: record.id, error: err, component: 'connection-manager' });
}
}
@ -160,16 +161,36 @@ export class ConnectionManager {
// Log connection details
if (this.settings.enableDetailedLogging) {
console.log(
`[${record.id}] Connection from ${record.remoteIP} on port ${record.localPort} terminated (${reason}).` +
` Duration: ${plugins.prettyMs(duration)}, Bytes IN: ${bytesReceived}, OUT: ${bytesSent}, ` +
`TLS: ${record.isTLS ? 'Yes' : 'No'}, Keep-Alive: ${record.hasKeepAlive ? 'Yes' : 'No'}` +
`${record.usingNetworkProxy ? ', Using NetworkProxy' : ''}` +
`${record.domainSwitches ? `, Domain switches: ${record.domainSwitches}` : ''}`
logger.log('info',
`Connection from ${record.remoteIP} on port ${record.localPort} terminated (${reason}). ` +
`Duration: ${plugins.prettyMs(duration)}, Bytes IN: ${bytesReceived}, OUT: ${bytesSent}, ` +
`TLS: ${record.isTLS ? 'Yes' : 'No'}, Keep-Alive: ${record.hasKeepAlive ? 'Yes' : 'No'}` +
`${record.usingNetworkProxy ? ', Using NetworkProxy' : ''}` +
`${record.domainSwitches ? `, Domain switches: ${record.domainSwitches}` : ''}`,
{
connectionId: record.id,
remoteIP: record.remoteIP,
localPort: record.localPort,
reason,
duration: plugins.prettyMs(duration),
bytes: { in: bytesReceived, out: bytesSent },
tls: record.isTLS,
keepAlive: record.hasKeepAlive,
usingNetworkProxy: record.usingNetworkProxy,
domainSwitches: record.domainSwitches || 0,
component: 'connection-manager'
}
);
} else {
console.log(
`[${record.id}] Connection from ${record.remoteIP} terminated (${reason}). Active connections: ${this.connectionRecords.size}`
logger.log('info',
`Connection from ${record.remoteIP} terminated (${reason}). Active connections: ${this.connectionRecords.size}`,
{
connectionId: record.id,
remoteIP: record.remoteIP,
reason,
activeConnections: this.connectionRecords.size,
component: 'connection-manager'
}
);
}
}
@ -189,7 +210,7 @@ export class ConnectionManager {
socket.destroy();
}
} catch (err) {
console.log(`[${record.id}] Error destroying ${side} socket: ${err}`);
logger.log('error', `Error destroying ${side} socket for connection ${record.id}: ${err}`, { connectionId: record.id, side, error: err, component: 'connection-manager' });
}
}, 1000);
@ -199,13 +220,13 @@ export class ConnectionManager {
}
}
} catch (err) {
console.log(`[${record.id}] Error closing ${side} socket: ${err}`);
logger.log('error', `Error closing ${side} socket for connection ${record.id}: ${err}`, { connectionId: record.id, side, error: err, component: 'connection-manager' });
try {
if (!socket.destroyed) {
socket.destroy();
}
} catch (destroyErr) {
console.log(`[${record.id}] Error destroying ${side} socket: ${destroyErr}`);
logger.log('error', `Error destroying ${side} socket for connection ${record.id}: ${destroyErr}`, { connectionId: record.id, side, error: destroyErr, component: 'connection-manager' });
}
}
}
@ -224,21 +245,36 @@ export class ConnectionManager {
if (code === 'ECONNRESET') {
reason = 'econnreset';
console.log(
`[${record.id}] ECONNRESET on ${side} side from ${record.remoteIP}: ${err.message}. ` +
`Duration: ${plugins.prettyMs(connectionDuration)}, Last activity: ${plugins.prettyMs(lastActivityAge)} ago`
);
logger.log('warn', `ECONNRESET on ${side} connection from ${record.remoteIP}. Error: ${err.message}. Duration: ${plugins.prettyMs(connectionDuration)}, Last activity: ${plugins.prettyMs(lastActivityAge)}`, {
connectionId: record.id,
side,
remoteIP: record.remoteIP,
error: err.message,
duration: plugins.prettyMs(connectionDuration),
lastActivity: plugins.prettyMs(lastActivityAge),
component: 'connection-manager'
});
} else if (code === 'ETIMEDOUT') {
reason = 'etimedout';
console.log(
`[${record.id}] ETIMEDOUT on ${side} side from ${record.remoteIP}: ${err.message}. ` +
`Duration: ${plugins.prettyMs(connectionDuration)}, Last activity: ${plugins.prettyMs(lastActivityAge)} ago`
);
logger.log('warn', `ETIMEDOUT on ${side} connection from ${record.remoteIP}. Error: ${err.message}. Duration: ${plugins.prettyMs(connectionDuration)}, Last activity: ${plugins.prettyMs(lastActivityAge)}`, {
connectionId: record.id,
side,
remoteIP: record.remoteIP,
error: err.message,
duration: plugins.prettyMs(connectionDuration),
lastActivity: plugins.prettyMs(lastActivityAge),
component: 'connection-manager'
});
} else {
console.log(
`[${record.id}] Error on ${side} side from ${record.remoteIP}: ${err.message}. ` +
`Duration: ${plugins.prettyMs(connectionDuration)}, Last activity: ${plugins.prettyMs(lastActivityAge)} ago`
);
logger.log('error', `Error on ${side} connection from ${record.remoteIP}: ${err.message}. Duration: ${plugins.prettyMs(connectionDuration)}, Last activity: ${plugins.prettyMs(lastActivityAge)}`, {
connectionId: record.id,
side,
remoteIP: record.remoteIP,
error: err.message,
duration: plugins.prettyMs(connectionDuration),
lastActivity: plugins.prettyMs(lastActivityAge),
component: 'connection-manager'
});
}
if (side === 'incoming' && record.incomingTerminationReason === null) {
@ -259,7 +295,12 @@ export class ConnectionManager {
public handleClose(side: 'incoming' | 'outgoing', record: IConnectionRecord) {
return () => {
if (this.settings.enableDetailedLogging) {
console.log(`[${record.id}] Connection closed on ${side} side from ${record.remoteIP}`);
logger.log('info', `Connection closed on ${side} side`, {
connectionId: record.id,
side,
remoteIP: record.remoteIP,
component: 'connection-manager'
});
}
if (side === 'incoming' && record.incomingTerminationReason === null) {
@ -321,11 +362,13 @@ export class ConnectionManager {
if (inactivityTime > effectiveTimeout && !record.connectionClosed) {
// For keep-alive connections, issue a warning first
if (record.hasKeepAlive && !record.inactivityWarningIssued) {
console.log(
`[${id}] Warning: Keep-alive connection from ${record.remoteIP} inactive for ${
plugins.prettyMs(inactivityTime)
}. Will close in 10 minutes if no activity.`
);
logger.log('warn', `Keep-alive connection ${id} from ${record.remoteIP} inactive for ${plugins.prettyMs(inactivityTime)}. Will close in 10 minutes if no activity.`, {
connectionId: id,
remoteIP: record.remoteIP,
inactiveFor: plugins.prettyMs(inactivityTime),
closureWarning: '10 minutes',
component: 'connection-manager'
});
// Set warning flag and add grace period
record.inactivityWarningIssued = true;
@ -337,27 +380,30 @@ export class ConnectionManager {
record.outgoing.write(Buffer.alloc(0));
if (this.settings.enableDetailedLogging) {
console.log(`[${id}] Sent probe packet to test keep-alive connection`);
logger.log('info', `Sent probe packet to test keep-alive connection ${id}`, { connectionId: id, component: 'connection-manager' });
}
} catch (err) {
console.log(`[${id}] Error sending probe packet: ${err}`);
logger.log('error', `Error sending probe packet to connection ${id}: ${err}`, { connectionId: id, error: err, component: 'connection-manager' });
}
}
} else {
// For non-keep-alive or after warning, close the connection
console.log(
`[${id}] Inactivity check: No activity on connection from ${record.remoteIP} ` +
`for ${plugins.prettyMs(inactivityTime)}.` +
(record.hasKeepAlive ? ' Despite keep-alive being enabled.' : '')
);
logger.log('warn', `Closing inactive connection ${id} from ${record.remoteIP} (inactive for ${plugins.prettyMs(inactivityTime)}, keep-alive: ${record.hasKeepAlive ? 'Yes' : 'No'})`, {
connectionId: id,
remoteIP: record.remoteIP,
inactiveFor: plugins.prettyMs(inactivityTime),
hasKeepAlive: record.hasKeepAlive,
component: 'connection-manager'
});
this.cleanupConnection(record, 'inactivity');
}
} else if (inactivityTime <= effectiveTimeout && record.inactivityWarningIssued) {
// If activity detected after warning, clear the warning
if (this.settings.enableDetailedLogging) {
console.log(
`[${id}] Connection activity detected after inactivity warning, resetting warning`
);
logger.log('info', `Connection ${id} activity detected after inactivity warning`, {
connectionId: id,
component: 'connection-manager'
});
}
record.inactivityWarningIssued = false;
}
@ -369,11 +415,12 @@ export class ConnectionManager {
!record.connectionClosed &&
now - record.outgoingClosedTime > 120000
) {
console.log(
`[${id}] Parity check: Incoming socket for ${record.remoteIP} still active ${
plugins.prettyMs(now - record.outgoingClosedTime)
} after outgoing closed.`
);
logger.log('warn', `Parity check: Connection ${id} from ${record.remoteIP} has incoming socket still active ${plugins.prettyMs(now - record.outgoingClosedTime)} after outgoing socket closed`, {
connectionId: id,
remoteIP: record.remoteIP,
timeElapsed: plugins.prettyMs(now - record.outgoingClosedTime),
component: 'connection-manager'
});
this.cleanupConnection(record, 'parity_check');
}
}
@ -406,7 +453,7 @@ export class ConnectionManager {
record.outgoing.end();
}
} catch (err) {
console.log(`Error during graceful connection end for ${id}: ${err}`);
logger.log('error', `Error during graceful end of connection ${id}: ${err}`, { connectionId: id, error: err, component: 'connection-manager' });
}
}
}
@ -433,7 +480,7 @@ export class ConnectionManager {
}
}
} catch (err) {
console.log(`Error during forced connection destruction for ${id}: ${err}`);
logger.log('error', `Error during forced destruction of connection ${id}: ${err}`, { connectionId: id, error: err, component: 'connection-manager' });
}
}
}

View File

@ -63,11 +63,24 @@ export class HttpProxyBridge {
*/
private routeToHttpProxyConfig(route: IRouteConfig): any {
// Convert route to HttpProxy domain config format
let domain = '*';
if (route.match.domains) {
if (Array.isArray(route.match.domains)) {
domain = route.match.domains[0] || '*';
} else {
domain = route.match.domains;
}
}
return {
domain: route.match.domains?.[0] || '*',
domain,
target: route.action.target,
tls: route.action.tls,
security: route.action.security
security: route.action.security,
match: {
...route.match,
domains: domain // Ensure domains is always set for HttpProxy
}
};
}

View File

@ -2,11 +2,20 @@ import * as plugins from '../../../plugins.js';
// Certificate types removed - use local definition
import type { TForwardingType } from '../../../forwarding/config/forwarding-types.js';
import type { PortRange } from '../../../proxies/nftables-proxy/models/interfaces.js';
import type { IRouteContext } from '../../../core/models/route-context.js';
// Re-export IRouteContext for convenience
export type { IRouteContext };
/**
* Supported action types for route configurations
*/
export type TRouteActionType = 'forward' | 'redirect' | 'block' | 'static';
export type TRouteActionType = 'forward' | 'socket-handler';
/**
* Socket handler function type
*/
export type TSocketHandler = (socket: plugins.net.Socket, context: IRouteContext) => void | Promise<void>;
/**
* TLS handling modes for route configurations
@ -35,36 +44,6 @@ export interface IRouteMatch {
headers?: Record<string, string | RegExp>; // Match specific HTTP headers
}
/**
* Context provided to port and host mapping functions
*/
export interface IRouteContext {
// Connection information
port: number; // The matched incoming port
domain?: string; // The domain from SNI or Host header
clientIp: string; // The client's IP address
serverIp: string; // The server's IP address
path?: string; // URL path (for HTTP connections)
query?: string; // Query string (for HTTP connections)
headers?: Record<string, string>; // HTTP headers (for HTTP connections)
method?: string; // HTTP method (for HTTP connections)
// TLS information
isTls: boolean; // Whether the connection is TLS
tlsVersion?: string; // TLS version if applicable
// Route information
routeName?: string; // The name of the matched route
routeId?: string; // The ID of the matched route
// Target information (resolved from dynamic mapping)
targetHost?: string | string[]; // The resolved target host(s)
targetPort?: number; // The resolved target port
// Additional properties
timestamp: number; // The request timestamp
connectionId: string; // Unique connection identifier
}
/**
* Target configuration for forwarding
@ -84,15 +63,6 @@ export interface IRouteAcme {
renewBeforeDays?: number; // Days before expiry to renew (default: 30)
}
/**
* Static route handler response
*/
export interface IStaticResponse {
status: number;
headers?: Record<string, string>;
body: string | Buffer;
}
/**
* TLS configuration for route actions
*/
@ -112,14 +82,6 @@ export interface IRouteTls {
sessionTimeout?: number; // TLS session timeout in seconds
}
/**
* Redirect configuration for route actions
*/
export interface IRouteRedirect {
to: string; // URL or template with {domain}, {port}, etc.
status: 301 | 302 | 307 | 308;
}
/**
* Authentication options
*/
@ -265,12 +227,6 @@ export interface IRouteAction {
// TLS handling
tls?: IRouteTls;
// For redirects
redirect?: IRouteRedirect;
// For static files
static?: IRouteStaticFiles;
// WebSocket support
websocket?: IRouteWebSocket;
@ -295,8 +251,8 @@ export interface IRouteAction {
// NFTables-specific options
nftables?: INfTablesOptions;
// Handler function for static routes
handler?: (context: IRouteContext) => Promise<IStaticResponse>;
// Socket handler function (when type is 'socket-handler')
socketHandler?: TSocketHandler;
}
/**

View File

@ -1,6 +1,7 @@
import * as plugins from '../../plugins.js';
import type { ISmartProxyOptions } from './models/interfaces.js';
import { RouteConnectionHandler } from './route-connection-handler.js';
import { logger } from '../../core/utils/logger.js';
/**
* PortManager handles the dynamic creation and removal of port listeners
@ -8,12 +9,17 @@ import { RouteConnectionHandler } from './route-connection-handler.js';
* This class provides methods to add and remove listening ports at runtime,
* allowing SmartProxy to adapt to configuration changes without requiring
* a full restart.
*
* It includes a reference counting system to track how many routes are using
* each port, so ports can be automatically released when they are no longer needed.
*/
export class PortManager {
private servers: Map<number, plugins.net.Server> = new Map();
private settings: ISmartProxyOptions;
private routeConnectionHandler: RouteConnectionHandler;
private isShuttingDown: boolean = false;
// Track how many routes are using each port
private portRefCounts: Map<number, number> = new Map();
/**
* Create a new PortManager
@ -38,10 +44,22 @@ export class PortManager {
public async addPort(port: number): Promise<void> {
// Check if we're already listening on this port
if (this.servers.has(port)) {
console.log(`PortManager: Already listening on port ${port}`);
// Port is already bound, just increment the reference count
this.incrementPortRefCount(port);
try {
logger.log('debug', `PortManager: Port ${port} is already bound by SmartProxy, reusing binding`, {
port,
component: 'port-manager'
});
} catch (e) {
console.log(`[DEBUG] PortManager: Port ${port} is already bound by SmartProxy, reusing binding`);
}
return;
}
// Initialize reference count for new port
this.portRefCounts.set(port, 1);
// Create a server for this port
const server = plugins.net.createServer((socket) => {
// Check if shutting down
@ -54,24 +72,66 @@ export class PortManager {
// Delegate to route connection handler
this.routeConnectionHandler.handleConnection(socket);
}).on('error', (err: Error) => {
console.log(`Server Error on port ${port}: ${err.message}`);
try {
logger.log('error', `Server Error on port ${port}: ${err.message}`, {
port,
error: err.message,
component: 'port-manager'
});
} catch (e) {
console.error(`[ERROR] Server Error on port ${port}: ${err.message}`);
}
});
// Start listening on the port
return new Promise<void>((resolve, reject) => {
server.listen(port, () => {
const isHttpProxyPort = this.settings.useHttpProxy?.includes(port);
console.log(
`SmartProxy -> OK: Now listening on port ${port}${
try {
logger.log('info', `SmartProxy -> OK: Now listening on port ${port}${
isHttpProxyPort ? ' (HttpProxy forwarding enabled)' : ''
}`
);
}`, {
port,
isHttpProxyPort: !!isHttpProxyPort,
component: 'port-manager'
});
} catch (e) {
console.log(`[INFO] SmartProxy -> OK: Now listening on port ${port}${
isHttpProxyPort ? ' (HttpProxy forwarding enabled)' : ''
}`);
}
// Store the server reference
this.servers.set(port, server);
resolve();
}).on('error', (err) => {
console.log(`Failed to listen on port ${port}: ${err.message}`);
// Check if this is an external conflict
const { isConflict, isExternal } = this.isPortConflict(err);
if (isConflict && !isExternal) {
// This is an internal conflict (port already bound by SmartProxy)
// This shouldn't normally happen because we check servers.has(port) above
logger.log('warn', `Port ${port} binding conflict: already in use by SmartProxy`, {
port,
component: 'port-manager'
});
// Still increment reference count to maintain tracking
this.incrementPortRefCount(port);
resolve();
return;
}
// Log the error and propagate it
logger.log('error', `Failed to listen on port ${port}: ${err.message}`, {
port,
error: err.message,
code: (err as any).code,
component: 'port-manager'
});
// Clean up reference count since binding failed
this.portRefCounts.delete(port);
reject(err);
});
});
@ -84,10 +144,28 @@ export class PortManager {
* @returns Promise that resolves when the server is closed
*/
public async removePort(port: number): Promise<void> {
// Decrement the reference count first
const newRefCount = this.decrementPortRefCount(port);
// If there are still references to this port, keep it open
if (newRefCount > 0) {
logger.log('debug', `PortManager: Port ${port} still has ${newRefCount} references, keeping open`, {
port,
refCount: newRefCount,
component: 'port-manager'
});
return;
}
// Get the server for this port
const server = this.servers.get(port);
if (!server) {
console.log(`PortManager: Not listening on port ${port}`);
logger.log('warn', `PortManager: Not listening on port ${port}`, {
port,
component: 'port-manager'
});
// Ensure reference count is reset
this.portRefCounts.delete(port);
return;
}
@ -95,13 +173,21 @@ export class PortManager {
return new Promise<void>((resolve) => {
server.close((err) => {
if (err) {
console.log(`Error closing server on port ${port}: ${err.message}`);
logger.log('error', `Error closing server on port ${port}: ${err.message}`, {
port,
error: err.message,
component: 'port-manager'
});
} else {
console.log(`SmartProxy -> Stopped listening on port ${port}`);
logger.log('info', `SmartProxy -> Stopped listening on port ${port}`, {
port,
component: 'port-manager'
});
}
// Remove the server reference
// Remove the server reference and clean up reference counting
this.servers.delete(port);
this.portRefCounts.delete(port);
resolve();
});
});
@ -192,4 +278,89 @@ export class PortManager {
public getServers(): Map<number, plugins.net.Server> {
return new Map(this.servers);
}
/**
* Check if a port is bound by this SmartProxy instance
*
* @param port The port number to check
* @returns True if the port is currently bound by SmartProxy
*/
public isPortBoundBySmartProxy(port: number): boolean {
return this.servers.has(port);
}
/**
* Get the current reference count for a port
*
* @param port The port number to check
* @returns The number of routes using this port, 0 if none
*/
public getPortRefCount(port: number): number {
return this.portRefCounts.get(port) || 0;
}
/**
* Increment the reference count for a port
*
* @param port The port number to increment
* @returns The new reference count
*/
public incrementPortRefCount(port: number): number {
const currentCount = this.portRefCounts.get(port) || 0;
const newCount = currentCount + 1;
this.portRefCounts.set(port, newCount);
logger.log('debug', `Port ${port} reference count increased to ${newCount}`, {
port,
refCount: newCount,
component: 'port-manager'
});
return newCount;
}
/**
* Decrement the reference count for a port
*
* @param port The port number to decrement
* @returns The new reference count
*/
public decrementPortRefCount(port: number): number {
const currentCount = this.portRefCounts.get(port) || 0;
if (currentCount <= 0) {
logger.log('warn', `Attempted to decrement reference count for port ${port} below zero`, {
port,
component: 'port-manager'
});
return 0;
}
const newCount = currentCount - 1;
this.portRefCounts.set(port, newCount);
logger.log('debug', `Port ${port} reference count decreased to ${newCount}`, {
port,
refCount: newCount,
component: 'port-manager'
});
return newCount;
}
/**
* Determine if a port binding error is due to an external or internal conflict
*
* @param error The error object from a failed port binding
* @returns Object indicating if this is a conflict and if it's external
*/
private isPortConflict(error: any): { isConflict: boolean; isExternal: boolean } {
if (error.code !== 'EADDRINUSE') {
return { isConflict: false, isExternal: false };
}
// Check if we already have this port
const isBoundInternally = this.servers.has(Number(error.port));
return { isConflict: true, isExternal: !isBoundInternally };
}
}

File diff suppressed because it is too large Load Diff

View File

@ -338,10 +338,19 @@ export class RouteManager extends plugins.EventEmitter {
// Find the first matching route based on priority order
for (const route of routesForPort) {
// Check domain match if specified
if (domain && !this.matchRouteDomain(route, domain)) {
continue;
// Check domain match
// If the route has domain restrictions and we have a domain to check
if (route.match.domains) {
// If no domain was provided (non-TLS or no SNI), this route doesn't match
if (!domain) {
continue;
}
// If domain is provided but doesn't match the route's domains, skip
if (!this.matchRouteDomain(route, domain)) {
continue;
}
}
// If route has no domain restrictions, it matches all domains
// Check path match if specified in both route and request
if (path && route.match.path) {

View File

@ -1,4 +1,5 @@
import * as plugins from '../../plugins.js';
import { logger } from '../../core/utils/logger.js';
// Importing required components
import { ConnectionManager } from './connection-manager.js';
@ -63,6 +64,9 @@ export class SmartProxy extends plugins.EventEmitter {
private routeUpdateLock: any = null; // Will be initialized as AsyncMutex
private acmeStateManager: AcmeStateManager;
// Track port usage across route updates
private portUsageMap: Map<number, Set<string>> = new Map();
/**
* Constructor for SmartProxy
*
@ -239,7 +243,7 @@ export class SmartProxy extends plugins.EventEmitter {
);
if (autoRoutes.length === 0 && !this.hasStaticCertRoutes()) {
console.log('No routes require certificate management');
logger.log('info', 'No routes require certificate management', { component: 'certificate-manager' });
return;
}
@ -256,7 +260,7 @@ export class SmartProxy extends plugins.EventEmitter {
useProduction: this.settings.acme.useProduction || false,
port: this.settings.acme.port || 80
};
console.log(`Using top-level ACME configuration with email: ${acmeOptions.email}`);
logger.log('info', `Using top-level ACME configuration with email: ${acmeOptions.email}`, { component: 'certificate-manager' });
} else if (autoRoutes.length > 0) {
// Check for route-level ACME config
const routeWithAcme = autoRoutes.find(r => r.action.tls?.acme?.email);
@ -267,7 +271,7 @@ export class SmartProxy extends plugins.EventEmitter {
useProduction: routeAcme.useProduction || false,
port: routeAcme.challengePort || 80
};
console.log(`Using route-level ACME configuration from route '${routeWithAcme.name}' with email: ${acmeOptions.email}`);
logger.log('info', `Using route-level ACME configuration from route '${routeWithAcme.name}' with email: ${acmeOptions.email}`, { component: 'certificate-manager' });
}
}
@ -305,25 +309,10 @@ export class SmartProxy extends plugins.EventEmitter {
public async start() {
// Don't start if already shutting down
if (this.isShuttingDown) {
console.log("Cannot start SmartProxy while it's shutting down");
logger.log('warn', "Cannot start SmartProxy while it's in the shutdown process");
return;
}
// Initialize certificate manager before starting servers
await this.initializeCertificateManager();
// Initialize and start HttpProxy if needed
if (this.settings.useHttpProxy && this.settings.useHttpProxy.length > 0) {
await this.httpProxyBridge.initialize();
// Connect HttpProxy with certificate manager
if (this.certManager) {
this.certManager.setHttpProxy(this.httpProxyBridge.getHttpProxy());
}
await this.httpProxyBridge.start();
}
// Validate the route configuration
const configWarnings = this.routeManager.validateConfiguration();
@ -332,15 +321,25 @@ export class SmartProxy extends plugins.EventEmitter {
const allWarnings = [...configWarnings, ...acmeWarnings];
if (allWarnings.length > 0) {
console.log("Configuration warnings:");
logger.log('warn', `${allWarnings.length} configuration warnings found`, { count: allWarnings.length });
for (const warning of allWarnings) {
console.log(` - ${warning}`);
logger.log('warn', `${warning}`);
}
}
// Get listening ports from RouteManager
const listeningPorts = this.routeManager.getListeningPorts();
// Initialize port usage tracking
this.portUsageMap = this.updatePortUsageMap(this.settings.routes);
// Log port usage for startup
logger.log('info', `SmartProxy starting with ${listeningPorts.length} ports: ${listeningPorts.join(', ')}`, {
portCount: listeningPorts.length,
ports: listeningPorts,
component: 'smart-proxy'
});
// Provision NFTables rules for routes that use NFTables
for (const route of this.settings.routes) {
if (route.action.forwardingEngine === 'nftables') {
@ -348,8 +347,30 @@ export class SmartProxy extends plugins.EventEmitter {
}
}
// Start port listeners using the PortManager
// Initialize and start HttpProxy if needed - before port binding
if (this.settings.useHttpProxy && this.settings.useHttpProxy.length > 0) {
await this.httpProxyBridge.initialize();
await this.httpProxyBridge.start();
}
// Start port listeners using the PortManager BEFORE initializing certificate manager
// This ensures all required ports are bound and ready when adding ACME challenge routes
await this.portManager.addPorts(listeningPorts);
// Initialize certificate manager AFTER port binding is complete
// This ensures the ACME challenge port is already bound and ready when needed
await this.initializeCertificateManager();
// Connect certificate manager with HttpProxy if both are available
if (this.certManager && this.httpProxyBridge.getHttpProxy()) {
this.certManager.setHttpProxy(this.httpProxyBridge.getHttpProxy());
}
// Now that ports are listening, provision any required certificates
if (this.certManager) {
logger.log('info', 'Starting certificate provisioning now that ports are ready', { component: 'certificate-manager' });
await this.certManager.provisionAllCertificates();
}
// Set up periodic connection logging and inactivity checks
this.connectionLogger = setInterval(() => {
@ -405,16 +426,26 @@ export class SmartProxy extends plugins.EventEmitter {
const terminationStats = this.connectionManager.getTerminationStats();
// Log detailed stats
console.log(
`Active connections: ${connectionRecords.size}. ` +
`Types: TLS=${tlsConnections} (Completed=${completedTlsHandshakes}, Pending=${pendingTlsHandshakes}), ` +
`Non-TLS=${nonTlsConnections}, KeepAlive=${keepAliveConnections}, HttpProxy=${httpProxyConnections}. ` +
`Longest running: IN=${plugins.prettyMs(maxIncoming)}, OUT=${plugins.prettyMs(maxOutgoing)}. ` +
`Termination stats: ${JSON.stringify({
IN: terminationStats.incoming,
OUT: terminationStats.outgoing,
})}`
);
logger.log('info', 'Connection statistics', {
activeConnections: connectionRecords.size,
tls: {
total: tlsConnections,
completed: completedTlsHandshakes,
pending: pendingTlsHandshakes
},
nonTls: nonTlsConnections,
keepAlive: keepAliveConnections,
httpProxy: httpProxyConnections,
longestRunning: {
incoming: plugins.prettyMs(maxIncoming),
outgoing: plugins.prettyMs(maxOutgoing)
},
terminationStats: {
incoming: terminationStats.incoming,
outgoing: terminationStats.outgoing
},
component: 'connection-manager'
});
}, this.settings.inactivityCheckInterval || 60000);
// Make sure the interval doesn't keep the process alive
@ -433,19 +464,19 @@ export class SmartProxy extends plugins.EventEmitter {
* Stop the proxy server
*/
public async stop() {
console.log('SmartProxy shutting down...');
logger.log('info', 'SmartProxy shutting down...');
this.isShuttingDown = true;
this.portManager.setShuttingDown(true);
// Stop certificate manager
if (this.certManager) {
await this.certManager.stop();
console.log('Certificate manager stopped');
logger.log('info', 'Certificate manager stopped');
}
// Stop NFTablesManager
await this.nftablesManager.stop();
console.log('NFTablesManager stopped');
logger.log('info', 'NFTablesManager stopped');
// Stop the connection logger
if (this.connectionLogger) {
@ -455,7 +486,7 @@ export class SmartProxy extends plugins.EventEmitter {
// Stop all port listeners
await this.portManager.closeAll();
console.log('All servers closed. Cleaning up active connections...');
logger.log('info', 'All servers closed. Cleaning up active connections...');
// Clean up all active connections
this.connectionManager.clearConnections();
@ -466,7 +497,7 @@ export class SmartProxy extends plugins.EventEmitter {
// Clear ACME state manager
this.acmeStateManager.clear();
console.log('SmartProxy shutdown complete.');
logger.log('info', 'SmartProxy shutdown complete.');
}
/**
@ -475,7 +506,7 @@ export class SmartProxy extends plugins.EventEmitter {
* Note: This legacy method has been removed. Use updateRoutes instead.
*/
public async updateDomainConfigs(): Promise<void> {
console.warn('Method updateDomainConfigs() is deprecated. Use updateRoutes() instead.');
logger.log('warn', 'Method updateDomainConfigs() is deprecated. Use updateRoutes() instead.');
throw new Error('updateDomainConfigs() is deprecated - use updateRoutes() instead');
}
@ -491,7 +522,12 @@ export class SmartProxy extends plugins.EventEmitter {
const challengeRouteExists = this.settings.routes.some(r => r.name === 'acme-challenge');
if (!challengeRouteExists) {
console.log('Challenge route successfully removed from routes');
try {
logger.log('info', 'Challenge route successfully removed from routes');
} catch (error) {
// Silently handle logging errors
console.log('[INFO] Challenge route successfully removed from routes');
}
return;
}
@ -499,7 +535,14 @@ export class SmartProxy extends plugins.EventEmitter {
await plugins.smartdelay.delayFor(retryDelay);
}
throw new Error('Failed to verify challenge route removal after ' + maxRetries + ' attempts');
const error = `Failed to verify challenge route removal after ${maxRetries} attempts`;
try {
logger.log('error', error);
} catch (logError) {
// Silently handle logging errors
console.log(`[ERROR] ${error}`);
}
throw new Error(error);
}
/**
@ -527,19 +570,74 @@ export class SmartProxy extends plugins.EventEmitter {
*/
public async updateRoutes(newRoutes: IRouteConfig[]): Promise<void> {
return this.routeUpdateLock.runExclusive(async () => {
console.log(`Updating routes (${newRoutes.length} routes)`);
try {
logger.log('info', `Updating routes (${newRoutes.length} routes)`, {
routeCount: newRoutes.length,
component: 'route-manager'
});
} catch (error) {
// Silently handle logging errors
console.log(`[INFO] Updating routes (${newRoutes.length} routes)`);
}
// Get existing routes that use NFTables
// Track port usage before and after updates
const oldPortUsage = this.updatePortUsageMap(this.settings.routes);
const newPortUsage = this.updatePortUsageMap(newRoutes);
// Get the lists of currently listening ports and new ports needed
const currentPorts = new Set(this.portManager.getListeningPorts());
const newPortsSet = new Set(newPortUsage.keys());
// Log the port usage for debugging
try {
logger.log('debug', `Current listening ports: ${Array.from(currentPorts).join(', ')}`, {
ports: Array.from(currentPorts),
component: 'smart-proxy'
});
logger.log('debug', `Ports needed for new routes: ${Array.from(newPortsSet).join(', ')}`, {
ports: Array.from(newPortsSet),
component: 'smart-proxy'
});
} catch (error) {
// Silently handle logging errors
console.log(`[DEBUG] Current listening ports: ${Array.from(currentPorts).join(', ')}`);
console.log(`[DEBUG] Ports needed for new routes: ${Array.from(newPortsSet).join(', ')}`);
}
// Find orphaned ports - ports that no longer have any routes
const orphanedPorts = this.findOrphanedPorts(oldPortUsage, newPortUsage);
// Find new ports that need binding (only ports that we aren't already listening on)
const newBindingPorts = Array.from(newPortsSet).filter(p => !currentPorts.has(p));
// Check for ACME challenge port to give it special handling
const acmePort = this.settings.acme?.port || 80;
const acmePortNeeded = newPortsSet.has(acmePort);
const acmePortListed = newBindingPorts.includes(acmePort);
if (acmePortNeeded && acmePortListed) {
try {
logger.log('info', `Adding ACME challenge port ${acmePort} to routes`, {
port: acmePort,
component: 'smart-proxy'
});
} catch (error) {
// Silently handle logging errors
console.log(`[INFO] Adding ACME challenge port ${acmePort} to routes`);
}
}
// Get existing routes that use NFTables and update them
const oldNfTablesRoutes = this.settings.routes.filter(
r => r.action.forwardingEngine === 'nftables'
);
// Get new routes that use NFTables
const newNfTablesRoutes = newRoutes.filter(
r => r.action.forwardingEngine === 'nftables'
);
// Find routes to remove, update, or add
// Update existing NFTables routes
for (const oldRoute of oldNfTablesRoutes) {
const newRoute = newNfTablesRoutes.find(r => r.name === oldRoute.name);
@ -552,7 +650,7 @@ export class SmartProxy extends plugins.EventEmitter {
}
}
// Find new routes to add
// Add new NFTables routes
for (const newRoute of newNfTablesRoutes) {
const oldRoute = oldNfTablesRoutes.find(r => r.name === newRoute.name);
@ -565,14 +663,70 @@ export class SmartProxy extends plugins.EventEmitter {
// Update routes in RouteManager
this.routeManager.updateRoutes(newRoutes);
// Get the new set of required ports
const requiredPorts = this.routeManager.getListeningPorts();
// Update port listeners to match the new configuration
await this.portManager.updatePorts(requiredPorts);
// Release orphaned ports first to free resources
if (orphanedPorts.length > 0) {
try {
logger.log('info', `Releasing ${orphanedPorts.length} orphaned ports: ${orphanedPorts.join(', ')}`, {
ports: orphanedPorts,
component: 'smart-proxy'
});
} catch (error) {
// Silently handle logging errors
console.log(`[INFO] Releasing ${orphanedPorts.length} orphaned ports: ${orphanedPorts.join(', ')}`);
}
await this.portManager.removePorts(orphanedPorts);
}
// Add new ports if needed
if (newBindingPorts.length > 0) {
try {
logger.log('info', `Binding to ${newBindingPorts.length} new ports: ${newBindingPorts.join(', ')}`, {
ports: newBindingPorts,
component: 'smart-proxy'
});
} catch (error) {
// Silently handle logging errors
console.log(`[INFO] Binding to ${newBindingPorts.length} new ports: ${newBindingPorts.join(', ')}`);
}
// Handle port binding with improved error recovery
try {
await this.portManager.addPorts(newBindingPorts);
} catch (error) {
// Special handling for port binding errors
// This provides better diagnostics for ACME challenge port conflicts
if ((error as any).code === 'EADDRINUSE') {
const port = (error as any).port || newBindingPorts[0];
const isAcmePort = port === acmePort;
if (isAcmePort) {
try {
logger.log('warn', `Could not bind to ACME challenge port ${port}. It may be in use by another application.`, {
port,
component: 'smart-proxy'
});
} catch (logError) {
console.log(`[WARN] Could not bind to ACME challenge port ${port}. It may be in use by another application.`);
}
// Re-throw with more helpful message
throw new Error(
`ACME challenge port ${port} is already in use by another application. ` +
`Configure a different port in settings.acme.port (e.g., 8080) or free up port ${port}.`
);
}
}
// Re-throw the original error for other cases
throw error;
}
}
// Update settings with the new routes
this.settings.routes = newRoutes;
// Save the new port usage map for future reference
this.portUsageMap = newPortUsage;
// If HttpProxy is initialized, resync the configurations
if (this.httpProxyBridge.getHttpProxy()) {
@ -587,6 +741,22 @@ export class SmartProxy extends plugins.EventEmitter {
// Store global state before stopping
this.globalChallengeRouteActive = existingState.challengeRouteActive;
// Only stop the cert manager if absolutely necessary
// First check if there's an ACME route on the same port already
const acmePort = existingAcmeOptions?.port || 80;
const acmePortInUse = newPortUsage.has(acmePort) && newPortUsage.get(acmePort)!.size > 0;
try {
logger.log('debug', `ACME port ${acmePort} ${acmePortInUse ? 'is' : 'is not'} already in use by other routes`, {
port: acmePort,
inUse: acmePortInUse,
component: 'smart-proxy'
});
} catch (error) {
// Silently handle logging errors
console.log(`[DEBUG] ACME port ${acmePort} ${acmePortInUse ? 'is' : 'is not'} already in use by other routes`);
}
await this.certManager.stop();
// Verify the challenge route has been properly removed
@ -618,6 +788,88 @@ export class SmartProxy extends plugins.EventEmitter {
await this.certManager.provisionCertificate(route);
}
/**
* Update the port usage map based on the provided routes
*
* This tracks which ports are used by which routes, allowing us to
* detect when a port is no longer needed and can be released.
*/
private updatePortUsageMap(routes: IRouteConfig[]): Map<number, Set<string>> {
// Reset the usage map
const portUsage = new Map<number, Set<string>>();
for (const route of routes) {
// Get the ports for this route
const portsConfig = Array.isArray(route.match.ports)
? route.match.ports
: [route.match.ports];
// Expand port range objects to individual port numbers
const expandedPorts: number[] = [];
for (const portConfig of portsConfig) {
if (typeof portConfig === 'number') {
expandedPorts.push(portConfig);
} else if (typeof portConfig === 'object' && 'from' in portConfig && 'to' in portConfig) {
// Expand the port range
for (let p = portConfig.from; p <= portConfig.to; p++) {
expandedPorts.push(p);
}
}
}
// Use route name if available, otherwise generate a unique ID
const routeName = route.name || `unnamed_${Math.random().toString(36).substring(2, 9)}`;
// Add each port to the usage map
for (const port of expandedPorts) {
if (!portUsage.has(port)) {
portUsage.set(port, new Set());
}
portUsage.get(port)!.add(routeName);
}
}
// Log port usage for debugging
for (const [port, routes] of portUsage.entries()) {
try {
logger.log('debug', `Port ${port} is used by ${routes.size} routes: ${Array.from(routes).join(', ')}`, {
port,
routeCount: routes.size,
component: 'smart-proxy'
});
} catch (error) {
// Silently handle logging errors
console.log(`[DEBUG] Port ${port} is used by ${routes.size} routes: ${Array.from(routes).join(', ')}`);
}
}
return portUsage;
}
/**
* Find ports that have no routes in the new configuration
*/
private findOrphanedPorts(oldUsage: Map<number, Set<string>>, newUsage: Map<number, Set<string>>): number[] {
const orphanedPorts: number[] = [];
for (const [port, routes] of oldUsage.entries()) {
if (!newUsage.has(port) || newUsage.get(port)!.size === 0) {
orphanedPorts.push(port);
try {
logger.log('info', `Port ${port} no longer has any associated routes, will be released`, {
port,
component: 'smart-proxy'
});
} catch (error) {
// Silently handle logging errors
console.log(`[INFO] Port ${port} no longer has any associated routes, will be released`);
}
}
}
return orphanedPorts;
}
/**
* Force renewal of a certificate
@ -652,14 +904,14 @@ export class SmartProxy extends plugins.EventEmitter {
// Check for wildcard domains (they can't get ACME certs)
if (domain.includes('*')) {
console.log(`Wildcard domains like "${domain}" are not supported for ACME certificates`);
logger.log('warn', `Wildcard domains like "${domain}" are not supported for automatic ACME certificates`, { domain, component: 'certificate-manager' });
return false;
}
// Check if domain has at least one dot and no invalid characters
const validDomainRegex = /^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
if (!validDomainRegex.test(domain)) {
console.log(`Domain "${domain}" has invalid format`);
logger.log('warn', `Domain "${domain}" has invalid format for certificate issuance`, { domain, component: 'certificate-manager' });
return false;
}

View File

@ -19,7 +19,6 @@ import {
createWebSocketRoute as createWebSocketPatternRoute,
createLoadBalancerRoute as createLoadBalancerPatternRoute,
createApiGatewayRoute,
createStaticFileServerRoute,
addRateLimiting,
addBasicAuth,
addJwtAuth
@ -29,7 +28,6 @@ export {
createWebSocketPatternRoute,
createLoadBalancerPatternRoute,
createApiGatewayRoute,
createStaticFileServerRoute,
addRateLimiting,
addBasicAuth,
addJwtAuth

View File

@ -11,7 +11,6 @@
* - 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)
* - Port mapping routes (createPortMappingRoute, createOffsetPortMappingRoute)
@ -19,6 +18,7 @@
* - NFTables routes (createNfTablesRoute, createNfTablesTerminateRoute)
*/
import * as plugins from '../../../plugins.js';
import type { IRouteConfig, IRouteMatch, IRouteAction, IRouteTarget, TPortRange, IRouteContext } from '../models/route-types.js';
/**
@ -118,11 +118,8 @@ export function createHttpToHttpsRedirect(
// Create route action
const action: IRouteAction = {
type: 'redirect',
redirect: {
to: `https://{domain}:${httpsPort}{path}`,
status: 301
}
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect(`https://{domain}:${httpsPort}{path}`, 301)
};
// Create the route config
@ -266,60 +263,6 @@ export function createLoadBalancerRoute(
};
}
/**
* 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
@ -810,4 +753,278 @@ export function createCompleteNfTablesHttpsServer(
);
return [httpsRoute, httpRedirectRoute];
}
}
/**
* Create a socket handler route configuration
* @param domains Domain(s) to match
* @param ports Port(s) to listen on
* @param handler Socket handler function
* @param options Additional route options
* @returns Route configuration object
*/
export function createSocketHandlerRoute(
domains: string | string[],
ports: TPortRange,
handler: (socket: plugins.net.Socket) => void | Promise<void>,
options: {
name?: string;
priority?: number;
path?: string;
} = {}
): IRouteConfig {
return {
name: options.name || 'socket-handler-route',
priority: options.priority !== undefined ? options.priority : 50,
match: {
domains,
ports,
...(options.path && { path: options.path })
},
action: {
type: 'socket-handler',
socketHandler: handler
}
};
}
/**
* Pre-built socket handlers for common use cases
*/
export const SocketHandlers = {
/**
* Simple echo server handler
*/
echo: (socket: plugins.net.Socket, context: IRouteContext) => {
socket.write('ECHO SERVER READY\n');
socket.on('data', data => socket.write(data));
},
/**
* TCP proxy handler
*/
proxy: (targetHost: string, targetPort: number) => (socket: plugins.net.Socket, context: IRouteContext) => {
const target = plugins.net.connect(targetPort, targetHost);
socket.pipe(target);
target.pipe(socket);
socket.on('close', () => target.destroy());
target.on('close', () => socket.destroy());
target.on('error', (err) => {
console.error('Proxy target error:', err);
socket.destroy();
});
},
/**
* Line-based protocol handler
*/
lineProtocol: (handler: (line: string, socket: plugins.net.Socket) => void) => (socket: plugins.net.Socket, context: IRouteContext) => {
let buffer = '';
socket.on('data', (data) => {
buffer += data.toString();
const lines = buffer.split('\n');
buffer = lines.pop() || '';
lines.forEach(line => {
if (line.trim()) {
handler(line.trim(), socket);
}
});
});
},
/**
* Simple HTTP response handler (for testing)
*/
httpResponse: (statusCode: number, body: string) => (socket: plugins.net.Socket, context: IRouteContext) => {
const response = [
`HTTP/1.1 ${statusCode} ${statusCode === 200 ? 'OK' : 'Error'}`,
'Content-Type: text/plain',
`Content-Length: ${body.length}`,
'Connection: close',
'',
body
].join('\r\n');
socket.write(response);
socket.end();
},
/**
* Block connection immediately
*/
block: (message?: string) => (socket: plugins.net.Socket, context: IRouteContext) => {
const finalMessage = message || `Connection blocked from ${context.clientIp}`;
if (finalMessage) {
socket.write(finalMessage);
}
socket.end();
},
/**
* HTTP block response
*/
httpBlock: (statusCode: number = 403, message?: string) => (socket: plugins.net.Socket, context: IRouteContext) => {
const defaultMessage = `Access forbidden for ${context.domain || context.clientIp}`;
const finalMessage = message || defaultMessage;
const response = [
`HTTP/1.1 ${statusCode} ${finalMessage}`,
'Content-Type: text/plain',
`Content-Length: ${finalMessage.length}`,
'Connection: close',
'',
finalMessage
].join('\r\n');
socket.write(response);
socket.end();
},
/**
* HTTP redirect handler
*/
httpRedirect: (locationTemplate: string, statusCode: number = 301) => (socket: plugins.net.Socket, context: IRouteContext) => {
let buffer = '';
socket.once('data', (data) => {
buffer += data.toString();
const lines = buffer.split('\r\n');
const requestLine = lines[0];
const [method, path] = requestLine.split(' ');
const domain = context.domain || 'localhost';
const port = context.port;
let finalLocation = locationTemplate
.replace('{domain}', domain)
.replace('{port}', String(port))
.replace('{path}', path)
.replace('{clientIp}', context.clientIp);
const message = `Redirecting to ${finalLocation}`;
const response = [
`HTTP/1.1 ${statusCode} ${statusCode === 301 ? 'Moved Permanently' : 'Found'}`,
`Location: ${finalLocation}`,
'Content-Type: text/plain',
`Content-Length: ${message.length}`,
'Connection: close',
'',
message
].join('\r\n');
socket.write(response);
socket.end();
});
},
/**
* HTTP server handler for ACME challenges and other HTTP needs
*/
httpServer: (handler: (req: { method: string; url: string; headers: Record<string, string>; body?: string }, res: { status: (code: number) => void; header: (name: string, value: string) => void; send: (data: string) => void; end: () => void }) => void) => (socket: plugins.net.Socket, context: IRouteContext) => {
let buffer = '';
let requestParsed = false;
socket.on('data', (data) => {
if (requestParsed) return; // Only handle the first request
buffer += data.toString();
// Check if we have a complete HTTP request
const headerEndIndex = buffer.indexOf('\r\n\r\n');
if (headerEndIndex === -1) return; // Need more data
requestParsed = true;
// Parse the HTTP request
const headerPart = buffer.substring(0, headerEndIndex);
const bodyPart = buffer.substring(headerEndIndex + 4);
const lines = headerPart.split('\r\n');
const [method, url] = lines[0].split(' ');
const headers: Record<string, string> = {};
for (let i = 1; i < lines.length; i++) {
const colonIndex = lines[i].indexOf(':');
if (colonIndex > 0) {
const name = lines[i].substring(0, colonIndex).trim().toLowerCase();
const value = lines[i].substring(colonIndex + 1).trim();
headers[name] = value;
}
}
// Create request object
const req = {
method: method || 'GET',
url: url || '/',
headers,
body: bodyPart
};
// Create response object
let statusCode = 200;
const responseHeaders: Record<string, string> = {};
let ended = false;
const res = {
status: (code: number) => {
statusCode = code;
},
header: (name: string, value: string) => {
responseHeaders[name] = value;
},
send: (data: string) => {
if (ended) return;
ended = true;
if (!responseHeaders['content-type']) {
responseHeaders['content-type'] = 'text/plain';
}
responseHeaders['content-length'] = String(data.length);
responseHeaders['connection'] = 'close';
const statusText = statusCode === 200 ? 'OK' :
statusCode === 404 ? 'Not Found' :
statusCode === 500 ? 'Internal Server Error' : 'Response';
let response = `HTTP/1.1 ${statusCode} ${statusText}\r\n`;
for (const [name, value] of Object.entries(responseHeaders)) {
response += `${name}: ${value}\r\n`;
}
response += '\r\n';
response += data;
socket.write(response);
socket.end();
},
end: () => {
if (ended) return;
ended = true;
socket.write('HTTP/1.1 200 OK\r\nContent-Length: 0\r\nConnection: close\r\n\r\n');
socket.end();
}
};
try {
handler(req, res);
// Ensure response is sent even if handler doesn't call send()
setTimeout(() => {
if (!ended) {
res.send('');
}
}, 1000);
} catch (error) {
if (!ended) {
res.status(500);
res.send('Internal Server Error');
}
}
});
socket.on('error', () => {
if (!requestParsed) {
socket.end();
}
});
}
};

View File

@ -7,6 +7,7 @@
import type { IRouteConfig, IRouteMatch, IRouteAction, IRouteTarget } from '../models/route-types.js';
import { mergeRouteConfigs } from './route-utils.js';
import { SocketHandlers } from './route-helpers.js';
/**
* Create a basic HTTP route configuration
@ -112,11 +113,11 @@ export function createHttpToHttpsRedirect(
ports: 80
},
action: {
type: 'redirect',
redirect: {
to: options.preservePath ? 'https://{domain}{path}' : 'https://{domain}',
status: options.redirectCode || 301
}
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect(
options.preservePath ? 'https://{domain}{path}' : 'https://{domain}',
options.redirectCode || 301
)
},
name: options.name || `HTTP to HTTPS redirect: ${Array.isArray(domains) ? domains.join(', ') : domains}`
};
@ -214,57 +215,6 @@ export function createApiGatewayRoute(
return mergeRouteConfigs(baseRoute, apiRoute);
}
/**
* Create a static file server route pattern
* @param domains Domain(s) to match
* @param rootDirectory Root directory for static files
* @param options Additional route options
* @returns Static file server route configuration
*/
export function createStaticFileServerRoute(
domains: string | string[],
rootDirectory: string,
options: {
useTls?: boolean;
certificate?: 'auto' | { key: string; cert: string };
indexFiles?: string[];
cacheControl?: string;
path?: string;
[key: string]: any;
} = {}
): IRouteConfig {
// Create base route with static action
const baseRoute: IRouteConfig = {
match: {
domains,
ports: options.useTls ? 443 : 80,
path: options.path || '/'
},
action: {
type: 'static',
static: {
root: rootDirectory,
index: options.indexFiles || ['index.html', 'index.htm'],
headers: {
'Cache-Control': options.cacheControl || 'public, max-age=3600'
}
}
},
name: options.name || `Static Server: ${Array.isArray(domains) ? domains.join(', ') : domains}`,
priority: options.priority || 50
};
// Add TLS configuration if requested
if (options.useTls) {
baseRoute.action.tls = {
mode: 'terminate',
certificate: options.certificate || 'auto'
};
}
return baseRoute;
}
/**
* Create a WebSocket route pattern
* @param domains Domain(s) to match

View File

@ -53,7 +53,15 @@ export function mergeRouteConfigs(
if (overrideRoute.action) {
// If action types are different, replace the entire action
if (overrideRoute.action.type && overrideRoute.action.type !== mergedRoute.action.type) {
mergedRoute.action = JSON.parse(JSON.stringify(overrideRoute.action));
// Handle socket handler specially since it's a function
if (overrideRoute.action.type === 'socket-handler' && overrideRoute.action.socketHandler) {
mergedRoute.action = {
type: 'socket-handler',
socketHandler: overrideRoute.action.socketHandler
};
} else {
mergedRoute.action = JSON.parse(JSON.stringify(overrideRoute.action));
}
} else {
// Otherwise merge the action properties
mergedRoute.action = { ...mergedRoute.action };
@ -74,20 +82,9 @@ export function mergeRouteConfigs(
};
}
// Merge redirect options
if (overrideRoute.action.redirect) {
mergedRoute.action.redirect = {
...mergedRoute.action.redirect,
...overrideRoute.action.redirect
};
}
// Merge static options
if (overrideRoute.action.static) {
mergedRoute.action.static = {
...mergedRoute.action.static,
...overrideRoute.action.static
};
// Handle socket handler update
if (overrideRoute.action.socketHandler) {
mergedRoute.action.socketHandler = overrideRoute.action.socketHandler;
}
}
}

View File

@ -98,7 +98,7 @@ export function validateRouteAction(action: IRouteAction): { valid: boolean; err
// Validate action type
if (!action.type) {
errors.push('Action type is required');
} else if (!['forward', 'redirect', 'static', 'block'].includes(action.type)) {
} else if (!['forward', 'socket-handler'].includes(action.type)) {
errors.push(`Invalid action type: ${action.type}`);
}
@ -143,30 +143,12 @@ export function validateRouteAction(action: IRouteAction): { valid: boolean; err
}
}
// Validate redirect for 'redirect' action
if (action.type === 'redirect') {
if (!action.redirect) {
errors.push('Redirect configuration is required for redirect action');
} else {
if (!action.redirect.to) {
errors.push('Redirect target (to) is required');
}
if (action.redirect.status &&
![301, 302, 303, 307, 308].includes(action.redirect.status)) {
errors.push('Invalid redirect status code');
}
}
}
// Validate static file config for 'static' action
if (action.type === 'static') {
if (!action.static) {
errors.push('Static file configuration is required for static action');
} else {
if (!action.static.root) {
errors.push('Static file root directory is required');
}
// Validate socket handler for 'socket-handler' action
if (action.type === 'socket-handler') {
if (!action.socketHandler) {
errors.push('Socket handler function is required for socket-handler action');
} else if (typeof action.socketHandler !== 'function') {
errors.push('Socket handler must be a function');
}
}
@ -261,12 +243,8 @@ export function hasRequiredPropertiesForAction(route: IRouteConfig, actionType:
switch (actionType) {
case 'forward':
return !!route.action.target && !!route.action.target.host && !!route.action.target.port;
case 'redirect':
return !!route.action.redirect && !!route.action.redirect.to;
case 'static':
return !!route.action.static && !!route.action.static.root;
case 'block':
return true; // Block action doesn't require additional properties
case 'socket-handler':
return !!route.action.socketHandler && typeof route.action.socketHandler === 'function';
default:
return false;
}