Compare commits

...

36 Commits

Author SHA1 Message Date
jkunz 30e5ab308f v27.7.3
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-14 01:14:33 +00:00
jkunz d2a54b3491 fix(repo): no changes detected 2026-04-14 01:14:33 +00:00
jkunz dc922c97df v27.7.2
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-14 00:55:25 +00:00
jkunz 8d1bae7604 fix(docs): clarify metrics documentation for domain normalization and saturating gauges 2026-04-14 00:55:25 +00:00
jkunz 200e86e311 v27.7.1
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-14 00:54:12 +00:00
jkunz a53a2c4ca5 fix(rustproxy-http,rustproxy-metrics): fix domain-scoped request host detection and harden connection metrics cleanup 2026-04-14 00:54:12 +00:00
jkunz 6ee7237357 v27.7.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-13 23:21:54 +00:00
jkunz b5b4c608f0 feat(smart-proxy): add typed Rust config serialization and regex header contract coverage 2026-04-13 23:21:54 +00:00
jkunz af132f40fc v27.6.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-13 18:33:28 +00:00
jkunz 781634446a feat(metrics): track per-IP domain request metrics across HTTP and TCP passthrough traffic 2026-04-13 18:33:28 +00:00
jkunz e988d935b6 v27.5.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-06 12:46:09 +00:00
jkunz 99a026627d feat(security): add domain-scoped IP allow list support across HTTP and passthrough filtering 2026-04-06 12:46:09 +00:00
jkunz 572e31587a v27.4.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-04 19:25:06 +00:00
jkunz 8587fb997c feat(rustproxy): add HTTP/3 proxy service wiring for QUIC listeners 2026-04-04 19:25:06 +00:00
jkunz 9ba101c59b v27.3.1
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-04 18:54:05 +00:00
jkunz 1ad3e61c15 fix(metrics): correct frontend and backend protocol connection tracking across h1, h2, h3, and websocket traffic 2026-04-04 18:54:05 +00:00
jkunz 3bfa451341 v27.3.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-04 17:59:04 +00:00
jkunz 7b3ab7378b feat(test): add end-to-end WebSocket proxy test coverage 2026-04-04 17:59:04 +00:00
jkunz 527c616cd4 v27.2.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-04-04 16:52:25 +00:00
jkunz b04eb0ab17 feat(metrics): add frontend and backend protocol distribution metrics 2026-04-04 16:52:25 +00:00
jkunz a55ff20391 v27.1.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-27 22:34:13 +00:00
jkunz 3c24bf659b feat(rustproxy-passthrough): add selective connection recycling for route, security, and certificate updates 2026-03-27 22:34:13 +00:00
jkunz 5be93c8d38 v27.0.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-26 20:45:41 +00:00
jkunz 788ccea81e BREAKING CHANGE(smart-proxy): remove route helper APIs and standardize route configuration on plain route objects 2026-03-26 20:45:41 +00:00
jkunz 47140e5403 v26.3.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-26 13:11:57 +00:00
jkunz a6ffa24e36 feat(nftables): move NFTables forwarding management from the Rust engine to @push.rocks/smartnftables 2026-03-26 13:11:57 +00:00
jkunz c0e432fd9b v26.2.4
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-26 07:05:57 +00:00
jkunz a3d8a3a388 fix(rustproxy-http): improve HTTP/3 connection reuse and clean up stale proxy state 2026-03-26 07:05:57 +00:00
jkunz 437d1a3329 v26.2.3
Default (tags) / security (push) Failing after 3s
Default (tags) / test (push) Failing after 3s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-25 07:26:47 +00:00
jkunz 746d93663d fix(repo): no changes to commit 2026-03-25 07:26:47 +00:00
jkunz a3f3fee253 v26.2.2
Default (tags) / security (push) Failing after 4s
Default (tags) / test (push) Failing after 5s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-25 07:22:17 +00:00
jkunz 53dee1fffc fix(proxy): improve connection cleanup and route validation handling 2026-03-25 07:22:17 +00:00
jkunz 34dc0cb9b6 v26.2.1
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-23 11:11:55 +00:00
jkunz c83c43194b fix(rustproxy-http): include the upstream request URL when caching H3 Alt-Svc discoveries 2026-03-23 11:11:55 +00:00
jkunz d026d7c266 v26.2.0
Default (tags) / security (push) Failing after 0s
Default (tags) / test (push) Failing after 0s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-03-23 09:42:07 +00:00
jkunz 3b01144c51 feat(protocol-cache): add sliding TTL re-probing and eviction for backend protocol detection 2026-03-23 09:42:07 +00:00
85 changed files with 7277 additions and 5092 deletions
View File
+126
View File
@@ -1,5 +1,131 @@
# Changelog # Changelog
## 2026-04-14 - 27.7.3 - fix(repo)
no changes detected
## 2026-04-14 - 27.7.2 - fix(docs)
clarify metrics documentation for domain normalization and saturating gauges
- Document that per-IP domain keys are normalized to lowercase and have trailing dots stripped before counting.
- Clarify that the saturating close pattern also applies to connection and UDP active gauges.
## 2026-04-14 - 27.7.1 - fix(rustproxy-http,rustproxy-metrics)
fix domain-scoped request host detection and harden connection metrics cleanup
- use a shared request host extractor that falls back to URI authority so domain-scoped IP allow lists work for HTTP/2 and HTTP/3 requests without a Host header
- add request filter and host extraction tests covering domain-scoped ACL behavior
- prevent connection counters from underflowing during close handling and clean up per-IP metrics entries more safely
- normalize tracked domain keys in metrics to reduce duplicate entries caused by case or trailing-dot variations
## 2026-04-13 - 27.7.0 - feat(smart-proxy)
add typed Rust config serialization and regex header contract coverage
- serialize SmartProxy routes and top-level options into explicit Rust-safe types, including header regex literals, UDP field normalization, ACME, defaults, and proxy settings
- support JS-style regex header literals with flags in Rust header matching and add cross-contract tests for route preprocessing and config deserialization
- improve TypeScript safety for Rust bridge and metrics integration by replacing loose any-based payloads with dedicated Rust type definitions
## 2026-04-13 - 27.6.0 - feat(metrics)
track per-IP domain request metrics across HTTP and TCP passthrough traffic
- records domain request counts per frontend IP from HTTP Host headers and TCP SNI
- exposes per-IP domain maps and top IP-domain request pairs through the TypeScript metrics adapter
- bounds per-IP domain tracking and prunes stale entries to limit memory growth
- adds metrics system documentation covering architecture, collected data, and known gaps
## 2026-04-06 - 27.5.0 - feat(security)
add domain-scoped IP allow list support across HTTP and passthrough filtering
- extend route security types to accept IP allow entries scoped to specific domains
- apply domain-aware IP checks using Host headers for HTTP and SNI context for QUIC and passthrough connections
- preserve compatibility for existing plain allow list entries and add validation and tests for scoped matching
## 2026-04-04 - 27.4.0 - feat(rustproxy)
add HTTP/3 proxy service wiring for QUIC listeners
- registers H3ProxyService with the UDP listener manager so QUIC connections can serve HTTP/3
- keeps proxy IP configuration intact while enabling HTTP/3 handling during listener setup
## 2026-04-04 - 27.3.1 - fix(metrics)
correct frontend and backend protocol connection tracking across h1, h2, h3, and websocket traffic
- move frontend protocol accounting from per-request to connection lifetime tracking for HTTP/1, HTTP/2, and HTTP/3
- add backend protocol guards to connection drivers so active protocol metrics reflect live upstream connections
- prevent protocol counter underflow by using atomic saturating decrements in the metrics collector
- read backend protocol distribution directly from cached aggregate counters in the Rust metrics adapter
## 2026-04-04 - 27.3.0 - feat(test)
add end-to-end WebSocket proxy test coverage
- add comprehensive WebSocket e2e tests for upgrade handling, bidirectional messaging, header forwarding, close propagation, and large payloads
- add ws and @types/ws as development dependencies to support the new test suite
## 2026-04-04 - 27.2.0 - feat(metrics)
add frontend and backend protocol distribution metrics
- track active and total frontend protocol counts for h1, h2, h3, websocket, and other traffic
- add backend protocol counters with RAII guards to ensure metrics are decremented on all exit paths
- expose protocol distribution through the TypeScript metrics interfaces and Rust metrics adapter
## 2026-03-27 - 27.1.0 - feat(rustproxy-passthrough)
add selective connection recycling for route, security, and certificate updates
- introduce a shared connection registry to track active TCP and QUIC connections by route, source IP, and domain
- recycle only affected connections when route actions or security rules change instead of broadly invalidating traffic
- gracefully recycle existing connections when TLS certificates change for a domain
- apply route-level IP security checks to QUIC connections and share route cancellation state with UDP listeners
## 2026-03-26 - 27.0.0 - BREAKING CHANGE(smart-proxy)
remove route helper APIs and standardize route configuration on plain route objects
- Removes TypeScript route helper exports and related Rust config helpers in favor of defining routes directly with match and action properties.
- Updates documentation and tests to use plain IRouteConfig objects and SocketHandlers imports instead of helper factory functions.
- Moves socket handlers to a top-level utils export and keeps direct socket-handler route configuration as the supported pattern.
## 2026-03-26 - 26.3.0 - feat(nftables)
move NFTables forwarding management from the Rust engine to @push.rocks/smartnftables
- add @push.rocks/smartnftables as a runtime dependency and export it via the plugin layer
- remove the internal rustproxy-nftables crate along with Rust-side NFTables rule application and status management
- apply and clean up NFTables port-forwarding rules in the TypeScript SmartProxy lifecycle and route update flow
- change getNfTablesStatus to return local smartnftables status instead of querying the Rust bridge
- update README documentation to describe NFTables support as provided through @push.rocks/smartnftables
## 2026-03-26 - 26.2.4 - fix(rustproxy-http)
improve HTTP/3 connection reuse and clean up stale proxy state
- Reuse pooled HTTP/3 SendRequest handles to skip repeated SETTINGS handshakes and reduce request overhead on QUIC pool hits
- Add periodic cleanup for per-route rate limiters and orphaned backend metrics to prevent unbounded memory growth after traffic or backend errors stop
- Enforce HTTP max connection lifetime alongside idle timeouts and apply configured lifetime values from the TCP listener
- Reduce HTTP/3 body copying by using owned Bytes paths for request and response streaming, and replace the custom response body adapter with a stream-based implementation
- Harden auxiliary proxy components by capping datagram handler buffer growth and removing duplicate RustProxy exit listeners
## 2026-03-25 - 26.2.3 - fix(repo)
no changes to commit
## 2026-03-25 - 26.2.2 - fix(proxy)
improve connection cleanup and route validation handling
- add timeouts for HTTP/1 upstream connection drivers to prevent lingering tasks
- ensure QUIC relay sessions cancel and abort background tasks on drop
- avoid registering unnamed routes as duplicates and label unnamed catch-all conflicts clearly
- fix offset mapping route helper to forward only remaining route options without overriding derived values
- update project config filename and toolchain versions for the current build setup
## 2026-03-23 - 26.2.1 - fix(rustproxy-http)
include the upstream request URL when caching H3 Alt-Svc discoveries
- Tracks the request path that triggered Alt-Svc discovery in connection activity state
- Adds request URL context to Alt-Svc debug logging and protocol cache insertion reasons for better traceability
## 2026-03-23 - 26.2.0 - feat(protocol-cache)
add sliding TTL re-probing and eviction for backend protocol detection
- extend protocol cache entries and metrics with last accessed and last probed timestamps
- trigger periodic ALPN re-probes for cached H1/H2 entries while keeping active entries alive with a sliding 1 day TTL
- log protocol transitions with reasons and evict cache entries when all protocol fallback attempts fail
## 2026-03-22 - 26.1.0 - feat(rustproxy-http) ## 2026-03-22 - 26.1.0 - feat(rustproxy-http)
add protocol failure suppression, h3 fallback escalation, and protocol cache metrics exposure add protocol failure suppression, h3 fallback escalation, and protocol cache metrics exposure
Generated
+404 -384
View File
File diff suppressed because it is too large Load Diff
+1 -1
View File
@@ -1,4 +1,4 @@
Copyright (c) 2019 Lossless GmbH (hello@lossless.com) Copyright (c) 2019 Task Venture Capital GmbH (hello@task.vc)
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
+12 -9
View File
@@ -1,6 +1,6 @@
{ {
"name": "@push.rocks/smartproxy", "name": "@push.rocks/smartproxy",
"version": "26.1.0", "version": "27.7.3",
"private": false, "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.", "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", "main": "dist_ts/index.js",
@@ -16,18 +16,21 @@
"buildDocs": "tsdoc" "buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^4.3.0", "@git.zone/tsbuild": "^4.4.0",
"@git.zone/tsrun": "^2.0.1", "@git.zone/tsrun": "^2.0.2",
"@git.zone/tsrust": "^1.3.0", "@git.zone/tsrust": "^1.3.2",
"@git.zone/tstest": "^3.5.0", "@git.zone/tstest": "^3.6.0",
"@push.rocks/smartserve": "^2.0.1", "@push.rocks/smartserve": "^2.0.3",
"@types/node": "^25.5.0", "@types/node": "^25.5.0",
"typescript": "^5.9.3", "@types/ws": "^8.18.1",
"why-is-node-running": "^3.2.2" "typescript": "^6.0.2",
"why-is-node-running": "^3.2.2",
"ws": "^8.20.0"
}, },
"dependencies": { "dependencies": {
"@push.rocks/smartcrypto": "^2.0.4", "@push.rocks/smartcrypto": "^2.0.4",
"@push.rocks/smartlog": "^3.2.1", "@push.rocks/smartlog": "^3.2.1",
"@push.rocks/smartnftables": "^1.0.1",
"@push.rocks/smartrust": "^1.3.2", "@push.rocks/smartrust": "^1.3.2",
"@tsclass/tsclass": "^9.5.0", "@tsclass/tsclass": "^9.5.0",
"minimatch": "^10.2.4" "minimatch": "^10.2.4"
@@ -41,7 +44,7 @@
"dist_ts_web/**/*", "dist_ts_web/**/*",
"assets/**/*", "assets/**/*",
"cli.js", "cli.js",
"npmextra.json", ".smartconfig.json",
"readme.md", "readme.md",
"changelog.md" "changelog.md"
], ],
+286 -220
View File
File diff suppressed because it is too large Load Diff
+42 -20
View File
@@ -462,35 +462,57 @@ For TLS termination modes (`terminate` and `terminate-and-reencrypt`), SmartProx
**HTTP to HTTPS Redirect**: **HTTP to HTTPS Redirect**:
```typescript ```typescript
import { createHttpToHttpsRedirect } from '@push.rocks/smartproxy'; import { SocketHandlers } from '@push.rocks/smartproxy';
const redirectRoute = createHttpToHttpsRedirect(['example.com', 'www.example.com']); const redirectRoute = {
name: 'http-to-https',
match: { ports: 80, domains: ['example.com', 'www.example.com'] },
action: {
type: 'socket-handler' as const,
socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
}
};
``` ```
**Complete HTTPS Server (with redirect)**: **Complete HTTPS Server (with redirect)**:
```typescript ```typescript
import { createCompleteHttpsServer } from '@push.rocks/smartproxy'; const routes = [
{
const routes = createCompleteHttpsServer( name: 'https-server',
'example.com', match: { ports: 443, domains: 'example.com' },
{ host: 'localhost', port: 8080 }, action: {
{ certificate: 'auto' } type: 'forward' as const,
); targets: [{ host: 'localhost', port: 8080 }],
tls: { mode: 'terminate' as const, certificate: 'auto' as const }
}
},
{
name: 'http-redirect',
match: { ports: 80, domains: 'example.com' },
action: {
type: 'socket-handler' as const,
socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
}
}
];
``` ```
**Load Balancer with Health Checks**: **Load Balancer with Health Checks**:
```typescript ```typescript
import { createLoadBalancerRoute } from '@push.rocks/smartproxy'; const lbRoute = {
name: 'load-balancer',
const lbRoute = createLoadBalancerRoute( match: { ports: 443, domains: 'api.example.com' },
'api.example.com', action: {
[ type: 'forward' as const,
{ host: 'backend1', port: 8080 }, targets: [
{ host: 'backend2', port: 8080 }, { host: 'backend1', port: 8080 },
{ host: 'backend3', port: 8080 } { host: 'backend2', port: 8080 },
], { host: 'backend3', port: 8080 }
{ tls: { mode: 'terminate', certificate: 'auto' } } ],
); tls: { mode: 'terminate' as const, certificate: 'auto' as const },
loadBalancing: { algorithm: 'round-robin' as const }
}
};
``` ```
### Smart SNI Requirement (v22.3+) ### Smart SNI Requirement (v22.3+)
+163 -161
View File
@@ -1,6 +1,6 @@
# @push.rocks/smartproxy 🚀 # @push.rocks/smartproxy 🚀
**A high-performance, Rust-powered proxy toolkit for Node.js** — unified route-based configuration for SSL/TLS termination, HTTP/HTTPS reverse proxying, WebSocket support, UDP/QUIC/HTTP3, load balancing, custom protocol handlers, and kernel-level NFTables forwarding. **A high-performance, Rust-powered proxy toolkit for Node.js** — unified route-based configuration for SSL/TLS termination, HTTP/HTTPS reverse proxying, WebSocket support, UDP/QUIC/HTTP3, load balancing, custom protocol handlers, and kernel-level NFTables forwarding via [`@push.rocks/smartnftables`](https://code.foss.global/push.rocks/smartnftables).
## 📦 Installation ## 📦 Installation
@@ -44,7 +44,7 @@ Whether you're building microservices, deploying edge infrastructure, proxying U
Get up and running in 30 seconds: Get up and running in 30 seconds:
```typescript ```typescript
import { SmartProxy, createCompleteHttpsServer } from '@push.rocks/smartproxy'; import { SmartProxy, SocketHandlers } from '@push.rocks/smartproxy';
// Create a proxy with automatic HTTPS // Create a proxy with automatic HTTPS
const proxy = new SmartProxy({ const proxy = new SmartProxy({
@@ -53,13 +53,25 @@ const proxy = new SmartProxy({
useProduction: true useProduction: true
}, },
routes: [ routes: [
// Complete HTTPS setup in one call! ✨ // HTTPS route with automatic Let's Encrypt cert
...createCompleteHttpsServer('app.example.com', { {
host: 'localhost', name: 'https-app',
port: 3000 match: { ports: 443, domains: 'app.example.com' },
}, { action: {
certificate: 'auto' // Automatic Let's Encrypt cert 🎩 type: 'forward',
}) targets: [{ host: 'localhost', port: 3000 }],
tls: { mode: 'terminate', certificate: 'auto' }
}
},
// HTTP → HTTPS redirect
{
name: 'http-redirect',
match: { ports: 80, domains: 'app.example.com' },
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
}
}
] ]
}); });
@@ -111,31 +123,38 @@ SmartProxy supports three TLS handling modes:
### 🌐 HTTP to HTTPS Redirect ### 🌐 HTTP to HTTPS Redirect
```typescript ```typescript
import { SmartProxy, createHttpToHttpsRedirect } from '@push.rocks/smartproxy'; import { SmartProxy, SocketHandlers } from '@push.rocks/smartproxy';
const proxy = new SmartProxy({ const proxy = new SmartProxy({
routes: [ routes: [{
createHttpToHttpsRedirect(['example.com', '*.example.com']) name: 'http-to-https',
] match: { ports: 80, domains: ['example.com', '*.example.com'] },
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
}
}]
}); });
``` ```
### ⚖️ Load Balancer with Health Checks ### ⚖️ Load Balancer with Health Checks
```typescript ```typescript
import { SmartProxy, createLoadBalancerRoute } from '@push.rocks/smartproxy'; import { SmartProxy } from '@push.rocks/smartproxy';
const proxy = new SmartProxy({ const proxy = new SmartProxy({
routes: [ routes: [{
createLoadBalancerRoute( name: 'load-balancer',
'app.example.com', match: { ports: 443, domains: 'app.example.com' },
[ action: {
type: 'forward',
targets: [
{ host: 'server1.internal', port: 8080 }, { host: 'server1.internal', port: 8080 },
{ host: 'server2.internal', port: 8080 }, { host: 'server2.internal', port: 8080 },
{ host: 'server3.internal', port: 8080 } { host: 'server3.internal', port: 8080 }
], ],
{ tls: { mode: 'terminate', certificate: 'auto' },
tls: { mode: 'terminate', certificate: 'auto' }, loadBalancing: {
algorithm: 'round-robin', algorithm: 'round-robin',
healthCheck: { healthCheck: {
path: '/health', path: '/health',
@@ -145,57 +164,68 @@ const proxy = new SmartProxy({
healthyThreshold: 2 healthyThreshold: 2
} }
} }
) }
] }]
}); });
``` ```
### 🔌 WebSocket Proxy ### 🔌 WebSocket Proxy
```typescript ```typescript
import { SmartProxy, createWebSocketRoute } from '@push.rocks/smartproxy'; import { SmartProxy } from '@push.rocks/smartproxy';
const proxy = new SmartProxy({ const proxy = new SmartProxy({
routes: [ routes: [{
createWebSocketRoute( name: 'websocket',
'ws.example.com', match: { ports: 443, domains: 'ws.example.com', path: '/socket' },
{ host: 'websocket-server', port: 8080 }, priority: 100,
{ action: {
path: '/socket', type: 'forward',
useTls: true, targets: [{ host: 'websocket-server', port: 8080 }],
certificate: 'auto', tls: { mode: 'terminate', certificate: 'auto' },
websocket: {
enabled: true,
pingInterval: 30000, pingInterval: 30000,
pingTimeout: 10000 pingTimeout: 10000
} }
) }
] }]
}); });
``` ```
### 🚦 API Gateway with Rate Limiting ### 🚦 API Gateway with Rate Limiting
```typescript ```typescript
import { SmartProxy, createApiGatewayRoute, addRateLimiting } from '@push.rocks/smartproxy'; import { SmartProxy } from '@push.rocks/smartproxy';
let apiRoute = createApiGatewayRoute( const proxy = new SmartProxy({
'api.example.com', routes: [{
'/api', name: 'api-gateway',
{ host: 'api-backend', port: 8080 }, match: { ports: 443, domains: 'api.example.com', path: '/api/*' },
{ priority: 100,
useTls: true, action: {
certificate: 'auto', type: 'forward',
addCorsHeaders: true targets: [{ host: 'api-backend', port: 8080 }],
} tls: { mode: 'terminate', certificate: 'auto' }
); },
headers: {
// Add rate limiting — 100 requests per minute per IP response: {
apiRoute = addRateLimiting(apiRoute, { 'Access-Control-Allow-Origin': '*',
maxRequests: 100, 'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
window: 60, 'Access-Control-Allow-Headers': 'Content-Type, Authorization',
keyBy: 'ip' 'Access-Control-Max-Age': '86400'
}
},
security: {
rateLimit: {
enabled: true,
maxRequests: 100,
window: 60,
keyBy: 'ip'
}
}
}]
}); });
const proxy = new SmartProxy({ routes: [apiRoute] });
``` ```
### 🎮 Custom Protocol Handler (TCP) ### 🎮 Custom Protocol Handler (TCP)
@@ -203,36 +233,40 @@ const proxy = new SmartProxy({ routes: [apiRoute] });
SmartProxy lets you implement any protocol with full socket control. Routes with JavaScript socket handlers are automatically relayed from the Rust engine back to your TypeScript code: SmartProxy lets you implement any protocol with full socket control. Routes with JavaScript socket handlers are automatically relayed from the Rust engine back to your TypeScript code:
```typescript ```typescript
import { SmartProxy, createSocketHandlerRoute, SocketHandlers } from '@push.rocks/smartproxy'; import { SmartProxy, SocketHandlers } from '@push.rocks/smartproxy';
// Use pre-built handlers const proxy = new SmartProxy({
const echoRoute = createSocketHandlerRoute( routes: [
'echo.example.com', // Use pre-built handlers
7777, {
SocketHandlers.echo name: 'echo-server',
); match: { ports: 7777, domains: 'echo.example.com' },
action: { type: 'socket-handler', socketHandler: SocketHandlers.echo }
},
// Or create your own custom protocol
{
name: 'custom-protocol',
match: { ports: 9999, domains: 'custom.example.com' },
action: {
type: 'socket-handler',
socketHandler: async (socket) => {
console.log(`New connection on custom protocol`);
socket.write('Welcome to my custom protocol!\n');
// Or create your own custom protocol socket.on('data', (data) => {
const customRoute = createSocketHandlerRoute( const command = data.toString().trim();
'custom.example.com', switch (command) {
9999, case 'PING': socket.write('PONG\n'); break;
async (socket) => { case 'TIME': socket.write(`${new Date().toISOString()}\n`); break;
console.log(`New connection on custom protocol`); case 'QUIT': socket.end('Goodbye!\n'); break;
socket.write('Welcome to my custom protocol!\n'); default: socket.write(`Unknown: ${command}\n`);
}
socket.on('data', (data) => { });
const command = data.toString().trim(); }
switch (command) {
case 'PING': socket.write('PONG\n'); break;
case 'TIME': socket.write(`${new Date().toISOString()}\n`); break;
case 'QUIT': socket.end('Goodbye!\n'); break;
default: socket.write(`Unknown: ${command}\n`);
} }
}); }
} ]
); });
const proxy = new SmartProxy({ routes: [echoRoute, customRoute] });
``` ```
**Pre-built Socket Handlers:** **Pre-built Socket Handlers:**
@@ -384,23 +418,26 @@ const dualStackRoute: IRouteConfig = {
### ⚡ High-Performance NFTables Forwarding ### ⚡ High-Performance NFTables Forwarding
For ultra-low latency on Linux, use kernel-level forwarding (requires root): For ultra-low latency on Linux, use kernel-level forwarding via [`@push.rocks/smartnftables`](https://code.foss.global/push.rocks/smartnftables) (requires root):
```typescript ```typescript
import { SmartProxy, createNfTablesTerminateRoute } from '@push.rocks/smartproxy'; import { SmartProxy } from '@push.rocks/smartproxy';
const proxy = new SmartProxy({ const proxy = new SmartProxy({
routes: [ routes: [{
createNfTablesTerminateRoute( name: 'nftables-fast',
'fast.example.com', match: { ports: 443, domains: 'fast.example.com' },
{ host: 'backend', port: 8080 }, action: {
{ type: 'forward',
ports: 443, forwardingEngine: 'nftables',
certificate: 'auto', targets: [{ host: 'backend', port: 8080 }],
tls: { mode: 'terminate', certificate: 'auto' },
nftables: {
protocol: 'tcp',
preserveSourceIP: true // Backend sees real client IP preserveSourceIP: true // Backend sees real client IP
} }
) }
] }]
}); });
``` ```
@@ -409,15 +446,18 @@ const proxy = new SmartProxy({
Forward encrypted traffic to backends without terminating TLS — the proxy routes based on the SNI hostname alone: Forward encrypted traffic to backends without terminating TLS — the proxy routes based on the SNI hostname alone:
```typescript ```typescript
import { SmartProxy, createHttpsPassthroughRoute } from '@push.rocks/smartproxy'; import { SmartProxy } from '@push.rocks/smartproxy';
const proxy = new SmartProxy({ const proxy = new SmartProxy({
routes: [ routes: [{
createHttpsPassthroughRoute('secure.example.com', { name: 'sni-passthrough',
host: 'backend-that-handles-tls', match: { ports: 443, domains: 'secure.example.com' },
port: 8443 action: {
}) type: 'forward',
] targets: [{ host: 'backend-that-handles-tls', port: 8443 }],
tls: { mode: 'passthrough' }
}
}]
}); });
``` ```
@@ -524,15 +564,7 @@ Comprehensive per-route security options:
} }
``` ```
**Security modifier helpers** let you add security to any existing route: Security options are configured directly on each route's `security` property — no separate helpers needed.
```typescript
import { addRateLimiting, addBasicAuth, addJwtAuth } from '@push.rocks/smartproxy';
let route = createHttpsTerminateRoute('api.example.com', { host: 'backend', port: 8080 });
route = addRateLimiting(route, { maxRequests: 100, window: 60, keyBy: 'ip' });
route = addBasicAuth(route, { users: [{ username: 'admin', password: 'secret' }] });
```
### 📊 Runtime Management ### 📊 Runtime Management
@@ -694,22 +726,26 @@ SmartProxy uses a hybrid **Rust + TypeScript** architecture:
│ │ Listener│ │ Reverse │ │ Matcher │ │ Cert Mgr │ │ │ │ Listener│ │ Reverse │ │ Matcher │ │ Cert Mgr │ │
│ │ │ │ Proxy │ │ │ │ │ │ │ │ │ │ Proxy │ │ │ │ │ │
│ └─────────┘ └─────────┘ └─────────┘ └──────────┘ │ │ └─────────┘ └─────────┘ └─────────┘ └──────────┘ │
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌──────────┐ │ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ │ UDP │ │ Security│ │ Metrics │ │ NFTables │ │ │ UDP │ │ Security│ │ Metrics │
│ │ QUIC │ │ Enforce │ │ Collect │ Mgr │ │ QUIC │ │ Enforce │ │ Collect │
│ │ HTTP/3 │ │ │ │ │ │ │ HTTP/3 │ │ │ │ │
│ └─────────┘ └─────────┘ └─────────┘ └──────────┘ │ └─────────┘ └─────────┘ └─────────┘
└──────────────────┬──────────────────────────────────┘ └──────────────────┬──────────────────────────────────┘
│ Unix Socket Relay │ Unix Socket Relay
┌──────────────────▼──────────────────────────────────┐ ┌──────────────────▼──────────────────────────────────┐
│ TypeScript Socket & Datagram Handler Servers │ │ TypeScript Socket & Datagram Handler Servers │
│ (for JS socket handlers, datagram handlers, │ │ (for JS socket handlers, datagram handlers, │
│ and dynamic routes) │ │ and dynamic routes) │
├─────────────────────────────────────────────────────┤
│ @push.rocks/smartnftables (kernel-level NFTables) │
│ (DNAT/SNAT, firewall, rate limiting via nft CLI) │
└─────────────────────────────────────────────────────┘ └─────────────────────────────────────────────────────┘
``` ```
- **Rust Engine** handles all networking: TCP, UDP, TLS, QUIC, HTTP proxying, connection management, security, and metrics - **Rust Engine** handles all networking: TCP, UDP, TLS, QUIC, HTTP proxying, connection management, security, and metrics
- **TypeScript** provides the npm API, configuration types, route helpers, validation, and handler callbacks - **TypeScript** provides the npm API, configuration types, validation, and handler callbacks
- **NFTables** managed by [`@push.rocks/smartnftables`](https://code.foss.global/push.rocks/smartnftables) — kernel-level DNAT/SNAT forwarding, firewall rules, and rate limiting via the `nft` CLI
- **IPC** — The TypeScript wrapper uses JSON commands/events over stdin/stdout to communicate with the Rust binary - **IPC** — The TypeScript wrapper uses JSON commands/events over stdin/stdout to communicate with the Rust binary
- **Socket/Datagram Relay** — Unix domain socket servers for routes requiring TypeScript-side handling (socket handlers, datagram handlers, dynamic host/port functions) - **Socket/Datagram Relay** — Unix domain socket servers for routes requiring TypeScript-side handling (socket handlers, datagram handlers, dynamic host/port functions)
@@ -854,47 +890,13 @@ interface IRouteQuic {
} }
``` ```
## 🛠️ Helper Functions Reference ## 🛠️ Exports Reference
All helpers are fully typed and return `IRouteConfig` or `IRouteConfig[]`:
```typescript ```typescript
import { import {
// HTTP/HTTPS // Core
createHttpRoute, // Plain HTTP route SmartProxy, // Main proxy class
createHttpsTerminateRoute, // HTTPS with TLS termination SocketHandlers, // Pre-built socket handlers (echo, proxy, block, httpRedirect, httpServer, etc.)
createHttpsPassthroughRoute, // SNI passthrough (no termination)
createHttpToHttpsRedirect, // HTTP → HTTPS redirect
createCompleteHttpsServer, // HTTPS + redirect combo (returns IRouteConfig[])
// Load Balancing
createLoadBalancerRoute, // Multi-backend with health checks
createSmartLoadBalancer, // Dynamic domain-based backend selection
// API & WebSocket
createApiRoute, // API route with path matching
createApiGatewayRoute, // API gateway with CORS
createWebSocketRoute, // WebSocket-enabled route
// Custom Protocols
createSocketHandlerRoute, // Custom TCP socket handler
SocketHandlers, // Pre-built handlers (echo, proxy, block, etc.)
// NFTables (Linux, requires root)
createNfTablesRoute, // Kernel-level packet forwarding
createNfTablesTerminateRoute, // NFTables + TLS termination
createCompleteNfTablesHttpsServer, // NFTables HTTPS + redirect combo
// Dynamic Routing
createPortMappingRoute, // Port mapping with context
createOffsetPortMappingRoute, // Simple port offset
createDynamicRoute, // Dynamic host/port via functions
createPortOffset, // Port offset factory
// Security Modifiers
addRateLimiting, // Add rate limiting to any route
addBasicAuth, // Add basic auth to any route
addJwtAuth, // Add JWT auth to any route
// Route Utilities // Route Utilities
mergeRouteConfigs, // Deep-merge two route configs mergeRouteConfigs, // Deep-merge two route configs
@@ -906,7 +908,7 @@ import {
} from '@push.rocks/smartproxy'; } from '@push.rocks/smartproxy';
``` ```
> **Tip:** For UDP datagram handler routes or QUIC/HTTP3 routes, construct `IRouteConfig` objects directly — there are no helper functions for these yet. See the [UDP Datagram Handler](#-udp-datagram-handler) and [QUIC / HTTP3 Forwarding](#-quic--http3-forwarding) examples above. All routes are configured as plain `IRouteConfig` objects with `match` and `action` properties — see the examples throughout this document.
## 📖 API Documentation ## 📖 API Documentation
@@ -938,8 +940,8 @@ class SmartProxy extends EventEmitter {
getCertificateStatus(routeName: string): Promise<any>; getCertificateStatus(routeName: string): Promise<any>;
getEligibleDomainsForCertificates(): string[]; getEligibleDomainsForCertificates(): string[];
// NFTables // NFTables (managed by @push.rocks/smartnftables)
getNfTablesStatus(): Promise<Record<string, any>>; getNfTablesStatus(): INftStatus | null;
// Events // Events
on(event: 'error', handler: (err: Error) => void): this; on(event: 'error', handler: (err: Error) => void): this;
@@ -991,11 +993,11 @@ interface ISmartProxyOptions {
sendProxyProtocol?: boolean; // Send PROXY protocol to targets sendProxyProtocol?: boolean; // Send PROXY protocol to targets
// Timeouts // Timeouts
connectionTimeout?: number; // Backend connection timeout (default: 30s) connectionTimeout?: number; // Backend connection timeout (default: 60s)
initialDataTimeout?: number; // Initial data/SNI timeout (default: 120s) initialDataTimeout?: number; // Initial data/SNI timeout (default: 60s)
socketTimeout?: number; // Socket inactivity timeout (default: 1h) socketTimeout?: number; // Socket inactivity timeout (default: 60s)
maxConnectionLifetime?: number; // Max connection lifetime (default: 24h) maxConnectionLifetime?: number; // Max connection lifetime (default: 1h)
inactivityTimeout?: number; // Inactivity timeout (default: 4h) inactivityTimeout?: number; // Inactivity timeout (default: 75s)
gracefulShutdownTimeout?: number; // Shutdown grace period (default: 30s) gracefulShutdownTimeout?: number; // Shutdown grace period (default: 30s)
// Connection limits // Connection limits
@@ -1004,8 +1006,8 @@ interface ISmartProxyOptions {
// Keep-alive // Keep-alive
keepAliveTreatment?: 'standard' | 'extended' | 'immortal'; keepAliveTreatment?: 'standard' | 'extended' | 'immortal';
keepAliveInactivityMultiplier?: number; // (default: 6) keepAliveInactivityMultiplier?: number; // (default: 4)
extendedKeepAliveLifetime?: number; // (default: 7 days) extendedKeepAliveLifetime?: number; // (default: 1h)
// Metrics // Metrics
metrics?: { metrics?: {
@@ -1137,7 +1139,7 @@ SmartProxy searches for the Rust binary in this order:
## License and Legal Information ## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file. This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file. **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+484
View File
@@ -0,0 +1,484 @@
# SmartProxy Metrics System
## Architecture
Two-tier design separating the data plane from the observation plane:
**Hot path (per-chunk, lock-free):** All recording in the proxy data plane touches only `AtomicU64` counters. No `Mutex` is ever acquired on the forwarding path. `CountingBody` batches flushes every 64KB to reduce DashMap shard contention.
**Cold path (1Hz sampling):** A background tokio task drains pending atomics into `ThroughputTracker` circular buffers (Mutex-guarded), producing per-second throughput history. Same task prunes orphaned entries and cleans up rate limiter state.
**Read path (on-demand):** `snapshot()` reads all atomics and locks ThroughputTrackers to build a serializable `Metrics` struct. TypeScript polls this at 1s intervals via IPC.
```
Data Plane (lock-free) Background (1Hz) Read Path
───────────────────── ────────────────── ─────────
record_bytes() ──> AtomicU64 ──┐
record_http_request() ──> AtomicU64 ──┤
connection_opened/closed() ──> AtomicU64 ──┤ sample_all() snapshot()
backend_*() ──> DashMap<AtomicU64> ──┤────> drain atomics ──────> Metrics struct
protocol_*() ──> AtomicU64 ──┤ feed ThroughputTrackers ──> JSON
datagram_*() ──> AtomicU64 ──┘ prune orphans ──> IPC stdout
──> TS cache
──> IMetrics API
```
### Key Types
| Type | Crate | Purpose |
|---|---|---|
| `MetricsCollector` | `rustproxy-metrics` | Central store. All DashMaps, atomics, and throughput trackers |
| `ThroughputTracker` | `rustproxy-metrics` | Circular buffer of 1Hz samples. Default 3600 capacity (1 hour) |
| `ForwardMetricsCtx` | `rustproxy-passthrough` | Carries `Arc<MetricsCollector>` + route_id + source_ip through TCP forwarding |
| `CountingBody` | `rustproxy-http` | Wraps HTTP bodies, batches byte recording per 64KB, flushes on drop |
| `ProtocolGuard` | `rustproxy-http` | RAII guard for frontend/backend protocol active/total counters |
| `ConnectionGuard` | `rustproxy-passthrough` | RAII guard calling `connection_closed()` on drop |
| `RustMetricsAdapter` | TypeScript | Polls Rust via IPC, implements `IMetrics` interface over cached JSON |
---
## What's Collected
### Global Counters
| Metric | Type | Updated by |
|---|---|---|
| Active connections | AtomicU64 | `connection_opened/closed` |
| Total connections (lifetime) | AtomicU64 | `connection_opened` |
| Total bytes in | AtomicU64 | `record_bytes` |
| Total bytes out | AtomicU64 | `record_bytes` |
| Total HTTP requests | AtomicU64 | `record_http_request` |
| Active UDP sessions | AtomicU64 | `udp_session_opened/closed` |
| Total UDP sessions | AtomicU64 | `udp_session_opened` |
| Total datagrams in | AtomicU64 | `record_datagram_in` |
| Total datagrams out | AtomicU64 | `record_datagram_out` |
### Per-Route Metrics (keyed by route ID string)
| Metric | Storage |
|---|---|
| Active connections | `DashMap<String, AtomicU64>` |
| Total connections | `DashMap<String, AtomicU64>` |
| Bytes in / out | `DashMap<String, AtomicU64>` |
| Pending throughput (in, out) | `DashMap<String, (AtomicU64, AtomicU64)>` |
| Throughput history | `DashMap<String, Mutex<ThroughputTracker>>` |
Entries are pruned via `retain_routes()` when routes are removed.
### Per-IP Metrics (keyed by IP string)
| Metric | Storage |
|---|---|
| Active connections | `DashMap<String, AtomicU64>` |
| Total connections | `DashMap<String, AtomicU64>` |
| Bytes in / out | `DashMap<String, AtomicU64>` |
| Pending throughput (in, out) | `DashMap<String, (AtomicU64, AtomicU64)>` |
| Throughput history | `DashMap<String, Mutex<ThroughputTracker>>` |
| Domain requests | `DashMap<String, DashMap<String, AtomicU64>>` (IP → domain → count) |
All seven maps for an IP are evicted when its active connection count drops to 0. Safety-net pruning in `sample_all()` catches entries orphaned by races. Snapshots cap at 100 IPs, sorted by active connections descending.
**Domain request tracking:** Records which domains each frontend IP has requested. Populated from HTTP Host headers (for HTTP/1.1, HTTP/2, HTTP/3 requests) and from SNI (for TLS passthrough connections). Domain keys are normalized to lowercase with any trailing dot stripped so the same hostname does not fragment across multiple counters. Capped at 256 domains per IP (`MAX_DOMAINS_PER_IP`) to prevent subdomain-spray abuse. Inner DashMap uses 2 shards to minimise base memory per IP (~200 bytes). Common case (IP + domain both known) is two DashMap reads + one atomic increment with zero allocation.
### Per-Backend Metrics (keyed by "host:port")
| Metric | Storage |
|---|---|
| Active connections | `DashMap<String, AtomicU64>` |
| Total connections | `DashMap<String, AtomicU64>` |
| Detected protocol (h1/h2/h3) | `DashMap<String, String>` |
| Connect errors | `DashMap<String, AtomicU64>` |
| Handshake errors | `DashMap<String, AtomicU64>` |
| Request errors | `DashMap<String, AtomicU64>` |
| Total connect time (microseconds) | `DashMap<String, AtomicU64>` |
| Connect count | `DashMap<String, AtomicU64>` |
| Pool hits | `DashMap<String, AtomicU64>` |
| Pool misses | `DashMap<String, AtomicU64>` |
| H2 failures (fallback to H1) | `DashMap<String, AtomicU64>` |
All per-backend maps are evicted when active count reaches 0. Pruned via `retain_backends()`.
### Frontend Protocol Distribution
Tracked via `ProtocolGuard` RAII guards and `FrontendProtocolTracker`. Five protocol categories, each with active + total counters (AtomicU64):
| Protocol | Where detected |
|---|---|
| h1 | `FrontendProtocolTracker` on first HTTP/1.x request |
| h2 | `FrontendProtocolTracker` on first HTTP/2 request |
| h3 | `ProtocolGuard::frontend("h3")` in H3ProxyService |
| ws | `ProtocolGuard::frontend("ws")` on WebSocket upgrade |
| other | Fallback (TCP passthrough without HTTP) |
Uses `fetch_update` for saturating decrements to prevent underflow races. The same saturating-close pattern is also used for connection and UDP active gauges.
### Backend Protocol Distribution
Same five categories (h1/h2/h3/ws/other), tracked via `ProtocolGuard::backend()` at connection establishment. Backend h2 failures (fallback to h1) are separately counted.
### Throughput History
`ThroughputTracker` is a circular buffer storing `ThroughputSample { timestamp_ms, bytes_in, bytes_out }` at 1Hz.
- Global tracker: 1 instance, default 3600 capacity
- Per-route trackers: 1 per active route
- Per-IP trackers: 1 per connected IP (evicted with the IP)
- HTTP request tracker: reuses ThroughputTracker with bytes_in = request count, bytes_out = 0
Query methods:
- `instant()` — last 1 second average
- `recent()` — last 10 seconds average
- `throughput(N)` — last N seconds average
- `history(N)` — last N raw samples in chronological order
Snapshots return 60 samples of global throughput history.
### Protocol Detection Cache
Not part of MetricsCollector. Maintained by `HttpProxyService`'s protocol detection system. Injected into the metrics snapshot at read time by `get_metrics()`.
Each entry records: host, port, domain, detected protocol (h1/h2/h3), H3 port, age, last accessed, last probed, suppression flags, cooldown timers, consecutive failure counts.
---
## Instrumentation Points
### TCP Passthrough (`rustproxy-passthrough`)
**Connection lifecycle**`tcp_listener.rs`:
- Accept: `conn_tracker.connection_opened(&ip)` (rate limiter) + `ConnectionTrackerGuard` RAII
- Route match: `metrics.connection_opened(route_id, source_ip)` + `ConnectionGuard` RAII
- Close: Both guards call their respective `_closed()` methods on drop
**Byte recording**`forwarder.rs` (`forward_bidirectional_with_timeouts`):
- Initial peeked data recorded immediately
- Per-chunk in both directions: `record_bytes(n, 0, ...)` / `record_bytes(0, n, ...)`
- Same pattern in `forward_bidirectional_split_with_timeouts` (tcp_listener.rs) for TLS-terminated paths
### HTTP Proxy (`rustproxy-http`)
**Request counting**`proxy_service.rs`:
- `record_http_request()` called once per request after route matching succeeds
**Body byte counting**`counting_body.rs` wrapping:
- Request bodies: `CountingBody::new(body, ..., Direction::In)` — counts client-to-upstream bytes
- Response bodies: `CountingBody::new(body, ..., Direction::Out)` — counts upstream-to-client bytes
- Batched flush every 64KB (`BYTE_FLUSH_THRESHOLD = 65_536`), remainder flushed on drop
- Also updates `connection_activity` atomic (idle watchdog) and `active_requests` counter (streaming detection)
**Backend metrics**`proxy_service.rs`:
- `backend_connection_opened(key, connect_time)` — after TCP/TLS connect succeeds
- `backend_connection_closed(key)` — on teardown
- `backend_connect_error(key)` — TCP/TLS connect failure or timeout
- `backend_handshake_error(key)` — H1/H2 protocol handshake failure
- `backend_request_error(key)` — send_request failure
- `backend_h2_failure(key)` — H2 attempted, fell back to H1
- `backend_pool_hit(key)` / `backend_pool_miss(key)` — connection pool reuse
- `set_backend_protocol(key, proto)` — records detected protocol
**WebSocket**`proxy_service.rs`:
- Does NOT use CountingBody; records bytes directly per-chunk in both directions of the bidirectional copy loop
### QUIC (`rustproxy-passthrough`)
**Connection level**`quic_handler.rs`:
- `connection_opened` / `connection_closed` via `QuicConnGuard` RAII
- `conn_tracker.connection_opened/closed` for rate limiting
**Stream level**:
- For QUIC-to-TCP stream forwarding: `record_bytes(bytes_in, bytes_out, ...)` called once per stream at completion (post-hoc, not per-chunk)
- For HTTP/3: delegates to `HttpProxyService.handle_request()`, so all HTTP proxy metrics apply
**H3 specifics**`h3_service.rs`:
- `ProtocolGuard::frontend("h3")` tracks the H3 connection
- H3 request bodies: `record_bytes(data.len(), 0, ...)` called directly (not CountingBody) since H3 uses `stream.send_data()`
- H3 response bodies: wrapped in CountingBody like HTTP/1 and HTTP/2
### UDP (`rustproxy-passthrough`)
**Session lifecycle**`udp_listener.rs` / `udp_session.rs`:
- `udp_session_opened()` + `connection_opened(route_id, source_ip)` on new session
- `udp_session_closed()` + `connection_closed(route_id, source_ip)` on idle reap or port drain
**Datagram counting**`udp_listener.rs`:
- Inbound: `record_bytes(len, 0, ...)` + `record_datagram_in()`
- Outbound (backend reply): `record_bytes(0, len, ...)` + `record_datagram_out()`
---
## Sampling Loop
`lib.rs` spawns a tokio task at configurable interval (default 1000ms):
```rust
loop {
tokio::select! {
_ = cancel => break,
_ = interval.tick() => {
metrics.sample_all();
conn_tracker.cleanup_stale_timestamps();
http_proxy.cleanup_all_rate_limiters();
}
}
}
```
`sample_all()` performs in one pass:
1. Drains `global_pending_tp_in/out` into global ThroughputTracker, samples
2. Drains per-route pending counters into per-route trackers, samples each
3. Samples idle route trackers (no new data) to advance their window
4. Drains per-IP pending counters into per-IP trackers, samples each
5. Drains `pending_http_requests` into HTTP request throughput tracker
6. Prunes orphaned per-IP entries (bytes/throughput maps with no matching ip_connections key)
7. Prunes orphaned per-backend entries (error/stats maps with no matching active/total key)
---
## Data Flow: Rust to TypeScript
```
MetricsCollector.snapshot()
├── reads all AtomicU64 counters
├── iterates DashMaps (routes, IPs, backends)
├── locks ThroughputTrackers for instant/recent rates + history
└── produces Metrics struct
RustProxy::get_metrics()
├── calls snapshot()
├── enriches with detectedProtocols from HTTP proxy protocol cache
└── returns Metrics
management.rs "getMetrics" IPC command
├── calls get_metrics()
├── serde_json::to_value (camelCase)
└── writes JSON to stdout
RustProxyBridge (TypeScript)
├── reads JSON from Rust process stdout
└── returns parsed object
RustMetricsAdapter
├── setInterval polls bridge.getMetrics() every 1s
├── stores raw JSON in this.cache
└── IMetrics methods read synchronously from cache
SmartProxy.getMetrics()
└── returns the RustMetricsAdapter instance
```
### IPC JSON Shape (Metrics)
```json
{
"activeConnections": 42,
"totalConnections": 1000,
"bytesIn": 123456789,
"bytesOut": 987654321,
"throughputInBytesPerSec": 50000,
"throughputOutBytesPerSec": 80000,
"throughputRecentInBytesPerSec": 45000,
"throughputRecentOutBytesPerSec": 75000,
"routes": {
"<route-id>": {
"activeConnections": 5,
"totalConnections": 100,
"bytesIn": 0, "bytesOut": 0,
"throughputInBytesPerSec": 0, "throughputOutBytesPerSec": 0,
"throughputRecentInBytesPerSec": 0, "throughputRecentOutBytesPerSec": 0
}
},
"ips": {
"<ip>": {
"activeConnections": 2, "totalConnections": 10,
"bytesIn": 0, "bytesOut": 0,
"throughputInBytesPerSec": 0, "throughputOutBytesPerSec": 0,
"domainRequests": {
"example.com": 4821,
"api.example.com": 312
}
}
},
"backends": {
"<host:port>": {
"activeConnections": 3, "totalConnections": 50,
"protocol": "h2",
"connectErrors": 0, "handshakeErrors": 0, "requestErrors": 0,
"totalConnectTimeUs": 150000, "connectCount": 50,
"poolHits": 40, "poolMisses": 10, "h2Failures": 1
}
},
"throughputHistory": [
{ "timestampMs": 1713000000000, "bytesIn": 50000, "bytesOut": 80000 }
],
"totalHttpRequests": 5000,
"httpRequestsPerSec": 100,
"httpRequestsPerSecRecent": 95,
"activeUdpSessions": 0, "totalUdpSessions": 5,
"totalDatagramsIn": 1000, "totalDatagramsOut": 1000,
"frontendProtocols": {
"h1Active": 10, "h1Total": 500,
"h2Active": 5, "h2Total": 200,
"h3Active": 1, "h3Total": 50,
"wsActive": 2, "wsTotal": 30,
"otherActive": 0, "otherTotal": 0
},
"backendProtocols": { "...same shape..." },
"detectedProtocols": [
{
"host": "backend", "port": 443, "domain": "example.com",
"protocol": "h2", "h3Port": 443,
"ageSecs": 120, "lastAccessedSecs": 5, "lastProbedSecs": 120,
"h2Suppressed": false, "h3Suppressed": false,
"h2CooldownRemainingSecs": null, "h3CooldownRemainingSecs": null,
"h2ConsecutiveFailures": null, "h3ConsecutiveFailures": null
}
]
}
```
### IPC JSON Shape (Statistics)
Lightweight administrative summary, fetched on-demand (not polled):
```json
{
"activeConnections": 42,
"totalConnections": 1000,
"routesCount": 5,
"listeningPorts": [80, 443, 8443],
"uptimeSeconds": 86400
}
```
---
## TypeScript Consumer API
`SmartProxy.getMetrics()` returns an `IMetrics` object. All members are synchronous methods reading from the polled cache.
### connections
| Method | Return | Source |
|---|---|---|
| `active()` | `number` | `cache.activeConnections` |
| `total()` | `number` | `cache.totalConnections` |
| `byRoute()` | `Map<string, number>` | `cache.routes[name].activeConnections` |
| `byIP()` | `Map<string, number>` | `cache.ips[ip].activeConnections` |
| `topIPs(limit?)` | `Array<{ip, count}>` | `cache.ips` sorted by active desc, default 10 |
| `domainRequestsByIP()` | `Map<string, Map<string, number>>` | `cache.ips[ip].domainRequests` |
| `topDomainRequests(limit?)` | `Array<{ip, domain, count}>` | Flattened from all IPs, sorted by count desc, default 20 |
| `frontendProtocols()` | `IProtocolDistribution` | `cache.frontendProtocols.*` |
| `backendProtocols()` | `IProtocolDistribution` | `cache.backendProtocols.*` |
### throughput
| Method | Return | Source |
|---|---|---|
| `instant()` | `{in, out}` | `cache.throughputInBytesPerSec/Out` |
| `recent()` | `{in, out}` | `cache.throughputRecentInBytesPerSec/Out` |
| `average()` | `{in, out}` | Falls back to `instant()` (not wired to windowed average) |
| `custom(seconds)` | `{in, out}` | Falls back to `instant()` (not wired) |
| `history(seconds)` | `IThroughputHistoryPoint[]` | `cache.throughputHistory` sliced to last N entries |
| `byRoute(windowSeconds?)` | `Map<string, {in, out}>` | `cache.routes[name].throughputIn/OutBytesPerSec` |
| `byIP(windowSeconds?)` | `Map<string, {in, out}>` | `cache.ips[ip].throughputIn/OutBytesPerSec` |
### requests
| Method | Return | Source |
|---|---|---|
| `perSecond()` | `number` | `cache.httpRequestsPerSec` |
| `perMinute()` | `number` | `cache.httpRequestsPerSecRecent * 60` |
| `total()` | `number` | `cache.totalHttpRequests` (fallback: totalConnections) |
### totals
| Method | Return | Source |
|---|---|---|
| `bytesIn()` | `number` | `cache.bytesIn` |
| `bytesOut()` | `number` | `cache.bytesOut` |
| `connections()` | `number` | `cache.totalConnections` |
### backends
| Method | Return | Source |
|---|---|---|
| `byBackend()` | `Map<string, IBackendMetrics>` | `cache.backends[key].*` with computed `avgConnectTimeMs` and `poolHitRate` |
| `protocols()` | `Map<string, string>` | `cache.backends[key].protocol` |
| `topByErrors(limit?)` | `IBackendMetrics[]` | Sorted by total errors desc |
| `detectedProtocols()` | `IProtocolCacheEntry[]` | `cache.detectedProtocols` passthrough |
`IBackendMetrics`: `{ protocol, activeConnections, totalConnections, connectErrors, handshakeErrors, requestErrors, avgConnectTimeMs, poolHitRate, h2Failures }`
### udp
| Method | Return | Source |
|---|---|---|
| `activeSessions()` | `number` | `cache.activeUdpSessions` |
| `totalSessions()` | `number` | `cache.totalUdpSessions` |
| `datagramsIn()` | `number` | `cache.totalDatagramsIn` |
| `datagramsOut()` | `number` | `cache.totalDatagramsOut` |
### percentiles (stub)
`connectionDuration()` and `bytesTransferred()` always return zeros. Not implemented.
---
## Configuration
```typescript
interface IMetricsConfig {
enabled: boolean; // default true
sampleIntervalMs: number; // default 1000 (1Hz sampling + TS polling)
retentionSeconds: number; // default 3600 (ThroughputTracker capacity)
enableDetailedTracking: boolean;
enablePercentiles: boolean;
cacheResultsMs: number;
prometheusEnabled: boolean; // not wired
prometheusPath: string; // not wired
prometheusPrefix: string; // not wired
}
```
Rust-side config (`MetricsConfig` in `rustproxy-config`):
```rust
pub struct MetricsConfig {
pub enabled: Option<bool>,
pub sample_interval_ms: Option<u64>, // default 1000
pub retention_seconds: Option<u64>, // default 3600
}
```
---
## Design Decisions
**Lock-free hot path.** `record_bytes()` is the most frequently called method (per-chunk in TCP, per-64KB in HTTP). It only touches `AtomicU64` with `Relaxed` ordering and short-circuits zero-byte directions to skip DashMap lookups entirely.
**CountingBody batching.** HTTP body frames are typically 16KB. Flushing to MetricsCollector every 64KB reduces DashMap shard contention by ~4x compared to per-frame recording.
**RAII guards everywhere.** `ConnectionGuard`, `ConnectionTrackerGuard`, `QuicConnGuard`, `ProtocolGuard`, `FrontendProtocolTracker` all use Drop to guarantee counter cleanup on all exit paths including panics.
**Saturating decrements.** Protocol counters use `fetch_update` loops instead of `fetch_sub` to prevent underflow to `u64::MAX` from concurrent close races.
**Bounded memory.** Per-IP entries evicted on last connection close. Per-backend entries evicted on last connection close. Snapshot caps IPs and backends at 100 each. `sample_all()` prunes orphaned entries every second.
**Two-phase throughput.** Pending bytes accumulate in lock-free atomics. The 1Hz cold path drains them into Mutex-guarded ThroughputTrackers. This means the hot path never contends on a Mutex, while the cold path does minimal work (one drain + one sample per tracker).
---
## Known Gaps
| Gap | Status |
|---|---|
| `throughput.average()` / `throughput.custom(seconds)` | Fall back to `instant()`. Not wired to Rust windowed queries. |
| `percentiles.connectionDuration()` / `percentiles.bytesTransferred()` | Stub returning zeros. No histogram in Rust. |
| Prometheus export | Config fields exist but not wired to any exporter. |
| `LogDeduplicator` | Implemented in `rustproxy-metrics` but not connected to any call site. |
| Rate limit hit counters | Rate-limited requests return 429 but no counter is recorded in MetricsCollector. |
| QUIC stream byte counting | Post-hoc (per-stream totals after close), not per-chunk like TCP. |
| Throughput history in snapshot | Capped at 60 samples. TS `history(seconds)` cannot return more than 60 points regardless of `retentionSeconds`. |
| Per-route total connections / bytes | Available in Rust JSON but `IMetrics.connections.byRoute()` only exposes active connections. |
| Per-IP total connections / bytes | Available in Rust JSON but `IMetrics.connections.byIP()` only exposes active connections. |
| IPC response typing | `RustProxyBridge` declares `result: any` for both metrics commands. No type-safe response. |
+1 -15
View File
@@ -1238,7 +1238,6 @@ dependencies = [
"rustproxy-config", "rustproxy-config",
"rustproxy-http", "rustproxy-http",
"rustproxy-metrics", "rustproxy-metrics",
"rustproxy-nftables",
"rustproxy-passthrough", "rustproxy-passthrough",
"rustproxy-routing", "rustproxy-routing",
"rustproxy-security", "rustproxy-security",
@@ -1270,6 +1269,7 @@ dependencies = [
"arc-swap", "arc-swap",
"bytes", "bytes",
"dashmap", "dashmap",
"futures",
"h3", "h3",
"h3-quinn", "h3-quinn",
"http-body", "http-body",
@@ -1303,20 +1303,6 @@ dependencies = [
"tracing", "tracing",
] ]
[[package]]
name = "rustproxy-nftables"
version = "0.1.0"
dependencies = [
"anyhow",
"libc",
"rustproxy-config",
"serde",
"serde_json",
"thiserror 2.0.18",
"tokio",
"tracing",
]
[[package]] [[package]]
name = "rustproxy-passthrough" name = "rustproxy-passthrough"
version = "0.1.0" version = "0.1.0"
-2
View File
@@ -7,7 +7,6 @@ members = [
"crates/rustproxy-tls", "crates/rustproxy-tls",
"crates/rustproxy-passthrough", "crates/rustproxy-passthrough",
"crates/rustproxy-http", "crates/rustproxy-http",
"crates/rustproxy-nftables",
"crates/rustproxy-metrics", "crates/rustproxy-metrics",
"crates/rustproxy-security", "crates/rustproxy-security",
] ]
@@ -107,6 +106,5 @@ rustproxy-routing = { path = "crates/rustproxy-routing" }
rustproxy-tls = { path = "crates/rustproxy-tls" } rustproxy-tls = { path = "crates/rustproxy-tls" }
rustproxy-passthrough = { path = "crates/rustproxy-passthrough" } rustproxy-passthrough = { path = "crates/rustproxy-passthrough" }
rustproxy-http = { path = "crates/rustproxy-http" } rustproxy-http = { path = "crates/rustproxy-http" }
rustproxy-nftables = { path = "crates/rustproxy-nftables" }
rustproxy-metrics = { path = "crates/rustproxy-metrics" } rustproxy-metrics = { path = "crates/rustproxy-metrics" }
rustproxy-security = { path = "crates/rustproxy-security" } rustproxy-security = { path = "crates/rustproxy-security" }
-345
View File
@@ -1,345 +0,0 @@
use crate::route_types::*;
use crate::tls_types::*;
/// Create a simple HTTP forwarding route.
/// Equivalent to SmartProxy's `createHttpRoute()`.
pub fn create_http_route(
domains: impl Into<DomainSpec>,
target_host: impl Into<String>,
target_port: u16,
) -> RouteConfig {
RouteConfig {
id: None,
route_match: RouteMatch {
ports: PortRange::Single(80),
domains: Some(domains.into()),
path: None,
client_ip: None,
transport: None,
tls_version: None,
headers: None,
protocol: None,
},
action: RouteAction {
action_type: RouteActionType::Forward,
targets: Some(vec![RouteTarget {
target_match: None,
host: HostSpec::Single(target_host.into()),
port: PortSpec::Fixed(target_port),
tls: None,
websocket: None,
load_balancing: None,
send_proxy_protocol: None,
headers: None,
advanced: None,
backend_transport: None,
priority: None,
}]),
tls: None,
websocket: None,
load_balancing: None,
advanced: None,
options: None,
forwarding_engine: None,
nftables: None,
send_proxy_protocol: None,
udp: None,
},
headers: None,
security: None,
name: None,
description: None,
priority: None,
tags: None,
enabled: None,
}
}
/// Create an HTTPS termination route.
/// Equivalent to SmartProxy's `createHttpsTerminateRoute()`.
pub fn create_https_terminate_route(
domains: impl Into<DomainSpec>,
target_host: impl Into<String>,
target_port: u16,
) -> RouteConfig {
let mut route = create_http_route(domains, target_host, target_port);
route.route_match.ports = PortRange::Single(443);
route.action.tls = Some(RouteTls {
mode: TlsMode::Terminate,
certificate: Some(CertificateSpec::Auto("auto".to_string())),
acme: None,
versions: None,
ciphers: None,
honor_cipher_order: None,
session_timeout: None,
});
route
}
/// Create a TLS passthrough route.
/// Equivalent to SmartProxy's `createHttpsPassthroughRoute()`.
pub fn create_https_passthrough_route(
domains: impl Into<DomainSpec>,
target_host: impl Into<String>,
target_port: u16,
) -> RouteConfig {
let mut route = create_http_route(domains, target_host, target_port);
route.route_match.ports = PortRange::Single(443);
route.action.tls = Some(RouteTls {
mode: TlsMode::Passthrough,
certificate: None,
acme: None,
versions: None,
ciphers: None,
honor_cipher_order: None,
session_timeout: None,
});
route
}
/// Create an HTTP-to-HTTPS redirect route.
/// Equivalent to SmartProxy's `createHttpToHttpsRedirect()`.
pub fn create_http_to_https_redirect(
domains: impl Into<DomainSpec>,
) -> RouteConfig {
let domains = domains.into();
RouteConfig {
id: None,
route_match: RouteMatch {
ports: PortRange::Single(80),
domains: Some(domains),
path: None,
client_ip: None,
transport: None,
tls_version: None,
headers: None,
protocol: None,
},
action: RouteAction {
action_type: RouteActionType::Forward,
targets: None,
tls: None,
websocket: None,
load_balancing: None,
advanced: Some(RouteAdvanced {
timeout: None,
headers: None,
keep_alive: None,
static_files: None,
test_response: Some(RouteTestResponse {
status: 301,
headers: {
let mut h = std::collections::HashMap::new();
h.insert("Location".to_string(), "https://{domain}{path}".to_string());
h
},
body: String::new(),
}),
url_rewrite: None,
}),
options: None,
forwarding_engine: None,
nftables: None,
send_proxy_protocol: None,
udp: None,
},
headers: None,
security: None,
name: Some("HTTP to HTTPS Redirect".to_string()),
description: None,
priority: None,
tags: None,
enabled: None,
}
}
/// Create a complete HTTPS server with HTTP redirect.
/// Equivalent to SmartProxy's `createCompleteHttpsServer()`.
pub fn create_complete_https_server(
domain: impl Into<String>,
target_host: impl Into<String>,
target_port: u16,
) -> Vec<RouteConfig> {
let domain = domain.into();
let target_host = target_host.into();
vec![
create_http_to_https_redirect(DomainSpec::Single(domain.clone())),
create_https_terminate_route(
DomainSpec::Single(domain),
target_host,
target_port,
),
]
}
/// Create a load balancer route.
/// Equivalent to SmartProxy's `createLoadBalancerRoute()`.
pub fn create_load_balancer_route(
domains: impl Into<DomainSpec>,
targets: Vec<(String, u16)>,
tls: Option<RouteTls>,
) -> RouteConfig {
let route_targets: Vec<RouteTarget> = targets
.into_iter()
.map(|(host, port)| RouteTarget {
target_match: None,
host: HostSpec::Single(host),
port: PortSpec::Fixed(port),
tls: None,
websocket: None,
load_balancing: None,
send_proxy_protocol: None,
headers: None,
advanced: None,
backend_transport: None,
priority: None,
})
.collect();
let port = if tls.is_some() { 443 } else { 80 };
RouteConfig {
id: None,
route_match: RouteMatch {
ports: PortRange::Single(port),
domains: Some(domains.into()),
path: None,
client_ip: None,
transport: None,
tls_version: None,
headers: None,
protocol: None,
},
action: RouteAction {
action_type: RouteActionType::Forward,
targets: Some(route_targets),
tls,
websocket: None,
load_balancing: Some(RouteLoadBalancing {
algorithm: LoadBalancingAlgorithm::RoundRobin,
health_check: None,
}),
advanced: None,
options: None,
forwarding_engine: None,
nftables: None,
send_proxy_protocol: None,
udp: None,
},
headers: None,
security: None,
name: Some("Load Balancer".to_string()),
description: None,
priority: None,
tags: None,
enabled: None,
}
}
// Convenience conversions for DomainSpec
impl From<&str> for DomainSpec {
fn from(s: &str) -> Self {
DomainSpec::Single(s.to_string())
}
}
impl From<String> for DomainSpec {
fn from(s: String) -> Self {
DomainSpec::Single(s)
}
}
impl From<Vec<String>> for DomainSpec {
fn from(v: Vec<String>) -> Self {
DomainSpec::List(v)
}
}
impl From<Vec<&str>> for DomainSpec {
fn from(v: Vec<&str>) -> Self {
DomainSpec::List(v.into_iter().map(|s| s.to_string()).collect())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::tls_types::TlsMode;
#[test]
fn test_create_http_route() {
let route = create_http_route("example.com", "localhost", 8080);
assert_eq!(route.route_match.ports.to_ports(), vec![80]);
let domains = route.route_match.domains.as_ref().unwrap().to_vec();
assert_eq!(domains, vec!["example.com"]);
let target = &route.action.targets.as_ref().unwrap()[0];
assert_eq!(target.host.first(), "localhost");
assert_eq!(target.port.resolve(80), 8080);
assert!(route.action.tls.is_none());
}
#[test]
fn test_create_https_terminate_route() {
let route = create_https_terminate_route("api.example.com", "backend", 3000);
assert_eq!(route.route_match.ports.to_ports(), vec![443]);
let tls = route.action.tls.as_ref().unwrap();
assert_eq!(tls.mode, TlsMode::Terminate);
assert!(tls.certificate.as_ref().unwrap().is_auto());
}
#[test]
fn test_create_https_passthrough_route() {
let route = create_https_passthrough_route("secure.example.com", "backend", 443);
assert_eq!(route.route_match.ports.to_ports(), vec![443]);
let tls = route.action.tls.as_ref().unwrap();
assert_eq!(tls.mode, TlsMode::Passthrough);
assert!(tls.certificate.is_none());
}
#[test]
fn test_create_http_to_https_redirect() {
let route = create_http_to_https_redirect("example.com");
assert_eq!(route.route_match.ports.to_ports(), vec![80]);
assert!(route.action.targets.is_none());
let test_response = route.action.advanced.as_ref().unwrap().test_response.as_ref().unwrap();
assert_eq!(test_response.status, 301);
assert!(test_response.headers.contains_key("Location"));
}
#[test]
fn test_create_complete_https_server() {
let routes = create_complete_https_server("example.com", "backend", 8080);
assert_eq!(routes.len(), 2);
// First route is HTTP redirect
assert_eq!(routes[0].route_match.ports.to_ports(), vec![80]);
// Second route is HTTPS terminate
assert_eq!(routes[1].route_match.ports.to_ports(), vec![443]);
}
#[test]
fn test_create_load_balancer_route() {
let targets = vec![
("backend1".to_string(), 8080),
("backend2".to_string(), 8080),
("backend3".to_string(), 8080),
];
let route = create_load_balancer_route("*.example.com", targets, None);
assert_eq!(route.route_match.ports.to_ports(), vec![80]);
assert_eq!(route.action.targets.as_ref().unwrap().len(), 3);
let lb = route.action.load_balancing.as_ref().unwrap();
assert_eq!(lb.algorithm, LoadBalancingAlgorithm::RoundRobin);
}
#[test]
fn test_domain_spec_from_str() {
let spec: DomainSpec = "example.com".into();
assert_eq!(spec.to_vec(), vec!["example.com"]);
}
#[test]
fn test_domain_spec_from_vec() {
let spec: DomainSpec = vec!["a.com", "b.com"].into();
assert_eq!(spec.to_vec(), vec!["a.com", "b.com"]);
}
}
-2
View File
@@ -8,7 +8,6 @@ pub mod proxy_options;
pub mod tls_types; pub mod tls_types;
pub mod security_types; pub mod security_types;
pub mod validation; pub mod validation;
pub mod helpers;
// Re-export all primary types // Re-export all primary types
pub use route_types::*; pub use route_types::*;
@@ -16,4 +15,3 @@ pub use proxy_options::*;
pub use tls_types::*; pub use tls_types::*;
pub use security_types::*; pub use security_types::*;
pub use validation::*; pub use validation::*;
pub use helpers::*;
+278 -19
View File
@@ -129,7 +129,6 @@ pub struct RustProxyOptions {
pub defaults: Option<DefaultConfig>, pub defaults: Option<DefaultConfig>,
// ─── Timeout Settings ──────────────────────────────────────────── // ─── Timeout Settings ────────────────────────────────────────────
/// Timeout for establishing connection to backend (ms), default: 30000 /// Timeout for establishing connection to backend (ms), default: 30000
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub connection_timeout: Option<u64>, pub connection_timeout: Option<u64>,
@@ -159,7 +158,6 @@ pub struct RustProxyOptions {
pub graceful_shutdown_timeout: Option<u64>, pub graceful_shutdown_timeout: Option<u64>,
// ─── Socket Optimization ───────────────────────────────────────── // ─── Socket Optimization ─────────────────────────────────────────
/// Disable Nagle's algorithm (default: true) /// Disable Nagle's algorithm (default: true)
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub no_delay: Option<bool>, pub no_delay: Option<bool>,
@@ -177,7 +175,6 @@ pub struct RustProxyOptions {
pub max_pending_data_size: Option<u64>, pub max_pending_data_size: Option<u64>,
// ─── Enhanced Features ─────────────────────────────────────────── // ─── Enhanced Features ───────────────────────────────────────────
/// Disable inactivity checking entirely /// Disable inactivity checking entirely
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub disable_inactivity_check: Option<bool>, pub disable_inactivity_check: Option<bool>,
@@ -199,7 +196,6 @@ pub struct RustProxyOptions {
pub enable_randomized_timeouts: Option<bool>, pub enable_randomized_timeouts: Option<bool>,
// ─── Rate Limiting ─────────────────────────────────────────────── // ─── Rate Limiting ───────────────────────────────────────────────
/// Maximum simultaneous connections from a single IP /// Maximum simultaneous connections from a single IP
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub max_connections_per_ip: Option<u64>, pub max_connections_per_ip: Option<u64>,
@@ -213,7 +209,6 @@ pub struct RustProxyOptions {
pub max_connections: Option<u64>, pub max_connections: Option<u64>,
// ─── Keep-Alive Settings ───────────────────────────────────────── // ─── Keep-Alive Settings ─────────────────────────────────────────
/// How to treat keep-alive connections /// How to treat keep-alive connections
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub keep_alive_treatment: Option<KeepAliveTreatment>, pub keep_alive_treatment: Option<KeepAliveTreatment>,
@@ -227,7 +222,6 @@ pub struct RustProxyOptions {
pub extended_keep_alive_lifetime: Option<u64>, pub extended_keep_alive_lifetime: Option<u64>,
// ─── HttpProxy Integration ─────────────────────────────────────── // ─── HttpProxy Integration ───────────────────────────────────────
/// Array of ports to forward to HttpProxy /// Array of ports to forward to HttpProxy
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub use_http_proxy: Option<Vec<u16>>, pub use_http_proxy: Option<Vec<u16>>,
@@ -237,13 +231,11 @@ pub struct RustProxyOptions {
pub http_proxy_port: Option<u16>, pub http_proxy_port: Option<u16>,
// ─── Metrics ───────────────────────────────────────────────────── // ─── Metrics ─────────────────────────────────────────────────────
/// Metrics configuration /// Metrics configuration
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub metrics: Option<MetricsConfig>, pub metrics: Option<MetricsConfig>,
// ─── ACME ──────────────────────────────────────────────────────── // ─── ACME ────────────────────────────────────────────────────────
/// Global ACME configuration /// Global ACME configuration
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub acme: Option<AcmeOptions>, pub acme: Option<AcmeOptions>,
@@ -318,7 +310,8 @@ impl RustProxyOptions {
/// Get all unique ports that routes listen on. /// Get all unique ports that routes listen on.
pub fn all_listening_ports(&self) -> Vec<u16> { pub fn all_listening_ports(&self) -> Vec<u16> {
let mut ports: Vec<u16> = self.routes let mut ports: Vec<u16> = self
.routes
.iter() .iter()
.flat_map(|r| r.listening_ports()) .flat_map(|r| r.listening_ports())
.collect(); .collect();
@@ -331,12 +324,73 @@ impl RustProxyOptions {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use crate::helpers::*; use crate::route_types::*;
use crate::tls_types::*;
fn make_route(domain: &str, host: &str, port: u16, listen_port: u16) -> RouteConfig {
RouteConfig {
id: None,
route_match: RouteMatch {
ports: PortRange::Single(listen_port),
domains: Some(DomainSpec::Single(domain.to_string())),
path: None,
client_ip: None,
transport: None,
tls_version: None,
headers: None,
protocol: None,
},
action: RouteAction {
action_type: RouteActionType::Forward,
targets: Some(vec![RouteTarget {
target_match: None,
host: HostSpec::Single(host.to_string()),
port: PortSpec::Fixed(port),
tls: None,
websocket: None,
load_balancing: None,
send_proxy_protocol: None,
headers: None,
advanced: None,
backend_transport: None,
priority: None,
}]),
tls: None,
websocket: None,
load_balancing: None,
advanced: None,
options: None,
send_proxy_protocol: None,
udp: None,
},
headers: None,
security: None,
name: None,
description: None,
priority: None,
tags: None,
enabled: None,
}
}
fn make_passthrough_route(domain: &str, host: &str, port: u16) -> RouteConfig {
let mut route = make_route(domain, host, port, 443);
route.action.tls = Some(RouteTls {
mode: TlsMode::Passthrough,
certificate: None,
acme: None,
versions: None,
ciphers: None,
honor_cipher_order: None,
session_timeout: None,
});
route
}
#[test] #[test]
fn test_serde_roundtrip_minimal() { fn test_serde_roundtrip_minimal() {
let options = RustProxyOptions { let options = RustProxyOptions {
routes: vec![create_http_route("example.com", "localhost", 8080)], routes: vec![make_route("example.com", "localhost", 8080, 80)],
..Default::default() ..Default::default()
}; };
let json = serde_json::to_string(&options).unwrap(); let json = serde_json::to_string(&options).unwrap();
@@ -348,8 +402,8 @@ mod tests {
fn test_serde_roundtrip_full() { fn test_serde_roundtrip_full() {
let options = RustProxyOptions { let options = RustProxyOptions {
routes: vec![ routes: vec![
create_http_route("a.com", "backend1", 8080), make_route("a.com", "backend1", 8080, 80),
create_https_passthrough_route("b.com", "backend2", 443), make_passthrough_route("b.com", "backend2", 443),
], ],
connection_timeout: Some(5000), connection_timeout: Some(5000),
socket_timeout: Some(60000), socket_timeout: Some(60000),
@@ -374,6 +428,209 @@ mod tests {
assert_eq!(parsed.connection_timeout, Some(5000)); assert_eq!(parsed.connection_timeout, Some(5000));
} }
#[test]
fn test_deserialize_ts_contract_route_shapes() {
let value = serde_json::json!({
"routes": [{
"name": "contract-route",
"match": {
"ports": [443, { "from": 8443, "to": 8444 }],
"domains": ["api.example.com", "*.example.com"],
"transport": "udp",
"protocol": "http3",
"headers": {
"content-type": "/^application\\/json$/i"
}
},
"action": {
"type": "forward",
"targets": [{
"match": {
"ports": [443],
"path": "/api/*",
"method": ["GET"],
"headers": {
"x-env": "/^(prod|stage)$/"
}
},
"host": ["backend-a", "backend-b"],
"port": "preserve",
"sendProxyProtocol": true,
"backendTransport": "tcp"
}],
"tls": {
"mode": "terminate",
"certificate": "auto"
},
"sendProxyProtocol": true,
"udp": {
"maxSessionsPerIp": 321,
"quic": {
"enableHttp3": true
}
}
},
"security": {
"ipAllowList": [{
"ip": "10.0.0.0/8",
"domains": ["api.example.com"]
}]
}
}],
"preserveSourceIp": true,
"proxyIps": ["10.0.0.1"],
"acceptProxyProtocol": true,
"sendProxyProtocol": true,
"noDelay": true,
"keepAlive": true,
"keepAliveInitialDelay": 1500,
"maxPendingDataSize": 4096,
"disableInactivityCheck": true,
"enableKeepAliveProbes": true,
"enableDetailedLogging": true,
"enableTlsDebugLogging": true,
"enableRandomizedTimeouts": true,
"connectionTimeout": 5000,
"initialDataTimeout": 7000,
"socketTimeout": 9000,
"inactivityCheckInterval": 1100,
"maxConnectionLifetime": 13000,
"inactivityTimeout": 15000,
"gracefulShutdownTimeout": 17000,
"maxConnectionsPerIp": 20,
"connectionRateLimitPerMinute": 30,
"keepAliveTreatment": "extended",
"keepAliveInactivityMultiplier": 2.0,
"extendedKeepAliveLifetime": 19000,
"metrics": {
"enabled": true,
"sampleIntervalMs": 250,
"retentionSeconds": 60
},
"acme": {
"enabled": true,
"email": "ops@example.com",
"environment": "staging",
"useProduction": false,
"skipConfiguredCerts": true,
"renewThresholdDays": 14,
"renewCheckIntervalHours": 12,
"autoRenew": true,
"port": 80
}
});
let options: RustProxyOptions = serde_json::from_value(value).unwrap();
assert_eq!(options.routes.len(), 1);
assert_eq!(options.preserve_source_ip, Some(true));
assert_eq!(options.proxy_ips, Some(vec!["10.0.0.1".to_string()]));
assert_eq!(options.accept_proxy_protocol, Some(true));
assert_eq!(options.send_proxy_protocol, Some(true));
assert_eq!(options.no_delay, Some(true));
assert_eq!(options.keep_alive, Some(true));
assert_eq!(options.keep_alive_initial_delay, Some(1500));
assert_eq!(options.max_pending_data_size, Some(4096));
assert_eq!(options.disable_inactivity_check, Some(true));
assert_eq!(options.enable_keep_alive_probes, Some(true));
assert_eq!(options.enable_detailed_logging, Some(true));
assert_eq!(options.enable_tls_debug_logging, Some(true));
assert_eq!(options.enable_randomized_timeouts, Some(true));
assert_eq!(options.connection_timeout, Some(5000));
assert_eq!(options.initial_data_timeout, Some(7000));
assert_eq!(options.socket_timeout, Some(9000));
assert_eq!(options.inactivity_check_interval, Some(1100));
assert_eq!(options.max_connection_lifetime, Some(13000));
assert_eq!(options.inactivity_timeout, Some(15000));
assert_eq!(options.graceful_shutdown_timeout, Some(17000));
assert_eq!(options.max_connections_per_ip, Some(20));
assert_eq!(options.connection_rate_limit_per_minute, Some(30));
assert_eq!(
options.keep_alive_treatment,
Some(KeepAliveTreatment::Extended)
);
assert_eq!(options.keep_alive_inactivity_multiplier, Some(2.0));
assert_eq!(options.extended_keep_alive_lifetime, Some(19000));
let route = &options.routes[0];
assert_eq!(route.route_match.transport, Some(TransportProtocol::Udp));
assert_eq!(route.route_match.protocol.as_deref(), Some("http3"));
assert_eq!(
route
.route_match
.headers
.as_ref()
.unwrap()
.get("content-type")
.unwrap(),
"/^application\\/json$/i"
);
let target = &route.action.targets.as_ref().unwrap()[0];
assert!(matches!(target.host, HostSpec::List(_)));
assert!(matches!(target.port, PortSpec::Special(ref p) if p == "preserve"));
assert_eq!(target.backend_transport, Some(TransportProtocol::Tcp));
assert_eq!(target.send_proxy_protocol, Some(true));
assert_eq!(
target
.target_match
.as_ref()
.unwrap()
.headers
.as_ref()
.unwrap()
.get("x-env")
.unwrap(),
"/^(prod|stage)$/"
);
assert_eq!(route.action.send_proxy_protocol, Some(true));
assert_eq!(
route.action.udp.as_ref().unwrap().max_sessions_per_ip,
Some(321)
);
assert_eq!(
route
.action
.udp
.as_ref()
.unwrap()
.quic
.as_ref()
.unwrap()
.enable_http3,
Some(true)
);
let allow_list = route
.security
.as_ref()
.unwrap()
.ip_allow_list
.as_ref()
.unwrap();
assert!(matches!(
&allow_list[0],
crate::security_types::IpAllowEntry::DomainScoped { ip, domains }
if ip == "10.0.0.0/8" && domains == &vec!["api.example.com".to_string()]
));
let metrics = options.metrics.as_ref().unwrap();
assert_eq!(metrics.enabled, Some(true));
assert_eq!(metrics.sample_interval_ms, Some(250));
assert_eq!(metrics.retention_seconds, Some(60));
let acme = options.acme.as_ref().unwrap();
assert_eq!(acme.enabled, Some(true));
assert_eq!(acme.email.as_deref(), Some("ops@example.com"));
assert_eq!(acme.environment, Some(AcmeEnvironment::Staging));
assert_eq!(acme.use_production, Some(false));
assert_eq!(acme.skip_configured_certs, Some(true));
assert_eq!(acme.renew_threshold_days, Some(14));
assert_eq!(acme.renew_check_interval_hours, Some(12));
assert_eq!(acme.auto_renew, Some(true));
assert_eq!(acme.port, Some(80));
}
#[test] #[test]
fn test_default_timeouts() { fn test_default_timeouts() {
let options = RustProxyOptions::default(); let options = RustProxyOptions::default();
@@ -402,9 +659,9 @@ mod tests {
fn test_all_listening_ports() { fn test_all_listening_ports() {
let options = RustProxyOptions { let options = RustProxyOptions {
routes: vec![ routes: vec![
create_http_route("a.com", "backend", 8080), // port 80 make_route("a.com", "backend", 8080, 80), // port 80
create_https_passthrough_route("b.com", "backend", 443), // port 443 make_passthrough_route("b.com", "backend", 443), // port 443
create_http_route("c.com", "backend", 9090), // port 80 (duplicate) make_route("c.com", "backend", 9090, 80), // port 80 (duplicate)
], ],
..Default::default() ..Default::default()
}; };
@@ -428,9 +685,11 @@ mod tests {
#[test] #[test]
fn test_deserialize_example_json() { fn test_deserialize_example_json() {
let content = std::fs::read_to_string( let content = std::fs::read_to_string(concat!(
concat!(env!("CARGO_MANIFEST_DIR"), "/../../config/example.json") env!("CARGO_MANIFEST_DIR"),
).unwrap(); "/../../config/example.json"
))
.unwrap();
let options: RustProxyOptions = serde_json::from_str(&content).unwrap(); let options: RustProxyOptions = serde_json::from_str(&content).unwrap();
assert_eq!(options.routes.len(), 4); assert_eq!(options.routes.len(), 4);
let ports = options.all_listening_ports(); let ports = options.all_listening_ports();
+33 -56
View File
@@ -1,8 +1,8 @@
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use std::collections::HashMap; use std::collections::HashMap;
use crate::tls_types::RouteTls;
use crate::security_types::RouteSecurity; use crate::security_types::RouteSecurity;
use crate::tls_types::RouteTls;
// ─── Port Range ────────────────────────────────────────────────────── // ─── Port Range ──────────────────────────────────────────────────────
@@ -32,12 +32,13 @@ impl PortRange {
pub fn to_ports(&self) -> Vec<u16> { pub fn to_ports(&self) -> Vec<u16> {
match self { match self {
PortRange::Single(p) => vec![*p], PortRange::Single(p) => vec![*p],
PortRange::List(items) => { PortRange::List(items) => items
items.iter().flat_map(|item| match item { .iter()
.flat_map(|item| match item {
PortRangeItem::Port(p) => vec![*p], PortRangeItem::Port(p) => vec![*p],
PortRangeItem::Range(r) => (r.from..=r.to).collect(), PortRangeItem::Range(r) => (r.from..=r.to).collect(),
}).collect() })
} .collect(),
} }
} }
} }
@@ -60,16 +61,6 @@ pub enum RouteActionType {
SocketHandler, SocketHandler,
} }
// ─── Forwarding Engine ───────────────────────────────────────────────
/// Forwarding engine specification.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum ForwardingEngine {
Node,
Nftables,
}
// ─── Route Match ───────────────────────────────────────────────────── // ─── Route Match ─────────────────────────────────────────────────────
/// Domain specification: single string or array. /// Domain specification: single string or array.
@@ -89,8 +80,34 @@ impl DomainSpec {
} }
} }
// Convenience conversions for DomainSpec
impl From<&str> for DomainSpec {
fn from(s: &str) -> Self {
DomainSpec::Single(s.to_string())
}
}
impl From<String> for DomainSpec {
fn from(s: String) -> Self {
DomainSpec::Single(s)
}
}
impl From<Vec<String>> for DomainSpec {
fn from(v: Vec<String>) -> Self {
DomainSpec::List(v)
}
}
impl From<Vec<&str>> for DomainSpec {
fn from(v: Vec<&str>) -> Self {
DomainSpec::List(v.into_iter().map(|s| s.to_string()).collect())
}
}
/// Header match value: either exact string or regex pattern. /// Header match value: either exact string or regex pattern.
/// In JSON, all values come as strings. Regex patterns are prefixed with `/` and suffixed with `/`. /// In JSON, all values come as strings. Regex patterns use JS-style literal syntax,
/// e.g. `/^application\/json$/` or `/^application\/json$/i`.
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)] #[serde(untagged)]
pub enum HeaderMatchValue { pub enum HeaderMatchValue {
@@ -341,38 +358,6 @@ pub struct RouteAdvanced {
pub url_rewrite: Option<RouteUrlRewrite>, pub url_rewrite: Option<RouteUrlRewrite>,
} }
// ─── NFTables Options ────────────────────────────────────────────────
/// NFTables protocol type.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum NfTablesProtocol {
Tcp,
Udp,
All,
}
/// NFTables-specific configuration options.
/// Matches TypeScript: `INfTablesOptions`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NfTablesOptions {
#[serde(skip_serializing_if = "Option::is_none")]
pub preserve_source_ip: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub protocol: Option<NfTablesProtocol>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_rate: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub priority: Option<i32>,
#[serde(skip_serializing_if = "Option::is_none")]
pub table_name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub use_ip_sets: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub use_advanced_nat: Option<bool>,
}
// ─── Backend Protocol ──────────────────────────────────────────────── // ─── Backend Protocol ────────────────────────────────────────────────
/// Backend protocol. /// Backend protocol.
@@ -541,14 +526,6 @@ pub struct RouteAction {
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub options: Option<ActionOptions>, pub options: Option<ActionOptions>,
/// Forwarding engine specification
#[serde(skip_serializing_if = "Option::is_none")]
pub forwarding_engine: Option<ForwardingEngine>,
/// NFTables-specific options
#[serde(skip_serializing_if = "Option::is_none")]
pub nftables: Option<NfTablesOptions>,
/// PROXY protocol support (default for all targets) /// PROXY protocol support (default for all targets)
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub send_proxy_protocol: Option<bool>, pub send_proxy_protocol: Option<bool>,
@@ -103,14 +103,30 @@ pub struct JwtAuthConfig {
pub exclude_paths: Option<Vec<String>>, pub exclude_paths: Option<Vec<String>>,
} }
/// An entry in the IP allow list: either a plain IP/CIDR string
/// or a domain-scoped entry that restricts the IP to specific domains.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum IpAllowEntry {
/// Plain IP/CIDR — allowed for all domains on this route
Plain(String),
/// Domain-scoped — allowed only when the requested domain matches
DomainScoped {
ip: String,
domains: Vec<String>,
},
}
/// Security options for routes. /// Security options for routes.
/// Matches TypeScript: `IRouteSecurity` /// Matches TypeScript: `IRouteSecurity`
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct RouteSecurity { pub struct RouteSecurity {
/// IP addresses that are allowed to connect /// IP addresses that are allowed to connect.
/// Entries can be plain strings (full route access) or objects with
/// `{ ip, domains }` to scope access to specific domains.
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub ip_allow_list: Option<Vec<String>>, pub ip_allow_list: Option<Vec<IpAllowEntry>>,
/// IP addresses that are blocked from connecting /// IP addresses that are blocked from connecting
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub ip_block_list: Option<Vec<String>>, pub ip_block_list: Option<Vec<String>>,
+43 -1
View File
@@ -104,7 +104,49 @@ mod tests {
use crate::route_types::*; use crate::route_types::*;
fn make_valid_route() -> RouteConfig { fn make_valid_route() -> RouteConfig {
crate::helpers::create_http_route("example.com", "localhost", 8080) RouteConfig {
id: None,
route_match: RouteMatch {
ports: PortRange::Single(80),
domains: Some(DomainSpec::Single("example.com".to_string())),
path: None,
client_ip: None,
transport: None,
tls_version: None,
headers: None,
protocol: None,
},
action: RouteAction {
action_type: RouteActionType::Forward,
targets: Some(vec![RouteTarget {
target_match: None,
host: HostSpec::Single("localhost".to_string()),
port: PortSpec::Fixed(8080),
tls: None,
websocket: None,
load_balancing: None,
send_proxy_protocol: None,
headers: None,
advanced: None,
backend_transport: None,
priority: None,
}]),
tls: None,
websocket: None,
load_balancing: None,
advanced: None,
options: None,
send_proxy_protocol: None,
udp: None,
},
headers: None,
security: None,
name: None,
description: None,
priority: None,
tags: None,
enabled: None,
}
} }
#[test] #[test]
+1
View File
@@ -30,3 +30,4 @@ socket2 = { workspace = true }
quinn = { workspace = true } quinn = { workspace = true }
h3 = { workspace = true } h3 = { workspace = true }
h3-quinn = { workspace = true } h3-quinn = { workspace = true }
futures = { version = "0.3", default-features = false, features = ["std"] }
@@ -3,8 +3,8 @@
//! Reuses idle keep-alive connections to avoid per-request TCP+TLS handshakes. //! Reuses idle keep-alive connections to avoid per-request TCP+TLS handshakes.
//! HTTP/2 and HTTP/3 connections are multiplexed (clone the sender / share the connection). //! HTTP/2 and HTTP/3 connections are multiplexed (clone the sender / share the connection).
use std::sync::Arc;
use std::sync::atomic::{AtomicU64, Ordering}; use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use bytes::Bytes; use bytes::Bytes;
@@ -56,7 +56,11 @@ struct PooledH2 {
} }
/// A pooled QUIC/HTTP/3 connection (multiplexed like H2). /// A pooled QUIC/HTTP/3 connection (multiplexed like H2).
/// Stores the h3 `SendRequest` handle so pool hits skip the h3 SETTINGS handshake.
pub struct PooledH3 { pub struct PooledH3 {
/// Multiplexed h3 request handle — clone to open a new stream.
pub send_request: h3::client::SendRequest<h3_quinn::OpenStreams, Bytes>,
/// Raw QUIC connection — kept for liveness probing (close_reason) only.
pub connection: quinn::Connection, pub connection: quinn::Connection,
pub created_at: Instant, pub created_at: Instant,
pub generation: u64, pub generation: u64,
@@ -101,13 +105,19 @@ impl ConnectionPool {
/// Try to check out an idle HTTP/1.1 sender for the given key. /// Try to check out an idle HTTP/1.1 sender for the given key.
/// Returns `None` if no usable idle connection exists. /// Returns `None` if no usable idle connection exists.
pub fn checkout_h1(&self, key: &PoolKey) -> Option<http1::SendRequest<BoxBody<Bytes, hyper::Error>>> { pub fn checkout_h1(
&self,
key: &PoolKey,
) -> Option<http1::SendRequest<BoxBody<Bytes, hyper::Error>>> {
let mut entry = self.h1_pool.get_mut(key)?; let mut entry = self.h1_pool.get_mut(key)?;
let idles = entry.value_mut(); let idles = entry.value_mut();
while let Some(idle) = idles.pop() { while let Some(idle) = idles.pop() {
// Check if the connection is still alive and ready // Check if the connection is still alive and ready
if idle.idle_since.elapsed() < IDLE_TIMEOUT && idle.sender.is_ready() && !idle.sender.is_closed() { if idle.idle_since.elapsed() < IDLE_TIMEOUT
&& idle.sender.is_ready()
&& !idle.sender.is_closed()
{
// H1 pool hit — no logging on hot path // H1 pool hit — no logging on hot path
return Some(idle.sender); return Some(idle.sender);
} }
@@ -124,7 +134,11 @@ impl ConnectionPool {
/// Return an HTTP/1.1 sender to the pool after the response body has been prepared. /// Return an HTTP/1.1 sender to the pool after the response body has been prepared.
/// The caller should NOT call this if the sender is closed or not ready. /// The caller should NOT call this if the sender is closed or not ready.
pub fn checkin_h1(&self, key: PoolKey, sender: http1::SendRequest<BoxBody<Bytes, hyper::Error>>) { pub fn checkin_h1(
&self,
key: PoolKey,
sender: http1::SendRequest<BoxBody<Bytes, hyper::Error>>,
) {
if sender.is_closed() || !sender.is_ready() { if sender.is_closed() || !sender.is_ready() {
return; // Don't pool broken connections return; // Don't pool broken connections
} }
@@ -141,7 +155,10 @@ impl ConnectionPool {
/// Try to get a cloned HTTP/2 sender for the given key. /// Try to get a cloned HTTP/2 sender for the given key.
/// HTTP/2 senders are Clone-able (multiplexed), so we clone rather than remove. /// HTTP/2 senders are Clone-able (multiplexed), so we clone rather than remove.
pub fn checkout_h2(&self, key: &PoolKey) -> Option<(http2::SendRequest<BoxBody<Bytes, hyper::Error>>, Duration)> { pub fn checkout_h2(
&self,
key: &PoolKey,
) -> Option<(http2::SendRequest<BoxBody<Bytes, hyper::Error>>, Duration)> {
let entry = self.h2_pool.get(key)?; let entry = self.h2_pool.get(key)?;
let pooled = entry.value(); let pooled = entry.value();
let age = pooled.created_at.elapsed(); let age = pooled.created_at.elapsed();
@@ -180,16 +197,23 @@ impl ConnectionPool {
/// Register an HTTP/2 sender in the pool. Returns the generation ID for this entry. /// Register an HTTP/2 sender in the pool. Returns the generation ID for this entry.
/// The caller should pass this generation to the connection driver so it can use /// The caller should pass this generation to the connection driver so it can use
/// `remove_h2_if_generation` instead of `remove_h2` to avoid phantom eviction. /// `remove_h2_if_generation` instead of `remove_h2` to avoid phantom eviction.
pub fn register_h2(&self, key: PoolKey, sender: http2::SendRequest<BoxBody<Bytes, hyper::Error>>) -> u64 { pub fn register_h2(
&self,
key: PoolKey,
sender: http2::SendRequest<BoxBody<Bytes, hyper::Error>>,
) -> u64 {
let gen = self.h2_generation.fetch_add(1, Ordering::Relaxed); let gen = self.h2_generation.fetch_add(1, Ordering::Relaxed);
if sender.is_closed() { if sender.is_closed() {
return gen; return gen;
} }
self.h2_pool.insert(key, PooledH2 { self.h2_pool.insert(
sender, key,
created_at: Instant::now(), PooledH2 {
generation: gen, sender,
}); created_at: Instant::now(),
generation: gen,
},
);
gen gen
} }
@@ -197,7 +221,14 @@ impl ConnectionPool {
/// Try to get a pooled QUIC connection for the given key. /// Try to get a pooled QUIC connection for the given key.
/// QUIC connections are multiplexed — the connection is shared, not removed. /// QUIC connections are multiplexed — the connection is shared, not removed.
pub fn checkout_h3(&self, key: &PoolKey) -> Option<(quinn::Connection, Duration)> { pub fn checkout_h3(
&self,
key: &PoolKey,
) -> Option<(
h3::client::SendRequest<h3_quinn::OpenStreams, Bytes>,
quinn::Connection,
Duration,
)> {
let entry = self.h3_pool.get(key)?; let entry = self.h3_pool.get(key)?;
let pooled = entry.value(); let pooled = entry.value();
let age = pooled.created_at.elapsed(); let age = pooled.created_at.elapsed();
@@ -215,17 +246,27 @@ impl ConnectionPool {
return None; return None;
} }
Some((pooled.connection.clone(), age)) Some((pooled.send_request.clone(), pooled.connection.clone(), age))
} }
/// Register a QUIC connection in the pool. Returns the generation ID. /// Register a QUIC connection and its h3 SendRequest handle in the pool.
pub fn register_h3(&self, key: PoolKey, connection: quinn::Connection) -> u64 { /// Returns the generation ID.
pub fn register_h3(
&self,
key: PoolKey,
connection: quinn::Connection,
send_request: h3::client::SendRequest<h3_quinn::OpenStreams, Bytes>,
) -> u64 {
let gen = self.h2_generation.fetch_add(1, Ordering::Relaxed); let gen = self.h2_generation.fetch_add(1, Ordering::Relaxed);
self.h3_pool.insert(key, PooledH3 { self.h3_pool.insert(
connection, key,
created_at: Instant::now(), PooledH3 {
generation: gen, send_request,
}); connection,
created_at: Instant::now(),
generation: gen,
},
);
gen gen
} }
@@ -266,7 +307,9 @@ impl ConnectionPool {
// Evict dead or aged-out H2 connections // Evict dead or aged-out H2 connections
let mut dead_h2 = Vec::new(); let mut dead_h2 = Vec::new();
for entry in h2_pool.iter() { for entry in h2_pool.iter() {
if entry.value().sender.is_closed() || entry.value().created_at.elapsed() >= MAX_H2_AGE { if entry.value().sender.is_closed()
|| entry.value().created_at.elapsed() >= MAX_H2_AGE
{
dead_h2.push(entry.key().clone()); dead_h2.push(entry.key().clone());
} }
} }
@@ -1,8 +1,8 @@
//! A body wrapper that counts bytes flowing through and reports them to MetricsCollector. //! A body wrapper that counts bytes flowing through and reports them to MetricsCollector.
use std::pin::Pin; use std::pin::Pin;
use std::sync::Arc;
use std::sync::atomic::{AtomicU64, Ordering}; use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;
use std::task::{Context, Poll}; use std::task::{Context, Poll};
use bytes::Bytes; use bytes::Bytes;
@@ -76,7 +76,11 @@ impl<B> CountingBody<B> {
/// Set the connection-level activity tracker. When set, each data frame /// Set the connection-level activity tracker. When set, each data frame
/// updates this timestamp to prevent the idle watchdog from killing the /// updates this timestamp to prevent the idle watchdog from killing the
/// connection during active body streaming. /// connection during active body streaming.
pub fn with_connection_activity(mut self, activity: Arc<AtomicU64>, start: std::time::Instant) -> Self { pub fn with_connection_activity(
mut self,
activity: Arc<AtomicU64>,
start: std::time::Instant,
) -> Self {
self.connection_activity = Some(activity); self.connection_activity = Some(activity);
self.activity_start = Some(start); self.activity_start = Some(start);
self self
@@ -134,7 +138,9 @@ where
} }
// Keep the connection-level idle watchdog alive on every frame // Keep the connection-level idle watchdog alive on every frame
// (this is just one atomic store — cheap enough per-frame) // (this is just one atomic store — cheap enough per-frame)
if let (Some(activity), Some(start)) = (&this.connection_activity, &this.activity_start) { if let (Some(activity), Some(start)) =
(&this.connection_activity, &this.activity_start)
{
activity.store(start.elapsed().as_millis() as u64, Ordering::Relaxed); activity.store(start.elapsed().as_millis() as u64, Ordering::Relaxed);
} }
} }
+34 -14
View File
@@ -11,14 +11,14 @@ use std::task::{Context, Poll};
use bytes::{Buf, Bytes}; use bytes::{Buf, Bytes};
use http_body::Frame; use http_body::Frame;
use http_body_util::BodyExt;
use http_body_util::combinators::BoxBody; use http_body_util::combinators::BoxBody;
use http_body_util::BodyExt;
use tracing::{debug, warn}; use tracing::{debug, warn};
use rustproxy_config::RouteConfig; use rustproxy_config::RouteConfig;
use tokio_util::sync::CancellationToken; use tokio_util::sync::CancellationToken;
use crate::proxy_service::{ConnActivity, HttpProxyService}; use crate::proxy_service::{ConnActivity, HttpProxyService, ProtocolGuard};
/// HTTP/3 proxy service. /// HTTP/3 proxy service.
/// ///
@@ -48,6 +48,10 @@ impl H3ProxyService {
let remote_addr = real_client_addr.unwrap_or_else(|| connection.remote_address()); let remote_addr = real_client_addr.unwrap_or_else(|| connection.remote_address());
debug!("HTTP/3 connection from {} on port {}", remote_addr, port); debug!("HTTP/3 connection from {} on port {}", remote_addr, port);
// Track frontend H3 connection for the QUIC connection's lifetime.
let _frontend_h3_guard =
ProtocolGuard::frontend(Arc::clone(self.http_proxy.metrics()), "h3");
let mut h3_conn: h3::server::Connection<h3_quinn::Connection, Bytes> = let mut h3_conn: h3::server::Connection<h3_quinn::Connection, Bytes> =
h3::server::builder() h3::server::builder()
.send_grease(false) .send_grease(false)
@@ -89,8 +93,15 @@ impl H3ProxyService {
tokio::spawn(async move { tokio::spawn(async move {
if let Err(e) = handle_h3_request( if let Err(e) = handle_h3_request(
request, stream, port, remote_addr, &http_proxy, request_cancel, request,
).await { stream,
port,
remote_addr,
&http_proxy,
request_cancel,
)
.await
{
debug!("HTTP/3 request error from {}: {}", remote_addr, e); debug!("HTTP/3 request error from {}: {}", remote_addr, e);
} }
}); });
@@ -116,7 +127,7 @@ async fn handle_h3_request(
cancel: CancellationToken, cancel: CancellationToken,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
// Stream request body from H3 client via an mpsc channel. // Stream request body from H3 client via an mpsc channel.
let (body_tx, body_rx) = tokio::sync::mpsc::channel::<Bytes>(4); let (body_tx, body_rx) = tokio::sync::mpsc::channel::<Bytes>(32);
// Spawn the H3 body reader task with cancellation // Spawn the H3 body reader task with cancellation
let body_cancel = cancel.clone(); let body_cancel = cancel.clone();
@@ -132,8 +143,7 @@ async fn handle_h3_request(
} }
}; };
let mut chunk = chunk; let mut chunk = chunk;
let data = Bytes::copy_from_slice(chunk.chunk()); let data = chunk.copy_to_bytes(chunk.remaining());
chunk.advance(chunk.remaining());
if body_tx.send(data).await.is_err() { if body_tx.send(data).await.is_err() {
break; break;
} }
@@ -151,11 +161,14 @@ async fn handle_h3_request(
// Delegate to HttpProxyService — same backend path as TCP/HTTP: // Delegate to HttpProxyService — same backend path as TCP/HTTP:
// route matching, ALPN protocol detection, connection pool, H1/H2/H3 auto. // route matching, ALPN protocol detection, connection pool, H1/H2/H3 auto.
let conn_activity = ConnActivity::new_standalone(); let conn_activity = ConnActivity::new_standalone();
let response = http_proxy.handle_request(req, peer_addr, port, cancel, conn_activity).await let response = http_proxy
.handle_request(req, peer_addr, port, cancel, conn_activity)
.await
.map_err(|e| anyhow::anyhow!("Backend request failed: {}", e))?; .map_err(|e| anyhow::anyhow!("Backend request failed: {}", e))?;
// Await the body reader to get the H3 stream back // Await the body reader to get the H3 stream back
let mut stream = body_reader.await let mut stream = body_reader
.await
.map_err(|e| anyhow::anyhow!("Body reader task failed: {}", e))?; .map_err(|e| anyhow::anyhow!("Body reader task failed: {}", e))?;
// Send response headers over H3 (skip hop-by-hop headers) // Send response headers over H3 (skip hop-by-hop headers)
@@ -168,10 +181,13 @@ async fn handle_h3_request(
} }
h3_response = h3_response.header(name, value); h3_response = h3_response.header(name, value);
} }
let h3_response = h3_response.body(()) let h3_response = h3_response
.body(())
.map_err(|e| anyhow::anyhow!("Failed to build H3 response: {}", e))?; .map_err(|e| anyhow::anyhow!("Failed to build H3 response: {}", e))?;
stream.send_response(h3_response).await stream
.send_response(h3_response)
.await
.map_err(|e| anyhow::anyhow!("Failed to send H3 response: {}", e))?; .map_err(|e| anyhow::anyhow!("Failed to send H3 response: {}", e))?;
// Stream response body back over H3 // Stream response body back over H3
@@ -179,8 +195,10 @@ async fn handle_h3_request(
while let Some(frame) = resp_body.frame().await { while let Some(frame) = resp_body.frame().await {
match frame { match frame {
Ok(frame) => { Ok(frame) => {
if let Some(data) = frame.data_ref() { if let Ok(data) = frame.into_data() {
stream.send_data(Bytes::copy_from_slice(data)).await stream
.send_data(data)
.await
.map_err(|e| anyhow::anyhow!("Failed to send H3 data: {}", e))?; .map_err(|e| anyhow::anyhow!("Failed to send H3 data: {}", e))?;
} }
} }
@@ -192,7 +210,9 @@ async fn handle_h3_request(
} }
// Finish the H3 stream (send QUIC FIN) // Finish the H3 stream (send QUIC FIN)
stream.finish().await stream
.finish()
.await
.map_err(|e| anyhow::anyhow!("Failed to finish H3 stream: {}", e))?; .map_err(|e| anyhow::anyhow!("Failed to finish H3 stream: {}", e))?;
Ok(()) Ok(())
+2 -1
View File
@@ -5,14 +5,15 @@
pub mod connection_pool; pub mod connection_pool;
pub mod counting_body; pub mod counting_body;
pub mod h3_service;
pub mod protocol_cache; pub mod protocol_cache;
pub mod proxy_service; pub mod proxy_service;
pub mod request_filter; pub mod request_filter;
mod request_host;
pub mod response_filter; pub mod response_filter;
pub mod shutdown_on_drop; pub mod shutdown_on_drop;
pub mod template; pub mod template;
pub mod upstream_selector; pub mod upstream_selector;
pub mod h3_service;
pub use connection_pool::*; pub use connection_pool::*;
pub use counting_body::*; pub use counting_body::*;
+207 -47
View File
@@ -1,20 +1,36 @@
//! Bounded, TTL-based protocol detection cache with generic failure suppression. //! Bounded, sliding-TTL protocol detection cache with periodic re-probing and failure suppression.
//! //!
//! Caches the detected protocol (H1, H2, or H3) per backend endpoint and requested //! Caches the detected protocol (H1, H2, or H3) per backend endpoint and requested
//! domain (host:port + requested_host). This prevents cache oscillation when multiple //! domain (host:port + requested_host). This prevents cache oscillation when multiple
//! frontend domains share the same backend but differ in protocol support. //! frontend domains share the same backend but differ in protocol support.
//! //!
//! ## Sliding TTL
//!
//! Each cache hit refreshes the entry's expiry timer (`last_accessed_at`). Entries
//! remain valid for up to 1 day of continuous use. Every 5 minutes, the next request
//! triggers an inline ALPN re-probe to verify the cached protocol is still correct.
//!
//! ## Upgrade signals //! ## Upgrade signals
//! //!
//! - ALPN (TLS handshake) → detects H2 vs H1 //! - ALPN (TLS handshake) → detects H2 vs H1
//! - Alt-Svc (response header) → advertises H3 //! - Alt-Svc (response header) → advertises H3
//! //!
//! ## Protocol transitions
//!
//! All protocol changes are logged at `info!()` level with the reason:
//! "Protocol transition: H1 → H2 because periodic ALPN re-probe"
//!
//! ## Failure suppression //! ## Failure suppression
//! //!
//! When a protocol fails, `record_failure()` prevents upgrade signals from //! When a protocol fails, `record_failure()` prevents upgrade signals from
//! re-introducing it until an escalating cooldown expires (5s → 10s → ... → 300s). //! re-introducing it until an escalating cooldown expires (5s → 10s → ... → 300s).
//! Within-request escalation is allowed via `can_retry()` after a 5s minimum gap. //! Within-request escalation is allowed via `can_retry()` after a 5s minimum gap.
//! //!
//! ## Total failure eviction
//!
//! When all protocols (H3, H2, H1) fail for a backend, the cache entry is evicted
//! entirely via `evict()`, forcing a fresh probe on the next request.
//!
//! Cascading: when a lower protocol also fails, higher protocol cooldowns are //! Cascading: when a lower protocol also fails, higher protocol cooldowns are
//! reduced to 5s remaining (not instant clear), preventing tight retry loops. //! reduced to 5s remaining (not instant clear), preventing tight retry loops.
@@ -22,11 +38,17 @@ use std::sync::Arc;
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use dashmap::DashMap; use dashmap::DashMap;
use tracing::debug; use tracing::{debug, info};
/// TTL for cached protocol detection results. /// Sliding TTL for cached protocol detection results.
/// After this duration, the next request will re-probe the backend. /// Entries that haven't been accessed for this duration are evicted.
const PROTOCOL_CACHE_TTL: Duration = Duration::from_secs(300); // 5 minutes /// Each `get()` call refreshes the timer (sliding window).
const PROTOCOL_CACHE_TTL: Duration = Duration::from_secs(86400); // 1 day
/// Interval between inline ALPN re-probes for H1/H2 entries.
/// When a cached entry's `last_probed_at` exceeds this, the next request
/// triggers an ALPN re-probe to verify the backend still speaks the same protocol.
const PROTOCOL_REPROBE_INTERVAL: Duration = Duration::from_secs(300); // 5 minutes
/// Maximum number of entries in the protocol cache. /// Maximum number of entries in the protocol cache.
const PROTOCOL_CACHE_MAX_ENTRIES: usize = 4096; const PROTOCOL_CACHE_MAX_ENTRIES: usize = 4096;
@@ -37,7 +59,7 @@ const PROTOCOL_CACHE_CLEANUP_INTERVAL: Duration = Duration::from_secs(60);
/// Minimum cooldown between retry attempts of a failed protocol. /// Minimum cooldown between retry attempts of a failed protocol.
const PROTOCOL_FAILURE_COOLDOWN: Duration = Duration::from_secs(5); const PROTOCOL_FAILURE_COOLDOWN: Duration = Duration::from_secs(5);
/// Maximum cooldown (escalation ceiling). Matches cache TTL. /// Maximum cooldown (escalation ceiling).
const PROTOCOL_FAILURE_MAX_COOLDOWN: Duration = Duration::from_secs(300); const PROTOCOL_FAILURE_MAX_COOLDOWN: Duration = Duration::from_secs(300);
/// Consecutive failure count at which cooldown reaches maximum. /// Consecutive failure count at which cooldown reaches maximum.
@@ -52,12 +74,26 @@ pub enum DetectedProtocol {
H3, H3,
} }
impl std::fmt::Display for DetectedProtocol {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
DetectedProtocol::H1 => write!(f, "H1"),
DetectedProtocol::H2 => write!(f, "H2"),
DetectedProtocol::H3 => write!(f, "H3"),
}
}
}
/// Result of a protocol cache lookup. /// Result of a protocol cache lookup.
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub struct CachedProtocol { pub struct CachedProtocol {
pub protocol: DetectedProtocol, pub protocol: DetectedProtocol,
/// For H3: the port advertised by Alt-Svc (may differ from TCP port). /// For H3: the port advertised by Alt-Svc (may differ from TCP port).
pub h3_port: Option<u16>, pub h3_port: Option<u16>,
/// True if the entry's `last_probed_at` exceeds `PROTOCOL_REPROBE_INTERVAL`.
/// Caller should perform an inline ALPN re-probe and call `update_probe_result()`.
/// Always `false` for H3 entries (H3 is discovered via Alt-Svc, not ALPN).
pub needs_reprobe: bool,
} }
/// Key for the protocol cache: (host, port, requested_host). /// Key for the protocol cache: (host, port, requested_host).
@@ -70,10 +106,15 @@ pub struct ProtocolCacheKey {
pub requested_host: Option<String>, pub requested_host: Option<String>,
} }
/// A cached protocol detection result with a timestamp. /// A cached protocol detection result with timestamps.
struct CachedEntry { struct CachedEntry {
protocol: DetectedProtocol, protocol: DetectedProtocol,
/// When this protocol was first detected (or last changed).
detected_at: Instant, detected_at: Instant,
/// Last time any request used this entry (sliding-window TTL).
last_accessed_at: Instant,
/// Last time an ALPN re-probe was performed for this entry.
last_probed_at: Instant,
/// For H3: the port advertised by Alt-Svc (may differ from TCP port). /// For H3: the port advertised by Alt-Svc (may differ from TCP port).
h3_port: Option<u16>, h3_port: Option<u16>,
} }
@@ -103,10 +144,14 @@ impl FailureState {
} }
fn all_expired(&self) -> bool { fn all_expired(&self) -> bool {
let h2_expired = self.h2.as_ref() let h2_expired = self
.h2
.as_ref()
.map(|r| r.failed_at.elapsed() >= r.cooldown) .map(|r| r.failed_at.elapsed() >= r.cooldown)
.unwrap_or(true); .unwrap_or(true);
let h3_expired = self.h3.as_ref() let h3_expired = self
.h3
.as_ref()
.map(|r| r.failed_at.elapsed() >= r.cooldown) .map(|r| r.failed_at.elapsed() >= r.cooldown)
.unwrap_or(true); .unwrap_or(true);
h2_expired && h3_expired h2_expired && h3_expired
@@ -138,6 +183,8 @@ pub struct ProtocolCacheEntry {
pub protocol: String, pub protocol: String,
pub h3_port: Option<u16>, pub h3_port: Option<u16>,
pub age_secs: u64, pub age_secs: u64,
pub last_accessed_secs: u64,
pub last_probed_secs: u64,
pub h2_suppressed: bool, pub h2_suppressed: bool,
pub h3_suppressed: bool, pub h3_suppressed: bool,
pub h2_cooldown_remaining_secs: Option<u64>, pub h2_cooldown_remaining_secs: Option<u64>,
@@ -154,11 +201,11 @@ fn escalate_cooldown(consecutive: u32) -> Duration {
Duration::from_secs(secs.min(PROTOCOL_FAILURE_MAX_COOLDOWN.as_secs())) Duration::from_secs(secs.min(PROTOCOL_FAILURE_MAX_COOLDOWN.as_secs()))
} }
/// Bounded, TTL-based protocol detection cache with failure suppression. /// Bounded, sliding-TTL protocol detection cache with failure suppression.
/// ///
/// Memory safety guarantees: /// Memory safety guarantees:
/// - Hard cap at `PROTOCOL_CACHE_MAX_ENTRIES` — cannot grow unboundedly. /// - Hard cap at `PROTOCOL_CACHE_MAX_ENTRIES` — cannot grow unboundedly.
/// - TTL expiry — stale entries naturally age out on lookup. /// - Sliding TTL expiry — entries age out after 1 day without access.
/// - Background cleanup task — proactively removes expired entries every 60s. /// - Background cleanup task — proactively removes expired entries every 60s.
/// - `clear()` — called on route updates to discard stale detections. /// - `clear()` — called on route updates to discard stale detections.
/// - `Drop` — aborts the background task to prevent dangling tokio tasks. /// - `Drop` — aborts the background task to prevent dangling tokio tasks.
@@ -190,15 +237,25 @@ impl ProtocolCache {
} }
/// Look up the cached protocol for a backend endpoint. /// Look up the cached protocol for a backend endpoint.
///
/// Returns `None` if not cached or expired (caller should probe via ALPN). /// Returns `None` if not cached or expired (caller should probe via ALPN).
/// On hit, refreshes `last_accessed_at` (sliding TTL) and sets `needs_reprobe`
/// if the entry hasn't been probed in over 5 minutes (H1/H2 only).
pub fn get(&self, key: &ProtocolCacheKey) -> Option<CachedProtocol> { pub fn get(&self, key: &ProtocolCacheKey) -> Option<CachedProtocol> {
let entry = self.cache.get(key)?; let mut entry = self.cache.get_mut(key)?;
if entry.detected_at.elapsed() < PROTOCOL_CACHE_TTL { if entry.last_accessed_at.elapsed() < PROTOCOL_CACHE_TTL {
debug!("Protocol cache hit: {:?} for {}:{} (requested: {:?})", // Refresh sliding TTL
entry.protocol, key.host, key.port, key.requested_host); entry.last_accessed_at = Instant::now();
// H3 is the ceiling — can't ALPN-probe for H3 (discovered via Alt-Svc).
// Only H1/H2 entries trigger periodic re-probing.
let needs_reprobe = entry.protocol != DetectedProtocol::H3
&& entry.last_probed_at.elapsed() >= PROTOCOL_REPROBE_INTERVAL;
Some(CachedProtocol { Some(CachedProtocol {
protocol: entry.protocol, protocol: entry.protocol,
h3_port: entry.h3_port, h3_port: entry.h3_port,
needs_reprobe,
}) })
} else { } else {
// Expired — remove and return None to trigger re-probe // Expired — remove and return None to trigger re-probe
@@ -214,7 +271,7 @@ impl ProtocolCache {
/// **Key semantic**: only suppresses if the protocol being inserted matches /// **Key semantic**: only suppresses if the protocol being inserted matches
/// a suppressed protocol. H1 inserts are NEVER suppressed — downgrades /// a suppressed protocol. H1 inserts are NEVER suppressed — downgrades
/// always succeed. /// always succeed.
pub fn insert(&self, key: ProtocolCacheKey, protocol: DetectedProtocol) -> bool { pub fn insert(&self, key: ProtocolCacheKey, protocol: DetectedProtocol, reason: &str) -> bool {
if self.is_suppressed(&key, protocol) { if self.is_suppressed(&key, protocol) {
debug!( debug!(
host = %key.host, port = %key.port, domain = ?key.requested_host, host = %key.host, port = %key.port, domain = ?key.requested_host,
@@ -223,13 +280,13 @@ impl ProtocolCache {
); );
return false; return false;
} }
self.insert_internal(key, protocol, None); self.insert_internal(key, protocol, None, reason);
true true
} }
/// Insert an H3 detection result with the Alt-Svc advertised port. /// Insert an H3 detection result with the Alt-Svc advertised port.
/// Returns `false` if H3 is suppressed. /// Returns `false` if H3 is suppressed.
pub fn insert_h3(&self, key: ProtocolCacheKey, h3_port: u16) -> bool { pub fn insert_h3(&self, key: ProtocolCacheKey, h3_port: u16, reason: &str) -> bool {
if self.is_suppressed(&key, DetectedProtocol::H3) { if self.is_suppressed(&key, DetectedProtocol::H3) {
debug!( debug!(
host = %key.host, port = %key.port, domain = ?key.requested_host, host = %key.host, port = %key.port, domain = ?key.requested_host,
@@ -237,10 +294,54 @@ impl ProtocolCache {
); );
return false; return false;
} }
self.insert_internal(key, DetectedProtocol::H3, Some(h3_port)); self.insert_internal(key, DetectedProtocol::H3, Some(h3_port), reason);
true true
} }
/// Update the cache after an inline ALPN re-probe completes.
///
/// Always updates `last_probed_at`. If the protocol changed, logs the transition
/// and updates the entry. Returns `Some(new_protocol)` if changed, `None` if unchanged.
pub fn update_probe_result(
&self,
key: &ProtocolCacheKey,
probed_protocol: DetectedProtocol,
reason: &str,
) -> Option<DetectedProtocol> {
if let Some(mut entry) = self.cache.get_mut(key) {
let old_protocol = entry.protocol;
entry.last_probed_at = Instant::now();
entry.last_accessed_at = Instant::now();
if old_protocol != probed_protocol {
info!(
host = %key.host, port = %key.port, domain = ?key.requested_host,
old = %old_protocol, new = %probed_protocol, reason = %reason,
"Protocol transition"
);
entry.protocol = probed_protocol;
entry.detected_at = Instant::now();
// Clear h3_port if downgrading from H3
if old_protocol == DetectedProtocol::H3 && probed_protocol != DetectedProtocol::H3 {
entry.h3_port = None;
}
return Some(probed_protocol);
}
debug!(
host = %key.host, port = %key.port, domain = ?key.requested_host,
protocol = %old_protocol, reason = %reason,
"Re-probe confirmed — no protocol change"
);
None
} else {
// Entry was evicted between the get() and the probe completing.
// Insert as a fresh entry.
self.insert_internal(key.clone(), probed_protocol, None, reason);
Some(probed_protocol)
}
}
/// Record a protocol failure. Future `insert()` calls for this protocol /// Record a protocol failure. Future `insert()` calls for this protocol
/// will be suppressed until the escalating cooldown expires. /// will be suppressed until the escalating cooldown expires.
/// ///
@@ -258,9 +359,13 @@ impl ProtocolCache {
let record = entry.get_mut(protocol); let record = entry.get_mut(protocol);
let (consecutive, new_cooldown) = match record { let (consecutive, new_cooldown) = match record {
Some(existing) if existing.failed_at.elapsed() < existing.cooldown.saturating_mul(2) => { Some(existing)
if existing.failed_at.elapsed() < existing.cooldown.saturating_mul(2) =>
{
// Still within the "recent" window — escalate // Still within the "recent" window — escalate
let c = existing.consecutive_failures.saturating_add(1) let c = existing
.consecutive_failures
.saturating_add(1)
.min(PROTOCOL_FAILURE_ESCALATION_CAP); .min(PROTOCOL_FAILURE_ESCALATION_CAP);
(c, escalate_cooldown(c)) (c, escalate_cooldown(c))
} }
@@ -281,7 +386,7 @@ impl ProtocolCache {
Self::reduce_cooldown_to(entry.h3.as_mut(), PROTOCOL_FAILURE_COOLDOWN); Self::reduce_cooldown_to(entry.h3.as_mut(), PROTOCOL_FAILURE_COOLDOWN);
} }
debug!( info!(
host = %key.host, port = %key.port, domain = ?key.requested_host, host = %key.host, port = %key.port, domain = ?key.requested_host,
protocol = ?protocol, protocol = ?protocol,
consecutive = consecutive, consecutive = consecutive,
@@ -297,8 +402,13 @@ impl ProtocolCache {
if protocol == DetectedProtocol::H1 { if protocol == DetectedProtocol::H1 {
return false; return false;
} }
self.failures.get(key) self.failures
.and_then(|entry| entry.get(protocol).map(|r| r.failed_at.elapsed() < r.cooldown)) .get(key)
.and_then(|entry| {
entry
.get(protocol)
.map(|r| r.failed_at.elapsed() < r.cooldown)
})
.unwrap_or(false) .unwrap_or(false)
} }
@@ -348,6 +458,17 @@ impl ProtocolCache {
} }
} }
/// Evict a cache entry entirely. Called when all protocol probes (H3, H2, H1)
/// have failed for a backend.
pub fn evict(&self, key: &ProtocolCacheKey) {
self.cache.remove(key);
self.failures.remove(key);
info!(
host = %key.host, port = %key.port, domain = ?key.requested_host,
"Cache entry evicted — all protocols failed"
);
}
/// Clear all entries. Called on route updates to discard stale detections. /// Clear all entries. Called on route updates to discard stale detections.
pub fn clear(&self) { pub fn clear(&self) {
self.cache.clear(); self.cache.clear();
@@ -356,19 +477,18 @@ impl ProtocolCache {
/// Snapshot all non-expired cache entries for metrics/UI display. /// Snapshot all non-expired cache entries for metrics/UI display.
pub fn snapshot(&self) -> Vec<ProtocolCacheEntry> { pub fn snapshot(&self) -> Vec<ProtocolCacheEntry> {
self.cache.iter() self.cache
.filter(|entry| entry.value().detected_at.elapsed() < PROTOCOL_CACHE_TTL) .iter()
.filter(|entry| entry.value().last_accessed_at.elapsed() < PROTOCOL_CACHE_TTL)
.map(|entry| { .map(|entry| {
let key = entry.key(); let key = entry.key();
let val = entry.value(); let val = entry.value();
let failure_info = self.failures.get(key); let failure_info = self.failures.get(key);
let (h2_sup, h2_cd, h2_cons) = Self::suppression_info( let (h2_sup, h2_cd, h2_cons) =
failure_info.as_deref().and_then(|f| f.h2.as_ref()), Self::suppression_info(failure_info.as_deref().and_then(|f| f.h2.as_ref()));
); let (h3_sup, h3_cd, h3_cons) =
let (h3_sup, h3_cd, h3_cons) = Self::suppression_info( Self::suppression_info(failure_info.as_deref().and_then(|f| f.h3.as_ref()));
failure_info.as_deref().and_then(|f| f.h3.as_ref()),
);
ProtocolCacheEntry { ProtocolCacheEntry {
host: key.host.clone(), host: key.host.clone(),
@@ -381,6 +501,8 @@ impl ProtocolCache {
}, },
h3_port: val.h3_port, h3_port: val.h3_port,
age_secs: val.detected_at.elapsed().as_secs(), age_secs: val.detected_at.elapsed().as_secs(),
last_accessed_secs: val.last_accessed_at.elapsed().as_secs(),
last_probed_secs: val.last_probed_at.elapsed().as_secs(),
h2_suppressed: h2_sup, h2_suppressed: h2_sup,
h3_suppressed: h3_sup, h3_suppressed: h3_sup,
h2_cooldown_remaining_secs: h2_cd, h2_cooldown_remaining_secs: h2_cd,
@@ -395,21 +517,50 @@ impl ProtocolCache {
// --- Internal helpers --- // --- Internal helpers ---
/// Insert a protocol detection result with an optional H3 port. /// Insert a protocol detection result with an optional H3 port.
/// Logs protocol transitions when overwriting an existing entry.
/// No suppression check — callers must check before calling. /// No suppression check — callers must check before calling.
fn insert_internal(&self, key: ProtocolCacheKey, protocol: DetectedProtocol, h3_port: Option<u16>) { fn insert_internal(
&self,
key: ProtocolCacheKey,
protocol: DetectedProtocol,
h3_port: Option<u16>,
reason: &str,
) {
// Check for existing entry to log protocol transitions
if let Some(existing) = self.cache.get(&key) {
if existing.protocol != protocol {
info!(
host = %key.host, port = %key.port, domain = ?key.requested_host,
old = %existing.protocol, new = %protocol, reason = %reason,
"Protocol transition"
);
}
drop(existing);
}
// Evict oldest entry if at capacity
if self.cache.len() >= PROTOCOL_CACHE_MAX_ENTRIES && !self.cache.contains_key(&key) { if self.cache.len() >= PROTOCOL_CACHE_MAX_ENTRIES && !self.cache.contains_key(&key) {
let oldest = self.cache.iter() let oldest = self
.min_by_key(|entry| entry.value().detected_at) .cache
.iter()
.min_by_key(|entry| entry.value().last_accessed_at)
.map(|entry| entry.key().clone()); .map(|entry| entry.key().clone());
if let Some(oldest_key) = oldest { if let Some(oldest_key) = oldest {
self.cache.remove(&oldest_key); self.cache.remove(&oldest_key);
} }
} }
self.cache.insert(key, CachedEntry {
protocol, let now = Instant::now();
detected_at: Instant::now(), self.cache.insert(
h3_port, key,
}); CachedEntry {
protocol,
detected_at: now,
last_accessed_at: now,
last_probed_at: now,
h3_port,
},
);
} }
/// Reduce a failure record's remaining cooldown to `target`, if it currently /// Reduce a failure record's remaining cooldown to `target`, if it currently
@@ -453,27 +604,35 @@ impl ProtocolCache {
loop { loop {
interval.tick().await; interval.tick().await;
// Clean expired cache entries // Clean expired cache entries (sliding TTL based on last_accessed_at)
let expired: Vec<ProtocolCacheKey> = cache.iter() let expired: Vec<ProtocolCacheKey> = cache
.filter(|entry| entry.value().detected_at.elapsed() >= PROTOCOL_CACHE_TTL) .iter()
.filter(|entry| entry.value().last_accessed_at.elapsed() >= PROTOCOL_CACHE_TTL)
.map(|entry| entry.key().clone()) .map(|entry| entry.key().clone())
.collect(); .collect();
if !expired.is_empty() { if !expired.is_empty() {
debug!("Protocol cache cleanup: removing {} expired entries", expired.len()); debug!(
"Protocol cache cleanup: removing {} expired entries",
expired.len()
);
for key in expired { for key in expired {
cache.remove(&key); cache.remove(&key);
} }
} }
// Clean fully-expired failure entries // Clean fully-expired failure entries
let expired_failures: Vec<ProtocolCacheKey> = failures.iter() let expired_failures: Vec<ProtocolCacheKey> = failures
.iter()
.filter(|entry| entry.value().all_expired()) .filter(|entry| entry.value().all_expired())
.map(|entry| entry.key().clone()) .map(|entry| entry.key().clone())
.collect(); .collect();
if !expired_failures.is_empty() { if !expired_failures.is_empty() {
debug!("Protocol cache cleanup: removing {} expired failure entries", expired_failures.len()); debug!(
"Protocol cache cleanup: removing {} expired failure entries",
expired_failures.len()
);
for key in expired_failures { for key in expired_failures {
failures.remove(&key); failures.remove(&key);
} }
@@ -481,7 +640,8 @@ impl ProtocolCache {
// Safety net: cap failures map at 2× max entries // Safety net: cap failures map at 2× max entries
if failures.len() > PROTOCOL_CACHE_MAX_ENTRIES * 2 { if failures.len() > PROTOCOL_CACHE_MAX_ENTRIES * 2 {
let oldest: Vec<ProtocolCacheKey> = failures.iter() let oldest: Vec<ProtocolCacheKey> = failures
.iter()
.filter(|e| e.value().all_expired()) .filter(|e| e.value().all_expired())
.map(|e| e.key().clone()) .map(|e| e.key().clone())
.take(failures.len() - PROTOCOL_CACHE_MAX_ENTRIES) .take(failures.len() - PROTOCOL_CACHE_MAX_ENTRIES)
File diff suppressed because it is too large Load Diff
+144 -39
View File
@@ -4,13 +4,15 @@ use std::net::SocketAddr;
use std::sync::Arc; use std::sync::Arc;
use bytes::Bytes; use bytes::Bytes;
use http_body_util::Full;
use http_body_util::BodyExt;
use hyper::{Request, Response, StatusCode};
use http_body_util::combinators::BoxBody; use http_body_util::combinators::BoxBody;
use http_body_util::BodyExt;
use http_body_util::Full;
use hyper::{Request, Response, StatusCode};
use rustproxy_config::RouteSecurity; use rustproxy_config::RouteSecurity;
use rustproxy_security::{IpFilter, BasicAuthValidator, JwtValidator, RateLimiter}; use rustproxy_security::{BasicAuthValidator, IpFilter, JwtValidator, RateLimiter};
use crate::request_host::extract_request_host;
pub struct RequestFilter; pub struct RequestFilter;
@@ -35,13 +37,14 @@ impl RequestFilter {
let client_ip = peer_addr.ip(); let client_ip = peer_addr.ip();
let request_path = req.uri().path(); let request_path = req.uri().path();
// IP filter // IP filter (domain-aware: use the same host extraction as route matching)
if security.ip_allow_list.is_some() || security.ip_block_list.is_some() { if security.ip_allow_list.is_some() || security.ip_block_list.is_some() {
let allow = security.ip_allow_list.as_deref().unwrap_or(&[]); let allow = security.ip_allow_list.as_deref().unwrap_or(&[]);
let block = security.ip_block_list.as_deref().unwrap_or(&[]); let block = security.ip_block_list.as_deref().unwrap_or(&[]);
let filter = IpFilter::new(allow, block); let filter = IpFilter::new(allow, block);
let normalized = IpFilter::normalize_ip(&client_ip); let normalized = IpFilter::normalize_ip(&client_ip);
if !filter.is_allowed(&normalized) { let host = extract_request_host(req);
if !filter.is_allowed_for_domain(&normalized, host) {
return Some(error_response(StatusCode::FORBIDDEN, "Access denied")); return Some(error_response(StatusCode::FORBIDDEN, "Access denied"));
} }
} }
@@ -55,16 +58,15 @@ impl RequestFilter {
!limiter.check(&key) !limiter.check(&key)
} else { } else {
// Create a per-check limiter (less ideal but works for non-shared case) // Create a per-check limiter (less ideal but works for non-shared case)
let limiter = RateLimiter::new( let limiter =
rate_limit_config.max_requests, RateLimiter::new(rate_limit_config.max_requests, rate_limit_config.window);
rate_limit_config.window,
);
let key = Self::rate_limit_key(rate_limit_config, req, peer_addr); let key = Self::rate_limit_key(rate_limit_config, req, peer_addr);
!limiter.check(&key) !limiter.check(&key)
}; };
if should_block { if should_block {
let message = rate_limit_config.error_message let message = rate_limit_config
.error_message
.as_deref() .as_deref()
.unwrap_or("Rate limit exceeded"); .unwrap_or("Rate limit exceeded");
return Some(error_response(StatusCode::TOO_MANY_REQUESTS, message)); return Some(error_response(StatusCode::TOO_MANY_REQUESTS, message));
@@ -80,36 +82,48 @@ impl RequestFilter {
if let Some(ref basic_auth) = security.basic_auth { if let Some(ref basic_auth) = security.basic_auth {
if basic_auth.enabled { if basic_auth.enabled {
// Check basic auth exclude paths // Check basic auth exclude paths
let skip_basic = basic_auth.exclude_paths.as_ref() let skip_basic = basic_auth
.exclude_paths
.as_ref()
.map(|paths| Self::path_matches_any(request_path, paths)) .map(|paths| Self::path_matches_any(request_path, paths))
.unwrap_or(false); .unwrap_or(false);
if !skip_basic { if !skip_basic {
let users: Vec<(String, String)> = basic_auth.users.iter() let users: Vec<(String, String)> = basic_auth
.users
.iter()
.map(|c| (c.username.clone(), c.password.clone())) .map(|c| (c.username.clone(), c.password.clone()))
.collect(); .collect();
let validator = BasicAuthValidator::new(users, basic_auth.realm.clone()); let validator = BasicAuthValidator::new(users, basic_auth.realm.clone());
let auth_header = req.headers() let auth_header = req
.headers()
.get("authorization") .get("authorization")
.and_then(|v| v.to_str().ok()); .and_then(|v| v.to_str().ok());
match auth_header { match auth_header {
Some(header) => { Some(header) => {
if validator.validate(header).is_none() { if validator.validate(header).is_none() {
return Some(Response::builder() return Some(
.status(StatusCode::UNAUTHORIZED) Response::builder()
.header("WWW-Authenticate", validator.www_authenticate()) .status(StatusCode::UNAUTHORIZED)
.body(boxed_body("Invalid credentials")) .header(
.unwrap()); "WWW-Authenticate",
validator.www_authenticate(),
)
.body(boxed_body("Invalid credentials"))
.unwrap(),
);
} }
} }
None => { None => {
return Some(Response::builder() return Some(
.status(StatusCode::UNAUTHORIZED) Response::builder()
.header("WWW-Authenticate", validator.www_authenticate()) .status(StatusCode::UNAUTHORIZED)
.body(boxed_body("Authentication required")) .header("WWW-Authenticate", validator.www_authenticate())
.unwrap()); .body(boxed_body("Authentication required"))
.unwrap(),
);
} }
} }
} }
@@ -120,7 +134,9 @@ impl RequestFilter {
if let Some(ref jwt_auth) = security.jwt_auth { if let Some(ref jwt_auth) = security.jwt_auth {
if jwt_auth.enabled { if jwt_auth.enabled {
// Check JWT auth exclude paths // Check JWT auth exclude paths
let skip_jwt = jwt_auth.exclude_paths.as_ref() let skip_jwt = jwt_auth
.exclude_paths
.as_ref()
.map(|paths| Self::path_matches_any(request_path, paths)) .map(|paths| Self::path_matches_any(request_path, paths))
.unwrap_or(false); .unwrap_or(false);
@@ -132,18 +148,25 @@ impl RequestFilter {
jwt_auth.audience.as_deref(), jwt_auth.audience.as_deref(),
); );
let auth_header = req.headers() let auth_header = req
.headers()
.get("authorization") .get("authorization")
.and_then(|v| v.to_str().ok()); .and_then(|v| v.to_str().ok());
match auth_header.and_then(JwtValidator::extract_token) { match auth_header.and_then(JwtValidator::extract_token) {
Some(token) => { Some(token) => {
if validator.validate(token).is_err() { if validator.validate(token).is_err() {
return Some(error_response(StatusCode::UNAUTHORIZED, "Invalid token")); return Some(error_response(
StatusCode::UNAUTHORIZED,
"Invalid token",
));
} }
} }
None => { None => {
return Some(error_response(StatusCode::UNAUTHORIZED, "Bearer token required")); return Some(error_response(
StatusCode::UNAUTHORIZED,
"Bearer token required",
));
} }
} }
} }
@@ -203,14 +226,19 @@ impl RequestFilter {
} }
/// Check IP-based security (for use in passthrough / TCP-level connections). /// Check IP-based security (for use in passthrough / TCP-level connections).
/// `domain` is the SNI from the TLS handshake (if available) for domain-scoped filtering.
/// Returns true if allowed, false if blocked. /// Returns true if allowed, false if blocked.
pub fn check_ip_security(security: &RouteSecurity, client_ip: &std::net::IpAddr) -> bool { pub fn check_ip_security(
security: &RouteSecurity,
client_ip: &std::net::IpAddr,
domain: Option<&str>,
) -> bool {
if security.ip_allow_list.is_some() || security.ip_block_list.is_some() { if security.ip_allow_list.is_some() || security.ip_block_list.is_some() {
let allow = security.ip_allow_list.as_deref().unwrap_or(&[]); let allow = security.ip_allow_list.as_deref().unwrap_or(&[]);
let block = security.ip_block_list.as_deref().unwrap_or(&[]); let block = security.ip_block_list.as_deref().unwrap_or(&[]);
let filter = IpFilter::new(allow, block); let filter = IpFilter::new(allow, block);
let normalized = IpFilter::normalize_ip(client_ip); let normalized = IpFilter::normalize_ip(client_ip);
filter.is_allowed(&normalized) filter.is_allowed_for_domain(&normalized, domain)
} else { } else {
true true
} }
@@ -233,19 +261,28 @@ impl RequestFilter {
return None; return None;
} }
let origin = req.headers() let origin = req
.headers()
.get("origin") .get("origin")
.and_then(|v| v.to_str().ok()) .and_then(|v| v.to_str().ok())
.unwrap_or("*"); .unwrap_or("*");
Some(Response::builder() Some(
.status(StatusCode::NO_CONTENT) Response::builder()
.header("Access-Control-Allow-Origin", origin) .status(StatusCode::NO_CONTENT)
.header("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, PATCH, OPTIONS") .header("Access-Control-Allow-Origin", origin)
.header("Access-Control-Allow-Headers", "Content-Type, Authorization, X-Requested-With") .header(
.header("Access-Control-Max-Age", "86400") "Access-Control-Allow-Methods",
.body(boxed_body("")) "GET, POST, PUT, DELETE, PATCH, OPTIONS",
.unwrap()) )
.header(
"Access-Control-Allow-Headers",
"Content-Type, Authorization, X-Requested-With",
)
.header("Access-Control-Max-Age", "86400")
.body(boxed_body(""))
.unwrap(),
)
} }
} }
@@ -260,3 +297,71 @@ fn error_response(status: StatusCode, message: &str) -> Response<BoxBody<Bytes,
fn boxed_body(data: &str) -> BoxBody<Bytes, hyper::Error> { fn boxed_body(data: &str) -> BoxBody<Bytes, hyper::Error> {
BoxBody::new(Full::new(Bytes::from(data.to_string())).map_err(|never| match never {})) BoxBody::new(Full::new(Bytes::from(data.to_string())).map_err(|never| match never {}))
} }
#[cfg(test)]
mod tests {
use bytes::Bytes;
use http_body_util::Empty;
use hyper::{Request, StatusCode, Version};
use rustproxy_config::{IpAllowEntry, RouteSecurity};
use super::RequestFilter;
fn domain_scoped_security() -> RouteSecurity {
RouteSecurity {
ip_allow_list: Some(vec![IpAllowEntry::DomainScoped {
ip: "10.8.0.2".to_string(),
domains: vec!["*.abc.xyz".to_string()],
}]),
ip_block_list: None,
max_connections: None,
authentication: None,
rate_limit: None,
basic_auth: None,
jwt_auth: None,
}
}
fn peer_addr() -> std::net::SocketAddr {
std::net::SocketAddr::from(([10, 8, 0, 2], 4242))
}
fn request(uri: &str, version: Version, host: Option<&str>) -> Request<Empty<Bytes>> {
let mut builder = Request::builder().uri(uri).version(version);
if let Some(host) = host {
builder = builder.header("host", host);
}
builder.body(Empty::<Bytes>::new()).unwrap()
}
#[test]
fn domain_scoped_acl_allows_uri_authority_without_host_header() {
let security = domain_scoped_security();
let req = request("https://outline.abc.xyz/", Version::HTTP_2, None);
assert!(RequestFilter::apply(&security, &req, &peer_addr()).is_none());
}
#[test]
fn domain_scoped_acl_allows_host_header_with_port() {
let security = domain_scoped_security();
let req = request(
"https://unrelated.invalid/",
Version::HTTP_11,
Some("outline.abc.xyz:443"),
);
assert!(RequestFilter::apply(&security, &req, &peer_addr()).is_none());
}
#[test]
fn domain_scoped_acl_denies_non_matching_uri_authority() {
let security = domain_scoped_security();
let req = request("https://outline.other.xyz/", Version::HTTP_2, None);
let response = RequestFilter::apply(&security, &req, &peer_addr())
.expect("non-matching domain should be denied");
assert_eq!(response.status(), StatusCode::FORBIDDEN);
}
}
@@ -0,0 +1,43 @@
use hyper::Request;
/// Extract the effective request host for routing and scoped ACL checks.
///
/// Prefer the explicit `Host` header when present, otherwise fall back to the
/// URI authority used by HTTP/2 and HTTP/3 requests.
pub(crate) fn extract_request_host<B>(req: &Request<B>) -> Option<&str> {
req.headers()
.get("host")
.and_then(|value| value.to_str().ok())
.map(|host| host.split(':').next().unwrap_or(host))
.or_else(|| req.uri().host())
}
#[cfg(test)]
mod tests {
use bytes::Bytes;
use http_body_util::Empty;
use hyper::Request;
use super::extract_request_host;
#[test]
fn extracts_host_header_before_uri_authority() {
let req = Request::builder()
.uri("https://uri.abc.xyz/test")
.header("host", "header.abc.xyz:443")
.body(Empty::<Bytes>::new())
.unwrap();
assert_eq!(extract_request_host(&req), Some("header.abc.xyz"));
}
#[test]
fn falls_back_to_uri_authority_when_host_header_missing() {
let req = Request::builder()
.uri("https://outline.abc.xyz/test")
.body(Empty::<Bytes>::new())
.unwrap();
assert_eq!(extract_request_host(&req), Some("outline.abc.xyz"));
}
}
@@ -3,7 +3,7 @@
use hyper::header::{HeaderMap, HeaderName, HeaderValue}; use hyper::header::{HeaderMap, HeaderName, HeaderValue};
use rustproxy_config::RouteConfig; use rustproxy_config::RouteConfig;
use crate::template::{RequestContext, expand_template}; use crate::template::{expand_template, RequestContext};
pub struct ResponseFilter; pub struct ResponseFilter;
@@ -11,12 +11,17 @@ impl ResponseFilter {
/// Apply response headers from route config and CORS settings. /// Apply response headers from route config and CORS settings.
/// If a `RequestContext` is provided, template variables in header values will be expanded. /// If a `RequestContext` is provided, template variables in header values will be expanded.
/// Also injects Alt-Svc header for routes with HTTP/3 enabled. /// Also injects Alt-Svc header for routes with HTTP/3 enabled.
pub fn apply_headers(route: &RouteConfig, headers: &mut HeaderMap, req_ctx: Option<&RequestContext>) { pub fn apply_headers(
route: &RouteConfig,
headers: &mut HeaderMap,
req_ctx: Option<&RequestContext>,
) {
// Inject Alt-Svc for HTTP/3 advertisement if QUIC/HTTP3 is enabled on this route // Inject Alt-Svc for HTTP/3 advertisement if QUIC/HTTP3 is enabled on this route
if let Some(ref udp) = route.action.udp { if let Some(ref udp) = route.action.udp {
if let Some(ref quic) = udp.quic { if let Some(ref quic) = udp.quic {
if quic.enable_http3.unwrap_or(false) { if quic.enable_http3.unwrap_or(false) {
let port = quic.alt_svc_port let port = quic
.alt_svc_port
.or_else(|| req_ctx.map(|c| c.port)) .or_else(|| req_ctx.map(|c| c.port))
.unwrap_or(443); .unwrap_or(443);
let max_age = quic.alt_svc_max_age.unwrap_or(86400); let max_age = quic.alt_svc_max_age.unwrap_or(86400);
@@ -63,10 +68,7 @@ impl ResponseFilter {
headers.insert("access-control-allow-origin", val); headers.insert("access-control-allow-origin", val);
} }
} else { } else {
headers.insert( headers.insert("access-control-allow-origin", HeaderValue::from_static("*"));
"access-control-allow-origin",
HeaderValue::from_static("*"),
);
} }
// Allow-Methods // Allow-Methods
@@ -62,17 +62,11 @@ impl<S: AsyncRead + AsyncWrite + Unpin + Send + 'static> AsyncWrite for Shutdown
self.inner.as_ref().unwrap().is_write_vectored() self.inner.as_ref().unwrap().is_write_vectored()
} }
fn poll_flush( fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<io::Result<()>> {
Pin::new(self.get_mut().inner.as_mut().unwrap()).poll_flush(cx) Pin::new(self.get_mut().inner.as_mut().unwrap()).poll_flush(cx)
} }
fn poll_shutdown( fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<io::Result<()>> {
let this = self.get_mut(); let this = self.get_mut();
let result = Pin::new(this.inner.as_mut().unwrap()).poll_shutdown(cx); let result = Pin::new(this.inner.as_mut().unwrap()).poll_shutdown(cx);
if result.is_ready() { if result.is_ready() {
@@ -93,7 +87,8 @@ impl<S: AsyncRead + AsyncWrite + Unpin + Send + 'static> Drop for ShutdownOnDrop
let _ = tokio::time::timeout( let _ = tokio::time::timeout(
std::time::Duration::from_secs(2), std::time::Duration::from_secs(2),
tokio::io::AsyncWriteExt::shutdown(&mut stream), tokio::io::AsyncWriteExt::shutdown(&mut stream),
).await; )
.await;
// stream is dropped here — all resources freed // stream is dropped here — all resources freed
}); });
} }
+6 -2
View File
@@ -39,7 +39,8 @@ pub fn expand_headers(
headers: &HashMap<String, String>, headers: &HashMap<String, String>,
ctx: &RequestContext, ctx: &RequestContext,
) -> HashMap<String, String> { ) -> HashMap<String, String> {
headers.iter() headers
.iter()
.map(|(k, v)| (k.clone(), expand_template(v, ctx))) .map(|(k, v)| (k.clone(), expand_template(v, ctx)))
.collect() .collect()
} }
@@ -150,7 +151,10 @@ mod tests {
let ctx = test_context(); let ctx = test_context();
let template = "{clientIp}|{domain}|{port}|{path}|{routeName}|{connectionId}"; let template = "{clientIp}|{domain}|{port}|{path}|{routeName}|{connectionId}";
let result = expand_template(template, &ctx); let result = expand_template(template, &ctx);
assert_eq!(result, "192.168.1.100|example.com|443|/api/v1/users|api-route|42"); assert_eq!(
result,
"192.168.1.100|example.com|443|/api/v1/users|api-route|42"
);
} }
#[test] #[test]
@@ -7,7 +7,7 @@ use std::sync::Arc;
use std::sync::Mutex; use std::sync::Mutex;
use dashmap::DashMap; use dashmap::DashMap;
use rustproxy_config::{RouteTarget, LoadBalancingAlgorithm}; use rustproxy_config::{LoadBalancingAlgorithm, RouteTarget};
/// Upstream selection result. /// Upstream selection result.
pub struct UpstreamSelection { pub struct UpstreamSelection {
@@ -51,21 +51,19 @@ impl UpstreamSelector {
} }
// Determine load balancing algorithm // Determine load balancing algorithm
let algorithm = target.load_balancing.as_ref() let algorithm = target
.load_balancing
.as_ref()
.map(|lb| &lb.algorithm) .map(|lb| &lb.algorithm)
.unwrap_or(&LoadBalancingAlgorithm::RoundRobin); .unwrap_or(&LoadBalancingAlgorithm::RoundRobin);
let idx = match algorithm { let idx = match algorithm {
LoadBalancingAlgorithm::RoundRobin => { LoadBalancingAlgorithm::RoundRobin => self.round_robin_select(&hosts, port),
self.round_robin_select(&hosts, port)
}
LoadBalancingAlgorithm::IpHash => { LoadBalancingAlgorithm::IpHash => {
let hash = Self::ip_hash(client_addr); let hash = Self::ip_hash(client_addr);
hash % hosts.len() hash % hosts.len()
} }
LoadBalancingAlgorithm::LeastConnections => { LoadBalancingAlgorithm::LeastConnections => self.least_connections_select(&hosts, port),
self.least_connections_select(&hosts, port)
}
}; };
UpstreamSelection { UpstreamSelection {
@@ -78,9 +76,7 @@ impl UpstreamSelector {
fn round_robin_select(&self, hosts: &[&str], port: u16) -> usize { fn round_robin_select(&self, hosts: &[&str], port: u16) -> usize {
let key = format!("{}:{}", hosts[0], port); let key = format!("{}:{}", hosts[0], port);
let mut counters = self.round_robin.lock().unwrap(); let mut counters = self.round_robin.lock().unwrap();
let counter = counters let counter = counters.entry(key).or_insert_with(|| AtomicUsize::new(0));
.entry(key)
.or_insert_with(|| AtomicUsize::new(0));
let idx = counter.fetch_add(1, Ordering::Relaxed); let idx = counter.fetch_add(1, Ordering::Relaxed);
idx % hosts.len() idx % hosts.len()
} }
@@ -91,7 +87,8 @@ impl UpstreamSelector {
for (i, host) in hosts.iter().enumerate() { for (i, host) in hosts.iter().enumerate() {
let key = format!("{}:{}", host, port); let key = format!("{}:{}", host, port);
let conns = self.active_connections let conns = self
.active_connections
.get(&key) .get(&key)
.map(|entry| entry.value().load(Ordering::Relaxed)) .map(|entry| entry.value().load(Ordering::Relaxed))
.unwrap_or(0); .unwrap_or(0);
@@ -228,13 +225,21 @@ mod tests {
selector.connection_started("backend:8080"); selector.connection_started("backend:8080");
selector.connection_started("backend:8080"); selector.connection_started("backend:8080");
assert_eq!( assert_eq!(
selector.active_connections.get("backend:8080").unwrap().load(Ordering::Relaxed), selector
.active_connections
.get("backend:8080")
.unwrap()
.load(Ordering::Relaxed),
2 2
); );
selector.connection_ended("backend:8080"); selector.connection_ended("backend:8080");
assert_eq!( assert_eq!(
selector.active_connections.get("backend:8080").unwrap().load(Ordering::Relaxed), selector
.active_connections
.get("backend:8080")
.unwrap()
.load(Ordering::Relaxed),
1 1
); );
File diff suppressed because it is too large Load Diff
-17
View File
@@ -1,17 +0,0 @@
[package]
name = "rustproxy-nftables"
version.workspace = true
edition.workspace = true
license.workspace = true
authors.workspace = true
description = "NFTables kernel-level forwarding for RustProxy"
[dependencies]
rustproxy-config = { workspace = true }
tokio = { workspace = true }
tracing = { workspace = true }
thiserror = { workspace = true }
anyhow = { workspace = true }
serde = { workspace = true }
serde_json = { workspace = true }
libc = { workspace = true }
-10
View File
@@ -1,10 +0,0 @@
//! # rustproxy-nftables
//!
//! NFTables kernel-level forwarding for RustProxy.
//! Generates and manages nft CLI rules for DNAT/SNAT.
pub mod nft_manager;
pub mod rule_builder;
pub use nft_manager::*;
pub use rule_builder::*;
@@ -1,238 +0,0 @@
use thiserror::Error;
use std::collections::HashMap;
use tracing::{debug, info, warn};
#[derive(Debug, Error)]
pub enum NftError {
#[error("nft command failed: {0}")]
CommandFailed(String),
#[error("IO error: {0}")]
Io(#[from] std::io::Error),
#[error("Not running as root")]
NotRoot,
}
/// Manager for nftables rules.
///
/// Executes `nft` CLI commands to manage kernel-level packet forwarding.
/// Requires root privileges; operations are skipped gracefully if not root.
pub struct NftManager {
table_name: String,
/// Active rules indexed by route ID
active_rules: HashMap<String, Vec<String>>,
/// Whether the table has been initialized
table_initialized: bool,
}
impl NftManager {
pub fn new(table_name: Option<String>) -> Self {
Self {
table_name: table_name.unwrap_or_else(|| "rustproxy".to_string()),
active_rules: HashMap::new(),
table_initialized: false,
}
}
/// Check if we are running as root.
fn is_root() -> bool {
unsafe { libc::geteuid() == 0 }
}
/// Execute a single nft command via the CLI.
async fn exec_nft(command: &str) -> Result<String, NftError> {
// The command starts with "nft ", strip it to get the args
let args = if command.starts_with("nft ") {
&command[4..]
} else {
command
};
let output = tokio::process::Command::new("nft")
.args(args.split_whitespace())
.output()
.await
.map_err(NftError::Io)?;
if output.status.success() {
Ok(String::from_utf8_lossy(&output.stdout).to_string())
} else {
let stderr = String::from_utf8_lossy(&output.stderr);
Err(NftError::CommandFailed(format!(
"Command '{}' failed: {}",
command, stderr
)))
}
}
/// Ensure the nftables table and chains are set up.
async fn ensure_table(&mut self) -> Result<(), NftError> {
if self.table_initialized {
return Ok(());
}
let setup_commands = crate::rule_builder::build_table_setup(&self.table_name);
for cmd in &setup_commands {
Self::exec_nft(cmd).await?;
}
self.table_initialized = true;
info!("NFTables table '{}' initialized", self.table_name);
Ok(())
}
/// Apply rules for a route.
///
/// Executes the nft commands via the CLI. If not running as root,
/// the rules are stored locally but not applied to the kernel.
pub async fn apply_rules(&mut self, route_id: &str, rules: Vec<String>) -> Result<(), NftError> {
if !Self::is_root() {
warn!("Not running as root, nftables rules will not be applied to kernel");
self.active_rules.insert(route_id.to_string(), rules);
return Ok(());
}
self.ensure_table().await?;
for cmd in &rules {
Self::exec_nft(cmd).await?;
debug!("Applied nft rule: {}", cmd);
}
info!("Applied {} nftables rules for route '{}'", rules.len(), route_id);
self.active_rules.insert(route_id.to_string(), rules);
Ok(())
}
/// Remove rules for a route.
///
/// Currently removes the route from tracking. To fully remove specific
/// rules would require handle-based tracking; for now, cleanup() removes
/// the entire table.
pub async fn remove_rules(&mut self, route_id: &str) -> Result<(), NftError> {
if let Some(rules) = self.active_rules.remove(route_id) {
info!("Removed {} tracked nft rules for route '{}'", rules.len(), route_id);
}
Ok(())
}
/// Clean up all managed rules by deleting the entire nftables table.
pub async fn cleanup(&mut self) -> Result<(), NftError> {
if !Self::is_root() {
warn!("Not running as root, skipping nftables cleanup");
self.active_rules.clear();
self.table_initialized = false;
return Ok(());
}
if self.table_initialized {
let cleanup_commands = crate::rule_builder::build_table_cleanup(&self.table_name);
for cmd in &cleanup_commands {
match Self::exec_nft(cmd).await {
Ok(_) => debug!("Cleanup: {}", cmd),
Err(e) => warn!("Cleanup command failed (may be ok): {}", e),
}
}
info!("NFTables table '{}' cleaned up", self.table_name);
}
self.active_rules.clear();
self.table_initialized = false;
Ok(())
}
/// Get the table name.
pub fn table_name(&self) -> &str {
&self.table_name
}
/// Whether the table has been initialized in the kernel.
pub fn is_initialized(&self) -> bool {
self.table_initialized
}
/// Get the number of active route rule sets.
pub fn active_route_count(&self) -> usize {
self.active_rules.len()
}
/// Get the status of all active rules.
pub fn status(&self) -> HashMap<String, serde_json::Value> {
let mut status = HashMap::new();
for (route_id, rules) in &self.active_rules {
status.insert(
route_id.clone(),
serde_json::json!({
"ruleCount": rules.len(),
"rules": rules,
}),
);
}
status
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_new_default_table_name() {
let mgr = NftManager::new(None);
assert_eq!(mgr.table_name(), "rustproxy");
assert!(!mgr.is_initialized());
}
#[test]
fn test_new_custom_table_name() {
let mgr = NftManager::new(Some("custom".to_string()));
assert_eq!(mgr.table_name(), "custom");
}
#[tokio::test]
async fn test_apply_rules_non_root() {
let mut mgr = NftManager::new(None);
// When not root, rules are stored but not applied to kernel
let rules = vec!["nft add rule ip rustproxy prerouting tcp dport 443 dnat to 10.0.0.1:8443".to_string()];
mgr.apply_rules("route-1", rules).await.unwrap();
assert_eq!(mgr.active_route_count(), 1);
let status = mgr.status();
assert!(status.contains_key("route-1"));
assert_eq!(status["route-1"]["ruleCount"], 1);
}
#[tokio::test]
async fn test_remove_rules() {
let mut mgr = NftManager::new(None);
let rules = vec!["nft add rule test".to_string()];
mgr.apply_rules("route-1", rules).await.unwrap();
assert_eq!(mgr.active_route_count(), 1);
mgr.remove_rules("route-1").await.unwrap();
assert_eq!(mgr.active_route_count(), 0);
}
#[tokio::test]
async fn test_cleanup_non_root() {
let mut mgr = NftManager::new(None);
let rules = vec!["nft add rule test".to_string()];
mgr.apply_rules("route-1", rules).await.unwrap();
mgr.apply_rules("route-2", vec!["nft add rule test2".to_string()]).await.unwrap();
mgr.cleanup().await.unwrap();
assert_eq!(mgr.active_route_count(), 0);
assert!(!mgr.is_initialized());
}
#[tokio::test]
async fn test_status_multiple_routes() {
let mut mgr = NftManager::new(None);
mgr.apply_rules("web", vec!["rule1".to_string(), "rule2".to_string()]).await.unwrap();
mgr.apply_rules("api", vec!["rule3".to_string()]).await.unwrap();
let status = mgr.status();
assert_eq!(status.len(), 2);
assert_eq!(status["web"]["ruleCount"], 2);
assert_eq!(status["api"]["ruleCount"], 1);
}
}
@@ -1,146 +0,0 @@
use rustproxy_config::{NfTablesOptions, NfTablesProtocol};
/// Build nftables DNAT rule for port forwarding.
pub fn build_dnat_rule(
table_name: &str,
chain_name: &str,
source_port: u16,
target_host: &str,
target_port: u16,
options: &NfTablesOptions,
) -> Vec<String> {
let protocols: Vec<&str> = match options.protocol.as_ref().unwrap_or(&NfTablesProtocol::Tcp) {
NfTablesProtocol::Tcp => vec!["tcp"],
NfTablesProtocol::Udp => vec!["udp"],
NfTablesProtocol::All => vec!["tcp", "udp"],
};
let mut rules = Vec::new();
for protocol in &protocols {
// DNAT rule
rules.push(format!(
"nft add rule ip {} {} {} dport {} dnat to {}:{}",
table_name, chain_name, protocol, source_port, target_host, target_port,
));
// SNAT rule if preserving source IP is not enabled
if !options.preserve_source_ip.unwrap_or(false) {
rules.push(format!(
"nft add rule ip {} postrouting {} dport {} masquerade",
table_name, protocol, target_port,
));
}
// Rate limiting
if let Some(max_rate) = &options.max_rate {
rules.push(format!(
"nft add rule ip {} {} {} dport {} limit rate {} accept",
table_name, chain_name, protocol, source_port, max_rate,
));
}
}
rules
}
/// Build the initial table and chain setup commands.
pub fn build_table_setup(table_name: &str) -> Vec<String> {
vec![
format!("nft add table ip {}", table_name),
format!("nft add chain ip {} prerouting {{ type nat hook prerouting priority 0 \\; }}", table_name),
format!("nft add chain ip {} postrouting {{ type nat hook postrouting priority 100 \\; }}", table_name),
]
}
/// Build cleanup commands to remove the table.
pub fn build_table_cleanup(table_name: &str) -> Vec<String> {
vec![format!("nft delete table ip {}", table_name)]
}
#[cfg(test)]
mod tests {
use super::*;
fn make_options() -> NfTablesOptions {
NfTablesOptions {
preserve_source_ip: None,
protocol: None,
max_rate: None,
priority: None,
table_name: None,
use_ip_sets: None,
use_advanced_nat: None,
}
}
#[test]
fn test_basic_dnat_rule() {
let options = make_options();
let rules = build_dnat_rule("rustproxy", "prerouting", 443, "10.0.0.1", 8443, &options);
assert!(rules.len() >= 1);
assert!(rules[0].contains("dnat to 10.0.0.1:8443"));
assert!(rules[0].contains("dport 443"));
}
#[test]
fn test_preserve_source_ip() {
let mut options = make_options();
options.preserve_source_ip = Some(true);
let rules = build_dnat_rule("rustproxy", "prerouting", 443, "10.0.0.1", 8443, &options);
// When preserving source IP, no masquerade rule
assert!(rules.iter().all(|r| !r.contains("masquerade")));
}
#[test]
fn test_without_preserve_source_ip() {
let options = make_options();
let rules = build_dnat_rule("rustproxy", "prerouting", 443, "10.0.0.1", 8443, &options);
assert!(rules.iter().any(|r| r.contains("masquerade")));
}
#[test]
fn test_rate_limited_rule() {
let mut options = make_options();
options.max_rate = Some("100/second".to_string());
let rules = build_dnat_rule("rustproxy", "prerouting", 80, "10.0.0.1", 8080, &options);
assert!(rules.iter().any(|r| r.contains("limit rate 100/second")));
}
#[test]
fn test_table_setup_commands() {
let commands = build_table_setup("rustproxy");
assert_eq!(commands.len(), 3);
assert!(commands[0].contains("add table ip rustproxy"));
assert!(commands[1].contains("prerouting"));
assert!(commands[2].contains("postrouting"));
}
#[test]
fn test_table_cleanup() {
let commands = build_table_cleanup("rustproxy");
assert_eq!(commands.len(), 1);
assert!(commands[0].contains("delete table ip rustproxy"));
}
#[test]
fn test_protocol_all_generates_tcp_and_udp_rules() {
let mut options = make_options();
options.protocol = Some(NfTablesProtocol::All);
let rules = build_dnat_rule("rustproxy", "prerouting", 53, "10.0.0.53", 53, &options);
// Should have TCP DNAT + masquerade + UDP DNAT + masquerade = 4 rules
assert_eq!(rules.len(), 4);
assert!(rules.iter().any(|r| r.contains("tcp dport 53 dnat")));
assert!(rules.iter().any(|r| r.contains("udp dport 53 dnat")));
assert!(rules.iter().filter(|r| r.contains("masquerade")).count() == 2);
}
#[test]
fn test_protocol_udp() {
let mut options = make_options();
options.protocol = Some(NfTablesProtocol::Udp);
let rules = build_dnat_rule("rustproxy", "prerouting", 53, "10.0.0.53", 53, &options);
assert!(rules.iter().all(|r| !r.contains("tcp")));
assert!(rules.iter().any(|r| r.contains("udp dport 53 dnat")));
}
}
@@ -0,0 +1,329 @@
//! Shared connection registry for selective connection recycling.
//!
//! Tracks active connections across both TCP and QUIC with metadata
//! (source IP, SNI domain, route ID, cancel token) so that connections
//! can be selectively recycled when certificates, security rules, or
//! route targets change.
use std::collections::HashSet;
use std::net::IpAddr;
use std::sync::Arc;
use std::sync::atomic::{AtomicU64, Ordering};
use dashmap::DashMap;
use tokio_util::sync::CancellationToken;
use tracing::info;
use rustproxy_config::RouteSecurity;
use rustproxy_http::request_filter::RequestFilter;
use rustproxy_routing::matchers::domain_matches;
/// Metadata about an active connection.
pub struct ConnectionEntry {
/// Per-connection cancel token (child of per-route token).
pub cancel: CancellationToken,
/// Client source IP.
pub source_ip: IpAddr,
/// SNI domain from TLS handshake (None for non-TLS connections).
pub domain: Option<String>,
/// Route ID this connection was matched to (None if route has no ID).
pub route_id: Option<String>,
}
/// Transport-agnostic registry of active connections.
///
/// Used by both `TcpListenerManager` and `UdpListenerManager` to track
/// connections and enable selective recycling on config changes.
pub struct ConnectionRegistry {
connections: DashMap<u64, ConnectionEntry>,
next_id: AtomicU64,
}
impl ConnectionRegistry {
pub fn new() -> Self {
Self {
connections: DashMap::new(),
next_id: AtomicU64::new(1),
}
}
/// Register a connection and return its ID + RAII guard.
///
/// The guard automatically removes the connection from the registry on drop.
pub fn register(self: &Arc<Self>, entry: ConnectionEntry) -> (u64, ConnectionRegistryGuard) {
let id = self.next_id.fetch_add(1, Ordering::Relaxed);
self.connections.insert(id, entry);
let guard = ConnectionRegistryGuard {
registry: Arc::clone(self),
conn_id: id,
};
(id, guard)
}
/// Number of tracked connections (for metrics/debugging).
pub fn len(&self) -> usize {
self.connections.len()
}
/// Recycle connections whose SNI domain matches a renewed certificate domain.
///
/// Uses bidirectional domain matching so that:
/// - Cert `*.example.com` recycles connections for `sub.example.com`
/// - Cert `sub.example.com` recycles connections on routes with `*.example.com`
pub fn recycle_for_cert_change(&self, cert_domain: &str) {
let mut recycled = 0u64;
self.connections.retain(|_, entry| {
let matches = entry.domain.as_deref()
.map(|d| domain_matches(cert_domain, d) || domain_matches(d, cert_domain))
.unwrap_or(false);
if matches {
entry.cancel.cancel();
recycled += 1;
false
} else {
true
}
});
if recycled > 0 {
info!(
"Recycled {} connection(s) for cert change on domain '{}'",
recycled, cert_domain
);
}
}
/// Recycle connections on a route whose security config changed.
///
/// Re-evaluates each connection's source IP against the new security rules.
/// Only connections from now-blocked IPs are terminated; allowed IPs are undisturbed.
pub fn recycle_for_security_change(&self, route_id: &str, new_security: &RouteSecurity) {
let mut recycled = 0u64;
self.connections.retain(|_, entry| {
if entry.route_id.as_deref() == Some(route_id) {
if !RequestFilter::check_ip_security(new_security, &entry.source_ip, entry.domain.as_deref()) {
info!(
"Terminating connection from {} — IP now blocked on route '{}'",
entry.source_ip, route_id
);
entry.cancel.cancel();
recycled += 1;
return false;
}
}
true
});
if recycled > 0 {
info!(
"Recycled {} connection(s) for security change on route '{}'",
recycled, route_id
);
}
}
/// Recycle all connections on a route (e.g., when targets changed).
pub fn recycle_for_route_change(&self, route_id: &str) {
let mut recycled = 0u64;
self.connections.retain(|_, entry| {
if entry.route_id.as_deref() == Some(route_id) {
entry.cancel.cancel();
recycled += 1;
false
} else {
true
}
});
if recycled > 0 {
info!(
"Recycled {} connection(s) for config change on route '{}'",
recycled, route_id
);
}
}
/// Remove connections on routes that no longer exist.
///
/// This complements per-route CancellationToken cancellation —
/// the token cascade handles graceful shutdown, this cleans up the registry.
pub fn cleanup_removed_routes(&self, active_route_ids: &HashSet<String>) {
self.connections.retain(|_, entry| {
match &entry.route_id {
Some(id) => active_route_ids.contains(id),
None => true, // keep connections without a route ID
}
});
}
}
/// RAII guard that removes a connection from the registry on drop.
pub struct ConnectionRegistryGuard {
registry: Arc<ConnectionRegistry>,
conn_id: u64,
}
impl Drop for ConnectionRegistryGuard {
fn drop(&mut self) {
self.registry.connections.remove(&self.conn_id);
}
}
#[cfg(test)]
mod tests {
use super::*;
fn make_registry() -> Arc<ConnectionRegistry> {
Arc::new(ConnectionRegistry::new())
}
#[test]
fn test_register_and_guard_cleanup() {
let reg = make_registry();
let token = CancellationToken::new();
let entry = ConnectionEntry {
cancel: token.clone(),
source_ip: "10.0.0.1".parse().unwrap(),
domain: Some("example.com".to_string()),
route_id: Some("route-1".to_string()),
};
let (id, guard) = reg.register(entry);
assert_eq!(reg.len(), 1);
assert!(reg.connections.contains_key(&id));
drop(guard);
assert_eq!(reg.len(), 0);
assert!(!token.is_cancelled());
}
#[test]
fn test_recycle_for_cert_change_exact() {
let reg = make_registry();
let t1 = CancellationToken::new();
let t2 = CancellationToken::new();
let (_, _g1) = reg.register(ConnectionEntry {
cancel: t1.clone(),
source_ip: "10.0.0.1".parse().unwrap(),
domain: Some("api.example.com".to_string()),
route_id: Some("r1".to_string()),
});
let (_, _g2) = reg.register(ConnectionEntry {
cancel: t2.clone(),
source_ip: "10.0.0.2".parse().unwrap(),
domain: Some("other.com".to_string()),
route_id: Some("r2".to_string()),
});
reg.recycle_for_cert_change("api.example.com");
assert!(t1.is_cancelled());
assert!(!t2.is_cancelled());
// Registry retains unmatched entry (guard still alive keeps it too,
// but the retain removed the matched one before guard could)
}
#[test]
fn test_recycle_for_cert_change_wildcard() {
let reg = make_registry();
let t1 = CancellationToken::new();
let t2 = CancellationToken::new();
let (_, _g1) = reg.register(ConnectionEntry {
cancel: t1.clone(),
source_ip: "10.0.0.1".parse().unwrap(),
domain: Some("sub.example.com".to_string()),
route_id: Some("r1".to_string()),
});
let (_, _g2) = reg.register(ConnectionEntry {
cancel: t2.clone(),
source_ip: "10.0.0.2".parse().unwrap(),
domain: Some("other.com".to_string()),
route_id: Some("r2".to_string()),
});
// Wildcard cert should match subdomain
reg.recycle_for_cert_change("*.example.com");
assert!(t1.is_cancelled());
assert!(!t2.is_cancelled());
}
#[test]
fn test_recycle_for_security_change() {
let reg = make_registry();
let t1 = CancellationToken::new();
let t2 = CancellationToken::new();
let (_, _g1) = reg.register(ConnectionEntry {
cancel: t1.clone(),
source_ip: "10.0.0.1".parse().unwrap(),
domain: None,
route_id: Some("r1".to_string()),
});
let (_, _g2) = reg.register(ConnectionEntry {
cancel: t2.clone(),
source_ip: "10.0.0.2".parse().unwrap(),
domain: None,
route_id: Some("r1".to_string()),
});
// Block 10.0.0.1, allow 10.0.0.2
let security = RouteSecurity {
ip_allow_list: None,
ip_block_list: Some(vec!["10.0.0.1".to_string()]),
max_connections: None,
authentication: None,
rate_limit: None,
basic_auth: None,
jwt_auth: None,
};
reg.recycle_for_security_change("r1", &security);
assert!(t1.is_cancelled());
assert!(!t2.is_cancelled());
}
#[test]
fn test_recycle_for_route_change() {
let reg = make_registry();
let t1 = CancellationToken::new();
let t2 = CancellationToken::new();
let (_, _g1) = reg.register(ConnectionEntry {
cancel: t1.clone(),
source_ip: "10.0.0.1".parse().unwrap(),
domain: None,
route_id: Some("r1".to_string()),
});
let (_, _g2) = reg.register(ConnectionEntry {
cancel: t2.clone(),
source_ip: "10.0.0.2".parse().unwrap(),
domain: None,
route_id: Some("r2".to_string()),
});
reg.recycle_for_route_change("r1");
assert!(t1.is_cancelled());
assert!(!t2.is_cancelled());
}
#[test]
fn test_cleanup_removed_routes() {
let reg = make_registry();
let t1 = CancellationToken::new();
let t2 = CancellationToken::new();
let (_, _g1) = reg.register(ConnectionEntry {
cancel: t1.clone(),
source_ip: "10.0.0.1".parse().unwrap(),
domain: None,
route_id: Some("active".to_string()),
});
let (_, _g2) = reg.register(ConnectionEntry {
cancel: t2.clone(),
source_ip: "10.0.0.2".parse().unwrap(),
domain: None,
route_id: Some("removed".to_string()),
});
let mut active = HashSet::new();
active.insert("active".to_string());
reg.cleanup_removed_routes(&active);
// "removed" route entry was cleaned from registry
// (but guard is still alive so len may differ — the retain already removed it)
assert!(!t1.is_cancelled()); // not cancelled by cleanup, only by token cascade
assert!(!t2.is_cancelled()); // cleanup doesn't cancel, just removes from registry
}
}
+2 -2
View File
@@ -10,7 +10,7 @@ pub mod forwarder;
pub mod proxy_protocol; pub mod proxy_protocol;
pub mod tls_handler; pub mod tls_handler;
pub mod connection_tracker; pub mod connection_tracker;
pub mod socket_relay; pub mod connection_registry;
pub mod socket_opts; pub mod socket_opts;
pub mod udp_session; pub mod udp_session;
pub mod udp_listener; pub mod udp_listener;
@@ -22,7 +22,7 @@ pub use forwarder::*;
pub use proxy_protocol::*; pub use proxy_protocol::*;
pub use tls_handler::*; pub use tls_handler::*;
pub use connection_tracker::*; pub use connection_tracker::*;
pub use socket_relay::*; pub use connection_registry::*;
pub use socket_opts::*; pub use socket_opts::*;
pub use udp_session::*; pub use udp_session::*;
pub use udp_listener::*; pub use udp_listener::*;
@@ -30,6 +30,7 @@ use rustproxy_routing::{MatchContext, RouteManager};
use rustproxy_http::h3_service::H3ProxyService; use rustproxy_http::h3_service::H3ProxyService;
use crate::connection_tracker::ConnectionTracker; use crate::connection_tracker::ConnectionTracker;
use crate::connection_registry::{ConnectionEntry, ConnectionRegistry};
/// Create a QUIC server endpoint on the given port with the provided TLS config. /// Create a QUIC server endpoint on the given port with the provided TLS config.
/// ///
@@ -77,6 +78,13 @@ struct RelaySession {
cancel: CancellationToken, cancel: CancellationToken,
} }
impl Drop for RelaySession {
fn drop(&mut self) {
self.cancel.cancel();
self.return_task.abort();
}
}
/// Create a QUIC endpoint with a PROXY protocol v2 relay layer. /// Create a QUIC endpoint with a PROXY protocol v2 relay layer.
/// ///
/// Instead of giving the external socket to quinn, we: /// Instead of giving the external socket to quinn, we:
@@ -343,6 +351,8 @@ pub async fn quic_accept_loop(
cancel: CancellationToken, cancel: CancellationToken,
h3_service: Option<Arc<H3ProxyService>>, h3_service: Option<Arc<H3ProxyService>>,
real_client_map: Option<Arc<DashMap<SocketAddr, SocketAddr>>>, real_client_map: Option<Arc<DashMap<SocketAddr, SocketAddr>>>,
route_cancels: Arc<DashMap<String, CancellationToken>>,
connection_registry: Arc<ConnectionRegistry>,
) { ) {
loop { loop {
let incoming = tokio::select! { let incoming = tokio::select! {
@@ -399,17 +409,48 @@ pub async fn quic_accept_loop(
} }
}; };
// Check route-level IP security for QUIC (domain from SNI context)
if let Some(ref security) = route.security {
if !rustproxy_http::request_filter::RequestFilter::check_ip_security(
security, &ip, ctx.domain,
) {
debug!("QUIC connection from {} blocked by route security", real_addr);
continue;
}
}
conn_tracker.connection_opened(&ip); conn_tracker.connection_opened(&ip);
let route_id = route.name.clone().or(route.id.clone()); let route_id = route.name.clone().or(route.id.clone());
metrics.connection_opened(route_id.as_deref(), Some(&ip_str)); metrics.connection_opened(route_id.as_deref(), Some(&ip_str));
// Resolve per-route cancel token (child of global cancel)
let route_cancel = match route_id.as_deref() {
Some(id) => route_cancels.entry(id.to_string())
.or_insert_with(|| cancel.child_token())
.clone(),
None => cancel.child_token(),
};
// Per-connection child token for selective recycling
let conn_cancel = route_cancel.child_token();
// Register in connection registry
let registry = Arc::clone(&connection_registry);
let reg_entry = ConnectionEntry {
cancel: conn_cancel.clone(),
source_ip: ip,
domain: None, // QUIC Initial is encrypted, domain comes later via H3 :authority
route_id: route_id.clone(),
};
let metrics = Arc::clone(&metrics); let metrics = Arc::clone(&metrics);
let conn_tracker = Arc::clone(&conn_tracker); let conn_tracker = Arc::clone(&conn_tracker);
let cancel = cancel.child_token();
let h3_svc = h3_service.clone(); let h3_svc = h3_service.clone();
let real_client_addr = if real_addr != remote_addr { Some(real_addr) } else { None }; let real_client_addr = if real_addr != remote_addr { Some(real_addr) } else { None };
tokio::spawn(async move { tokio::spawn(async move {
// Register in connection registry (RAII guard removes on drop)
let (_conn_id, _registry_guard) = registry.register(reg_entry);
// RAII guard: ensures metrics/tracker cleanup even on panic // RAII guard: ensures metrics/tracker cleanup even on panic
struct QuicConnGuard { struct QuicConnGuard {
tracker: Arc<ConnectionTracker>, tracker: Arc<ConnectionTracker>,
@@ -432,7 +473,7 @@ pub async fn quic_accept_loop(
route_id, route_id,
}; };
match handle_quic_connection(incoming, route, port, Arc::clone(&metrics), &cancel, h3_svc, real_client_addr).await { match handle_quic_connection(incoming, route, port, Arc::clone(&metrics), &conn_cancel, h3_svc, real_client_addr).await {
Ok(()) => debug!("QUIC connection from {} completed", real_addr), Ok(()) => debug!("QUIC connection from {} completed", real_addr),
Err(e) => debug!("QUIC connection from {} error: {}", real_addr, e), Err(e) => debug!("QUIC connection from {} error: {}", real_addr, e),
} }
@@ -634,7 +675,7 @@ async fn forward_quic_stream_to_tcp(
let la_watch = Arc::clone(&last_activity); let la_watch = Arc::clone(&last_activity);
let c2b_abort = c2b.abort_handle(); let c2b_abort = c2b.abort_handle();
let b2c_abort = b2c.abort_handle(); let b2c_abort = b2c.abort_handle();
tokio::spawn(async move { let watchdog = tokio::spawn(async move {
let check_interval = std::time::Duration::from_secs(5); let check_interval = std::time::Duration::from_secs(5);
let mut last_seen = 0u64; let mut last_seen = 0u64;
loop { loop {
@@ -665,6 +706,7 @@ async fn forward_quic_stream_to_tcp(
let bytes_in = c2b.await.unwrap_or(0); let bytes_in = c2b.await.unwrap_or(0);
let bytes_out = b2c.await.unwrap_or(0); let bytes_out = b2c.await.unwrap_or(0);
watchdog.abort();
Ok((bytes_in, bytes_out)) Ok((bytes_in, bytes_out))
} }
@@ -1,126 +1,4 @@
//! Socket handler relay for connecting client connections to a TypeScript handler //! Socket handler relay module.
//! via a Unix domain socket.
//! //!
//! Protocol: Send a JSON metadata line terminated by `\n`, then bidirectional relay. //! Note: The actual relay logic lives in `tcp_listener::relay_to_socket_handler()`
//! which has proper timeouts, cancellation, and metrics integration.
use tokio::net::UnixStream;
use tokio::io::{AsyncWriteExt, AsyncReadExt};
use tokio::net::TcpStream;
use serde::Serialize;
use tracing::debug;
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct RelayMetadata {
connection_id: u64,
remote_ip: String,
remote_port: u16,
local_port: u16,
sni: Option<String>,
route_name: String,
initial_data_base64: Option<String>,
}
/// Relay a client connection to a TypeScript handler via Unix domain socket.
///
/// Protocol: Send a JSON metadata line terminated by `\n`, then bidirectional relay.
pub async fn relay_to_handler(
client: TcpStream,
relay_socket_path: &str,
connection_id: u64,
remote_ip: String,
remote_port: u16,
local_port: u16,
sni: Option<String>,
route_name: String,
initial_data: Option<&[u8]>,
) -> std::io::Result<()> {
debug!(
"Relaying connection {} to handler socket {}",
connection_id, relay_socket_path
);
// Connect to TypeScript handler Unix socket
let mut handler = UnixStream::connect(relay_socket_path).await?;
// Build and send metadata header
let initial_data_base64 = initial_data.map(base64_encode);
let metadata = RelayMetadata {
connection_id,
remote_ip,
remote_port,
local_port,
sni,
route_name,
initial_data_base64,
};
let metadata_json = serde_json::to_string(&metadata)
.map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?;
handler.write_all(metadata_json.as_bytes()).await?;
handler.write_all(b"\n").await?;
// Bidirectional relay between client and handler
let (mut client_read, mut client_write) = client.into_split();
let (mut handler_read, mut handler_write) = handler.into_split();
let c2h = tokio::spawn(async move {
let mut buf = vec![0u8; 65536];
loop {
let n = match client_read.read(&mut buf).await {
Ok(0) | Err(_) => break,
Ok(n) => n,
};
if handler_write.write_all(&buf[..n]).await.is_err() {
break;
}
}
let _ = handler_write.shutdown().await;
});
let h2c = tokio::spawn(async move {
let mut buf = vec![0u8; 65536];
loop {
let n = match handler_read.read(&mut buf).await {
Ok(0) | Err(_) => break,
Ok(n) => n,
};
if client_write.write_all(&buf[..n]).await.is_err() {
break;
}
}
let _ = client_write.shutdown().await;
});
let _ = tokio::join!(c2h, h2c);
debug!("Relay connection {} completed", connection_id);
Ok(())
}
/// Simple base64 encoding without external dependency.
fn base64_encode(data: &[u8]) -> String {
const CHARS: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
let mut result = String::new();
for chunk in data.chunks(3) {
let b0 = chunk[0] as u32;
let b1 = if chunk.len() > 1 { chunk[1] as u32 } else { 0 };
let b2 = if chunk.len() > 2 { chunk[2] as u32 } else { 0 };
let n = (b0 << 16) | (b1 << 8) | b2;
result.push(CHARS[((n >> 18) & 0x3F) as usize] as char);
result.push(CHARS[((n >> 12) & 0x3F) as usize] as char);
if chunk.len() > 1 {
result.push(CHARS[((n >> 6) & 0x3F) as usize] as char);
} else {
result.push('=');
}
if chunk.len() > 2 {
result.push(CHARS[(n & 0x3F) as usize] as char);
} else {
result.push('=');
}
}
result
}
@@ -16,6 +16,7 @@ use crate::sni_parser;
use crate::forwarder; use crate::forwarder;
use crate::tls_handler; use crate::tls_handler;
use crate::connection_tracker::ConnectionTracker; use crate::connection_tracker::ConnectionTracker;
use crate::connection_registry::{ConnectionEntry, ConnectionRegistry};
use crate::socket_opts; use crate::socket_opts;
/// RAII guard that decrements the active connection metric on drop. /// RAII guard that decrements the active connection metric on drop.
@@ -42,6 +43,33 @@ impl Drop for ConnectionGuard {
} }
} }
/// RAII guard for frontend+backend protocol distribution tracking.
/// Calls the appropriate _closed methods on drop for both frontend and backend.
struct ProtocolGuard {
metrics: Arc<MetricsCollector>,
frontend_proto: Option<&'static str>,
backend_proto: Option<&'static str>,
}
impl ProtocolGuard {
fn new(metrics: Arc<MetricsCollector>, frontend: &'static str, backend: &'static str) -> Self {
metrics.frontend_protocol_opened(frontend);
metrics.backend_protocol_opened(backend);
Self { metrics, frontend_proto: Some(frontend), backend_proto: Some(backend) }
}
}
impl Drop for ProtocolGuard {
fn drop(&mut self) {
if let Some(proto) = self.frontend_proto {
self.metrics.frontend_protocol_closed(proto);
}
if let Some(proto) = self.backend_proto {
self.metrics.backend_protocol_closed(proto);
}
}
}
/// RAII guard that calls ConnectionTracker::connection_closed on drop. /// RAII guard that calls ConnectionTracker::connection_closed on drop.
/// Ensures per-IP tracking is cleaned up on ALL exit paths — normal, error, or panic. /// Ensures per-IP tracking is cleaned up on ALL exit paths — normal, error, or panic.
struct ConnectionTrackerGuard { struct ConnectionTrackerGuard {
@@ -166,6 +194,8 @@ pub struct TcpListenerManager {
/// Per-route cancellation tokens (child of cancel_token). /// Per-route cancellation tokens (child of cancel_token).
/// When a route is removed, its token is cancelled, terminating all connections on that route. /// When a route is removed, its token is cancelled, terminating all connections on that route.
route_cancels: Arc<DashMap<String, CancellationToken>>, route_cancels: Arc<DashMap<String, CancellationToken>>,
/// Shared connection registry for selective recycling on config changes.
connection_registry: Arc<ConnectionRegistry>,
} }
impl TcpListenerManager { impl TcpListenerManager {
@@ -182,6 +212,7 @@ impl TcpListenerManager {
http_proxy_svc.set_backend_tls_config_alpn(tls_handler::shared_backend_tls_config_alpn()); http_proxy_svc.set_backend_tls_config_alpn(tls_handler::shared_backend_tls_config_alpn());
http_proxy_svc.set_connection_timeouts( http_proxy_svc.set_connection_timeouts(
std::time::Duration::from_millis(conn_config.socket_timeout_ms), std::time::Duration::from_millis(conn_config.socket_timeout_ms),
std::time::Duration::from_millis(conn_config.max_connection_lifetime_ms),
std::time::Duration::from_millis(conn_config.socket_timeout_ms), std::time::Duration::from_millis(conn_config.socket_timeout_ms),
std::time::Duration::from_millis(conn_config.max_connection_lifetime_ms), std::time::Duration::from_millis(conn_config.max_connection_lifetime_ms),
); );
@@ -204,6 +235,7 @@ impl TcpListenerManager {
socket_handler_relay: Arc::new(std::sync::RwLock::new(None)), socket_handler_relay: Arc::new(std::sync::RwLock::new(None)),
conn_semaphore: Arc::new(tokio::sync::Semaphore::new(max_conns)), conn_semaphore: Arc::new(tokio::sync::Semaphore::new(max_conns)),
route_cancels: Arc::new(DashMap::new()), route_cancels: Arc::new(DashMap::new()),
connection_registry: Arc::new(ConnectionRegistry::new()),
} }
} }
@@ -220,6 +252,7 @@ impl TcpListenerManager {
http_proxy_svc.set_backend_tls_config_alpn(tls_handler::shared_backend_tls_config_alpn()); http_proxy_svc.set_backend_tls_config_alpn(tls_handler::shared_backend_tls_config_alpn());
http_proxy_svc.set_connection_timeouts( http_proxy_svc.set_connection_timeouts(
std::time::Duration::from_millis(conn_config.socket_timeout_ms), std::time::Duration::from_millis(conn_config.socket_timeout_ms),
std::time::Duration::from_millis(conn_config.max_connection_lifetime_ms),
std::time::Duration::from_millis(conn_config.socket_timeout_ms), std::time::Duration::from_millis(conn_config.socket_timeout_ms),
std::time::Duration::from_millis(conn_config.max_connection_lifetime_ms), std::time::Duration::from_millis(conn_config.max_connection_lifetime_ms),
); );
@@ -242,6 +275,7 @@ impl TcpListenerManager {
socket_handler_relay: Arc::new(std::sync::RwLock::new(None)), socket_handler_relay: Arc::new(std::sync::RwLock::new(None)),
conn_semaphore: Arc::new(tokio::sync::Semaphore::new(max_conns)), conn_semaphore: Arc::new(tokio::sync::Semaphore::new(max_conns)),
route_cancels: Arc::new(DashMap::new()), route_cancels: Arc::new(DashMap::new()),
connection_registry: Arc::new(ConnectionRegistry::new()),
} }
} }
@@ -263,6 +297,7 @@ impl TcpListenerManager {
http_proxy_svc.set_backend_tls_config_alpn(tls_handler::shared_backend_tls_config_alpn()); http_proxy_svc.set_backend_tls_config_alpn(tls_handler::shared_backend_tls_config_alpn());
http_proxy_svc.set_connection_timeouts( http_proxy_svc.set_connection_timeouts(
std::time::Duration::from_millis(config.socket_timeout_ms), std::time::Duration::from_millis(config.socket_timeout_ms),
std::time::Duration::from_millis(config.max_connection_lifetime_ms),
std::time::Duration::from_millis(config.socket_timeout_ms), std::time::Duration::from_millis(config.socket_timeout_ms),
std::time::Duration::from_millis(config.max_connection_lifetime_ms), std::time::Duration::from_millis(config.max_connection_lifetime_ms),
); );
@@ -325,12 +360,13 @@ impl TcpListenerManager {
let relay = Arc::clone(&self.socket_handler_relay); let relay = Arc::clone(&self.socket_handler_relay);
let semaphore = Arc::clone(&self.conn_semaphore); let semaphore = Arc::clone(&self.conn_semaphore);
let route_cancels = Arc::clone(&self.route_cancels); let route_cancels = Arc::clone(&self.route_cancels);
let connection_registry = Arc::clone(&self.connection_registry);
let handle = tokio::spawn(async move { let handle = tokio::spawn(async move {
Self::accept_loop( Self::accept_loop(
listener, port, route_manager_swap, metrics, tls_configs, listener, port, route_manager_swap, metrics, tls_configs,
shared_tls_acceptor, http_proxy, conn_config, conn_tracker, cancel, relay, shared_tls_acceptor, http_proxy, conn_config, conn_tracker, cancel, relay,
semaphore, route_cancels, semaphore, route_cancels, connection_registry,
).await; ).await;
}); });
@@ -443,6 +479,16 @@ impl TcpListenerManager {
&self.metrics &self.metrics
} }
/// Get a reference to the shared connection registry.
pub fn connection_registry(&self) -> &Arc<ConnectionRegistry> {
&self.connection_registry
}
/// Get a reference to the per-route cancellation tokens.
pub fn route_cancels(&self) -> &Arc<DashMap<String, CancellationToken>> {
&self.route_cancels
}
/// Accept loop for a single port. /// Accept loop for a single port.
async fn accept_loop( async fn accept_loop(
listener: TcpListener, listener: TcpListener,
@@ -458,6 +504,7 @@ impl TcpListenerManager {
socket_handler_relay: Arc<std::sync::RwLock<Option<String>>>, socket_handler_relay: Arc<std::sync::RwLock<Option<String>>>,
conn_semaphore: Arc<tokio::sync::Semaphore>, conn_semaphore: Arc<tokio::sync::Semaphore>,
route_cancels: Arc<DashMap<String, CancellationToken>>, route_cancels: Arc<DashMap<String, CancellationToken>>,
connection_registry: Arc<ConnectionRegistry>,
) { ) {
loop { loop {
tokio::select! { tokio::select! {
@@ -511,6 +558,7 @@ impl TcpListenerManager {
let cn = cancel.clone(); let cn = cancel.clone();
let sr = Arc::clone(&socket_handler_relay); let sr = Arc::clone(&socket_handler_relay);
let rc = Arc::clone(&route_cancels); let rc = Arc::clone(&route_cancels);
let cr = Arc::clone(&connection_registry);
debug!("Accepted connection from {} on port {}", peer_addr, port); debug!("Accepted connection from {} on port {}", peer_addr, port);
tokio::spawn(async move { tokio::spawn(async move {
@@ -519,7 +567,7 @@ impl TcpListenerManager {
// RAII guard ensures connection_closed is called on all paths // RAII guard ensures connection_closed is called on all paths
let _ct_guard = ConnectionTrackerGuard::new(ct, ip); let _ct_guard = ConnectionTrackerGuard::new(ct, ip);
let result = Self::handle_connection( let result = Self::handle_connection(
stream, port, peer_addr, rm, m, tc, sa, hp, cc, cn, sr, rc, stream, port, peer_addr, rm, m, tc, sa, hp, cc, cn, sr, rc, cr,
).await; ).await;
if let Err(e) = result { if let Err(e) = result {
warn!("Connection error from {}: {}", peer_addr, e); warn!("Connection error from {}: {}", peer_addr, e);
@@ -550,6 +598,7 @@ impl TcpListenerManager {
cancel: CancellationToken, cancel: CancellationToken,
socket_handler_relay: Arc<std::sync::RwLock<Option<String>>>, socket_handler_relay: Arc<std::sync::RwLock<Option<String>>>,
route_cancels: Arc<DashMap<String, CancellationToken>>, route_cancels: Arc<DashMap<String, CancellationToken>>,
connection_registry: Arc<ConnectionRegistry>,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> { ) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
use tokio::io::AsyncReadExt; use tokio::io::AsyncReadExt;
@@ -669,17 +718,29 @@ impl TcpListenerManager {
let route_id = quick_match.route.id.as_deref(); let route_id = quick_match.route.id.as_deref();
// Resolve per-route cancel token (child of global cancel) // Resolve per-route cancel token (child of global cancel)
let conn_cancel = match route_id { let route_cancel = match route_id {
Some(id) => route_cancels.entry(id.to_string()) Some(id) => route_cancels.entry(id.to_string())
.or_insert_with(|| cancel.child_token()) .or_insert_with(|| cancel.child_token())
.clone(), .clone(),
None => cancel.clone(), None => cancel.clone(),
}; };
// Per-connection child token for selective recycling
let conn_cancel = route_cancel.child_token();
// Check route-level IP security // Register in connection registry for selective recycling
let (_conn_id, _registry_guard) = connection_registry.register(
ConnectionEntry {
cancel: conn_cancel.clone(),
source_ip: peer_addr.ip(),
domain: None, // fast path has no domain
route_id: route_id.map(|s| s.to_string()),
},
);
// Check route-level IP security (fast path: no SNI available)
if let Some(ref security) = quick_match.route.security { if let Some(ref security) = quick_match.route.security {
if !rustproxy_http::request_filter::RequestFilter::check_ip_security( if !rustproxy_http::request_filter::RequestFilter::check_ip_security(
security, &peer_addr.ip(), security, &peer_addr.ip(), None,
) { ) {
warn!("Connection from {} blocked by route security", peer_addr); warn!("Connection from {} blocked by route security", peer_addr);
return Ok(()); return Ok(());
@@ -849,18 +910,31 @@ impl TcpListenerManager {
// Resolve per-route cancel token (child of global cancel). // Resolve per-route cancel token (child of global cancel).
// When this route is removed via updateRoutes, the token is cancelled, // When this route is removed via updateRoutes, the token is cancelled,
// terminating all connections on this route. // terminating all connections on this route.
let cancel = match route_id { let route_cancel = match route_id {
Some(id) => route_cancels.entry(id.to_string()) Some(id) => route_cancels.entry(id.to_string())
.or_insert_with(|| cancel.child_token()) .or_insert_with(|| cancel.child_token())
.clone(), .clone(),
None => cancel, None => cancel,
}; };
// Per-connection child token for selective recycling
let cancel = route_cancel.child_token();
// Check route-level IP security for passthrough connections // Register in connection registry for selective recycling
let (_conn_id, _registry_guard) = connection_registry.register(
ConnectionEntry {
cancel: cancel.clone(),
source_ip: peer_addr.ip(),
domain: domain.clone(),
route_id: route_id.map(|s| s.to_string()),
},
);
// Check route-level IP security for passthrough connections (SNI available)
if let Some(ref security) = route_match.route.security { if let Some(ref security) = route_match.route.security {
if !rustproxy_http::request_filter::RequestFilter::check_ip_security( if !rustproxy_http::request_filter::RequestFilter::check_ip_security(
security, security,
&peer_addr.ip(), &peer_addr.ip(),
domain.as_deref(),
) { ) {
warn!("Connection from {} blocked by route security", peer_addr); warn!("Connection from {} blocked by route security", peer_addr);
return Ok(()); return Ok(());
@@ -869,6 +943,9 @@ impl TcpListenerManager {
// Track connection in metrics — guard ensures connection_closed on all exit paths // Track connection in metrics — guard ensures connection_closed on all exit paths
metrics.connection_opened(route_id, Some(&ip_str)); metrics.connection_opened(route_id, Some(&ip_str));
if let Some(d) = effective_domain {
metrics.record_ip_domain_request(&ip_str, d);
}
let _conn_guard = ConnectionGuard::new(Arc::clone(&metrics), route_id, Some(&ip_str)); let _conn_guard = ConnectionGuard::new(Arc::clone(&metrics), route_id, Some(&ip_str));
// Check if this is a socket-handler route that should be relayed to TypeScript // Check if this is a socket-handler route that should be relayed to TypeScript
@@ -978,6 +1055,9 @@ impl TcpListenerManager {
peer_addr, target_host, target_port, domain peer_addr, target_host, target_port, domain
); );
// Track as "other" protocol (non-HTTP passthrough)
let _proto_guard = ProtocolGuard::new(Arc::clone(&metrics), "other", "other");
let mut actual_buf = vec![0u8; n]; let mut actual_buf = vec![0u8; n];
stream.read_exact(&mut actual_buf).await?; stream.read_exact(&mut actual_buf).await?;
@@ -1044,6 +1124,8 @@ impl TcpListenerManager {
"TLS Terminate + TCP: {} -> {}:{} (domain: {:?})", "TLS Terminate + TCP: {} -> {}:{} (domain: {:?})",
peer_addr, target_host, target_port, domain peer_addr, target_host, target_port, domain
); );
// Track as "other" protocol (TLS-terminated non-HTTP)
let _proto_guard = ProtocolGuard::new(Arc::clone(&metrics), "other", "other");
// Raw TCP forwarding of decrypted stream // Raw TCP forwarding of decrypted stream
let backend = match tokio::time::timeout( let backend = match tokio::time::timeout(
connect_timeout, connect_timeout,
@@ -1130,6 +1212,8 @@ impl TcpListenerManager {
"TLS Terminate+Reencrypt + TCP: {} -> {}:{}", "TLS Terminate+Reencrypt + TCP: {} -> {}:{}",
peer_addr, target_host, target_port peer_addr, target_host, target_port
); );
// Track as "other" protocol (TLS-terminated non-HTTP, re-encrypted)
let _proto_guard = ProtocolGuard::new(Arc::clone(&metrics), "other", "other");
Self::handle_tls_reencrypt_tunnel( Self::handle_tls_reencrypt_tunnel(
buf_stream, &target_host, target_port, buf_stream, &target_host, target_port,
peer_addr, Arc::clone(&metrics), route_id, peer_addr, Arc::clone(&metrics), route_id,
@@ -1146,6 +1230,8 @@ impl TcpListenerManager {
Ok(()) Ok(())
} else { } else {
// Plain TCP forwarding (non-HTTP) // Plain TCP forwarding (non-HTTP)
// Track as "other" protocol (plain TCP, non-HTTP)
let _proto_guard = ProtocolGuard::new(Arc::clone(&metrics), "other", "other");
let mut backend = match tokio::time::timeout( let mut backend = match tokio::time::timeout(
connect_timeout, connect_timeout,
tokio::net::TcpStream::connect(format!("{}:{}", target_host, target_port)), tokio::net::TcpStream::connect(format!("{}:{}", target_host, target_port)),
@@ -28,6 +28,8 @@ use rustproxy_routing::{MatchContext, RouteManager};
use rustproxy_http::h3_service::H3ProxyService; use rustproxy_http::h3_service::H3ProxyService;
use crate::connection_registry::ConnectionRegistry;
use crate::connection_tracker::ConnectionTracker; use crate::connection_tracker::ConnectionTracker;
use crate::udp_session::{SessionKey, UdpSession, UdpSessionConfig, UdpSessionTable}; use crate::udp_session::{SessionKey, UdpSession, UdpSessionConfig, UdpSessionTable};
@@ -56,6 +58,10 @@ pub struct UdpListenerManager {
/// Trusted proxy IPs that may send PROXY protocol v2 headers. /// Trusted proxy IPs that may send PROXY protocol v2 headers.
/// When non-empty, PROXY v2 detection is enabled on both raw UDP and QUIC paths. /// When non-empty, PROXY v2 detection is enabled on both raw UDP and QUIC paths.
proxy_ips: Arc<Vec<IpAddr>>, proxy_ips: Arc<Vec<IpAddr>>,
/// Per-route cancellation tokens (shared with TcpListenerManager).
route_cancels: Arc<DashMap<String, CancellationToken>>,
/// Shared connection registry for selective recycling.
connection_registry: Arc<ConnectionRegistry>,
} }
impl Drop for UdpListenerManager { impl Drop for UdpListenerManager {
@@ -76,6 +82,8 @@ impl UdpListenerManager {
metrics: Arc<MetricsCollector>, metrics: Arc<MetricsCollector>,
conn_tracker: Arc<ConnectionTracker>, conn_tracker: Arc<ConnectionTracker>,
cancel_token: CancellationToken, cancel_token: CancellationToken,
route_cancels: Arc<DashMap<String, CancellationToken>>,
connection_registry: Arc<ConnectionRegistry>,
) -> Self { ) -> Self {
Self { Self {
listeners: HashMap::new(), listeners: HashMap::new(),
@@ -89,6 +97,8 @@ impl UdpListenerManager {
relay_reader_cancel: None, relay_reader_cancel: None,
h3_service: None, h3_service: None,
proxy_ips: Arc::new(Vec::new()), proxy_ips: Arc::new(Vec::new()),
route_cancels,
connection_registry,
} }
} }
@@ -152,6 +162,8 @@ impl UdpListenerManager {
self.cancel_token.child_token(), self.cancel_token.child_token(),
self.h3_service.clone(), self.h3_service.clone(),
None, None,
Arc::clone(&self.route_cancels),
Arc::clone(&self.connection_registry),
)); ));
self.listeners.insert(port, (handle, Some(endpoint_for_updates))); self.listeners.insert(port, (handle, Some(endpoint_for_updates)));
info!("QUIC endpoint started on port {}", port); info!("QUIC endpoint started on port {}", port);
@@ -173,6 +185,8 @@ impl UdpListenerManager {
self.cancel_token.child_token(), self.cancel_token.child_token(),
self.h3_service.clone(), self.h3_service.clone(),
Some(relay.real_client_map), Some(relay.real_client_map),
Arc::clone(&self.route_cancels),
Arc::clone(&self.connection_registry),
)); ));
self.listeners.insert(port, (handle, Some(endpoint_for_updates))); self.listeners.insert(port, (handle, Some(endpoint_for_updates)));
info!("QUIC endpoint with PROXY relay started on port {}", port); info!("QUIC endpoint with PROXY relay started on port {}", port);
@@ -356,6 +370,8 @@ impl UdpListenerManager {
self.cancel_token.child_token(), self.cancel_token.child_token(),
self.h3_service.clone(), self.h3_service.clone(),
None, None,
Arc::clone(&self.route_cancels),
Arc::clone(&self.connection_registry),
)); ));
self.listeners.insert(port, (handle, Some(endpoint_for_updates))); self.listeners.insert(port, (handle, Some(endpoint_for_updates)));
Ok(()) Ok(())
@@ -379,6 +395,8 @@ impl UdpListenerManager {
self.cancel_token.child_token(), self.cancel_token.child_token(),
self.h3_service.clone(), self.h3_service.clone(),
Some(relay.real_client_map), Some(relay.real_client_map),
Arc::clone(&self.route_cancels),
Arc::clone(&self.connection_registry),
)); ));
self.listeners.insert(port, (handle, Some(endpoint_for_updates))); self.listeners.insert(port, (handle, Some(endpoint_for_updates)));
Ok(()) Ok(())
@@ -1,5 +1,42 @@
use std::collections::HashMap;
use regex::Regex; use regex::Regex;
use std::collections::HashMap;
fn compile_regex_pattern(pattern: &str) -> Option<Regex> {
if !pattern.starts_with('/') {
return None;
}
let last_slash = pattern.rfind('/')?;
if last_slash == 0 {
return None;
}
let regex_body = &pattern[1..last_slash];
let flags = &pattern[last_slash + 1..];
let mut inline_flags = String::new();
for flag in flags.chars() {
match flag {
'i' | 'm' | 's' | 'u' => {
if !inline_flags.contains(flag) {
inline_flags.push(flag);
}
}
'g' => {
// Global has no effect for single header matching.
}
_ => return None,
}
}
let compiled = if inline_flags.is_empty() {
regex_body.to_string()
} else {
format!("(?{}){}", inline_flags, regex_body)
};
Regex::new(&compiled).ok()
}
/// Match HTTP headers against a set of patterns. /// Match HTTP headers against a set of patterns.
/// ///
@@ -24,16 +61,15 @@ pub fn headers_match(
None => return false, // Required header not present None => return false, // Required header not present
}; };
// Check if pattern is a regex (surrounded by /) // Check if pattern is a regex literal (/pattern/ or /pattern/flags)
if pattern.starts_with('/') && pattern.ends_with('/') && pattern.len() > 2 { if pattern.starts_with('/') && pattern.len() > 2 {
let regex_str = &pattern[1..pattern.len() - 1]; match compile_regex_pattern(pattern) {
match Regex::new(regex_str) { Some(re) => {
Ok(re) => {
if !re.is_match(header_value) { if !re.is_match(header_value) {
return false; return false;
} }
} }
Err(_) => { None => {
// Invalid regex, fall back to exact match // Invalid regex, fall back to exact match
if header_value != pattern { if header_value != pattern {
return false; return false;
@@ -85,6 +121,24 @@ mod tests {
assert!(headers_match(&patterns, &headers)); assert!(headers_match(&patterns, &headers));
} }
#[test]
fn test_regex_header_match_with_flags() {
let patterns: HashMap<String, String> = {
let mut m = HashMap::new();
m.insert(
"Content-Type".to_string(),
"/^application\\/json$/i".to_string(),
);
m
};
let headers: HashMap<String, String> = {
let mut m = HashMap::new();
m.insert("content-type".to_string(), "Application/JSON".to_string());
m
};
assert!(headers_match(&patterns, &headers));
}
#[test] #[test]
fn test_missing_header() { fn test_missing_header() {
let patterns: HashMap<String, String> = { let patterns: HashMap<String, String> = {
@@ -281,6 +281,11 @@ impl RouteManager {
.unwrap_or_default() .unwrap_or_default()
} }
/// Get all enabled routes.
pub fn routes(&self) -> &[RouteConfig] {
&self.routes
}
/// Get the total number of enabled routes. /// Get the total number of enabled routes.
pub fn route_count(&self) -> usize { pub fn route_count(&self) -> usize {
self.routes.len() self.routes.len()
@@ -355,8 +360,6 @@ mod tests {
load_balancing: None, load_balancing: None,
advanced: None, advanced: None,
options: None, options: None,
forwarding_engine: None,
nftables: None,
send_proxy_protocol: None, send_proxy_protocol: None,
udp: None, udp: None,
}, },
+194 -37
View File
@@ -2,12 +2,24 @@ use ipnet::IpNet;
use std::net::IpAddr; use std::net::IpAddr;
use std::str::FromStr; use std::str::FromStr;
use rustproxy_config::IpAllowEntry;
/// IP filter supporting CIDR ranges, wildcards, and exact matches. /// IP filter supporting CIDR ranges, wildcards, and exact matches.
/// Supports domain-scoped allow entries that restrict an IP to specific domains.
pub struct IpFilter { pub struct IpFilter {
/// Plain allow entries — IP allowed for any domain on the route
allow_list: Vec<IpPattern>, allow_list: Vec<IpPattern>,
/// Domain-scoped allow entries — IP allowed only for matching domains
domain_scoped: Vec<DomainScopedEntry>,
block_list: Vec<IpPattern>, block_list: Vec<IpPattern>,
} }
/// A domain-scoped allow entry: IP + list of allowed domain patterns.
struct DomainScopedEntry {
pattern: IpPattern,
domains: Vec<String>,
}
/// Represents an IP pattern for matching. /// Represents an IP pattern for matching.
#[derive(Debug)] #[derive(Debug)]
enum IpPattern { enum IpPattern {
@@ -31,10 +43,6 @@ impl IpPattern {
if let Ok(addr) = IpAddr::from_str(s) { if let Ok(addr) = IpAddr::from_str(s) {
return IpPattern::Exact(addr); return IpPattern::Exact(addr);
} }
// Try as CIDR by appending default prefix
if let Ok(addr) = IpAddr::from_str(s) {
return IpPattern::Exact(addr);
}
// Fallback: treat as exact, will never match an invalid string // Fallback: treat as exact, will never match an invalid string
IpPattern::Exact(IpAddr::from_str("0.0.0.0").unwrap()) IpPattern::Exact(IpAddr::from_str("0.0.0.0").unwrap())
} }
@@ -48,19 +56,56 @@ impl IpPattern {
} }
} }
/// Simple domain pattern matching (exact, `*`, or `*.suffix`).
fn domain_matches_pattern(pattern: &str, domain: &str) -> bool {
let p = pattern.trim();
let d = domain.trim();
if p == "*" {
return true;
}
if p.eq_ignore_ascii_case(d) {
return true;
}
if p.starts_with("*.") {
let suffix = &p[1..]; // e.g., ".abc.xyz"
d.len() > suffix.len()
&& d[d.len() - suffix.len()..].eq_ignore_ascii_case(suffix)
} else {
false
}
}
impl IpFilter { impl IpFilter {
/// Create a new IP filter from allow and block lists. /// Create a new IP filter from allow entries and a block list.
pub fn new(allow_list: &[String], block_list: &[String]) -> Self { pub fn new(allow_entries: &[IpAllowEntry], block_list: &[String]) -> Self {
let mut allow_list = Vec::new();
let mut domain_scoped = Vec::new();
for entry in allow_entries {
match entry {
IpAllowEntry::Plain(ip) => {
allow_list.push(IpPattern::parse(ip));
}
IpAllowEntry::DomainScoped { ip, domains } => {
domain_scoped.push(DomainScopedEntry {
pattern: IpPattern::parse(ip),
domains: domains.clone(),
});
}
}
}
Self { Self {
allow_list: allow_list.iter().map(|s| IpPattern::parse(s)).collect(), allow_list,
domain_scoped,
block_list: block_list.iter().map(|s| IpPattern::parse(s)).collect(), block_list: block_list.iter().map(|s| IpPattern::parse(s)).collect(),
} }
} }
/// Check if an IP is allowed. /// Check if an IP is allowed, considering domain-scoped entries.
/// If allow_list is non-empty, IP must match at least one entry. /// If `domain` is Some, domain-scoped entries are evaluated against it.
/// If block_list is non-empty, IP must NOT match any entry. /// If `domain` is None, only plain allow entries are considered.
pub fn is_allowed(&self, ip: &IpAddr) -> bool { pub fn is_allowed_for_domain(&self, ip: &IpAddr, domain: Option<&str>) -> bool {
// Check block list first // Check block list first
if !self.block_list.is_empty() { if !self.block_list.is_empty() {
for pattern in &self.block_list { for pattern in &self.block_list {
@@ -70,14 +115,36 @@ impl IpFilter {
} }
} }
// If allow list is non-empty, must match at least one // If there are any allow entries (plain or domain-scoped), IP must match
if !self.allow_list.is_empty() { let has_any_allow = !self.allow_list.is_empty() || !self.domain_scoped.is_empty();
return self.allow_list.iter().any(|p| p.matches(ip)); if has_any_allow {
// Check plain allow list — grants access to entire route
if self.allow_list.iter().any(|p| p.matches(ip)) {
return true;
}
// Check domain-scoped entries — grants access only if domain matches
if let Some(req_domain) = domain {
for entry in &self.domain_scoped {
if entry.pattern.matches(ip) {
if entry.domains.iter().any(|d| domain_matches_pattern(d, req_domain)) {
return true;
}
}
}
}
return false;
} }
true true
} }
/// Check if an IP is allowed (backwards-compat wrapper, no domain context).
pub fn is_allowed(&self, ip: &IpAddr) -> bool {
self.is_allowed_for_domain(ip, None)
}
/// Normalize IPv4-mapped IPv6 addresses (::ffff:x.x.x.x -> x.x.x.x) /// Normalize IPv4-mapped IPv6 addresses (::ffff:x.x.x.x -> x.x.x.x)
pub fn normalize_ip(ip: &IpAddr) -> IpAddr { pub fn normalize_ip(ip: &IpAddr) -> IpAddr {
match ip { match ip {
@@ -97,19 +164,28 @@ impl IpFilter {
mod tests { mod tests {
use super::*; use super::*;
fn plain(s: &str) -> IpAllowEntry {
IpAllowEntry::Plain(s.to_string())
}
fn scoped(ip: &str, domains: &[&str]) -> IpAllowEntry {
IpAllowEntry::DomainScoped {
ip: ip.to_string(),
domains: domains.iter().map(|s| s.to_string()).collect(),
}
}
#[test] #[test]
fn test_empty_lists_allow_all() { fn test_empty_lists_allow_all() {
let filter = IpFilter::new(&[], &[]); let filter = IpFilter::new(&[], &[]);
let ip: IpAddr = "192.168.1.1".parse().unwrap(); let ip: IpAddr = "192.168.1.1".parse().unwrap();
assert!(filter.is_allowed(&ip)); assert!(filter.is_allowed(&ip));
assert!(filter.is_allowed_for_domain(&ip, Some("example.com")));
} }
#[test] #[test]
fn test_allow_list_exact() { fn test_plain_allow_list_exact() {
let filter = IpFilter::new( let filter = IpFilter::new(&[plain("10.0.0.1")], &[]);
&["10.0.0.1".to_string()],
&[],
);
let allowed: IpAddr = "10.0.0.1".parse().unwrap(); let allowed: IpAddr = "10.0.0.1".parse().unwrap();
let denied: IpAddr = "10.0.0.2".parse().unwrap(); let denied: IpAddr = "10.0.0.2".parse().unwrap();
assert!(filter.is_allowed(&allowed)); assert!(filter.is_allowed(&allowed));
@@ -117,11 +193,8 @@ mod tests {
} }
#[test] #[test]
fn test_allow_list_cidr() { fn test_plain_allow_list_cidr() {
let filter = IpFilter::new( let filter = IpFilter::new(&[plain("10.0.0.0/8")], &[]);
&["10.0.0.0/8".to_string()],
&[],
);
let allowed: IpAddr = "10.255.255.255".parse().unwrap(); let allowed: IpAddr = "10.255.255.255".parse().unwrap();
let denied: IpAddr = "192.168.1.1".parse().unwrap(); let denied: IpAddr = "192.168.1.1".parse().unwrap();
assert!(filter.is_allowed(&allowed)); assert!(filter.is_allowed(&allowed));
@@ -130,10 +203,7 @@ mod tests {
#[test] #[test]
fn test_block_list() { fn test_block_list() {
let filter = IpFilter::new( let filter = IpFilter::new(&[], &["192.168.1.100".to_string()]);
&[],
&["192.168.1.100".to_string()],
);
let blocked: IpAddr = "192.168.1.100".parse().unwrap(); let blocked: IpAddr = "192.168.1.100".parse().unwrap();
let allowed: IpAddr = "192.168.1.101".parse().unwrap(); let allowed: IpAddr = "192.168.1.101".parse().unwrap();
assert!(!filter.is_allowed(&blocked)); assert!(!filter.is_allowed(&blocked));
@@ -143,7 +213,7 @@ mod tests {
#[test] #[test]
fn test_block_trumps_allow() { fn test_block_trumps_allow() {
let filter = IpFilter::new( let filter = IpFilter::new(
&["10.0.0.0/8".to_string()], &[plain("10.0.0.0/8")],
&["10.0.0.5".to_string()], &["10.0.0.5".to_string()],
); );
let blocked: IpAddr = "10.0.0.5".parse().unwrap(); let blocked: IpAddr = "10.0.0.5".parse().unwrap();
@@ -154,20 +224,14 @@ mod tests {
#[test] #[test]
fn test_wildcard_allow() { fn test_wildcard_allow() {
let filter = IpFilter::new( let filter = IpFilter::new(&[plain("*")], &[]);
&["*".to_string()],
&[],
);
let ip: IpAddr = "1.2.3.4".parse().unwrap(); let ip: IpAddr = "1.2.3.4".parse().unwrap();
assert!(filter.is_allowed(&ip)); assert!(filter.is_allowed(&ip));
} }
#[test] #[test]
fn test_wildcard_block() { fn test_wildcard_block() {
let filter = IpFilter::new( let filter = IpFilter::new(&[], &["*".to_string()]);
&[],
&["*".to_string()],
);
let ip: IpAddr = "1.2.3.4".parse().unwrap(); let ip: IpAddr = "1.2.3.4".parse().unwrap();
assert!(!filter.is_allowed(&ip)); assert!(!filter.is_allowed(&ip));
} }
@@ -186,4 +250,97 @@ mod tests {
let normalized = IpFilter::normalize_ip(&ip); let normalized = IpFilter::normalize_ip(&ip);
assert_eq!(normalized, ip); assert_eq!(normalized, ip);
} }
// Domain-scoped tests
#[test]
fn test_domain_scoped_allows_matching_domain() {
let filter = IpFilter::new(
&[scoped("10.8.0.2", &["outline.abc.xyz"])],
&[],
);
let ip: IpAddr = "10.8.0.2".parse().unwrap();
assert!(filter.is_allowed_for_domain(&ip, Some("outline.abc.xyz")));
}
#[test]
fn test_domain_scoped_denies_non_matching_domain() {
let filter = IpFilter::new(
&[scoped("10.8.0.2", &["outline.abc.xyz"])],
&[],
);
let ip: IpAddr = "10.8.0.2".parse().unwrap();
assert!(!filter.is_allowed_for_domain(&ip, Some("app.abc.xyz")));
}
#[test]
fn test_domain_scoped_denies_without_domain() {
let filter = IpFilter::new(
&[scoped("10.8.0.2", &["outline.abc.xyz"])],
&[],
);
let ip: IpAddr = "10.8.0.2".parse().unwrap();
// Without domain context, domain-scoped entries cannot match
assert!(!filter.is_allowed_for_domain(&ip, None));
}
#[test]
fn test_domain_scoped_wildcard_domain() {
let filter = IpFilter::new(
&[scoped("10.8.0.2", &["*.abc.xyz"])],
&[],
);
let ip: IpAddr = "10.8.0.2".parse().unwrap();
assert!(filter.is_allowed_for_domain(&ip, Some("outline.abc.xyz")));
assert!(filter.is_allowed_for_domain(&ip, Some("app.abc.xyz")));
assert!(!filter.is_allowed_for_domain(&ip, Some("other.com")));
}
#[test]
fn test_plain_and_domain_scoped_coexist() {
let filter = IpFilter::new(
&[
plain("1.2.3.4"), // full route access
scoped("10.8.0.2", &["outline.abc.xyz"]), // scoped access
],
&[],
);
let admin: IpAddr = "1.2.3.4".parse().unwrap();
let vpn: IpAddr = "10.8.0.2".parse().unwrap();
let other: IpAddr = "9.9.9.9".parse().unwrap();
// Admin IP has full access
assert!(filter.is_allowed_for_domain(&admin, Some("anything.abc.xyz")));
assert!(filter.is_allowed_for_domain(&admin, Some("outline.abc.xyz")));
// VPN IP only has scoped access
assert!(filter.is_allowed_for_domain(&vpn, Some("outline.abc.xyz")));
assert!(!filter.is_allowed_for_domain(&vpn, Some("app.abc.xyz")));
// Unknown IP denied
assert!(!filter.is_allowed_for_domain(&other, Some("outline.abc.xyz")));
}
#[test]
fn test_block_trumps_domain_scoped() {
let filter = IpFilter::new(
&[scoped("10.8.0.2", &["outline.abc.xyz"])],
&["10.8.0.2".to_string()],
);
let ip: IpAddr = "10.8.0.2".parse().unwrap();
assert!(!filter.is_allowed_for_domain(&ip, Some("outline.abc.xyz")));
}
#[test]
fn test_domain_matches_pattern_fn() {
assert!(domain_matches_pattern("example.com", "example.com"));
assert!(domain_matches_pattern("*.abc.xyz", "outline.abc.xyz"));
assert!(domain_matches_pattern("*.abc.xyz", "app.abc.xyz"));
assert!(!domain_matches_pattern("*.abc.xyz", "abc.xyz")); // suffix only, not exact parent
assert!(domain_matches_pattern("*", "anything.com"));
assert!(!domain_matches_pattern("outline.abc.xyz", "app.abc.xyz"));
// Case insensitive
assert!(domain_matches_pattern("*.ABC.XYZ", "outline.abc.xyz"));
}
} }
-1
View File
@@ -20,7 +20,6 @@ rustproxy-routing = { workspace = true }
rustproxy-tls = { workspace = true } rustproxy-tls = { workspace = true }
rustproxy-passthrough = { workspace = true } rustproxy-passthrough = { workspace = true }
rustproxy-http = { workspace = true } rustproxy-http = { workspace = true }
rustproxy-nftables = { workspace = true }
rustproxy-metrics = { workspace = true } rustproxy-metrics = { workspace = true }
rustproxy-security = { workspace = true } rustproxy-security = { workspace = true }
tokio = { workspace = true } tokio = { workspace = true }
+112 -118
View File
@@ -7,14 +7,40 @@
//! //!
//! ```rust,no_run //! ```rust,no_run
//! use rustproxy::RustProxy; //! use rustproxy::RustProxy;
//! use rustproxy_config::{RustProxyOptions, create_https_passthrough_route}; //! use rustproxy_config::*;
//! //!
//! #[tokio::main] //! #[tokio::main]
//! async fn main() -> anyhow::Result<()> { //! async fn main() -> anyhow::Result<()> {
//! let options = RustProxyOptions { //! let options = RustProxyOptions {
//! routes: vec![ //! routes: vec![RouteConfig {
//! create_https_passthrough_route("example.com", "backend", 443), //! id: None,
//! ], //! route_match: RouteMatch {
//! ports: PortRange::Single(443),
//! domains: Some(DomainSpec::Single("example.com".to_string())),
//! path: None, client_ip: None, transport: None,
//! tls_version: None, headers: None, protocol: None,
//! },
//! action: RouteAction {
//! action_type: RouteActionType::Forward,
//! targets: Some(vec![RouteTarget {
//! target_match: None,
//! host: HostSpec::Single("backend".to_string()),
//! port: PortSpec::Fixed(443),
//! tls: None, websocket: None, load_balancing: None,
//! send_proxy_protocol: None, headers: None, advanced: None,
//! backend_transport: None, priority: None,
//! }]),
//! tls: Some(RouteTls {
//! mode: TlsMode::Passthrough,
//! certificate: None, acme: None, versions: None,
//! ciphers: None, honor_cipher_order: None, session_timeout: None,
//! }),
//! websocket: None, load_balancing: None, advanced: None,
//! options: None, send_proxy_protocol: None, udp: None,
//! },
//! headers: None, security: None, name: None, description: None,
//! priority: None, tags: None, enabled: None,
//! }],
//! ..Default::default() //! ..Default::default()
//! }; //! };
//! //!
@@ -41,16 +67,14 @@ pub use rustproxy_routing;
pub use rustproxy_passthrough; pub use rustproxy_passthrough;
pub use rustproxy_tls; pub use rustproxy_tls;
pub use rustproxy_http; pub use rustproxy_http;
pub use rustproxy_nftables;
pub use rustproxy_metrics; pub use rustproxy_metrics;
pub use rustproxy_security; pub use rustproxy_security;
use rustproxy_config::{RouteConfig, RustProxyOptions, TlsMode, CertificateSpec, ForwardingEngine}; use rustproxy_config::{RouteConfig, RustProxyOptions, TlsMode, CertificateSpec};
use rustproxy_routing::RouteManager; use rustproxy_routing::RouteManager;
use rustproxy_passthrough::{TcpListenerManager, UdpListenerManager, TlsCertConfig, ConnectionConfig}; use rustproxy_passthrough::{TcpListenerManager, UdpListenerManager, TlsCertConfig, ConnectionConfig};
use rustproxy_metrics::{MetricsCollector, Metrics, Statistics}; use rustproxy_metrics::{MetricsCollector, Metrics, Statistics};
use rustproxy_tls::{CertManager, CertStore, CertBundle, CertMetadata, CertSource}; use rustproxy_tls::{CertManager, CertStore, CertBundle, CertMetadata, CertSource};
use rustproxy_nftables::{NftManager, rule_builder};
use tokio_util::sync::CancellationToken; use tokio_util::sync::CancellationToken;
/// Certificate status. /// Certificate status.
@@ -74,7 +98,6 @@ pub struct RustProxy {
challenge_server: Option<challenge_server::ChallengeServer>, challenge_server: Option<challenge_server::ChallengeServer>,
renewal_handle: Option<tokio::task::JoinHandle<()>>, renewal_handle: Option<tokio::task::JoinHandle<()>>,
sampling_handle: Option<tokio::task::JoinHandle<()>>, sampling_handle: Option<tokio::task::JoinHandle<()>>,
nft_manager: Option<NftManager>,
started: bool, started: bool,
started_at: Option<Instant>, started_at: Option<Instant>,
/// Shared path to a Unix domain socket for relaying socket-handler connections back to TypeScript. /// Shared path to a Unix domain socket for relaying socket-handler connections back to TypeScript.
@@ -121,7 +144,6 @@ impl RustProxy {
challenge_server: None, challenge_server: None,
renewal_handle: None, renewal_handle: None,
sampling_handle: None, sampling_handle: None,
nft_manager: None,
started: false, started: false,
started_at: None, started_at: None,
socket_handler_relay: Arc::new(std::sync::RwLock::new(None)), socket_handler_relay: Arc::new(std::sync::RwLock::new(None)),
@@ -176,7 +198,9 @@ impl RustProxy {
}; };
if let Some(ref allow_list) = default_security.ip_allow_list { if let Some(ref allow_list) = default_security.ip_allow_list {
security.ip_allow_list = Some(allow_list.clone()); security.ip_allow_list = Some(
allow_list.iter().map(|s| rustproxy_config::IpAllowEntry::Plain(s.clone())).collect()
);
} }
if let Some(ref block_list) = default_security.ip_block_list { if let Some(ref block_list) = default_security.ip_block_list {
security.ip_block_list = Some(block_list.clone()); security.ip_block_list = Some(block_list.clone());
@@ -334,12 +358,17 @@ impl RustProxy {
// Bind UDP ports (if any) // Bind UDP ports (if any)
if !udp_ports.is_empty() { if !udp_ports.is_empty() {
let conn_tracker = self.listener_manager.as_ref().unwrap().conn_tracker().clone(); let tcp_mgr = self.listener_manager.as_ref().unwrap();
let conn_tracker = tcp_mgr.conn_tracker().clone();
let route_cancels = tcp_mgr.route_cancels().clone();
let connection_registry = tcp_mgr.connection_registry().clone();
let mut udp_mgr = UdpListenerManager::new( let mut udp_mgr = UdpListenerManager::new(
Arc::clone(&*self.route_table.load()), Arc::clone(&*self.route_table.load()),
Arc::clone(&self.metrics), Arc::clone(&self.metrics),
conn_tracker, conn_tracker,
self.cancel_token.clone(), self.cancel_token.clone(),
route_cancels,
connection_registry,
); );
udp_mgr.set_proxy_ips(udp_proxy_ips.clone()); udp_mgr.set_proxy_ips(udp_proxy_ips.clone());
@@ -363,6 +392,7 @@ impl RustProxy {
// Start the throughput sampling task with cooperative cancellation // Start the throughput sampling task with cooperative cancellation
let metrics = Arc::clone(&self.metrics); let metrics = Arc::clone(&self.metrics);
let conn_tracker = self.listener_manager.as_ref().unwrap().conn_tracker().clone(); let conn_tracker = self.listener_manager.as_ref().unwrap().conn_tracker().clone();
let http_proxy = self.listener_manager.as_ref().unwrap().http_proxy().clone();
let interval_ms = self.options.metrics.as_ref() let interval_ms = self.options.metrics.as_ref()
.and_then(|m| m.sample_interval_ms) .and_then(|m| m.sample_interval_ms)
.unwrap_or(1000); .unwrap_or(1000);
@@ -378,14 +408,14 @@ impl RustProxy {
metrics.sample_all(); metrics.sample_all();
// Periodically clean up stale rate-limit timestamp entries // Periodically clean up stale rate-limit timestamp entries
conn_tracker.cleanup_stale_timestamps(); conn_tracker.cleanup_stale_timestamps();
// Clean up expired rate limiter entries to prevent unbounded
// growth from unique IPs after traffic stops
http_proxy.cleanup_all_rate_limiters();
} }
} }
} }
})); }));
// Apply NFTables rules for routes using nftables forwarding engine
self.apply_nftables_rules(&self.options.routes.clone()).await;
// Start renewal timer if ACME is enabled // Start renewal timer if ACME is enabled
self.start_renewal_timer(); self.start_renewal_timer();
@@ -612,14 +642,6 @@ impl RustProxy {
} }
self.challenge_server = None; self.challenge_server = None;
// Clean up NFTables rules
if let Some(ref mut nft) = self.nft_manager {
if let Err(e) = nft.cleanup().await {
warn!("NFTables cleanup failed: {}", e);
}
}
self.nft_manager = None;
if let Some(ref mut listener) = self.listener_manager { if let Some(ref mut listener) = self.listener_manager {
listener.graceful_stop().await; listener.graceful_stop().await;
} }
@@ -692,6 +714,9 @@ impl RustProxy {
.collect(); .collect();
self.metrics.retain_backends(&active_backends); self.metrics.retain_backends(&active_backends);
// Capture old route manager for diff-based connection recycling
let old_manager = self.route_table.load_full();
// Atomically swap the route table // Atomically swap the route table
let new_manager = Arc::new(new_manager); let new_manager = Arc::new(new_manager);
self.route_table.store(Arc::clone(&new_manager)); self.route_table.store(Arc::clone(&new_manager));
@@ -727,9 +752,47 @@ impl RustProxy {
listener.update_route_manager(Arc::clone(&new_manager)); listener.update_route_manager(Arc::clone(&new_manager));
// Cancel connections on routes that were removed or disabled // Cancel connections on routes that were removed or disabled
listener.invalidate_removed_routes(&active_route_ids); listener.invalidate_removed_routes(&active_route_ids);
// Clean up registry entries for removed routes
listener.connection_registry().cleanup_removed_routes(&active_route_ids);
// Prune HTTP proxy caches (rate limiters, regex cache, round-robin counters) // Prune HTTP proxy caches (rate limiters, regex cache, round-robin counters)
listener.prune_http_proxy_caches(&active_route_ids); listener.prune_http_proxy_caches(&active_route_ids);
// Diff-based connection recycling for changed routes
{
let registry = listener.connection_registry();
for new_route in &routes {
let new_id = match &new_route.id {
Some(id) => id.as_str(),
None => continue,
};
// Find corresponding old route
let old_route = old_manager.routes().iter().find(|r| {
r.id.as_deref() == Some(new_id)
});
let old_route = match old_route {
Some(r) => r,
None => continue, // new route, no existing connections to recycle
};
// Security diff: re-evaluate existing connections' IPs
let old_sec = serde_json::to_string(&old_route.security).ok();
let new_sec = serde_json::to_string(&new_route.security).ok();
if old_sec != new_sec {
if let Some(ref security) = new_route.security {
registry.recycle_for_security_change(new_id, security);
}
// If security removed entirely (became more permissive), no recycling needed
}
// Action diff (targets, TLS mode, etc.): recycle all connections on route
let old_action = serde_json::to_string(&old_route.action).ok();
let new_action = serde_json::to_string(&new_route.action).ok();
if old_action != new_action {
registry.recycle_for_route_change(new_id);
}
}
}
// Add new ports // Add new ports
for port in &new_ports { for port in &new_ports {
if !old_ports.contains(port) { if !old_ports.contains(port) {
@@ -772,14 +835,22 @@ impl RustProxy {
if self.udp_listener_manager.is_none() { if self.udp_listener_manager.is_none() {
if let Some(ref listener) = self.listener_manager { if let Some(ref listener) = self.listener_manager {
let conn_tracker = listener.conn_tracker().clone(); let conn_tracker = listener.conn_tracker().clone();
let route_cancels = listener.route_cancels().clone();
let connection_registry = listener.connection_registry().clone();
let conn_config = Self::build_connection_config(&self.options); let conn_config = Self::build_connection_config(&self.options);
let mut udp_mgr = UdpListenerManager::new( let mut udp_mgr = UdpListenerManager::new(
Arc::clone(&new_manager), Arc::clone(&new_manager),
Arc::clone(&self.metrics), Arc::clone(&self.metrics),
conn_tracker, conn_tracker,
self.cancel_token.clone(), self.cancel_token.clone(),
route_cancels,
connection_registry,
); );
udp_mgr.set_proxy_ips(conn_config.proxy_ips); udp_mgr.set_proxy_ips(conn_config.proxy_ips);
// Wire up H3ProxyService so QUIC connections can serve HTTP/3
let http_proxy = listener.http_proxy().clone();
let h3_svc = rustproxy_http::h3_service::H3ProxyService::new(http_proxy);
udp_mgr.set_h3_service(std::sync::Arc::new(h3_svc));
self.udp_listener_manager = Some(udp_mgr); self.udp_listener_manager = Some(udp_mgr);
} }
} }
@@ -821,9 +892,6 @@ impl RustProxy {
} }
} }
// Update NFTables rules: remove old, apply new
self.update_nftables_rules(&routes).await;
self.options.routes = routes; self.options.routes = routes;
Ok(()) Ok(())
} }
@@ -950,6 +1018,8 @@ impl RustProxy {
protocol: e.protocol, protocol: e.protocol,
h3_port: e.h3_port, h3_port: e.h3_port,
age_secs: e.age_secs, age_secs: e.age_secs,
last_accessed_secs: e.last_accessed_secs,
last_probed_secs: e.last_probed_secs,
h2_suppressed: e.h2_suppressed, h2_suppressed: e.h2_suppressed,
h3_suppressed: e.h3_suppressed, h3_suppressed: e.h3_suppressed,
h2_cooldown_remaining_secs: e.h2_cooldown_remaining_secs, h2_cooldown_remaining_secs: e.h2_cooldown_remaining_secs,
@@ -1082,6 +1152,10 @@ impl RustProxy {
} }
/// Load a certificate for a domain and hot-swap the TLS configuration. /// Load a certificate for a domain and hot-swap the TLS configuration.
///
/// If the cert PEM differs from the currently loaded cert for this domain,
/// existing connections for the domain are gracefully recycled (GOAWAY for
/// HTTP/2, Connection: close for HTTP/1.1, graceful FIN for TCP).
pub async fn load_certificate( pub async fn load_certificate(
&mut self, &mut self,
domain: &str, domain: &str,
@@ -1091,6 +1165,12 @@ impl RustProxy {
) -> Result<()> { ) -> Result<()> {
info!("Loading certificate for domain: {}", domain); info!("Loading certificate for domain: {}", domain);
// Check if the cert actually changed (for selective connection recycling)
let cert_changed = self.loaded_certs
.get(domain)
.map(|existing| existing.cert_pem != cert_pem)
.unwrap_or(false); // new domain = no existing connections to recycle
// Store in cert manager if available // Store in cert manager if available
if let Some(ref cm_arc) = self.cert_manager { if let Some(ref cm_arc) = self.cert_manager {
let now = std::time::SystemTime::now() let now = std::time::SystemTime::now()
@@ -1139,103 +1219,17 @@ impl RustProxy {
} }
} }
// Recycle existing connections if cert actually changed
if cert_changed {
if let Some(ref listener) = self.listener_manager {
listener.connection_registry().recycle_for_cert_change(domain);
}
}
info!("Certificate loaded and TLS config updated for {}", domain); info!("Certificate loaded and TLS config updated for {}", domain);
Ok(()) Ok(())
} }
/// Get NFTables status.
pub async fn get_nftables_status(&self) -> Result<HashMap<String, serde_json::Value>> {
match &self.nft_manager {
Some(nft) => Ok(nft.status()),
None => Ok(HashMap::new()),
}
}
/// Apply NFTables rules for routes using the nftables forwarding engine.
async fn apply_nftables_rules(&mut self, routes: &[RouteConfig]) {
let nft_routes: Vec<&RouteConfig> = routes.iter()
.filter(|r| r.action.forwarding_engine.as_ref() == Some(&ForwardingEngine::Nftables))
.collect();
if nft_routes.is_empty() {
return;
}
info!("Applying NFTables rules for {} routes", nft_routes.len());
let table_name = nft_routes.iter()
.find_map(|r| r.action.nftables.as_ref()?.table_name.clone())
.unwrap_or_else(|| "rustproxy".to_string());
let mut nft = NftManager::new(Some(table_name));
for route in &nft_routes {
let route_id = route.id.as_deref()
.or(route.name.as_deref())
.unwrap_or("unnamed");
let nft_options = match &route.action.nftables {
Some(opts) => opts.clone(),
None => rustproxy_config::NfTablesOptions {
preserve_source_ip: None,
protocol: None,
max_rate: None,
priority: None,
table_name: None,
use_ip_sets: None,
use_advanced_nat: None,
},
};
let targets = match &route.action.targets {
Some(targets) => targets,
None => {
warn!("NFTables route '{}' has no targets, skipping", route_id);
continue;
}
};
let source_ports = route.route_match.ports.to_ports();
for target in targets {
let target_host = target.host.first().to_string();
let target_port_spec = &target.port;
for &source_port in &source_ports {
let resolved_port = target_port_spec.resolve(source_port);
let rules = rule_builder::build_dnat_rule(
nft.table_name(),
"prerouting",
source_port,
&target_host,
resolved_port,
&nft_options,
);
let rule_id = format!("{}-{}-{}", route_id, source_port, resolved_port);
if let Err(e) = nft.apply_rules(&rule_id, rules).await {
error!("Failed to apply NFTables rules for route '{}': {}", route_id, e);
}
}
}
}
self.nft_manager = Some(nft);
}
/// Update NFTables rules when routes change.
async fn update_nftables_rules(&mut self, new_routes: &[RouteConfig]) {
// Clean up old rules
if let Some(ref mut nft) = self.nft_manager {
if let Err(e) = nft.cleanup().await {
warn!("NFTables cleanup during update failed: {}", e);
}
}
self.nft_manager = None;
// Apply new rules
self.apply_nftables_rules(new_routes).await;
}
/// Extract TLS configurations from route configs. /// Extract TLS configurations from route configs.
fn extract_tls_configs(routes: &[RouteConfig]) -> HashMap<String, TlsCertConfig> { fn extract_tls_configs(routes: &[RouteConfig]) -> HashMap<String, TlsCertConfig> {
let mut configs = HashMap::new(); let mut configs = HashMap::new();
-21
View File
@@ -147,7 +147,6 @@ async fn handle_request(
"renewCertificate" => handle_renew_certificate(&id, &request.params, proxy).await, "renewCertificate" => handle_renew_certificate(&id, &request.params, proxy).await,
"getCertificateStatus" => handle_get_certificate_status(&id, &request.params, proxy).await, "getCertificateStatus" => handle_get_certificate_status(&id, &request.params, proxy).await,
"getListeningPorts" => handle_get_listening_ports(&id, proxy), "getListeningPorts" => handle_get_listening_ports(&id, proxy),
"getNftablesStatus" => handle_get_nftables_status(&id, proxy).await,
"setSocketHandlerRelay" => handle_set_socket_handler_relay(&id, &request.params, proxy).await, "setSocketHandlerRelay" => handle_set_socket_handler_relay(&id, &request.params, proxy).await,
"setDatagramHandlerRelay" => handle_set_datagram_handler_relay(&id, &request.params, proxy).await, "setDatagramHandlerRelay" => handle_set_datagram_handler_relay(&id, &request.params, proxy).await,
"addListeningPort" => handle_add_listening_port(&id, &request.params, proxy).await, "addListeningPort" => handle_add_listening_port(&id, &request.params, proxy).await,
@@ -352,26 +351,6 @@ fn handle_get_listening_ports(
} }
} }
async fn handle_get_nftables_status(
id: &str,
proxy: &Option<RustProxy>,
) -> ManagementResponse {
match proxy.as_ref() {
Some(p) => {
match p.get_nftables_status().await {
Ok(status) => {
match serde_json::to_value(&status) {
Ok(v) => ManagementResponse::ok(id.to_string(), v),
Err(e) => ManagementResponse::err(id.to_string(), format!("Failed to serialize: {}", e)),
}
}
Err(e) => ManagementResponse::err(id.to_string(), format!("Failed to get status: {}", e)),
}
}
None => ManagementResponse::ok(id.to_string(), serde_json::json!({})),
}
}
async fn handle_set_socket_handler_relay( async fn handle_set_socket_handler_relay(
id: &str, id: &str,
params: &serde_json::Value, params: &serde_json::Value,
@@ -297,8 +297,6 @@ pub fn make_test_route(
load_balancing: None, load_balancing: None,
advanced: None, advanced: None,
options: None, options: None,
forwarding_engine: None,
nftables: None,
send_proxy_protocol: None, send_proxy_protocol: None,
udp: None, udp: None,
}, },
+33 -36
View File
@@ -1,11 +1,5 @@
import { tap, expect } from '@git.zone/tstest/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import {
createHttpsTerminateRoute,
createCompleteHttpsServer,
createHttpRoute,
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import { import {
mergeRouteConfigs, mergeRouteConfigs,
cloneRoute, cloneRoute,
@@ -19,8 +13,11 @@ import {
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js'; import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
tap.test('route creation - createHttpsTerminateRoute produces correct structure', async () => { tap.test('route creation - HTTPS terminate route has correct structure', async () => {
const route = createHttpsTerminateRoute('secure.example.com', { host: '127.0.0.1', port: 8443 }); const route: IRouteConfig = {
match: { ports: 443, domains: 'secure.example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 8443 }], tls: { mode: 'terminate', certificate: 'auto' } }
};
expect(route).toHaveProperty('match'); expect(route).toHaveProperty('match');
expect(route).toHaveProperty('action'); expect(route).toHaveProperty('action');
expect(route.action.type).toEqual('forward'); expect(route.action.type).toEqual('forward');
@@ -29,20 +26,10 @@ tap.test('route creation - createHttpsTerminateRoute produces correct structure'
expect(route.match.domains).toEqual('secure.example.com'); expect(route.match.domains).toEqual('secure.example.com');
}); });
tap.test('route creation - createCompleteHttpsServer returns redirect and main route', async () => {
const routes = createCompleteHttpsServer('app.example.com', { host: '127.0.0.1', port: 3000 });
expect(routes).toBeArray();
expect(routes.length).toBeGreaterThanOrEqual(2);
// Should have an HTTP→HTTPS redirect and an HTTPS route
const hasRedirect = routes.some((r) => r.action.type === 'forward' && r.action.redirect !== undefined);
const hasHttps = routes.some((r) => r.action.tls?.mode === 'terminate');
expect(hasRedirect || hasHttps).toBeTrue();
});
tap.test('route validation - validateRoutes on a set of routes', async () => { tap.test('route validation - validateRoutes on a set of routes', async () => {
const routes: IRouteConfig[] = [ const routes: IRouteConfig[] = [
createHttpRoute('a.com', { host: '127.0.0.1', port: 3000 }), { match: { ports: 80, domains: 'a.com' }, action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] } },
createHttpRoute('b.com', { host: '127.0.0.1', port: 4000 }), { match: { ports: 80, domains: 'b.com' }, action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 4000 }] } },
]; ];
const result = validateRoutes(routes); const result = validateRoutes(routes);
expect(result.valid).toBeTrue(); expect(result.valid).toBeTrue();
@@ -51,7 +38,7 @@ tap.test('route validation - validateRoutes on a set of routes', async () => {
tap.test('route validation - validateRoutes catches invalid route in set', async () => { tap.test('route validation - validateRoutes catches invalid route in set', async () => {
const routes: any[] = [ const routes: any[] = [
createHttpRoute('valid.com', { host: '127.0.0.1', port: 3000 }), { match: { ports: 80, domains: 'valid.com' }, action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] } },
{ match: { ports: 80 } }, // missing action { match: { ports: 80 } }, // missing action
]; ];
const result = validateRoutes(routes); const result = validateRoutes(routes);
@@ -60,23 +47,30 @@ tap.test('route validation - validateRoutes catches invalid route in set', async
}); });
tap.test('path matching - routeMatchesPath with exact path', async () => { tap.test('path matching - routeMatchesPath with exact path', async () => {
const route = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const route: IRouteConfig = {
route.match.path = '/api'; match: { ports: 80, domains: 'example.com', path: '/api' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] }
};
expect(routeMatchesPath(route, '/api')).toBeTrue(); expect(routeMatchesPath(route, '/api')).toBeTrue();
expect(routeMatchesPath(route, '/other')).toBeFalse(); expect(routeMatchesPath(route, '/other')).toBeFalse();
}); });
tap.test('path matching - route without path matches everything', async () => { tap.test('path matching - route without path matches everything', async () => {
const route = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const route: IRouteConfig = {
// No path set, should match any path match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] }
};
expect(routeMatchesPath(route, '/anything')).toBeTrue(); expect(routeMatchesPath(route, '/anything')).toBeTrue();
expect(routeMatchesPath(route, '/')).toBeTrue(); expect(routeMatchesPath(route, '/')).toBeTrue();
}); });
tap.test('route merging - mergeRouteConfigs combines routes', async () => { tap.test('route merging - mergeRouteConfigs combines routes', async () => {
const base = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const base: IRouteConfig = {
base.priority = 10; match: { ports: 80, domains: 'example.com' },
base.name = 'base-route'; action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] },
priority: 10,
name: 'base-route'
};
const merged = mergeRouteConfigs(base, { const merged = mergeRouteConfigs(base, {
priority: 50, priority: 50,
@@ -85,14 +79,16 @@ tap.test('route merging - mergeRouteConfigs combines routes', async () => {
expect(merged.priority).toEqual(50); expect(merged.priority).toEqual(50);
expect(merged.name).toEqual('merged-route'); expect(merged.name).toEqual('merged-route');
// Original route fields should be preserved
expect(merged.match.domains).toEqual('example.com'); expect(merged.match.domains).toEqual('example.com');
expect(merged.action.targets![0].host).toEqual('127.0.0.1'); expect(merged.action.targets![0].host).toEqual('127.0.0.1');
}); });
tap.test('route merging - mergeRouteConfigs does not mutate original', async () => { tap.test('route merging - mergeRouteConfigs does not mutate original', async () => {
const base = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const base: IRouteConfig = {
base.name = 'original'; match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] },
name: 'original'
};
const merged = mergeRouteConfigs(base, { name: 'changed' }); const merged = mergeRouteConfigs(base, { name: 'changed' });
expect(base.name).toEqual('original'); expect(base.name).toEqual('original');
@@ -100,20 +96,21 @@ tap.test('route merging - mergeRouteConfigs does not mutate original', async ()
}); });
tap.test('route cloning - cloneRoute produces independent copy', async () => { tap.test('route cloning - cloneRoute produces independent copy', async () => {
const original = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const original: IRouteConfig = {
original.priority = 42; match: { ports: 80, domains: 'example.com' },
original.name = 'original-route'; action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] },
priority: 42,
name: 'original-route'
};
const cloned = cloneRoute(original); const cloned = cloneRoute(original);
// Should be equal in value
expect(cloned.match.domains).toEqual('example.com'); expect(cloned.match.domains).toEqual('example.com');
expect(cloned.priority).toEqual(42); expect(cloned.priority).toEqual(42);
expect(cloned.name).toEqual('original-route'); expect(cloned.name).toEqual('original-route');
expect(cloned.action.targets![0].host).toEqual('127.0.0.1'); expect(cloned.action.targets![0].host).toEqual('127.0.0.1');
expect(cloned.action.targets![0].port).toEqual(3000); expect(cloned.action.targets![0].port).toEqual(3000);
// Should be independent - modifying clone shouldn't affect original
cloned.name = 'cloned-route'; cloned.name = 'cloned-route';
cloned.priority = 99; cloned.priority = 99;
expect(original.name).toEqual('original-route'); expect(original.name).toEqual('original-route');
+38 -34
View File
@@ -1,11 +1,5 @@
import { tap, expect } from '@git.zone/tstest/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import {
createHttpRoute,
createHttpsTerminateRoute,
createLoadBalancerRoute,
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import { import {
findMatchingRoutes, findMatchingRoutes,
findBestMatchingRoute, findBestMatchingRoute,
@@ -22,24 +16,11 @@ import {
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js'; import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
tap.test('route creation - createHttpRoute produces correct structure', async () => {
const route = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 });
expect(route).toHaveProperty('match');
expect(route).toHaveProperty('action');
expect(route.match.domains).toEqual('example.com');
expect(route.action.type).toEqual('forward');
expect(route.action.targets).toBeArray();
expect(route.action.targets![0].host).toEqual('127.0.0.1');
expect(route.action.targets![0].port).toEqual(3000);
});
tap.test('route creation - createHttpRoute with array of domains', async () => {
const route = createHttpRoute(['a.com', 'b.com'], { host: 'localhost', port: 8080 });
expect(route.match.domains).toEqual(['a.com', 'b.com']);
});
tap.test('route validation - validateRouteConfig accepts valid route', async () => { tap.test('route validation - validateRouteConfig accepts valid route', async () => {
const route = createHttpRoute('valid.example.com', { host: '10.0.0.1', port: 8080 }); const route: IRouteConfig = {
match: { ports: 80, domains: 'valid.example.com' },
action: { type: 'forward', targets: [{ host: '10.0.0.1', port: 8080 }] }
};
const result = validateRouteConfig(route); const result = validateRouteConfig(route);
expect(result.valid).toBeTrue(); expect(result.valid).toBeTrue();
expect(result.errors).toHaveLength(0); expect(result.errors).toHaveLength(0);
@@ -67,30 +48,44 @@ tap.test('route validation - isValidPort checks correctly', async () => {
}); });
tap.test('domain matching - exact domain', async () => { tap.test('domain matching - exact domain', async () => {
const route = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const route: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] }
};
expect(routeMatchesDomain(route, 'example.com')).toBeTrue(); expect(routeMatchesDomain(route, 'example.com')).toBeTrue();
expect(routeMatchesDomain(route, 'other.com')).toBeFalse(); expect(routeMatchesDomain(route, 'other.com')).toBeFalse();
}); });
tap.test('domain matching - wildcard domain', async () => { tap.test('domain matching - wildcard domain', async () => {
const route = createHttpRoute('*.example.com', { host: '127.0.0.1', port: 3000 }); const route: IRouteConfig = {
match: { ports: 80, domains: '*.example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] }
};
expect(routeMatchesDomain(route, 'sub.example.com')).toBeTrue(); expect(routeMatchesDomain(route, 'sub.example.com')).toBeTrue();
expect(routeMatchesDomain(route, 'example.com')).toBeFalse(); expect(routeMatchesDomain(route, 'example.com')).toBeFalse();
}); });
tap.test('port matching - single port', async () => { tap.test('port matching - single port', async () => {
const route = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const route: IRouteConfig = {
// createHttpRoute defaults to port 80 match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] }
};
expect(routeMatchesPort(route, 80)).toBeTrue(); expect(routeMatchesPort(route, 80)).toBeTrue();
expect(routeMatchesPort(route, 443)).toBeFalse(); expect(routeMatchesPort(route, 443)).toBeFalse();
}); });
tap.test('route finding - findBestMatchingRoute selects by priority', async () => { tap.test('route finding - findBestMatchingRoute selects by priority', async () => {
const lowPriority = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const lowPriority: IRouteConfig = {
lowPriority.priority = 10; match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] },
priority: 10
};
const highPriority = createHttpRoute('example.com', { host: '127.0.0.1', port: 4000 }); const highPriority: IRouteConfig = {
highPriority.priority = 100; match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 4000 }] },
priority: 100
};
const routes: IRouteConfig[] = [lowPriority, highPriority]; const routes: IRouteConfig[] = [lowPriority, highPriority];
const best = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 }); const best = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 });
@@ -100,9 +95,18 @@ tap.test('route finding - findBestMatchingRoute selects by priority', async () =
}); });
tap.test('route finding - findMatchingRoutes returns all matches', async () => { tap.test('route finding - findMatchingRoutes returns all matches', async () => {
const route1 = createHttpRoute('example.com', { host: '127.0.0.1', port: 3000 }); const route1: IRouteConfig = {
const route2 = createHttpRoute('example.com', { host: '127.0.0.1', port: 4000 }); match: { ports: 80, domains: 'example.com' },
const route3 = createHttpRoute('other.com', { host: '127.0.0.1', port: 5000 }); action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 3000 }] }
};
const route2: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 4000 }] }
};
const route3: IRouteConfig = {
match: { ports: 80, domains: 'other.com' },
action: { type: 'forward', targets: [{ host: '127.0.0.1', port: 5000 }] }
};
const matches = findMatchingRoutes([route1, route2, route3], { domain: 'example.com', port: 80 }); const matches = findMatchingRoutes([route1, route2, route3], { domain: 'example.com', port: 80 });
expect(matches).toHaveLength(2); expect(matches).toHaveLength(2);
+67 -114
View File
@@ -2,146 +2,101 @@ import * as path from 'path';
import { tap, expect } from '@git.zone/tstest/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/proxies/smart-proxy/index.js'; import { SmartProxy } from '../ts/proxies/smart-proxy/index.js';
import { import { SocketHandlers } from '../ts/proxies/smart-proxy/utils/socket-handlers.js';
createHttpRoute,
createHttpsTerminateRoute,
createHttpsPassthroughRoute,
createHttpToHttpsRedirect,
createCompleteHttpsServer,
createLoadBalancerRoute,
createApiRoute,
createWebSocketRoute
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js'; import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
// Test to demonstrate various route configurations using the new helpers
tap.test('Route-based configuration examples', async (tools) => { tap.test('Route-based configuration examples', async (tools) => {
// Example 1: HTTP-only configuration const httpOnlyRoute: IRouteConfig = {
const httpOnlyRoute = createHttpRoute( match: { ports: 80, domains: 'http.example.com' },
'http.example.com', action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
{ name: 'Basic HTTP Route'
host: 'localhost', };
port: 3000
},
{
name: 'Basic HTTP Route'
}
);
console.log('HTTP-only route created successfully:', httpOnlyRoute.name); console.log('HTTP-only route created successfully:', httpOnlyRoute.name);
expect(httpOnlyRoute.action.type).toEqual('forward'); expect(httpOnlyRoute.action.type).toEqual('forward');
expect(httpOnlyRoute.match.domains).toEqual('http.example.com'); expect(httpOnlyRoute.match.domains).toEqual('http.example.com');
// Example 2: HTTPS Passthrough (SNI) configuration const httpsPassthroughRoute: IRouteConfig = {
const httpsPassthroughRoute = createHttpsPassthroughRoute( match: { ports: 443, domains: 'pass.example.com' },
'pass.example.com', action: { type: 'forward', targets: [{ host: '10.0.0.1', port: 443 }, { host: '10.0.0.2', port: 443 }], tls: { mode: 'passthrough' } },
{ name: 'HTTPS Passthrough Route'
host: ['10.0.0.1', '10.0.0.2'], // Round-robin target IPs };
port: 443
},
{
name: 'HTTPS Passthrough Route'
}
);
expect(httpsPassthroughRoute).toBeTruthy(); expect(httpsPassthroughRoute).toBeTruthy();
expect(httpsPassthroughRoute.action.tls?.mode).toEqual('passthrough'); expect(httpsPassthroughRoute.action.tls?.mode).toEqual('passthrough');
expect(Array.isArray(httpsPassthroughRoute.action.targets)).toBeTrue(); expect(Array.isArray(httpsPassthroughRoute.action.targets)).toBeTrue();
// Example 3: HTTPS Termination to HTTP Backend const terminateToHttpRoute: IRouteConfig = {
const terminateToHttpRoute = createHttpsTerminateRoute( match: { ports: 443, domains: 'secure.example.com' },
'secure.example.com', action: { type: 'forward', targets: [{ host: 'localhost', port: 8080 }], tls: { mode: 'terminate', certificate: 'auto' } },
{ name: 'HTTPS Termination to HTTP Backend'
host: 'localhost', };
port: 8080
},
{
certificate: 'auto',
name: 'HTTPS Termination to HTTP Backend'
}
);
// Create the HTTP to HTTPS redirect for this domain const httpToHttpsRedirect: IRouteConfig = {
const httpToHttpsRedirect = createHttpToHttpsRedirect( match: { ports: 80, domains: 'secure.example.com' },
'secure.example.com', action: { type: 'socket-handler', socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301) },
443, name: 'HTTP to HTTPS Redirect for secure.example.com'
{ };
name: 'HTTP to HTTPS Redirect for secure.example.com'
}
);
expect(terminateToHttpRoute).toBeTruthy(); expect(terminateToHttpRoute).toBeTruthy();
expect(terminateToHttpRoute.action.tls?.mode).toEqual('terminate'); expect(terminateToHttpRoute.action.tls?.mode).toEqual('terminate');
expect(httpToHttpsRedirect.action.type).toEqual('socket-handler');
// Example 4: Load Balancer with HTTPS const loadBalancerRoute: IRouteConfig = {
const loadBalancerRoute = createLoadBalancerRoute( match: { ports: 443, domains: 'proxy.example.com' },
'proxy.example.com', action: {
['internal-api-1.local', 'internal-api-2.local'], type: 'forward',
8443, targets: [
{ { host: 'internal-api-1.local', port: 8443 },
tls: { { host: 'internal-api-2.local', port: 8443 }
mode: 'terminate-and-reencrypt', ],
certificate: 'auto' tls: { mode: 'terminate-and-reencrypt', certificate: 'auto' }
}, },
name: 'Load Balanced HTTPS Route' name: 'Load Balanced HTTPS Route'
} };
);
expect(loadBalancerRoute).toBeTruthy(); expect(loadBalancerRoute).toBeTruthy();
expect(loadBalancerRoute.action.tls?.mode).toEqual('terminate-and-reencrypt'); expect(loadBalancerRoute.action.tls?.mode).toEqual('terminate-and-reencrypt');
expect(Array.isArray(loadBalancerRoute.action.targets)).toBeTrue(); expect(Array.isArray(loadBalancerRoute.action.targets)).toBeTrue();
// Example 5: API Route const apiRoute: IRouteConfig = {
const apiRoute = createApiRoute( match: { ports: 443, domains: 'api.example.com', path: '/api' },
'api.example.com', action: {
'/api', type: 'forward',
{ host: 'localhost', port: 8081 }, targets: [{ host: 'localhost', port: 8081 }],
{ tls: { mode: 'terminate', certificate: 'auto' }
name: 'API Route', },
useTls: true, name: 'API Route'
addCorsHeaders: true };
}
);
expect(apiRoute.action.type).toEqual('forward'); expect(apiRoute.action.type).toEqual('forward');
expect(apiRoute.match.path).toBeTruthy(); expect(apiRoute.match.path).toBeTruthy();
// Example 6: Complete HTTPS Server with HTTP Redirect const httpsRoute: IRouteConfig = {
const httpsServerRoutes = createCompleteHttpsServer( match: { ports: 443, domains: 'complete.example.com' },
'complete.example.com', action: { type: 'forward', targets: [{ host: 'localhost', port: 8080 }], tls: { mode: 'terminate', certificate: 'auto' } },
{ name: 'Complete HTTPS Server'
host: 'localhost', };
port: 8080
const httpsRedirectRoute: IRouteConfig = {
match: { ports: 80, domains: 'complete.example.com' },
action: { type: 'socket-handler', socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301) },
name: 'Complete HTTPS Server - Redirect'
};
const webSocketRoute: IRouteConfig = {
match: { ports: 443, domains: 'ws.example.com', path: '/ws' },
action: {
type: 'forward',
targets: [{ host: 'localhost', port: 8082 }],
tls: { mode: 'terminate', certificate: 'auto' },
websocket: { enabled: true }
}, },
{ name: 'WebSocket Route'
certificate: 'auto', };
name: 'Complete HTTPS Server'
}
);
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('socket-handler');
// Example 7: Static File Server - removed (use nginx/apache behind proxy)
// Example 8: WebSocket Route
const webSocketRoute = createWebSocketRoute(
'ws.example.com',
'/ws',
{ host: 'localhost', port: 8082 },
{
useTls: true,
name: 'WebSocket Route'
}
);
expect(webSocketRoute.action.type).toEqual('forward'); expect(webSocketRoute.action.type).toEqual('forward');
expect(webSocketRoute.action.websocket?.enabled).toBeTrue(); expect(webSocketRoute.action.websocket?.enabled).toBeTrue();
// Create a SmartProxy instance with all routes
const allRoutes: IRouteConfig[] = [ const allRoutes: IRouteConfig[] = [
httpOnlyRoute, httpOnlyRoute,
httpsPassthroughRoute, httpsPassthroughRoute,
@@ -149,19 +104,17 @@ tap.test('Route-based configuration examples', async (tools) => {
httpToHttpsRedirect, httpToHttpsRedirect,
loadBalancerRoute, loadBalancerRoute,
apiRoute, apiRoute,
...httpsServerRoutes, httpsRoute,
httpsRedirectRoute,
webSocketRoute webSocketRoute
]; ];
// We're not actually starting the SmartProxy in this test,
// just verifying that the configuration is valid
const smartProxy = new SmartProxy({ const smartProxy = new SmartProxy({
routes: allRoutes routes: allRoutes
}); });
// Just verify that all routes are configured correctly
console.log(`Created ${allRoutes.length} example routes`); console.log(`Created ${allRoutes.length} example routes`);
expect(allRoutes.length).toEqual(9); // One less without static file route expect(allRoutes.length).toEqual(9);
}); });
export default tap.start(); export default tap.start();
+18 -48
View File
@@ -1,27 +1,8 @@
import { tap, expect } from '@git.zone/tstest/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as plugins from '../ts/plugins.js'; import * as plugins from '../ts/plugins.js';
// Import route-based helpers import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
import {
createHttpRoute,
createHttpsTerminateRoute,
createHttpsPassthroughRoute,
createHttpToHttpsRedirect,
createCompleteHttpsServer
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
// Create helper functions for backward compatibility
const helpers = {
httpOnly: (domains: string | string[], target: any) => createHttpRoute(domains, target),
tlsTerminateToHttp: (domains: string | string[], target: any) =>
createHttpsTerminateRoute(domains, target),
tlsTerminateToHttps: (domains: string | string[], target: any) =>
createHttpsTerminateRoute(domains, target, { reencrypt: true }),
httpsPassthrough: (domains: string | string[], target: any) =>
createHttpsPassthroughRoute(domains, target)
};
// Route-based utility functions for testing
function findRouteForDomain(routes: any[], domain: string): any { function findRouteForDomain(routes: any[], domain: string): any {
return routes.find(route => { return routes.find(route => {
const domains = Array.isArray(route.match.domains) const domains = Array.isArray(route.match.domains)
@@ -31,55 +12,44 @@ function findRouteForDomain(routes: any[], domain: string): any {
}); });
} }
// Replace the old test with route-based tests
tap.test('Route Helpers - Create HTTP routes', async () => { tap.test('Route Helpers - Create HTTP routes', async () => {
const route = helpers.httpOnly('example.com', { host: 'localhost', port: 3000 }); const route: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] }
};
expect(route.action.type).toEqual('forward'); expect(route.action.type).toEqual('forward');
expect(route.match.domains).toEqual('example.com'); expect(route.match.domains).toEqual('example.com');
expect(route.action.targets?.[0]).toEqual({ host: 'localhost', port: 3000 }); expect(route.action.targets?.[0]).toEqual({ host: 'localhost', port: 3000 });
}); });
tap.test('Route Helpers - Create HTTPS terminate to HTTP routes', async () => { tap.test('Route Helpers - Create HTTPS terminate to HTTP routes', async () => {
const route = helpers.tlsTerminateToHttp('secure.example.com', { host: 'localhost', port: 3000 }); const route: IRouteConfig = {
match: { ports: 443, domains: 'secure.example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }], tls: { mode: 'terminate', certificate: 'auto' } }
};
expect(route.action.type).toEqual('forward'); expect(route.action.type).toEqual('forward');
expect(route.match.domains).toEqual('secure.example.com'); expect(route.match.domains).toEqual('secure.example.com');
expect(route.action.tls?.mode).toEqual('terminate'); expect(route.action.tls?.mode).toEqual('terminate');
}); });
tap.test('Route Helpers - Create HTTPS passthrough routes', async () => { tap.test('Route Helpers - Create HTTPS passthrough routes', async () => {
const route = helpers.httpsPassthrough('passthrough.example.com', { host: 'backend', port: 443 }); const route: IRouteConfig = {
match: { ports: 443, domains: 'passthrough.example.com' },
action: { type: 'forward', targets: [{ host: 'backend', port: 443 }], tls: { mode: 'passthrough' } }
};
expect(route.action.type).toEqual('forward'); expect(route.action.type).toEqual('forward');
expect(route.match.domains).toEqual('passthrough.example.com'); expect(route.match.domains).toEqual('passthrough.example.com');
expect(route.action.tls?.mode).toEqual('passthrough'); expect(route.action.tls?.mode).toEqual('passthrough');
}); });
tap.test('Route Helpers - Create HTTPS to HTTPS routes', async () => { tap.test('Route Helpers - Create HTTPS to HTTPS routes', async () => {
const route = helpers.tlsTerminateToHttps('reencrypt.example.com', { host: 'backend', port: 443 }); const route: IRouteConfig = {
match: { ports: 443, domains: 'reencrypt.example.com' },
action: { type: 'forward', targets: [{ host: 'backend', port: 443 }], tls: { mode: 'terminate-and-reencrypt', certificate: 'auto' } }
};
expect(route.action.type).toEqual('forward'); expect(route.action.type).toEqual('forward');
expect(route.match.domains).toEqual('reencrypt.example.com'); expect(route.match.domains).toEqual('reencrypt.example.com');
expect(route.action.tls?.mode).toEqual('terminate-and-reencrypt'); expect(route.action.tls?.mode).toEqual('terminate-and-reencrypt');
}); });
tap.test('Route Helpers - Create complete HTTPS server with redirect', async () => { export default tap.start();
const routes = createCompleteHttpsServer(
'full.example.com',
{ host: 'localhost', port: 3000 },
{ certificate: 'auto' }
);
expect(routes.length).toEqual(2);
// 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
const httpsRoute = routes.find(r => r.action.type === 'forward');
expect(httpsRoute.match.ports).toEqual(443);
expect(httpsRoute.action.tls?.mode).toEqual('terminate');
});
// Export test runner
export default tap.start();
+45 -45
View File
@@ -1,15 +1,14 @@
import { SmartProxy } from '../ts/proxies/smart-proxy/index.js'; import { SmartProxy } from '../ts/proxies/smart-proxy/index.js';
import { createNfTablesRoute, createNfTablesTerminateRoute } from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import { expect, tap } from '@git.zone/tstest/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as child_process from 'child_process'; import * as child_process from 'child_process';
import { promisify } from 'util'; import { promisify } from 'util';
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
const exec = promisify(child_process.exec); const exec = promisify(child_process.exec);
// Check if we have root privileges to run NFTables tests
async function checkRootPrivileges(): Promise<boolean> { async function checkRootPrivileges(): Promise<boolean> {
try { try {
// Check if we're running as root
const { stdout } = await exec('id -u'); const { stdout } = await exec('id -u');
return stdout.trim() === '0'; return stdout.trim() === '0';
} catch (err) { } catch (err) {
@@ -17,7 +16,6 @@ async function checkRootPrivileges(): Promise<boolean> {
} }
} }
// Check if tests should run
const isRoot = await checkRootPrivileges(); const isRoot = await checkRootPrivileges();
if (!isRoot) { if (!isRoot) {
@@ -29,68 +27,70 @@ if (!isRoot) {
console.log(''); console.log('');
} }
// Define the test with proper skip condition
const testFn = isRoot ? tap.test : tap.skip.test; const testFn = isRoot ? tap.test : tap.skip.test;
testFn('NFTables integration tests', async () => { testFn('NFTables integration tests', async () => {
console.log('Running NFTables tests with root privileges'); console.log('Running NFTables tests with root privileges');
// Create test routes const routes: IRouteConfig[] = [
const routes = [ {
createNfTablesRoute('tcp-forward', { match: { ports: 9080 },
host: 'localhost', action: {
port: 8080 type: 'forward',
}, { forwardingEngine: 'nftables',
ports: 9080, targets: [{ host: 'localhost', port: 8080 }],
protocol: 'tcp' nftables: { protocol: 'tcp' }
}), },
name: 'tcp-forward'
createNfTablesRoute('udp-forward', { },
host: 'localhost',
port: 5353 {
}, { match: { ports: 5354 },
ports: 5354, action: {
protocol: 'udp' type: 'forward',
}), forwardingEngine: 'nftables',
targets: [{ host: 'localhost', port: 5353 }],
createNfTablesRoute('port-range', { nftables: { protocol: 'udp' }
host: 'localhost', },
port: 8080 name: 'udp-forward'
}, { },
ports: [{ from: 9000, to: 9100 }],
protocol: 'tcp' {
}) match: { ports: [{ from: 9000, to: 9100 }] },
action: {
type: 'forward',
forwardingEngine: 'nftables',
targets: [{ host: 'localhost', port: 8080 }],
nftables: { protocol: 'tcp' }
},
name: 'port-range'
}
]; ];
const smartProxy = new SmartProxy({ const smartProxy = new SmartProxy({
enableDetailedLogging: true, enableDetailedLogging: true,
routes routes
}); });
// Start the proxy
await smartProxy.start(); await smartProxy.start();
console.log('SmartProxy started with NFTables routes'); console.log('SmartProxy started with NFTables routes');
// Get NFTables status
const status = await smartProxy.getNfTablesStatus(); const status = await smartProxy.getNfTablesStatus();
console.log('NFTables status:', JSON.stringify(status, null, 2)); console.log('NFTables status:', JSON.stringify(status, null, 2));
// Verify all routes are provisioned
expect(Object.keys(status).length).toEqual(routes.length); expect(Object.keys(status).length).toEqual(routes.length);
for (const routeStatus of Object.values(status)) { for (const routeStatus of Object.values(status)) {
expect(routeStatus.active).toBeTrue(); expect(routeStatus.active).toBeTrue();
expect(routeStatus.ruleCount.total).toBeGreaterThan(0); expect(routeStatus.ruleCount.total).toBeGreaterThan(0);
} }
// Stop the proxy
await smartProxy.stop(); await smartProxy.stop();
console.log('SmartProxy stopped'); console.log('SmartProxy stopped');
// Verify all rules are cleaned up
const finalStatus = await smartProxy.getNfTablesStatus(); const finalStatus = await smartProxy.getNfTablesStatus();
expect(Object.keys(finalStatus).length).toEqual(0); expect(Object.keys(finalStatus).length).toEqual(0);
}); });
export default tap.start(); export default tap.start();
+89 -102
View File
@@ -1,5 +1,4 @@
import { SmartProxy } from '../ts/proxies/smart-proxy/index.js'; import { SmartProxy } from '../ts/proxies/smart-proxy/index.js';
import { createNfTablesRoute, createNfTablesTerminateRoute } from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import { expect, tap } from '@git.zone/tstest/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net'; import * as net from 'net';
import * as http from 'http'; import * as http from 'http';
@@ -10,13 +9,13 @@ import { fileURLToPath } from 'url';
import * as child_process from 'child_process'; import * as child_process from 'child_process';
import { promisify } from 'util'; import { promisify } from 'util';
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
const exec = promisify(child_process.exec); const exec = promisify(child_process.exec);
// Get __dirname equivalent for ES modules
const __filename = fileURLToPath(import.meta.url); const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename); const __dirname = path.dirname(__filename);
// Check if we have root privileges
async function checkRootPrivileges(): Promise<boolean> { async function checkRootPrivileges(): Promise<boolean> {
try { try {
const { stdout } = await exec('id -u'); const { stdout } = await exec('id -u');
@@ -26,7 +25,6 @@ async function checkRootPrivileges(): Promise<boolean> {
} }
} }
// Check if tests should run
const runTests = await checkRootPrivileges(); const runTests = await checkRootPrivileges();
if (!runTests) { if (!runTests) {
@@ -36,10 +34,8 @@ if (!runTests) {
console.log('Skipping NFTables integration tests'); console.log('Skipping NFTables integration tests');
console.log('========================================'); console.log('========================================');
console.log(''); console.log('');
// Skip tests when not running as root - tests are marked with tap.skip.test
} }
// Test server and client utilities
let testTcpServer: net.Server; let testTcpServer: net.Server;
let testHttpServer: http.Server; let testHttpServer: http.Server;
let testHttpsServer: https.Server; let testHttpsServer: https.Server;
@@ -53,10 +49,8 @@ const PROXY_HTTP_PORT = 5001;
const PROXY_HTTPS_PORT = 5002; const PROXY_HTTPS_PORT = 5002;
const TEST_DATA = 'Hello through NFTables!'; const TEST_DATA = 'Hello through NFTables!';
// Helper to create test certificates
async function createTestCertificates() { async function createTestCertificates() {
try { try {
// Import the certificate helper
const certsModule = await import('./helpers/certificates.js'); const certsModule = await import('./helpers/certificates.js');
const certificates = certsModule.loadTestCertificates(); const certificates = certsModule.loadTestCertificates();
return { return {
@@ -65,7 +59,6 @@ async function createTestCertificates() {
}; };
} catch (err) { } catch (err) {
console.error('Failed to load test certificates:', err); console.error('Failed to load test certificates:', err);
// Use dummy certificates for testing
return { return {
cert: fs.readFileSync(path.join(__dirname, '..', 'assets', 'certs', 'cert.pem'), 'utf8'), cert: fs.readFileSync(path.join(__dirname, '..', 'assets', 'certs', 'cert.pem'), 'utf8'),
key: fs.readFileSync(path.join(__dirname, '..', 'assets', 'certs', 'key.pem'), 'utf8') key: fs.readFileSync(path.join(__dirname, '..', 'assets', 'certs', 'key.pem'), 'utf8')
@@ -75,111 +68,112 @@ async function createTestCertificates() {
tap.skip.test('setup NFTables integration test environment', async () => { tap.skip.test('setup NFTables integration test environment', async () => {
console.log('Running NFTables integration tests with root privileges'); console.log('Running NFTables integration tests with root privileges');
// Create a basic TCP test server
testTcpServer = net.createServer((socket) => { testTcpServer = net.createServer((socket) => {
socket.on('data', (data) => { socket.on('data', (data) => {
socket.write(`Server says: ${data.toString()}`); socket.write(`Server says: ${data.toString()}`);
}); });
}); });
await new Promise<void>((resolve) => { await new Promise<void>((resolve) => {
testTcpServer.listen(TEST_TCP_PORT, () => { testTcpServer.listen(TEST_TCP_PORT, () => {
console.log(`TCP test server listening on port ${TEST_TCP_PORT}`); console.log(`TCP test server listening on port ${TEST_TCP_PORT}`);
resolve(); resolve();
}); });
}); });
// Create an HTTP test server
testHttpServer = http.createServer((req, res) => { testHttpServer = http.createServer((req, res) => {
res.writeHead(200, { 'Content-Type': 'text/plain' }); res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end(`HTTP Server says: ${TEST_DATA}`); res.end(`HTTP Server says: ${TEST_DATA}`);
}); });
await new Promise<void>((resolve) => { await new Promise<void>((resolve) => {
testHttpServer.listen(TEST_HTTP_PORT, () => { testHttpServer.listen(TEST_HTTP_PORT, () => {
console.log(`HTTP test server listening on port ${TEST_HTTP_PORT}`); console.log(`HTTP test server listening on port ${TEST_HTTP_PORT}`);
resolve(); resolve();
}); });
}); });
// Create an HTTPS test server
const certs = await createTestCertificates(); const certs = await createTestCertificates();
testHttpsServer = https.createServer({ key: certs.key, cert: certs.cert }, (req, res) => { testHttpsServer = https.createServer({ key: certs.key, cert: certs.cert }, (req, res) => {
res.writeHead(200, { 'Content-Type': 'text/plain' }); res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end(`HTTPS Server says: ${TEST_DATA}`); res.end(`HTTPS Server says: ${TEST_DATA}`);
}); });
await new Promise<void>((resolve) => { await new Promise<void>((resolve) => {
testHttpsServer.listen(TEST_HTTPS_PORT, () => { testHttpsServer.listen(TEST_HTTPS_PORT, () => {
console.log(`HTTPS test server listening on port ${TEST_HTTPS_PORT}`); console.log(`HTTPS test server listening on port ${TEST_HTTPS_PORT}`);
resolve(); resolve();
}); });
}); });
// Create SmartProxy with various NFTables routes
smartProxy = new SmartProxy({ smartProxy = new SmartProxy({
enableDetailedLogging: true, enableDetailedLogging: true,
routes: [ routes: [
// TCP forwarding route {
createNfTablesRoute('tcp-nftables', { match: { ports: PROXY_TCP_PORT },
host: 'localhost', action: {
port: TEST_TCP_PORT type: 'forward',
}, { forwardingEngine: 'nftables',
ports: PROXY_TCP_PORT, targets: [{ host: 'localhost', port: TEST_TCP_PORT }],
protocol: 'tcp' nftables: { protocol: 'tcp' }
}), },
name: 'tcp-nftables'
// HTTP forwarding route },
createNfTablesRoute('http-nftables', {
host: 'localhost', {
port: TEST_HTTP_PORT match: { ports: PROXY_HTTP_PORT },
}, { action: {
ports: PROXY_HTTP_PORT, type: 'forward',
protocol: 'tcp' forwardingEngine: 'nftables',
}), targets: [{ host: 'localhost', port: TEST_HTTP_PORT }],
nftables: { protocol: 'tcp' }
// HTTPS termination route },
createNfTablesTerminateRoute('https-nftables.example.com', { name: 'http-nftables'
host: 'localhost', },
port: TEST_HTTPS_PORT
}, { {
ports: PROXY_HTTPS_PORT, match: { ports: PROXY_HTTPS_PORT, domains: 'https-nftables.example.com' },
protocol: 'tcp', action: {
certificate: certs type: 'forward',
}), forwardingEngine: 'nftables',
targets: [{ host: 'localhost', port: TEST_HTTPS_PORT }],
// Route with IP allow list tls: { mode: 'terminate', certificate: 'auto' },
createNfTablesRoute('secure-tcp', { nftables: { protocol: 'tcp' }
host: 'localhost', },
port: TEST_TCP_PORT name: 'https-nftables'
}, { },
ports: 5003,
protocol: 'tcp', {
ipAllowList: ['127.0.0.1', '::1'] match: { ports: 5003 },
}), action: {
type: 'forward',
// Route with QoS settings forwardingEngine: 'nftables',
createNfTablesRoute('qos-tcp', { targets: [{ host: 'localhost', port: TEST_TCP_PORT }],
host: 'localhost', nftables: { protocol: 'tcp', ipAllowList: ['127.0.0.1', '::1'] }
port: TEST_TCP_PORT },
}, { name: 'secure-tcp'
ports: 5004, },
protocol: 'tcp',
maxRate: '10mbps', {
priority: 1 match: { ports: 5004 },
}) action: {
type: 'forward',
forwardingEngine: 'nftables',
targets: [{ host: 'localhost', port: TEST_TCP_PORT }],
nftables: { protocol: 'tcp', maxRate: '10mbps', priority: 1 }
},
name: 'qos-tcp'
}
] ]
}); });
console.log('SmartProxy created, now starting...'); console.log('SmartProxy created, now starting...');
// Start the proxy
try { try {
await smartProxy.start(); await smartProxy.start();
console.log('SmartProxy started successfully'); console.log('SmartProxy started successfully');
// Verify proxy is listening on expected ports
const listeningPorts = smartProxy.getListeningPorts(); const listeningPorts = smartProxy.getListeningPorts();
console.log(`SmartProxy is listening on ports: ${listeningPorts.join(', ')}`); console.log(`SmartProxy is listening on ports: ${listeningPorts.join(', ')}`);
} catch (err) { } catch (err) {
@@ -190,8 +184,7 @@ tap.skip.test('setup NFTables integration test environment', async () => {
tap.skip.test('should forward TCP connections through NFTables', async () => { tap.skip.test('should forward TCP connections through NFTables', async () => {
console.log(`Attempting to connect to proxy TCP port ${PROXY_TCP_PORT}...`); console.log(`Attempting to connect to proxy TCP port ${PROXY_TCP_PORT}...`);
// First verify our test server is running
try { try {
const testClient = new net.Socket(); const testClient = new net.Socket();
await new Promise<void>((resolve, reject) => { await new Promise<void>((resolve, reject) => {
@@ -205,40 +198,39 @@ tap.skip.test('should forward TCP connections through NFTables', async () => {
} catch (err) { } catch (err) {
console.error(`Test server on port ${TEST_TCP_PORT} is not accessible: ${err}`); console.error(`Test server on port ${TEST_TCP_PORT} is not accessible: ${err}`);
} }
// Connect to the proxy port
const client = new net.Socket(); const client = new net.Socket();
const response = await new Promise<string>((resolve, reject) => { const response = await new Promise<string>((resolve, reject) => {
let responseData = ''; let responseData = '';
const timeout = setTimeout(() => { const timeout = setTimeout(() => {
client.destroy(); client.destroy();
reject(new Error(`Connection timeout after 5 seconds to proxy port ${PROXY_TCP_PORT}`)); reject(new Error(`Connection timeout after 5 seconds to proxy port ${PROXY_TCP_PORT}`));
}, 5000); }, 5000);
client.connect(PROXY_TCP_PORT, 'localhost', () => { client.connect(PROXY_TCP_PORT, 'localhost', () => {
console.log(`Connected to proxy port ${PROXY_TCP_PORT}, sending data...`); console.log(`Connected to proxy port ${PROXY_TCP_PORT}, sending data...`);
client.write(TEST_DATA); client.write(TEST_DATA);
}); });
client.on('data', (data) => { client.on('data', (data) => {
console.log(`Received data from proxy: ${data.toString()}`); console.log(`Received data from proxy: ${data.toString()}`);
responseData += data.toString(); responseData += data.toString();
client.end(); client.end();
}); });
client.on('end', () => { client.on('end', () => {
clearTimeout(timeout); clearTimeout(timeout);
resolve(responseData); resolve(responseData);
}); });
client.on('error', (err) => { client.on('error', (err) => {
clearTimeout(timeout); clearTimeout(timeout);
console.error(`Connection error on proxy port ${PROXY_TCP_PORT}: ${err.message}`); console.error(`Connection error on proxy port ${PROXY_TCP_PORT}: ${err.message}`);
reject(err); reject(err);
}); });
}); });
expect(response).toEqual(`Server says: ${TEST_DATA}`); expect(response).toEqual(`Server says: ${TEST_DATA}`);
}); });
@@ -254,21 +246,20 @@ tap.skip.test('should forward HTTP connections through NFTables', async () => {
}); });
}).on('error', reject); }).on('error', reject);
}); });
expect(response).toEqual(`HTTP Server says: ${TEST_DATA}`); expect(response).toEqual(`HTTP Server says: ${TEST_DATA}`);
}); });
tap.skip.test('should handle HTTPS termination with NFTables', async () => { tap.skip.test('should handle HTTPS termination with NFTables', async () => {
// Skip this test if running without proper certificates
const response = await new Promise<string>((resolve, reject) => { const response = await new Promise<string>((resolve, reject) => {
const options = { const options = {
hostname: 'localhost', hostname: 'localhost',
port: PROXY_HTTPS_PORT, port: PROXY_HTTPS_PORT,
path: '/', path: '/',
method: 'GET', method: 'GET',
rejectUnauthorized: false // For self-signed cert rejectUnauthorized: false
}; };
https.get(options, (res) => { https.get(options, (res) => {
let data = ''; let data = '';
res.on('data', (chunk) => { res.on('data', (chunk) => {
@@ -279,43 +270,40 @@ tap.skip.test('should handle HTTPS termination with NFTables', async () => {
}); });
}).on('error', reject); }).on('error', reject);
}); });
expect(response).toEqual(`HTTPS Server says: ${TEST_DATA}`); expect(response).toEqual(`HTTPS Server says: ${TEST_DATA}`);
}); });
tap.skip.test('should respect IP allow lists in NFTables', async () => { tap.skip.test('should respect IP allow lists in NFTables', async () => {
// This test should pass since we're connecting from localhost
const client = new net.Socket(); const client = new net.Socket();
const connected = await new Promise<boolean>((resolve) => { const connected = await new Promise<boolean>((resolve) => {
const timeout = setTimeout(() => { const timeout = setTimeout(() => {
client.destroy(); client.destroy();
resolve(false); resolve(false);
}, 2000); }, 2000);
client.connect(5003, 'localhost', () => { client.connect(5003, 'localhost', () => {
clearTimeout(timeout); clearTimeout(timeout);
client.end(); client.end();
resolve(true); resolve(true);
}); });
client.on('error', () => { client.on('error', () => {
clearTimeout(timeout); clearTimeout(timeout);
resolve(false); resolve(false);
}); });
}); });
expect(connected).toBeTrue(); expect(connected).toBeTrue();
}); });
tap.skip.test('should get NFTables status', async () => { tap.skip.test('should get NFTables status', async () => {
const status = await smartProxy.getNfTablesStatus(); const status = await smartProxy.getNfTablesStatus();
// Check that we have status for our routes
const statusKeys = Object.keys(status); const statusKeys = Object.keys(status);
expect(statusKeys.length).toBeGreaterThan(0); expect(statusKeys.length).toBeGreaterThan(0);
// Check status structure for one of the routes
const firstStatus = status[statusKeys[0]]; const firstStatus = status[statusKeys[0]];
expect(firstStatus).toHaveProperty('active'); expect(firstStatus).toHaveProperty('active');
expect(firstStatus).toHaveProperty('ruleCount'); expect(firstStatus).toHaveProperty('ruleCount');
@@ -324,21 +312,20 @@ tap.skip.test('should get NFTables status', async () => {
}); });
tap.skip.test('cleanup NFTables integration test environment', async () => { tap.skip.test('cleanup NFTables integration test environment', async () => {
// Stop the proxy and test servers
await smartProxy.stop(); await smartProxy.stop();
await new Promise<void>((resolve) => { await new Promise<void>((resolve) => {
testTcpServer.close(() => { testTcpServer.close(() => {
resolve(); resolve();
}); });
}); });
await new Promise<void>((resolve) => { await new Promise<void>((resolve) => {
testHttpServer.close(() => { testHttpServer.close(() => {
resolve(); resolve();
}); });
}); });
await new Promise<void>((resolve) => { await new Promise<void>((resolve) => {
testHttpsServer.close(() => { testHttpsServer.close(() => {
resolve(); resolve();
@@ -346,4 +333,4 @@ tap.skip.test('cleanup NFTables integration test environment', async () => {
}); });
}); });
export default tap.start(); export default tap.start();
+75 -111
View File
@@ -1,30 +1,20 @@
import { expect, tap } from '@git.zone/tstest/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as net from 'net'; import * as net from 'net';
import { SmartProxy } from '../ts/proxies/smart-proxy/index.js'; import { SmartProxy } from '../ts/proxies/smart-proxy/index.js';
import {
createPortMappingRoute,
createOffsetPortMappingRoute,
createDynamicRoute,
createSmartLoadBalancer,
createPortOffset
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import type { IRouteConfig, IRouteContext } from '../ts/proxies/smart-proxy/models/route-types.js'; import type { IRouteConfig, IRouteContext } from '../ts/proxies/smart-proxy/models/route-types.js';
import { findFreePorts, assertPortsFree } from './helpers/port-allocator.js'; import { findFreePorts, assertPortsFree } from './helpers/port-allocator.js';
// Test server and client utilities
let testServers: Array<{ server: net.Server; port: number }> = []; let testServers: Array<{ server: net.Server; port: number }> = [];
let smartProxy: SmartProxy; let smartProxy: SmartProxy;
let TEST_PORTS: number[]; // 3 test server ports let TEST_PORTS: number[];
let PROXY_PORTS: number[]; // 6 proxy ports let PROXY_PORTS: number[];
const TEST_DATA = 'Hello through dynamic port mapper!'; const TEST_DATA = 'Hello through dynamic port mapper!';
// Cleanup function to close all servers and proxies
function cleanup() { function cleanup() {
console.log('Starting cleanup...'); console.log('Starting cleanup...');
const promises = []; const promises = [];
// Close test servers
for (const { server, port } of testServers) { for (const { server, port } of testServers) {
promises.push(new Promise<void>(resolve => { promises.push(new Promise<void>(resolve => {
console.log(`Closing test server on port ${port}`); console.log(`Closing test server on port ${port}`);
@@ -34,31 +24,28 @@ function cleanup() {
}); });
})); }));
} }
// Stop SmartProxy
if (smartProxy) { if (smartProxy) {
console.log('Stopping SmartProxy...'); console.log('Stopping SmartProxy...');
promises.push(smartProxy.stop().then(() => { promises.push(smartProxy.stop().then(() => {
console.log('SmartProxy stopped'); console.log('SmartProxy stopped');
})); }));
} }
return Promise.all(promises); return Promise.all(promises);
} }
// Helper: Creates a test TCP server that listens on a given port
function createTestServer(port: number): Promise<net.Server> { function createTestServer(port: number): Promise<net.Server> {
return new Promise((resolve) => { return new Promise((resolve) => {
const server = net.createServer((socket) => { const server = net.createServer((socket) => {
socket.on('data', (data) => { socket.on('data', (data) => {
// Echo the received data back with a server identifier
socket.write(`Server ${port} says: ${data.toString()}`); socket.write(`Server ${port} says: ${data.toString()}`);
}); });
socket.on('error', (error) => { socket.on('error', (error) => {
console.error(`[Test Server] Socket error on port ${port}:`, error); console.error(`[Test Server] Socket error on port ${port}:`, error);
}); });
}); });
server.listen(port, () => { server.listen(port, () => {
console.log(`[Test Server] Listening on port ${port}`); console.log(`[Test Server] Listening on port ${port}`);
testServers.push({ server, port }); testServers.push({ server, port });
@@ -67,32 +54,31 @@ function createTestServer(port: number): Promise<net.Server> {
}); });
} }
// Helper: Creates a test client connection with timeout
function createTestClient(port: number, data: string): Promise<string> { function createTestClient(port: number, data: string): Promise<string> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const client = new net.Socket(); const client = new net.Socket();
let response = ''; let response = '';
const timeout = setTimeout(() => { const timeout = setTimeout(() => {
client.destroy(); client.destroy();
reject(new Error(`Client connection timeout to port ${port}`)); reject(new Error(`Client connection timeout to port ${port}`));
}, 5000); }, 5000);
client.connect(port, 'localhost', () => { client.connect(port, 'localhost', () => {
console.log(`[Test Client] Connected to server on port ${port}`); console.log(`[Test Client] Connected to server on port ${port}`);
client.write(data); client.write(data);
}); });
client.on('data', (chunk) => { client.on('data', (chunk) => {
response += chunk.toString(); response += chunk.toString();
client.end(); client.end();
}); });
client.on('end', () => { client.on('end', () => {
clearTimeout(timeout); clearTimeout(timeout);
resolve(response); resolve(response);
}); });
client.on('error', (error) => { client.on('error', (error) => {
clearTimeout(timeout); clearTimeout(timeout);
reject(error); reject(error);
@@ -100,123 +86,108 @@ function createTestClient(port: number, data: string): Promise<string> {
}); });
} }
// Set up test environment
tap.test('setup port mapping test environment', async () => { tap.test('setup port mapping test environment', async () => {
const allPorts = await findFreePorts(9); const allPorts = await findFreePorts(9);
TEST_PORTS = allPorts.slice(0, 3); TEST_PORTS = allPorts.slice(0, 3);
PROXY_PORTS = allPorts.slice(3, 9); PROXY_PORTS = allPorts.slice(3, 9);
// Create multiple test servers on different ports
await Promise.all([ await Promise.all([
createTestServer(TEST_PORTS[0]), createTestServer(TEST_PORTS[0]),
createTestServer(TEST_PORTS[1]), createTestServer(TEST_PORTS[1]),
createTestServer(TEST_PORTS[2]), createTestServer(TEST_PORTS[2]),
]); ]);
// Compute dynamic offset between proxy and test ports
const portOffset = TEST_PORTS[1] - PROXY_PORTS[1]; const portOffset = TEST_PORTS[1] - PROXY_PORTS[1];
// Create a SmartProxy with dynamic port mapping routes
smartProxy = new SmartProxy({ smartProxy = new SmartProxy({
routes: [ routes: [
// Simple function that returns the same port (identity mapping) {
createPortMappingRoute({ match: { ports: PROXY_PORTS[0] },
sourcePortRange: PROXY_PORTS[0], action: {
targetHost: 'localhost', type: 'forward',
portMapper: (context) => TEST_PORTS[0], targets: [{
name: 'Identity Port Mapping' host: 'localhost',
}), port: (context: IRouteContext) => TEST_PORTS[0]
}]
// Offset port mapping using dynamic offset
createOffsetPortMappingRoute({
ports: PROXY_PORTS[1],
targetHost: 'localhost',
offset: portOffset,
name: `Offset Port Mapping (${portOffset})`
}),
// Dynamic route with conditional port mapping
createDynamicRoute({
ports: [PROXY_PORTS[2], PROXY_PORTS[3]],
targetHost: (context) => {
// Dynamic host selection based on port
return context.port === PROXY_PORTS[2] ? 'localhost' : '127.0.0.1';
}, },
portMapper: (context) => { name: 'Identity Port Mapping'
// Port mapping logic based on incoming port },
if (context.port === PROXY_PORTS[2]) {
return TEST_PORTS[0]; {
} else { match: { ports: PROXY_PORTS[1] },
return TEST_PORTS[2]; action: {
} type: 'forward',
targets: [{
host: 'localhost',
port: (context: IRouteContext) => context.port + portOffset
}]
},
name: `Offset Port Mapping (${portOffset})`
},
{
match: { ports: [PROXY_PORTS[2], PROXY_PORTS[3]] },
action: {
type: 'forward',
targets: [{
host: (context: IRouteContext) => {
return context.port === PROXY_PORTS[2] ? 'localhost' : '127.0.0.1';
},
port: (context: IRouteContext) => {
if (context.port === PROXY_PORTS[2]) {
return TEST_PORTS[0];
} else {
return TEST_PORTS[2];
}
}
}]
}, },
name: 'Dynamic Host and Port Mapping' name: 'Dynamic Host and Port Mapping'
}), },
// Smart load balancer for domain-based routing {
createSmartLoadBalancer({ match: { ports: PROXY_PORTS[4] },
ports: PROXY_PORTS[4], action: {
domainTargets: { type: 'forward',
'test1.example.com': 'localhost', targets: [{
'test2.example.com': '127.0.0.1' host: (context: IRouteContext) => {
if (context.domain === 'test1.example.com') return 'localhost';
if (context.domain === 'test2.example.com') return '127.0.0.1';
return 'localhost';
},
port: (context: IRouteContext) => {
if (context.domain === 'test1.example.com') {
return TEST_PORTS[0];
} else {
return TEST_PORTS[1];
}
}
}]
}, },
portMapper: (context) => {
// Use different backend ports based on domain
if (context.domain === 'test1.example.com') {
return TEST_PORTS[0];
} else {
return TEST_PORTS[1];
}
},
defaultTarget: 'localhost',
name: 'Smart Domain Load Balancer' name: 'Smart Domain Load Balancer'
}) }
] ]
}); });
// Start the SmartProxy
await smartProxy.start(); await smartProxy.start();
}); });
// Test 1: Simple identity port mapping
tap.test('should map port using identity function', async () => { tap.test('should map port using identity function', async () => {
const response = await createTestClient(PROXY_PORTS[0], TEST_DATA); const response = await createTestClient(PROXY_PORTS[0], TEST_DATA);
expect(response).toEqual(`Server ${TEST_PORTS[0]} says: ${TEST_DATA}`); expect(response).toEqual(`Server ${TEST_PORTS[0]} says: ${TEST_DATA}`);
}); });
// Test 2: Offset port mapping
tap.test('should map port using offset function', async () => { tap.test('should map port using offset function', async () => {
const response = await createTestClient(PROXY_PORTS[1], TEST_DATA); const response = await createTestClient(PROXY_PORTS[1], TEST_DATA);
expect(response).toEqual(`Server ${TEST_PORTS[1]} says: ${TEST_DATA}`); expect(response).toEqual(`Server ${TEST_PORTS[1]} says: ${TEST_DATA}`);
}); });
// Test 3: Dynamic port and host mapping (conditional logic)
tap.test('should map port using dynamic logic', async () => { tap.test('should map port using dynamic logic', async () => {
const response = await createTestClient(PROXY_PORTS[2], TEST_DATA); const response = await createTestClient(PROXY_PORTS[2], TEST_DATA);
expect(response).toEqual(`Server ${TEST_PORTS[0]} says: ${TEST_DATA}`); expect(response).toEqual(`Server ${TEST_PORTS[0]} says: ${TEST_DATA}`);
}); });
// Test 4: Test reuse of createPortOffset helper
tap.test('should use createPortOffset helper for port mapping', async () => {
// Test the createPortOffset helper with dynamic offset
const portOffset = TEST_PORTS[1] - PROXY_PORTS[1];
const offsetFn = createPortOffset(portOffset);
const context = {
port: PROXY_PORTS[1],
clientIp: '127.0.0.1',
serverIp: '127.0.0.1',
isTls: false,
timestamp: Date.now(),
connectionId: 'test-connection'
} as IRouteContext;
const mappedPort = offsetFn(context);
expect(mappedPort).toEqual(TEST_PORTS[1]);
});
// Test 5: Test error handling for invalid port mapping functions
tap.test('should handle errors in port mapping functions', async () => { tap.test('should handle errors in port mapping functions', async () => {
// Create a route with a function that throws an error
const errorRoute: IRouteConfig = { const errorRoute: IRouteConfig = {
match: { match: {
ports: PROXY_PORTS[5] ports: PROXY_PORTS[5]
@@ -232,34 +203,27 @@ tap.test('should handle errors in port mapping functions', async () => {
}, },
name: 'Error Route' name: 'Error Route'
}; };
// Add the route to SmartProxy
await smartProxy.updateRoutes([...smartProxy.settings.routes, errorRoute]); await smartProxy.updateRoutes([...smartProxy.settings.routes, errorRoute]);
// The connection should fail or timeout
try { try {
await createTestClient(PROXY_PORTS[5], TEST_DATA); await createTestClient(PROXY_PORTS[5], TEST_DATA);
// Connection should not succeed
expect(false).toBeTrue(); expect(false).toBeTrue();
} catch (error) { } catch (error) {
// Connection failed as expected
expect(true).toBeTrue(); expect(true).toBeTrue();
} }
}); });
// Cleanup
tap.test('cleanup port mapping test environment', async () => { tap.test('cleanup port mapping test environment', async () => {
// Add timeout to prevent hanging if SmartProxy shutdown has issues
const cleanupPromise = cleanup(); const cleanupPromise = cleanup();
const timeoutPromise = new Promise((_, reject) => const timeoutPromise = new Promise((_, reject) =>
setTimeout(() => reject(new Error('Cleanup timeout after 5 seconds')), 5000) setTimeout(() => reject(new Error('Cleanup timeout after 5 seconds')), 5000)
); );
try { try {
await Promise.race([cleanupPromise, timeoutPromise]); await Promise.race([cleanupPromise, timeoutPromise]);
} catch (error) { } catch (error) {
console.error('Cleanup error:', error); console.error('Cleanup error:', error);
// Force cleanup even if there's an error
testServers = []; testServers = [];
smartProxy = null as any; smartProxy = null as any;
} }
@@ -267,4 +231,4 @@ tap.test('cleanup port mapping test environment', async () => {
await assertPortsFree([...TEST_PORTS, ...PROXY_PORTS]); await assertPortsFree([...TEST_PORTS, ...PROXY_PORTS]);
}); });
export default tap.start(); export default tap.start();
+266 -223
View File
@@ -6,7 +6,7 @@ import { expect, tap } from '@git.zone/tstest/tapbundle';
// Import from core modules // Import from core modules
import { SmartProxy } from '../ts/proxies/smart-proxy/index.js'; import { SmartProxy } from '../ts/proxies/smart-proxy/index.js';
// Import route utilities and helpers // Import route utilities
import { import {
findMatchingRoutes, findMatchingRoutes,
findBestMatchingRoute, findBestMatchingRoute,
@@ -28,16 +28,7 @@ import {
assertValidRoute assertValidRoute
} from '../ts/proxies/smart-proxy/utils/route-validator.js'; } from '../ts/proxies/smart-proxy/utils/route-validator.js';
import { import { SocketHandlers } from '../ts/proxies/smart-proxy/utils/socket-handlers.js';
createHttpRoute,
createHttpsTerminateRoute,
createHttpsPassthroughRoute,
createHttpToHttpsRedirect,
createCompleteHttpsServer,
createLoadBalancerRoute,
createApiRoute,
createWebSocketRoute
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
// Import test helpers // Import test helpers
import { loadTestCertificates } from './helpers/certificates.js'; import { loadTestCertificates } from './helpers/certificates.js';
@@ -47,12 +38,12 @@ import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.
// --------------------------------- Route Creation Tests --------------------------------- // --------------------------------- Route Creation Tests ---------------------------------
tap.test('Routes: Should create basic HTTP route', async () => { tap.test('Routes: Should create basic HTTP route', async () => {
// Create a simple HTTP route const httpRoute: IRouteConfig = {
const httpRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }, { match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'Basic HTTP Route' name: 'Basic HTTP Route'
}); };
// Validate the route configuration
expect(httpRoute.match.ports).toEqual(80); expect(httpRoute.match.ports).toEqual(80);
expect(httpRoute.match.domains).toEqual('example.com'); expect(httpRoute.match.domains).toEqual('example.com');
expect(httpRoute.action.type).toEqual('forward'); expect(httpRoute.action.type).toEqual('forward');
@@ -62,14 +53,17 @@ tap.test('Routes: Should create basic HTTP route', async () => {
}); });
tap.test('Routes: Should create HTTPS route with TLS termination', async () => { tap.test('Routes: Should create HTTPS route with TLS termination', async () => {
// Create an HTTPS route with TLS termination const httpsRoute: IRouteConfig = {
const httpsRoute = createHttpsTerminateRoute('secure.example.com', { host: 'localhost', port: 8080 }, { match: { ports: 443, domains: 'secure.example.com' },
certificate: 'auto', action: {
type: 'forward',
targets: [{ host: 'localhost', port: 8080 }],
tls: { mode: 'terminate', certificate: 'auto' }
},
name: 'HTTPS Route' name: 'HTTPS Route'
}); };
// Validate the route configuration expect(httpsRoute.match.ports).toEqual(443);
expect(httpsRoute.match.ports).toEqual(443); // Default HTTPS port
expect(httpsRoute.match.domains).toEqual('secure.example.com'); expect(httpsRoute.match.domains).toEqual('secure.example.com');
expect(httpsRoute.action.type).toEqual('forward'); expect(httpsRoute.action.type).toEqual('forward');
expect(httpsRoute.action.tls?.mode).toEqual('terminate'); expect(httpsRoute.action.tls?.mode).toEqual('terminate');
@@ -80,10 +74,15 @@ tap.test('Routes: Should create HTTPS route with TLS termination', async () => {
}); });
tap.test('Routes: Should create HTTP to HTTPS redirect', async () => { tap.test('Routes: Should create HTTP to HTTPS redirect', async () => {
// Create an HTTP to HTTPS redirect const redirectRoute: IRouteConfig = {
const redirectRoute = createHttpToHttpsRedirect('example.com', 443); match: { ports: 80, domains: 'example.com' },
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
},
name: 'HTTP to HTTPS Redirect for example.com'
};
// Validate the route configuration
expect(redirectRoute.match.ports).toEqual(80); expect(redirectRoute.match.ports).toEqual(80);
expect(redirectRoute.match.domains).toEqual('example.com'); expect(redirectRoute.match.domains).toEqual('example.com');
expect(redirectRoute.action.type).toEqual('socket-handler'); expect(redirectRoute.action.type).toEqual('socket-handler');
@@ -91,22 +90,34 @@ tap.test('Routes: Should create HTTP to HTTPS redirect', async () => {
}); });
tap.test('Routes: Should create complete HTTPS server with redirects', async () => { tap.test('Routes: Should create complete HTTPS server with redirects', async () => {
// Create a complete HTTPS server setup const routes: IRouteConfig[] = [
const routes = createCompleteHttpsServer('example.com', { host: 'localhost', port: 8080 }, { {
certificate: 'auto' match: { ports: 443, domains: 'example.com' },
}); action: {
type: 'forward',
targets: [{ host: 'localhost', port: 8080 }],
tls: { mode: 'terminate', certificate: 'auto' }
},
name: 'HTTPS Terminate Route for example.com'
},
{
match: { ports: 80, domains: 'example.com' },
action: {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
},
name: 'HTTP to HTTPS Redirect for example.com'
}
];
// Validate that we got two routes (HTTPS route and HTTP redirect)
expect(routes.length).toEqual(2); expect(routes.length).toEqual(2);
// Validate HTTPS route
const httpsRoute = routes[0]; const httpsRoute = routes[0];
expect(httpsRoute.match.ports).toEqual(443); expect(httpsRoute.match.ports).toEqual(443);
expect(httpsRoute.match.domains).toEqual('example.com'); expect(httpsRoute.match.domains).toEqual('example.com');
expect(httpsRoute.action.type).toEqual('forward'); expect(httpsRoute.action.type).toEqual('forward');
expect(httpsRoute.action.tls?.mode).toEqual('terminate'); expect(httpsRoute.action.tls?.mode).toEqual('terminate');
// Validate HTTP redirect route
const redirectRoute = routes[1]; const redirectRoute = routes[1];
expect(redirectRoute.match.ports).toEqual(80); expect(redirectRoute.match.ports).toEqual(80);
expect(redirectRoute.action.type).toEqual('socket-handler'); expect(redirectRoute.action.type).toEqual('socket-handler');
@@ -114,21 +125,17 @@ tap.test('Routes: Should create complete HTTPS server with redirects', async ()
}); });
tap.test('Routes: Should create load balancer route', async () => { tap.test('Routes: Should create load balancer route', async () => {
// Create a load balancer route const lbRoute: IRouteConfig = {
const lbRoute = createLoadBalancerRoute( match: { ports: 443, domains: 'app.example.com' },
'app.example.com', action: {
['10.0.0.1', '10.0.0.2', '10.0.0.3'], type: 'forward',
8080, targets: [{ host: ['10.0.0.1', '10.0.0.2', '10.0.0.3'], port: 8080 }],
{ tls: { mode: 'terminate', certificate: 'auto' },
tls: { loadBalancing: { algorithm: 'round-robin' }
mode: 'terminate', },
certificate: 'auto' name: 'Load Balanced Route'
}, };
name: 'Load Balanced Route'
}
);
// Validate the route configuration
expect(lbRoute.match.domains).toEqual('app.example.com'); expect(lbRoute.match.domains).toEqual('app.example.com');
expect(lbRoute.action.type).toEqual('forward'); expect(lbRoute.action.type).toEqual('forward');
expect(Array.isArray(lbRoute.action.targets?.[0]?.host)).toBeTrue(); expect(Array.isArray(lbRoute.action.targets?.[0]?.host)).toBeTrue();
@@ -139,23 +146,32 @@ tap.test('Routes: Should create load balancer route', async () => {
}); });
tap.test('Routes: Should create API route with CORS', async () => { tap.test('Routes: Should create API route with CORS', async () => {
// Create an API route with CORS headers const apiRoute: IRouteConfig = {
const apiRoute = createApiRoute('api.example.com', '/v1', { host: 'localhost', port: 3000 }, { match: { ports: 443, domains: 'api.example.com', path: '/v1/*' },
useTls: true, action: {
certificate: 'auto', type: 'forward',
addCorsHeaders: true, targets: [{ host: 'localhost', port: 3000 }],
tls: { mode: 'terminate', certificate: 'auto' }
},
headers: {
response: {
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type, Authorization',
'Access-Control-Max-Age': '86400'
}
},
priority: 100,
name: 'API Route' name: 'API Route'
}); };
// Validate the route configuration
expect(apiRoute.match.domains).toEqual('api.example.com'); expect(apiRoute.match.domains).toEqual('api.example.com');
expect(apiRoute.match.path).toEqual('/v1/*'); expect(apiRoute.match.path).toEqual('/v1/*');
expect(apiRoute.action.type).toEqual('forward'); expect(apiRoute.action.type).toEqual('forward');
expect(apiRoute.action.tls?.mode).toEqual('terminate'); expect(apiRoute.action.tls?.mode).toEqual('terminate');
expect(apiRoute.action.targets?.[0]?.host).toEqual('localhost'); expect(apiRoute.action.targets?.[0]?.host).toEqual('localhost');
expect(apiRoute.action.targets?.[0]?.port).toEqual(3000); expect(apiRoute.action.targets?.[0]?.port).toEqual(3000);
// Check CORS headers
expect(apiRoute.headers).toBeDefined(); expect(apiRoute.headers).toBeDefined();
if (apiRoute.headers?.response) { if (apiRoute.headers?.response) {
expect(apiRoute.headers.response['Access-Control-Allow-Origin']).toEqual('*'); expect(apiRoute.headers.response['Access-Control-Allow-Origin']).toEqual('*');
@@ -164,23 +180,25 @@ tap.test('Routes: Should create API route with CORS', async () => {
}); });
tap.test('Routes: Should create WebSocket route', async () => { tap.test('Routes: Should create WebSocket route', async () => {
// Create a WebSocket route const wsRoute: IRouteConfig = {
const wsRoute = createWebSocketRoute('ws.example.com', '/socket', { host: 'localhost', port: 5000 }, { match: { ports: 443, domains: 'ws.example.com', path: '/socket' },
useTls: true, action: {
certificate: 'auto', type: 'forward',
pingInterval: 15000, targets: [{ host: 'localhost', port: 5000 }],
tls: { mode: 'terminate', certificate: 'auto' },
websocket: { enabled: true, pingInterval: 15000 }
},
priority: 100,
name: 'WebSocket Route' name: 'WebSocket Route'
}); };
// Validate the route configuration
expect(wsRoute.match.domains).toEqual('ws.example.com'); expect(wsRoute.match.domains).toEqual('ws.example.com');
expect(wsRoute.match.path).toEqual('/socket'); expect(wsRoute.match.path).toEqual('/socket');
expect(wsRoute.action.type).toEqual('forward'); expect(wsRoute.action.type).toEqual('forward');
expect(wsRoute.action.tls?.mode).toEqual('terminate'); expect(wsRoute.action.tls?.mode).toEqual('terminate');
expect(wsRoute.action.targets?.[0]?.host).toEqual('localhost'); expect(wsRoute.action.targets?.[0]?.host).toEqual('localhost');
expect(wsRoute.action.targets?.[0]?.port).toEqual(5000); expect(wsRoute.action.targets?.[0]?.port).toEqual(5000);
// Check WebSocket configuration
expect(wsRoute.action.websocket).toBeDefined(); expect(wsRoute.action.websocket).toBeDefined();
if (wsRoute.action.websocket) { if (wsRoute.action.websocket) {
expect(wsRoute.action.websocket.enabled).toBeTrue(); expect(wsRoute.action.websocket.enabled).toBeTrue();
@@ -191,22 +209,27 @@ tap.test('Routes: Should create WebSocket route', async () => {
// Static file serving has been removed - should be handled by external servers // Static file serving has been removed - should be handled by external servers
tap.test('SmartProxy: Should create instance with route-based config', async () => { tap.test('SmartProxy: Should create instance with route-based config', async () => {
// Create TLS certificates for testing
const certs = loadTestCertificates(); const certs = loadTestCertificates();
// Create a SmartProxy instance with route-based configuration
const proxy = new SmartProxy({ const proxy = new SmartProxy({
routes: [ routes: [
createHttpRoute('example.com', { host: 'localhost', port: 3000 }, { {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route' name: 'HTTP Route'
}), },
createHttpsTerminateRoute('secure.example.com', { host: 'localhost', port: 8443 }, { {
certificate: { match: { ports: 443, domains: 'secure.example.com' },
key: certs.privateKey, action: {
cert: certs.publicKey type: 'forward',
targets: [{ host: 'localhost', port: 8443 }],
tls: {
mode: 'terminate',
certificate: { key: certs.privateKey, cert: certs.publicKey }
}
}, },
name: 'HTTPS Route' name: 'HTTPS Route'
}) }
], ],
defaults: { defaults: {
target: { target: {
@@ -218,13 +241,11 @@ tap.test('SmartProxy: Should create instance with route-based config', async ()
maxConnections: 100 maxConnections: 100
} }
}, },
// Additional settings
initialDataTimeout: 10000, initialDataTimeout: 10000,
inactivityTimeout: 300000, inactivityTimeout: 300000,
enableDetailedLogging: true enableDetailedLogging: true
}); });
// Simply verify the instance was created successfully
expect(typeof proxy).toEqual('object'); expect(typeof proxy).toEqual('object');
expect(typeof proxy.start).toEqual('function'); expect(typeof proxy.start).toEqual('function');
expect(typeof proxy.stop).toEqual('function'); expect(typeof proxy.stop).toEqual('function');
@@ -233,94 +254,109 @@ tap.test('SmartProxy: Should create instance with route-based config', async ()
// --------------------------------- Edge Case Tests --------------------------------- // --------------------------------- Edge Case Tests ---------------------------------
tap.test('Edge Case - Empty Routes Array', async () => { tap.test('Edge Case - Empty Routes Array', async () => {
// Attempting to find routes in an empty array
const emptyRoutes: IRouteConfig[] = []; const emptyRoutes: IRouteConfig[] = [];
const matches = findMatchingRoutes(emptyRoutes, { domain: 'example.com', port: 80 }); const matches = findMatchingRoutes(emptyRoutes, { domain: 'example.com', port: 80 });
expect(matches).toBeInstanceOf(Array); expect(matches).toBeInstanceOf(Array);
expect(matches.length).toEqual(0); expect(matches.length).toEqual(0);
const bestMatch = findBestMatchingRoute(emptyRoutes, { domain: 'example.com', port: 80 }); const bestMatch = findBestMatchingRoute(emptyRoutes, { domain: 'example.com', port: 80 });
expect(bestMatch).toBeUndefined(); expect(bestMatch).toBeUndefined();
}); });
tap.test('Edge Case - Multiple Matching Routes with Same Priority', async () => { tap.test('Edge Case - Multiple Matching Routes with Same Priority', async () => {
// Create multiple routes with identical priority but different targets const route1: IRouteConfig = {
const route1 = createHttpRoute('example.com', { host: 'server1', port: 3000 }); match: { ports: 80, domains: 'example.com' },
const route2 = createHttpRoute('example.com', { host: 'server2', port: 3000 }); action: { type: 'forward', targets: [{ host: 'server1', port: 3000 }] },
const route3 = createHttpRoute('example.com', { host: 'server3', port: 3000 }); name: 'HTTP Route for example.com'
};
// Set all to the same priority const route2: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'server2', port: 3000 }] },
name: 'HTTP Route for example.com'
};
const route3: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'server3', port: 3000 }] },
name: 'HTTP Route for example.com'
};
route1.priority = 100; route1.priority = 100;
route2.priority = 100; route2.priority = 100;
route3.priority = 100; route3.priority = 100;
const routes = [route1, route2, route3]; const routes = [route1, route2, route3];
// Find matching routes
const matches = findMatchingRoutes(routes, { domain: 'example.com', port: 80 }); const matches = findMatchingRoutes(routes, { domain: 'example.com', port: 80 });
// Should find all three routes
expect(matches.length).toEqual(3); expect(matches.length).toEqual(3);
// First match could be any of the routes since they have the same priority
// But the implementation should be consistent (likely keep the original order)
const bestMatch = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 }); const bestMatch = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 });
expect(bestMatch).not.toBeUndefined(); expect(bestMatch).not.toBeUndefined();
}); });
tap.test('Edge Case - Wildcard Domains and Path Matching', async () => { tap.test('Edge Case - Wildcard Domains and Path Matching', async () => {
// Create routes with wildcard domains and path patterns const wildcardApiRoute: IRouteConfig = {
const wildcardApiRoute = createApiRoute('*.example.com', '/api', { host: 'api-server', port: 3000 }, { match: { ports: 443, domains: '*.example.com', path: '/api/*' },
useTls: true, action: {
certificate: 'auto' type: 'forward',
}); targets: [{ host: 'api-server', port: 3000 }],
tls: { mode: 'terminate', certificate: 'auto' }
const exactApiRoute = createApiRoute('api.example.com', '/api', { host: 'specific-api-server', port: 3001 }, { },
useTls: true, priority: 100,
certificate: 'auto', name: 'API Route for *.example.com'
priority: 200 // Higher priority };
});
const exactApiRoute: IRouteConfig = {
match: { ports: 443, domains: 'api.example.com', path: '/api/*' },
action: {
type: 'forward',
targets: [{ host: 'specific-api-server', port: 3001 }],
tls: { mode: 'terminate', certificate: 'auto' }
},
priority: 200,
name: 'API Route for api.example.com'
};
const routes = [wildcardApiRoute, exactApiRoute]; const routes = [wildcardApiRoute, exactApiRoute];
// Test with a specific subdomain that matches both routes
const matches = findMatchingRoutes(routes, { domain: 'api.example.com', path: '/api/users', port: 443 }); const matches = findMatchingRoutes(routes, { domain: 'api.example.com', path: '/api/users', port: 443 });
// Should match both routes
expect(matches.length).toEqual(2); expect(matches.length).toEqual(2);
// The exact domain match should have higher priority
const bestMatch = findBestMatchingRoute(routes, { domain: 'api.example.com', path: '/api/users', port: 443 }); const bestMatch = findBestMatchingRoute(routes, { domain: 'api.example.com', path: '/api/users', port: 443 });
expect(bestMatch).not.toBeUndefined(); expect(bestMatch).not.toBeUndefined();
if (bestMatch) { if (bestMatch) {
expect(bestMatch.action.targets[0].port).toEqual(3001); // Should match the exact domain route expect(bestMatch.action.targets[0].port).toEqual(3001);
} }
// Test with a different subdomain - should only match the wildcard route
const otherMatches = findMatchingRoutes(routes, { domain: 'other.example.com', path: '/api/products', port: 443 }); const otherMatches = findMatchingRoutes(routes, { domain: 'other.example.com', path: '/api/products', port: 443 });
expect(otherMatches.length).toEqual(1); expect(otherMatches.length).toEqual(1);
expect(otherMatches[0].action.targets[0].port).toEqual(3000); // Should match the wildcard domain route expect(otherMatches[0].action.targets[0].port).toEqual(3000);
}); });
tap.test('Edge Case - Disabled Routes', async () => { tap.test('Edge Case - Disabled Routes', async () => {
// Create enabled and disabled routes const enabledRoute: IRouteConfig = {
const enabledRoute = createHttpRoute('example.com', { host: 'server1', port: 3000 }); match: { ports: 80, domains: 'example.com' },
const disabledRoute = createHttpRoute('example.com', { host: 'server2', port: 3001 }); action: { type: 'forward', targets: [{ host: 'server1', port: 3000 }] },
name: 'HTTP Route for example.com'
};
const disabledRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'server2', port: 3001 }] },
name: 'HTTP Route for example.com'
};
disabledRoute.enabled = false; disabledRoute.enabled = false;
const routes = [enabledRoute, disabledRoute]; const routes = [enabledRoute, disabledRoute];
// Find matching routes
const matches = findMatchingRoutes(routes, { domain: 'example.com', port: 80 }); const matches = findMatchingRoutes(routes, { domain: 'example.com', port: 80 });
// Should only find the enabled route
expect(matches.length).toEqual(1); expect(matches.length).toEqual(1);
expect(matches[0].action.targets[0].port).toEqual(3000); expect(matches[0].action.targets[0].port).toEqual(3000);
}); });
tap.test('Edge Case - Complex Path and Headers Matching', async () => { tap.test('Edge Case - Complex Path and Headers Matching', async () => {
// Create route with complex path and headers matching
const complexRoute: IRouteConfig = { const complexRoute: IRouteConfig = {
match: { match: {
domains: 'api.example.com', domains: 'api.example.com',
@@ -344,22 +380,20 @@ tap.test('Edge Case - Complex Path and Headers Matching', async () => {
}, },
name: 'Complex API Route' name: 'Complex API Route'
}; };
// Test with matching criteria
const matchingPath = routeMatchesPath(complexRoute, '/api/v2/users'); const matchingPath = routeMatchesPath(complexRoute, '/api/v2/users');
expect(matchingPath).toBeTrue(); expect(matchingPath).toBeTrue();
const matchingHeaders = routeMatchesHeaders(complexRoute, { const matchingHeaders = routeMatchesHeaders(complexRoute, {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
'X-API-Key': 'valid-key', 'X-API-Key': 'valid-key',
'Accept': 'application/json' 'Accept': 'application/json'
}); });
expect(matchingHeaders).toBeTrue(); expect(matchingHeaders).toBeTrue();
// Test with non-matching criteria
const nonMatchingPath = routeMatchesPath(complexRoute, '/api/v1/users'); const nonMatchingPath = routeMatchesPath(complexRoute, '/api/v1/users');
expect(nonMatchingPath).toBeFalse(); expect(nonMatchingPath).toBeFalse();
const nonMatchingHeaders = routeMatchesHeaders(complexRoute, { const nonMatchingHeaders = routeMatchesHeaders(complexRoute, {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
'X-API-Key': 'invalid-key' 'X-API-Key': 'invalid-key'
@@ -368,7 +402,6 @@ tap.test('Edge Case - Complex Path and Headers Matching', async () => {
}); });
tap.test('Edge Case - Port Range Matching', async () => { tap.test('Edge Case - Port Range Matching', async () => {
// Create route with port range matching
const portRangeRoute: IRouteConfig = { const portRangeRoute: IRouteConfig = {
match: { match: {
domains: 'example.com', domains: 'example.com',
@@ -383,17 +416,14 @@ tap.test('Edge Case - Port Range Matching', async () => {
}, },
name: 'Port Range Route' name: 'Port Range Route'
}; };
// Test with ports in the range expect(routeMatchesPort(portRangeRoute, 8000)).toBeTrue();
expect(routeMatchesPort(portRangeRoute, 8000)).toBeTrue(); // Lower bound expect(routeMatchesPort(portRangeRoute, 8500)).toBeTrue();
expect(routeMatchesPort(portRangeRoute, 8500)).toBeTrue(); // Middle expect(routeMatchesPort(portRangeRoute, 9000)).toBeTrue();
expect(routeMatchesPort(portRangeRoute, 9000)).toBeTrue(); // Upper bound
expect(routeMatchesPort(portRangeRoute, 7999)).toBeFalse();
// Test with ports outside the range expect(routeMatchesPort(portRangeRoute, 9001)).toBeFalse();
expect(routeMatchesPort(portRangeRoute, 7999)).toBeFalse(); // Just below
expect(routeMatchesPort(portRangeRoute, 9001)).toBeFalse(); // Just above
// Test with multiple port ranges
const multiRangeRoute: IRouteConfig = { const multiRangeRoute: IRouteConfig = {
match: { match: {
domains: 'example.com', domains: 'example.com',
@@ -411,7 +441,7 @@ tap.test('Edge Case - Port Range Matching', async () => {
}, },
name: 'Multi Range Route' name: 'Multi Range Route'
}; };
expect(routeMatchesPort(multiRangeRoute, 85)).toBeTrue(); expect(routeMatchesPort(multiRangeRoute, 85)).toBeTrue();
expect(routeMatchesPort(multiRangeRoute, 8500)).toBeTrue(); expect(routeMatchesPort(multiRangeRoute, 8500)).toBeTrue();
expect(routeMatchesPort(multiRangeRoute, 100)).toBeFalse(); expect(routeMatchesPort(multiRangeRoute, 100)).toBeFalse();
@@ -420,55 +450,56 @@ tap.test('Edge Case - Port Range Matching', async () => {
// --------------------------------- Wildcard Domain Tests --------------------------------- // --------------------------------- Wildcard Domain Tests ---------------------------------
tap.test('Wildcard Domain Handling', async () => { tap.test('Wildcard Domain Handling', async () => {
// Create routes with different wildcard patterns const simpleDomainRoute: IRouteConfig = {
const simpleDomainRoute = createHttpRoute('example.com', { host: 'server1', port: 3000 }); match: { ports: 80, domains: 'example.com' },
const wildcardSubdomainRoute = createHttpRoute('*.example.com', { host: 'server2', port: 3001 }); action: { type: 'forward', targets: [{ host: 'server1', port: 3000 }] },
const specificSubdomainRoute = createHttpRoute('api.example.com', { host: 'server3', port: 3002 }); name: 'HTTP Route for example.com'
};
const wildcardSubdomainRoute: IRouteConfig = {
match: { ports: 80, domains: '*.example.com' },
action: { type: 'forward', targets: [{ host: 'server2', port: 3001 }] },
name: 'HTTP Route for *.example.com'
};
const specificSubdomainRoute: IRouteConfig = {
match: { ports: 80, domains: 'api.example.com' },
action: { type: 'forward', targets: [{ host: 'server3', port: 3002 }] },
name: 'HTTP Route for api.example.com'
};
// Set explicit priorities to ensure deterministic matching specificSubdomainRoute.priority = 200;
specificSubdomainRoute.priority = 200; // Highest priority for specific domain wildcardSubdomainRoute.priority = 100;
wildcardSubdomainRoute.priority = 100; // Medium priority for wildcard simpleDomainRoute.priority = 50;
simpleDomainRoute.priority = 50; // Lowest priority for generic domain
const routes = [simpleDomainRoute, wildcardSubdomainRoute, specificSubdomainRoute]; const routes = [simpleDomainRoute, wildcardSubdomainRoute, specificSubdomainRoute];
// Test exact domain match
expect(routeMatchesDomain(simpleDomainRoute, 'example.com')).toBeTrue(); expect(routeMatchesDomain(simpleDomainRoute, 'example.com')).toBeTrue();
expect(routeMatchesDomain(simpleDomainRoute, 'sub.example.com')).toBeFalse(); expect(routeMatchesDomain(simpleDomainRoute, 'sub.example.com')).toBeFalse();
// Test wildcard subdomain match
expect(routeMatchesDomain(wildcardSubdomainRoute, 'any.example.com')).toBeTrue(); expect(routeMatchesDomain(wildcardSubdomainRoute, 'any.example.com')).toBeTrue();
expect(routeMatchesDomain(wildcardSubdomainRoute, 'nested.sub.example.com')).toBeTrue(); expect(routeMatchesDomain(wildcardSubdomainRoute, 'nested.sub.example.com')).toBeTrue();
expect(routeMatchesDomain(wildcardSubdomainRoute, 'example.com')).toBeFalse(); expect(routeMatchesDomain(wildcardSubdomainRoute, 'example.com')).toBeFalse();
// Test specific subdomain match
expect(routeMatchesDomain(specificSubdomainRoute, 'api.example.com')).toBeTrue(); expect(routeMatchesDomain(specificSubdomainRoute, 'api.example.com')).toBeTrue();
expect(routeMatchesDomain(specificSubdomainRoute, 'other.example.com')).toBeFalse(); expect(routeMatchesDomain(specificSubdomainRoute, 'other.example.com')).toBeFalse();
expect(routeMatchesDomain(specificSubdomainRoute, 'sub.api.example.com')).toBeFalse(); expect(routeMatchesDomain(specificSubdomainRoute, 'sub.api.example.com')).toBeFalse();
// Test finding best match when multiple domains match
const specificSubdomainRequest = { domain: 'api.example.com', port: 80 }; const specificSubdomainRequest = { domain: 'api.example.com', port: 80 };
const bestSpecificMatch = findBestMatchingRoute(routes, specificSubdomainRequest); const bestSpecificMatch = findBestMatchingRoute(routes, specificSubdomainRequest);
expect(bestSpecificMatch).not.toBeUndefined(); expect(bestSpecificMatch).not.toBeUndefined();
if (bestSpecificMatch) { if (bestSpecificMatch) {
// Find which route was matched
const matchedPort = bestSpecificMatch.action.targets[0].port; const matchedPort = bestSpecificMatch.action.targets[0].port;
console.log(`Matched route with port: ${matchedPort}`); console.log(`Matched route with port: ${matchedPort}`);
// Verify it's the specific subdomain route (with highest priority)
expect(bestSpecificMatch.priority).toEqual(200); expect(bestSpecificMatch.priority).toEqual(200);
} }
// Test with a subdomain that matches wildcard but not specific
const otherSubdomainRequest = { domain: 'other.example.com', port: 80 }; const otherSubdomainRequest = { domain: 'other.example.com', port: 80 };
const bestWildcardMatch = findBestMatchingRoute(routes, otherSubdomainRequest); const bestWildcardMatch = findBestMatchingRoute(routes, otherSubdomainRequest);
expect(bestWildcardMatch).not.toBeUndefined(); expect(bestWildcardMatch).not.toBeUndefined();
if (bestWildcardMatch) { if (bestWildcardMatch) {
// Find which route was matched
const matchedPort = bestWildcardMatch.action.targets[0].port; const matchedPort = bestWildcardMatch.action.targets[0].port;
console.log(`Matched route with port: ${matchedPort}`); console.log(`Matched route with port: ${matchedPort}`);
// Verify it's the wildcard subdomain route (with medium priority)
expect(bestWildcardMatch.priority).toEqual(100); expect(bestWildcardMatch.priority).toEqual(100);
} }
}); });
@@ -476,56 +507,83 @@ tap.test('Wildcard Domain Handling', async () => {
// --------------------------------- Integration Tests --------------------------------- // --------------------------------- Integration Tests ---------------------------------
tap.test('Route Integration - Combining Multiple Route Types', async () => { tap.test('Route Integration - Combining Multiple Route Types', async () => {
// Create a comprehensive set of routes for a full application
const routes: IRouteConfig[] = [ const routes: IRouteConfig[] = [
// Main website with HTTPS and HTTP redirect {
...createCompleteHttpsServer('example.com', { host: 'web-server', port: 8080 }, { match: { ports: 443, domains: 'example.com' },
certificate: 'auto' action: {
}), type: 'forward',
targets: [{ host: 'web-server', port: 8080 }],
// API endpoints tls: { mode: 'terminate', certificate: 'auto' }
createApiRoute('api.example.com', '/v1', { host: 'api-server', port: 3000 }, { },
useTls: true, name: 'HTTPS Terminate Route for example.com'
certificate: 'auto', },
addCorsHeaders: true {
}), match: { ports: 80, domains: 'example.com' },
action: {
// WebSocket for real-time updates type: 'socket-handler',
createWebSocketRoute('ws.example.com', '/live', { host: 'websocket-server', port: 5000 }, { socketHandler: SocketHandlers.httpRedirect('https://{domain}:443{path}', 301)
useTls: true, },
certificate: 'auto' name: 'HTTP to HTTPS Redirect for example.com'
}), },
{
match: { ports: 443, domains: 'api.example.com', path: '/v1/*' },
// Legacy system with passthrough action: {
createHttpsPassthroughRoute('legacy.example.com', { host: 'legacy-server', port: 443 }) type: 'forward',
targets: [{ host: 'api-server', port: 3000 }],
tls: { mode: 'terminate', certificate: 'auto' }
},
headers: {
response: {
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type, Authorization',
'Access-Control-Max-Age': '86400'
}
},
priority: 100,
name: 'API Route for api.example.com'
},
{
match: { ports: 443, domains: 'ws.example.com', path: '/live' },
action: {
type: 'forward',
targets: [{ host: 'websocket-server', port: 5000 }],
tls: { mode: 'terminate', certificate: 'auto' },
websocket: { enabled: true }
},
priority: 100,
name: 'WebSocket Route for ws.example.com'
},
{
match: { ports: 443, domains: 'legacy.example.com' },
action: {
type: 'forward',
targets: [{ host: 'legacy-server', port: 443 }],
tls: { mode: 'passthrough' }
},
name: 'HTTPS Passthrough Route for legacy.example.com'
}
]; ];
// Validate all routes
const validationResult = validateRoutes(routes); const validationResult = validateRoutes(routes);
expect(validationResult.valid).toBeTrue(); expect(validationResult.valid).toBeTrue();
expect(validationResult.errors.length).toEqual(0); expect(validationResult.errors.length).toEqual(0);
// Test route matching for different endpoints
// Web server (HTTPS)
const webServerMatch = findBestMatchingRoute(routes, { domain: 'example.com', port: 443 }); const webServerMatch = findBestMatchingRoute(routes, { domain: 'example.com', port: 443 });
expect(webServerMatch).not.toBeUndefined(); expect(webServerMatch).not.toBeUndefined();
if (webServerMatch) { if (webServerMatch) {
expect(webServerMatch.action.type).toEqual('forward'); expect(webServerMatch.action.type).toEqual('forward');
expect(webServerMatch.action.targets[0].host).toEqual('web-server'); expect(webServerMatch.action.targets[0].host).toEqual('web-server');
} }
// Web server (HTTP redirect via socket handler)
const webRedirectMatch = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 }); const webRedirectMatch = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 });
expect(webRedirectMatch).not.toBeUndefined(); expect(webRedirectMatch).not.toBeUndefined();
if (webRedirectMatch) { if (webRedirectMatch) {
expect(webRedirectMatch.action.type).toEqual('socket-handler'); expect(webRedirectMatch.action.type).toEqual('socket-handler');
} }
// API server const apiMatch = findBestMatchingRoute(routes, {
const apiMatch = findBestMatchingRoute(routes, { domain: 'api.example.com',
domain: 'api.example.com',
port: 443, port: 443,
path: '/v1/users' path: '/v1/users'
}); });
@@ -534,10 +592,9 @@ tap.test('Route Integration - Combining Multiple Route Types', async () => {
expect(apiMatch.action.type).toEqual('forward'); expect(apiMatch.action.type).toEqual('forward');
expect(apiMatch.action.targets[0].host).toEqual('api-server'); expect(apiMatch.action.targets[0].host).toEqual('api-server');
} }
// WebSocket server const wsMatch = findBestMatchingRoute(routes, {
const wsMatch = findBestMatchingRoute(routes, { domain: 'ws.example.com',
domain: 'ws.example.com',
port: 443, port: 443,
path: '/live' path: '/live'
}); });
@@ -547,12 +604,9 @@ tap.test('Route Integration - Combining Multiple Route Types', async () => {
expect(wsMatch.action.targets[0].host).toEqual('websocket-server'); expect(wsMatch.action.targets[0].host).toEqual('websocket-server');
expect(wsMatch.action.websocket?.enabled).toBeTrue(); expect(wsMatch.action.websocket?.enabled).toBeTrue();
} }
// Static assets route was removed - static file serving should be handled externally const legacyMatch = findBestMatchingRoute(routes, {
domain: 'legacy.example.com',
// Legacy system
const legacyMatch = findBestMatchingRoute(routes, {
domain: 'legacy.example.com',
port: 443 port: 443
}); });
expect(legacyMatch).not.toBeUndefined(); expect(legacyMatch).not.toBeUndefined();
@@ -565,7 +619,6 @@ tap.test('Route Integration - Combining Multiple Route Types', async () => {
// --------------------------------- Protocol Match Field Tests --------------------------------- // --------------------------------- Protocol Match Field Tests ---------------------------------
tap.test('Routes: Should accept protocol field on route match', async () => { tap.test('Routes: Should accept protocol field on route match', async () => {
// Create a route with protocol: 'http'
const httpOnlyRoute: IRouteConfig = { const httpOnlyRoute: IRouteConfig = {
match: { match: {
ports: 443, ports: 443,
@@ -583,16 +636,13 @@ tap.test('Routes: Should accept protocol field on route match', async () => {
name: 'HTTP-only Route', name: 'HTTP-only Route',
}; };
// Validate the route - protocol field should not cause errors
const validation = validateRouteConfig(httpOnlyRoute); const validation = validateRouteConfig(httpOnlyRoute);
expect(validation.valid).toBeTrue(); expect(validation.valid).toBeTrue();
// Verify the protocol field is preserved
expect(httpOnlyRoute.match.protocol).toEqual('http'); expect(httpOnlyRoute.match.protocol).toEqual('http');
}); });
tap.test('Routes: Should accept protocol tcp on route match', async () => { tap.test('Routes: Should accept protocol tcp on route match', async () => {
// Create a route with protocol: 'tcp'
const tcpOnlyRoute: IRouteConfig = { const tcpOnlyRoute: IRouteConfig = {
match: { match: {
ports: 443, ports: 443,
@@ -616,28 +666,26 @@ tap.test('Routes: Should accept protocol tcp on route match', async () => {
}); });
tap.test('Routes: Protocol field should work with terminate-and-reencrypt', async () => { tap.test('Routes: Protocol field should work with terminate-and-reencrypt', async () => {
// Create a terminate-and-reencrypt route that only accepts HTTP const reencryptRoute: IRouteConfig = {
const reencryptRoute = createHttpsTerminateRoute( match: { ports: 443, domains: 'secure.example.com' },
'secure.example.com', action: {
{ host: 'backend', port: 443 }, type: 'forward',
{ reencrypt: true, certificate: 'auto', name: 'Reencrypt HTTP Route' } targets: [{ host: 'backend', port: 443 }],
); tls: { mode: 'terminate-and-reencrypt', certificate: 'auto' }
},
name: 'Reencrypt HTTP Route'
};
// Set protocol restriction to http
reencryptRoute.match.protocol = 'http'; reencryptRoute.match.protocol = 'http';
// Validate the route
const validation = validateRouteConfig(reencryptRoute); const validation = validateRouteConfig(reencryptRoute);
expect(validation.valid).toBeTrue(); expect(validation.valid).toBeTrue();
// Verify TLS mode
expect(reencryptRoute.action.tls?.mode).toEqual('terminate-and-reencrypt'); expect(reencryptRoute.action.tls?.mode).toEqual('terminate-and-reencrypt');
// Verify protocol field is preserved
expect(reencryptRoute.match.protocol).toEqual('http'); expect(reencryptRoute.match.protocol).toEqual('http');
}); });
tap.test('Routes: Protocol field should not affect domain/port matching', async () => { tap.test('Routes: Protocol field should not affect domain/port matching', async () => {
// Routes with and without protocol field should both match the same domain/port
const routeWithProtocol: IRouteConfig = { const routeWithProtocol: IRouteConfig = {
match: { match: {
ports: 443, ports: 443,
@@ -669,11 +717,9 @@ tap.test('Routes: Protocol field should not affect domain/port matching', async
const routes = [routeWithProtocol, routeWithoutProtocol]; const routes = [routeWithProtocol, routeWithoutProtocol];
// Both routes should match the domain/port (protocol is a hint for Rust-side matching)
const matches = findMatchingRoutes(routes, { domain: 'example.com', port: 443 }); const matches = findMatchingRoutes(routes, { domain: 'example.com', port: 443 });
expect(matches.length).toEqual(2); expect(matches.length).toEqual(2);
// The one with higher priority should be first
const best = findBestMatchingRoute(routes, { domain: 'example.com', port: 443 }); const best = findBestMatchingRoute(routes, { domain: 'example.com', port: 443 });
expect(best).not.toBeUndefined(); expect(best).not.toBeUndefined();
expect(best!.name).toEqual('With Protocol'); expect(best!.name).toEqual('With Protocol');
@@ -696,11 +742,9 @@ tap.test('Routes: Protocol field preserved through route cloning', async () => {
const cloned = cloneRoute(original); const cloned = cloneRoute(original);
// Verify protocol is preserved in clone
expect(cloned.match.protocol).toEqual('http'); expect(cloned.match.protocol).toEqual('http');
expect(cloned.action.tls?.mode).toEqual('terminate-and-reencrypt'); expect(cloned.action.tls?.mode).toEqual('terminate-and-reencrypt');
// Modify clone should not affect original
cloned.match.protocol = 'tcp'; cloned.match.protocol = 'tcp';
expect(original.match.protocol).toEqual('http'); expect(original.match.protocol).toEqual('http');
}); });
@@ -720,10 +764,9 @@ tap.test('Routes: Protocol field preserved through route merging', async () => {
name: 'Merge Base', name: 'Merge Base',
}; };
// Merge with override that changes name but not protocol
const merged = mergeRouteConfigs(base, { name: 'Merged Route' }); const merged = mergeRouteConfigs(base, { name: 'Merged Route' });
expect(merged.match.protocol).toEqual('http'); expect(merged.match.protocol).toEqual('http');
expect(merged.name).toEqual('Merged Route'); expect(merged.name).toEqual('Merged Route');
}); });
export default tap.start(); export default tap.start();
+213 -468
View File
@@ -1,21 +1,7 @@
import { tap, expect } from '@git.zone/tstest/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as plugins from '../ts/plugins.js'; import * as plugins from '../ts/plugins.js';
// Import from individual modules to avoid naming conflicts
import { import {
// Route helpers
createHttpRoute,
createHttpsTerminateRoute,
createApiRoute,
createWebSocketRoute,
createHttpToHttpsRedirect,
createHttpsPassthroughRoute,
createCompleteHttpsServer,
createLoadBalancerRoute
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import {
// Route validators
validateRouteConfig, validateRouteConfig,
validateRoutes, validateRoutes,
isValidDomain, isValidDomain,
@@ -27,7 +13,6 @@ import {
} from '../ts/proxies/smart-proxy/utils/route-validator.js'; } from '../ts/proxies/smart-proxy/utils/route-validator.js';
import { import {
// Route utilities
mergeRouteConfigs, mergeRouteConfigs,
findMatchingRoutes, findMatchingRoutes,
findBestMatchingRoute, findBestMatchingRoute,
@@ -39,16 +24,6 @@ import {
cloneRoute cloneRoute
} from '../ts/proxies/smart-proxy/utils/route-utils.js'; } from '../ts/proxies/smart-proxy/utils/route-utils.js';
import {
// Route patterns
createApiGatewayRoute,
createWebSocketRoute as createWebSocketPattern,
createLoadBalancerRoute as createLbPattern,
addRateLimiting,
addBasicAuth,
addJwtAuth
} from '../ts/proxies/smart-proxy/utils/route-helpers.js';
import type { import type {
IRouteConfig, IRouteConfig,
IRouteMatch, IRouteMatch,
@@ -84,7 +59,7 @@ tap.test('Route Validation - isValidPort', async () => {
expect(isValidPort(443)).toBeTrue(); expect(isValidPort(443)).toBeTrue();
expect(isValidPort(8080)).toBeTrue(); expect(isValidPort(8080)).toBeTrue();
expect(isValidPort([80, 443])).toBeTrue(); expect(isValidPort([80, 443])).toBeTrue();
// Invalid ports // Invalid ports
expect(isValidPort(0)).toBeFalse(); expect(isValidPort(0)).toBeFalse();
expect(isValidPort(65536)).toBeFalse(); expect(isValidPort(65536)).toBeFalse();
@@ -101,7 +76,7 @@ tap.test('Route Validation - validateRouteMatch', async () => {
const validResult = validateRouteMatch(validMatch); const validResult = validateRouteMatch(validMatch);
expect(validResult.valid).toBeTrue(); expect(validResult.valid).toBeTrue();
expect(validResult.errors.length).toEqual(0); expect(validResult.errors.length).toEqual(0);
// Invalid match configuration (invalid domain) // Invalid match configuration (invalid domain)
const invalidMatch: IRouteMatch = { const invalidMatch: IRouteMatch = {
ports: 80, ports: 80,
@@ -111,7 +86,7 @@ tap.test('Route Validation - validateRouteMatch', async () => {
expect(invalidResult.valid).toBeFalse(); expect(invalidResult.valid).toBeFalse();
expect(invalidResult.errors.length).toBeGreaterThan(0); expect(invalidResult.errors.length).toBeGreaterThan(0);
expect(invalidResult.errors[0]).toInclude('Invalid domain'); expect(invalidResult.errors[0]).toInclude('Invalid domain');
// Invalid match configuration (invalid port) // Invalid match configuration (invalid port)
const invalidPortMatch: IRouteMatch = { const invalidPortMatch: IRouteMatch = {
ports: 0, ports: 0,
@@ -121,7 +96,7 @@ tap.test('Route Validation - validateRouteMatch', async () => {
expect(invalidPortResult.valid).toBeFalse(); expect(invalidPortResult.valid).toBeFalse();
expect(invalidPortResult.errors.length).toBeGreaterThan(0); expect(invalidPortResult.errors.length).toBeGreaterThan(0);
expect(invalidPortResult.errors[0]).toInclude('Invalid port'); expect(invalidPortResult.errors[0]).toInclude('Invalid port');
// Test path validation // Test path validation
const invalidPathMatch: IRouteMatch = { const invalidPathMatch: IRouteMatch = {
ports: 80, ports: 80,
@@ -146,7 +121,7 @@ tap.test('Route Validation - validateRouteAction', async () => {
const validForwardResult = validateRouteAction(validForwardAction); const validForwardResult = validateRouteAction(validForwardAction);
expect(validForwardResult.valid).toBeTrue(); expect(validForwardResult.valid).toBeTrue();
expect(validForwardResult.errors.length).toEqual(0); expect(validForwardResult.errors.length).toEqual(0);
// Valid socket-handler action // Valid socket-handler action
const validSocketAction: IRouteAction = { const validSocketAction: IRouteAction = {
type: 'socket-handler', type: 'socket-handler',
@@ -157,7 +132,7 @@ tap.test('Route Validation - validateRouteAction', async () => {
const validSocketResult = validateRouteAction(validSocketAction); const validSocketResult = validateRouteAction(validSocketAction);
expect(validSocketResult.valid).toBeTrue(); expect(validSocketResult.valid).toBeTrue();
expect(validSocketResult.errors.length).toEqual(0); expect(validSocketResult.errors.length).toEqual(0);
// Invalid action (missing targets) // Invalid action (missing targets)
const invalidAction: IRouteAction = { const invalidAction: IRouteAction = {
type: 'forward' type: 'forward'
@@ -166,7 +141,7 @@ tap.test('Route Validation - validateRouteAction', async () => {
expect(invalidResult.valid).toBeFalse(); expect(invalidResult.valid).toBeFalse();
expect(invalidResult.errors.length).toBeGreaterThan(0); expect(invalidResult.errors.length).toBeGreaterThan(0);
expect(invalidResult.errors[0]).toInclude('Targets array is required'); expect(invalidResult.errors[0]).toInclude('Targets array is required');
// Invalid action (missing socket handler) // Invalid action (missing socket handler)
const invalidSocketAction: IRouteAction = { const invalidSocketAction: IRouteAction = {
type: 'socket-handler' type: 'socket-handler'
@@ -179,11 +154,15 @@ tap.test('Route Validation - validateRouteAction', async () => {
tap.test('Route Validation - validateRouteConfig', async () => { tap.test('Route Validation - validateRouteConfig', async () => {
// Valid route config // Valid route config
const validRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const validRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
const validResult = validateRouteConfig(validRoute); const validResult = validateRouteConfig(validRoute);
expect(validResult.valid).toBeTrue(); expect(validResult.valid).toBeTrue();
expect(validResult.errors.length).toEqual(0); expect(validResult.errors.length).toEqual(0);
// Invalid route config (missing targets) // Invalid route config (missing targets)
const invalidRoute: IRouteConfig = { const invalidRoute: IRouteConfig = {
match: { match: {
@@ -203,7 +182,11 @@ tap.test('Route Validation - validateRouteConfig', async () => {
tap.test('Route Validation - validateRoutes', async () => { tap.test('Route Validation - validateRoutes', async () => {
// Create valid and invalid routes // Create valid and invalid routes
const routes = [ const routes = [
createHttpRoute('example.com', { host: 'localhost', port: 3000 }), {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
} as IRouteConfig,
{ {
match: { match: {
domains: 'invalid..domain', domains: 'invalid..domain',
@@ -217,9 +200,13 @@ tap.test('Route Validation - validateRoutes', async () => {
} }
} }
} as IRouteConfig, } as IRouteConfig,
createHttpsTerminateRoute('secure.example.com', { host: 'localhost', port: 3001 }) {
match: { ports: 443, domains: 'secure.example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3001 }], tls: { mode: 'terminate', certificate: 'auto' } },
name: 'HTTPS Terminate Route for secure.example.com',
} as IRouteConfig
]; ];
const result = validateRoutes(routes); const result = validateRoutes(routes);
expect(result.valid).toBeFalse(); expect(result.valid).toBeFalse();
expect(result.errors.length).toEqual(1); expect(result.errors.length).toEqual(1);
@@ -230,13 +217,13 @@ tap.test('Route Validation - validateRoutes', async () => {
tap.test('Route Validation - hasRequiredPropertiesForAction', async () => { tap.test('Route Validation - hasRequiredPropertiesForAction', async () => {
// Forward action // Forward action
const forwardRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const forwardRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
expect(hasRequiredPropertiesForAction(forwardRoute, 'forward')).toBeTrue(); expect(hasRequiredPropertiesForAction(forwardRoute, 'forward')).toBeTrue();
// Socket handler action (redirect functionality)
const redirectRoute = createHttpToHttpsRedirect('example.com');
expect(hasRequiredPropertiesForAction(redirectRoute, 'socket-handler')).toBeTrue();
// Socket handler action // Socket handler action
const socketRoute: IRouteConfig = { const socketRoute: IRouteConfig = {
match: { match: {
@@ -252,7 +239,7 @@ tap.test('Route Validation - hasRequiredPropertiesForAction', async () => {
name: 'Socket Handler Route' name: 'Socket Handler Route'
}; };
expect(hasRequiredPropertiesForAction(socketRoute, 'socket-handler')).toBeTrue(); expect(hasRequiredPropertiesForAction(socketRoute, 'socket-handler')).toBeTrue();
// Missing required properties // Missing required properties
const invalidForwardRoute: IRouteConfig = { const invalidForwardRoute: IRouteConfig = {
match: { match: {
@@ -269,9 +256,13 @@ tap.test('Route Validation - hasRequiredPropertiesForAction', async () => {
tap.test('Route Validation - assertValidRoute', async () => { tap.test('Route Validation - assertValidRoute', async () => {
// Valid route // Valid route
const validRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const validRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
expect(() => assertValidRoute(validRoute)).not.toThrow(); expect(() => assertValidRoute(validRoute)).not.toThrow();
// Invalid route // Invalid route
const invalidRoute: IRouteConfig = { const invalidRoute: IRouteConfig = {
match: { match: {
@@ -290,8 +281,12 @@ tap.test('Route Validation - assertValidRoute', async () => {
tap.test('Route Utilities - mergeRouteConfigs', async () => { tap.test('Route Utilities - mergeRouteConfigs', async () => {
// Base route // Base route
const baseRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const baseRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
// Override with different name and port // Override with different name and port
const overrideRoute: Partial<IRouteConfig> = { const overrideRoute: Partial<IRouteConfig> = {
name: 'Merged Route', name: 'Merged Route',
@@ -299,16 +294,16 @@ tap.test('Route Utilities - mergeRouteConfigs', async () => {
ports: 8080 ports: 8080
} }
}; };
// Merge configs // Merge configs
const mergedRoute = mergeRouteConfigs(baseRoute, overrideRoute); const mergedRoute = mergeRouteConfigs(baseRoute, overrideRoute);
// Check merged properties // Check merged properties
expect(mergedRoute.name).toEqual('Merged Route'); expect(mergedRoute.name).toEqual('Merged Route');
expect(mergedRoute.match.ports).toEqual(8080); expect(mergedRoute.match.ports).toEqual(8080);
expect(mergedRoute.match.domains).toEqual('example.com'); expect(mergedRoute.match.domains).toEqual('example.com');
expect(mergedRoute.action.type).toEqual('forward'); expect(mergedRoute.action.type).toEqual('forward');
// Test merging action properties // Test merging action properties
const actionOverride: Partial<IRouteConfig> = { const actionOverride: Partial<IRouteConfig> = {
action: { action: {
@@ -319,11 +314,11 @@ tap.test('Route Utilities - mergeRouteConfigs', async () => {
}] }]
} }
}; };
const actionMergedRoute = mergeRouteConfigs(baseRoute, actionOverride); const actionMergedRoute = mergeRouteConfigs(baseRoute, actionOverride);
expect(actionMergedRoute.action.targets?.[0]?.host).toEqual('new-host.local'); expect(actionMergedRoute.action.targets?.[0]?.host).toEqual('new-host.local');
expect(actionMergedRoute.action.targets?.[0]?.port).toEqual(5000); expect(actionMergedRoute.action.targets?.[0]?.port).toEqual(5000);
// Test replacing action with socket handler // Test replacing action with socket handler
const typeChangeOverride: Partial<IRouteConfig> = { const typeChangeOverride: Partial<IRouteConfig> = {
action: { action: {
@@ -336,7 +331,7 @@ tap.test('Route Utilities - mergeRouteConfigs', async () => {
} }
} }
}; };
const typeChangedRoute = mergeRouteConfigs(baseRoute, typeChangeOverride); const typeChangedRoute = mergeRouteConfigs(baseRoute, typeChangeOverride);
expect(typeChangedRoute.action.type).toEqual('socket-handler'); expect(typeChangedRoute.action.type).toEqual('socket-handler');
expect(typeChangedRoute.action.socketHandler).toBeDefined(); expect(typeChangedRoute.action.socketHandler).toBeDefined();
@@ -345,37 +340,53 @@ tap.test('Route Utilities - mergeRouteConfigs', async () => {
tap.test('Route Matching - routeMatchesDomain', async () => { tap.test('Route Matching - routeMatchesDomain', async () => {
// Create route with wildcard domain // Create route with wildcard domain
const wildcardRoute = createHttpRoute('*.example.com', { host: 'localhost', port: 3000 }); const wildcardRoute: IRouteConfig = {
match: { ports: 80, domains: '*.example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for *.example.com',
};
// Create route with exact domain // Create route with exact domain
const exactRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const exactRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
// Create route with multiple domains // Create route with multiple domains
const multiDomainRoute = createHttpRoute(['example.com', 'example.org'], { host: 'localhost', port: 3000 }); const multiDomainRoute: IRouteConfig = {
match: { ports: 80, domains: ['example.com', 'example.org'] },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com,example.org',
};
// Test wildcard domain matching // Test wildcard domain matching
expect(routeMatchesDomain(wildcardRoute, 'sub.example.com')).toBeTrue(); expect(routeMatchesDomain(wildcardRoute, 'sub.example.com')).toBeTrue();
expect(routeMatchesDomain(wildcardRoute, 'another.example.com')).toBeTrue(); expect(routeMatchesDomain(wildcardRoute, 'another.example.com')).toBeTrue();
expect(routeMatchesDomain(wildcardRoute, 'example.com')).toBeFalse(); expect(routeMatchesDomain(wildcardRoute, 'example.com')).toBeFalse();
expect(routeMatchesDomain(wildcardRoute, 'example.org')).toBeFalse(); expect(routeMatchesDomain(wildcardRoute, 'example.org')).toBeFalse();
// Test exact domain matching // Test exact domain matching
expect(routeMatchesDomain(exactRoute, 'example.com')).toBeTrue(); expect(routeMatchesDomain(exactRoute, 'example.com')).toBeTrue();
expect(routeMatchesDomain(exactRoute, 'sub.example.com')).toBeFalse(); expect(routeMatchesDomain(exactRoute, 'sub.example.com')).toBeFalse();
// Test multiple domains matching // Test multiple domains matching
expect(routeMatchesDomain(multiDomainRoute, 'example.com')).toBeTrue(); expect(routeMatchesDomain(multiDomainRoute, 'example.com')).toBeTrue();
expect(routeMatchesDomain(multiDomainRoute, 'example.org')).toBeTrue(); expect(routeMatchesDomain(multiDomainRoute, 'example.org')).toBeTrue();
expect(routeMatchesDomain(multiDomainRoute, 'example.net')).toBeFalse(); expect(routeMatchesDomain(multiDomainRoute, 'example.net')).toBeFalse();
// Test case insensitivity // Test case insensitivity
expect(routeMatchesDomain(exactRoute, 'Example.Com')).toBeTrue(); expect(routeMatchesDomain(exactRoute, 'Example.Com')).toBeTrue();
}); });
tap.test('Route Matching - routeMatchesPort', async () => { tap.test('Route Matching - routeMatchesPort', async () => {
// Create routes with different port configurations // Create routes with different port configurations
const singlePortRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const singlePortRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
const multiPortRoute: IRouteConfig = { const multiPortRoute: IRouteConfig = {
match: { match: {
domains: 'example.com', domains: 'example.com',
@@ -389,7 +400,7 @@ tap.test('Route Matching - routeMatchesPort', async () => {
}] }]
} }
}; };
const portRangeRoute: IRouteConfig = { const portRangeRoute: IRouteConfig = {
match: { match: {
domains: 'example.com', domains: 'example.com',
@@ -403,16 +414,16 @@ tap.test('Route Matching - routeMatchesPort', async () => {
}] }]
} }
}; };
// Test single port matching // Test single port matching
expect(routeMatchesPort(singlePortRoute, 80)).toBeTrue(); expect(routeMatchesPort(singlePortRoute, 80)).toBeTrue();
expect(routeMatchesPort(singlePortRoute, 443)).toBeFalse(); expect(routeMatchesPort(singlePortRoute, 443)).toBeFalse();
// Test multi-port matching // Test multi-port matching
expect(routeMatchesPort(multiPortRoute, 80)).toBeTrue(); expect(routeMatchesPort(multiPortRoute, 80)).toBeTrue();
expect(routeMatchesPort(multiPortRoute, 8080)).toBeTrue(); expect(routeMatchesPort(multiPortRoute, 8080)).toBeTrue();
expect(routeMatchesPort(multiPortRoute, 3000)).toBeFalse(); expect(routeMatchesPort(multiPortRoute, 3000)).toBeFalse();
// Test port range matching // Test port range matching
expect(routeMatchesPort(portRangeRoute, 8000)).toBeTrue(); expect(routeMatchesPort(portRangeRoute, 8000)).toBeTrue();
expect(routeMatchesPort(portRangeRoute, 8500)).toBeTrue(); expect(routeMatchesPort(portRangeRoute, 8500)).toBeTrue();
@@ -437,11 +448,11 @@ tap.test('Route Matching - routeMatchesPath', async () => {
}] }]
} }
}; };
// Test prefix matching with wildcard (not trailing slash) // Test prefix matching with wildcard (not trailing slash)
const prefixPathRoute: IRouteConfig = { const prefixPathRoute: IRouteConfig = {
match: { match: {
domains: 'example.com', domains: 'example.com',
ports: 80, ports: 80,
path: '/api/*' path: '/api/*'
}, },
@@ -453,7 +464,7 @@ tap.test('Route Matching - routeMatchesPath', async () => {
}] }]
} }
}; };
const wildcardPathRoute: IRouteConfig = { const wildcardPathRoute: IRouteConfig = {
match: { match: {
domains: 'example.com', domains: 'example.com',
@@ -468,17 +479,17 @@ tap.test('Route Matching - routeMatchesPath', async () => {
}] }]
} }
}; };
// Test exact path matching // Test exact path matching
expect(routeMatchesPath(exactPathRoute, '/api')).toBeTrue(); expect(routeMatchesPath(exactPathRoute, '/api')).toBeTrue();
expect(routeMatchesPath(exactPathRoute, '/api/users')).toBeFalse(); expect(routeMatchesPath(exactPathRoute, '/api/users')).toBeFalse();
expect(routeMatchesPath(exactPathRoute, '/app')).toBeFalse(); expect(routeMatchesPath(exactPathRoute, '/app')).toBeFalse();
// Test prefix path matching with wildcard // Test prefix path matching with wildcard
expect(routeMatchesPath(prefixPathRoute, '/api/')).toBeFalse(); // Wildcard requires content after /api/ expect(routeMatchesPath(prefixPathRoute, '/api/')).toBeFalse(); // Wildcard requires content after /api/
expect(routeMatchesPath(prefixPathRoute, '/api/users')).toBeTrue(); expect(routeMatchesPath(prefixPathRoute, '/api/users')).toBeTrue();
expect(routeMatchesPath(prefixPathRoute, '/app/')).toBeFalse(); expect(routeMatchesPath(prefixPathRoute, '/app/')).toBeFalse();
// Test wildcard path matching // Test wildcard path matching
expect(routeMatchesPath(wildcardPathRoute, '/api/users')).toBeTrue(); expect(routeMatchesPath(wildcardPathRoute, '/api/users')).toBeTrue();
expect(routeMatchesPath(wildcardPathRoute, '/api/products')).toBeTrue(); expect(routeMatchesPath(wildcardPathRoute, '/api/products')).toBeTrue();
@@ -504,30 +515,59 @@ tap.test('Route Matching - routeMatchesHeaders', async () => {
}] }]
} }
}; };
// Test header matching // Test header matching
expect(routeMatchesHeaders(headerRoute, { expect(routeMatchesHeaders(headerRoute, {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
'X-Custom-Header': 'value' 'X-Custom-Header': 'value'
})).toBeTrue(); })).toBeTrue();
expect(routeMatchesHeaders(headerRoute, { expect(routeMatchesHeaders(headerRoute, {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
'X-Custom-Header': 'value', 'X-Custom-Header': 'value',
'Extra-Header': 'something' 'Extra-Header': 'something'
})).toBeTrue(); })).toBeTrue();
expect(routeMatchesHeaders(headerRoute, { expect(routeMatchesHeaders(headerRoute, {
'Content-Type': 'application/json' 'Content-Type': 'application/json'
})).toBeFalse(); })).toBeFalse();
expect(routeMatchesHeaders(headerRoute, { expect(routeMatchesHeaders(headerRoute, {
'Content-Type': 'text/html', 'Content-Type': 'text/html',
'X-Custom-Header': 'value' 'X-Custom-Header': 'value'
})).toBeFalse(); })).toBeFalse();
const regexHeaderRoute: IRouteConfig = {
match: {
domains: 'example.com',
ports: 80,
headers: {
'Content-Type': /^application\/(json|problem\+json)$/i,
}
},
action: {
type: 'forward',
targets: [{
host: 'localhost',
port: 3000
}]
}
};
expect(routeMatchesHeaders(regexHeaderRoute, {
'Content-Type': 'Application/Problem+Json',
})).toBeTrue();
expect(routeMatchesHeaders(regexHeaderRoute, {
'Content-Type': 'text/html',
})).toBeFalse();
// Route without header matching should match any headers // Route without header matching should match any headers
const noHeaderRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const noHeaderRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
expect(routeMatchesHeaders(noHeaderRoute, { expect(routeMatchesHeaders(noHeaderRoute, {
'Content-Type': 'application/json' 'Content-Type': 'application/json'
})).toBeTrue(); })).toBeTrue();
@@ -536,78 +576,118 @@ tap.test('Route Matching - routeMatchesHeaders', async () => {
tap.test('Route Finding - findMatchingRoutes', async () => { tap.test('Route Finding - findMatchingRoutes', async () => {
// Create multiple routes // Create multiple routes
const routes: IRouteConfig[] = [ const routes: IRouteConfig[] = [
createHttpRoute('example.com', { host: 'localhost', port: 3000 }), {
createHttpsTerminateRoute('secure.example.com', { host: 'localhost', port: 3001 }), match: { ports: 80, domains: 'example.com' },
createApiRoute('api.example.com', '/v1', { host: 'localhost', port: 3002 }), action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
createWebSocketRoute('ws.example.com', '/socket', { host: 'localhost', port: 3003 }) name: 'HTTP Route for example.com',
},
{
match: { ports: 443, domains: 'secure.example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3001 }], tls: { mode: 'terminate', certificate: 'auto' } },
name: 'HTTPS Route for secure.example.com',
},
{
match: { ports: 443, domains: 'api.example.com', path: '/v1/*' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3002 }], tls: { mode: 'terminate', certificate: 'auto' } },
name: 'API Route for api.example.com',
},
{
match: { ports: 443, domains: 'ws.example.com', path: '/socket' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3003 }], tls: { mode: 'terminate', certificate: 'auto' }, websocket: { enabled: true } },
name: 'WebSocket Route for ws.example.com',
},
]; ];
// Set priorities // Set priorities
routes[0].priority = 10; routes[0].priority = 10;
routes[1].priority = 20; routes[1].priority = 20;
routes[2].priority = 30; routes[2].priority = 30;
routes[3].priority = 40; routes[3].priority = 40;
// Find routes for different criteria // Find routes for different criteria
const httpMatches = findMatchingRoutes(routes, { domain: 'example.com', port: 80 }); const httpMatches = findMatchingRoutes(routes, { domain: 'example.com', port: 80 });
expect(httpMatches.length).toEqual(1); expect(httpMatches.length).toEqual(1);
expect(httpMatches[0].name).toInclude('HTTP Route'); expect(httpMatches[0].name).toInclude('HTTP Route');
const httpsMatches = findMatchingRoutes(routes, { domain: 'secure.example.com', port: 443 }); const httpsMatches = findMatchingRoutes(routes, { domain: 'secure.example.com', port: 443 });
expect(httpsMatches.length).toEqual(1); expect(httpsMatches.length).toEqual(1);
expect(httpsMatches[0].name).toInclude('HTTPS Route'); expect(httpsMatches[0].name).toInclude('HTTPS Route');
const apiMatches = findMatchingRoutes(routes, { domain: 'api.example.com', path: '/v1/users' }); const apiMatches = findMatchingRoutes(routes, { domain: 'api.example.com', path: '/v1/users' });
expect(apiMatches.length).toEqual(1); expect(apiMatches.length).toEqual(1);
expect(apiMatches[0].name).toInclude('API Route'); expect(apiMatches[0].name).toInclude('API Route');
const wsMatches = findMatchingRoutes(routes, { domain: 'ws.example.com', path: '/socket' }); const wsMatches = findMatchingRoutes(routes, { domain: 'ws.example.com', path: '/socket' });
expect(wsMatches.length).toEqual(1); expect(wsMatches.length).toEqual(1);
expect(wsMatches[0].name).toInclude('WebSocket Route'); expect(wsMatches[0].name).toInclude('WebSocket Route');
// Test finding multiple routes that match same criteria // Test finding multiple routes that match same criteria
const route1 = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const route1: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
route1.priority = 10; route1.priority = 10;
const route2 = createHttpRoute('example.com', { host: 'localhost', port: 3001 }); const route2: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3001 }] },
name: 'HTTP Route for example.com',
};
route2.priority = 20; route2.priority = 20;
route2.match.path = '/api'; route2.match.path = '/api';
const multiMatchRoutes = [route1, route2]; const multiMatchRoutes = [route1, route2];
const multiMatches = findMatchingRoutes(multiMatchRoutes, { domain: 'example.com', port: 80 }); const multiMatches = findMatchingRoutes(multiMatchRoutes, { domain: 'example.com', port: 80 });
expect(multiMatches.length).toEqual(2); expect(multiMatches.length).toEqual(2);
expect(multiMatches[0].priority).toEqual(20); // Higher priority should be first expect(multiMatches[0].priority).toEqual(20); // Higher priority should be first
expect(multiMatches[1].priority).toEqual(10); expect(multiMatches[1].priority).toEqual(10);
// Test disabled routes // Test disabled routes
const disabledRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const disabledRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
disabledRoute.enabled = false; disabledRoute.enabled = false;
const enabledRoutes = findMatchingRoutes([disabledRoute], { domain: 'example.com', port: 80 }); const enabledRoutes = findMatchingRoutes([disabledRoute], { domain: 'example.com', port: 80 });
expect(enabledRoutes.length).toEqual(0); expect(enabledRoutes.length).toEqual(0);
}); });
tap.test('Route Finding - findBestMatchingRoute', async () => { tap.test('Route Finding - findBestMatchingRoute', async () => {
// Create multiple routes with different priorities // Create multiple routes with different priorities
const route1 = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const route1: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
route1.priority = 10; route1.priority = 10;
const route2 = createHttpRoute('example.com', { host: 'localhost', port: 3001 }); const route2: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3001 }] },
name: 'HTTP Route for example.com',
};
route2.priority = 20; route2.priority = 20;
route2.match.path = '/api'; route2.match.path = '/api';
const route3 = createHttpRoute('example.com', { host: 'localhost', port: 3002 }); const route3: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3002 }] },
name: 'HTTP Route for example.com',
};
route3.priority = 30; route3.priority = 30;
route3.match.path = '/api/users'; route3.match.path = '/api/users';
const routes = [route1, route2, route3]; const routes = [route1, route2, route3];
// Find best route for different criteria // Find best route for different criteria
const bestGeneral = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 }); const bestGeneral = findBestMatchingRoute(routes, { domain: 'example.com', port: 80 });
expect(bestGeneral).not.toBeUndefined(); expect(bestGeneral).not.toBeUndefined();
expect(bestGeneral?.priority).toEqual(30); expect(bestGeneral?.priority).toEqual(30);
// Test when no routes match // Test when no routes match
const noMatch = findBestMatchingRoute(routes, { domain: 'unknown.com', port: 80 }); const noMatch = findBestMatchingRoute(routes, { domain: 'unknown.com', port: 80 });
expect(noMatch).toBeUndefined(); expect(noMatch).toBeUndefined();
@@ -615,389 +695,54 @@ tap.test('Route Finding - findBestMatchingRoute', async () => {
tap.test('Route Utilities - generateRouteId', async () => { tap.test('Route Utilities - generateRouteId', async () => {
// Test ID generation for different route types // Test ID generation for different route types
const httpRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 }); const httpRoute: IRouteConfig = {
match: { ports: 80, domains: 'example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com',
};
const httpId = generateRouteId(httpRoute); const httpId = generateRouteId(httpRoute);
expect(httpId).toInclude('example-com'); expect(httpId).toInclude('example-com');
expect(httpId).toInclude('80'); expect(httpId).toInclude('80');
expect(httpId).toInclude('forward'); expect(httpId).toInclude('forward');
const httpsRoute = createHttpsTerminateRoute('secure.example.com', { host: 'localhost', port: 3001 }); const httpsRoute: IRouteConfig = {
match: { ports: 443, domains: 'secure.example.com' },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3001 }], tls: { mode: 'terminate', certificate: 'auto' } },
name: 'HTTPS Terminate Route for secure.example.com',
};
const httpsId = generateRouteId(httpsRoute); const httpsId = generateRouteId(httpsRoute);
expect(httpsId).toInclude('secure-example-com'); expect(httpsId).toInclude('secure-example-com');
expect(httpsId).toInclude('443'); expect(httpsId).toInclude('443');
expect(httpsId).toInclude('forward'); expect(httpsId).toInclude('forward');
const multiDomainRoute = createHttpRoute(['example.com', 'example.org'], { host: 'localhost', port: 3000 }); const multiDomainRoute: IRouteConfig = {
match: { ports: 80, domains: ['example.com', 'example.org'] },
action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }] },
name: 'HTTP Route for example.com,example.org',
};
const multiDomainId = generateRouteId(multiDomainRoute); const multiDomainId = generateRouteId(multiDomainRoute);
expect(multiDomainId).toInclude('example-com-example-org'); expect(multiDomainId).toInclude('example-com-example-org');
}); });
tap.test('Route Utilities - cloneRoute', async () => { tap.test('Route Utilities - cloneRoute', async () => {
// Create a route and clone it // Create a route and clone it
const originalRoute = createHttpsTerminateRoute('example.com', { host: 'localhost', port: 3000 }, { const originalRoute: IRouteConfig = {
certificate: 'auto', match: { ports: 443, domains: 'example.com' },
name: 'Original Route' action: { type: 'forward', targets: [{ host: 'localhost', port: 3000 }], tls: { mode: 'terminate', certificate: 'auto' } },
}); name: 'Original Route',
};
const clonedRoute = cloneRoute(originalRoute); const clonedRoute = cloneRoute(originalRoute);
// Check that the values are identical // Check that the values are identical
expect(clonedRoute.name).toEqual(originalRoute.name); expect(clonedRoute.name).toEqual(originalRoute.name);
expect(clonedRoute.match.domains).toEqual(originalRoute.match.domains); expect(clonedRoute.match.domains).toEqual(originalRoute.match.domains);
expect(clonedRoute.action.type).toEqual(originalRoute.action.type); expect(clonedRoute.action.type).toEqual(originalRoute.action.type);
expect(clonedRoute.action.targets?.[0]?.port).toEqual(originalRoute.action.targets?.[0]?.port); expect(clonedRoute.action.targets?.[0]?.port).toEqual(originalRoute.action.targets?.[0]?.port);
// Modify the clone and check that the original is unchanged // Modify the clone and check that the original is unchanged
clonedRoute.name = 'Modified Clone'; clonedRoute.name = 'Modified Clone';
expect(originalRoute.name).toEqual('Original Route'); expect(originalRoute.name).toEqual('Original Route');
}); });
// --------------------------------- Route Helper Tests --------------------------------- export default tap.start();
tap.test('Route Helpers - createHttpRoute', async () => {
const route = createHttpRoute('example.com', { host: 'localhost', port: 3000 });
expect(route.match.domains).toEqual('example.com');
expect(route.match.ports).toEqual(80);
expect(route.action.type).toEqual('forward');
expect(route.action.targets?.[0]?.host).toEqual('localhost');
expect(route.action.targets?.[0]?.port).toEqual(3000);
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
tap.test('Route Helpers - createHttpsTerminateRoute', async () => {
const route = createHttpsTerminateRoute('example.com', { host: 'localhost', port: 3000 }, {
certificate: 'auto'
});
expect(route.match.domains).toEqual('example.com');
expect(route.match.ports).toEqual(443);
expect(route.action.type).toEqual('forward');
expect(route.action.tls.mode).toEqual('terminate');
expect(route.action.tls.certificate).toEqual('auto');
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
tap.test('Route Helpers - createHttpToHttpsRedirect', async () => {
const route = createHttpToHttpsRedirect('example.com');
expect(route.match.domains).toEqual('example.com');
expect(route.match.ports).toEqual(80);
expect(route.action.type).toEqual('socket-handler');
expect(route.action.socketHandler).toBeDefined();
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
tap.test('Route Helpers - createHttpsPassthroughRoute', async () => {
const route = createHttpsPassthroughRoute('example.com', { host: 'localhost', port: 3000 });
expect(route.match.domains).toEqual('example.com');
expect(route.match.ports).toEqual(443);
expect(route.action.type).toEqual('forward');
expect(route.action.tls.mode).toEqual('passthrough');
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
tap.test('Route Helpers - createCompleteHttpsServer', async () => {
const routes = createCompleteHttpsServer('example.com', { host: 'localhost', port: 3000 }, {
certificate: 'auto'
});
expect(routes.length).toEqual(2);
// HTTPS route
expect(routes[0].match.domains).toEqual('example.com');
expect(routes[0].match.ports).toEqual(443);
expect(routes[0].action.type).toEqual('forward');
expect(routes[0].action.tls.mode).toEqual('terminate');
// HTTP redirect route
expect(routes[1].match.domains).toEqual('example.com');
expect(routes[1].match.ports).toEqual(80);
expect(routes[1].action.type).toEqual('socket-handler');
const validation1 = validateRouteConfig(routes[0]);
const validation2 = validateRouteConfig(routes[1]);
expect(validation1.valid).toBeTrue();
expect(validation2.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 }, {
useTls: true,
certificate: 'auto',
addCorsHeaders: true
});
expect(route.match.domains).toEqual('api.example.com');
expect(route.match.ports).toEqual(443);
expect(route.match.path).toEqual('/v1/*');
expect(route.action.type).toEqual('forward');
expect(route.action.tls.mode).toEqual('terminate');
// Check CORS headers if they exist
if (route.headers && route.headers.response) {
expect(route.headers.response['Access-Control-Allow-Origin']).toEqual('*');
}
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
tap.test('Route Helpers - createWebSocketRoute', async () => {
const route = createWebSocketRoute('ws.example.com', '/socket', { host: 'localhost', port: 3000 }, {
useTls: true,
certificate: 'auto',
pingInterval: 15000
});
expect(route.match.domains).toEqual('ws.example.com');
expect(route.match.ports).toEqual(443);
expect(route.match.path).toEqual('/socket');
expect(route.action.type).toEqual('forward');
expect(route.action.tls.mode).toEqual('terminate');
// Check websocket configuration if it exists
if (route.action.websocket) {
expect(route.action.websocket.enabled).toBeTrue();
expect(route.action.websocket.pingInterval).toEqual(15000);
}
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
tap.test('Route Helpers - createLoadBalancerRoute', async () => {
const route = createLoadBalancerRoute(
'loadbalancer.example.com',
['server1.local', 'server2.local', 'server3.local'],
8080,
{
tls: {
mode: 'terminate',
certificate: 'auto'
}
}
);
expect(route.match.domains).toEqual('loadbalancer.example.com');
expect(route.match.ports).toEqual(443);
expect(route.action.type).toEqual('forward');
expect(route.action.targets).toBeDefined();
if (route.action.targets && Array.isArray(route.action.targets[0]?.host)) {
expect((route.action.targets[0].host as string[]).length).toEqual(3);
}
expect(route.action.targets?.[0]?.port).toEqual(8080);
expect(route.action.tls.mode).toEqual('terminate');
const validationResult = validateRouteConfig(route);
expect(validationResult.valid).toBeTrue();
});
// --------------------------------- Route Pattern Tests ---------------------------------
tap.test('Route Patterns - createApiGatewayRoute', async () => {
// Create API Gateway route
const apiGatewayRoute = createApiGatewayRoute(
'api.example.com',
'/v1',
{ host: 'localhost', port: 3000 },
{
useTls: true,
addCorsHeaders: true
}
);
// Validate route configuration
expect(apiGatewayRoute.match.domains).toEqual('api.example.com');
expect(apiGatewayRoute.match.path).toInclude('/v1');
expect(apiGatewayRoute.action.type).toEqual('forward');
expect(apiGatewayRoute.action.targets?.[0]?.port).toEqual(3000);
// Check TLS configuration
if (apiGatewayRoute.action.tls) {
expect(apiGatewayRoute.action.tls.mode).toEqual('terminate');
}
// Check CORS headers
if (apiGatewayRoute.headers && apiGatewayRoute.headers.response) {
expect(apiGatewayRoute.headers.response['Access-Control-Allow-Origin']).toEqual('*');
}
const result = validateRouteConfig(apiGatewayRoute);
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
const wsRoute = createWebSocketPattern(
'ws.example.com',
{ host: 'localhost', port: 3000 },
{
useTls: true,
path: '/socket',
pingInterval: 10000
}
);
// Validate route configuration
expect(wsRoute.match.domains).toEqual('ws.example.com');
expect(wsRoute.match.path).toEqual('/socket');
expect(wsRoute.action.type).toEqual('forward');
expect(wsRoute.action.targets?.[0]?.port).toEqual(3000);
// Check TLS configuration
if (wsRoute.action.tls) {
expect(wsRoute.action.tls.mode).toEqual('terminate');
}
// Check websocket configuration if it exists
if (wsRoute.action.websocket) {
expect(wsRoute.action.websocket.enabled).toBeTrue();
expect(wsRoute.action.websocket.pingInterval).toEqual(10000);
}
const result = validateRouteConfig(wsRoute);
expect(result.valid).toBeTrue();
});
tap.test('Route Patterns - createLoadBalancerRoute pattern', async () => {
// Create load balancer route pattern with missing algorithm as it might not be implemented yet
try {
const lbRoute = createLbPattern(
'lb.example.com',
[
{ host: 'server1.local', port: 8080 },
{ host: 'server2.local', port: 8080 },
{ host: 'server3.local', port: 8080 }
],
{
useTls: true
}
);
// Validate route configuration
expect(lbRoute.match.domains).toEqual('lb.example.com');
expect(lbRoute.action.type).toEqual('forward');
// Check target hosts
if (lbRoute.action.targets && Array.isArray(lbRoute.action.targets[0]?.host)) {
expect((lbRoute.action.targets[0].host as string[]).length).toEqual(3);
}
// Check TLS configuration
if (lbRoute.action.tls) {
expect(lbRoute.action.tls.mode).toEqual('terminate');
}
const result = validateRouteConfig(lbRoute);
expect(result.valid).toBeTrue();
} catch (error) {
// If the pattern is not implemented yet, skip this test
console.log('Load balancer pattern might not be fully implemented yet');
}
});
tap.test('Route Security - addRateLimiting', async () => {
// Create base route
const baseRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 });
// Add rate limiting
const secureRoute = addRateLimiting(baseRoute, {
maxRequests: 100,
window: 60, // 1 minute
keyBy: 'ip'
});
// Check if rate limiting is applied
if (secureRoute.security) {
expect(secureRoute.security.rateLimit?.enabled).toBeTrue();
expect(secureRoute.security.rateLimit?.maxRequests).toEqual(100);
expect(secureRoute.security.rateLimit?.window).toEqual(60);
expect(secureRoute.security.rateLimit?.keyBy).toEqual('ip');
} else {
// Skip this test if security features are not implemented yet
console.log('Security features not implemented yet in route configuration');
}
// Just check that the route itself is valid
const result = validateRouteConfig(secureRoute);
expect(result.valid).toBeTrue();
});
tap.test('Route Security - addBasicAuth', async () => {
// Create base route
const baseRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 });
// Add basic authentication
const authRoute = addBasicAuth(baseRoute, {
users: [
{ username: 'admin', password: 'secret' },
{ username: 'user', password: 'password' }
],
realm: 'Protected Area',
excludePaths: ['/public']
});
// Check if basic auth is applied
if (authRoute.security) {
expect(authRoute.security.basicAuth?.enabled).toBeTrue();
expect(authRoute.security.basicAuth?.users.length).toEqual(2);
expect(authRoute.security.basicAuth?.realm).toEqual('Protected Area');
expect(authRoute.security.basicAuth?.excludePaths).toInclude('/public');
} else {
// Skip this test if security features are not implemented yet
console.log('Security features not implemented yet in route configuration');
}
// Check that the route itself is valid
const result = validateRouteConfig(authRoute);
expect(result.valid).toBeTrue();
});
tap.test('Route Security - addJwtAuth', async () => {
// Create base route
const baseRoute = createHttpRoute('example.com', { host: 'localhost', port: 3000 });
// Add JWT authentication
const jwtRoute = addJwtAuth(baseRoute, {
secret: 'your-jwt-secret-key',
algorithm: 'HS256',
issuer: 'auth.example.com',
audience: 'api.example.com',
expiresIn: 3600
});
// Check if JWT auth is applied
if (jwtRoute.security) {
expect(jwtRoute.security.jwtAuth?.enabled).toBeTrue();
expect(jwtRoute.security.jwtAuth?.secret).toEqual('your-jwt-secret-key');
expect(jwtRoute.security.jwtAuth?.algorithm).toEqual('HS256');
expect(jwtRoute.security.jwtAuth?.issuer).toEqual('auth.example.com');
expect(jwtRoute.security.jwtAuth?.audience).toEqual('api.example.com');
expect(jwtRoute.security.jwtAuth?.expiresIn).toEqual(3600);
} else {
// Skip this test if security features are not implemented yet
console.log('Security features not implemented yet in route configuration');
}
// Check that the route itself is valid
const result = validateRouteConfig(jwtRoute);
expect(result.valid).toBeTrue();
});
export default tap.start();
+192
View File
@@ -0,0 +1,192 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import type { ISmartProxyOptions } from '../ts/proxies/smart-proxy/models/interfaces.js';
import type { IRouteConfig } from '../ts/proxies/smart-proxy/models/route-types.js';
import { RoutePreprocessor } from '../ts/proxies/smart-proxy/route-preprocessor.js';
import { buildRustProxyOptions } from '../ts/proxies/smart-proxy/utils/rust-config.js';
tap.test('Rust contract - preprocessor serializes regex headers for Rust', async () => {
const route: IRouteConfig = {
name: 'contract-route',
match: {
ports: [443, { from: 8443, to: 8444 }],
domains: ['api.example.com', '*.example.com'],
transport: 'udp',
protocol: 'http3',
headers: {
'Content-Type': /^application\/json$/i,
},
},
action: {
type: 'forward',
targets: [{
match: {
ports: [443],
path: '/api/*',
method: ['GET'],
headers: {
'X-Env': /^(prod|stage)$/,
},
},
host: ['backend-a', 'backend-b'],
port: 'preserve',
sendProxyProtocol: true,
backendTransport: 'tcp',
}],
tls: {
mode: 'terminate',
certificate: 'auto',
},
sendProxyProtocol: true,
udp: {
maxSessionsPerIP: 321,
quic: {
enableHttp3: true,
},
},
},
security: {
ipAllowList: [{
ip: '10.0.0.0/8',
domains: ['api.example.com'],
}],
},
};
const preprocessor = new RoutePreprocessor();
const [rustRoute] = preprocessor.preprocessForRust([route]);
expect(rustRoute.match.headers?.['Content-Type']).toEqual('/^application\\/json$/i');
expect(rustRoute.match.transport).toEqual('udp');
expect(rustRoute.match.protocol).toEqual('http3');
expect(rustRoute.action.targets?.[0].match?.headers?.['X-Env']).toEqual('/^(prod|stage)$/');
expect(rustRoute.action.targets?.[0].port).toEqual('preserve');
expect(rustRoute.action.targets?.[0].backendTransport).toEqual('tcp');
expect(rustRoute.action.sendProxyProtocol).toBeTrue();
expect(rustRoute.action.udp?.maxSessionsPerIp).toEqual(321);
});
tap.test('Rust contract - preprocessor converts dynamic targets to relay-safe payloads', async () => {
const route: IRouteConfig = {
name: 'dynamic-contract-route',
match: {
ports: 8080,
},
action: {
type: 'forward',
targets: [{
host: () => 'dynamic-backend.internal',
port: () => 9443,
}],
},
};
const preprocessor = new RoutePreprocessor();
const [rustRoute] = preprocessor.preprocessForRust([route]);
expect(rustRoute.action.type).toEqual('socket-handler');
expect(rustRoute.action.targets?.[0].host).toEqual('localhost');
expect(rustRoute.action.targets?.[0].port).toEqual(0);
expect(preprocessor.getOriginalRoute('dynamic-contract-route')).toEqual(route);
});
tap.test('Rust contract - top-level config keeps shared SmartProxy settings', async () => {
const settings: ISmartProxyOptions = {
routes: [{
name: 'top-level-contract-route',
match: {
ports: 443,
domains: 'api.example.com',
},
action: {
type: 'forward',
targets: [{
host: 'backend.internal',
port: 8443,
}],
tls: {
mode: 'terminate',
certificate: 'auto',
},
},
}],
preserveSourceIP: true,
proxyIPs: ['10.0.0.1'],
acceptProxyProtocol: true,
sendProxyProtocol: true,
noDelay: true,
keepAlive: true,
keepAliveInitialDelay: 1500,
maxPendingDataSize: 4096,
disableInactivityCheck: true,
enableKeepAliveProbes: true,
enableDetailedLogging: true,
enableTlsDebugLogging: true,
enableRandomizedTimeouts: true,
connectionTimeout: 5000,
initialDataTimeout: 7000,
socketTimeout: 9000,
inactivityCheckInterval: 1100,
maxConnectionLifetime: 13000,
inactivityTimeout: 15000,
gracefulShutdownTimeout: 17000,
maxConnectionsPerIP: 20,
connectionRateLimitPerMinute: 30,
keepAliveTreatment: 'extended',
keepAliveInactivityMultiplier: 2,
extendedKeepAliveLifetime: 19000,
metrics: {
enabled: true,
sampleIntervalMs: 250,
retentionSeconds: 60,
},
acme: {
enabled: true,
email: 'ops@example.com',
environment: 'staging',
useProduction: false,
skipConfiguredCerts: true,
renewThresholdDays: 14,
renewCheckIntervalHours: 12,
autoRenew: true,
port: 80,
},
};
const preprocessor = new RoutePreprocessor();
const routes = preprocessor.preprocessForRust(settings.routes);
const config = buildRustProxyOptions(settings, routes);
expect(config.preserveSourceIp).toBeTrue();
expect(config.proxyIps).toEqual(['10.0.0.1']);
expect(config.acceptProxyProtocol).toBeTrue();
expect(config.sendProxyProtocol).toBeTrue();
expect(config.noDelay).toBeTrue();
expect(config.keepAlive).toBeTrue();
expect(config.keepAliveInitialDelay).toEqual(1500);
expect(config.maxPendingDataSize).toEqual(4096);
expect(config.disableInactivityCheck).toBeTrue();
expect(config.enableKeepAliveProbes).toBeTrue();
expect(config.enableDetailedLogging).toBeTrue();
expect(config.enableTlsDebugLogging).toBeTrue();
expect(config.enableRandomizedTimeouts).toBeTrue();
expect(config.connectionTimeout).toEqual(5000);
expect(config.initialDataTimeout).toEqual(7000);
expect(config.socketTimeout).toEqual(9000);
expect(config.inactivityCheckInterval).toEqual(1100);
expect(config.maxConnectionLifetime).toEqual(13000);
expect(config.inactivityTimeout).toEqual(15000);
expect(config.gracefulShutdownTimeout).toEqual(17000);
expect(config.maxConnectionsPerIp).toEqual(20);
expect(config.connectionRateLimitPerMinute).toEqual(30);
expect(config.keepAliveTreatment).toEqual('extended');
expect(config.keepAliveInactivityMultiplier).toEqual(2);
expect(config.extendedKeepAliveLifetime).toEqual(19000);
expect(config.metrics?.sampleIntervalMs).toEqual(250);
expect(config.acme?.email).toEqual('ops@example.com');
expect(config.acme?.environment).toEqual('staging');
expect(config.acme?.skipConfiguredCerts).toBeTrue();
expect(config.acme?.renewThresholdDays).toEqual(14);
});
export default tap.start();
+418
View File
@@ -0,0 +1,418 @@
import { tap, expect } from '@git.zone/tstest/tapbundle';
import { SmartProxy } from '../ts/index.js';
import * as http from 'http';
import WebSocket, { WebSocketServer } from 'ws';
import { findFreePorts, assertPortsFree } from './helpers/port-allocator.js';
/**
* Helper: create a WebSocket client that connects through the proxy.
* Registers the message handler BEFORE awaiting open to avoid race conditions.
*/
function connectWs(
url: string,
headers: Record<string, string> = {},
opts: WebSocket.ClientOptions = {},
): { ws: WebSocket; messages: string[]; opened: Promise<void> } {
const messages: string[] = [];
const ws = new WebSocket(url, { headers, ...opts });
// Register message handler immediately — before open fires
ws.on('message', (data) => {
messages.push(data.toString());
});
const opened = new Promise<void>((resolve, reject) => {
const timeout = setTimeout(() => reject(new Error('WebSocket open timeout')), 5000);
ws.on('open', () => { clearTimeout(timeout); resolve(); });
ws.on('error', (err) => { clearTimeout(timeout); reject(err); });
});
return { ws, messages, opened };
}
/** Wait until `predicate` returns true, with a hard timeout. */
function waitFor(predicate: () => boolean, timeoutMs = 5000): Promise<void> {
return new Promise((resolve, reject) => {
const deadline = setTimeout(() => reject(new Error('waitFor timeout')), timeoutMs);
const check = () => {
if (predicate()) { clearTimeout(deadline); resolve(); }
else setTimeout(check, 30);
};
check();
});
}
/** Graceful close helper */
function closeWs(ws: WebSocket): Promise<void> {
return new Promise((resolve) => {
if (ws.readyState === WebSocket.CLOSED) return resolve();
ws.on('close', () => resolve());
ws.close();
setTimeout(resolve, 2000); // fallback
});
}
// ─── Test 1: Basic WebSocket upgrade and bidirectional messaging ───
tap.test('should proxy WebSocket connections with bidirectional messaging', async () => {
const [PROXY_PORT, BACKEND_PORT] = await findFreePorts(2);
// Backend: echoes messages with prefix, sends greeting on connect
const backendServer = http.createServer();
const wss = new WebSocketServer({ server: backendServer });
const backendMessages: string[] = [];
wss.on('connection', (ws) => {
ws.on('message', (data) => {
const msg = data.toString();
backendMessages.push(msg);
ws.send(`echo: ${msg}`);
});
ws.send('hello from backend');
});
await new Promise<void>((resolve) => {
backendServer.listen(BACKEND_PORT, '127.0.0.1', () => resolve());
});
const proxy = new SmartProxy({
routes: [{
name: 'ws-test-route',
match: { ports: PROXY_PORT },
action: {
type: 'forward',
targets: [{ host: '127.0.0.1', port: BACKEND_PORT }],
websocket: { enabled: true },
},
}],
});
await proxy.start();
// Connect client — message handler registered before open
const { ws, messages, opened } = connectWs(
`ws://127.0.0.1:${PROXY_PORT}/`,
{ Host: 'test.local' },
);
await opened;
// Wait for the backend greeting
await waitFor(() => messages.length >= 1);
expect(messages[0]).toEqual('hello from backend');
// Send 3 messages, expect 3 echoes
ws.send('ping 1');
ws.send('ping 2');
ws.send('ping 3');
await waitFor(() => messages.length >= 4);
expect(messages).toContain('echo: ping 1');
expect(messages).toContain('echo: ping 2');
expect(messages).toContain('echo: ping 3');
expect(backendMessages).toInclude('ping 1');
expect(backendMessages).toInclude('ping 2');
expect(backendMessages).toInclude('ping 3');
await closeWs(ws);
await proxy.stop();
await new Promise<void>((resolve) => backendServer.close(() => resolve()));
await new Promise((r) => setTimeout(r, 500));
await assertPortsFree([PROXY_PORT, BACKEND_PORT]);
});
// ─── Test 2: Multiple concurrent WebSocket connections ───
tap.test('should handle multiple concurrent WebSocket connections', async () => {
const [PROXY_PORT, BACKEND_PORT] = await findFreePorts(2);
const backendServer = http.createServer();
const wss = new WebSocketServer({ server: backendServer });
let connectionCount = 0;
wss.on('connection', (ws) => {
const id = ++connectionCount;
ws.on('message', (data) => {
ws.send(`conn${id}: ${data.toString()}`);
});
});
await new Promise<void>((resolve) => {
backendServer.listen(BACKEND_PORT, '127.0.0.1', () => resolve());
});
const proxy = new SmartProxy({
routes: [{
name: 'ws-multi-route',
match: { ports: PROXY_PORT },
action: {
type: 'forward',
targets: [{ host: '127.0.0.1', port: BACKEND_PORT }],
websocket: { enabled: true },
},
}],
});
await proxy.start();
const NUM_CLIENTS = 5;
const clients: { ws: WebSocket; messages: string[] }[] = [];
for (let i = 0; i < NUM_CLIENTS; i++) {
const c = connectWs(
`ws://127.0.0.1:${PROXY_PORT}/`,
{ Host: 'test.local' },
);
await c.opened;
clients.push(c);
}
// Each client sends a unique message
for (let i = 0; i < NUM_CLIENTS; i++) {
clients[i].ws.send(`hello from client ${i}`);
}
// Wait for all replies
await waitFor(() => clients.every((c) => c.messages.length >= 1));
for (let i = 0; i < NUM_CLIENTS; i++) {
expect(clients[i].messages.length).toBeGreaterThanOrEqual(1);
expect(clients[i].messages[0]).toInclude(`hello from client ${i}`);
}
expect(connectionCount).toEqual(NUM_CLIENTS);
for (const c of clients) await closeWs(c.ws);
await proxy.stop();
await new Promise<void>((resolve) => backendServer.close(() => resolve()));
await new Promise((r) => setTimeout(r, 500));
await assertPortsFree([PROXY_PORT, BACKEND_PORT]);
});
// ─── Test 3: WebSocket with binary data ───
tap.test('should proxy binary WebSocket frames', async () => {
const [PROXY_PORT, BACKEND_PORT] = await findFreePorts(2);
const backendServer = http.createServer();
const wss = new WebSocketServer({ server: backendServer });
wss.on('connection', (ws) => {
ws.on('message', (data) => {
ws.send(data, { binary: true });
});
});
await new Promise<void>((resolve) => {
backendServer.listen(BACKEND_PORT, '127.0.0.1', () => resolve());
});
const proxy = new SmartProxy({
routes: [{
name: 'ws-binary-route',
match: { ports: PROXY_PORT },
action: {
type: 'forward',
targets: [{ host: '127.0.0.1', port: BACKEND_PORT }],
websocket: { enabled: true },
},
}],
});
await proxy.start();
const receivedBuffers: Buffer[] = [];
const ws = new WebSocket(`ws://127.0.0.1:${PROXY_PORT}/`, {
headers: { Host: 'test.local' },
});
ws.on('message', (data) => {
receivedBuffers.push(Buffer.from(data as ArrayBuffer));
});
await new Promise<void>((resolve, reject) => {
const timeout = setTimeout(() => reject(new Error('timeout')), 5000);
ws.on('open', () => { clearTimeout(timeout); resolve(); });
ws.on('error', (err) => { clearTimeout(timeout); reject(err); });
});
// Send a 256-byte buffer with known content
const sentBuffer = Buffer.alloc(256);
for (let i = 0; i < 256; i++) sentBuffer[i] = i;
ws.send(sentBuffer);
await waitFor(() => receivedBuffers.length >= 1);
expect(receivedBuffers[0].length).toEqual(256);
expect(Buffer.compare(receivedBuffers[0], sentBuffer)).toEqual(0);
await closeWs(ws);
await proxy.stop();
await new Promise<void>((resolve) => backendServer.close(() => resolve()));
await new Promise((r) => setTimeout(r, 500));
await assertPortsFree([PROXY_PORT, BACKEND_PORT]);
});
// ─── Test 4: WebSocket path and query string preserved ───
tap.test('should preserve path and query string through proxy', async () => {
const [PROXY_PORT, BACKEND_PORT] = await findFreePorts(2);
const backendServer = http.createServer();
const wss = new WebSocketServer({ server: backendServer });
let receivedUrl = '';
wss.on('connection', (ws, req) => {
receivedUrl = req.url || '';
ws.send(`url: ${receivedUrl}`);
});
await new Promise<void>((resolve) => {
backendServer.listen(BACKEND_PORT, '127.0.0.1', () => resolve());
});
const proxy = new SmartProxy({
routes: [{
name: 'ws-path-route',
match: { ports: PROXY_PORT },
action: {
type: 'forward',
targets: [{ host: '127.0.0.1', port: BACKEND_PORT }],
websocket: { enabled: true },
},
}],
});
await proxy.start();
const { ws, messages, opened } = connectWs(
`ws://127.0.0.1:${PROXY_PORT}/chat/room1?token=abc123`,
{ Host: 'test.local' },
);
await opened;
await waitFor(() => messages.length >= 1);
expect(receivedUrl).toEqual('/chat/room1?token=abc123');
expect(messages[0]).toEqual('url: /chat/room1?token=abc123');
await closeWs(ws);
await proxy.stop();
await new Promise<void>((resolve) => backendServer.close(() => resolve()));
await new Promise((r) => setTimeout(r, 500));
await assertPortsFree([PROXY_PORT, BACKEND_PORT]);
});
// ─── Test 5: Clean close propagation ───
tap.test('should handle clean WebSocket close from client', async () => {
const [PROXY_PORT, BACKEND_PORT] = await findFreePorts(2);
const backendServer = http.createServer();
const wss = new WebSocketServer({ server: backendServer });
let backendGotClose = false;
let backendCloseCode = 0;
wss.on('connection', (ws) => {
ws.on('close', (code) => {
backendGotClose = true;
backendCloseCode = code;
});
ws.on('message', (data) => {
ws.send(data);
});
});
await new Promise<void>((resolve) => {
backendServer.listen(BACKEND_PORT, '127.0.0.1', () => resolve());
});
const proxy = new SmartProxy({
routes: [{
name: 'ws-close-route',
match: { ports: PROXY_PORT },
action: {
type: 'forward',
targets: [{ host: '127.0.0.1', port: BACKEND_PORT }],
websocket: { enabled: true },
},
}],
});
await proxy.start();
const { ws, messages, opened } = connectWs(
`ws://127.0.0.1:${PROXY_PORT}/`,
{ Host: 'test.local' },
);
await opened;
// Confirm connection works with a round-trip
ws.send('test');
await waitFor(() => messages.length >= 1);
// Close with code 1000
let clientCloseCode = 0;
const closed = new Promise<void>((resolve) => {
ws.on('close', (code) => {
clientCloseCode = code;
resolve();
});
setTimeout(resolve, 3000);
});
ws.close(1000, 'done');
await closed;
// Wait for backend to register
await waitFor(() => backendGotClose, 3000);
expect(backendGotClose).toBeTrue();
expect(clientCloseCode).toEqual(1000);
await proxy.stop();
await new Promise<void>((resolve) => backendServer.close(() => resolve()));
await new Promise((r) => setTimeout(r, 500));
await assertPortsFree([PROXY_PORT, BACKEND_PORT]);
});
// ─── Test 6: Large messages ───
tap.test('should handle large WebSocket messages', async () => {
const [PROXY_PORT, BACKEND_PORT] = await findFreePorts(2);
const backendServer = http.createServer();
const wss = new WebSocketServer({ server: backendServer, maxPayload: 5 * 1024 * 1024 });
wss.on('connection', (ws) => {
ws.on('message', (data) => {
const buf = Buffer.from(data as ArrayBuffer);
ws.send(`received ${buf.length} bytes`);
});
});
await new Promise<void>((resolve) => {
backendServer.listen(BACKEND_PORT, '127.0.0.1', () => resolve());
});
const proxy = new SmartProxy({
routes: [{
name: 'ws-large-route',
match: { ports: PROXY_PORT },
action: {
type: 'forward',
targets: [{ host: '127.0.0.1', port: BACKEND_PORT }],
websocket: { enabled: true },
},
}],
});
await proxy.start();
const { ws, messages, opened } = connectWs(
`ws://127.0.0.1:${PROXY_PORT}/`,
{ Host: 'test.local' },
{ maxPayload: 5 * 1024 * 1024 },
);
await opened;
// Send a 1MB message
const largePayload = Buffer.alloc(1024 * 1024, 0x42);
ws.send(largePayload);
await waitFor(() => messages.length >= 1);
expect(messages[0]).toEqual(`received ${1024 * 1024} bytes`);
await closeWs(ws);
await proxy.stop();
await new Promise<void>((resolve) => backendServer.close(() => resolve()));
await new Promise((r) => setTimeout(r, 500));
await assertPortsFree([PROXY_PORT, BACKEND_PORT]);
});
export default tap.start();
+1 -1
View File
@@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartproxy', name: '@push.rocks/smartproxy',
version: '26.1.0', version: '27.7.3',
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.' 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.'
} }
+2
View File
@@ -19,12 +19,14 @@ export { tsclass };
import * as smartcrypto from '@push.rocks/smartcrypto'; import * as smartcrypto from '@push.rocks/smartcrypto';
import * as smartlog from '@push.rocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
import * as smartlogDestinationLocal from '@push.rocks/smartlog/destination-local'; import * as smartlogDestinationLocal from '@push.rocks/smartlog/destination-local';
import * as smartnftables from '@push.rocks/smartnftables';
import * as smartrust from '@push.rocks/smartrust'; import * as smartrust from '@push.rocks/smartrust';
export { export {
smartcrypto, smartcrypto,
smartlog, smartlog,
smartlogDestinationLocal, smartlogDestinationLocal,
smartnftables,
smartrust, smartrust,
}; };
@@ -26,6 +26,8 @@ interface IDatagramRelayMessage {
* - TSRust: { type: "reply", sourceIp, sourcePort, destPort, payloadBase64 } * - TSRust: { type: "reply", sourceIp, sourcePort, destPort, payloadBase64 }
*/ */
export class DatagramHandlerServer { export class DatagramHandlerServer {
private static readonly MAX_BUFFER_SIZE = 50 * 1024 * 1024; // 50 MB
private server: plugins.net.Server | null = null; private server: plugins.net.Server | null = null;
private connection: plugins.net.Socket | null = null; private connection: plugins.net.Socket | null = null;
private socketPath: string; private socketPath: string;
@@ -100,6 +102,11 @@ export class DatagramHandlerServer {
socket.on('data', (chunk: Buffer) => { socket.on('data', (chunk: Buffer) => {
this.readBuffer = Buffer.concat([this.readBuffer, chunk]); this.readBuffer = Buffer.concat([this.readBuffer, chunk]);
if (this.readBuffer.length > DatagramHandlerServer.MAX_BUFFER_SIZE) {
logger.log('error', `DatagramHandlerServer: buffer exceeded ${DatagramHandlerServer.MAX_BUFFER_SIZE} bytes, resetting`);
this.readBuffer = Buffer.alloc(0);
return;
}
this.processFrames(); this.processFrames();
}); });
@@ -32,6 +32,23 @@ export interface IThroughputHistoryPoint {
/** /**
* Main metrics interface with clean, grouped API * Main metrics interface with clean, grouped API
*/ */
/**
* Protocol distribution for frontend (clientproxy) or backend (proxyupstream).
* Tracks active and total counts for h1/h2/h3/ws/other.
*/
export interface IProtocolDistribution {
h1Active: number;
h1Total: number;
h2Active: number;
h2Total: number;
h3Active: number;
h3Total: number;
wsActive: number;
wsTotal: number;
otherActive: number;
otherTotal: number;
}
export interface IMetrics { export interface IMetrics {
// Connection metrics // Connection metrics
connections: { connections: {
@@ -40,6 +57,12 @@ export interface IMetrics {
byRoute(): Map<string, number>; byRoute(): Map<string, number>;
byIP(): Map<string, number>; byIP(): Map<string, number>;
topIPs(limit?: number): Array<{ ip: string; count: number }>; topIPs(limit?: number): Array<{ ip: string; count: number }>;
/** Per-IP domain request counts: IP -> { domain -> count }. */
domainRequestsByIP(): Map<string, Map<string, number>>;
/** Top IP-domain pairs sorted by request count descending. */
topDomainRequests(limit?: number): Array<{ ip: string; domain: string; count: number }>;
frontendProtocols(): IProtocolDistribution;
backendProtocols(): IProtocolDistribution;
}; };
// Throughput metrics (bytes per second) // Throughput metrics (bytes per second)
@@ -126,6 +149,8 @@ export interface IProtocolCacheEntry {
protocol: string; protocol: string;
h3Port: number | null; h3Port: number | null;
ageSecs: number; ageSecs: number;
lastAccessedSecs: number;
lastProbedSecs: number;
h2Suppressed: boolean; h2Suppressed: boolean;
h3Suppressed: boolean; h3Suppressed: boolean;
h2CooldownRemainingSecs: number | null; h2CooldownRemainingSecs: number | null;
+4 -2
View File
@@ -141,8 +141,10 @@ export interface IRouteAuthentication {
* Security options for routes * Security options for routes
*/ */
export interface IRouteSecurity { export interface IRouteSecurity {
// Access control lists // Access control lists.
ipAllowList?: string[]; // IP addresses that are allowed to connect // Entries can be plain IP/CIDR strings (full route access) or
// objects { ip, domains } to scope access to specific domains on this route.
ipAllowList?: Array<string | { ip: string; domains: string[] }>;
ipBlockList?: string[]; // IP addresses that are blocked from connecting ipBlockList?: string[]; // IP addresses that are blocked from connecting
// Connection limits // Connection limits
+160
View File
@@ -0,0 +1,160 @@
import type { IProtocolCacheEntry, IProtocolDistribution } from './metrics-types.js';
import type { IAcmeOptions, ISmartProxyOptions } from './interfaces.js';
import type {
IRouteAction,
IRouteConfig,
IRouteMatch,
IRouteTarget,
ITargetMatch,
IRouteUdp,
} from './route-types.js';
export type TRustHeaderMatchers = Record<string, string>;
export interface IRustRouteMatch extends Omit<IRouteMatch, 'headers'> {
headers?: TRustHeaderMatchers;
}
export interface IRustTargetMatch extends Omit<ITargetMatch, 'headers'> {
headers?: TRustHeaderMatchers;
}
export interface IRustRouteTarget extends Omit<IRouteTarget, 'host' | 'port' | 'match'> {
host: string | string[];
port: number | 'preserve';
match?: IRustTargetMatch;
}
export interface IRustRouteUdp extends Omit<IRouteUdp, 'maxSessionsPerIP'> {
maxSessionsPerIp?: number;
}
export interface IRustDefaultConfig extends Omit<NonNullable<ISmartProxyOptions['defaults']>, 'preserveSourceIP'> {
preserveSourceIp?: boolean;
}
export interface IRustRouteAction
extends Omit<IRouteAction, 'targets' | 'socketHandler' | 'datagramHandler' | 'forwardingEngine' | 'nftables' | 'udp'> {
targets?: IRustRouteTarget[];
udp?: IRustRouteUdp;
}
export interface IRustRouteConfig extends Omit<IRouteConfig, 'match' | 'action'> {
match: IRustRouteMatch;
action: IRustRouteAction;
}
export interface IRustAcmeOptions extends Omit<IAcmeOptions, 'routeForwards'> {}
export interface IRustProxyOptions {
routes: IRustRouteConfig[];
preserveSourceIp?: boolean;
proxyIps?: string[];
acceptProxyProtocol?: boolean;
sendProxyProtocol?: boolean;
defaults?: IRustDefaultConfig;
connectionTimeout?: number;
initialDataTimeout?: number;
socketTimeout?: number;
inactivityCheckInterval?: number;
maxConnectionLifetime?: number;
inactivityTimeout?: number;
gracefulShutdownTimeout?: number;
noDelay?: boolean;
keepAlive?: boolean;
keepAliveInitialDelay?: number;
maxPendingDataSize?: number;
disableInactivityCheck?: boolean;
enableKeepAliveProbes?: boolean;
enableDetailedLogging?: boolean;
enableTlsDebugLogging?: boolean;
enableRandomizedTimeouts?: boolean;
maxConnectionsPerIp?: number;
connectionRateLimitPerMinute?: number;
keepAliveTreatment?: ISmartProxyOptions['keepAliveTreatment'];
keepAliveInactivityMultiplier?: number;
extendedKeepAliveLifetime?: number;
metrics?: ISmartProxyOptions['metrics'];
acme?: IRustAcmeOptions;
}
export interface IRustStatistics {
activeConnections: number;
totalConnections: number;
routesCount: number;
listeningPorts: number[];
uptimeSeconds: number;
}
export interface IRustCertificateStatus {
domain: string;
source: string;
expiresAt: number;
isValid: boolean;
}
export interface IRustThroughputSample {
timestampMs: number;
bytesIn: number;
bytesOut: number;
}
export interface IRustRouteMetrics {
activeConnections: number;
totalConnections: number;
bytesIn: number;
bytesOut: number;
throughputInBytesPerSec: number;
throughputOutBytesPerSec: number;
throughputRecentInBytesPerSec: number;
throughputRecentOutBytesPerSec: number;
}
export interface IRustIpMetrics {
activeConnections: number;
totalConnections: number;
bytesIn: number;
bytesOut: number;
throughputInBytesPerSec: number;
throughputOutBytesPerSec: number;
domainRequests: Record<string, number>;
}
export interface IRustBackendMetrics {
activeConnections: number;
totalConnections: number;
protocol: string;
connectErrors: number;
handshakeErrors: number;
requestErrors: number;
totalConnectTimeUs: number;
connectCount: number;
poolHits: number;
poolMisses: number;
h2Failures: number;
}
export interface IRustMetricsSnapshot {
activeConnections: number;
totalConnections: number;
bytesIn: number;
bytesOut: number;
throughputInBytesPerSec: number;
throughputOutBytesPerSec: number;
throughputRecentInBytesPerSec: number;
throughputRecentOutBytesPerSec: number;
routes: Record<string, IRustRouteMetrics>;
ips: Record<string, IRustIpMetrics>;
backends: Record<string, IRustBackendMetrics>;
throughputHistory: IRustThroughputSample[];
totalHttpRequests: number;
httpRequestsPerSec: number;
httpRequestsPerSecRecent: number;
activeUdpSessions: number;
totalUdpSessions: number;
totalDatagramsIn: number;
totalDatagramsOut: number;
detectedProtocols: IProtocolCacheEntry[];
frontendProtocols: IProtocolDistribution;
backendProtocols: IProtocolDistribution;
}
+13 -11
View File
@@ -1,5 +1,6 @@
import type { IRouteConfig, IRouteAction, IRouteTarget } from './models/route-types.js'; import type { IRouteConfig, IRouteAction, IRouteTarget } from './models/route-types.js';
import { logger } from '../../core/utils/logger.js'; import type { IRustRouteConfig } from './models/rust-types.js';
import { serializeRouteForRust } from './utils/rust-config.js';
/** /**
* Preprocesses routes before sending them to Rust. * Preprocesses routes before sending them to Rust.
@@ -24,7 +25,7 @@ export class RoutePreprocessor {
* - Non-serializable fields are stripped * - Non-serializable fields are stripped
* - Original routes are preserved in the local map for handler lookup * - Original routes are preserved in the local map for handler lookup
*/ */
public preprocessForRust(routes: IRouteConfig[]): IRouteConfig[] { public preprocessForRust(routes: IRouteConfig[]): IRustRouteConfig[] {
this.originalRoutes.clear(); this.originalRoutes.clear();
return routes.map((route, index) => this.preprocessRoute(route, index)); return routes.map((route, index) => this.preprocessRoute(route, index));
} }
@@ -43,7 +44,7 @@ export class RoutePreprocessor {
return new Map(this.originalRoutes); return new Map(this.originalRoutes);
} }
private preprocessRoute(route: IRouteConfig, index: number): IRouteConfig { private preprocessRoute(route: IRouteConfig, index: number): IRustRouteConfig {
const routeKey = route.name || route.id || `route_${index}`; const routeKey = route.name || route.id || `route_${index}`;
// Check if this route needs TS-side handling // Check if this route needs TS-side handling
@@ -57,7 +58,7 @@ export class RoutePreprocessor {
// Create a clean copy for Rust // Create a clean copy for Rust
const cleanRoute: IRouteConfig = { const cleanRoute: IRouteConfig = {
...route, ...route,
action: this.cleanAction(route.action, routeKey, needsTsHandling), action: this.cleanAction(route.action, needsTsHandling),
}; };
// Ensure we have a name for handler lookup // Ensure we have a name for handler lookup
@@ -65,7 +66,7 @@ export class RoutePreprocessor {
cleanRoute.name = routeKey; cleanRoute.name = routeKey;
} }
return cleanRoute; return serializeRouteForRust(cleanRoute);
} }
private routeNeedsTsHandling(route: IRouteConfig): boolean { private routeNeedsTsHandling(route: IRouteConfig): boolean {
@@ -91,15 +92,16 @@ export class RoutePreprocessor {
return false; return false;
} }
private cleanAction(action: IRouteAction, routeKey: string, needsTsHandling: boolean): IRouteAction { private cleanAction(action: IRouteAction, needsTsHandling: boolean): IRouteAction {
const cleanAction: IRouteAction = { ...action }; let cleanAction: IRouteAction = { ...action };
if (needsTsHandling) { if (needsTsHandling) {
// Convert to socket-handler type for Rust (Rust will relay back to TS) // Convert to socket-handler type for Rust (Rust will relay back to TS)
cleanAction.type = 'socket-handler'; const { socketHandler: _socketHandler, datagramHandler: _datagramHandler, ...serializableAction } = cleanAction;
// Remove the JS handlers (not serializable) cleanAction = {
delete (cleanAction as any).socketHandler; ...serializableAction,
delete (cleanAction as any).datagramHandler; type: 'socket-handler',
};
} }
// Clean targets - replace functions with static values // Clean targets - replace functions with static values
+95 -33
View File
@@ -1,5 +1,6 @@
import type { IMetrics, IBackendMetrics, IProtocolCacheEntry, IThroughputData, IThroughputHistoryPoint } from './models/metrics-types.js'; import type { IMetrics, IBackendMetrics, IProtocolCacheEntry, IProtocolDistribution, IThroughputData, IThroughputHistoryPoint } from './models/metrics-types.js';
import type { RustProxyBridge } from './rust-proxy-bridge.js'; import type { RustProxyBridge } from './rust-proxy-bridge.js';
import type { IRustBackendMetrics, IRustIpMetrics, IRustMetricsSnapshot, IRustRouteMetrics } from './models/rust-types.js';
/** /**
* Adapts Rust JSON metrics to the IMetrics interface. * Adapts Rust JSON metrics to the IMetrics interface.
@@ -14,7 +15,7 @@ import type { RustProxyBridge } from './rust-proxy-bridge.js';
*/ */
export class RustMetricsAdapter implements IMetrics { export class RustMetricsAdapter implements IMetrics {
private bridge: RustProxyBridge; private bridge: RustProxyBridge;
private cache: any = null; private cache: IRustMetricsSnapshot | null = null;
private pollTimer: ReturnType<typeof setInterval> | null = null; private pollTimer: ReturnType<typeof setInterval> | null = null;
private pollIntervalMs: number; private pollIntervalMs: number;
@@ -65,8 +66,8 @@ export class RustMetricsAdapter implements IMetrics {
byRoute: (): Map<string, number> => { byRoute: (): Map<string, number> => {
const result = new Map<string, number>(); const result = new Map<string, number>();
if (this.cache?.routes) { if (this.cache?.routes) {
for (const [name, rm] of Object.entries(this.cache.routes)) { for (const [name, rm] of Object.entries(this.cache.routes) as Array<[string, IRustRouteMetrics]>) {
result.set(name, (rm as any).activeConnections ?? 0); result.set(name, rm.activeConnections ?? 0);
} }
} }
return result; return result;
@@ -74,8 +75,8 @@ export class RustMetricsAdapter implements IMetrics {
byIP: (): Map<string, number> => { byIP: (): Map<string, number> => {
const result = new Map<string, number>(); const result = new Map<string, number>();
if (this.cache?.ips) { if (this.cache?.ips) {
for (const [ip, im] of Object.entries(this.cache.ips)) { for (const [ip, im] of Object.entries(this.cache.ips) as Array<[string, IRustIpMetrics]>) {
result.set(ip, (im as any).activeConnections ?? 0); result.set(ip, im.activeConnections ?? 0);
} }
} }
return result; return result;
@@ -83,13 +84,76 @@ export class RustMetricsAdapter implements IMetrics {
topIPs: (limit: number = 10): Array<{ ip: string; count: number }> => { topIPs: (limit: number = 10): Array<{ ip: string; count: number }> => {
const result: Array<{ ip: string; count: number }> = []; const result: Array<{ ip: string; count: number }> = [];
if (this.cache?.ips) { if (this.cache?.ips) {
for (const [ip, im] of Object.entries(this.cache.ips)) { for (const [ip, im] of Object.entries(this.cache.ips) as Array<[string, IRustIpMetrics]>) {
result.push({ ip, count: (im as any).activeConnections ?? 0 }); result.push({ ip, count: im.activeConnections ?? 0 });
} }
} }
result.sort((a, b) => b.count - a.count); result.sort((a, b) => b.count - a.count);
return result.slice(0, limit); return result.slice(0, limit);
}, },
domainRequestsByIP: (): Map<string, Map<string, number>> => {
const result = new Map<string, Map<string, number>>();
if (this.cache?.ips) {
for (const [ip, im] of Object.entries(this.cache.ips) as Array<[string, IRustIpMetrics]>) {
const dr = im.domainRequests;
if (dr && typeof dr === 'object') {
const domainMap = new Map<string, number>();
for (const [domain, count] of Object.entries(dr)) {
domainMap.set(domain, count as number);
}
if (domainMap.size > 0) {
result.set(ip, domainMap);
}
}
}
}
return result;
},
topDomainRequests: (limit: number = 20): Array<{ ip: string; domain: string; count: number }> => {
const result: Array<{ ip: string; domain: string; count: number }> = [];
if (this.cache?.ips) {
for (const [ip, im] of Object.entries(this.cache.ips) as Array<[string, IRustIpMetrics]>) {
const dr = im.domainRequests;
if (dr && typeof dr === 'object') {
for (const [domain, count] of Object.entries(dr)) {
result.push({ ip, domain, count: count as number });
}
}
}
}
result.sort((a, b) => b.count - a.count);
return result.slice(0, limit);
},
frontendProtocols: (): IProtocolDistribution => {
const fp = this.cache?.frontendProtocols;
return {
h1Active: fp?.h1Active ?? 0,
h1Total: fp?.h1Total ?? 0,
h2Active: fp?.h2Active ?? 0,
h2Total: fp?.h2Total ?? 0,
h3Active: fp?.h3Active ?? 0,
h3Total: fp?.h3Total ?? 0,
wsActive: fp?.wsActive ?? 0,
wsTotal: fp?.wsTotal ?? 0,
otherActive: fp?.otherActive ?? 0,
otherTotal: fp?.otherTotal ?? 0,
};
},
backendProtocols: (): IProtocolDistribution => {
const bp = this.cache?.backendProtocols;
return {
h1Active: bp?.h1Active ?? 0,
h1Total: bp?.h1Total ?? 0,
h2Active: bp?.h2Active ?? 0,
h2Total: bp?.h2Total ?? 0,
h3Active: bp?.h3Active ?? 0,
h3Total: bp?.h3Total ?? 0,
wsActive: bp?.wsActive ?? 0,
wsTotal: bp?.wsTotal ?? 0,
otherActive: bp?.otherActive ?? 0,
otherTotal: bp?.otherTotal ?? 0,
};
},
}; };
public throughput = { public throughput = {
@@ -113,7 +177,7 @@ export class RustMetricsAdapter implements IMetrics {
}, },
history: (seconds: number): Array<IThroughputHistoryPoint> => { history: (seconds: number): Array<IThroughputHistoryPoint> => {
if (!this.cache?.throughputHistory) return []; if (!this.cache?.throughputHistory) return [];
return this.cache.throughputHistory.slice(-seconds).map((p: any) => ({ return this.cache.throughputHistory.slice(-seconds).map((p) => ({
timestamp: p.timestampMs, timestamp: p.timestampMs,
in: p.bytesIn, in: p.bytesIn,
out: p.bytesOut, out: p.bytesOut,
@@ -122,10 +186,10 @@ export class RustMetricsAdapter implements IMetrics {
byRoute: (_windowSeconds?: number): Map<string, IThroughputData> => { byRoute: (_windowSeconds?: number): Map<string, IThroughputData> => {
const result = new Map<string, IThroughputData>(); const result = new Map<string, IThroughputData>();
if (this.cache?.routes) { if (this.cache?.routes) {
for (const [name, rm] of Object.entries(this.cache.routes)) { for (const [name, rm] of Object.entries(this.cache.routes) as Array<[string, IRustRouteMetrics]>) {
result.set(name, { result.set(name, {
in: (rm as any).throughputInBytesPerSec ?? 0, in: rm.throughputInBytesPerSec ?? 0,
out: (rm as any).throughputOutBytesPerSec ?? 0, out: rm.throughputOutBytesPerSec ?? 0,
}); });
} }
} }
@@ -134,10 +198,10 @@ export class RustMetricsAdapter implements IMetrics {
byIP: (_windowSeconds?: number): Map<string, IThroughputData> => { byIP: (_windowSeconds?: number): Map<string, IThroughputData> => {
const result = new Map<string, IThroughputData>(); const result = new Map<string, IThroughputData>();
if (this.cache?.ips) { if (this.cache?.ips) {
for (const [ip, im] of Object.entries(this.cache.ips)) { for (const [ip, im] of Object.entries(this.cache.ips) as Array<[string, IRustIpMetrics]>) {
result.set(ip, { result.set(ip, {
in: (im as any).throughputInBytesPerSec ?? 0, in: im.throughputInBytesPerSec ?? 0,
out: (im as any).throughputOutBytesPerSec ?? 0, out: im.throughputOutBytesPerSec ?? 0,
}); });
} }
} }
@@ -173,23 +237,22 @@ export class RustMetricsAdapter implements IMetrics {
byBackend: (): Map<string, IBackendMetrics> => { byBackend: (): Map<string, IBackendMetrics> => {
const result = new Map<string, IBackendMetrics>(); const result = new Map<string, IBackendMetrics>();
if (this.cache?.backends) { if (this.cache?.backends) {
for (const [key, bm] of Object.entries(this.cache.backends)) { for (const [key, bm] of Object.entries(this.cache.backends) as Array<[string, IRustBackendMetrics]>) {
const m = bm as any; const totalTimeUs = bm.totalConnectTimeUs ?? 0;
const totalTimeUs = m.totalConnectTimeUs ?? 0; const count = bm.connectCount ?? 0;
const count = m.connectCount ?? 0; const poolHits = bm.poolHits ?? 0;
const poolHits = m.poolHits ?? 0; const poolMisses = bm.poolMisses ?? 0;
const poolMisses = m.poolMisses ?? 0;
const poolTotal = poolHits + poolMisses; const poolTotal = poolHits + poolMisses;
result.set(key, { result.set(key, {
protocol: m.protocol ?? 'unknown', protocol: bm.protocol ?? 'unknown',
activeConnections: m.activeConnections ?? 0, activeConnections: bm.activeConnections ?? 0,
totalConnections: m.totalConnections ?? 0, totalConnections: bm.totalConnections ?? 0,
connectErrors: m.connectErrors ?? 0, connectErrors: bm.connectErrors ?? 0,
handshakeErrors: m.handshakeErrors ?? 0, handshakeErrors: bm.handshakeErrors ?? 0,
requestErrors: m.requestErrors ?? 0, requestErrors: bm.requestErrors ?? 0,
avgConnectTimeMs: count > 0 ? (totalTimeUs / count) / 1000 : 0, avgConnectTimeMs: count > 0 ? (totalTimeUs / count) / 1000 : 0,
poolHitRate: poolTotal > 0 ? poolHits / poolTotal : 0, poolHitRate: poolTotal > 0 ? poolHits / poolTotal : 0,
h2Failures: m.h2Failures ?? 0, h2Failures: bm.h2Failures ?? 0,
}); });
} }
} }
@@ -198,8 +261,8 @@ export class RustMetricsAdapter implements IMetrics {
protocols: (): Map<string, string> => { protocols: (): Map<string, string> => {
const result = new Map<string, string>(); const result = new Map<string, string>();
if (this.cache?.backends) { if (this.cache?.backends) {
for (const [key, bm] of Object.entries(this.cache.backends)) { for (const [key, bm] of Object.entries(this.cache.backends) as Array<[string, IRustBackendMetrics]>) {
result.set(key, (bm as any).protocol ?? 'unknown'); result.set(key, bm.protocol ?? 'unknown');
} }
} }
return result; return result;
@@ -207,9 +270,8 @@ export class RustMetricsAdapter implements IMetrics {
topByErrors: (limit: number = 10): Array<{ backend: string; errors: number }> => { topByErrors: (limit: number = 10): Array<{ backend: string; errors: number }> => {
const result: Array<{ backend: string; errors: number }> = []; const result: Array<{ backend: string; errors: number }> = [];
if (this.cache?.backends) { if (this.cache?.backends) {
for (const [key, bm] of Object.entries(this.cache.backends)) { for (const [key, bm] of Object.entries(this.cache.backends) as Array<[string, IRustBackendMetrics]>) {
const m = bm as any; const errors = (bm.connectErrors ?? 0) + (bm.handshakeErrors ?? 0) + (bm.requestErrors ?? 0);
const errors = (m.connectErrors ?? 0) + (m.handshakeErrors ?? 0) + (m.requestErrors ?? 0);
if (errors > 0) result.push({ backend: key, errors }); if (errors > 0) result.push({ backend: key, errors });
} }
} }
+24 -23
View File
@@ -1,24 +1,29 @@
import * as plugins from '../../plugins.js'; import * as plugins from '../../plugins.js';
import { logger } from '../../core/utils/logger.js'; import { logger } from '../../core/utils/logger.js';
import type { IRouteConfig } from './models/route-types.js'; import type {
IRustCertificateStatus,
IRustMetricsSnapshot,
IRustProxyOptions,
IRustRouteConfig,
IRustStatistics,
} from './models/rust-types.js';
/** /**
* Type-safe command definitions for the Rust proxy IPC protocol. * Type-safe command definitions for the Rust proxy IPC protocol.
*/ */
type TSmartProxyCommands = { type TSmartProxyCommands = {
start: { params: { config: any }; result: void }; start: { params: { config: IRustProxyOptions }; result: void };
stop: { params: Record<string, never>; result: void }; stop: { params: Record<string, never>; result: void };
updateRoutes: { params: { routes: IRouteConfig[] }; result: void }; updateRoutes: { params: { routes: IRustRouteConfig[] }; result: void };
getMetrics: { params: Record<string, never>; result: any }; getMetrics: { params: Record<string, never>; result: IRustMetricsSnapshot };
getStatistics: { params: Record<string, never>; result: any }; getStatistics: { params: Record<string, never>; result: IRustStatistics };
provisionCertificate: { params: { routeName: string }; result: void }; provisionCertificate: { params: { routeName: string }; result: void };
renewCertificate: { params: { routeName: string }; result: void }; renewCertificate: { params: { routeName: string }; result: void };
getCertificateStatus: { params: { routeName: string }; result: any }; getCertificateStatus: { params: { routeName: string }; result: IRustCertificateStatus | null };
getListeningPorts: { params: Record<string, never>; result: { ports: number[] } }; getListeningPorts: { params: Record<string, never>; result: { ports: number[] } };
getNftablesStatus: { params: Record<string, never>; result: any }; setSocketHandlerRelay: { params: { socketPath: string }; result: void };
setSocketHandlerRelay: { params: { socketPath: string }; result: void }; addListeningPort: { params: { port: number }; result: void };
addListeningPort: { params: { port: number }; result: void }; removeListeningPort: { params: { port: number }; result: void };
removeListeningPort: { params: { port: number }; result: void };
loadCertificate: { params: { domain: string; cert: string; key: string; ca?: string }; result: void }; loadCertificate: { params: { domain: string; cert: string; key: string; ca?: string }; result: void };
setDatagramHandlerRelay: { params: { socketPath: string }; result: void }; setDatagramHandlerRelay: { params: { socketPath: string }; result: void };
}; };
@@ -122,7 +127,7 @@ export class RustProxyBridge extends plugins.EventEmitter {
// --- Convenience methods for each management command --- // --- Convenience methods for each management command ---
public async startProxy(config: any): Promise<void> { public async startProxy(config: IRustProxyOptions): Promise<void> {
await this.bridge.sendCommand('start', { config }); await this.bridge.sendCommand('start', { config });
} }
@@ -130,15 +135,15 @@ export class RustProxyBridge extends plugins.EventEmitter {
await this.bridge.sendCommand('stop', {} as Record<string, never>); await this.bridge.sendCommand('stop', {} as Record<string, never>);
} }
public async updateRoutes(routes: IRouteConfig[]): Promise<void> { public async updateRoutes(routes: IRustRouteConfig[]): Promise<void> {
await this.bridge.sendCommand('updateRoutes', { routes }); await this.bridge.sendCommand('updateRoutes', { routes });
} }
public async getMetrics(): Promise<any> { public async getMetrics(): Promise<IRustMetricsSnapshot> {
return this.bridge.sendCommand('getMetrics', {} as Record<string, never>); return this.bridge.sendCommand('getMetrics', {} as Record<string, never>);
} }
public async getStatistics(): Promise<any> { public async getStatistics(): Promise<IRustStatistics> {
return this.bridge.sendCommand('getStatistics', {} as Record<string, never>); return this.bridge.sendCommand('getStatistics', {} as Record<string, never>);
} }
@@ -150,7 +155,7 @@ export class RustProxyBridge extends plugins.EventEmitter {
await this.bridge.sendCommand('renewCertificate', { routeName }); await this.bridge.sendCommand('renewCertificate', { routeName });
} }
public async getCertificateStatus(routeName: string): Promise<any> { public async getCertificateStatus(routeName: string): Promise<IRustCertificateStatus | null> {
return this.bridge.sendCommand('getCertificateStatus', { routeName }); return this.bridge.sendCommand('getCertificateStatus', { routeName });
} }
@@ -159,10 +164,6 @@ export class RustProxyBridge extends plugins.EventEmitter {
return result?.ports ?? []; return result?.ports ?? [];
} }
public async getNftablesStatus(): Promise<any> {
return this.bridge.sendCommand('getNftablesStatus', {} as Record<string, never>);
}
public async setSocketHandlerRelay(socketPath: string): Promise<void> { public async setSocketHandlerRelay(socketPath: string): Promise<void> {
await this.bridge.sendCommand('setSocketHandlerRelay', { socketPath }); await this.bridge.sendCommand('setSocketHandlerRelay', { socketPath });
} }
+74 -38
View File
@@ -11,6 +11,7 @@ import { RustMetricsAdapter } from './rust-metrics-adapter.js';
// Route management // Route management
import { SharedRouteManager as RouteManager } from '../../core/routing/route-manager.js'; import { SharedRouteManager as RouteManager } from '../../core/routing/route-manager.js';
import { RouteValidator } from './utils/route-validator.js'; import { RouteValidator } from './utils/route-validator.js';
import { buildRustProxyOptions } from './utils/rust-config.js';
import { generateDefaultCertificate } from './utils/default-cert-generator.js'; import { generateDefaultCertificate } from './utils/default-cert-generator.js';
import { Mutex } from './utils/mutex.js'; import { Mutex } from './utils/mutex.js';
import { ConcurrencySemaphore } from './utils/concurrency-semaphore.js'; import { ConcurrencySemaphore } from './utils/concurrency-semaphore.js';
@@ -19,12 +20,13 @@ import { ConcurrencySemaphore } from './utils/concurrency-semaphore.js';
import type { ISmartProxyOptions, TSmartProxyCertProvisionObject, IAcmeOptions, ICertProvisionEventComms, ICertificateIssuedEvent, ICertificateFailedEvent } from './models/interfaces.js'; import type { ISmartProxyOptions, TSmartProxyCertProvisionObject, IAcmeOptions, ICertProvisionEventComms, ICertificateIssuedEvent, ICertificateFailedEvent } from './models/interfaces.js';
import type { IRouteConfig } from './models/route-types.js'; import type { IRouteConfig } from './models/route-types.js';
import type { IMetrics } from './models/metrics-types.js'; import type { IMetrics } from './models/metrics-types.js';
import type { IRustCertificateStatus, IRustProxyOptions, IRustStatistics } from './models/rust-types.js';
/** /**
* SmartProxy - Rust-backed proxy engine with TypeScript configuration API. * SmartProxy - Rust-backed proxy engine with TypeScript configuration API.
* *
* All networking (TCP, TLS, HTTP reverse proxy, connection management, security, * All networking (TCP, TLS, HTTP reverse proxy, connection management, security)
* NFTables) is handled by the Rust binary. TypeScript is only: * is handled by the Rust binary. TypeScript is only:
* - The npm module interface (types, route helpers) * - The npm module interface (types, route helpers)
* - The thin IPC wrapper (this class) * - The thin IPC wrapper (this class)
* - Socket-handler callback relay (for JS-defined handlers) * - Socket-handler callback relay (for JS-defined handlers)
@@ -39,6 +41,7 @@ export class SmartProxy extends plugins.EventEmitter {
private socketHandlerServer: SocketHandlerServer | null = null; private socketHandlerServer: SocketHandlerServer | null = null;
private datagramHandlerServer: DatagramHandlerServer | null = null; private datagramHandlerServer: DatagramHandlerServer | null = null;
private metricsAdapter: RustMetricsAdapter; private metricsAdapter: RustMetricsAdapter;
private nftablesManager: InstanceType<typeof plugins.smartnftables.SmartNftables> | null = null;
private routeUpdateLock: Mutex; private routeUpdateLock: Mutex;
private stopping = false; private stopping = false;
private certProvisionPromise: Promise<void> | null = null; private certProvisionPromise: Promise<void> | null = null;
@@ -128,6 +131,7 @@ export class SmartProxy extends plugins.EventEmitter {
} }
// Handle unexpected exit (only emits error if not intentionally stopping) // Handle unexpected exit (only emits error if not intentionally stopping)
this.bridge.removeAllListeners('exit');
this.bridge.on('exit', (code: number | null, signal: string | null) => { this.bridge.on('exit', (code: number | null, signal: string | null) => {
if (this.stopping) return; if (this.stopping) return;
logger.log('error', `RustProxy exited unexpectedly (code=${code}, signal=${signal})`, { component: 'smart-proxy' }); logger.log('error', `RustProxy exited unexpectedly (code=${code}, signal=${signal})`, { component: 'smart-proxy' });
@@ -210,6 +214,9 @@ export class SmartProxy extends plugins.EventEmitter {
} }
} }
// Apply NFTables rules for routes using nftables forwarding engine
await this.applyNftablesRules(this.settings.routes);
// Start metrics polling BEFORE cert provisioning — the Rust engine is already // Start metrics polling BEFORE cert provisioning — the Rust engine is already
// running and accepting connections, so metrics should be available immediately. // running and accepting connections, so metrics should be available immediately.
// Cert provisioning can hang indefinitely (e.g. DNS-01 ACME timeouts) and must // Cert provisioning can hang indefinitely (e.g. DNS-01 ACME timeouts) and must
@@ -237,6 +244,12 @@ export class SmartProxy extends plugins.EventEmitter {
this.certProvisionPromise = null; this.certProvisionPromise = null;
} }
// Clean up NFTables rules
if (this.nftablesManager) {
await this.nftablesManager.cleanup();
this.nftablesManager = null;
}
// Stop metrics polling // Stop metrics polling
this.metricsAdapter.stopPolling(); this.metricsAdapter.stopPolling();
@@ -318,6 +331,13 @@ export class SmartProxy extends plugins.EventEmitter {
this.datagramHandlerServer = null; this.datagramHandlerServer = null;
} }
// Update NFTables rules
if (this.nftablesManager) {
await this.nftablesManager.cleanup();
this.nftablesManager = null;
}
await this.applyNftablesRules(newRoutes);
// Update stored routes // Update stored routes
this.settings.routes = newRoutes; this.settings.routes = newRoutes;
@@ -347,7 +367,7 @@ export class SmartProxy extends plugins.EventEmitter {
/** /**
* Get certificate status for a route (async - calls Rust). * Get certificate status for a route (async - calls Rust).
*/ */
public async getCertificateStatus(routeName: string): Promise<any> { public async getCertificateStatus(routeName: string): Promise<IRustCertificateStatus | null> {
return this.bridge.getCertificateStatus(routeName); return this.bridge.getCertificateStatus(routeName);
} }
@@ -361,7 +381,7 @@ export class SmartProxy extends plugins.EventEmitter {
/** /**
* Get statistics (async - calls Rust). * Get statistics (async - calls Rust).
*/ */
public async getStatistics(): Promise<any> { public async getStatistics(): Promise<IRustStatistics> {
return this.bridge.getStatistics(); return this.bridge.getStatistics();
} }
@@ -410,48 +430,64 @@ export class SmartProxy extends plugins.EventEmitter {
} }
/** /**
* Get NFTables status (async - calls Rust). * Get NFTables status.
*/ */
public async getNfTablesStatus(): Promise<Record<string, any>> { public getNfTablesStatus(): plugins.smartnftables.INftStatus | null {
return this.bridge.getNftablesStatus(); return this.nftablesManager?.status() ?? null;
} }
// --- Private helpers --- // --- Private helpers ---
/**
* Apply NFTables rules for routes using the nftables forwarding engine.
*/
private async applyNftablesRules(routes: IRouteConfig[]): Promise<void> {
const nftRoutes = routes.filter(r => r.action.forwardingEngine === 'nftables');
if (nftRoutes.length === 0) return;
const tableName = nftRoutes.find(r => r.action.nftables?.tableName)?.action.nftables?.tableName ?? 'smartproxy';
const nft = new plugins.smartnftables.SmartNftables({ tableName });
await nft.initialize();
for (const route of nftRoutes) {
const routeId = route.name || 'unnamed';
const targets = route.action.targets;
if (!targets) continue;
const nftOpts = route.action.nftables;
const protocol: plugins.smartnftables.TNftProtocol = (nftOpts?.protocol as any) ?? 'tcp';
const preserveSourceIP = nftOpts?.preserveSourceIP ?? false;
const ports = Array.isArray(route.match.ports)
? route.match.ports.flatMap(p => typeof p === 'number' ? [p] : [])
: typeof route.match.ports === 'number' ? [route.match.ports] : [];
for (const target of targets) {
const targetHost = Array.isArray(target.host) ? target.host[0] : target.host;
if (typeof targetHost !== 'string') continue;
for (const sourcePort of ports) {
const targetPort = typeof target.port === 'number' ? target.port : sourcePort;
await nft.nat.addPortForwarding(`${routeId}-${sourcePort}-${targetPort}`, {
sourcePort,
targetHost,
targetPort,
protocol,
preserveSourceIP,
});
}
}
}
this.nftablesManager = nft;
logger.log('info', `Applied NFTables rules for ${nftRoutes.length} route(s)`, { component: 'smart-proxy' });
}
/** /**
* Build the Rust configuration object from TS settings. * Build the Rust configuration object from TS settings.
*/ */
private buildRustConfig(routes: IRouteConfig[], acmeOverride?: IAcmeOptions): any { private buildRustConfig(routes: IRustProxyOptions['routes'], acmeOverride?: IAcmeOptions): IRustProxyOptions {
const acme = acmeOverride !== undefined ? acmeOverride : this.settings.acme; return buildRustProxyOptions(this.settings, routes, acmeOverride);
return {
routes,
defaults: this.settings.defaults,
acme: acme
? {
enabled: acme.enabled,
email: acme.email,
useProduction: acme.useProduction,
port: acme.port,
renewThresholdDays: acme.renewThresholdDays,
autoRenew: acme.autoRenew,
renewCheckIntervalHours: acme.renewCheckIntervalHours,
}
: undefined,
connectionTimeout: this.settings.connectionTimeout,
initialDataTimeout: this.settings.initialDataTimeout,
socketTimeout: this.settings.socketTimeout,
maxConnectionLifetime: this.settings.maxConnectionLifetime,
gracefulShutdownTimeout: this.settings.gracefulShutdownTimeout,
maxConnectionsPerIp: this.settings.maxConnectionsPerIP,
connectionRateLimitPerMinute: this.settings.connectionRateLimitPerMinute,
keepAliveTreatment: this.settings.keepAliveTreatment,
keepAliveInactivityMultiplier: this.settings.keepAliveInactivityMultiplier,
extendedKeepAliveLifetime: this.settings.extendedKeepAliveLifetime,
proxyIps: this.settings.proxyIPs,
acceptProxyProtocol: this.settings.acceptProxyProtocol,
sendProxyProtocol: this.settings.sendProxyProtocol,
metrics: this.settings.metrics,
};
} }
/** /**
+3 -11
View File
@@ -2,12 +2,9 @@
* SmartProxy Route Utilities * SmartProxy Route Utilities
* *
* This file exports all route-related utilities for the SmartProxy module, * This file exports all route-related utilities for the SmartProxy module,
* including helpers, validators, utilities, and patterns for working with routes. * including validators, utilities, and socket handlers for working with routes.
*/ */
// Export route helpers for creating route configurations
export * from './route-helpers.js';
// Export route validator (class-based and functional API) // Export route validator (class-based and functional API)
export * from './route-validator.js'; export * from './route-validator.js';
@@ -20,10 +17,5 @@ export { generateDefaultCertificate } from './default-cert-generator.js';
// Export concurrency semaphore // Export concurrency semaphore
export { ConcurrencySemaphore } from './concurrency-semaphore.js'; export { ConcurrencySemaphore } from './concurrency-semaphore.js';
// Export additional functions from route-helpers that weren't already exported // Export socket handlers
export { export { SocketHandlers } from './socket-handlers.js';
createApiGatewayRoute,
addRateLimiting,
addBasicAuth,
addJwtAuth
} from './route-helpers.js';
@@ -1,11 +0,0 @@
/**
* Route Helper Functions
*
* This file re-exports all route helper functions for backwards compatibility.
* The actual implementations have been split into focused modules in the route-helpers/ directory.
*
* @see ./route-helpers/index.ts for the modular exports
*/
// Re-export everything from the modular helpers
export * from './route-helpers/index.js';
@@ -1,144 +0,0 @@
/**
* API Route Helper Functions
*
* This module provides utility functions for creating API route configurations.
*/
import type { IRouteConfig, IRouteMatch, IRouteAction } from '../../models/route-types.js';
import { mergeRouteConfigs } from '../route-utils.js';
import { createHttpRoute } from './http-helpers.js';
import { createHttpsTerminateRoute } from './https-helpers.js';
/**
* Create an API route configuration
* @param domains Domain(s) to match
* @param apiPath API base path (e.g., "/api")
* @param target Target host and port
* @param options Additional route options
* @returns Route configuration object
*/
export function createApiRoute(
domains: string | string[],
apiPath: string,
target: { host: string | string[]; port: number },
options: {
useTls?: boolean;
certificate?: 'auto' | { key: string; cert: string };
addCorsHeaders?: boolean;
httpPort?: number | number[];
httpsPort?: number | number[];
name?: string;
[key: string]: any;
} = {}
): IRouteConfig {
// Normalize API path
const normalizedPath = apiPath.startsWith('/') ? apiPath : `/${apiPath}`;
const pathWithWildcard = normalizedPath.endsWith('/')
? `${normalizedPath}*`
: `${normalizedPath}/*`;
// Create route match
const match: IRouteMatch = {
ports: options.useTls
? (options.httpsPort || 443)
: (options.httpPort || 80),
domains,
path: pathWithWildcard
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [target]
};
// Add TLS configuration if using HTTPS
if (options.useTls) {
action.tls = {
mode: 'terminate',
certificate: options.certificate || 'auto'
};
}
// Add CORS headers if requested
const headers: Record<string, Record<string, string>> = {};
if (options.addCorsHeaders) {
headers.response = {
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type, Authorization',
'Access-Control-Max-Age': '86400'
};
}
// Create the route config
return {
match,
action,
headers: Object.keys(headers).length > 0 ? headers : undefined,
name: options.name || `API Route ${normalizedPath} for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
priority: options.priority || 100, // Higher priority for specific path matches
...options
};
}
/**
* Create an API Gateway route pattern
* @param domains Domain(s) to match
* @param apiBasePath Base path for API endpoints (e.g., '/api')
* @param target Target host and port
* @param options Additional route options
* @returns API route configuration
*/
export function createApiGatewayRoute(
domains: string | string[],
apiBasePath: string,
target: { host: string | string[]; port: number },
options: {
useTls?: boolean;
certificate?: 'auto' | { key: string; cert: string };
addCorsHeaders?: boolean;
[key: string]: any;
} = {}
): IRouteConfig {
// Normalize apiBasePath to ensure it starts with / and doesn't end with /
const normalizedPath = apiBasePath.startsWith('/')
? apiBasePath
: `/${apiBasePath}`;
// Add wildcard to path to match all API endpoints
const apiPath = normalizedPath.endsWith('/')
? `${normalizedPath}*`
: `${normalizedPath}/*`;
// Create base route
const baseRoute = options.useTls
? createHttpsTerminateRoute(domains, target, {
certificate: options.certificate || 'auto'
})
: createHttpRoute(domains, target);
// Add API-specific configurations
const apiRoute: Partial<IRouteConfig> = {
match: {
...baseRoute.match,
path: apiPath
},
name: options.name || `API Gateway: ${apiPath} -> ${Array.isArray(target.host) ? target.host.join(', ') : target.host}:${target.port}`,
priority: options.priority || 100 // Higher priority for specific path matching
};
// Add CORS headers if requested
if (options.addCorsHeaders) {
apiRoute.headers = {
response: {
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type, Authorization',
'Access-Control-Max-Age': '86400'
}
};
}
return mergeRouteConfigs(baseRoute, apiRoute);
}
@@ -1,124 +0,0 @@
/**
* Dynamic Route Helper Functions
*
* This module provides utility functions for creating dynamic routes
* with context-based host and port mapping.
*/
import type { IRouteConfig, IRouteMatch, IRouteAction, TPortRange, IRouteContext } from '../../models/route-types.js';
/**
* Create a helper function that applies a port offset
* @param offset The offset to apply to the matched port
* @returns A function that adds the offset to the matched port
*/
export function createPortOffset(offset: number): (context: IRouteContext) => number {
return (context: IRouteContext) => context.port + offset;
}
/**
* Create a port mapping route with context-based port function
* @param options Port mapping route options
* @returns Route configuration object
*/
export function createPortMappingRoute(options: {
sourcePortRange: TPortRange;
targetHost: string | string[] | ((context: IRouteContext) => string | string[]);
portMapper: (context: IRouteContext) => number;
name?: string;
domains?: string | string[];
priority?: number;
[key: string]: any;
}): IRouteConfig {
// Create route match
const match: IRouteMatch = {
ports: options.sourcePortRange,
domains: options.domains
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [{
host: options.targetHost,
port: options.portMapper
}]
};
// Create the route config
return {
match,
action,
name: options.name || `Port Mapping Route for ${options.domains || 'all domains'}`,
priority: options.priority,
...options
};
}
/**
* Create a simple offset port mapping route
* @param options Offset port mapping route options
* @returns Route configuration object
*/
export function createOffsetPortMappingRoute(options: {
ports: TPortRange;
targetHost: string | string[];
offset: number;
name?: string;
domains?: string | string[];
priority?: number;
[key: string]: any;
}): IRouteConfig {
return createPortMappingRoute({
sourcePortRange: options.ports,
targetHost: options.targetHost,
portMapper: (context) => context.port + options.offset,
name: options.name || `Offset Mapping (${options.offset > 0 ? '+' : ''}${options.offset}) for ${options.domains || 'all domains'}`,
domains: options.domains,
priority: options.priority,
...options
});
}
/**
* Create a dynamic route with context-based host and port mapping
* @param options Dynamic route options
* @returns Route configuration object
*/
export function createDynamicRoute(options: {
ports: TPortRange;
targetHost: (context: IRouteContext) => string | string[];
portMapper: (context: IRouteContext) => number;
name?: string;
domains?: string | string[];
path?: string;
clientIp?: string[];
priority?: number;
[key: string]: any;
}): IRouteConfig {
// Create route match
const match: IRouteMatch = {
ports: options.ports,
domains: options.domains,
path: options.path,
clientIp: options.clientIp
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [{
host: options.targetHost,
port: options.portMapper
}]
};
// Create the route config
return {
match,
action,
name: options.name || `Dynamic Route for ${options.domains || 'all domains'}`,
priority: options.priority,
...options
};
}
@@ -1,40 +0,0 @@
/**
* HTTP Route Helper Functions
*
* This module provides utility functions for creating HTTP route configurations.
*/
import type { IRouteConfig, IRouteMatch, IRouteAction } from '../../models/route-types.js';
/**
* Create an HTTP-only route configuration
* @param domains Domain(s) to match
* @param target Target host and port
* @param options Additional route options
* @returns Route configuration object
*/
export function createHttpRoute(
domains: string | string[],
target: { host: string | string[]; port: number },
options: Partial<IRouteConfig> = {}
): IRouteConfig {
// Create route match
const match: IRouteMatch = {
ports: options.match?.ports || 80,
domains
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [target]
};
// Create the route config
return {
match,
action,
name: options.name || `HTTP Route for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
...options
};
}
@@ -1,163 +0,0 @@
/**
* HTTPS Route Helper Functions
*
* This module provides utility functions for creating HTTPS route configurations
* including TLS termination and passthrough routes.
*/
import type { IRouteConfig, IRouteMatch, IRouteAction } from '../../models/route-types.js';
import { SocketHandlers } from './socket-handlers.js';
/**
* Create an HTTPS route with TLS termination
* @param domains Domain(s) to match
* @param target Target host and port
* @param options Additional route options
* @returns Route configuration object
*/
export function createHttpsTerminateRoute(
domains: string | string[],
target: { host: string | string[]; port: number },
options: {
certificate?: 'auto' | { key: string; cert: string };
httpPort?: number | number[];
httpsPort?: number | number[];
reencrypt?: boolean;
name?: string;
[key: string]: any;
} = {}
): IRouteConfig {
// Create route match
const match: IRouteMatch = {
ports: options.httpsPort || 443,
domains
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [target],
tls: {
mode: options.reencrypt ? 'terminate-and-reencrypt' : 'terminate',
certificate: options.certificate || 'auto'
}
};
// Create the route config
return {
match,
action,
name: options.name || `HTTPS Route for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
...options
};
}
/**
* Create an HTTP to HTTPS redirect route
* @param domains Domain(s) to match
* @param httpsPort HTTPS port to redirect to (default: 443)
* @param options Additional route options
* @returns Route configuration object
*/
export function createHttpToHttpsRedirect(
domains: string | string[],
httpsPort: number = 443,
options: Partial<IRouteConfig> = {}
): IRouteConfig {
// Create route match
const match: IRouteMatch = {
ports: options.match?.ports || 80,
domains
};
// Create route action
const action: IRouteAction = {
type: 'socket-handler',
socketHandler: SocketHandlers.httpRedirect(`https://{domain}:${httpsPort}{path}`, 301)
};
// Create the route config
return {
match,
action,
name: options.name || `HTTP to HTTPS Redirect for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
...options
};
}
/**
* Create an HTTPS passthrough route (SNI-based forwarding without TLS termination)
* @param domains Domain(s) to match
* @param target Target host and port
* @param options Additional route options
* @returns Route configuration object
*/
export function createHttpsPassthroughRoute(
domains: string | string[],
target: { host: string | string[]; port: number },
options: Partial<IRouteConfig> = {}
): IRouteConfig {
// Create route match
const match: IRouteMatch = {
ports: options.match?.ports || 443,
domains
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [target],
tls: {
mode: 'passthrough'
}
};
// Create the route config
return {
match,
action,
name: options.name || `HTTPS Passthrough for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
...options
};
}
/**
* Create a complete HTTPS server with HTTP to HTTPS redirects
* @param domains Domain(s) to match
* @param target Target host and port
* @param options Additional configuration options
* @returns Array of two route configurations (HTTPS and HTTP redirect)
*/
export function createCompleteHttpsServer(
domains: string | string[],
target: { host: string | string[]; port: number },
options: {
certificate?: 'auto' | { key: string; cert: string };
httpPort?: number | number[];
httpsPort?: number | number[];
reencrypt?: boolean;
name?: string;
[key: string]: any;
} = {}
): IRouteConfig[] {
// Create the HTTPS route
const httpsRoute = createHttpsTerminateRoute(domains, target, options);
// Create the HTTP redirect route
const httpRedirectRoute = createHttpToHttpsRedirect(
domains,
// Extract the HTTPS port from the HTTPS route - ensure it's a number
typeof options.httpsPort === 'number' ? options.httpsPort :
Array.isArray(options.httpsPort) ? options.httpsPort[0] : 443,
{
// Set the HTTP port
match: {
ports: options.httpPort || 80,
domains
},
name: `HTTP to HTTPS Redirect for ${Array.isArray(domains) ? domains.join(', ') : domains}`
}
);
return [httpsRoute, httpRedirectRoute];
}
@@ -1,62 +0,0 @@
/**
* Route Helper Functions
*
* This module provides utility functions for creating route configurations for common scenarios.
* These functions aim to simplify the creation of route configurations for typical use cases.
*
* This barrel file re-exports all helper functions for backwards compatibility.
*/
// HTTP helpers
export { createHttpRoute } from './http-helpers.js';
// HTTPS helpers
export {
createHttpsTerminateRoute,
createHttpToHttpsRedirect,
createHttpsPassthroughRoute,
createCompleteHttpsServer
} from './https-helpers.js';
// WebSocket helpers
export { createWebSocketRoute } from './websocket-helpers.js';
// Load balancer helpers
export {
createLoadBalancerRoute,
createSmartLoadBalancer
} from './load-balancer-helpers.js';
// NFTables helpers
export {
createNfTablesRoute,
createNfTablesTerminateRoute,
createCompleteNfTablesHttpsServer
} from './nftables-helpers.js';
// Dynamic routing helpers
export {
createPortOffset,
createPortMappingRoute,
createOffsetPortMappingRoute,
createDynamicRoute
} from './dynamic-helpers.js';
// API helpers
export {
createApiRoute,
createApiGatewayRoute
} from './api-helpers.js';
// Security helpers
export {
addRateLimiting,
addBasicAuth,
addJwtAuth
} from './security-helpers.js';
// Socket handlers
export {
SocketHandlers,
createSocketHandlerRoute
} from './socket-handlers.js';
@@ -1,154 +0,0 @@
/**
* Load Balancer Route Helper Functions
*
* This module provides utility functions for creating load balancer route configurations.
*/
import type { IRouteConfig, IRouteMatch, IRouteAction, IRouteTarget, TPortRange, IRouteContext } from '../../models/route-types.js';
/**
* Create a load balancer route (round-robin between multiple backend hosts)
* @param domains Domain(s) to match
* @param backendsOrHosts Array of backend servers OR array of host strings (legacy)
* @param portOrOptions Port number (legacy) OR options object
* @param options Additional route options (legacy)
* @returns Route configuration object
*/
export function createLoadBalancerRoute(
domains: string | string[],
backendsOrHosts: Array<{ host: string; port: number }> | string[],
portOrOptions?: number | {
tls?: {
mode: 'passthrough' | 'terminate' | 'terminate-and-reencrypt';
certificate?: 'auto' | { key: string; cert: string };
};
useTls?: boolean;
certificate?: 'auto' | { key: string; cert: string };
algorithm?: 'round-robin' | 'least-connections' | 'ip-hash';
healthCheck?: {
path: string;
interval: number;
timeout: number;
unhealthyThreshold: number;
healthyThreshold: number;
};
[key: string]: any;
},
options?: {
tls?: {
mode: 'passthrough' | 'terminate' | 'terminate-and-reencrypt';
certificate?: 'auto' | { key: string; cert: string };
};
[key: string]: any;
}
): IRouteConfig {
// Handle legacy signature: (domains, hosts[], port, options)
let backends: Array<{ host: string; port: number }>;
let finalOptions: any;
if (Array.isArray(backendsOrHosts) && backendsOrHosts.length > 0 && typeof backendsOrHosts[0] === 'string') {
// Legacy signature
const hosts = backendsOrHosts as string[];
const port = portOrOptions as number;
backends = hosts.map(host => ({ host, port }));
finalOptions = options || {};
} else {
// New signature
backends = backendsOrHosts as Array<{ host: string; port: number }>;
finalOptions = (portOrOptions as any) || {};
}
// Extract hosts and ensure all backends use the same port
const port = backends[0].port;
const hosts = backends.map(backend => backend.host);
// Create route match
const match: IRouteMatch = {
ports: finalOptions.match?.ports || (finalOptions.tls || finalOptions.useTls ? 443 : 80),
domains
};
// Create route target
const target: IRouteTarget = {
host: hosts,
port
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [target]
};
// Add TLS configuration if provided
if (finalOptions.tls || finalOptions.useTls) {
action.tls = {
mode: finalOptions.tls?.mode || 'terminate',
certificate: finalOptions.tls?.certificate || finalOptions.certificate || 'auto'
};
}
// Add load balancing options
if (finalOptions.algorithm || finalOptions.healthCheck) {
action.loadBalancing = {
algorithm: finalOptions.algorithm || 'round-robin',
healthCheck: finalOptions.healthCheck
};
}
// Create the route config
return {
match,
action,
name: finalOptions.name || `Load Balancer for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
...finalOptions
};
}
/**
* Create a smart load balancer with dynamic domain-based backend selection
* @param options Smart load balancer options
* @returns Route configuration object
*/
export function createSmartLoadBalancer(options: {
ports: TPortRange;
domainTargets: Record<string, string | string[]>;
portMapper: (context: IRouteContext) => number;
name?: string;
defaultTarget?: string | string[];
priority?: number;
[key: string]: any;
}): IRouteConfig {
// Extract all domain keys to create the match criteria
const domains = Object.keys(options.domainTargets);
// Create the smart host selector function
const hostSelector = (context: IRouteContext) => {
const domain = context.domain || '';
return options.domainTargets[domain] || options.defaultTarget || 'localhost';
};
// Create route match
const match: IRouteMatch = {
ports: options.ports,
domains
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [{
host: hostSelector,
port: options.portMapper
}]
};
// Create the route config
return {
match,
action,
name: options.name || `Smart Load Balancer for ${domains.join(', ')}`,
priority: options.priority,
...options
};
}
@@ -1,202 +0,0 @@
/**
* NFTables Route Helper Functions
*
* This module provides utility functions for creating NFTables-based route configurations
* for high-performance packet forwarding at the kernel level.
*/
import type { IRouteConfig, IRouteMatch, IRouteAction, TPortRange } from '../../models/route-types.js';
import { createHttpToHttpsRedirect } from './https-helpers.js';
/**
* Create an NFTables-based route for high-performance packet forwarding
* @param nameOrDomains Name or domain(s) to match
* @param target Target host and port
* @param options Additional route options
* @returns Route configuration object
*/
export function createNfTablesRoute(
nameOrDomains: string | string[],
target: { host: string; port: number | 'preserve' },
options: {
ports?: TPortRange;
protocol?: 'tcp' | 'udp' | 'all';
preserveSourceIP?: boolean;
ipAllowList?: string[];
ipBlockList?: string[];
maxRate?: string;
priority?: number;
useTls?: boolean;
tableName?: string;
useIPSets?: boolean;
useAdvancedNAT?: boolean;
} = {}
): IRouteConfig {
// Determine if this is a name or domain
let name: string;
let domains: string | string[] | undefined;
if (Array.isArray(nameOrDomains) || (typeof nameOrDomains === 'string' && nameOrDomains.includes('.'))) {
domains = nameOrDomains;
name = Array.isArray(nameOrDomains) ? nameOrDomains[0] : nameOrDomains;
} else {
name = nameOrDomains;
domains = undefined; // No domains
}
// Create route match
const match: IRouteMatch = {
domains,
ports: options.ports || 80
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [{
host: target.host,
port: target.port
}],
forwardingEngine: 'nftables',
nftables: {
protocol: options.protocol || 'tcp',
preserveSourceIP: options.preserveSourceIP,
maxRate: options.maxRate,
priority: options.priority,
tableName: options.tableName,
useIPSets: options.useIPSets,
useAdvancedNAT: options.useAdvancedNAT
}
};
// Add TLS options if needed
if (options.useTls) {
action.tls = {
mode: 'passthrough'
};
}
// Create the route config
const routeConfig: IRouteConfig = {
name,
match,
action
};
// Add security if allowed or blocked IPs are specified
if (options.ipAllowList?.length || options.ipBlockList?.length) {
routeConfig.security = {
ipAllowList: options.ipAllowList,
ipBlockList: options.ipBlockList
};
}
return routeConfig;
}
/**
* Create an NFTables-based TLS termination route
* @param nameOrDomains Name or domain(s) to match
* @param target Target host and port
* @param options Additional route options
* @returns Route configuration object
*/
export function createNfTablesTerminateRoute(
nameOrDomains: string | string[],
target: { host: string; port: number | 'preserve' },
options: {
ports?: TPortRange;
protocol?: 'tcp' | 'udp' | 'all';
preserveSourceIP?: boolean;
ipAllowList?: string[];
ipBlockList?: string[];
maxRate?: string;
priority?: number;
tableName?: string;
useIPSets?: boolean;
useAdvancedNAT?: boolean;
certificate?: 'auto' | { key: string; cert: string };
} = {}
): IRouteConfig {
// Create basic NFTables route
const route = createNfTablesRoute(
nameOrDomains,
target,
{
...options,
ports: options.ports || 443,
useTls: false
}
);
// Set TLS termination
route.action.tls = {
mode: 'terminate',
certificate: options.certificate || 'auto'
};
return route;
}
/**
* Create a complete NFTables-based HTTPS setup with HTTP redirect
* @param nameOrDomains Name or domain(s) to match
* @param target Target host and port
* @param options Additional route options
* @returns Array of two route configurations (HTTPS and HTTP redirect)
*/
export function createCompleteNfTablesHttpsServer(
nameOrDomains: string | string[],
target: { host: string; port: number | 'preserve' },
options: {
httpPort?: TPortRange;
httpsPort?: TPortRange;
protocol?: 'tcp' | 'udp' | 'all';
preserveSourceIP?: boolean;
ipAllowList?: string[];
ipBlockList?: string[];
maxRate?: string;
priority?: number;
tableName?: string;
useIPSets?: boolean;
useAdvancedNAT?: boolean;
certificate?: 'auto' | { key: string; cert: string };
} = {}
): IRouteConfig[] {
// Create the HTTPS route using NFTables
const httpsRoute = createNfTablesTerminateRoute(
nameOrDomains,
target,
{
...options,
ports: options.httpsPort || 443
}
);
// Determine the domain(s) for HTTP redirect
const domains = typeof nameOrDomains === 'string' && !nameOrDomains.includes('.')
? undefined
: nameOrDomains;
// Extract the HTTPS port for the redirect destination
const httpsPort = typeof options.httpsPort === 'number'
? options.httpsPort
: Array.isArray(options.httpsPort) && typeof options.httpsPort[0] === 'number'
? options.httpsPort[0]
: 443;
// Create the HTTP redirect route (this uses standard forwarding, not NFTables)
const httpRedirectRoute = createHttpToHttpsRedirect(
domains as any, // Type cast needed since domains can be undefined now
httpsPort,
{
match: {
ports: options.httpPort || 80,
domains: domains as any // Type cast needed since domains can be undefined now
},
name: `HTTP to HTTPS Redirect for ${Array.isArray(domains) ? domains.join(', ') : domains || 'all domains'}`
}
);
return [httpsRoute, httpRedirectRoute];
}
@@ -1,96 +0,0 @@
/**
* Security Route Helper Functions
*
* This module provides utility functions for adding security features to routes.
*/
import type { IRouteConfig } from '../../models/route-types.js';
import { mergeRouteConfigs } from '../route-utils.js';
/**
* Create a rate limiting route pattern
* @param baseRoute Base route to add rate limiting to
* @param rateLimit Rate limiting configuration
* @returns Route with rate limiting
*/
export function addRateLimiting(
baseRoute: IRouteConfig,
rateLimit: {
maxRequests: number;
window: number; // Time window in seconds
keyBy?: 'ip' | 'path' | 'header';
headerName?: string; // Required if keyBy is 'header'
errorMessage?: string;
}
): IRouteConfig {
return mergeRouteConfigs(baseRoute, {
security: {
rateLimit: {
enabled: true,
maxRequests: rateLimit.maxRequests,
window: rateLimit.window,
keyBy: rateLimit.keyBy || 'ip',
headerName: rateLimit.headerName,
errorMessage: rateLimit.errorMessage || 'Rate limit exceeded. Please try again later.'
}
}
});
}
/**
* Create a basic authentication route pattern
* @param baseRoute Base route to add authentication to
* @param auth Authentication configuration
* @returns Route with basic authentication
*/
export function addBasicAuth(
baseRoute: IRouteConfig,
auth: {
users: Array<{ username: string; password: string }>;
realm?: string;
excludePaths?: string[];
}
): IRouteConfig {
return mergeRouteConfigs(baseRoute, {
security: {
basicAuth: {
enabled: true,
users: auth.users,
realm: auth.realm || 'Restricted Area',
excludePaths: auth.excludePaths || []
}
}
});
}
/**
* Create a JWT authentication route pattern
* @param baseRoute Base route to add JWT authentication to
* @param jwt JWT authentication configuration
* @returns Route with JWT authentication
*/
export function addJwtAuth(
baseRoute: IRouteConfig,
jwt: {
secret: string;
algorithm?: string;
issuer?: string;
audience?: string;
expiresIn?: number; // Time in seconds
excludePaths?: string[];
}
): IRouteConfig {
return mergeRouteConfigs(baseRoute, {
security: {
jwtAuth: {
enabled: true,
secret: jwt.secret,
algorithm: jwt.algorithm || 'HS256',
issuer: jwt.issuer,
audience: jwt.audience,
expiresIn: jwt.expiresIn,
excludePaths: jwt.excludePaths || []
}
}
});
}
@@ -1,98 +0,0 @@
/**
* WebSocket Route Helper Functions
*
* This module provides utility functions for creating WebSocket route configurations.
*/
import type { IRouteConfig, IRouteMatch, IRouteAction } from '../../models/route-types.js';
/**
* Create a WebSocket route configuration
* @param domains Domain(s) to match
* @param targetOrPath Target server OR WebSocket path (legacy)
* @param targetOrOptions Target server (legacy) OR options
* @param options Additional route options (legacy)
* @returns Route configuration object
*/
export function createWebSocketRoute(
domains: string | string[],
targetOrPath: { host: string | string[]; port: number } | string,
targetOrOptions?: { host: string | string[]; port: number } | {
useTls?: boolean;
certificate?: 'auto' | { key: string; cert: string };
path?: string;
httpPort?: number | number[];
httpsPort?: number | number[];
pingInterval?: number;
pingTimeout?: number;
name?: string;
[key: string]: any;
},
options?: {
useTls?: boolean;
certificate?: 'auto' | { key: string; cert: string };
httpPort?: number | number[];
httpsPort?: number | number[];
pingInterval?: number;
pingTimeout?: number;
name?: string;
[key: string]: any;
}
): IRouteConfig {
// Handle different signatures
let target: { host: string | string[]; port: number };
let wsPath: string;
let finalOptions: any;
if (typeof targetOrPath === 'string') {
// Legacy signature: (domains, path, target, options)
wsPath = targetOrPath;
target = targetOrOptions as { host: string | string[]; port: number };
finalOptions = options || {};
} else {
// New signature: (domains, target, options)
target = targetOrPath;
finalOptions = (targetOrOptions as any) || {};
wsPath = finalOptions.path || '/ws';
}
// Normalize WebSocket path
const normalizedPath = wsPath.startsWith('/') ? wsPath : `/${wsPath}`;
// Create route match
const match: IRouteMatch = {
ports: finalOptions.useTls
? (finalOptions.httpsPort || 443)
: (finalOptions.httpPort || 80),
domains,
path: normalizedPath
};
// Create route action
const action: IRouteAction = {
type: 'forward',
targets: [target],
websocket: {
enabled: true,
pingInterval: finalOptions.pingInterval || 30000, // 30 seconds
pingTimeout: finalOptions.pingTimeout || 5000 // 5 seconds
}
};
// Add TLS configuration if using HTTPS
if (finalOptions.useTls) {
action.tls = {
mode: 'terminate',
certificate: finalOptions.certificate || 'auto'
};
}
// Create the route config
return {
match,
action,
name: finalOptions.name || `WebSocket Route ${normalizedPath} for ${Array.isArray(domains) ? domains.join(', ') : domains}`,
priority: finalOptions.priority || 100, // Higher priority for WebSocket routes
...finalOptions
};
}
+22 -8
View File
@@ -168,14 +168,28 @@ export function routeMatchesHeaders(
if (!route.match?.headers || Object.keys(route.match.headers).length === 0) { if (!route.match?.headers || Object.keys(route.match.headers).length === 0) {
return true; // No headers specified means it matches any headers return true; // No headers specified means it matches any headers
} }
// Convert RegExp patterns to strings for HeaderMatcher for (const [headerName, expectedValue] of Object.entries(route.match.headers)) {
const stringHeaders: Record<string, string> = {}; const actualKey = Object.keys(headers).find((key) => key.toLowerCase() === headerName.toLowerCase());
for (const [key, value] of Object.entries(route.match.headers)) { const actualValue = actualKey ? headers[actualKey] : undefined;
stringHeaders[key] = value instanceof RegExp ? value.source : value;
if (actualValue === undefined) {
return false;
}
if (expectedValue instanceof RegExp) {
if (!expectedValue.test(actualValue)) {
return false;
}
continue;
}
if (!HeaderMatcher.match(expectedValue, actualValue)) {
return false;
}
} }
return HeaderMatcher.matchAll(stringHeaders, headers); return true;
} }
/** /**
@@ -283,4 +297,4 @@ export function generateRouteId(route: IRouteConfig): string {
*/ */
export function cloneRoute(route: IRouteConfig): IRouteConfig { export function cloneRoute(route: IRouteConfig): IRouteConfig {
return JSON.parse(JSON.stringify(route)); return JSON.parse(JSON.stringify(route));
} }
@@ -196,10 +196,19 @@ export class RouteValidator {
// Validate IP allow/block lists // Validate IP allow/block lists
if (route.security.ipAllowList) { if (route.security.ipAllowList) {
const allowList = Array.isArray(route.security.ipAllowList) ? route.security.ipAllowList : [route.security.ipAllowList]; const allowList = Array.isArray(route.security.ipAllowList) ? route.security.ipAllowList : [route.security.ipAllowList];
for (const ip of allowList) { for (const entry of allowList) {
if (!this.isValidIPPattern(ip)) { if (typeof entry === 'string') {
errors.push(`Invalid IP pattern in allow list: ${ip}`); if (!this.isValidIPPattern(entry)) {
errors.push(`Invalid IP pattern in allow list: ${entry}`);
}
} else if (entry && typeof entry === 'object') {
if (!this.isValidIPPattern(entry.ip)) {
errors.push(`Invalid IP pattern in domain-scoped allow entry: ${entry.ip}`);
}
if (!Array.isArray(entry.domains) || entry.domains.length === 0) {
errors.push(`Domain-scoped allow entry for ${entry.ip} must have non-empty domains array`);
}
} }
} }
} }
@@ -258,7 +267,9 @@ export class RouteValidator {
errorMap.set(route.name, existingErrors); errorMap.set(route.name, existingErrors);
valid = false; valid = false;
} }
routeNames.add(route.name); if (route.name) {
routeNames.add(route.name);
}
} }
// Validate each route // Validate each route
@@ -328,7 +339,7 @@ export class RouteValidator {
if (catchAllRoutes.length > 1) { if (catchAllRoutes.length > 1) {
for (const route of catchAllRoutes) { for (const route of catchAllRoutes) {
conflicts.push({ conflicts.push({
route: route.name, route: route.name || 'unnamed',
message: `Multiple catch-all routes on port ${port}` message: `Multiple catch-all routes on port ${port}`
}); });
} }
+187
View File
@@ -0,0 +1,187 @@
import type { IAcmeOptions, ISmartProxyOptions } from '../models/interfaces.js';
import type { IRouteAction, IRouteConfig, IRouteMatch, IRouteTarget, ITargetMatch } from '../models/route-types.js';
import type {
IRustAcmeOptions,
IRustDefaultConfig,
IRustProxyOptions,
IRustRouteAction,
IRustRouteConfig,
IRustRouteMatch,
IRustRouteTarget,
IRustTargetMatch,
IRustRouteUdp,
TRustHeaderMatchers,
} from '../models/rust-types.js';
const SUPPORTED_REGEX_FLAGS = new Set(['i', 'm', 's', 'u', 'g']);
export function serializeHeaderMatchValue(value: string | RegExp): string {
if (typeof value === 'string') {
return value;
}
const unsupportedFlags = Array.from(new Set(value.flags)).filter((flag) => !SUPPORTED_REGEX_FLAGS.has(flag));
if (unsupportedFlags.length > 0) {
throw new Error(
`Header RegExp uses unsupported flags for Rust serialization: ${unsupportedFlags.join(', ')}`
);
}
return `/${value.source}/${value.flags}`;
}
export function serializeHeaderMatchers(headers?: Record<string, string | RegExp>): TRustHeaderMatchers | undefined {
if (!headers) {
return undefined;
}
return Object.fromEntries(
Object.entries(headers).map(([key, value]) => [key, serializeHeaderMatchValue(value)])
);
}
export function serializeTargetMatchForRust(match?: ITargetMatch): IRustTargetMatch | undefined {
if (!match) {
return undefined;
}
return {
...match,
headers: serializeHeaderMatchers(match.headers),
};
}
export function serializeRouteMatchForRust(match: IRouteMatch): IRustRouteMatch {
return {
...match,
headers: serializeHeaderMatchers(match.headers),
};
}
export function serializeRouteTargetForRust(target: IRouteTarget): IRustRouteTarget {
if (typeof target.host !== 'string' && !Array.isArray(target.host)) {
throw new Error('Route target host must be serialized before sending to Rust');
}
if (typeof target.port !== 'number' && target.port !== 'preserve') {
throw new Error('Route target port must be serialized before sending to Rust');
}
return {
...target,
host: target.host,
port: target.port,
match: serializeTargetMatchForRust(target.match),
};
}
function serializeUdpForRust(udp?: IRouteAction['udp']): IRustRouteUdp | undefined {
if (!udp) {
return undefined;
}
const { maxSessionsPerIP, ...rest } = udp;
return {
...rest,
maxSessionsPerIp: maxSessionsPerIP,
};
}
export function serializeRouteActionForRust(action: IRouteAction): IRustRouteAction {
const {
socketHandler: _socketHandler,
datagramHandler: _datagramHandler,
forwardingEngine: _forwardingEngine,
nftables: _nftables,
targets,
udp,
...rest
} = action;
return {
...rest,
targets: targets?.map((target) => serializeRouteTargetForRust(target)),
udp: serializeUdpForRust(udp),
};
}
export function serializeRouteForRust(route: IRouteConfig): IRustRouteConfig {
return {
...route,
match: serializeRouteMatchForRust(route.match),
action: serializeRouteActionForRust(route.action),
};
}
function serializeAcmeForRust(acme?: IAcmeOptions): IRustAcmeOptions | undefined {
if (!acme) {
return undefined;
}
return {
enabled: acme.enabled,
email: acme.email,
environment: acme.environment,
accountEmail: acme.accountEmail,
port: acme.port,
useProduction: acme.useProduction,
renewThresholdDays: acme.renewThresholdDays,
autoRenew: acme.autoRenew,
skipConfiguredCerts: acme.skipConfiguredCerts,
renewCheckIntervalHours: acme.renewCheckIntervalHours,
};
}
function serializeDefaultsForRust(defaults?: ISmartProxyOptions['defaults']): IRustDefaultConfig | undefined {
if (!defaults) {
return undefined;
}
const { preserveSourceIP, ...rest } = defaults;
return {
...rest,
preserveSourceIp: preserveSourceIP,
};
}
export function buildRustProxyOptions(
settings: ISmartProxyOptions,
routes: IRustRouteConfig[],
acmeOverride?: IAcmeOptions,
): IRustProxyOptions {
const acme = acmeOverride !== undefined ? acmeOverride : settings.acme;
return {
routes,
preserveSourceIp: settings.preserveSourceIP,
proxyIps: settings.proxyIPs,
acceptProxyProtocol: settings.acceptProxyProtocol,
sendProxyProtocol: settings.sendProxyProtocol,
defaults: serializeDefaultsForRust(settings.defaults),
connectionTimeout: settings.connectionTimeout,
initialDataTimeout: settings.initialDataTimeout,
socketTimeout: settings.socketTimeout,
inactivityCheckInterval: settings.inactivityCheckInterval,
maxConnectionLifetime: settings.maxConnectionLifetime,
inactivityTimeout: settings.inactivityTimeout,
gracefulShutdownTimeout: settings.gracefulShutdownTimeout,
noDelay: settings.noDelay,
keepAlive: settings.keepAlive,
keepAliveInitialDelay: settings.keepAliveInitialDelay,
maxPendingDataSize: settings.maxPendingDataSize,
disableInactivityCheck: settings.disableInactivityCheck,
enableKeepAliveProbes: settings.enableKeepAliveProbes,
enableDetailedLogging: settings.enableDetailedLogging,
enableTlsDebugLogging: settings.enableTlsDebugLogging,
enableRandomizedTimeouts: settings.enableRandomizedTimeouts,
maxConnectionsPerIp: settings.maxConnectionsPerIP,
connectionRateLimitPerMinute: settings.connectionRateLimitPerMinute,
keepAliveTreatment: settings.keepAliveTreatment,
keepAliveInactivityMultiplier: settings.keepAliveInactivityMultiplier,
extendedKeepAliveLifetime: settings.extendedKeepAliveLifetime,
metrics: settings.metrics,
acme: serializeAcmeForRust(acme),
};
}
@@ -5,9 +5,9 @@
* like echoing, proxying, HTTP responses, and redirects. * like echoing, proxying, HTTP responses, and redirects.
*/ */
import * as plugins from '../../../../plugins.js'; import * as plugins from '../../../plugins.js';
import type { IRouteConfig, TPortRange, IRouteContext } from '../../models/route-types.js'; import type { IRouteContext } from '../models/route-types.js';
import { createSocketTracker } from '../../../../core/utils/socket-tracker.js'; import { createSocketTracker } from '../../../core/utils/socket-tracker.js';
/** /**
* Minimal HTTP request parser for socket handlers. * Minimal HTTP request parser for socket handlers.
@@ -308,31 +308,3 @@ export const SocketHandlers = {
}); });
} }
}; };
/**
* Create a socket handler route configuration
*/
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
}
};
}
+1 -5
View File
@@ -1,14 +1,10 @@
{ {
"compilerOptions": { "compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022", "target": "ES2022",
"module": "NodeNext", "module": "NodeNext",
"moduleResolution": "NodeNext", "moduleResolution": "NodeNext",
"esModuleInterop": true, "esModuleInterop": true,
"verbatimModuleSyntax": true, "verbatimModuleSyntax": true
"baseUrl": ".",
"paths": {}
}, },
"exclude": [ "exclude": [
"dist_*/**/*.d.ts" "dist_*/**/*.d.ts"