Profile pictures from Gravatar or the identity provider, fetched and kept by the server
Both sources are off until switched on under Settings, Sign-in. The server asks only gravatar.com (by a hash of the email) and the identity provider's own host, accepts only small PNG/JPEG/WebP/GIF, keeps each picture for a day and serves it from /api/avatars/<id>, so browsers never contact either. Shown in the user menu and on the Users page, with initials as the fallback; the Privacy page says when it is on. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
9782bd3252
commit
c05c847d17
26 files changed
+4361
-21
No files matched your search
@@ -0,0 +1 @@
|
||||
ALTER TABLE `users` ADD `picture_url` text;
|
||||
File diff suppressed because it is too large.
Load diff
@@ -288,6 +288,13 @@
|
||||
"when": 1792357895858,
|
||||
"tag": "0040_petite_invaders",
|
||||
"breakpoints": true
|
||||
},
|
||||
{
|
||||
"idx": 41,
|
||||
"version": "6",
|
||||
"when": 1792359507903,
|
||||
"tag": "0041_open_silvermane",
|
||||
"breakpoints": true
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -47,6 +47,7 @@ import { alertsRouter } from "./routes/alerts.js";
|
||||
import { mapRouter } from "./routes/map.js";
|
||||
import { generatorRouter } from "./routes/generator.js";
|
||||
import { alertTicketsRouter } from "./routes/alertTickets.js";
|
||||
import { avatarsRouter } from "./routes/avatars.js";
|
||||
import { apiErrorHandler } from "./utils/apiErrorHandler.js";
|
||||
import { securityHeaders } from "./utils/securityHeaders.js";
|
||||
import { sameOriginGuard } from "./utils/sameOriginGuard.js";
|
||||
@@ -103,6 +104,7 @@ export function createApp() {
|
||||
|
||||
app.use("/auth", authRouter);
|
||||
app.use("/api/me", meRouter);
|
||||
app.use("/api/avatars", avatarsRouter);
|
||||
app.use("/api/uptime", uptimeRouter);
|
||||
app.use("/api/share-links", shareLinksRouter);
|
||||
app.use("/api/runbooks", runbooksRouter);
|
||||
|
||||
@@ -11,6 +11,7 @@ import { users } from "../db/schema.js";
|
||||
import { recordAudit } from "../services/audit.js";
|
||||
import { verifyIdTokenSignature } from "./idToken.js";
|
||||
import { rateLimit } from "../utils/rateLimit.js";
|
||||
import { pictureFromClaims } from "../services/avatars.js";
|
||||
|
||||
export const authRouter = Router();
|
||||
|
||||
@@ -130,7 +131,7 @@ authRouter.get("/callback", signInLimiter, async (req, res, next) => {
|
||||
console.warn(`[auth] roles follow groups, but the sign-in carried no "${signIn.groupsClaim}" claim — roles left as they are`);
|
||||
}
|
||||
|
||||
const { user, created, roleChange } = await upsertUserFromLogin({ sub: claims.sub, email, name, groups });
|
||||
const { user, created, roleChange } = await upsertUserFromLogin({ sub: claims.sub, email, name, groups, pictureUrl: pictureFromClaims(claimSources) });
|
||||
if (roleChange) {
|
||||
await recordAudit({
|
||||
actor: user,
|
||||
|
||||
@@ -27,6 +27,8 @@ export async function upsertUserFromLogin(params: {
|
||||
email?: string;
|
||||
name?: string;
|
||||
groups?: string[] | null;
|
||||
/** The identity provider's "picture" claim, when it gave one; left as it was when it did not. */
|
||||
pictureUrl?: string;
|
||||
}): Promise<{ user: typeof users.$inferSelect; created: boolean; roleChange?: RoleChange }> {
|
||||
const [existing] = await db.select().from(users).where(eq(users.oidcSub, params.sub)).limit(1);
|
||||
const now = new Date().toISOString();
|
||||
@@ -55,6 +57,7 @@ export async function upsertUserFromLogin(params: {
|
||||
.set({
|
||||
email: params.email ?? existing.email,
|
||||
name: params.name ?? existing.name,
|
||||
pictureUrl: params.pictureUrl ?? existing.pictureUrl,
|
||||
lastLoginAt: now,
|
||||
role,
|
||||
...(groupsJson !== undefined ? { groups: groupsJson } : {}),
|
||||
@@ -74,6 +77,7 @@ export async function upsertUserFromLogin(params: {
|
||||
oidcSub: params.sub,
|
||||
email: params.email,
|
||||
name: params.name,
|
||||
pictureUrl: params.pictureUrl ?? null,
|
||||
role,
|
||||
lastLoginAt: now,
|
||||
...(groupsJson !== undefined ? { groups: groupsJson } : {}),
|
||||
|
||||
@@ -26,6 +26,9 @@ export const users = sqliteTable("users", {
|
||||
// How this person arranged the dashboard: a JSON object with the cards they hid ("hidden": ["Gitea"]) and the order of the others
|
||||
// ("order": {"DNS": 0, "Secrets": 1}). Follows them to any browser; null is the default layout.
|
||||
dashboardLayout: text("dashboard_layout"),
|
||||
// The address of the picture the identity provider gave for this person (the OIDC "picture" claim), as of their last sign-in. Only an address:
|
||||
// nothing is fetched from it unless Settings → Sign-in → Profile pictures allows it, and then only by this server, never by the browser.
|
||||
pictureUrl: text("picture_url"),
|
||||
});
|
||||
|
||||
// ─── Audit log ──────────────────────────────────────────────────────────────
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
import { Router } from "express";
|
||||
import { eq } from "drizzle-orm";
|
||||
import { db } from "../db/client.js";
|
||||
import { users } from "../db/schema.js";
|
||||
import { requireAuth } from "../auth/middleware.js";
|
||||
import { getAvatar } from "../services/avatars.js";
|
||||
import { getSettings } from "../services/settingsStore.js";
|
||||
import { asyncHandler } from "../utils/asyncHandler.js";
|
||||
|
||||
export const avatarsRouter = Router();
|
||||
avatarsRouter.use(requireAuth);
|
||||
|
||||
// A person's profile picture, for anyone signed in (their names are shown to everyone already). The server asks Gravatar or the identity
|
||||
// provider; the browser only ever talks to this app. 404 means "no picture": the page falls back to initials. With the setting off nothing is asked.
|
||||
avatarsRouter.get("/:id", asyncHandler(async (req, res) => {
|
||||
const id = /^\d+$/.test(req.params.id) ? Number(req.params.id) : NaN;
|
||||
if (!Number.isSafeInteger(id)) return res.status(404).json({ error: "not_found" });
|
||||
const [person] = await db.select({ email: users.email, pictureUrl: users.pictureUrl }).from(users).where(eq(users.id, id)).limit(1);
|
||||
if (!person) return res.status(404).json({ error: "not_found" });
|
||||
|
||||
const image = await getAvatar(person, (await getSettings()).profilePictures);
|
||||
if (!image) return res.status(404).json({ error: "no_picture" });
|
||||
|
||||
res.setHeader("Content-Type", image.contentType);
|
||||
// Kept an hour by the browser: short enough that turning the setting off, or a new picture, is not long in showing.
|
||||
res.setHeader("Cache-Control", "private, max-age=3600");
|
||||
res.setHeader("Content-Security-Policy", "default-src 'none'; sandbox");
|
||||
res.send(image.body);
|
||||
}));
|
||||
@@ -6,6 +6,8 @@ import { users } from "../db/schema.js";
|
||||
import { requireAuth } from "../auth/middleware.js";
|
||||
import { asyncHandler } from "../utils/asyncHandler.js";
|
||||
import { FIRST_LOOKBACK_MS, getChangesSince } from "../services/changesSince.js";
|
||||
import { avatarUrlFor } from "../services/avatars.js";
|
||||
import { getSettings } from "../services/settingsStore.js";
|
||||
|
||||
export const meRouter = Router();
|
||||
|
||||
@@ -36,10 +38,12 @@ export function parseDashboardLayout(stored: string | null): DashboardLayout {
|
||||
}
|
||||
}
|
||||
|
||||
meRouter.get("/", requireAuth, (req, res) => {
|
||||
const { id, email, name, role, oidcSub, favorites, dashboardLayout } = req.currentUser!;
|
||||
res.json({ user: { id, sub: oidcSub, email, name, role, favorites: parseFavorites(favorites), dashboard: parseDashboardLayout(dashboardLayout) } });
|
||||
});
|
||||
meRouter.get("/", requireAuth, asyncHandler(async (req, res) => {
|
||||
const me = req.currentUser!;
|
||||
const { id, email, name, role, oidcSub, favorites, dashboardLayout } = me;
|
||||
const avatarUrl = avatarUrlFor(me, (await getSettings()).profilePictures);
|
||||
res.json({ user: { id, sub: oidcSub, email, name, role, avatarUrl, favorites: parseFavorites(favorites), dashboard: parseDashboardLayout(dashboardLayout) } });
|
||||
}));
|
||||
|
||||
// Paths inside the app only: a slash, then letters, digits, dashes, underscores and further slashes — and, for a saved view of a page,
|
||||
// a short query of the characters a browser leaves as they are or percent-encodes (the search words, a status, a sort). Which of them
|
||||
|
||||
@@ -7,6 +7,7 @@ import { recordAudit } from "../services/audit.js";
|
||||
import { getSettings } from "../services/settingsStore.js";
|
||||
import { listSessions } from "../services/sessionStore.js";
|
||||
import { asyncHandler } from "../utils/asyncHandler.js";
|
||||
import { env } from "../env.js";
|
||||
|
||||
export const privacyRouter = Router();
|
||||
privacyRouter.use(requireAuth);
|
||||
@@ -46,7 +47,7 @@ privacyRouter.get("/", asyncHandler(async (req, res) => {
|
||||
|
||||
res.json({
|
||||
me: {
|
||||
user: { email: me.email, name: me.name, role: me.role, subject: me.oidcSub, createdAt: me.createdAt, lastLoginAt: me.lastLoginAt },
|
||||
user: { email: me.email, name: me.name, role: me.role, subject: me.oidcSub, createdAt: me.createdAt, lastLoginAt: me.lastLoginAt, pictureUrl: me.pictureUrl },
|
||||
auditEntries,
|
||||
sessions: await ownSessions(me.oidcSub, req.sessionID),
|
||||
},
|
||||
@@ -58,6 +59,7 @@ privacyRouter.get("/", asyncHandler(async (req, res) => {
|
||||
tlsCertificateChecks: tlsChecks,
|
||||
servers: serverCount,
|
||||
serversWithAgent: agentCount,
|
||||
profilePictures: { ...settings.profilePictures, identityProviderHost: isAdmin ? hostOf(env.authentik.issuerUrl) : null },
|
||||
channels: {
|
||||
gotify: channel(settings.gotify.enabled, hostOf(settings.gotify.url)),
|
||||
ntfy: channel(settings.ntfy.enabled, hostOf(settings.ntfy.url)),
|
||||
@@ -84,7 +86,7 @@ privacyRouter.get("/export", asyncHandler(async (req, res) => {
|
||||
const body = {
|
||||
exportedAt: new Date().toISOString(),
|
||||
note: "Everything Homelab Manager holds that is specifically about you. Other people's data, server data and shared inventory are not included.",
|
||||
account: { email: row.email, name: row.name, role: row.role, subject: row.oidcSub, createdAt: row.createdAt, lastLoginAt: row.lastLoginAt },
|
||||
account: { email: row.email, name: row.name, role: row.role, subject: row.oidcSub, createdAt: row.createdAt, lastLoginAt: row.lastLoginAt, pictureUrl: row.pictureUrl },
|
||||
sessions: await ownSessions(me.oidcSub, req.sessionID),
|
||||
auditLog: entries.map((e) => ({ ...e, detail: e.detail ? safeJson(e.detail) : null })),
|
||||
};
|
||||
|
||||
@@ -160,6 +160,7 @@ const updateSchema = z.object({
|
||||
})
|
||||
.partial()
|
||||
.optional(),
|
||||
profilePictures: z.object({ gravatar: z.boolean(), identityProvider: z.boolean() }).partial().optional(),
|
||||
digest: z
|
||||
.object({ enabled: z.boolean(), day: z.number().int().min(0).max(6), time: z.string().regex(/^([01]\d|2[0-3]):[0-5]\d$/) })
|
||||
.partial()
|
||||
|
||||
@@ -8,6 +8,7 @@ import { recordAudit } from "../services/audit.js";
|
||||
import { asyncHandler } from "../utils/asyncHandler.js";
|
||||
import { getSettings } from "../services/settingsStore.js";
|
||||
import { roleFromGroups } from "../auth/groups.js";
|
||||
import { avatarUrlFor } from "../services/avatars.js";
|
||||
|
||||
export const usersRouter = Router();
|
||||
|
||||
@@ -26,9 +27,9 @@ export function parseGroups(stored: string | null): string[] | null {
|
||||
|
||||
usersRouter.get("/", asyncHandler(async (_req, res) => {
|
||||
const rows = await db.select().from(users).orderBy(users.createdAt);
|
||||
const { signIn } = await getSettings();
|
||||
const { signIn, profilePictures } = await getSettings();
|
||||
res.json({
|
||||
users: rows.map((u) => ({ id: u.id, oidcSub: u.oidcSub, email: u.email, name: u.name, role: u.role, createdAt: u.createdAt, lastLoginAt: u.lastLoginAt, groups: parseGroups(u.groups) })),
|
||||
users: rows.map((u) => ({ id: u.id, oidcSub: u.oidcSub, email: u.email, name: u.name, role: u.role, createdAt: u.createdAt, lastLoginAt: u.lastLoginAt, groups: parseGroups(u.groups), avatarUrl: avatarUrlFor(u, profilePictures) })),
|
||||
// When roles follow groups, a role set by hand would be undone at the next sign-in, so the page says so instead of offering it.
|
||||
rolesFollowGroups: signIn.roleFromGroups,
|
||||
});
|
||||
|
||||
@@ -0,0 +1,186 @@
|
||||
/**
|
||||
* Profile pictures, fetched and kept by this server so that people's browsers never contact an outside address.
|
||||
*
|
||||
* Where a picture can come from (Settings → Sign-in → Profile pictures, both off until an administrator turns them on):
|
||||
* - the identity provider's own "picture" claim, tried first, and
|
||||
* - Gravatar, by a SHA-256 hash of the person's email address (never the address itself).
|
||||
*
|
||||
* The server only ever asks the hosts it is allowed to: gravatar.com, and the identity provider's own host. A "picture" claim naming anywhere
|
||||
* else is ignored, so a claim cannot be used to make the server fetch an arbitrary address. What comes back must be a small PNG, JPEG, WebP or
|
||||
* GIF — never SVG, which can carry script and would be served from this app's own origin.
|
||||
*/
|
||||
import { createHash } from "node:crypto";
|
||||
import { env } from "../env.js";
|
||||
import type { ProfilePictureSettings } from "./settingsStore.js";
|
||||
|
||||
/** What the server will accept as a picture. */
|
||||
const MAX_BYTES = 256 * 1024;
|
||||
const TYPES = new Set(["image/png", "image/jpeg", "image/webp", "image/gif"]);
|
||||
const FETCH_TIMEOUT_MS = 4000;
|
||||
const MAX_REDIRECTS = 2;
|
||||
const FOUND_TTL_MS = 24 * 3600_000;
|
||||
/** Someone with no picture is asked about again after this, so adding one shows up the same day without asking every page view. */
|
||||
const MISSING_TTL_MS = 3600_000;
|
||||
/** A host that could not be reached is tried again soon. */
|
||||
const FAILED_TTL_MS = 5 * 60_000;
|
||||
const MAX_CACHED = 200;
|
||||
|
||||
export interface AvatarImage {
|
||||
contentType: string;
|
||||
body: Buffer;
|
||||
}
|
||||
|
||||
export type AvatarFetcher = (url: string) => Promise<Response>;
|
||||
|
||||
const realFetcher: AvatarFetcher = (url) =>
|
||||
fetch(url, { redirect: "manual", signal: AbortSignal.timeout(FETCH_TIMEOUT_MS), headers: { accept: [...TYPES].join(", "), "user-agent": "HomelabManager" } });
|
||||
|
||||
let fetcher: AvatarFetcher = realFetcher;
|
||||
/** Tests stand in for the network. */
|
||||
export function setAvatarFetcherForTests(f: AvatarFetcher | null): void {
|
||||
fetcher = f ?? realFetcher;
|
||||
cache.clear();
|
||||
}
|
||||
|
||||
/** A person's email as Gravatar wants it: trimmed, lower case, SHA-256. */
|
||||
export function gravatarHash(email: string): string {
|
||||
return createHash("sha256").update(email.trim().toLowerCase()).digest("hex");
|
||||
}
|
||||
|
||||
export function gravatarUrl(email: string): string {
|
||||
return `https://gravatar.com/avatar/${gravatarHash(email)}?s=128&d=404`;
|
||||
}
|
||||
|
||||
function issuerHost(): string | null {
|
||||
try {
|
||||
return new URL(env.authentik.issuerUrl).host.toLowerCase();
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
const isGravatarHost = (host: string) => host === "gravatar.com" || host.endsWith(".gravatar.com");
|
||||
|
||||
/** Whether the server may ask this address for a picture: Gravatar over HTTPS, or the identity provider's own host. */
|
||||
export function isAllowedPictureUrl(raw: string, idpHost: string | null = issuerHost()): boolean {
|
||||
let url: URL;
|
||||
try {
|
||||
url = new URL(raw);
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
const host = url.host.toLowerCase();
|
||||
if (url.username || url.password) return false;
|
||||
if (isGravatarHost(url.hostname.toLowerCase())) return url.protocol === "https:";
|
||||
return idpHost !== null && host === idpHost && (url.protocol === "https:" || url.protocol === "http:");
|
||||
}
|
||||
|
||||
/** The "picture" claim, if it is an address at all; kept as given and judged again whenever it is used. */
|
||||
export function pictureFromClaims(sources: Record<string, unknown>[]): string | undefined {
|
||||
for (const source of sources) {
|
||||
const value = source.picture;
|
||||
if (typeof value !== "string") continue;
|
||||
const trimmed = value.trim();
|
||||
if (trimmed.length === 0 || trimmed.length > 500) continue;
|
||||
try {
|
||||
const url = new URL(trimmed);
|
||||
if (url.protocol === "https:" || url.protocol === "http:") return trimmed;
|
||||
} catch {
|
||||
// not an address
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
/** The addresses this person's picture may be fetched from under the current settings, in the order they are tried. */
|
||||
export function avatarSources(user: { email: string | null; pictureUrl: string | null }, settings: ProfilePictureSettings, idpHost: string | null = issuerHost()): string[] {
|
||||
const out: string[] = [];
|
||||
if (settings.identityProvider && user.pictureUrl && isAllowedPictureUrl(user.pictureUrl, idpHost)) {
|
||||
// A claim that names Gravatar is Gravatar all the same: it needs that switched on too.
|
||||
let host = "";
|
||||
try {
|
||||
host = new URL(user.pictureUrl).hostname.toLowerCase();
|
||||
} catch {
|
||||
// judged above
|
||||
}
|
||||
if (!isGravatarHost(host) || settings.gravatar) out.push(user.pictureUrl);
|
||||
}
|
||||
if (settings.gravatar && user.email && user.email.includes("@")) out.push(gravatarUrl(user.email));
|
||||
return [...new Set(out)];
|
||||
}
|
||||
|
||||
/** The address the browser asks this server for, or null when there is no picture to look for. `v` changes with the source so a new one is not hidden by the browser's copy. */
|
||||
export function avatarUrlFor(user: { id: number; email: string | null; pictureUrl: string | null }, settings: ProfilePictureSettings): string | null {
|
||||
const sources = avatarSources(user, settings);
|
||||
if (sources.length === 0) return null;
|
||||
return `/api/avatars/${user.id}?v=${createHash("sha256").update(sources.join("\n")).digest("hex").slice(0, 8)}`;
|
||||
}
|
||||
|
||||
// ─── Fetching and keeping ──────────────────────────────────────────────────
|
||||
|
||||
interface Entry {
|
||||
until: number;
|
||||
image: AvatarImage | null;
|
||||
}
|
||||
const cache = new Map<string, Entry>();
|
||||
|
||||
function remember(url: string, image: AvatarImage | null, ttl: number): void {
|
||||
cache.delete(url);
|
||||
cache.set(url, { until: Date.now() + ttl, image });
|
||||
while (cache.size > MAX_CACHED) cache.delete(cache.keys().next().value as string);
|
||||
}
|
||||
|
||||
/** One picture from one address: followed through at most two redirects, only to addresses that are allowed too. */
|
||||
async function download(start: string): Promise<{ image: AvatarImage | null; failed: boolean }> {
|
||||
let url = start;
|
||||
for (let hop = 0; hop <= MAX_REDIRECTS; hop++) {
|
||||
let res: Response;
|
||||
try {
|
||||
res = await fetcher(url);
|
||||
} catch {
|
||||
return { image: null, failed: true };
|
||||
}
|
||||
if (res.status >= 300 && res.status < 400) {
|
||||
const location = res.headers.get("location");
|
||||
let next: string | null = null;
|
||||
try {
|
||||
next = location ? new URL(location, url).toString() : null;
|
||||
} catch {
|
||||
next = null;
|
||||
}
|
||||
if (!next || !isAllowedPictureUrl(next)) return { image: null, failed: false };
|
||||
url = next;
|
||||
continue;
|
||||
}
|
||||
if (res.status >= 500) return { image: null, failed: true };
|
||||
if (!res.ok) return { image: null, failed: false };
|
||||
const type = (res.headers.get("content-type") ?? "").split(";")[0].trim().toLowerCase();
|
||||
if (!TYPES.has(type)) return { image: null, failed: false };
|
||||
const declared = Number(res.headers.get("content-length"));
|
||||
if (Number.isFinite(declared) && declared > MAX_BYTES) return { image: null, failed: false };
|
||||
let body: Buffer;
|
||||
try {
|
||||
body = Buffer.from(await res.arrayBuffer());
|
||||
} catch {
|
||||
return { image: null, failed: true };
|
||||
}
|
||||
if (body.length === 0 || body.length > MAX_BYTES) return { image: null, failed: false };
|
||||
return { image: { contentType: type, body }, failed: false };
|
||||
}
|
||||
return { image: null, failed: false };
|
||||
}
|
||||
|
||||
/** The first of this person's sources that has a picture, from the keep or from the source itself. Null when none does. */
|
||||
export async function getAvatar(user: { email: string | null; pictureUrl: string | null }, settings: ProfilePictureSettings): Promise<AvatarImage | null> {
|
||||
for (const source of avatarSources(user, settings)) {
|
||||
const kept = cache.get(source);
|
||||
if (kept && kept.until > Date.now()) {
|
||||
if (kept.image) return kept.image;
|
||||
continue;
|
||||
}
|
||||
const { image, failed } = await download(source);
|
||||
remember(source, image, image ? FOUND_TTL_MS : failed ? FAILED_TTL_MS : MISSING_TTL_MS);
|
||||
if (image) return image;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
@@ -135,6 +135,17 @@ export interface SignInSettings {
|
||||
otherwise: "viewer" | "keep";
|
||||
}
|
||||
|
||||
/**
|
||||
* Where people's profile pictures may come from. Both are off until an administrator turns them on, because each means this server asks an
|
||||
* outside address for a picture (Gravatar is told a hash of the person's email). The browser never does: pictures are fetched and kept by the server.
|
||||
*/
|
||||
export interface ProfilePictureSettings {
|
||||
/** gravatar.com, by a hash of the person's email address. */
|
||||
gravatar: boolean;
|
||||
/** The picture the identity provider (Authentik) names for the person in its "picture" claim. */
|
||||
identityProvider: boolean;
|
||||
}
|
||||
|
||||
/** How the agents out on the servers are kept up to date. Off until an administrator turns it on. */
|
||||
export interface AgentSettings {
|
||||
/** An agent that is behind downloads the newer script from this app, checks it and replaces itself. */
|
||||
@@ -215,6 +226,7 @@ export interface AppSettings {
|
||||
healthChecks: HealthCheckSettings;
|
||||
digest: DigestSettings;
|
||||
signIn: SignInSettings;
|
||||
profilePictures: ProfilePictureSettings;
|
||||
inventory: InventorySettings;
|
||||
selfBackup: SelfBackupSettings;
|
||||
agents: AgentSettings;
|
||||
@@ -258,6 +270,7 @@ const DEFAULTS: AppSettings = {
|
||||
inventory: { currency: "", pricePerKwh: null },
|
||||
agents: { autoUpdate: false },
|
||||
selfBackup: { enabled: true, time: "03:30", keep: 14 },
|
||||
profilePictures: { gravatar: false, identityProvider: false },
|
||||
signIn: { roleFromGroups: false, groupsClaim: "groups", adminGroups: [], operatorGroups: [], otherwise: "viewer" },
|
||||
healthChecks: { serverOfflineMinutes: 60, diskUsagePercent: 90, domainWarnDays: 30, diskForecastDays: 14, backupStaleHours: 48, restoreTestDays: 0 },
|
||||
// Docker's default bridge (172.17.0.0/16) and the pool it hands custom networks from (172.18–31) live here, and every
|
||||
|
||||
@@ -0,0 +1,252 @@
|
||||
/**
|
||||
* Profile pictures: where they may come from, what is accepted, that nothing is asked of anyone while the settings are off, and that the
|
||||
* browser only ever talks to this app.
|
||||
*
|
||||
* Run with: npm test --workspace server
|
||||
*/
|
||||
import { test, describe, before, after, beforeEach } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import { createHash } from "node:crypto";
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import type { AddressInfo } from "node:net";
|
||||
import type { Server } from "node:http";
|
||||
|
||||
const dir = mkdtempSync(join(tmpdir(), "hm-avatars-"));
|
||||
process.env.DATABASE_PATH = join(dir, "test.sqlite");
|
||||
process.env.SESSION_DIR = join(dir, "sessions");
|
||||
process.env.CREDENTIALS_ENCRYPTION_KEY = "ab".repeat(32);
|
||||
process.env.HEALTH_STARTUP_GRACE_MS = "0";
|
||||
process.env.AUTHENTIK_ISSUER_URL = "https://auth.example.lan/application/o/homelab/";
|
||||
|
||||
const express = (await import("express")).default;
|
||||
const { db } = await import("../src/db/client.js");
|
||||
const { users } = await import("../src/db/schema.js");
|
||||
const { runMigrations } = await import("../src/db/migrate.js");
|
||||
const { avatarsRouter } = await import("../src/routes/avatars.js");
|
||||
const { meRouter } = await import("../src/routes/me.js");
|
||||
const { usersRouter } = await import("../src/routes/users.js");
|
||||
const { upsertUserFromLogin } = await import("../src/auth/users.js");
|
||||
const { updateSettings } = await import("../src/services/settingsStore.js");
|
||||
const { gravatarHash, gravatarUrl, isAllowedPictureUrl, pictureFromClaims, avatarSources, avatarUrlFor, getAvatar, setAvatarFetcherForTests } = await import("../src/services/avatars.js");
|
||||
|
||||
await runMigrations();
|
||||
|
||||
const IDP = "auth.example.lan";
|
||||
const PNG = Buffer.from("89504e470d0a1a0a0000000d49484452", "hex");
|
||||
const none = { gravatar: false, identityProvider: false };
|
||||
const both = { gravatar: true, identityProvider: true };
|
||||
|
||||
describe("where a picture may come from", () => {
|
||||
test("Gravatar gets a hash of the address — trimmed, lower case, SHA-256 — never the address itself", () => {
|
||||
const hash = createHash("sha256").update("olga@example.com").digest("hex");
|
||||
assert.equal(gravatarHash(" Olga@Example.COM "), hash);
|
||||
assert.equal(gravatarUrl("Olga@example.com"), `https://gravatar.com/avatar/${hash}?s=128&d=404`);
|
||||
assert.equal(gravatarUrl("Olga@example.com").includes("olga"), false);
|
||||
});
|
||||
|
||||
test("only Gravatar over HTTPS and the identity provider's own host are allowed", () => {
|
||||
assert.equal(isAllowedPictureUrl("https://gravatar.com/avatar/abc", IDP), true);
|
||||
assert.equal(isAllowedPictureUrl("https://secure.gravatar.com/avatar/abc", IDP), true);
|
||||
assert.equal(isAllowedPictureUrl("http://gravatar.com/avatar/abc", IDP), false, "Gravatar only over HTTPS");
|
||||
assert.equal(isAllowedPictureUrl("https://auth.example.lan/media/me.png", IDP), true);
|
||||
assert.equal(isAllowedPictureUrl("http://auth.example.lan/media/me.png", IDP), true, "the provider's own host may be plain HTTP on a LAN");
|
||||
for (const bad of ["https://evil.example/me.png", "https://gravatar.com.evil.example/a", "https://evilgravatar.com/a", "http://169.254.169.254/latest", "https://user:pw@auth.example.lan/x", "file:///etc/passwd", "not a url"]) {
|
||||
assert.equal(isAllowedPictureUrl(bad, IDP), false, bad);
|
||||
}
|
||||
assert.equal(isAllowedPictureUrl("https://auth.example.lan/x", null), false, "with no provider known, only Gravatar");
|
||||
});
|
||||
|
||||
test("the picture claim is read from the ID token or userinfo, and only if it is an address", () => {
|
||||
assert.equal(pictureFromClaims([{ sub: "a" }, { picture: "https://auth.example.lan/media/me.png" }]), "https://auth.example.lan/media/me.png");
|
||||
assert.equal(pictureFromClaims([{ picture: "not an address" }, { picture: "https://x.example/p.png" }]), "https://x.example/p.png", "an unusable claim is skipped for a usable one");
|
||||
assert.equal(pictureFromClaims([{ picture: "javascript:alert(1)" }, { picture: 5 }, { picture: "" }, { picture: "https://x/" + "a".repeat(600) }]), undefined);
|
||||
});
|
||||
|
||||
test("the provider's picture is tried before Gravatar; each needs its own setting; a claim naming Gravatar needs Gravatar on", () => {
|
||||
const user = { email: "olga@example.com", pictureUrl: "https://auth.example.lan/media/olga.png" };
|
||||
assert.deepEqual(avatarSources(user, none, IDP), []);
|
||||
assert.deepEqual(avatarSources(user, { gravatar: false, identityProvider: true }, IDP), ["https://auth.example.lan/media/olga.png"]);
|
||||
assert.deepEqual(avatarSources(user, { gravatar: true, identityProvider: false }, IDP), [gravatarUrl("olga@example.com")]);
|
||||
assert.deepEqual(avatarSources(user, both, IDP), ["https://auth.example.lan/media/olga.png", gravatarUrl("olga@example.com")]);
|
||||
const viaGravatar = { email: null, pictureUrl: gravatarUrl("olga@example.com") };
|
||||
assert.deepEqual(avatarSources(viaGravatar, { gravatar: false, identityProvider: true }, IDP), [], "that would tell Gravatar all the same");
|
||||
assert.deepEqual(avatarSources(viaGravatar, both, IDP), [gravatarUrl("olga@example.com")], "and one address is not asked twice");
|
||||
assert.deepEqual(avatarSources({ email: "no-at-sign", pictureUrl: "https://evil.example/x.png" }, both, IDP), [], "a claim naming anywhere else, and no address, is no source");
|
||||
});
|
||||
|
||||
test("the address the page uses changes when the source does, and is null with nothing to look for", () => {
|
||||
const a = avatarUrlFor({ id: 7, email: "a@example.com", pictureUrl: null }, { gravatar: true, identityProvider: false })!;
|
||||
const b = avatarUrlFor({ id: 7, email: "b@example.com", pictureUrl: null }, { gravatar: true, identityProvider: false })!;
|
||||
assert.match(a, /^\/api\/avatars\/7\?v=[0-9a-f]{8}$/);
|
||||
assert.notEqual(a, b);
|
||||
assert.equal(avatarUrlFor({ id: 7, email: "a@example.com", pictureUrl: null }, none), null);
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetching and keeping", () => {
|
||||
let calls: string[] = [];
|
||||
const image = (type = "image/png", body: Buffer = PNG) => new Response(body, { status: 200, headers: { "content-type": type } });
|
||||
const answer = (fn: (url: string) => Response) => setAvatarFetcherForTests(async (url) => (calls.push(url), fn(url)));
|
||||
const user = { email: "olga@example.com", pictureUrl: null };
|
||||
const on = { gravatar: true, identityProvider: false };
|
||||
|
||||
beforeEach(() => {
|
||||
calls = [];
|
||||
});
|
||||
after(() => setAvatarFetcherForTests(null));
|
||||
|
||||
test("nothing is asked of anyone while both settings are off", async () => {
|
||||
answer(() => image());
|
||||
assert.equal(await getAvatar(user, none), null);
|
||||
assert.deepEqual(calls, []);
|
||||
});
|
||||
|
||||
test("a picture comes back with its type, and is kept so the next ask does not go out again", async () => {
|
||||
answer(() => image());
|
||||
const first = await getAvatar(user, on);
|
||||
assert.equal(first?.contentType, "image/png");
|
||||
assert.deepEqual(first?.body, PNG);
|
||||
await getAvatar(user, on);
|
||||
assert.equal(calls.length, 1);
|
||||
assert.equal(calls[0], gravatarUrl("olga@example.com"));
|
||||
});
|
||||
|
||||
test("no picture (404) is kept for a while too, and falls through to the next source", async () => {
|
||||
answer((url) => (url.includes("auth.example.lan") ? new Response("", { status: 404 }) : image("image/jpeg")));
|
||||
const both_ = { user: { email: "olga@example.com", pictureUrl: "https://auth.example.lan/media/olga.png" }, settings: both };
|
||||
assert.equal((await getAvatar(both_.user, both_.settings))?.contentType, "image/jpeg", "the provider had none, so Gravatar's");
|
||||
await getAvatar(both_.user, both_.settings);
|
||||
assert.equal(calls.filter((c) => c.includes("auth.example.lan")).length, 1, "the provider is not asked again straight away");
|
||||
});
|
||||
|
||||
test("only small PNG, JPEG, WebP and GIF are accepted — not SVG, not HTML, not something huge", async () => {
|
||||
answer(() => image("image/svg+xml", Buffer.from("<svg onload=alert(1)/>")));
|
||||
assert.equal(await getAvatar({ email: "svg@example.com", pictureUrl: null }, on), null);
|
||||
answer(() => image("text/html", Buffer.from("<script>")));
|
||||
assert.equal(await getAvatar({ email: "html@example.com", pictureUrl: null }, on), null);
|
||||
answer(() => image("image/png", Buffer.alloc(300 * 1024)));
|
||||
assert.equal(await getAvatar({ email: "big@example.com", pictureUrl: null }, on), null);
|
||||
answer(() => new Response(PNG, { status: 200, headers: { "content-type": "image/png", "content-length": "9999999" } }));
|
||||
assert.equal(await getAvatar({ email: "declared@example.com", pictureUrl: null }, on), null);
|
||||
});
|
||||
|
||||
test("a redirect is followed only to an address that is allowed, and not for ever", async () => {
|
||||
answer((url) => (url.startsWith("https://gravatar.com/") ? new Response("", { status: 302, headers: { location: "https://secure.gravatar.com/avatar/x" } }) : image()));
|
||||
assert.ok(await getAvatar({ email: "r1@example.com", pictureUrl: null }, on));
|
||||
assert.equal(calls.length, 2);
|
||||
|
||||
calls = [];
|
||||
answer(() => new Response("", { status: 302, headers: { location: "http://169.254.169.254/latest/meta-data" } }));
|
||||
assert.equal(await getAvatar({ email: "r2@example.com", pictureUrl: null }, on), null);
|
||||
assert.equal(calls.length, 1, "the metadata address was never asked");
|
||||
|
||||
calls = [];
|
||||
answer((url) => new Response("", { status: 302, headers: { location: url + "x" } }));
|
||||
assert.equal(await getAvatar({ email: "r3@example.com", pictureUrl: null }, on), null);
|
||||
assert.ok(calls.length <= 3, "a redirect loop ends");
|
||||
});
|
||||
|
||||
test("an unreachable host gives no picture and does not throw; it is tried again soon, not every page view", async () => {
|
||||
setAvatarFetcherForTests(async (url) => {
|
||||
calls.push(url);
|
||||
throw new Error("connection refused");
|
||||
});
|
||||
assert.equal(await getAvatar({ email: "down@example.com", pictureUrl: null }, on), null);
|
||||
await getAvatar({ email: "down@example.com", pictureUrl: null }, on);
|
||||
assert.equal(calls.length, 1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("through the routes", () => {
|
||||
let app: Server;
|
||||
let base = "";
|
||||
let who = "olga";
|
||||
let olgaId = 0;
|
||||
let fetched: string[] = [];
|
||||
|
||||
before(async () => {
|
||||
const a = express();
|
||||
a.use(express.json());
|
||||
a.use((req, _res, next) => {
|
||||
(req as unknown as { session: unknown }).session = { user: { sub: who } };
|
||||
next();
|
||||
});
|
||||
a.use("/api/me", meRouter);
|
||||
a.use("/api/avatars", avatarsRouter);
|
||||
a.use("/api/users", usersRouter);
|
||||
app = await new Promise<Server>((resolve) => {
|
||||
const s = a.listen(0, "127.0.0.1", () => resolve(s));
|
||||
});
|
||||
base = `http://127.0.0.1:${(app.address() as AddressInfo).port}/api`;
|
||||
|
||||
// Through the sign-in code, as a login would: the first person is the administrator, and the picture claim is kept.
|
||||
const olga = await upsertUserFromLogin({ sub: "olga", email: "Olga@example.com", name: "Olga", pictureUrl: "https://auth.example.lan/media/olga.png" });
|
||||
olgaId = olga.user.id;
|
||||
await upsertUserFromLogin({ sub: "vic", email: "vic@example.com", name: "Vic" });
|
||||
setAvatarFetcherForTests(async (url) => {
|
||||
fetched.push(url);
|
||||
return url.includes("auth.example.lan") ? new Response("", { status: 404 }) : new Response(PNG, { status: 200, headers: { "content-type": "image/png" } });
|
||||
});
|
||||
});
|
||||
|
||||
after(() => {
|
||||
app.close();
|
||||
setAvatarFetcherForTests(null);
|
||||
try {
|
||||
rmSync(dir, { recursive: true, force: true });
|
||||
} catch {
|
||||
// Windows keeps the database file locked until the process exits.
|
||||
}
|
||||
});
|
||||
|
||||
const get = (path: string) => fetch(`${base}${path}`);
|
||||
|
||||
test("the picture claim from the sign-in is kept, and is still there when a later sign-in carries none", async () => {
|
||||
const [row] = await db.select().from(users);
|
||||
assert.equal(row.pictureUrl, "https://auth.example.lan/media/olga.png");
|
||||
await upsertUserFromLogin({ sub: "olga", email: "Olga@example.com", name: "Olga" });
|
||||
assert.equal((await db.select().from(users)).find((u) => u.oidcSub === "olga")!.pictureUrl, "https://auth.example.lan/media/olga.png");
|
||||
});
|
||||
|
||||
test("with the settings off there is no picture address for anyone and nothing is fetched", async () => {
|
||||
assert.equal((await (await get("/me")).json()).user.avatarUrl, null);
|
||||
assert.equal((await get(`/avatars/${olgaId}`)).status, 404);
|
||||
const list = (await (await get("/users")).json()).users as { avatarUrl: string | null }[];
|
||||
assert.deepEqual(list.map((u) => u.avatarUrl), [null, null]);
|
||||
assert.deepEqual(fetched, []);
|
||||
});
|
||||
|
||||
test("turned on, the browser is given an address on this app, and the picture is served from here with safe headers", async () => {
|
||||
await updateSettings({ profilePictures: { gravatar: true, identityProvider: true } });
|
||||
const me = (await (await get("/me")).json()).user;
|
||||
assert.match(me.avatarUrl, new RegExp(`^/api/avatars/${olgaId}\\?v=`));
|
||||
|
||||
who = "vic"; // anyone signed in may see anyone's picture
|
||||
const res = await fetch(`${base.slice(0, -"/api".length)}${me.avatarUrl}`);
|
||||
assert.equal(res.status, 200);
|
||||
assert.equal(res.headers.get("content-type"), "image/png");
|
||||
assert.match(res.headers.get("cache-control") ?? "", /private, max-age=\d+/);
|
||||
assert.match(res.headers.get("content-security-policy") ?? "", /sandbox/);
|
||||
assert.deepEqual(Buffer.from(await res.arrayBuffer()), PNG);
|
||||
assert.deepEqual(fetched[0], "https://auth.example.lan/media/olga.png", "the provider is tried first");
|
||||
assert.equal(fetched[1], gravatarUrl("olga@example.com"), "then Gravatar, with the address lower-cased and hashed");
|
||||
who = "olga";
|
||||
});
|
||||
|
||||
test("the Users page is told who has a picture to look for; someone unknown or a bad id is simply not found", async () => {
|
||||
const list = (await (await get("/users")).json()).users as { name: string; avatarUrl: string | null }[];
|
||||
assert.match(list.find((u) => u.name === "Olga")!.avatarUrl!, /^\/api\/avatars\//);
|
||||
assert.equal((await get("/avatars/99999")).status, 404);
|
||||
assert.equal((await get("/avatars/abc")).status, 404);
|
||||
assert.equal((await get("/avatars/1e3")).status, 404);
|
||||
});
|
||||
|
||||
test("a person with no email and no usable claim has no picture to look for", async () => {
|
||||
await upsertUserFromLogin({ sub: "nomail", name: "No Mail" });
|
||||
who = "nomail";
|
||||
assert.equal((await (await get("/me")).json()).user.avatarUrl, null);
|
||||
who = "olga";
|
||||
});
|
||||
});
|
||||
@@ -158,7 +158,8 @@ describe("the Users routes", () => {
|
||||
assert.equal(body.rolesFollowGroups, true);
|
||||
const olga = body.users.find((u: { name: string }) => u.name === "olga");
|
||||
assert.deepEqual(olga.groups, ["cooks"]);
|
||||
assert.deepEqual(Object.keys(olga).sort(), ["createdAt", "email", "groups", "id", "lastLoginAt", "name", "oidcSub", "role"]);
|
||||
assert.deepEqual(Object.keys(olga).sort(), ["avatarUrl", "createdAt", "email", "groups", "id", "lastLoginAt", "name", "oidcSub", "role"]);
|
||||
assert.equal(olga.avatarUrl, null, "no picture source is on, so none to look for");
|
||||
});
|
||||
|
||||
test("a role can't be set by hand while groups decide it", async () => {
|
||||
|
||||
Reference in new issue
Block a user