mirror of
https://github.com/outline/outline.git
synced 2026-11-21 13:34:02 +03:00
104 lines
2.7 KiB
TypeScript
104 lines
2.7 KiB
TypeScript
import dns from "node:dns";
|
|
import net from "node:net";
|
|
import ipaddr from "ipaddr.js";
|
|
import { randomString } from "@shared/random";
|
|
import env from "@server/env";
|
|
import { InvalidRequestError } from "@server/errors";
|
|
|
|
const UrlIdLength = 10;
|
|
|
|
/** IP ranges that are not allowed for outbound requests. */
|
|
const privateRanges = new Set([
|
|
"private",
|
|
"loopback",
|
|
"linkLocal",
|
|
"uniqueLocal",
|
|
"unspecified",
|
|
]);
|
|
|
|
export const generateUrlId = () => randomString(UrlIdLength);
|
|
|
|
/**
|
|
* Checks if an IP address is private, loopback, or link-local.
|
|
*
|
|
* @param ip - The IP address to check.
|
|
* @returns true if the IP is private.
|
|
*/
|
|
export function isPrivateIP(ip: string): boolean {
|
|
if (!ipaddr.isValid(ip)) {
|
|
return false;
|
|
}
|
|
return privateRanges.has(ipaddr.parse(ip).range());
|
|
}
|
|
|
|
/**
|
|
* Checks whether an IP address is present in the allowed private IP list,
|
|
* supporting both exact matches and CIDR ranges.
|
|
*
|
|
* @param ip - the IP address to check.
|
|
* @returns true if the IP is explicitly allowed.
|
|
*/
|
|
function isAllowedPrivateIP(ip: string): boolean {
|
|
const allowList = env.ALLOWED_PRIVATE_IP_ADDRESSES;
|
|
if (!allowList || allowList.length === 0) {
|
|
return false;
|
|
}
|
|
|
|
if (!ipaddr.isValid(ip)) {
|
|
return false;
|
|
}
|
|
|
|
const addr = ipaddr.parse(ip);
|
|
|
|
for (const entry of allowList) {
|
|
if (net.isIP(entry)) {
|
|
if (entry === ip) {
|
|
return true;
|
|
}
|
|
} else if (ipaddr.isValid(entry.split("/")[0])) {
|
|
try {
|
|
if (addr.match(ipaddr.parseCIDR(entry))) {
|
|
return true;
|
|
}
|
|
} catch {
|
|
// Skip invalid CIDR entries
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Validates that a URL does not resolve to a private or internal IP address.
|
|
* Respects the ALLOWED_PRIVATE_IP_ADDRESSES environment variable.
|
|
*
|
|
* @param url - the URL to validate.
|
|
* @throws InternalError if the URL resolves to a private IP that is not allowed.
|
|
*/
|
|
export async function validateUrlNotPrivate(url: string) {
|
|
const { hostname } = new URL(url);
|
|
|
|
if (net.isIP(hostname)) {
|
|
if (isPrivateIP(hostname) && !isAllowedPrivateIP(hostname)) {
|
|
throw InvalidRequestError(
|
|
`DNS lookup ${hostname} is not allowed.` +
|
|
(env.isCloudHosted
|
|
? ""
|
|
: " To allow this request, add the IP address or CIDR range to the ALLOWED_PRIVATE_IP_ADDRESSES environment variable.")
|
|
);
|
|
}
|
|
return;
|
|
}
|
|
|
|
const { address } = await dns.promises.lookup(hostname);
|
|
if (isPrivateIP(address) && !isAllowedPrivateIP(address)) {
|
|
throw InvalidRequestError(
|
|
`DNS lookup ${address} (${hostname}) is not allowed.` +
|
|
(env.isCloudHosted
|
|
? ""
|
|
: " To allow this request, add the IP address or CIDR range to the ALLOWED_PRIVATE_IP_ADDRESSES environment variable.")
|
|
);
|
|
}
|
|
}
|