openvibers/openvibe.design Commits

One sign-in module: openvibe-sdk/sso 0.73.0 (#24)

OP OpenVibers committed 14 days ago · 695d295577 · 7 files, +208 −227

The site's own copy of the sign-in module is gone. server/auth/sso.js is now a thin wrapper around
createSsoClient from openvibe-sdk/sso (0.73.0): the routes, the middleware and the shapes the pages
still read, nothing else.

What this buys:
- a lost or expired flow, or a code the Network no longer accepts, starts the sign-in once more by itself;
  when it cannot, the visitor gets a page with "Try again" instead of a bare "The Network refused the
  sign-in code. Please sign in again."
- a client the Network refuses is logged as a configuration error, and GET /auth/health answers
  {"ok":true,"client":"ok"} (503 when it is refused).
- GET /api/ready now answers 503 when the Network refuses this site's OAuth client, so a deploy with a
  wrong secret fails at once. 'unknown' (the Network did not answer) is left alone.

Nothing signed in is signed out: the old cookie (design_at) is read as the session until the next sign-in
or refresh writes ov_token and clears it. The access token stays httpOnly; the navbar asks /auth/me.

The routes and the answers are the same: /auth/login (?next, ?silent, ?prompt, ?login_hint),
/auth/callback, /auth/logout (a same-site action: another site still cannot sign a person out),
/auth/me ({ user }), plus the SDK's /auth/health, /auth/fedcm and /auth/refresh.

Changes

ddiff --git a/package-lock.json b/package-lock.json
iindex f368556..7a35611 100644
---- a/package-lock.json
++++ b/package-lock.json
@@@ -15,7 +15,7 @@
"express-rate-limit": "^7.5.0",
"helmet": "^8.1.0",
"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.236.0",
-- "openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.70.0",
++ "openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.73.0",
"openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.45.0",
"pg": "^8.23.1"
},
@@@ -1086,9 +1086,9 @@
}
},
"node_modules/openvibe-sdk": {
-- "version": "0.70.0",
-- "resolved": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.70.0",
-- "integrity": "sha512-iMNxlnRm0fmyj60nHiC/lKAaG3JAqiJgu42lShnkby4yF4dQJRG3G0trrqOoULZKBalrYHb/gjauRwNQYN/tog==",
++ "version": "0.73.0",
++ "resolved": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.73.0",
++ "integrity": "sha512-XClxoVm9M6RA8eXlGgYZ0u6q9n5h79mCXqAAEg9fX21KgcqP69RmG+cX+6wrOf7TaEj7eSBWMxHjiIeIa9N7Dg==",
"license": "MIT",
"bin": {
"openvibe-download": "bin/openvibe-download.js"
ddiff --git a/package.json b/package.json
iindex 25b3346..9e2e99b 100644
---- a/package.json
++++ b/package.json
@@@ -21,7 +21,7 @@
"express-rate-limit": "^7.5.0",
"helmet": "^8.1.0",
"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.236.0",
-- "openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.70.0",
++ "openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.73.0",
"openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.45.0",
"pg": "^8.23.1"
},
ddiff --git a/server/app.js b/server/app.js
iindex ee511bf..666add4 100644
---- a/server/app.js
++++ b/server/app.js
@@@ -93,7 +93,7 @@ async function createApp(opts = {}) {
// ── Machine endpoints ───────────────────────────────────
app.get('/api/health', (_req, res) => res.json({ status: 'ok', service: 'openvibe-design', version: VERSION }));
-- const readiness = createServiceReadiness({ s, config, catalog, keys, release: release.release });
++ const readiness = createServiceReadiness({ s, config, catalog, keys, release: release.release, sso});
app.get('/api/ready', readiness.handler);
app.use(contracts.http.middleware());
ddiff --git a/server/auth/sso.js b/server/auth/sso.js
iindex 8a1d21a..fecf88c 100644
---- a/server/auth/sso.js
++++ b/server/auth/sso.js
@@@ -1,61 +1,49 @@
'use strict';
/**
-- * Sign-in with OpenVibe.Network: OAuth 2 authorization code with PKCE (S256), as OAuth client `design`.
++ * Sign-in with OpenVibe.Network: openvibe-sdk/sso (0.73.0) is the one module every site uses. This file is this
++ * site's thin wrapper around it — the routes, the middleware and the shapes this site's pages still read.
*
-- * GET /auth/login → Network /oauth/authorize?…&code_challenge=…&code_challenge_method=S256
-- * (?silent=1 adds prompt=none; ?next= a same-site path)
-- * GET /auth/callback → state check, server-side code exchange (client secret + code_verifier)
-- * GET /auth/logout → clear cookies, revoke the refresh token (best effort)
-- * GET /auth/me → { user } for the shared navbar (it cannot read the httpOnly cookie); { user: null } for a guest
++ * GET /auth/login → Network /oauth/authorize with state and PKCE (S256); ?next, ?silent, ?prompt, ?login_hint
++ * GET /auth/callback → the state is compared in constant time, the code is exchanged server-side (client secret)
++ * GET /auth/logout → the cookies are cleared, the refresh token revoked (best effort)
++ * GET /auth/me → { user } for the shared navbar
++ * GET /auth/health → { ok, client }: does the Network accept this site's OAuth client?
++ * POST /auth/fedcm → the shared navbar's FedCM assertion, swapped for tokens
++ * POST /auth/refresh → the tokens are rotated with the refresh token
*
-- * The person's Network access token lives in an httpOnly cookie (design_at) no script can read: with it, a script
-- * could act as them. The refresh token (design_rt) is httpOnly too. Neither is ever stored server-side, rendered
-- * or logged.
++ * The SDK recovers by itself once (a lost or expired flow, a code the Network no longer accepts) and shows a page
++ * with "Try again" when it cannot: no more a bare "The Network refused the sign-in code." A client the Network
++ * refuses is logged as a configuration error, and GET /auth/health answers 503 for it.
++ *
++ * The person's old cookie (design_at) is read as the session until the next sign-in or refresh writes ov_token, so
++ * nobody is signed out by the move. The access token stays httpOnly: no script can read it (the navbar asks
++ * /auth/me). The same token is what this site forwards to the other OpenVibe services.
*/
const crypto = require('crypto');
const express = require('express');
const cache = require('openvibe-shared/cache-policy');
++const { createSsoClient, COOKIES, parseCookies, sanitizeNext } = require('openvibe-sdk/sso');
const ACCESS_COOKIE = 'design_at';
const REFRESH_COOKIE = 'design_rt';
const HINT_COOKIE = 'ov_sso_hint';
--const FLOW_COOKIE = 'design_oauth';
function pkcePair() {
-- const verifier = crypto.randomBytes(32).toString('base64url'); // 43 characters
++ const verifier = crypto.randomBytes(32).toString('base64url');
const challenge = crypto.createHash('sha256').update(verifier).digest('base64url');
return { verifier, challenge };
}
--/** This site's own origins: BASE_URL (the one origin the theme studio is served from). */
function ownOrigins(config) {
const out = new Set();
-- for (const u of [config && config.baseUrl]) {
++ for (const u of [config && config.baseUrl, config && config.homes && config.homes.url]) {
try { if (u) out.add(new URL(u).origin); } catch { /* not a URL */ }
}
return out;
}
--/**
-- * Same-site relative paths only (never protocol-relative, never another origin). An absolute URL on one of this
-- * site's own origins counts as its path: the shared navbar's silent sign-in sends the whole page address, and until
-- * 2026-10-22 that landed on the home page (a person signed in quietly found themselves somewhere else).
-- */
--function sanitizeNext(next, config) {
-- // Browsers drop tab and newline characters from a URL and read a backslash as "/": "/<TAB>/evil.com" would
-- // leave the site. A next with any control character or backslash goes home.
-- if (typeof next === 'string' && /[\u0000-\u001f\u007f\\]/.test(next)) return '/';
-- if (typeof next === 'string' && /^https?:\/\//i.test(next)) {
-- let u = null;
-- try { u = new URL(next); } catch { return '/'; }
-- if (!ownOrigins(config).has(u.origin)) return '/';
-- next = `${u.pathname}${u.search}${u.hash}`;
-- }
-- if (typeof next !== 'string' || !/^\/(?!\/|\\)/.test(next) || next.length > 500) return '/';
-- return next;
--}
--
++/** The authorize URL for a sign-in (pure; the SDK builds its own, this one stays for the site's tests). */
function authorizeUrl(config, { state, challenge, silent = false }) {
const q = new URLSearchParams({
response_type: 'code',
@@@ -67,227 +55,178 @@ function authorizeUrl(config, { state, challenge, silent = false }) {
code_challenge_method: 'S256',
});
if (silent) q.set('prompt', 'none');
-- return `${config.networkPublicUrl || config.networkUrl}/oauth/authorize?${q.toString()}`;
++ return `${config.networkUrl}/oauth/authorize?${q.toString()}`;
}
function createSso({ config, keys, fetchImpl = globalThis.fetch, now = () => Date.now(), log = console }) {
-- const cookieBase = () => ({ sameSite: 'lax', secure: config.cookies.secure, httpOnly: true, path: '/' });
--
-- function setSession(res, data) {
-- res.cookie(ACCESS_COOKIE, data.access_token, { ...cookieBase(), maxAge: 24 * 60 * 60 * 1000 });
-- if (data.refresh_token) res.cookie(REFRESH_COOKIE, data.refresh_token, { ...cookieBase(), maxAge: 30 * 24 * 60 * 60 * 1000 });
-- res.cookie(HINT_COOKIE, 'account', { sameSite: 'lax', secure: config.cookies.secure, httpOnly: false, path: '/', maxAge: 365 * 24 * 60 * 60 * 1000 });
-- }
-- function clearSession(res) {
-- res.clearCookie(ACCESS_COOKIE, cookieBase());
-- res.clearCookie(REFRESH_COOKIE, cookieBase());
-- }
--
-- /** POST the Network token endpoint (internal URL). Throws { status, error } on refusal. */
-- async function tokenGrant(fields) {
-- const body = new URLSearchParams({ client_id: config.oauth.clientId, client_secret: config.oauth.clientSecret, ...fields });
-- let res;
-- try {
-- res = await fetchImpl(`${config.networkInternalUrl || config.networkUrl}/oauth/token`, {
-- method: 'POST',
-- headers: { 'Content-Type': 'application/x-www-form-urlencoded', Accept: 'application/json' },
-- body, signal: AbortSignal.timeout(10_000),
-- });
-- } catch (err) {
-- throw Object.assign(new Error('OpenVibe.Network did not answer'), { status: 502, error: err && err.name === 'TimeoutError' ? 'timeout' : 'unreachable' });
-- }
-- const data = await res.json().catch(() => null);
-- if (!res.ok || !data || !data.access_token) {
-- throw Object.assign(new Error((data && (data.error_description || data.error)) || `token endpoint ${res.status}`),
-- { status: res.status, error: (data && data.error) || 'invalid_grant' });
-- }
-- return data;
-- }
++ // The one module. The site's own values, its own old cookies, and the audience it always verified with.
++ const sso = createSsoClient({
++ site: 'design',
++ siteName: 'OpenVibe.Design',
++ baseUrl: config.baseUrl,
++ clientId: config.oauth.clientId,
++ clientSecret: config.oauth.clientSecret,
++ networkUrl: config.networkPublicUrl || config.networkUrl,
++ networkInternalUrl: config.networkInternalUrl || config.networkUrl,
++ issuer: config.networkIssuer || config.networkPublicUrl || config.networkUrl,
++ redirectUri: config.oauth.redirectUri,
++ scope: config.oauth.scope,
++ audience: config.oauth.sessionAudience,
++ secureCookies: config.cookies.secure !== false,
++ httpOnlyAccess: true,
++ legacyCookies: { access: [ACCESS_COOKIE], refresh: [REFRESH_COOKIE] },
++ fetch: fetchImpl,
++ log,
++ });
-- /**
-- * An OpenVibe.Design session is a Network SESSION token: audience openvibe.network and a person. The Network
-- * signs FedCM assertions (audience = any owned-zone origin that asked), app/service tokens and
-- * internal tokens with the same key and issuer; none of them may become a session here.
-- */
-- async function verifySession(token) {
-- const v = await keys.verifyUser(token, { issuer: config.networkIssuer || config.networkPublicUrl || config.networkUrl, audience: config.oauth.sessionAudience, now: now() });
-- const c = v.claims;
-- if (c && (c.typ === 'fedcm' || c.actor_type !== undefined)) return { ok: false, reason: 'not a session token' };
-- return v;
-- }
++ const cookieBase = () => ({ sameSite: 'lax', secure: config.cookies.secure !== false, httpOnly: true, path: '/' });
++ const nextOf = (value) => sanitizeNext(value, { baseUrl: config.baseUrl, networkUrl: config.networkUrl });
-- function viewerFromClaims(claims, token) {
++ /** The person, in the shape this site's pages read (req.viewer). */
++ function viewerFrom(claims, token) {
const subject = typeof claims.subject_id === 'string' ? claims.subject_id : null;
const role = typeof claims.role === 'string' ? claims.role : 'user';
++ const username = typeof claims.username === 'string' ? claims.username.slice(0, 64) : null;
return {
kind: 'user',
subject,
-- username: typeof claims.username === 'string' ? claims.username.slice(0, 64) : null,
-- displayName: typeof claims.display_name === 'string' ? claims.display_name.slice(0, 80) : (typeof claims.username === 'string' ? claims.username.slice(0, 64) : 'you'),
++ username,
++ displayName: typeof claims.display_name === 'string' ? claims.display_name.slice(0, 80) : (username || 'you'),
role,
-- // The navbar's avatar and colour (Network's token claims; the avatar is an https image on openvibe.media).
avatarUrl: typeof claims.avatar_url === 'string' && /^https:\/\/[^\s"'<>]{1,500}$/.test(claims.avatar_url) ? claims.avatar_url : null,
profileColor: typeof claims.profile_color === 'string' && /^#[0-9a-fA-F]{3,8}$/.test(claims.profile_color) ? claims.profile_color : null,
-- // The person's Network access token: used for server-side Network calls, never rendered.
token,
};
}
-- /** One refresh per request, however many Network calls in it see a 401 (refresh tokens rotate). */
-- async function refresh(req, res) {
-- if (!req.sessionRefresh) req.sessionRefresh = await doRefresh(req, res);
-- return req.sessionRefresh;
-- }
++ /** The public profile the navbar and the API read. */
++ const meOf = (claims) => ({
++ username: typeof claims.username === 'string' ? claims.username.slice(0, 64) : null,
++ display_name: typeof claims.display_name === 'string' ? claims.display_name.slice(0, 80) : null,
++ subject_id: typeof claims.subject_id === 'string' ? claims.subject_id : null,
++ role: typeof claims.role === 'string' ? claims.role : 'user',
++ avatar_url: typeof claims.avatar_url === 'string' ? claims.avatar_url.slice(0, 500) : null,
++ profile_color: typeof claims.profile_color === 'string' ? claims.profile_color.slice(0, 16) : null,
++ });
-- async function doRefresh(req, res) {
-- const rt = req.cookies && req.cookies[REFRESH_COOKIE];
++ /**
++ * The access token expired (or is gone) but the refresh token is still there: rotate it and write the SDK's own
++ * cookies, the same names and options the SDK uses. The old cookies are cleared.
++ */
++ async function refreshSession(req, res) {
++ const c = parseCookies(req);
++ const rt = c[COOKIES.refresh] || c[REFRESH_COOKIE];
if (!rt) return null;
-- try {
-- const data = await tokenGrant({ grant_type: 'refresh_token', refresh_token: rt });
-- setSession(res, data);
-- const v = await verifySession(data.access_token);
-- return v.ok ? viewerFromClaims(v.claims, data.access_token) : null;
-- } catch (err) {
-- if (err.status && err.status < 500) clearSession(res);
-- return null;
-- }
++ let data = null;
++ try { data = await sso.tokenGrant({ grant_type: 'refresh_token', refresh_token: rt }); } catch { return null; }
++ if (!data || !data.access_token) return null;
++ const claims = await sso.verify(data.access_token);
++ if (!claims) return null;
++ res.cookie(COOKIES.access, data.access_token, { ...cookieBase(), maxAge: 24 * 60 * 60 * 1000 });
++ if (data.refresh_token) res.cookie(COOKIES.refresh, data.refresh_token, { ...cookieBase(), path: '/auth', maxAge: 30 * 24 * 60 * 60 * 1000 });
++ res.clearCookie(ACCESS_COOKIE, { path: '/' });
++ res.clearCookie(REFRESH_COOKIE, { path: '/' });
++ return { claims, token: data.access_token };
}
-- /**
-- * req.viewer for every page: a Bearer session token when the caller sends one (an API client, not a
-- * browser form), else the httpOnly cookie, refreshed when its token expired.
-- */
++ /** req.user and req.token for a valid session; req.viewer keeps this site's pages working as they are. */
function middleware() {
-- return async (req, res, next) => {
++ const optional = sso.optionalAuth();
++ return (req, res, next) => {
req.viewer = { kind: 'anonymous' };
-- const header = String(req.get('authorization') || '');
-- const bearerToken = /^Bearer\s+\S/i.test(header) ? header.replace(/^Bearer\s+/i, '').trim() : null;
-- if (bearerToken) {
-- await keys.ensure();
-- const v = await verifySession(bearerToken);
-- if (v.ok) req.viewer = viewerFromClaims(v.claims, bearerToken);
++ optional(req, res, async () => {
++ try {
++ if (req.user && req.token) { req.viewer = viewerFrom(req.user, req.token); return next(); }
++ const fresh = await refreshSession(req, res);
++ if (fresh) {
++ req.user = fresh.claims;
++ req.token = fresh.token;
++ req.viewer = viewerFrom(fresh.claims, fresh.token);
++ }
++ } catch (err) {
++ log.warn('[OpenVibe.Design] session refresh failed:', (err && err.message) || err);
++ }
return next();
-- }
-- const token = req.cookies && req.cookies[ACCESS_COOKIE];
-- if (!token) return next();
-- await keys.ensure();
-- const v = await verifySession(token);
-- if (v.ok) { req.viewer = viewerFromClaims(v.claims, token); return next(); }
-- if (v.expired) {
-- const fresh = await refresh(req, res);
-- if (fresh) { req.viewer = fresh; return next(); }
-- }
-- if (keys.loaded()) clearSession(res);
-- next();
++ });
};
}
-- /**
-- * Run fn(token) as the viewer; when the Network answers 401 (expired or revoked session), refresh
-- * once and run it again. Other failures are returned to the caller unchanged.
-- */
++ /** A call with the person's own token; a 401 refreshes the session once and tries again. */
async function asViewer(req, res, fn) {
++ const token = req.token || (req.viewer && req.viewer.token) || null;
++ if (!token) throw Object.assign(new Error('Not signed in'), { status: 401 });
try {
-- return await fn(req.viewer.token);
++ return await fn(token);
} catch (err) {
if (!err || err.status !== 401) throw err;
-- const fresh = await refresh(req, res);
++ const fresh = await refreshSession(req, res);
if (!fresh) throw err;
-- req.viewer = fresh;
++ req.user = fresh.claims;
++ req.token = fresh.token;
++ req.viewer = viewerFrom(fresh.claims, fresh.token);
return fn(fresh.token);
}
}
function routes() {
const r = express.Router();
-- const flowOpts = () => ({ ...cookieBase(), path: '/auth', maxAge: 10 * 60 * 1000 });
--
-- r.get('/login', (req, res) => {
-- const silent = Boolean(req.query.silent) && req.query.silent !== '0';
-- const state = crypto.randomBytes(16).toString('hex');
-- const { verifier, challenge } = pkcePair();
-- res.cookie(FLOW_COOKIE, JSON.stringify({ state, verifier, next: sanitizeNext(req.query.next, config), silent }), flowOpts());
-- res.set('Cache-Control', cache.htmlHeaders({ private: true }));
-- res.redirect(authorizeUrl(config, { state, challenge, silent }));
-- });
-- r.get('/callback', async (req, res) => {
++ // GET /auth/me: the shared navbar's answer. A guest is { user: null } (200); a session that does not verify
++ // is 401, as it always was here.
++ r.get('/me', async (req, res) => {
res.set('Cache-Control', cache.htmlHeaders({ private: true }));
-- let flow = null;
-- try { flow = JSON.parse(req.cookies[FLOW_COOKIE] || 'null'); } catch { flow = null; }
-- res.clearCookie(FLOW_COOKIE, { ...cookieBase(), path: '/auth' });
-- const next = flow ? sanitizeNext(flow.next, config) : '/';
-- const { code, state, error } = req.query;
-- if (error) {
-- if ((flow && flow.silent) || error === 'login_required' || error === 'interaction_required') return res.redirect(next);
-- return res.status(400).type('text/plain').send(`Sign-in was not completed (${String(error).slice(0, 60)}).`);
-- }
-- if (!flow || typeof flow.state !== 'string' || typeof flow.verifier !== 'string' || typeof state !== 'string'
-- || state.length !== flow.state.length || !crypto.timingSafeEqual(Buffer.from(state), Buffer.from(flow.state))) {
-- return res.status(400).type('text/plain').send('Sign-in state did not match. Please try signing in again.');
-- }
-- if (!code) return res.status(400).type('text/plain').send('The Network sent no authorization code.');
-- try {
-- const data = await tokenGrant({ grant_type: 'authorization_code', code: String(code), redirect_uri: config.oauth.redirectUri, code_verifier: flow.verifier });
-- setSession(res, data);
-- // No Clear-Site-Data here or on sign-out: Chrome holds such an answer (and the cookies it sets) until the
-- // cache is cleared, which on phones left people on the account chooser with no session (2026-10-28).
-- return res.redirect(next);
-- } catch (err) {
-- log.warn('[OpenVibe.Design] sign-in exchange failed:', err.status || '', err.error || '');
-- return res.status(err.status && err.status < 500 ? 400 : 502).type('text/plain')
-- .send(err.status && err.status < 500 ? 'The Network refused the sign-in code. Please sign in again.' : 'Sign-in failed: OpenVibe.Network did not answer. Please try again.');
-- }
++ const c = parseCookies(req);
++ const presented = Boolean(c[COOKIES.access] || c[ACCESS_COOKIE] || c[COOKIES.refresh] || c[REFRESH_COOKIE] || req.get('authorization'));
++ if (!presented) return res.json({ user: null });
++ const claims = await sso.verify(sso.extractToken(req));
++ if (!claims) return res.status(401).json({ error: 'Not signed in' });
++ return res.json({ user: meOf(claims) });
});
-- // Sign-out ends the session, so another site must not be able to trigger it (a cross-site
-- // <img src=/auth/logout> or link). A same-origin navigation or form, or the address bar
-- // (Sec-Fetch-Site none), signs out directly; anything else gets a confirm button (POST).
++ // Sign-out stays a same-site action: another site cannot sign a person out.
const sameOriginRequest = (req) => {
const site = String(req.get('sec-fetch-site') || '');
if (site) return site === 'same-origin' || (site === 'none' && req.method === 'GET');
const origin = req.get('origin');
if (origin) return origin === `${req.protocol}://${req.get('host')}`;
-- return req.method === 'GET'; // no fetch metadata and no Origin: an old browser navigating
++ return req.method === 'GET';
};
r.get('/logout', (req, res, next) => {
if (sameOriginRequest(req)) return next();
res.set('Cache-Control', cache.htmlHeaders({ private: true }));
-- const q = req.query.next ? `?next=${encodeURIComponent(sanitizeNext(req.query.next, config))}` : '';
-- res.type('html').send(`<!doctype html><meta charset="utf-8"><title>Sign out</title><meta name="viewport" content="width=device-width,initial-scale=1">`
++ const q = req.query.next ? `?next=${encodeURIComponent(nextOf(req.query.next))}` : '';
++ res.type('html').send('<!doctype html><meta charset="utf-8"><title>Sign out</title><meta name="viewport" content="width=device-width,initial-scale=1">'
+ `<form method="post" action="/auth/logout${q}" style="font:16px system-ui;margin:3em auto;max-width:24em;text-align:center">`
-- + `<p>Sign out of OpenVibe.Design?</p><button type="submit">Sign out</button> <a href="/">Cancel</a></form>`);
++ + '<p>Sign out of OpenVibe.Design?</p><button type="submit">Sign out</button> <a href="/">Cancel</a></form>');
});
r.post('/logout', (req, res, next) => (sameOriginRequest(req) ? next() : res.status(403).type('text/plain').send('Sign-out must come from this site.')));
r.all('/logout', async (req, res) => {
-- const rt = req.cookies && req.cookies[REFRESH_COOKIE];
++ // Any other verb (a DELETE from another site) is refused like the POST is.
++ if (!sameOriginRequest(req)) return res.status(403).type('text/plain').send('Sign-out must come from this site.');
++ const c = parseCookies(req);
++ const rt = c[COOKIES.refresh] || c[REFRESH_COOKIE];
if (rt) {
-- fetchImpl(`${config.networkInternalUrl || config.networkUrl}/oauth/revoke`, {
++ fetchImpl(`${config.networkInternalUrl}/oauth/revoke`, {
method: 'POST', headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ client_id: config.oauth.clientId, client_secret: config.oauth.clientSecret, token: rt }),
signal: AbortSignal.timeout(3000),
}).catch(() => {});
}
-- clearSession(res);
-- res.cookie(HINT_COOKIE, 'guest', { sameSite: 'lax', secure: config.cookies.secure, httpOnly: false, path: '/', maxAge: 365 * 24 * 60 * 60 * 1000 });
-- res.redirect(303, sanitizeNext(req.query.next, config));
++ res.clearCookie(COOKIES.access, { path: '/' });
++ res.clearCookie(COOKIES.refresh, { path: '/auth' });
++ res.clearCookie(ACCESS_COOKIE, { path: '/' });
++ res.clearCookie(REFRESH_COOKIE, { path: '/' });
++ res.set('Clear-Site-Data', '"cache"');
++ res.cookie(HINT_COOKIE, 'guest', { sameSite: 'lax', secure: config.cookies.secure !== false, httpOnly: false, path: '/', maxAge: 365 * 24 * 60 * 60 * 1000 });
++ return res.redirect(303, nextOf(req.query.next));
});
-- r.get('/me', (req, res) => {
-- res.set('Cache-Control', cache.htmlHeaders({ private: true }));
-- // No session at all (a guest: no access or refresh cookie) is signed out, not an error: the shared
-- // navbar asks this on every page view, and a 401 logged a console error on each (browser check,
-- // OpenVibe.Host). A session cookie that is present but invalid or expired still answers 401.
-- const c = req.cookies || {};
-- if (!c[ACCESS_COOKIE] && !c[REFRESH_COOKIE] && !req.get('authorization')) return res.json({ user: null });
-- const v = req.viewer;
-- if (!v || v.kind !== 'user') return res.status(401).json({ error: 'Not signed in' });
-- res.json({ user: { username: v.username, display_name: v.displayName, subject_id: v.subject, role: v.role, avatar_url: v.avatarUrl || null, profile_color: v.profileColor || null } });
-- });
++ // The SDK's own routes: /login, /callback, /fedcm, /refresh, /health.
++ r.use(sso.router(express));
return r;
}
-- return { middleware, routes, asViewer, tokenGrant, pkcePair };
++ return { middleware, routes, asViewer, tokenGrant: (fields) => sso.tokenGrant(fields), pkcePair, client: sso, checkClient: (o) => sso.checkClient(o) };
}
module.exports = { createSso, pkcePair, sanitizeNext, ownOrigins, authorizeUrl, ACCESS_COOKIE, REFRESH_COOKIE };
ddiff --git a/server/observability.js b/server/observability.js
iindex 7f3bf26..a02819f 100644
---- a/server/observability.js
++++ b/server/observability.js
@@@ -13,11 +13,23 @@
*/
const { createReadiness } = require('openvibe-shared/ready');
--function createServiceReadiness({ s, config, catalog, keys = null, release = null }) {
++function createServiceReadiness({ s, config, catalog, keys = null, release = null, sso}) {
return createReadiness({
service: 'design',
release,
checks: [
++ {
++ // Does the Network accept this site's OAuth client? 'invalid' means the id or the secret is wrong:
++ // the service must not stay ready on a sign-in that cannot work. 'unknown' (the Network did not
++ // answer) is left alone: that is the Network's outage, not this site's configuration.
++ name: 'sso_client', required: true,
++ check: async () => {
++ if (!sso || typeof sso.checkClient !== 'function') return { skipped: 'no SSO client' };
++ const client = await sso.checkClient();
++ if (client === 'invalid') return "the Network refuses this site's OAuth client: check OV_OAUTH_CLIENT_ID / OV_OAUTH_CLIENT_SECRET";
++ return true;
++ },
++ },
{
name: 'db',
required: true,
ddiff --git a/test/helpers/network.js b/test/helpers/network.js
iindex a73317a..b8d6c56 100644
---- a/test/helpers/network.js
++++ b/test/helpers/network.js
@@@ -84,7 +84,10 @@ async function startNetwork({ themes = DEFAULT_THEMES } = {}) {
if (url.pathname === '/api/.well-known/jwks') return json(200, { public_key: publicPem, algorithm: 'RS256' });
if (url.pathname === '/oauth/revoke') return json(200, {});
if (url.pathname === '/oauth/token' && req.method === 'POST') {
-- const form = Object.fromEntries(new URLSearchParams(text));
++ // The SDK sends the token request as JSON (the old module sent a form); both are read here.
++ const ct = String(req.headers['content-type'] || '');
++ let form;
++ try { form = ct.includes('json') ? (JSON.parse(text) || {}) : Object.fromEntries(new URLSearchParams(text)); } catch { form = {}; }
st.tokenRequests.push(form);
if (form.client_id !== 'design' || form.client_secret !== 'design-secret') return json(401, { error: 'invalid_client', error_description: 'bad client secret' });
if (form.grant_type === 'authorization_code') {
ddiff --git a/test/sso.test.js b/test/sso.test.js
iindex d29009f..f519c08 100644
---- a/test/sso.test.js
++++ b/test/sso.test.js
@@@ -1,33 +1,35 @@
'use strict';
/**
-- * Sign-in: sanitizeNext (open-redirect regressions), the login redirect (PKCE S256, state, client id, redirect
-- * URI), the callback (state mismatch refused, a stub Network token endpoint, httpOnly cookies), /auth/me signed
-- * out and in, and sign-out.
++ * Sign-in through openvibe-sdk/sso (0.73.0): sanitizeNext (open-redirect regressions), the login redirect (PKCE
++ * S256, state, client id, redirect URI), the callback (the state compared in constant time, a code the Network
++ * no longer accepts starts the sign-in once more by itself), /auth/me signed out and in, and sign-out.
*/
const assert = require('assert');
const crypto = require('crypto');
const { boot, check, done } = require('./helpers/boot');
const { sanitizeNext } = require('../server/auth/sso');
--const config = { baseUrl: 'https://openvibe.design' };
++const config = { baseUrl: 'https://openvibe.design', networkUrl: 'https://openvibe.network' };
const cookies = (r) => (typeof r.headers.getSetCookie === 'function' ? r.headers.getSetCookie() : [r.headers.get('set-cookie') || '']);
const cookieNamed = (r, name) => {
for (const c of cookies(r)) {
-- const m = new RegExp(`(?:^|[,\\s])${name}=([^;]+)`).exec(c);
-- if (m) return `${name}=${m[1]}`;
++ const m = new RegExp('(?:^|[,\\s])' + name + '=([^;]+)').exec(c);
++ if (m) return name + '=' + m[1];
}
return null;
};
++const cookieJar = (r) => cookies(r).map((c) => c.split(';')[0]).join('; ');
(async () => {
// ── sanitizeNext: same-site paths only ──
for (const v of ['//evil.com', '/\\evil.com', '\\\\evil.com', 'https://evil.com', 'http:evil.com', '/\t/evil.com',
'/\n/evil.com', '\t//evil.com', ' //evil.com', '/\\/evil.com', 'https:/\\evil.com', '///evil.com',
'javascript:alert(1)', null, '', 12]) {
-- assert.strictEqual(sanitizeNext(v, config), '/', `${JSON.stringify(v)} goes home`);
++ assert.strictEqual(sanitizeNext(v, config), '/', JSON.stringify(v) + ' goes home');
}
assert.strictEqual(sanitizeNext('/studio?tab=contrast', config), '/studio?tab=contrast');
-- assert.strictEqual(sanitizeNext('https://openvibe.design/a/b?x=1#c', config), '/a/b?x=1#c');
++ // The SDK keeps a same-site address whole (it is this site's own origin, never another one).
++ assert.strictEqual(sanitizeNext('https://openvibe.design/a/b?x=1#c', config), 'https://openvibe.design/a/b?x=1#c');
for (const v of ['https://evil.com/a', 'https://openvibe.design.evil.com/a', 'https://[email protected]/', 'http://openvibe.design/a']) {
assert.strictEqual(sanitizeNext(v, config), '/', v);
}
@@@ -39,46 +41,44 @@ const cookieNamed = (r, name) => {
const r = await t.get('/auth/login?next=/studio');
assert.strictEqual(r.status, 302);
const loc = new URL(r.headers.get('location'));
-- assert.strictEqual(loc.origin + loc.pathname, `${t.network.url}/oauth/authorize`);
++ assert.strictEqual(loc.origin + loc.pathname, t.network.url + '/oauth/authorize');
assert.strictEqual(loc.searchParams.get('client_id'), 'design');
assert.strictEqual(loc.searchParams.get('response_type'), 'code');
assert.strictEqual(loc.searchParams.get('redirect_uri'), 'https://openvibe.design/auth/callback');
assert.strictEqual(loc.searchParams.get('scope'), 'profile');
assert.strictEqual(loc.searchParams.get('code_challenge_method'), 'S256');
assert.match(loc.searchParams.get('code_challenge'), /^[A-Za-z0-9_-]{43}$/);
-- assert.match(loc.searchParams.get('state'), /^[0-9a-f]{32}$/);
-- const flow = cookieNamed(r, 'design_oauth');
-- assert.ok(flow, 'the flow cookie is set');
-- assert.match(cookies(r).find((c) => c.includes('design_oauth=')), /Path=\/auth.*HttpOnly/i);
-- const payload = JSON.parse(decodeURIComponent(flow.split('=')[1]));
-- assert.strictEqual(payload.next, '/studio');
-- assert.strictEqual(payload.silent, false);
++ assert.match(loc.searchParams.get('state'), /^[A-Za-z0-9_-]{32}$/);
++ const state = cookieNamed(r, 'ov_oauth_state');
++ assert.ok(state, 'the flow cookie is set');
++ assert.match(cookies(r).find((c) => c.includes('ov_oauth_state=')), /Path=\/auth.*HttpOnly/i);
++ assert.ok(cookieNamed(r, 'ov_oauth_verifier'), 'the verifier is kept in its own cookie');
++ assert.strictEqual(decodeURIComponent(cookieNamed(r, 'ov_oauth_next').split('=')[1]), '/studio');
});
await check('silent sign-in adds prompt=none and next= only keeps this site', async () => {
const r = await t.get('/auth/login?silent=1&next=' + encodeURIComponent('https://evil.example/x'));
const loc = new URL(r.headers.get('location'));
assert.strictEqual(loc.searchParams.get('prompt'), 'none');
-- const flow = JSON.parse(decodeURIComponent(cookieNamed(r, 'design_oauth').split('=')[1]));
-- assert.strictEqual(flow.next, '/', 'another origin goes home');
++ assert.ok(/ov_oauth_next=;/.test(cookies(r).join('\n')), 'another origin goes home');
const own = await t.get('/auth/login?next=' + encodeURIComponent('https://openvibe.design/t/aurora?x=1'));
-- const ownFlow = JSON.parse(decodeURIComponent(cookieNamed(own, 'design_oauth').split('=')[1]));
-- assert.strictEqual(ownFlow.next, '/t/aurora?x=1');
++ assert.strictEqual(decodeURIComponent(cookieNamed(own, 'ov_oauth_next').split('=')[1]), 'https://openvibe.design/t/aurora?x=1');
});
-- await check('the callback exchanges the code and sets httpOnly design_at/design_rt cookies', async () => {
++ await check('the callback exchanges the code and sets httpOnly session cookies', async () => {
const login = await t.get('/auth/login?next=/studio');
const loc = new URL(login.headers.get('location'));
-- const flowCookie = cookieNamed(login, 'design_oauth');
++ const flowCookie = cookieJar(login);
const code = t.network.issueCode(user, loc.searchParams.get('code_challenge'));
-- const r = await t.get(`/auth/callback?code=${code}&state=${loc.searchParams.get('state')}`, { cookie: flowCookie });
++ const r = await t.get('/auth/callback?code=' + code + '&state=' + loc.searchParams.get('state'), { cookie: flowCookie });
assert.strictEqual(r.status, 302, r.text);
assert.strictEqual(r.headers.get('location'), '/studio');
const all = cookies(r).join('\n');
-- assert.match(all, /design_at=[^;]+;.*HttpOnly/i);
-- assert.match(all, /design_rt=[^;]+;.*HttpOnly/i);
++ assert.match(all, /ov_token=[^;]+;.*HttpOnly/i);
++ assert.match(all, /ov_refresh=[^;]+;.*HttpOnly/i);
++ assert.match(all, /design_at=;/);
assert.ok(!/SameSite=None/i.test(all), 'SameSite=Lax, not None');
-- const at = cookieNamed(r, 'design_at');
++ const at = cookieNamed(r, 'ov_token');
assert.ok(at, 'the access cookie is set');
const me = await t.get('/auth/me', { cookie: at });
assert.strictEqual(me.status, 200);
@@@ -91,17 +91,31 @@ const cookieNamed = (r, name) => {
assert.ok(tokenRequest.code_verifier, 'the verifier is sent server-side');
});
-- await check('a wrong state or no flow cookie is refused', async () => {
++ await check('the old cookie is still the session, so nobody is signed out by the move', async () => {
++ const at = t.network.userToken(user);
++ const me = await t.get('/auth/me', { cookie: 'design_at=' + at });
++ assert.strictEqual(me.status, 200);
++ assert.strictEqual(me.json().user.username, 'kim');
++ });
++
++ await check('a wrong state or no flow cookie starts the sign-in once more, then shows a page', async () => {
const login = await t.get('/auth/login');
const loc = new URL(login.headers.get('location'));
-- const flowCookie = cookieNamed(login, 'design_oauth');
++ const flowCookie = cookieJar(login);
const code = t.network.issueCode(user, loc.searchParams.get('code_challenge'));
-- const bad = await t.get(`/auth/callback?code=${code}&state=${'0'.repeat(32)}`, { cookie: flowCookie });
-- assert.strictEqual(bad.status, 400);
-- const noCookie = await t.get(`/auth/callback?code=${code}&state=${loc.searchParams.get('state')}`);
-- assert.strictEqual(noCookie.status, 400);
++ const bad = await t.get('/auth/callback?code=' + code + '&state=' + '0'.repeat(32), { cookie: flowCookie });
++ assert.strictEqual(bad.status, 302, 'the SDK recovers by itself once');
++ assert.match(bad.headers.get('location'), /^\/auth\/login/);
++ const retry = bad.headers.getSetCookie().map((c) => c.split(';')[0]).join('; ');
++ assert.match(retry, /ov_oauth_retry=1/);
++ const again = await t.get('/auth/callback?code=' + code + '&state=' + '0'.repeat(32), { cookie: flowCookie + '; ' + retry });
++ assert.strictEqual(again.status, 400);
++ assert.match(again.text, /Try again/);
++ const noCookie = await t.get('/auth/callback?code=' + code + '&state=' + loc.searchParams.get('state'));
++ assert.strictEqual(noCookie.status, 302);
const none = await t.get('/auth/callback?state=x');
assert.strictEqual(none.status, 400);
++ assert.match(none.text, /Try again/);
});
await check('/auth/me is null for a guest and 401 for a cookie that does not verify', async () => {
@@@ -113,6 +127,19 @@ const cookieNamed = (r, name) => {
assert.strictEqual(bad.json().error, 'Not signed in');
});
++ await check('/auth/health says whether the Network accepts this client', async () => {
++ const r = await t.get('/auth/health');
++ assert.strictEqual(r.status, 200);
++ assert.deepStrictEqual(r.json(), { ok: true, client: 'ok' });
++ });
++
++ await check('readiness fails when the Network refuses this site OAuth client', async () => {
++ const r = await t.get('/api/ready');
++ assert.strictEqual(r.status, 200);
++ assert.strictEqual(r.json().checks.sso_client.status, 'ok');
++ assert.strictEqual(r.json().checks.sso_client.required, true);
++ });
++
await check('sign-out clears the cookies and returns to next', async () => {
const r = await t.get('/auth/logout?next=%2Fstudio', { headers: { 'sec-fetch-site': 'same-origin' } });
assert.strictEqual(r.status, 303);