Spaces:
Running
Running
File size: 16,041 Bytes
fc69895 46d21da fc69895 46d21da fc69895 1064a82 fc69895 f878d91 aef5046 fc69895 46d21da fc69895 46d21da fc69895 46d21da fc69895 46d21da fc69895 7325361 fc69895 46d21da fc69895 46d21da fc69895 |
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 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
import {
Issuer,
type BaseClient,
type UserinfoResponse,
type TokenSet,
custom,
generators,
} from "openid-client";
import type { RequestEvent } from "@sveltejs/kit";
import { addHours, addWeeks, differenceInMinutes, subMinutes } from "date-fns";
import { config } from "$lib/server/config";
import { sha256 } from "$lib/utils/sha256";
import { z } from "zod";
import { dev } from "$app/environment";
import { redirect, type Cookies } from "@sveltejs/kit";
import { collections } from "$lib/server/database";
import JSON5 from "json5";
import { logger } from "$lib/server/logger";
import { ObjectId } from "mongodb";
import type { Cookie } from "elysia";
import { adminTokenManager } from "./adminToken";
import type { User } from "$lib/types/User";
import type { Session } from "$lib/types/Session";
import { base } from "$app/paths";
import { acquireLock, isDBLocked, releaseLock } from "$lib/migrations/lock";
import { Semaphores } from "$lib/types/Semaphore";
export interface OIDCSettings {
redirectURI: string;
}
export interface OIDCUserInfo {
token: TokenSet;
userData: UserinfoResponse;
}
const stringWithDefault = (value: string) =>
z
.string()
.default(value)
.transform((el) => (el ? el : value));
export const OIDConfig = z
.object({
CLIENT_ID: stringWithDefault(config.OPENID_CLIENT_ID),
CLIENT_SECRET: stringWithDefault(config.OPENID_CLIENT_SECRET),
PROVIDER_URL: stringWithDefault(config.OPENID_PROVIDER_URL),
SCOPES: stringWithDefault(config.OPENID_SCOPES),
NAME_CLAIM: stringWithDefault(config.OPENID_NAME_CLAIM).refine(
(el) => !["preferred_username", "email", "picture", "sub"].includes(el),
{ message: "nameClaim cannot be one of the restricted keys." }
),
TOLERANCE: stringWithDefault(config.OPENID_TOLERANCE),
RESOURCE: stringWithDefault(config.OPENID_RESOURCE),
ID_TOKEN_SIGNED_RESPONSE_ALG: z.string().optional(),
})
.parse(JSON5.parse(config.OPENID_CONFIG || "{}"));
export const loginEnabled = !!OIDConfig.CLIENT_ID;
const sameSite = z
.enum(["lax", "none", "strict"])
.default(dev || config.ALLOW_INSECURE_COOKIES === "true" ? "lax" : "none")
.parse(config.COOKIE_SAMESITE === "" ? undefined : config.COOKIE_SAMESITE);
const secure = z
.boolean()
.default(!(dev || config.ALLOW_INSECURE_COOKIES === "true"))
.parse(config.COOKIE_SECURE === "" ? undefined : config.COOKIE_SECURE === "true");
function sanitizeReturnPath(path: string | undefined | null): string | undefined {
if (!path) {
return undefined;
}
if (path.startsWith("//")) {
return undefined;
}
if (!path.startsWith("/")) {
return undefined;
}
return path;
}
export function refreshSessionCookie(cookies: Cookies, sessionId: string) {
cookies.set(config.COOKIE_NAME, sessionId, {
path: "/",
// So that it works inside the space's iframe
sameSite,
secure,
httpOnly: true,
expires: addWeeks(new Date(), 2),
});
}
export async function findUser(
sessionId: string,
coupledCookieHash: string | undefined,
url: URL
): Promise<{
user: User | null;
invalidateSession: boolean;
oauth?: Session["oauth"];
}> {
const session = await collections.sessions.findOne({ sessionId });
if (!session) {
return { user: null, invalidateSession: false };
}
if (coupledCookieHash && session.coupledCookieHash !== coupledCookieHash) {
return { user: null, invalidateSession: true };
}
// Check if OAuth token needs refresh
if (session.oauth?.token && session.oauth.refreshToken) {
// If token expires in less than 5 minutes, refresh it
if (differenceInMinutes(session.oauth.token.expiresAt, new Date()) < 5) {
const lockKey = `${Semaphores.OAUTH_TOKEN_REFRESH}:${sessionId}`;
// Acquire lock for token refresh
const lockId = await acquireLock(lockKey);
if (lockId) {
try {
// Attempt to refresh the token
const newTokenSet = await refreshOAuthToken(
{ redirectURI: `${config.PUBLIC_ORIGIN}${base}/login/callback` },
session.oauth.refreshToken,
url
);
if (!newTokenSet || !newTokenSet.access_token) {
// Token refresh failed, invalidate session
return { user: null, invalidateSession: true };
}
// Update session with new token information
const updatedOAuth = tokenSetToSessionOauth(newTokenSet);
if (!updatedOAuth) {
// Token refresh failed, invalidate session
return { user: null, invalidateSession: true };
}
await collections.sessions.updateOne(
{ sessionId },
{
$set: {
oauth: updatedOAuth,
updatedAt: new Date(),
},
}
);
session.oauth = updatedOAuth;
} catch (err) {
logger.error("Error during token refresh:", err);
return { user: null, invalidateSession: true };
} finally {
await releaseLock(lockKey, lockId);
}
} else if (new Date() > session.oauth.token.expiresAt) {
// If the token has expired, we need to wait for the token refresh to complete
let attempts = 0;
do {
await new Promise((resolve) => setTimeout(resolve, 200));
attempts++;
if (attempts > 20) {
return { user: null, invalidateSession: true };
}
} while (await isDBLocked(lockKey));
const updatedSession = await collections.sessions.findOne({ sessionId });
if (!updatedSession || updatedSession.oauth?.token === session.oauth.token) {
return { user: null, invalidateSession: true };
}
session.oauth = updatedSession.oauth;
}
}
}
return {
user: await collections.users.findOne({ _id: session.userId }),
invalidateSession: false,
oauth: session.oauth,
};
}
export const authCondition = (locals: App.Locals) => {
if (!locals.user && !locals.sessionId) {
throw new Error("User or sessionId is required");
}
return locals.user
? { userId: locals.user._id }
: { sessionId: locals.sessionId, userId: { $exists: false } };
};
export function tokenSetToSessionOauth(tokenSet: TokenSet): Session["oauth"] {
if (!tokenSet.access_token) {
return undefined;
}
return {
token: {
value: tokenSet.access_token,
expiresAt: tokenSet.expires_at
? subMinutes(new Date(tokenSet.expires_at * 1000), 1)
: addWeeks(new Date(), 2),
},
refreshToken: tokenSet.refresh_token || undefined,
};
}
/**
* Generates a CSRF token using the user sessionId. Note that we don't need a secret because sessionId is enough.
*/
export async function generateCsrfToken(
sessionId: string,
redirectUrl: string,
next?: string
): Promise<string> {
const sanitizedNext = sanitizeReturnPath(next);
const data = {
expiration: addHours(new Date(), 1).getTime(),
redirectUrl,
...(sanitizedNext ? { next: sanitizedNext } : {}),
} as {
expiration: number;
redirectUrl: string;
next?: string;
};
return Buffer.from(
JSON.stringify({
data,
signature: await sha256(JSON.stringify(data) + "##" + sessionId),
})
).toString("base64");
}
let lastIssuer: Issuer<BaseClient> | null = null;
let lastIssuerFetchedAt: Date | null = null;
async function getOIDCClient(settings: OIDCSettings, url: URL): Promise<BaseClient> {
if (
lastIssuer &&
lastIssuerFetchedAt &&
differenceInMinutes(new Date(), lastIssuerFetchedAt) >= 10
) {
lastIssuer = null;
lastIssuerFetchedAt = null;
}
if (!lastIssuer) {
lastIssuer = await Issuer.discover(OIDConfig.PROVIDER_URL);
lastIssuerFetchedAt = new Date();
}
const issuer = lastIssuer;
const client_config: ConstructorParameters<typeof issuer.Client>[0] = {
client_id: OIDConfig.CLIENT_ID,
client_secret: OIDConfig.CLIENT_SECRET,
redirect_uris: [settings.redirectURI],
response_types: ["code"],
[custom.clock_tolerance]: OIDConfig.TOLERANCE || undefined,
id_token_signed_response_alg: OIDConfig.ID_TOKEN_SIGNED_RESPONSE_ALG || undefined,
};
if (OIDConfig.CLIENT_ID === "__CIMD__") {
client_config.client_id = new URL(
`${base}/.well-known/oauth-cimd`,
config.PUBLIC_ORIGIN || url.origin
).toString();
}
const alg_supported = issuer.metadata["id_token_signing_alg_values_supported"];
if (Array.isArray(alg_supported)) {
client_config.id_token_signed_response_alg ??= alg_supported[0];
}
return new issuer.Client(client_config);
}
export async function getOIDCAuthorizationUrl(
settings: OIDCSettings,
params: { sessionId: string; next?: string; url: URL; cookies: Cookies }
): Promise<string> {
const client = await getOIDCClient(settings, params.url);
const csrfToken = await generateCsrfToken(
params.sessionId,
settings.redirectURI,
sanitizeReturnPath(params.next)
);
const codeVerifier = generators.codeVerifier();
const codeChallenge = generators.codeChallenge(codeVerifier);
params.cookies.set("hfChat-codeVerifier", codeVerifier, {
path: "/",
sameSite,
secure,
httpOnly: true,
expires: addHours(new Date(), 1),
});
return client.authorizationUrl({
code_challenge_method: "S256",
code_challenge: codeChallenge,
scope: OIDConfig.SCOPES,
state: csrfToken,
resource: OIDConfig.RESOURCE || undefined,
});
}
export async function getOIDCUserData(
settings: OIDCSettings,
code: string,
codeVerifier: string,
iss: string | undefined,
url: URL
): Promise<OIDCUserInfo> {
const client = await getOIDCClient(settings, url);
const token = await client.callback(
settings.redirectURI,
{
code,
iss,
},
{ code_verifier: codeVerifier }
);
const userData = await client.userinfo(token);
return { token, userData };
}
/**
* Refreshes an OAuth token using the refresh token
*/
export async function refreshOAuthToken(
settings: OIDCSettings,
refreshToken: string,
url: URL
): Promise<TokenSet | null> {
const client = await getOIDCClient(settings, url);
const tokenSet = await client.refresh(refreshToken);
return tokenSet;
}
export async function validateAndParseCsrfToken(
token: string,
sessionId: string
): Promise<{
/** This is the redirect url that was passed to the OIDC provider */
redirectUrl: string;
/** Relative path (within this app) to return to after login */
next?: string;
} | null> {
try {
const { data, signature } = z
.object({
data: z.object({
expiration: z.number().int(),
redirectUrl: z.string().url(),
next: z.string().optional(),
}),
signature: z.string().length(64),
})
.parse(JSON.parse(token));
const reconstructSign = await sha256(JSON.stringify(data) + "##" + sessionId);
if (data.expiration > Date.now() && signature === reconstructSign) {
return { redirectUrl: data.redirectUrl, next: sanitizeReturnPath(data.next) };
}
} catch (e) {
logger.error(e);
}
return null;
}
type CookieRecord =
| { type: "elysia"; value: Record<string, Cookie<string | undefined>> }
| { type: "svelte"; value: Cookies };
type HeaderRecord =
| { type: "elysia"; value: Record<string, string | undefined> }
| { type: "svelte"; value: Headers };
export async function getCoupledCookieHash(cookie: CookieRecord): Promise<string | undefined> {
if (!config.COUPLE_SESSION_WITH_COOKIE_NAME) {
return undefined;
}
const cookieValue =
cookie.type === "elysia"
? cookie.value[config.COUPLE_SESSION_WITH_COOKIE_NAME]?.value
: cookie.value.get(config.COUPLE_SESSION_WITH_COOKIE_NAME);
if (!cookieValue) {
return "no-cookie";
}
return await sha256(cookieValue);
}
export async function authenticateRequest(
headers: HeaderRecord,
cookie: CookieRecord,
url: URL,
isApi?: boolean
): Promise<App.Locals & { secretSessionId: string }> {
// once the entire API has been moved to elysia
// we can move this function to authPlugin.ts
// and get rid of the isApi && type: "svelte" options
const token =
cookie.type === "elysia"
? cookie.value[config.COOKIE_NAME].value
: cookie.value.get(config.COOKIE_NAME);
let email = null;
if (config.TRUSTED_EMAIL_HEADER) {
if (headers.type === "elysia") {
email = headers.value[config.TRUSTED_EMAIL_HEADER];
} else {
email = headers.value.get(config.TRUSTED_EMAIL_HEADER);
}
}
let secretSessionId: string | null = null;
let sessionId: string | null = null;
if (email) {
secretSessionId = sessionId = await sha256(email);
return {
user: {
_id: new ObjectId(sessionId.slice(0, 24)),
name: email,
email,
createdAt: new Date(),
updatedAt: new Date(),
hfUserId: email,
avatarUrl: "",
},
sessionId,
secretSessionId,
isAdmin: adminTokenManager.isAdmin(sessionId),
};
}
if (token) {
secretSessionId = token;
sessionId = await sha256(token);
const result = await findUser(sessionId, await getCoupledCookieHash(cookie), url);
if (result.invalidateSession) {
secretSessionId = crypto.randomUUID();
sessionId = await sha256(secretSessionId);
if (await collections.sessions.findOne({ sessionId })) {
throw new Error("Session ID collision");
}
}
return {
user: result.user ?? undefined,
token: result.oauth?.token?.value,
sessionId,
secretSessionId,
isAdmin: result.user?.isAdmin || adminTokenManager.isAdmin(sessionId),
};
}
if (isApi) {
const authorization =
headers.type === "elysia"
? headers.value["Authorization"]
: headers.value.get("Authorization");
if (authorization?.startsWith("Bearer ")) {
const token = authorization.slice(7);
const hash = await sha256(token);
sessionId = secretSessionId = hash;
const cacheHit = await collections.tokenCaches.findOne({ tokenHash: hash });
if (cacheHit) {
const user = await collections.users.findOne({ hfUserId: cacheHit.userId });
if (!user) {
throw new Error("User not found");
}
return {
user,
sessionId,
token,
secretSessionId,
isAdmin: user.isAdmin || adminTokenManager.isAdmin(sessionId),
};
}
const response = await fetch("https://huggingface.co/api/whoami-v2", {
headers: { Authorization: `Bearer ${token}` },
});
if (!response.ok) {
throw new Error("Unauthorized");
}
const data = await response.json();
const user = await collections.users.findOne({ hfUserId: data.id });
if (!user) {
throw new Error("User not found");
}
await collections.tokenCaches.insertOne({
tokenHash: hash,
userId: data.id,
createdAt: new Date(),
updatedAt: new Date(),
});
return {
user,
sessionId,
secretSessionId,
token,
isAdmin: user.isAdmin || adminTokenManager.isAdmin(sessionId),
};
}
}
// Generate new session if none exists
secretSessionId = crypto.randomUUID();
sessionId = await sha256(secretSessionId);
if (await collections.sessions.findOne({ sessionId })) {
throw new Error("Session ID collision");
}
return { user: undefined, sessionId, secretSessionId, isAdmin: false };
}
export async function triggerOauthFlow({ url, locals, cookies }: RequestEvent): Promise<Response> {
// const referer = request.headers.get("referer");
// let redirectURI = `${(referer ? new URL(referer) : url).origin}${base}/login/callback`;
let redirectURI = `${url.origin}${base}/login/callback`;
// TODO: Handle errors if provider is not responding
if (url.searchParams.has("callback")) {
const callback = url.searchParams.get("callback") || redirectURI;
if (config.ALTERNATIVE_REDIRECT_URLS.includes(callback)) {
redirectURI = callback;
}
}
// Preserve a safe in-app return path after login.
// Priority: explicit ?next=... (must be an absolute path), else the current path (when auto-login kicks in).
let next: string | undefined = undefined;
const nextParam = sanitizeReturnPath(url.searchParams.get("next"));
if (nextParam) {
// Only accept absolute in-app paths to prevent open redirects
next = nextParam;
} else if (!url.pathname.startsWith(`${base}/login`)) {
// For automatic login on protected pages, return to the page the user was on
next = sanitizeReturnPath(`${url.pathname}${url.search}`) ?? `${base}/`;
} else {
next = sanitizeReturnPath(`${base}/`) ?? "/";
}
const authorizationUrl = await getOIDCAuthorizationUrl(
{ redirectURI },
{ sessionId: locals.sessionId, next, url, cookies }
);
throw redirect(302, authorizationUrl);
}
|