Skip to content

Security: kaiiiichen/buttercut

Security

SECURITY.md

Security Policy

Buttercut is a theme, not a hosted service, so most exposure depends on how you deploy it. We still take reports seriously for issues that affect the theme itself.

Reporting a vulnerability

  • Open a private advisory via GitHub's "Report a vulnerability" button on the repository's Security tab. Please include reproduction steps and the commit hash you tested against.
  • Do not open a public issue for sensitive reports.
  • Please allow up to 14 days for an initial response.

Scope

In scope:

  • XSS, CSRF, SSRF, injection, or auth bypass introduced by theme code.
  • Accidental leaking of secrets through the default demo content, build artefacts, or generated metadata.
  • Config-driven features that can be abused to include unsafe content at render time.

Out of scope:

  • Third-party services reached via the optional integrations (GitHub, Last.fm, Open-Meteo, Sentry, Supabase). Please report those to the respective providers.
  • Problems caused solely by user-provided site.config.ts values (e.g. pasted HTML into demo content).
  • Issues that only reproduce on forks with additional custom code.

Defensive defaults

  • Zero-key local runs: every integration degrades to a placeholder when its env vars are missing.
  • buildButtercutThemeStyle sanitises brand.theme.* tokens before they reach the document — invalid/overlong values are dropped silently.
  • Note slugs are matched against /^[A-Za-z0-9_-]+$/ before any fs read and the /notes/[slug] route pins dynamicParams = false, so only pre-rendered files can be served.
  • Long-form notes are MDX compiled at build time and rendered inside ButtercutProse. Treat content/demo/notes like source code—do not pipe untrusted user input through MDX without a separate hardening story.
  • Short copy uses renderButtercutInlineMarkdown (no raw HTML); it is intended for trusted author strings in config and JSON only.

Thanks for helping keep Buttercut safe.

There aren't any published security advisories