feat: private hostname guard for authenticated/private mode

Reject requests from unrecognised Host headers when running
authenticated/private. Adds server middleware, CLI `allowed-hostname`
command, config-schema field, and prompt support for configuring
allowed hostnames during onboard/configure.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Forgotten
2026-02-23 19:43:52 -06:00
parent 076092685e
commit 85c0b9a3dc
15 changed files with 385 additions and 8 deletions

View File

@@ -0,0 +1,92 @@
import type { Request, RequestHandler } from "express";
function isLoopbackHostname(hostname: string): boolean {
const normalized = hostname.trim().toLowerCase();
return normalized === "localhost" || normalized === "127.0.0.1" || normalized === "::1";
}
function extractHostname(req: Request): string | null {
const forwardedHost = req.header("x-forwarded-host")?.split(",")[0]?.trim();
const hostHeader = req.header("host")?.trim();
const raw = forwardedHost || hostHeader;
if (!raw) return null;
try {
return new URL(`http://${raw}`).hostname.trim().toLowerCase();
} catch {
return raw.trim().toLowerCase();
}
}
function normalizeAllowedHostnames(values: string[]): string[] {
const unique = new Set<string>();
for (const value of values) {
const trimmed = value.trim().toLowerCase();
if (!trimmed) continue;
unique.add(trimmed);
}
return Array.from(unique);
}
export function resolvePrivateHostnameAllowSet(opts: { allowedHostnames: string[]; bindHost: string }): Set<string> {
const configuredAllow = normalizeAllowedHostnames(opts.allowedHostnames);
const bindHost = opts.bindHost.trim().toLowerCase();
const allowSet = new Set<string>(configuredAllow);
if (bindHost && bindHost !== "0.0.0.0") {
allowSet.add(bindHost);
}
allowSet.add("localhost");
allowSet.add("127.0.0.1");
allowSet.add("::1");
return allowSet;
}
function blockedHostnameMessage(hostname: string): string {
return (
`Hostname '${hostname}' is not allowed for this Paperclip instance. ` +
`If you want to allow this hostname, please run pnpm paperclip allowed-hostname ${hostname}`
);
}
export function privateHostnameGuard(opts: {
enabled: boolean;
allowedHostnames: string[];
bindHost: string;
}): RequestHandler {
if (!opts.enabled) {
return (_req, _res, next) => next();
}
const allowSet = resolvePrivateHostnameAllowSet({
allowedHostnames: opts.allowedHostnames,
bindHost: opts.bindHost,
});
return (req, res, next) => {
const hostname = extractHostname(req);
const wantsJson = req.path.startsWith("/api") || req.accepts(["json", "html", "text"]) === "json";
if (!hostname) {
const error = "Missing Host header. If you want to allow a hostname, run pnpm paperclip allowed-hostname <host>.";
if (wantsJson) {
res.status(403).json({ error });
} else {
res.status(403).type("text/plain").send(error);
}
return;
}
if (isLoopbackHostname(hostname) || allowSet.has(hostname)) {
next();
return;
}
const error = blockedHostnameMessage(hostname);
if (wantsJson) {
res.status(403).json({ error });
} else {
res.status(403).type("text/plain").send(error);
}
};
}