import { existsSync } from "node:fs"; import { chmod, mkdir, symlink, writeFile } from "node:fs/promises"; import { join } from "node:path"; import { describe, expect, it } from "vitest"; import { createTestTempDirectory } from "../../tests/fixtures/temporaryDirectory.js"; import { APT_LOCATIONS, inspectAptRepositories, resolveAptLocations, } from "./AptRepositoryInventory.js"; import { runHostQuery, type QueryRunner } from "./HostQuery.js"; import { GPGV_A_ONLY, VENDOR_A, VENDOR_B, } from "../domain/desktop/aptKeys.fixture.js"; it.each(["list", "sources"] as const)( "does not broaden %s Signed-By fingerprint restrictions to every key in a keyring", async (format) => { const root = await createTestTempDirectory("apt-signed-by-"); const sources = join(root, `vendor.${format}`); const key = join(root, "vendor.gpg"); const trustedParts = join(root, "trusted.gpg.d"); await mkdir(trustedParts); await writeFile(key, VENDOR_A.key); await writeFile( join(root, "vendor.example_repo_InRelease"), "controlled release", ); const source = "https://vendor.example/repo stable/main amd64 Packages"; const targets = [ `Description: ${source}`, `Sourcesentry: ${sources}:1`, "Repo-URI: https://vendor.example/repo/", "Release: stable", "Component: main", "Base-URI: https://vendor.example/repo/", `Filename: ${join(root, "Packages")}`, ].join("\n"); let verifications = 0; const runQuery: QueryRunner = async (command) => { if (command === "apt-get") return { stdout: targets, exitCode: 0 }; if (command !== "gpgv") throw new Error(`Unexpected query ${command}`); verifications += 1; return { stdout: GPGV_A_ONLY, exitCode: 1 }; }; const inspect = async (signedBy: string) => { await writeFile( sources, format === "list" ? `deb [signed-by=${signedBy.replaceAll(" ", ",")}] https://vendor.example/repo stable main\n` : `Types: deb\nURIs: https://vendor.example/repo\nSuites: stable\nComponents: main\nSigned-By: ${signedBy}\n`, ); return inspectAptRepositories( { sources: [source], origins: ["Vendor"] }, { runQuery, apt: { lists: root, trustedParts, trusted: key }, }, undefined, ); }; const pathOnly = await inspect(key); expect(pathOnly.repositories[0]?.signing_key).toMatchObject({ path: key, fingerprint: VENDOR_A.fingerprint, }); expect(pathOnly.keys.size).toBe(1); for (const selector of [VENDOR_B.fingerprint, `${VENDOR_B.fingerprint}!`]) { for (const signedBy of [selector, `${key} ${selector}`]) { const restricted = await inspect(signedBy); expect(restricted.repositories[0]).toMatchObject({ source, sources_file: sources, uri: "https://vendor.example/repo", suite: "stable", components: ["main"], signing_key: null, signing_key_reason: expect.stringContaining(selector), }); expect(restricted.repositories[0]?.signing_key_reason).toContain( "not supported", ); expect(restricted.keys.size).toBe(0); } } expect(verifications).toBe(1); }, ); describe.skipIf(process.platform === "win32" || process.getuid?.() === 0)( "an InRelease the check cannot reach beside a readable detached pair", () => { it("keeps the release.gpg and Release files apt still holds", async () => { const root = await createTestTempDirectory("apt-inrelease-"); const lists = join(root, "lists"); const sources = join(root, "vendor.list"); const key = join(root, "vendor.gpg"); const trustedParts = join(root, "trusted.gpg.d"); // A symlink into a folder the check cannot search makes InRelease alone unprobeable. const denied = join(root, "denied"); await mkdir(lists); await mkdir(trustedParts); await mkdir(denied); await writeFile(key, VENDOR_A.key); // A symlink into a folder the check cannot search makes InRelease alone unprobeable. const released = "vendor.example_repo_"; await writeFile( join(denied, `${released}InRelease`), "controlled release", ); await symlink( join(denied, `${released}InRelease`), join(lists, `${released}InRelease`), ); await writeFile(join(lists, `${released}Release.gpg`), "signature"); await writeFile(join(lists, `${released}Release`), "controlled release"); await chmod(denied, 0o000); try { const source = "https://vendor.example/repo stable/main amd64 Packages"; const targets = [ `Description: ${source}`, `Sourcesentry: ${sources}:1`, "Repo-URI: https://vendor.example/repo/", "Release: stable", "Component: main", "Base-URI: https://vendor.example/repo/", `Filename: ${join(lists, `${released}Packages`)}`, ].join("\n"); const verified: string[][] = []; const runQuery: QueryRunner = async (command, argv) => { if (command === "apt-get") return { stdout: targets, exitCode: 0 }; if (command !== "gpgv") throw new Error(`Unexpected query ${command}`); verified.push(argv.slice(argv.indexOf("--keyring") + 2)); return { stdout: GPGV_A_ONLY, exitCode: 1 }; }; await writeFile( sources, `deb [signed-by=${key}] https://vendor.example/repo stable main\n`, ); const result = await inspectAptRepositories( { sources: [source], origins: ["Vendor"] }, { runQuery, apt: { lists, trustedParts, trusted: key }, }, undefined, ); expect(result.repositories[0]?.signing_key).toMatchObject({ fingerprint: VENDOR_A.fingerprint, }); expect(verified).toEqual([ [ join(lists, `${released}Release.gpg`), join(lists, `${released}Release`), ], ]); } finally { await chmod(denied, 0o755); } }); }, ); describe.skipIf(process.platform === "win32" || process.getuid?.() === 0)( "an InRelease the check cannot reach with no detached pair beside it", () => { it("leaves the signed release unknown instead of reporting none", async () => { // Only an InRelease known to be missing establishes that apt holds no // signed release. An unprobed one may still be there, so the check has to // report that it could not tell rather than absence. const root = await createTestTempDirectory("apt-inrelease-unknown-"); const lists = join(root, "lists"); const sources = join(root, "vendor.list"); const key = join(root, "vendor.gpg"); const trustedParts = join(root, "trusted.gpg.d"); const denied = join(root, "denied"); await mkdir(lists); await mkdir(trustedParts); await mkdir(denied); await writeFile(key, VENDOR_A.key); const released = "vendor.example_repo_"; await writeFile( join(denied, `${released}InRelease`), "controlled release", ); await symlink( join(denied, `${released}InRelease`), join(lists, `${released}InRelease`), ); await chmod(denied, 0o000); try { const source = "https://vendor.example/repo stable/main amd64 Packages"; const targets = [ `Description: ${source}`, `Sourcesentry: ${sources}:1`, "Repo-URI: https://vendor.example/repo/", "Release: stable", "Component: main", "Base-URI: https://vendor.example/repo/", `Filename: ${join(lists, `${released}Packages`)}`, ].join("\n"); const runQuery: QueryRunner = async (command) => { if (command === "apt-get") return { stdout: targets, exitCode: 0 }; throw new Error(`Unexpected query ${command}`); }; await writeFile( sources, `deb [signed-by=${key}] https://vendor.example/repo stable main\n`, ); const result = await inspectAptRepositories( { sources: [source], origins: ["Vendor"] }, { runQuery, apt: { lists, trustedParts, trusted: key }, }, undefined, ); expect(result.repositories[0]?.signing_key).toBeNull(); expect(result.repositories[0]?.signing_key_reason).toContain( "could not be checked", ); } finally { await chmod(denied, 0o755); } }); }, ); describe.skipIf( process.platform !== "linux" || !existsSync("/usr/bin/apt-config"), )("resolveAptLocations with apt-config", () => { it("preserves newline paths printed by the real apt-config command", async () => { const root = await createTestTempDirectory("apt-config-newline-"); const selected = { lists: `${root}/user's\nlists/`, trustedParts: `${root}/trusted\nparts/`, trusted: `${root}/trusted\nkeys.gpg`, }; const configured: QueryRunner = (command, argv, signal) => runHostQuery( command, [ "-o", `Dir::State::Lists=${selected.lists}`, "-o", `Dir::Etc::TrustedParts=${selected.trustedParts}`, "-o", `Dir::Etc::Trusted=${selected.trusted}`, ...argv, ], signal, ); expect(await resolveAptLocations(configured, undefined)).toEqual(selected); }); it("reads the lists folder an APT_CONFIG file names, resolved under Dir::State", async () => { const root = await createTestTempDirectory("apt-config-"); const config = join(root, "apt.conf"); await writeFile( config, `Dir::State "${root}/state";\nDir::State::Lists "user lists";\n`, ); const configured: QueryRunner = (command, argv, signal) => runHostQuery("env", [`APT_CONFIG=${config}`, command, ...argv], signal); const locations = await resolveAptLocations(configured, undefined); expect(locations).toEqual({ lists: `${root}/state/user lists/`, trustedParts: "/etc/apt/trusted.gpg.d/", trusted: "/etc/apt/trusted.gpg", }); expect( await resolveAptLocations( (_command, argv, signal) => runHostQuery("/missing/apt-config", argv, signal), undefined, ), ).toEqual(APT_LOCATIONS); }); });