/** * 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(""))); assert.equal(await getAvatar({ email: "svg@example.com", pictureUrl: null }, on), null); answer(() => image("text/html", Buffer.from("