feat(net): trusted-proxy depth so real client IPs survive a proxy — #2453
Fixes the defect the operator spotted in #370 immediately after it shipped: auth.ClientIP ignored X-Forwarded-For whenever RemoteAddr was public, so a proxy on a public address — a separate host, or a CDN, i.e. anyone running this publicly, since public means TLS means a proxy — recorded the PROXY for every session. created_ip and last_ip were then always equal and the "Address changed" signal could never fire. The feature looked like it worked and reported nothing. Replaced with the standard trusted-hop model (Rails, Caddy, Traefik, nginx). XFF grows left-to-right as each proxy appends the peer it received from, so for client -> CDN -> own-proxy -> app the app sees [client, CDN] with RemoteAddr = own-proxy, and the client sits at XFF[len - hops]: 0 RemoteAddr, XFF ignored — no proxy 1 the address your own proxy observed 2 through a CDN in front of your proxy Default 1, per the operator: publicly reachable means a TLS terminator in front. The cost is real and stated rather than hidden. hops >= 1 DECLARES that a proxy exists; set it with no proxy, or deeper than the actual chain, and the index reaches attacker-supplied entries, letting a visitor choose which address their own session shows — defeating exactly the detection #370 is for. That's inherent to the model, which is why 0 is a first-class value and the admin card says "count your proxies, don't guess high" instead of just exposing a number. Both mis-set shapes are pinned by tests so they stay known consequences rather than surprises. Migration 0053 + internal/netsettings, cached under an RWMutex. That's not an optimisation: ClientIP runs in RequireUser for every authenticated request, so a per-request query would put the database on the critical path of the whole API. New() always returns a usable service so a boot-time DB hiccup degrades to the default instead of breaking that path (rule #131), and Hops() is nil-safe because test routers construct middleware without it. RequireUser now takes a func() int rather than an int — the value is operator-editable at runtime while the middleware is built once at boot, and reading it per request is what makes a save take effect with no restart (rule #25). The admin card is verifiable, not just configurable: it reports the address the CURRENT setting resolves THIS request to, the raw forwarded chain, and the socket peer — so you set the number, save, and confirm the address matches the machine you're on. It also counts the arriving chain and says how many proxies that implies. GET/PUT both return that payload, PUT recomputed under the new value, so the effect is visible without a reload. Also fixes styling in the #370 card that CI could not catch: text-destructive and bg-destructive don't exist in this Tailwind config — the palette is colors.action.destructive — so the "Address changed" warning and the sign-out-others button were rendering unstyled. Both now use text-action-destructive / bg-action-destructive / text-action-fg. Not done here: requestlog.go still logs raw RemoteAddr and will disagree with the sessions UI about who connected. Left for its own change.
This commit is contained in:
@@ -0,0 +1,106 @@
|
||||
import { describe, expect, test, vi, beforeEach } from 'vitest';
|
||||
import { render, screen, fireEvent, waitFor } from '@testing-library/svelte';
|
||||
import NetworkSettingsCard from './NetworkSettingsCard.svelte';
|
||||
|
||||
const getNetworkSettings = vi.fn();
|
||||
const updateNetworkSettings = vi.fn();
|
||||
|
||||
vi.mock('$lib/api/admin', () => ({
|
||||
getNetworkSettings: () => getNetworkSettings(),
|
||||
updateNetworkSettings: (hops: number) => updateNetworkSettings(hops)
|
||||
}));
|
||||
|
||||
vi.mock('$lib/stores/toast.svelte', () => ({ pushToast: vi.fn() }));
|
||||
|
||||
function settings(over: Record<string, unknown> = {}) {
|
||||
return {
|
||||
trusted_proxy_hops: 1,
|
||||
max_hops: 10,
|
||||
detected_client_ip: '198.51.100.7',
|
||||
forwarded_chain: '198.51.100.7',
|
||||
remote_addr: '172.18.0.1:40000',
|
||||
...over
|
||||
};
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe('NetworkSettingsCard', () => {
|
||||
// The detected address is the card's verification affordance — the number
|
||||
// is abstract, this is checkable against the machine you're sitting at.
|
||||
test('shows the address the current setting resolves to', async () => {
|
||||
getNetworkSettings.mockResolvedValue(settings());
|
||||
render(NetworkSettingsCard);
|
||||
|
||||
expect(await screen.findByText('198.51.100.7')).toBeTruthy();
|
||||
expect(screen.getByText('172.18.0.1:40000')).toBeTruthy();
|
||||
});
|
||||
|
||||
test('save is inert until the value actually changes', async () => {
|
||||
getNetworkSettings.mockResolvedValue(settings({ trusted_proxy_hops: 1 }));
|
||||
render(NetworkSettingsCard);
|
||||
|
||||
const save = await screen.findByRole('button', { name: /Save/ });
|
||||
expect(save).toBeDisabled();
|
||||
|
||||
const input = screen.getByRole('spinbutton');
|
||||
await fireEvent.input(input, { target: { value: '2' } });
|
||||
await waitFor(() => expect(save).not.toBeDisabled());
|
||||
});
|
||||
|
||||
test('saving sends the new depth and adopts the echoed value', async () => {
|
||||
getNetworkSettings.mockResolvedValue(settings({ trusted_proxy_hops: 1 }));
|
||||
updateNetworkSettings.mockResolvedValue(
|
||||
settings({ trusted_proxy_hops: 2, detected_client_ip: '203.0.113.9' })
|
||||
);
|
||||
render(NetworkSettingsCard);
|
||||
|
||||
const input = await screen.findByRole('spinbutton');
|
||||
await fireEvent.input(input, { target: { value: '2' } });
|
||||
await fireEvent.click(screen.getByRole('button', { name: /Save/ }));
|
||||
|
||||
await waitFor(() => expect(updateNetworkSettings).toHaveBeenCalledWith(2));
|
||||
// The recomputed address proves the change took effect on this request.
|
||||
expect(await screen.findByText('203.0.113.9')).toBeTruthy();
|
||||
});
|
||||
|
||||
// Counting proxies is the operator's job and the hint is how they do it
|
||||
// without guessing.
|
||||
test('hints the likely depth when it disagrees with the arriving chain', async () => {
|
||||
getNetworkSettings.mockResolvedValue(
|
||||
settings({ trusted_proxy_hops: 1, forwarded_chain: '198.51.100.7, 203.0.113.50' })
|
||||
);
|
||||
render(NetworkSettingsCard);
|
||||
|
||||
expect(await screen.findByText(/arrived with 2 forwarded addresses/)).toBeTruthy();
|
||||
});
|
||||
|
||||
test('no hint when the setting already matches the chain length', async () => {
|
||||
getNetworkSettings.mockResolvedValue(
|
||||
settings({ trusted_proxy_hops: 1, forwarded_chain: '198.51.100.7' })
|
||||
);
|
||||
render(NetworkSettingsCard);
|
||||
|
||||
await screen.findByText('198.51.100.7');
|
||||
expect(screen.queryByText(/arrived with/)).toBeNull();
|
||||
});
|
||||
|
||||
test('states the mis-set risk rather than only exposing a number', async () => {
|
||||
getNetworkSettings.mockResolvedValue(settings());
|
||||
render(NetworkSettingsCard);
|
||||
|
||||
expect(await screen.findByText(/Count your proxies/)).toBeTruthy();
|
||||
});
|
||||
|
||||
test('offers a retry when loading fails', async () => {
|
||||
getNetworkSettings.mockRejectedValue(new Error('boom'));
|
||||
render(NetworkSettingsCard);
|
||||
|
||||
const retry = await screen.findByRole('button', { name: 'Try again' });
|
||||
getNetworkSettings.mockResolvedValue(settings());
|
||||
await fireEvent.click(retry);
|
||||
await screen.findByText('198.51.100.7');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user