feat(PortProxy): Add optional source IP preservation support in PortProxy
This commit is contained in:
parent
483cbb3634
commit
ee03224561
@ -1,5 +1,11 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-02-21 - 3.7.0 - feat(PortProxy)
|
||||||
|
Add optional source IP preservation support in PortProxy
|
||||||
|
|
||||||
|
- Added a feature to optionally preserve the client's source IP when proxying connections.
|
||||||
|
- Enhanced test cases to include scenarios for source IP preservation.
|
||||||
|
|
||||||
## 2025-02-21 - 3.6.0 - feat(PortProxy)
|
## 2025-02-21 - 3.6.0 - feat(PortProxy)
|
||||||
Add feature to preserve original client IP through chained proxies
|
Add feature to preserve original client IP through chained proxies
|
||||||
|
|
||||||
|
@ -175,35 +175,66 @@ tap.test('should stop port proxy', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
// Cleanup
|
// Cleanup
|
||||||
tap.test('should preserve client IP through chained proxies', async () => {
|
tap.test('should support optional source IP preservation in chained proxies', async () => {
|
||||||
// Create two proxies in chain
|
// Test 1: Without IP preservation (default behavior)
|
||||||
const firstProxy = new PortProxy({
|
const firstProxyDefault = new PortProxy({
|
||||||
fromPort: PROXY_PORT + 4,
|
fromPort: PROXY_PORT + 4,
|
||||||
toPort: PROXY_PORT + 5, // Point to second proxy
|
toPort: PROXY_PORT + 5,
|
||||||
toHost: 'localhost',
|
toHost: 'localhost',
|
||||||
domains: [],
|
domains: [],
|
||||||
sniEnabled: false,
|
sniEnabled: false,
|
||||||
defaultAllowedIPs: ['127.0.0.1']
|
defaultAllowedIPs: ['127.0.0.1', '::ffff:127.0.0.1']
|
||||||
});
|
});
|
||||||
|
|
||||||
const secondProxy = new PortProxy({
|
const secondProxyDefault = new PortProxy({
|
||||||
fromPort: PROXY_PORT + 5,
|
fromPort: PROXY_PORT + 5,
|
||||||
toPort: TEST_SERVER_PORT,
|
toPort: TEST_SERVER_PORT,
|
||||||
toHost: 'localhost',
|
toHost: 'localhost',
|
||||||
domains: [],
|
domains: [],
|
||||||
sniEnabled: false,
|
sniEnabled: false,
|
||||||
defaultAllowedIPs: ['127.0.0.1']
|
defaultAllowedIPs: ['127.0.0.1', '::ffff:127.0.0.1']
|
||||||
});
|
});
|
||||||
|
|
||||||
await secondProxy.start();
|
await secondProxyDefault.start();
|
||||||
await firstProxy.start();
|
await firstProxyDefault.start();
|
||||||
|
|
||||||
// Connect through the chain
|
// This should work because we explicitly allow both IPv4 and IPv6 formats
|
||||||
const response = await createTestClient(PROXY_PORT + 4, TEST_DATA);
|
const response1 = await createTestClient(PROXY_PORT + 4, TEST_DATA);
|
||||||
expect(response).toEqual(`Echo: ${TEST_DATA}`);
|
expect(response1).toEqual(`Echo: ${TEST_DATA}`);
|
||||||
|
|
||||||
await firstProxy.stop();
|
await firstProxyDefault.stop();
|
||||||
await secondProxy.stop();
|
await secondProxyDefault.stop();
|
||||||
|
|
||||||
|
// Test 2: With IP preservation
|
||||||
|
const firstProxyPreserved = new PortProxy({
|
||||||
|
fromPort: PROXY_PORT + 6,
|
||||||
|
toPort: PROXY_PORT + 7,
|
||||||
|
toHost: 'localhost',
|
||||||
|
domains: [],
|
||||||
|
sniEnabled: false,
|
||||||
|
defaultAllowedIPs: ['127.0.0.1'],
|
||||||
|
preserveSourceIP: true
|
||||||
|
});
|
||||||
|
|
||||||
|
const secondProxyPreserved = new PortProxy({
|
||||||
|
fromPort: PROXY_PORT + 7,
|
||||||
|
toPort: TEST_SERVER_PORT,
|
||||||
|
toHost: 'localhost',
|
||||||
|
domains: [],
|
||||||
|
sniEnabled: false,
|
||||||
|
defaultAllowedIPs: ['127.0.0.1'],
|
||||||
|
preserveSourceIP: true
|
||||||
|
});
|
||||||
|
|
||||||
|
await secondProxyPreserved.start();
|
||||||
|
await firstProxyPreserved.start();
|
||||||
|
|
||||||
|
// This should work with just IPv4 because source IP is preserved
|
||||||
|
const response2 = await createTestClient(PROXY_PORT + 6, TEST_DATA);
|
||||||
|
expect(response2).toEqual(`Echo: ${TEST_DATA}`);
|
||||||
|
|
||||||
|
await firstProxyPreserved.stop();
|
||||||
|
await secondProxyPreserved.stop();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('cleanup port proxy test environment', async () => {
|
tap.test('cleanup port proxy test environment', async () => {
|
||||||
|
@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartproxy',
|
name: '@push.rocks/smartproxy',
|
||||||
version: '3.6.0',
|
version: '3.7.0',
|
||||||
description: 'a proxy for handling high workloads of proxying'
|
description: 'a proxy for handling high workloads of proxying'
|
||||||
}
|
}
|
||||||
|
@ -17,6 +17,7 @@ export interface ProxySettings extends plugins.tls.TlsOptions {
|
|||||||
domains: DomainConfig[];
|
domains: DomainConfig[];
|
||||||
sniEnabled?: boolean;
|
sniEnabled?: boolean;
|
||||||
defaultAllowedIPs?: string[]; // Optional default IP patterns if no matching domain found
|
defaultAllowedIPs?: string[]; // Optional default IP patterns if no matching domain found
|
||||||
|
preserveSourceIP?: boolean; // Whether to preserve the client's source IP when proxying
|
||||||
}
|
}
|
||||||
|
|
||||||
export class PortProxy {
|
export class PortProxy {
|
||||||
@ -123,12 +124,18 @@ export class PortProxy {
|
|||||||
const domainConfig = serverName ? findMatchingDomain(serverName) : undefined;
|
const domainConfig = serverName ? findMatchingDomain(serverName) : undefined;
|
||||||
const targetHost = domainConfig?.targetIP || this.settings.toHost!;
|
const targetHost = domainConfig?.targetIP || this.settings.toHost!;
|
||||||
|
|
||||||
// Create connection with IP binding to preserve original client IP
|
// Create connection, optionally preserving the client's source IP
|
||||||
const to = plugins.net.createConnection({
|
const connectionOptions: plugins.net.NetConnectOpts = {
|
||||||
host: targetHost,
|
host: targetHost,
|
||||||
port: this.settings.toPort,
|
port: this.settings.toPort,
|
||||||
localAddress: remoteIP.replace('::ffff:', ''), // Remove IPv6 mapping if present
|
};
|
||||||
});
|
|
||||||
|
// Only set localAddress if preserveSourceIP is enabled
|
||||||
|
if (this.settings.preserveSourceIP) {
|
||||||
|
connectionOptions.localAddress = remoteIP.replace('::ffff:', ''); // Remove IPv6 mapping if present
|
||||||
|
}
|
||||||
|
|
||||||
|
const to = plugins.net.createConnection(connectionOptions);
|
||||||
console.log(`Connection established: ${remoteIP} -> ${targetHost}:${this.settings.toPort}${serverName ? ` (SNI: ${serverName})` : ''}`);
|
console.log(`Connection established: ${remoteIP} -> ${targetHost}:${this.settings.toPort}${serverName ? ` (SNI: ${serverName})` : ''}`);
|
||||||
from.setTimeout(120000);
|
from.setTimeout(120000);
|
||||||
from.pipe(to);
|
from.pipe(to);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user