Files
dashcaddy/dashcaddy-api/routes/auth/index.js
T
Hermes Agent c619d3a36b
CI / Test & Lint (push) Has been cancelled
CI / Security audit (push) Has been cancelled
DC-046 DC-047 pluggable auth providers + email magic link
Pluggable AuthProvider framework for any future auth method (OIDC, SAML,
passkeys) to plug in without touching the auth path again. Two
implementations ship:

  * TOTP — refactored from routes/auth/totp.js into src/auth/providers/totp.js
    as one AuthProvider impl. Legacy /api/v1/totp/* routes stay mounted for
    back-compat; new /api/v1/auth/login/totp/* routes use the new shape.

  * EmailMagicLink — src/auth/providers/email.js. Initiate issues a 32-byte
    base64url token, stores its SHA-256 hash in data/email-tokens.json
    (atomic lockfile-based mutation, automatic TTL cleanup), and delivers via
    nodemailer if providers.email.{host,port,username,password} is set OR
    falls back to log.info('auth', 'email magic link issued', ...) for dev.
    Verify accepts the token, marks it used, creates the same DashCaddy
    session cookie that TOTP uses (single global cookie model).

createAuthProviderRegistry() composes both implementations and exposes
them via /api/v1/auth/login/{methods, :provider/initiate, :provider/verify,
recovery-info} and /api/v1/auth/disable/:provider. PUBLIC_ROUTES + CSRF
exemptions updated to use :provider placeholder (parameterized for future
providers).

Test fix: src/utilities/middleware.js PUBLIC_ROUTES and csrf-protection.js
both switched to the :provider form because the prior literal 'totp'
wouldn't match the parameterized mount path Express 4.22 produces.

Test fix: __tests__/public-routes-drift.test.js extractMountPath() was
broken for Express 4.22's new ^/path/?(?=/|$) source format (no \?\?
terminator in the literal-mount case). Rewrote the parser to normalize
escaped slashes + trailing lookaheads instead of relying on regex
matching against the raw source.

New: __tests__/auth-provider-registry.test.js — 9 tests covering registry
composition, getProvider round-trip, listEnabled no-secrets-leak guarantee,
enabled-flag respect, listAll vs listEnabled distinction, email provider
dev-console fallback (token written to JSON store + log.info with
deliveredVia: 'dev-console' + response masked), verify rejects unknown
tokens via AuthenticationError.

Tests: 1241/1241 passing across 46 suites (was 1232; +9 new).

DNS2 deploy: this commit + bump VERSION to 1.16.0 + publish tarball to
get.dashcaddy.net + docker build + bash start.sh. The image-layer migration
from DC-050 also runs on first container recreate post-merge.
2026-07-20 01:40:33 -07:00

111 lines
4.2 KiB
JavaScript

const express = require('express');
const initTotp = require('./totp');
const initKeys = require('./keys');
const initSessionHandlers = require('./session-handlers');
const initSsoGate = require('./sso-gate');
const initLogin = require('./login');
const { createAuthProviderRegistry } = require('../../src/auth/providers');
/**
* Auth routes aggregator
* Assembles all auth sub-routes with their dependencies
* @param {Object} ctx - Application context (for backward compatibility)
* @returns {express.Router}
*/
/**
* Pull the SMTP/email provider config from whichever source has it.
*
* Resolution order:
* 1. ctx.emailProviderConfig — explicit override (operator or env)
* 2. ctx.notification.getConfig?.().providers.email — reuse the same
* SMTP settings notifications use. This is the "magic" — operators
* configure SMTP once for system notifications and email-auth picks
* it up automatically.
* 3. null — provider will operate in dev-console fallback mode.
*/
function _extractEmailConfig(ctx) {
if (ctx.emailProviderConfig && typeof ctx.emailProviderConfig === 'object') {
return ctx.emailProviderConfig;
}
const n = ctx.notification;
if (n && typeof n.getConfig === 'function') {
const cfg = n.getConfig();
if (cfg && cfg.providers && cfg.providers.email) return cfg.providers.email;
}
return null;
}
module.exports = function(ctx) {
const router = express.Router();
// Extract dependencies from context
const deps = {
authManager: ctx.authManager,
credentialManager: ctx.credentialManager,
totpConfig: ctx.totpConfig,
saveTotpConfig: ctx.saveTotpConfig,
session: ctx.session,
asyncHandler: ctx.asyncHandler,
errorResponse: ctx.errorResponse,
log: ctx.log,
// Additional deps for sso-gate
fetchT: ctx.fetchT,
getServiceById: ctx.getServiceById,
licenseManager: ctx.licenseManager,
servicesStateManager: ctx.servicesStateManager,
renewCSRFToken: ctx.middlewareResult?.renewCSRFToken,
// For DC-046 pluggable auth providers (EmailMagicLink, OIDC, …).
// Pass-through — providers like the EmailMagicLinkProvider need
// notificationManager for SMTP delivery, plus the siteConfig for
// building verification links.
notificationManager: ctx.notification,
siteConfig: ctx.siteConfig,
// DC-047: data-directory resolution for the email-token JSON store.
platformPaths: ctx.platformPaths || null,
};
const { getAppSession, appSessionCache } = initSessionHandlers(deps);
// DC-046: pluggable auth provider registry. The TOTP provider is wired
// here against the existing totpConfig / saveTotpConfig objects so it
// behaves identically to the legacy /api/v1/totp/* routes mounted below.
const registry = createAuthProviderRegistry(
{
credentialManager: ctx.credentialManager,
session: ctx.session,
saveTotpConfig: ctx.saveTotpConfig,
config: { totp: ctx.totpConfig, email: ctx.emailProviderConfig || { enabled: true } },
log: ctx.log,
renewCSRFToken: ctx.middlewareResult?.renewCSRFToken,
// DC-047: EmailMagicLinkProvider needs SMTP config + a public URL
// resolver + the data dir for the token store. All three come from
// existing global config — no new config knobs required.
emailConfig: _extractEmailConfig(ctx),
siteConfig: ctx.siteConfig || {},
platformPaths: deps.platformPaths,
},
ctx.siteConfig
);
ctx.authProviders = registry; // exposed for /api/v1/auth/methods, etc.
// NEW (DC-046): pluggable /api/v1/auth/login/* routes. Frontends should
// migrate here over time — the legacy /api/v1/totp/* routes below stay
// for back-compat. Mounted under `/auth` so internal paths
// (`/login/methods`, `/disable/:provider`) resolve at the canonical
// `/api/v1/auth/login/*` and `/api/v1/auth/disable/*` URLs that match
// PUBLIC_ROUTES and the documented login UI contract.
router.use('/auth', initLogin({
registry,
asyncHandler: ctx.asyncHandler,
errorResponse: ctx.errorResponse,
log: ctx.log,
}));
router.use(initTotp(deps));
router.use(initKeys(deps));
router.use(initSsoGate({ ...deps, getAppSession, appSessionCache }));
return router;
};