the sidecar, and the two doors
Officer holds the credential; Linkwarden holds the data and decides who may see it. That split is the whole design and it is why there are two doors that look alike from outside and are not. `/lw/*` is the extension's. Unauthenticated, forwarded verbatim, the credential is the caller's own - the same argument Vault's public router makes, that this is one address instead of two rather than new exposure, and it is what lets Linkwarden stop being reachable on its own. `/api/*` is ours. An Officer session names the caller, we find their mapped account and put THEIR token on the request. A browser holding an Officer session never holds a Linkwarden credential, which is the property Vault exists to give, applied per user. Officer decides whose token goes on; Linkwarden decides what it may see, because re-implementing that here would be a second answer able to disagree with the first. `proxiedSubPath: '/lw'` is load-bearing rather than tidy. Claiming the whole prefix would tell the body parser to leave /config alone too, and every field on it would read as missing - the failure caldav hit the day it was extracted. The sidecar is a plain HTTP proxy with no WebSocket: Vaultwarden pushes over SignalR and Linkwarden does not, so a socket here would be scaffolding for a protocol that does not exist. Its onCommand is empty for the same reason - it forwards bytes, and everything that decides anything happens before a request reaches it. Two things measured rather than assumed while writing this. The port announcement typechecks because SidecarPortAnnouncement was generalised, so a plugin no longer needs a platform pull request to announce its own port. And the config URL is the LOOPBACK address, not the advertised one: on alpha the name Linkwarden now advertises resolves to 127.0.1.1, where nothing is bound, so a sidecar running there would dial the name it publishes and get nothing. Typechecks clean. No provisioning and no panel yet.
This commit is contained in:
@@ -0,0 +1,123 @@
|
||||
import { createSidecarConnector } from '@@/sidecar/connect';
|
||||
import { API_URL } from '@@/officer-url.mjs';
|
||||
import { getLinkwardenBase, stripHopByHop, redactPath } from './upstream';
|
||||
|
||||
// The officer-linkwarden sidecar: a singleton process that registers with the API server and owns a
|
||||
// transparent reverse-proxy to a self-hosted Linkwarden. The platform API is a thin forwarder to this;
|
||||
// ALL knowledge of Linkwarden — where it is, whether it is switched on — lives here, which is what lets
|
||||
// the plugin be a plugin rather than something the platform has to learn about.
|
||||
//
|
||||
// ── Pass-through, with one exception that is the point of the plugin ──
|
||||
//
|
||||
// Method, path, query, headers, status and both body streams go through verbatim. Nothing is buffered,
|
||||
// parsed, rewritten or cached. The one exception is the Authorization header on the AUTHENTICATED door:
|
||||
// the platform has already decided who is calling and swapped in that person's Linkwarden token, so a
|
||||
// device holding an Officer session never holds a Linkwarden credential. This process does not do that
|
||||
// swap and does not know the tokens — it forwards what it is handed. See `api/router.ts`.
|
||||
//
|
||||
// ── No WebSocket ──
|
||||
//
|
||||
// Vault's sidecar proxies one, because Vaultwarden pushes notifications over SignalR. Linkwarden has no
|
||||
// equivalent: it is request/response over HTTP, and its own UI polls. A WebSocket path here would be
|
||||
// scaffolding for a protocol that does not exist.
|
||||
|
||||
/** Grab an ephemeral free port by briefly binding one and releasing it. */
|
||||
function getFreePort(): number {
|
||||
const probe = Bun.serve({ port: 0, hostname: '127.0.0.1', fetch: () => new Response('') });
|
||||
const port = probe.port;
|
||||
probe.stop(true);
|
||||
if (port == null) throw new Error('failed to acquire a free port');
|
||||
return port;
|
||||
}
|
||||
|
||||
const PORT = getFreePort();
|
||||
|
||||
Bun.serve({
|
||||
port: PORT,
|
||||
hostname: '127.0.0.1',
|
||||
idleTimeout: 120,
|
||||
|
||||
async fetch(req) {
|
||||
const url = new URL(req.url);
|
||||
|
||||
/*
|
||||
Ours, not part of the contract. Probes the upstream so "is the sidecar up" and "can it reach
|
||||
Linkwarden" are two answerable questions rather than one ambiguous timeout.
|
||||
*/
|
||||
if (url.pathname === '/_health') {
|
||||
const base = await getLinkwardenBase();
|
||||
if (!base) return Response.json({ ok: false, reason: 'unconfigured' }, { status: 503 });
|
||||
try {
|
||||
const probe = await fetch(`${base}/api/v1/auth/providers`, {
|
||||
signal: AbortSignal.timeout(5000),
|
||||
});
|
||||
return Response.json({ ok: probe.ok, upstream: probe.status });
|
||||
} catch {
|
||||
return Response.json({ ok: false, reason: 'unreachable' }, { status: 502 });
|
||||
}
|
||||
}
|
||||
|
||||
const base = await getLinkwardenBase();
|
||||
if (!base) return new Response('Linkwarden is not configured', { status: 503 });
|
||||
|
||||
const target = `${base}${url.pathname}${url.search}`;
|
||||
const hasBody = req.method !== 'GET' && req.method !== 'HEAD';
|
||||
|
||||
const init: RequestInit & { duplex?: 'half' } = {
|
||||
method: req.method,
|
||||
headers: stripHopByHop(req.headers),
|
||||
// `manual`, so a redirect is handed back to the caller exactly as Linkwarden wrote it rather than
|
||||
// being followed here. NextAuth redirects are part of its protocol and a proxy that resolves them
|
||||
// silently changes what the client sees.
|
||||
redirect: 'manual',
|
||||
...(hasBody ? { body: req.body, duplex: 'half' as const } : {}),
|
||||
};
|
||||
|
||||
let upstream: Response;
|
||||
try {
|
||||
upstream = await fetch(target, init);
|
||||
} catch (err) {
|
||||
console.error(
|
||||
`[linkwarden] ${req.method} ${redactPath(url.pathname + url.search)} -> upstream unreachable:`,
|
||||
err instanceof Error ? err.message : String(err),
|
||||
);
|
||||
return new Response('Linkwarden unreachable', { status: 502 });
|
||||
}
|
||||
|
||||
return new Response(upstream.body, {
|
||||
status: upstream.status,
|
||||
headers: stripHopByHop(upstream.headers),
|
||||
});
|
||||
},
|
||||
});
|
||||
|
||||
console.log(`[linkwarden] proxy listening on 127.0.0.1:${PORT}`);
|
||||
|
||||
/*
|
||||
Tell the platform where to find us.
|
||||
|
||||
The port is ephemeral and chosen fresh on every start, so it is not a value anybody configures — it is
|
||||
reported on connect and the platform routes to whatever the last connect said. That is what makes
|
||||
restarting this process invisible to the API server, and it is re-sent on every reconnect rather than
|
||||
once at boot, because the platform may be the side that restarted.
|
||||
*/
|
||||
const connection = createSidecarConnector({
|
||||
apiUrl: `${API_URL}/api/sidecar/register`,
|
||||
name: 'linkwarden',
|
||||
handles: ['linkwarden'],
|
||||
|
||||
/*
|
||||
Required by the connector, and deliberately empty.
|
||||
|
||||
There is no command vocabulary here. Vault has one because it brokers a login; this sidecar only
|
||||
forwards bytes, and everything that decides anything — which user, which token, whether they may —
|
||||
happens on the platform side before a request arrives. A command channel would be a second way to
|
||||
reach a process whose whole value is that it does one thing.
|
||||
*/
|
||||
onCommand() {},
|
||||
|
||||
onConnected() {
|
||||
connection.send({ type: 'linkwarden:server', port: PORT });
|
||||
console.log(`[linkwarden] reported proxy port ${PORT} to API`);
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,89 @@
|
||||
import { getLinkwardenConfig } from '../db/queries';
|
||||
|
||||
// Where Linkwarden is, for the officer-linkwarden sidecar, plus header hygiene.
|
||||
//
|
||||
// ── The URL comes from the database, and can change while this is running ──
|
||||
//
|
||||
// `db/schema.ts` says why it is not an environment variable. The consequence here is the interesting
|
||||
// part: a value that would have been constant for the process lifetime is now something the owner can
|
||||
// change from a settings panel without restarting anything.
|
||||
//
|
||||
// ── Why a cache with a TTL rather than a read per request ──
|
||||
//
|
||||
// This sits in front of every proxied byte. A Postgres round trip per request would put the database on
|
||||
// the hot path of a proxy whose whole design rule is to do as little as possible. Ten seconds is chosen
|
||||
// against what the value actually is — a URL edited by hand, roughly never, and then wanted immediately.
|
||||
// Imperceptible to somebody who just pressed Save, and free the rest of the time.
|
||||
//
|
||||
// The TTL is the WHOLE mechanism. There is no push: `sidecar-registry.ts` carries events from a sidecar
|
||||
// to the platform, not commands the other way, so the config route has nothing to call. Building that
|
||||
// channel for a cache hint would be a channel built for the wrong reason.
|
||||
//
|
||||
// A failed read keeps serving the last known-good value rather than dropping to null, because "cannot
|
||||
// reach Postgres" and "the owner never configured this" look identical on screen and are not the same.
|
||||
|
||||
const TTL_MS = 10_000;
|
||||
|
||||
type Cached = { url: string | null; enabled: boolean; at: number };
|
||||
let cache: Cached | null = null;
|
||||
let inflight: Promise<Cached> | null = null;
|
||||
|
||||
async function read(): Promise<Cached> {
|
||||
try {
|
||||
const config = await getLinkwardenConfig();
|
||||
cache = { url: config.url, enabled: config.enabled, at: Date.now() };
|
||||
return cache;
|
||||
} catch (err) {
|
||||
console.error(`[linkwarden] could not read config: ${err instanceof Error ? err.message : String(err)}`);
|
||||
if (cache) return { ...cache, at: Date.now() };
|
||||
return { url: null, enabled: true, at: Date.now() };
|
||||
}
|
||||
}
|
||||
|
||||
async function current(): Promise<Cached> {
|
||||
if (cache && Date.now() - cache.at < TTL_MS) return cache;
|
||||
// One read at a time. Without this, every request under load misses the same expired entry and fires
|
||||
// its own query — the stampede that makes a cache slower than no cache.
|
||||
inflight ??= read().finally(() => {
|
||||
inflight = null;
|
||||
});
|
||||
return inflight;
|
||||
}
|
||||
|
||||
/** The base URL to forward to, or null when unconfigured or switched off. No trailing slash. */
|
||||
export async function getLinkwardenBase(): Promise<string | null> {
|
||||
const { url, enabled } = await current();
|
||||
return enabled ? url : null;
|
||||
}
|
||||
|
||||
const HOP_BY_HOP = new Set([
|
||||
'connection',
|
||||
'keep-alive',
|
||||
'proxy-authenticate',
|
||||
'proxy-authorization',
|
||||
'te',
|
||||
'trailer',
|
||||
'transfer-encoding',
|
||||
'upgrade',
|
||||
'host',
|
||||
]);
|
||||
|
||||
/** Copy headers, dropping only hop-by-hop and `proxy-*` ones. Authorization and cookies pass through. */
|
||||
export function stripHopByHop(src: Headers): Headers {
|
||||
const out = new Headers();
|
||||
src.forEach((value, key) => {
|
||||
const k = key.toLowerCase();
|
||||
if (HOP_BY_HOP.has(k) || k.startsWith('proxy-')) return;
|
||||
out.set(key, value);
|
||||
});
|
||||
return out;
|
||||
}
|
||||
|
||||
/*
|
||||
Paths are logged; tokens are not.
|
||||
|
||||
Linkwarden puts an access token in a query string in more than one place, and a NextAuth callback
|
||||
carries a csrf token the same way. None of it belongs in a log that gets pasted into a chat.
|
||||
*/
|
||||
const REDACT = /([?&](access_token|token|csrfToken|code)=)[^&]*/gi;
|
||||
export const redactPath = (pathAndQuery: string): string => pathAndQuery.replace(REDACT, '$1<redacted>');
|
||||
Reference in New Issue
Block a user