Skip to content

armgit / umami

Public Imported from GitHub
0

Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.

Fix custom CLIENT_IP_HEADER not parsing x-forwarded-for/forwarded chains

Luca Seemann65b508c22a2b
diff --git a/src/lib/detect.test.ts b/src/lib/detect.test.ts
index 804c84029..8b66e06f7 100644
--- a/src/lib/detect.test.ts
+++ b/src/lib/detect.test.ts
@@ -24,6 +24,14 @@ test('getIpAddress: Custom header', () => {
expect(getIpAddress(new Headers({ 'x-custom-ip-header': IP }))).toEqual(IP);
});
+test('getIpAddress: Custom header set to x-forwarded-for uses leftmost IP in chain', () => {
+ process.env.CLIENT_IP_HEADER = 'x-forwarded-for';
+
+ expect(
+ getIpAddress(new Headers({ 'x-forwarded-for': `${IP}, 10.0.0.1, 10.0.0.2` })),
+ ).toEqual(IP);
+});
+
test('getIpAddress: CloudFlare header', () => {
expect(getIpAddress(new Headers({ 'cf-connecting-ip': IP }))).toEqual(IP);
});
diff --git a/src/lib/ip.ts b/src/lib/ip.ts
index 075a481f5..efe94d09e 100644
--- a/src/lib/ip.ts
+++ b/src/lib/ip.ts
@@ -58,11 +58,25 @@ function resolveIp(ip?: string | null) {
}
}
+function parseHeaderValue(header: string, value: string) {
+ if (header === 'x-forwarded-for') {
+ return resolveIp(value?.split(',')?.[0]?.trim());
+ }
+
+ if (header === 'forwarded') {
+ const match = value.match(/for=(\[?[0-9a-fA-F:.]+]?)/);
+
+ return match ? resolveIp(match[1]) : undefined;
+ }
+
+ return resolveIp(value);
+}
+
export function getIpAddress(headers: Headers) {
const customHeader = process.env.CLIENT_IP_HEADER;
if (customHeader && headers.get(customHeader)) {
- return resolveIp(headers.get(customHeader));
+ return parseHeaderValue(customHeader.toLowerCase(), headers.get(customHeader));
}
const header = IP_ADDRESS_HEADERS.find(name => headers.get(name));
@@ -70,19 +84,7 @@ export function getIpAddress(headers: Headers) {
return undefined;
}
- const ip = headers.get(header);
-
- if (header === 'x-forwarded-for') {
- return resolveIp(ip?.split(',')?.[0]?.trim());
- }
-
- if (header === 'forwarded') {
- const match = ip.match(/for=(\[?[0-9a-fA-F:.]+]?)/);
-
- return match ? resolveIp(match[1]) : undefined;
- }
-
- return resolveIp(ip);
+ return parseHeaderValue(header, headers.get(header));
}
export function stripPort(ip?: string | null) {