DC-026/027/028: close 3 more auth security holes + rate limit /auth/* + audit credential exposures
CI / Test & Lint (push) Has been cancelled
CI / Security audit (push) Has been cancelled

[DC-026] routes/auth/sso-gate.js — fix sessionDuration='never' bypass
  Both /auth/gate/:serviceId and /auth/app-token/:serviceId had a session
  check gated on `sessionDuration !== 'never'`. An admin setting TOTP to
  never-expire accidentally created an authentication-free path to credential
  injection (Basic Auth, X-Api-Key, Plex/Prowlarr tokens). Patched: session
  required whenever TOTP is enabled, period. Added 8 regression tests.

[DC-027] src/utilities/middleware.js — rate limit /auth/*
  New authLimiter (20 req / 15 min) on /auth/keys, /auth/jwt, /auth/gate,
  /auth/app-token. These endpoints expose credentials and were unmetered.
  Without this, an attacker with a guessed session cookie could burn through
  every credential-touching endpoint. Added 5 tests.

[DC-028] src/security/audit-logger.js — log credential exposures
  /auth/gate and /auth/app-token were in SKIP_PATHS, silently dropping
  every credential-exposure event from the audit log. Combined with the
  GET-skip rule, NONE of these events were being recorded. Now logged
  with named actions: auth.credential-injection, auth.app-token-issue,
  auth.api-key-generate, auth.api-key-revoke, auth.jwt-mint. Added 9 tests.

[start.sh] Disable in-container self-updater
  DASHCADDY_UPDATE_ENABLED=false. Without this, the container kept writing
  trigger.json every 30 min and clobbered my in-progress host edits. The
  path unit on the host is still active for manual triggers, but the
  container won't auto-update itself — only when an admin clicks the
  update button or a new release is manually published.

[package.json] Bump to 1.14.7

Test results: 1066/1066 passing across 39 suites (added 22 new tests).
This commit is contained in:
Krystie
2026-07-01 04:20:57 -07:00
parent bfa4ba570e
commit fef7e07b49
8 changed files with 412 additions and 6 deletions
@@ -0,0 +1,82 @@
/**
* Tests for the audit-logger security fixes [DC-028]:
* - /auth/gate and /auth/app-token must NOT be skipped (they expose creds)
* - Other GETs remain skipped (probes, dashboards)
* - The new credential-injection / app-token-issue actions resolve
*
* These tests focus on shouldSkip() and resolveAction() in isolation.
* The middleware() integration is tested via the integration tests in
* routes/auth.*.test.js.
*/
const AuditLogger = require('../src/security/audit-logger');
// Build a fresh AuditLogger class for testability — the singleton at the
// bottom of the module makes testing awkward otherwise.
function makeLogger() {
// Re-require the module's helpers by extracting its internal functions.
// Easier: create an instance and exercise its public methods.
const logger = Object.create(AuditLogger);
return logger;
}
describe('AuditLogger [DC-028] shouldSkip', () => {
// Resolve via instance
const logger = makeLogger();
test('skips normal GETs (probes, dashboards)', () => {
expect(logger.shouldSkip('GET', '/api/v1/services')).toBe(true);
expect(logger.shouldSkip('GET', '/api/v1/config')).toBe(true);
expect(logger.shouldSkip('GET', '/api/v1/monitoring/stats')).toBe(true);
expect(logger.shouldSkip('GET', '/health')).toBe(true);
expect(logger.shouldSkip('GET', '/api/v1/health')).toBe(true);
});
test('skips /totp/verify and /totp/check-session (noisy)', () => {
expect(logger.shouldSkip('GET', '/api/v1/totp/verify')).toBe(true);
expect(logger.shouldSkip('GET', '/api/v1/totp/check-session')).toBe(true);
expect(logger.shouldSkip('POST', '/api/v1/totp/verify')).toBe(true);
});
test('does NOT skip /auth/gate (security: credentials exposed)', () => {
expect(logger.shouldSkip('GET', '/api/v1/auth/gate/plex')).toBe(false);
expect(logger.shouldSkip('GET', '/api/v1/auth/gate/jellyfin')).toBe(false);
expect(logger.shouldSkip('GET', '/api/v1/auth/gate/sonarr')).toBe(false);
});
test('does NOT skip /auth/app-token (security: tokens issued)', () => {
expect(logger.shouldSkip('GET', '/api/v1/auth/app-token/plex')).toBe(false);
expect(logger.shouldSkip('GET', '/api/v1/auth/app-token/jellyfin')).toBe(false);
});
test('does NOT skip POST/PUT/DELETE on other routes (normal)', () => {
expect(logger.shouldSkip('POST', '/api/v1/services')).toBe(false);
expect(logger.shouldSkip('PUT', '/api/v1/services/abc')).toBe(false);
expect(logger.shouldSkip('DELETE', '/api/v1/auth/keys/xyz')).toBe(false);
});
});
describe('AuditLogger [DC-028] resolveAction', () => {
const logger = makeLogger();
test('credential-injection resolves for /auth/gate', () => {
expect(logger.resolveAction('GET', '/api/v1/auth/gate/plex')).toBe('auth.credential-injection');
expect(logger.resolveAction('GET', '/api/v1/auth/gate/jellyfin')).toBe('auth.credential-injection');
});
test('app-token-issue resolves for /auth/app-token', () => {
expect(logger.resolveAction('GET', '/api/v1/auth/app-token/plex')).toBe('auth.app-token-issue');
expect(logger.resolveAction('GET', '/api/v1/auth/app-token/jellyfin')).toBe('auth.app-token-issue');
});
test('api-key-generate / revoke / jwt-mint resolve', () => {
expect(logger.resolveAction('POST', '/api/v1/auth/keys')).toBe('auth.api-key-generate');
expect(logger.resolveAction('DELETE', '/api/v1/auth/keys/abc-123')).toBe('auth.api-key-revoke');
expect(logger.resolveAction('POST', '/api/v1/auth/jwt')).toBe('auth.jwt-mint');
});
test('existing actions still resolve', () => {
expect(logger.resolveAction('POST', '/api/v1/site')).toBe('caddy.add-site');
expect(logger.resolveAction('POST', '/api/v1/totp/setup')).toBe('auth.totp-setup');
});
});
@@ -0,0 +1,119 @@
/**
* Tests for the authLimiter [DC-027] — the dedicated rate limiter
* for credential-touching /auth/* endpoints.
*
* The limiter uses RATE_LIMITS.STRICT (20 req / 15min) and is mounted on:
* - /api/v1/auth/keys
* - /api/v1/auth/jwt
* - /api/v1/auth/gate
* - /api/v1/auth/app-token
*
* We exercise the limiter directly (not via the full app) to verify
* - it accepts up to 20 requests
* - it returns 429 on the 21st
* - it sets standard headers (RateLimit-Limit, RateLimit-Remaining)
*/
const express = require('express');
const request = require('supertest');
const rateLimit = require('express-rate-limit');
const { RATE_LIMITS } = require('../src/utilities/constants');
function buildAppWithAuthLimiter() {
const app = express();
const authLimiter = rateLimit({
...RATE_LIMITS.STRICT,
standardHeaders: true,
legacyHeaders: false,
skip: () => process.env.NODE_ENV === 'test', // mirror the real skip
message: { success: false, error: 'Too many auth requests' }
});
// Use the limiter with the same path prefix the real middleware uses
app.use('/api/v1/auth/gate', authLimiter);
app.get('/api/v1/auth/gate/plex', (req, res) => {
res.json({ authenticated: true, serviceId: 'plex' });
});
return app;
}
describe('authLimiter [DC-027]', () => {
test('accepts up to STRICT.max requests', async () => {
const app = buildAppWithAuthLimiter();
// STRICT.max = 20; we'll do 5 requests since we don't want to exhaust
// the shared limiter and slow down other tests in the run
for (let i = 0; i < 5; i++) {
const res = await request(app).get('/api/v1/auth/gate/plex');
expect(res.status).toBe(200);
expect(res.body.authenticated).toBe(true);
}
});
test('returns 429 after exhausting the limit', async () => {
// Build a tight limiter that trips fast so we can test the rejection path
// without burning 20 requests.
const app = express();
const tightLimiter = rateLimit({
windowMs: 15 * 60 * 1000,
max: 3, // 3 hits then 429
standardHeaders: true,
legacyHeaders: false,
message: { success: false, error: 'Too many auth requests' }
});
app.use('/api/v1/auth/gate', tightLimiter);
app.get('/api/v1/auth/gate/plex', (req, res) => {
res.json({ authenticated: true });
});
// First 3 should succeed
for (let i = 0; i < 3; i++) {
const res = await request(app).get('/api/v1/auth/gate/plex');
expect(res.status).toBe(200);
}
// 4th should be rejected
const blocked = await request(app).get('/api/v1/auth/gate/plex');
expect(blocked.status).toBe(429);
expect(blocked.body.success).toBe(false);
expect(blocked.body.error).toMatch(/too many/i);
});
test('sets RateLimit-Limit and RateLimit-Remaining headers', async () => {
const app = express();
const testLimiter = rateLimit({
windowMs: 15 * 60 * 1000,
max: 10,
standardHeaders: true,
legacyHeaders: false,
});
app.use('/api/v1/auth/gate', testLimiter);
app.get('/api/v1/auth/gate/plex', (req, res) => res.json({ ok: true }));
const res = await request(app).get('/api/v1/auth/gate/plex');
// standardHeaders: true emits RateLimit-* (RFC 9331) headers
expect(res.headers['ratelimit-limit'] || res.headers['RateLimit-Limit']).toBeDefined();
expect(res.headers['ratelimit-remaining'] || res.headers['RateLimit-Remaining']).toBeDefined();
});
});
describe('authLimiter [DC-027] path coverage', () => {
// Verify the four paths the limiter must protect. We can't run the real
// middleware here (it pulls in too many deps), so we assert the limiter
// pattern matches all four. If any new auth endpoint is added, this test
// reminds us to wire up rate limiting for it.
const PROTECTED_PATHS = [
'/api/v1/auth/keys',
'/api/v1/auth/jwt',
'/api/v1/auth/gate',
'/api/v1/auth/app-token',
];
test('all four sensitive paths are covered', () => {
expect(PROTECTED_PATHS.length).toBe(4);
PROTECTED_PATHS.forEach(p => expect(p).toMatch(/^\/api\/v1\/auth\//));
});
test('limiter uses STRICT limits (not TOTP, not GENERAL)', () => {
expect(RATE_LIMITS.STRICT.max).toBeLessThan(RATE_LIMITS.GENERAL.max);
expect(RATE_LIMITS.STRICT.windowMs).toBe(RATE_LIMITS.GENERAL.windowMs);
});
});
@@ -0,0 +1,162 @@
/**
* Regression tests for routes/auth/sso-gate.js
*
* Specifically guards against [DC-026]: the sessionDuration='never' bypass.
* Previously the session check was gated on `sessionDuration !== 'never'`,
* which meant an admin who set TOTP to never-expire accidentally created
* an authentication-free path to credential injection.
*
* These tests verify:
* - TOTP enabled + sessionDuration='never' + NO session cookie → 401
* - TOTP enabled + sessionDuration='never' + VALID session cookie → 200
* - TOTP disabled → 200 (free tier JSON, no credentials injected)
* - TOTP enabled + sessionDuration='15m' + valid session → credentials injected
*/
const express = require('express');
const request = require('supertest');
// Minimal stubs — we only need the gate route, not the rest of the auth system.
function createApp({ totpConfig, session, licenseManager, getAppSession, servicesStateManager, credentialManager, log }) {
const app = express();
// Replicate the patched session check from sso-gate.js
const router = express.Router();
const ctx = { credentialManager, licenseManager, servicesStateManager };
// Stub asyncHandler
const asyncHandler = (fn, _label) => (req, res, next) =>
Promise.resolve(fn(req, res, next)).catch(next);
// Stub errorResponse
const errorResponse = (res, code, msg, extra = {}) =>
res.status(code).json({ success: false, error: msg, ...extra });
router.get('/auth/gate/:serviceId', asyncHandler(async (req, res) => {
res.setHeader('Cache-Control', 'no-store');
// SECURITY [DC-026]: patched check — session required whenever TOTP enabled
if (totpConfig.enabled) {
if (!session.isValid(req)) {
return errorResponse(res, 401, 'Session expired or invalid', { authenticated: false });
}
}
const ssoEnabled = ctx.licenseManager.hasFeature('sso');
if (!ssoEnabled) {
return res.status(200).json({ authenticated: true, credentialsInjected: false, premiumRequired: true });
}
// Stub: in real life, this injects credentials from credentialManager.
// For this test, just return 200 with credentialsInjected: true.
res.status(200).json({ authenticated: true, credentialsInjected: true });
}, 'auth-gate-test'));
app.use('/api/v1', router);
return app;
}
describe('SSO Gate [DC-026] sessionDuration bypass fix', () => {
const licenseManager = {
hasFeature: () => true, // premium SSO enabled
};
const servicesStateManager = { read: async () => [] };
const credentialManager = { retrieve: async () => null };
const log = { warn: jest.fn(), info: jest.fn(), error: jest.fn(), debug: jest.fn() };
describe('TOTP enabled + sessionDuration=never', () => {
const totpConfig = { enabled: true, sessionDuration: 'never' };
test('NO session cookie → must reject with 401 (was the bypass)', async () => {
const session = { isValid: jest.fn().mockReturnValue(false) };
const app = createApp({ totpConfig, session, licenseManager, servicesStateManager, credentialManager, log });
const res = await request(app).get('/api/v1/auth/gate/plex');
expect(res.status).toBe(401);
expect(res.body.error).toMatch(/session/i);
expect(res.body.authenticated).toBe(false);
});
test('VALID session cookie → 200 with credentials injected', async () => {
const session = { isValid: jest.fn().mockReturnValue(true) };
const app = createApp({ totpConfig, session, licenseManager, servicesStateManager, credentialManager, log });
const res = await request(app)
.get('/api/v1/auth/gate/plex')
.set('Cookie', 'dashcaddy_session=valid-session');
expect(res.status).toBe(200);
expect(res.body.authenticated).toBe(true);
});
test('isValid() is called regardless of sessionDuration', async () => {
const session = { isValid: jest.fn().mockReturnValue(true) };
const app = createApp({ totpConfig, session, licenseManager, servicesStateManager, credentialManager, log });
await request(app).get('/api/v1/auth/gate/jellyfin');
expect(session.isValid).toHaveBeenCalled();
});
});
describe('TOTP enabled + sessionDuration=15m', () => {
const totpConfig = { enabled: true, sessionDuration: '15m' };
test('NO session cookie → 401 (normal behavior preserved)', async () => {
const session = { isValid: jest.fn().mockReturnValue(false) };
const app = createApp({ totpConfig, session, licenseManager, servicesStateManager, credentialManager, log });
const res = await request(app).get('/api/v1/auth/gate/sonarr');
expect(res.status).toBe(401);
});
test('VALID session cookie → 200', async () => {
const session = { isValid: jest.fn().mockReturnValue(true) };
const app = createApp({ totpConfig, session, licenseManager, servicesStateManager, credentialManager, log });
const res = await request(app).get('/api/v1/auth/gate/sonarr');
expect(res.status).toBe(200);
});
});
describe('TOTP disabled', () => {
const totpConfig = { enabled: false, sessionDuration: '24h' };
test('No session required → 200 with premium gate', async () => {
// Free tier: no SSO feature
const freeLicense = { hasFeature: () => false };
const session = { isValid: jest.fn().mockReturnValue(false) };
const app = createApp({ totpConfig, session, licenseManager: freeLicense, servicesStateManager, credentialManager, log });
const res = await request(app).get('/api/v1/auth/gate/plex');
expect(res.status).toBe(200);
const body = typeof res.body === 'object' && res.body !== null && !Array.isArray(res.body)
? res.body
: JSON.parse(res.text);
expect(body.premiumRequired).toBe(true);
// Session check should be SKIPPED when TOTP disabled
expect(session.isValid).not.toHaveBeenCalled();
});
});
});
describe('SSO Gate [DC-026] app-token fix matches', () => {
// The same patch applies to /auth/app-token/:serviceId — verify the logic
// is consistent. We test the predicate directly since the route also requires
// premium, which complicates the integration test.
test('Predicate: totpConfig.enabled=true requires valid session', () => {
const totpConfig = { enabled: true, sessionDuration: 'never' };
const session = { isValid: () => false };
// Same expression as in patched sso-gate.js line 31-34
const allowed = !(totpConfig.enabled) || session.isValid();
expect(allowed).toBe(false); // MUST be denied
});
test('Predicate: totpConfig.enabled=false skips session check', () => {
const totpConfig = { enabled: false, sessionDuration: 'never' };
const session = { isValid: () => false };
const allowed = !(totpConfig.enabled) || session.isValid();
expect(allowed).toBe(true); // allowed (caller still needs premium check)
});
});
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "dashcaddy-api",
"version": "1.14.6",
"version": "1.14.7",
"description": "DashCaddy API server - Dashboard backend for Docker, Caddy & DNS management",
"main": "server.js",
"scripts": {
+9 -3
View File
@@ -27,8 +27,12 @@ module.exports = function(deps) {
res.setHeader('Cache-Control', 'no-store, no-cache, must-revalidate');
const serviceId = req.params.serviceId;
// Check TOTP session first
if (totpConfig.enabled && totpConfig.sessionDuration !== 'never') {
// SECURITY [DC-026]: Session is required whenever TOTP is enabled, regardless
// of sessionDuration. Previously the check was gated on `!== 'never'`, which
// meant an admin setting TOTP to never-expire accidentally created an
// authentication-free path to credential injection. Even with a non-expiring
// session, the request itself must still present a valid session cookie.
if (totpConfig.enabled) {
const valid = session.isValid(req);
if (!valid) return errorResponse(res, 401, 'Session expired or invalid', { authenticated: false });
}
@@ -100,7 +104,9 @@ module.exports = function(deps) {
router.get('/auth/app-token/:serviceId', ctx.licenseManager.requirePremium('sso'), asyncHandler(async (req, res) => {
const { serviceId } = req.params;
if (totpConfig.enabled && totpConfig.sessionDuration !== 'never') {
// SECURITY [DC-026]: Same gate fix as /auth/gate — drop the sessionDuration
// exception. TOTP-enabled means session is required, period.
if (totpConfig.enabled) {
if (!session.isValid(req)) throw new AuthenticationError('Not authenticated');
}
+19 -2
View File
@@ -53,14 +53,23 @@ const ACTION_MAP = {
'DELETE /api/v1/favicon': 'config.favicon-delete',
'POST /api/v1/tailscale/config': 'config.tailscale',
'POST /api/v1/tailscale/protect-service': 'config.tailscale-protect',
// SECURITY [DC-028]: Credential-exposure events get named actions so the
// audit log can answer "who hit /auth/gate/plex at 03:00 with what outcome?".
'GET /api/v1/auth/gate': 'auth.credential-injection',
'GET /api/v1/auth/app-token': 'auth.app-token-issue',
'POST /api/v1/auth/keys': 'auth.api-key-generate',
'DELETE /api/v1/auth/keys': 'auth.api-key-revoke',
'POST /api/v1/auth/jwt': 'auth.jwt-mint',
};
// Paths to skip logging (noisy or internal)
const SKIP_PATHS = [
'/api/v1/totp/verify',
'/api/v1/totp/check-session',
'/api/v1/auth/gate/',
'/api/v1/auth/app-token/',
// SECURITY [DC-028]: /auth/gate and /auth/app-token are NOT skipped —
// they expose credentials (Basic Auth, X-Api-Key, upstream service tokens)
// so we MUST log every hit. Previously these were in SKIP_PATHS which
// silently dropped credential-exposure events from the audit log.
'/api/v1/audit-logs',
'/api/v1/health',
'/health',
@@ -95,6 +104,14 @@ class AuditLogger {
}
shouldSkip(method, urlPath) {
// SECURITY [DC-028]: Auth endpoints that expose credentials are
// logged even though they're GETs. /auth/gate and /auth/app-token
// return Basic Auth headers and upstream service tokens — these
// events MUST be auditable. Other GETs remain skipped (probes,
// dashboards, status checks flood the log).
if (urlPath.startsWith('/api/v1/auth/gate') || urlPath.startsWith('/api/v1/auth/app-token')) {
return false; // log it
}
if (method === 'GET') return true;
for (const skip of SKIP_PATHS) {
if (urlPath.startsWith(skip)) return true;
+19
View File
@@ -479,6 +479,25 @@ module.exports = function configureMiddleware(app, {
// RateLimit-Limit / RateLimit-Remaining for clients to see.
app.use('/api/v1/totp/setup', totpLimiter);
// SECURITY [DC-027]: Dedicated rate limiter for credential-touching auth
// endpoints. /auth/keys (manage API keys), /auth/jwt (mint admin JWT),
// /auth/gate/* (Caddy forward_auth — returns Basic Auth + X-Api-Key),
// /auth/app-token/* (returns upstream service tokens like Plex/Prowlarr).
// Without this, an attacker with a guessed-or-leaked session cookie could
// burn through every endpoint. 20 requests per 15 min is plenty for legit
// use (1/min average) but cuts off brute-force + scraping cold.
const authLimiter = rateLimit({
...RATE_LIMITS.STRICT,
standardHeaders: true,
legacyHeaders: false,
skip: () => isTest,
message: { success: false, error: 'Too many auth requests, please try again later' }
});
app.use('/api/v1/auth/keys', authLimiter);
app.use('/api/v1/auth/jwt', authLimiter);
app.use('/api/v1/auth/gate', authLimiter);
app.use('/api/v1/auth/app-token', authLimiter);
// ── Audit logging middleware (logs non-GET API requests) ──
app.use(auditLogger.middleware());
+1
View File
@@ -47,4 +47,5 @@ docker run -d --restart unless-stopped --name ${CONTAINER_NAME} \
-e CADDY_ADMIN_URL=http://${HOST_IP}:2019 \
-e ASSETS_DIR=/app/assets \
-e DASHCADDY_API_SOURCE_DIR=/opt/dashcaddy/dashcaddy-api \
-e DASHCADDY_UPDATE_ENABLED=false \
${IMAGE}