Spaces:
Runtime error
Runtime error
File size: 10,804 Bytes
cd8bd0a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 | /**
* API Authentication Guard β Shared utility for protecting API routes.
*
* Management APIs require a dashboard session, while client-facing APIs may still
* accept Bearer API keys. Route scope is inferred from the request pathname.
*
* @module shared/utils/apiAuth
*/
import { jwtVerify } from "jose";
import { cookies } from "next/headers";
import { getSettings } from "@/lib/localDb";
import { isPublicApiRoute } from "@/shared/constants/publicApiRoutes";
import { extractApiKey } from "@/sse/services/auth";
type RequestLike = {
cookies?: {
get?: (name: string) => { value?: string } | undefined;
};
headers?: Headers;
method?: string;
nextUrl?: { hostname?: string | null; pathname?: string | null } | null;
url?: string;
};
const LOOPBACK_HOSTNAMES = new Set(["localhost", "::1"]);
function hasConfiguredPassword(settings: Record<string, unknown>): boolean {
return typeof settings.password === "string" && settings.password.length > 0;
}
function getRequestPathname(request: RequestLike | Request | null | undefined): string | null {
const nextPathname =
request &&
typeof request === "object" &&
"nextUrl" in request &&
request.nextUrl &&
typeof request.nextUrl.pathname === "string"
? request.nextUrl.pathname
: null;
if (nextPathname) return nextPathname;
const rawUrl =
request && typeof request === "object" && "url" in request && typeof request.url === "string"
? request.url
: "";
if (!rawUrl) return null;
try {
return new URL(rawUrl, "http://localhost").pathname;
} catch {
return null;
}
}
function isOnboardingBootstrapPath(pathname: string | null): boolean {
return pathname === "/dashboard/onboarding";
}
function isRequireLoginBootstrapWritePath(pathname: string | null, method: string): boolean {
return pathname === "/api/settings/require-login" && method.toUpperCase() === "POST";
}
function getRequestMethod(request: RequestLike | Request | null | undefined): string {
if (
request &&
typeof request === "object" &&
"method" in request &&
typeof request.method === "string"
) {
return request.method.toUpperCase();
}
return "GET";
}
function getRequestHostname(request: RequestLike | Request | null | undefined): string | null {
const nextHostname =
request &&
typeof request === "object" &&
"nextUrl" in request &&
request.nextUrl &&
typeof request.nextUrl.hostname === "string"
? request.nextUrl.hostname
: null;
if (nextHostname) return nextHostname;
const rawUrl =
request && typeof request === "object" && "url" in request && typeof request.url === "string"
? request.url
: "";
if (rawUrl) {
try {
return new URL(rawUrl, "http://localhost").hostname;
} catch {
// Fall through to Host header parsing.
}
}
const requestHeaders =
request && typeof request === "object" && "headers" in request ? request.headers : undefined;
const host = requestHeaders?.get("host") || requestHeaders?.get("Host") || null;
if (!host) return null;
try {
return new URL(`http://${host}`).hostname;
} catch {
return host.split(":")[0] || null;
}
}
export function isLoopbackRequest(request: RequestLike | Request | null | undefined): boolean {
const hostname = getRequestHostname(request);
if (!hostname) return false;
const normalized = hostname
.trim()
.toLowerCase()
.replace(/^\[(.*)\]$/, "$1");
if (LOOPBACK_HOSTNAMES.has(normalized)) return true;
if (/^127(?:\.\d{1,3}){3}$/.test(normalized)) return true;
return false;
}
function getCookieValueFromHeader(headers: Headers | undefined, name: string): string | null {
const cookieHeader = headers?.get("cookie") || headers?.get("Cookie");
if (!cookieHeader) return null;
for (const segment of cookieHeader.split(";")) {
const [rawKey, ...rawValue] = segment.split("=");
if (!rawKey || rawValue.length === 0) continue;
if (rawKey.trim() !== name) continue;
return rawValue.join("=").trim();
}
return null;
}
function getRequestApiKey(
request: RequestLike | Request | null | undefined,
opts?: { allowUrl?: boolean }
): string | null {
if (!request || typeof request !== "object") return null;
const headers = "headers" in request ? request.headers : undefined;
const rawUrl = "url" in request && typeof request.url === "string" ? request.url : null;
const pathname = getRequestPathname(request);
const syntheticUrl = rawUrl || (pathname ? `http://localhost${pathname}` : null);
// Management auth never honours a URL-borne credential (defence-in-depth: the
// path-scoped token is a client-API affordance only β a credential in the URL
// must not authenticate a management route). See the #3300 security follow-up.
const allowUrl = opts?.allowUrl !== false;
return extractApiKey({ headers, url: allowUrl ? syntheticUrl : null }, { allowUrl });
}
async function validateBearerApiKey(apiKey: string | null): Promise<boolean> {
if (!apiKey) return false;
try {
const { validateApiKey } = await import("@/lib/db/apiKeys");
return await validateApiKey(apiKey);
} catch {
return false;
}
}
/**
* Check whether a Bearer API key is valid AND carries a scope that authorizes
* it on management API routes (`/api/*` excluding `/api/v1/*` and the public
* allowlist). Returns `false` for unscoped keys so that the existing
* default-deny posture on management routes is preserved.
*
* Scope set is sourced from `@/shared/constants/managementScopes` so this
* helper stays in lockstep with `requireManagementAuth.hasManageScope`.
*/
async function validateBearerApiKeyForManagement(apiKey: string | null): Promise<boolean> {
if (!apiKey) return false;
try {
const [{ validateApiKey, getApiKeyMetadata }, { hasManageScope }] = await Promise.all([
import("@/lib/db/apiKeys"),
import("@/shared/constants/managementScopes"),
]);
const valid = await validateApiKey(apiKey);
if (!valid) return false;
const metadata = await getApiKeyMetadata(apiKey);
if (!metadata) return false;
return hasManageScope(metadata.scopes);
} catch {
return false;
}
}
export function isManagementApiRequest(request: RequestLike | Request): boolean {
const pathname = getRequestPathname(request);
if (!pathname?.startsWith("/api/")) return false;
if (pathname.startsWith("/api/v1/")) return false;
return !isPublicApiRoute(pathname, getRequestMethod(request));
}
export async function isDashboardSessionAuthenticated(
request?: RequestLike | Request | null
): Promise<boolean> {
if (!process.env.JWT_SECRET) return false;
let token =
request &&
typeof request === "object" &&
"cookies" in request &&
request.cookies?.get?.("auth_token")?.value
? request.cookies.get("auth_token")?.value || null
: null;
const requestHeaders =
request && typeof request === "object" && "headers" in request ? request.headers : undefined;
if (!token) {
token = getCookieValueFromHeader(requestHeaders, "auth_token");
}
if (!token) {
try {
const cookieStore = await cookies();
token = cookieStore.get("auth_token")?.value || null;
} catch {
token = null;
}
}
if (!token) return false;
try {
const secret = new TextEncoder().encode(process.env.JWT_SECRET);
await jwtVerify(token, secret);
return true;
} catch {
return false;
}
}
// ββββββββββββββββ Auth Verification ββββββββββββββββ
/**
* Check if a request is authenticated.
*
* @returns null if authenticated, error message string if not
*/
export async function verifyAuth(request: any): Promise<string | null> {
if (await isDashboardSessionAuthenticated(request)) {
return null;
}
const isManagement = isManagementApiRequest(request);
const apiKey = getRequestApiKey(request, { allowUrl: !isManagement });
if (isManagement) {
if (await validateBearerApiKeyForManagement(apiKey)) {
return null;
}
return apiKey ? "Invalid management token" : "Authentication required";
}
if (await validateBearerApiKey(apiKey)) {
return null;
}
return "Authentication required";
}
/**
* Check if a request is authenticated β boolean convenience wrapper for route handlers.
*
* Uses `cookies()` from next/headers (App Router compatible) and Bearer API key.
* Returns true if authenticated, false otherwise.
*
* Unlike `verifyAuth`, this does NOT check `isAuthRequired()` β callers that
* need to conditionally skip auth should check that separately.
*/
export async function isAuthenticated(request: Request): Promise<boolean> {
// If settings say login/auth is disabled, treat all requests as authenticated
if (!(await isAuthRequired(request))) {
return true;
}
if (await isDashboardSessionAuthenticated(request)) {
return true;
}
const isManagement = isManagementApiRequest(request);
const apiKey = getRequestApiKey(request, { allowUrl: !isManagement });
if (isManagement) {
return validateBearerApiKeyForManagement(apiKey);
}
return validateBearerApiKey(apiKey);
}
/**
* Check if a route is in the public (no-auth) allowlist.
*/
export function isPublicRoute(pathname: string, method = "GET"): boolean {
return isPublicApiRoute(pathname, method);
}
/**
* Check if authentication is required based on settings.
* If requireLogin is explicitly false, auth is skipped. Fresh installs without
* a password keep their unauthenticated bootstrap path only on loopback
* requests; exposed network requests must configure INITIAL_PASSWORD or log in.
*/
export async function isAuthRequired(
request?: RequestLike | Request | null | undefined
): Promise<boolean> {
try {
const settings = await getSettings();
if (settings.requireLogin === false) return false;
if (!hasConfiguredPassword(settings) && !process.env.INITIAL_PASSWORD) {
if (!request) return false;
const pathname = getRequestPathname(request);
const method = getRequestMethod(request);
if (isOnboardingBootstrapPath(pathname)) {
return false;
}
if (pathname && isPublicApiRoute(pathname, method)) {
return false;
}
if (isRequireLoginBootstrapWritePath(pathname, method)) {
return false;
}
return settings.setupComplete === true || !isLoopbackRequest(request);
}
return true;
} catch (error: any) {
// On error, require auth (secure by default)
// Log the error so failures (e.g., SQLITE_BUSY) aren't silent 401s
console.error(
"[API_AUTH_GUARD] isAuthRequired failed, defaulting to true:",
error?.message || error
);
return true;
}
}
|