fix: harden v2 custom widgets and Workshop (#6480)

This commit is contained in:
Thomas authored and GitHub committed 2026-07-31 13:28:53 +02:00
1 parent e8a2c87c2d
commit 557ebe0a2f
138 files changed
+5151 -1976

No files matched your search

+60 -3
View File
@@ -1,9 +1,14 @@
import { customWidgetImportSchema } from "@homarr/custom-widgets/core";
import { CUSTOM_WIDGET_SCHEMA, customWidgetImportSchema } from "@homarr/custom-widgets/core";
import { z } from "zod/v4";
export const WORKSHOP_API_URL = "https://homarr.dev";
export const WORKSHOP_WEB_URL = "https://homarr.dev/workshop";
export const HOMARR_WEBSITE_URL = "https://homarr.dev";
export const WORKSHOP_API_URL = HOMARR_WEBSITE_URL;
export const WORKSHOP_WEB_URL = `${HOMARR_WEBSITE_URL}/workshop`;
export const WORKSHOP_CSS_SCHEMA = "homarr-custom-css-v1";
export const WORKSHOP_SCHEMA_BY_TYPE = {
customWidget: CUSTOM_WIDGET_SCHEMA,
customCss: WORKSHOP_CSS_SCHEMA,
} as const;
export const MAX_WORKSHOP_CSS_LENGTH = 16_384;
export const MAX_WORKSHOP_CONTENT_LENGTH = 1_000_000;
export const MAX_WORKSHOP_SCREENSHOTS = 5;
@@ -11,6 +16,58 @@ export const MAX_WORKSHOP_SCREENSHOT_BYTES = 5 * 1024 * 1024;
export const WORKSHOP_REQUEST_TIMEOUT_MS = 8_000;
export const WORKSHOP_SCREENSHOT_MIME_TYPES = ["image/png", "image/jpeg", "image/webp"] as const;
export interface HomarrUrlConfig {
homarrWebsiteUrl: string;
workshopApiUrl: string;
workshopWebUrl: string;
}
export interface HomarrUrlConfigInput {
homarrWebsiteUrl?: string;
workshopApiUrl?: string;
workshopWebUrl?: string;
}
export function normalizeHttpUrl(value: string, variableName: string): string {
if (value !== value.trim() || hasAsciiControl(value)) {
throw new Error(`${variableName} must not include surrounding whitespace or control characters`);
}
let url: URL;
try {
url = new URL(value);
} catch {
throw new Error(`${variableName} must be a valid absolute HTTP(S) URL`);
}
if (url.protocol !== "http:" && url.protocol !== "https:") {
throw new Error(`${variableName} must use HTTP or HTTPS`);
}
if (url.username || url.password) {
throw new Error(`${variableName} must not include credentials`);
}
if (url.search || url.hash) {
throw new Error(`${variableName} must not include a query string or fragment`);
}
return url.toString().replace(/\/+$/u, "");
}
function hasAsciiControl(value: string): boolean {
return [...value].some((character) => {
const code = character.codePointAt(0) ?? 0;
return code <= 31 || code === 127;
});
}
export function resolveHomarrUrlConfig(input: HomarrUrlConfigInput = {}): HomarrUrlConfig {
const homarrWebsiteUrl = normalizeHttpUrl(input.homarrWebsiteUrl ?? HOMARR_WEBSITE_URL, "HOMARR_WEBSITE_URL");
const workshopApiUrl = normalizeHttpUrl(input.workshopApiUrl ?? homarrWebsiteUrl, "WORKSHOP_API_URL");
const workshopWebUrl = normalizeHttpUrl(input.workshopWebUrl ?? `${homarrWebsiteUrl}/workshop`, "WORKSHOP_WEB_URL");
return { homarrWebsiteUrl, workshopApiUrl, workshopWebUrl };
}
export const workshopReportCategorySchema = z.enum(["malicious", "spam", "copyright", "inappropriate", "other"]);
export const workshopSubmissionTypeSchema = z.enum(["customWidget", "customCss"]);
export type WorkshopSubmissionType = z.infer<typeof workshopSubmissionTypeSchema>;