Jakub Zych
a03e076c62
- POST /api/__journal__/cache/purge removes every Nitro route-cache entry - 404 without a 32-character token or behind a proxy, 401 on a wrong bearer token (constant-time over sha256 digests) - routeRules keep /api/__journal__/** out of the route cache - runtimeConfig.journal.cachePurgeToken (NUXT_JOURNAL_CACHE_PURGE_TOKEN) - fixture API reload(); testing/purge-check.mjs proves a cached page shows a change after a purge; the playground caches with swr 300
86 lines
3.3 KiB
TypeScript
86 lines
3.3 KiB
TypeScript
// Site cache purge: the authorization rules of the purge route, the purge of
|
|
// Nitro's route cache and the parsing of the purge request body. Pure
|
|
// TypeScript, so `node --test` and the server route both import it directly.
|
|
|
|
import { createHash, timingSafeEqual } from 'node:crypto'
|
|
|
|
/** The shortest purge token the route accepts; with a shorter one it is off. */
|
|
export const MIN_PURGE_TOKEN_LENGTH = 32
|
|
|
|
/** The cache storage base of Nitro's route cache (routeRules cache and swr). */
|
|
export const ROUTE_CACHE_BASE = 'nitro:routes'
|
|
|
|
/** Longest slug the purge log line carries. */
|
|
const MAX_SLUG_LENGTH = 200
|
|
|
|
export type PurgeVerdict = 'ok' | 'disabled' | 'proxied' | 'unauthorized'
|
|
|
|
export interface PurgeAuthInput {
|
|
/** The configured token (runtimeConfig.journal.cachePurgeToken). */
|
|
token: unknown
|
|
/** The request's Authorization header, if any. */
|
|
authorization?: string | null
|
|
/** True when the request carried X-Forwarded-For, X-Real-IP or Forwarded. */
|
|
proxied: boolean
|
|
}
|
|
|
|
function digest(value: string): Buffer {
|
|
return createHash('sha256').update(value, 'utf8').digest()
|
|
}
|
|
|
|
/**
|
|
* Decides a purge request: `disabled` when no token of at least
|
|
* MIN_PURGE_TOKEN_LENGTH characters is configured, `proxied` when the
|
|
* request came through a reverse proxy (checked before the token), `ok` when
|
|
* the Bearer value equals the token (compared in constant time over sha256
|
|
* digests) and `unauthorized` otherwise.
|
|
*/
|
|
export function authorizePurge({ token, authorization, proxied }: PurgeAuthInput): PurgeVerdict {
|
|
if (typeof token !== 'string' || token.length < MIN_PURGE_TOKEN_LENGTH) return 'disabled'
|
|
if (proxied) return 'proxied'
|
|
const m = /^Bearer[ \t]+(\S+)[ \t]*$/i.exec(authorization ?? '')
|
|
if (!m) return 'unauthorized'
|
|
return timingSafeEqual(digest(m[1]), digest(token)) ? 'ok' : 'unauthorized'
|
|
}
|
|
|
|
/** The part of a Nitro/unstorage storage the purge uses. */
|
|
export interface PurgeStorage {
|
|
getKeys(base?: string): Promise<string[]> | string[]
|
|
removeItem(key: string): Promise<unknown> | unknown
|
|
}
|
|
|
|
/**
|
|
* Removes every entry of Nitro's route cache (pages, their _payload.json and
|
|
* feeds) from storage, which is `useStorage('cache')`, and returns how many
|
|
* it removed. Other cache groups (cached functions, handlers) stay.
|
|
*/
|
|
export async function purgeRouteCache(storage: PurgeStorage): Promise<number> {
|
|
const keys = await storage.getKeys(ROUTE_CACHE_BASE)
|
|
let removed = 0
|
|
for (const key of keys) {
|
|
if (!key.startsWith(ROUTE_CACHE_BASE + ':')) continue
|
|
await storage.removeItem(key)
|
|
removed++
|
|
}
|
|
return removed
|
|
}
|
|
|
|
export interface PurgeEvent {
|
|
kind: 'post' | 'category' | 'unknown'
|
|
slug: string
|
|
}
|
|
|
|
/**
|
|
* Reads the kind and slug of a purge request body for the log line: kind is
|
|
* post, category or unknown; the slug loses control characters and is cut
|
|
* to 200 characters.
|
|
*/
|
|
export function parsePurgeEvent(body: unknown): PurgeEvent {
|
|
if (body === null || typeof body !== 'object' || Array.isArray(body)) return { kind: 'unknown', slug: '' }
|
|
const raw = body as Record<string, unknown>
|
|
const kind = raw.kind === 'post' || raw.kind === 'category' ? raw.kind : 'unknown'
|
|
// eslint-disable-next-line no-control-regex
|
|
const slug = typeof raw.slug === 'string' ? raw.slug.replace(/[\u0000-\u001f\u007f-\u009f]/g, '').slice(0, MAX_SLUG_LENGTH) : ''
|
|
return { kind, slug }
|
|
}
|