Files
inkwell/src/thoughtsync/settings.py
T
bvandeusenandClaude Opus 4.8 69bf04e948
CI & Build / Python lint (push) Successful in 3s
CI & Build / Python tests (push) Successful in 12s
CI & Build / TypeScript typecheck (push) Successful in 34s
CI & Build / Build & push image (push) Successful in 33s
M6 1901: URL capture with link-preview unfurl (SSRF-hardened)
Paste a link → fetch its OpenGraph/meta preview (title, description, image,
site) and show a rich card. User-triggered + persisted (never auto-fetches;
cached so it never re-fetches). Opt-in via a new admin setting
enable_url_unfurl (default on, rule 26).

Security (the whole point of this task): a new dependency-free unfurl.py
does the fetch with layered SSRF defenses — http/https only; resolve the
host and reject EVERY non-public address (private/loopback/link-local/
reserved/multicast/unspecified — blocks 169.254.169.254 etc.); connect to
the vetted IP with SNI so DNS-rebinding can't slip through; ≤3 redirects
each re-validated; 5s timeout; 512 KB cap; text/html only; blocking IO in a
worker thread. No server-side image fetch — the og:image URL is loaded by
the browser.

- note_link_previews table (migration 0020), one per (note, url); serialized
  inline on notes (+ rides the sync pull feed read-only).
- POST /api/notes/<id>/unfurl {url} (owner-scoped, setting-gated, 502 on
  fetch failure); DELETE /api/notes/<id>/previews/<id>.
- enable_url_unfurl exposed in public config so the UI hides the affordance
  when disabled.

Frontend: LinkPreview.vue card; editor detects URLs in the body and offers a
"Preview <domain>" chip per un-previewed link (ensureDraft first), renders
preview cards with remove; card shows previews read-only. New link icon;
notes-store unfurl()/deletePreview().

Tests (DB-free): is_public_ip range blocking, validate_url scheme/parts,
extract_preview (OG + <title> fallback + relative-image resolve), endpoint
auth-guards.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FRgehjoz7Yv8LkUfADxACm
2026-07-23 08:05:24 -04:00

186 lines
5.4 KiB
Python

from __future__ import annotations
import json
import secrets
from dataclasses import dataclass
from datetime import datetime, timezone
from typing import Any, Literal
from .models.settings import Setting
SettingType = Literal["string", "bool", "int"]
@dataclass(frozen=True)
class SettingDef:
key: str
type: SettingType
default: Any
label: str
description: str
group: str
# The source of truth for every user-facing setting. Add a row here and it appears
# in the admin Settings UI with a working default — no migration, no env var.
REGISTRY: list[SettingDef] = [
SettingDef(
"site_name", "string", "ThoughtSync", "Site name", "Shown in the header and the browser tab.", "General"
),
SettingDef(
"allow_registration",
"bool",
True,
"Allow new registrations",
"When off, only existing users can sign in. The first account is always allowed.",
"Access",
),
SettingDef(
"session_ttl_days",
"int",
30,
"Session length (days)",
"How long a signed-in session stays valid before another login is required.",
"Access",
),
SettingDef(
"max_attachment_mb",
"int",
25,
"Max attachment size (MB)",
"Largest single file that can be attached to a note. Capped by the server body limit.",
"Attachments",
),
SettingDef(
"enable_url_unfurl",
"bool",
True,
"Link previews",
"Let the server fetch a page's title/description/image to preview pasted links. "
"The server contacts the linked site; private/internal addresses are always blocked.",
"Links",
),
]
_BY_KEY: dict[str, SettingDef] = {d.key: d for d in REGISTRY}
# Internal, non-UI reserved key: the persisted cookie-signing secret. Stored in the
# same table but never listed in the registry, so it never shows in the Settings UI.
SECRET_KEY_SETTING = "secret_key"
def _coerce_bool(raw: Any) -> bool:
if isinstance(raw, bool):
return raw
if isinstance(raw, str):
return raw.strip().lower() in ("1", "true", "yes", "on")
return bool(raw)
def _coerce(defn: SettingDef, raw: Any) -> Any:
if defn.type == "bool":
return _coerce_bool(raw)
if defn.type == "int":
try:
return int(raw)
except (ValueError, TypeError):
return defn.default
return str(raw)
async def _load_raw(db, key: str) -> Any:
row = await db.get(Setting, key)
if row is None:
return None
try:
return json.loads(row.value)
except (ValueError, TypeError):
return None
async def _upsert(db, key: str, value: Any) -> None:
row = await db.get(Setting, key)
payload = json.dumps(value)
if row is None:
db.add(Setting(key=key, value=payload))
else:
row.value = payload
row.updated_at = datetime.now(timezone.utc)
async def get_setting(db, key: str) -> Any:
defn = _BY_KEY.get(key)
if defn is None:
raise KeyError(key)
raw = await _load_raw(db, key)
return defn.default if raw is None else _coerce(defn, raw)
async def get_public_config(db) -> dict:
"""Non-sensitive settings the unauthenticated login/register screen needs."""
return {
"site_name": await get_setting(db, "site_name"),
"allow_registration": await get_setting(db, "allow_registration"),
"enable_url_unfurl": await get_setting(db, "enable_url_unfurl"),
}
async def get_admin_settings(db) -> list[dict]:
"""Every registry setting with its current value + metadata, for the admin UI."""
result: list[dict] = []
for d in REGISTRY:
result.append(
{
"key": d.key,
"type": d.type,
"value": await get_setting(db, d.key),
"default": d.default,
"label": d.label,
"description": d.description,
"group": d.group,
}
)
return result
def validate_updates(updates: dict) -> tuple[dict, str | None]:
"""Coerce/validate a {key: value} dict against the registry. Returns
(clean_values, error_message). An unknown key or a bad int is rejected."""
clean: dict = {}
for key, val in updates.items():
defn = _BY_KEY.get(key)
if defn is None:
return {}, f"unknown setting: {key}"
if defn.type == "int":
try:
clean[key] = int(val)
except (ValueError, TypeError):
return {}, f"{defn.label} must be a whole number"
elif defn.type == "bool":
clean[key] = _coerce_bool(val)
else:
clean[key] = str(val)
return clean, None
async def set_settings(db, updates: dict) -> None:
for key, value in updates.items():
await _upsert(db, key, value)
async def load_or_create_secret_key(db) -> str:
"""Return the persisted cookie-signing secret, generating + storing one on first
run. Keeps sessions valid across restarts with no env var or volume required."""
row = await db.get(Setting, SECRET_KEY_SETTING)
if row is not None:
try:
val = json.loads(row.value)
if isinstance(val, str) and val:
return val
except (ValueError, TypeError):
pass
key = secrets.token_urlsafe(48)
await _upsert(db, SECRET_KEY_SETTING, key)
await db.commit()
return key