@directus/api/dist/utils/get-ip-from-req.js

Directus is a real-time API and App dashboard for managing SQL database content

import { useLogger } from "../logger/index.js";
import { useEnv } from "@directus/env";
import { isIP } from "net";
import proxyAddr from "proxy-addr";

//#region src/utils/get-ip-from-req.ts
const IP_HEADER_WARNING_EXCLUDED_PATHS = new Set(["/server/ping", "/server/info"]);
function getReqPathname(req) {
	const rawUrl = "originalUrl" in req && req.originalUrl || req.url || "";
	try {
		return new URL(rawUrl, "http://localhost").pathname.toLowerCase();
	} catch {
		return "";
	}
}
/**
* Generate the trusted ip list
*
* Adapted to have feature parity with the express equivalent https://github.com/expressjs/express/blob/9f4dbe3a1332cd883069ba9b73a9eed99234cfc7/lib/utils.js#L192
*/
function getTrustValue(trust) {
	if (typeof trust === "boolean") return (_addr, _i) => trust;
	else if (typeof trust === "number") return (_addr, i) => i < trust;
	else if (typeof trust === "string") trust = trust.split(",").map((v) => v.trim());
	return proxyAddr.compile(trust || []);
}
function getIPFromReq(req) {
	const env = useEnv();
	const logger = useLogger();
	let ip = "ip" in req ? req.ip : proxyAddr(req, getTrustValue(env["IP_TRUST_PROXY"]));
	if (env["IP_CUSTOM_HEADER"]) {
		const customIPHeaderName = env["IP_CUSTOM_HEADER"].toLowerCase();
		let customIPHeaderValue = req.headers[customIPHeaderName];
		if (customIPHeaderName === "referer" || customIPHeaderName === "referrer") customIPHeaderValue = req.headers["referrer"] || req.headers["referer"];
		if (typeof customIPHeaderValue === "string" && isIP(customIPHeaderValue) !== 0) ip = customIPHeaderValue;
		else if (!IP_HEADER_WARNING_EXCLUDED_PATHS.has(getReqPathname(req))) logger.warn(`Custom IP header didn't return valid IP address: ${JSON.stringify(customIPHeaderValue)}`);
	}
	return ip?.startsWith("::ffff:") ? ip.substring(7) : ip ?? null;
}

//#endregion
export { getIPFromReq, getTrustValue };