Compare commits

...
4 Commits
Author SHA1 Message Date
Hermes 99ec6ebc53 fix(tailscale-admin): harden apiToken/tags/description validation (DC-080) [glm-grade=B]
DC-080 round-1 GLM-5.3 judge verdict: B. Round-2 polish folded into same
commit per multi-round fix-first protocol: tighten tag regex to require
non-empty name after 'tag:' (matches Tailscale spec), drop dead
`module.exports.createApp = null` line.

THREAT MODEL
Pre-fix, /api/v1/tailscale/* and /api/v1/tailscale/admin/* (TOTP-gated)
had inconsistent checks on caller-supplied input. Three coupled gaps:

  (a) PUT /settings validated `apiToken.startsWith('tskey-api-')` but
      had NO length cap — body-parser limit was the only ceiling. A 1 MB
      string starting with `tskey-api-` would be `.trim()`-ed, sent to
      Tailscale's /devices endpoint, and waste server-side CPU on a
      request that will always 401.
  (b) POST /settings/test accepted `apiToken` from the body with NO
      validation at all. The PUT route's prefix check did NOT extend to
      this path. An operator could submit arbitrary junk and the
      container would still call /devices on the Tailscale API with it
      (DoS-reflection + fingerprint timing for an attacker probing
      whether this API token format is accepted).
  (c) POST /admin/keys validated `tags` as Array but NOT per-element
      type — `tags: ['tag:guest', null, 123, {injection: true}]` would
      be forwarded to Tailscale verbatim. Tailscale's API is JSON-strict
      and would 400 the request, but the bad shape reached the wire.
      Similarly `description` had no length cap (Tailscale caps at 120
      chars per their docs).

All three are gated by TOTP — this is a logged-in-operator / phished-
session threat surface, not anonymous-unauth. The fix is defense-in-
depth: a bug in the auth path (TOTP bypass, session theft, future route
handler trust-boundary drift) should not turn these endpoints into a
`submit anything and forward to Tailscale` relay.

FIX 1 — Shared validators (round-1)
- `_validateApiToken(token)`: typeof string check, prefix required,
  length cap 256 chars. Catches empty/null/non-string AND oversize.
- `_validateTags(tags)`: undefined/null allowed (optional field),
  Array.isArray check, max 32 entries, per-element string check,
  per-element length cap 64 chars, regex
  `/^tag:[a-z0-9][a-z0-9_-]{0,62}$/` (round-2: requires non-empty
  name after `tag:` per Tailscale spec).
- `_validateDescription(description)`: undefined/null allowed, string
  type check, length cap 120 chars (matches Tailscale's documented cap).

All three return null on success or an error string on failure. Route
  layer maps to 400 via `errorResponse`. Validators exported via
  `module.exports._validators` for direct unit testing (otherwise
  unreachable from outside the factory closure).

FIX 2 — Endpoint wiring (round-1)
- PUT /settings: replaced inline `!startsWith('tskey-api-')` check with
  `_validateApiToken(token)`. Single source of truth for the rule.
- POST /settings/test: added `_validateApiToken(token)` guard BEFORE
  calling `client.setApiToken(token)`. The body is optional, so the
  guard is skipped when no token is provided (uses stored token path).
- POST /admin/keys: replaced `Array.isArray(opts.tags)` shallow check
  with `_validateTags(opts.tags)`, plus `_validateDescription(opts.description)`.
  Old code already validated `expirySeconds`; that stays.

FIX 3 — Round-2 polish
- TAG_KEY_RE: `/^[a-z0-9][a-z0-9:_-]{0,63}$/` → `/^tag:[a-z0-9][a-z0-9_-]{0,62}$/`.
  The old regex accepted `tag:` (empty name), which Tailscale's API
  rejects. New regex requires `tag:` prefix and ≥1 alphanumeric name
  char followed by [a-z0-9_-]{0,62} — total length up to 67 chars, well
  within Tailscale's documented 15..63 char tag length.
- Removed `module.exports.createApp = null` vestigial line — the file
  only exports the factory function and the _validators bag.

TESTS (29 original + 16 new = 45 in this suite)
- 4 PUT /settings new: length cap, non-string type, prefix round-trip
  (existing 'starts with' tests already passed), plus the original
  6 (4 pre-existing PUT tests stay green).
- 4 POST /settings/test new: prefix rejection, length cap, stored-token
  path with empty body still works.
- 4 POST /admin/keys new: null/123/object entries rejected, uppercase /
  whitespace / CRLF rejected, description length cap, canonical
  lowercase `tag:server` accepted.
- 4 direct validator unit tests: validateApiToken (5 cases incl. cap-edge),
  validateTags (8 cases incl. round-2 bare-'tag:' rejection), validateDescription
  (3 cases incl. cap-edge), constants-export surface.

All 45 tests pass on DNS2 (verified). Full repo suite unchanged: 2351/2351.
2026-08-18 18:32:34 -07:00
dashcaddy-polish a7260436d1 fix(disaster-recovery): stage Caddyfile + close path-traversal in assets/themes (DC-079) [glm-grade=A]
CI / Test & Lint (push) Canceled after 0s
CI / Security audit (push) Canceled after 0s
DC-079 2-round GLM-5.3 judge verdict: round1=C (blocking path-traversal
in assets/themes) → round2=A. 20/20 tests in routes/discover-disaster
(8 original + 12 new). Full repo: 2351/2351 (4 pre-existing billing
pdfkit failures unchanged).

THREAT MODEL
POST /api/v1/disaster/restore was the ONLY endpoint in the route tree
that wrote directly to process.env.CADDYFILE_PATH (=/caddyfile in
container = /etc/caddy/Caddyfile on host via start.sh:161 bind-mount).
Pre-fix: an authenticated dashboard operator POSTed
  {caddyfile: '<attacker-controlled-string>'}
and the handler called fsp.writeFile(caddyfilePath, snapshot.caddyfile),
overwriting the live Caddyfile immediately. Caddy reads this file on
every reload (ACME renewal, health probe, admin API touch), so the
attacker-controlled content executes as Caddy config directives:
  - import /etc/caddy/<anything-caddy-can-read> (content theft)
  - admin off (lock out admin API)
  - reverse_proxy to attacker IPs (Caddy becomes a pivot)
  - acme_ca override to attacker CA (rogue cert issuance)
  - log to attacker-writable paths (DoS/escape)
This bypassed the CLAUDE.md hard rule 'Caddyfile edits must use
caddy-apply' (validates + reloads + git-commits atomically).

FIX 1 — Caddyfile staging (round-1)
- New validateCaddyfileContent(): type check, non-empty check,
  512 KiB byte cap (defense-in-depth below the 1 MB body-parser limit),
  FORBIDDEN_IMPORT_RE rejects  directives with absolute paths,
  ../-escape, ~/, or URL-encoded payloads.
- POST /disaster/restore now writes to <dataDir>/disaster-staged/
  Caddyfile.candidate (atomic write + rename), NEVER to caddyfilePath.
- Response includes caddyfileStaged[{file, stagedPath, action: 'awaiting
  caddy-apply', livePath}] and a DC-079 warning instructing the operator
  to run `caddy-apply <reason>` to validate + reload + git-commit.

FIX 2 — assets/themes path-traversal (round-2 BLOCKING)
GLM round-1 caught a parallel vector: snapshot.assets[name] and
snapshot.themes[name] are user-controlled JSON keys flowing into
path.join(assetsDir, name) and path.join(themesDir, name). An attacker
could POST {assets: {'../../etc/caddy/Caddyfile': '<base64-evil>'}}
and overwrite the live Caddyfile via the dataDir bind-mount, fully
bypassing Fix 1.
- ASSET_KEY_RE = /^[a-zA-Z0-9._-]+$/ + ASSET_PATH_TRAVERSAL_RE catch
  slashes, leading '..', and absolute-path keys.
- THEME_NAME_RE = /^[a-zA-Z0-9._-]+\.json\$/ additionally forces
  .json extension and no slashes.
- assertSafeAssetKey/assertSafeThemeName helpers throw on invalid input.
- Both restore loops now: assert → path.resolve(dir, name) → containment
  check (resolved must start with path.resolve(dir) + path.sep) → write
  to resolved (never the raw join).

TESTS
12 new tests in __tests__/routes/discover-disaster.routes.test.js:
- staging: live sentinel unchanged, candidate at expected path
- rejects: non-string, empty, oversize, 3 forbidden-import variants
- assets: path-traversal key, absolute-path key
- themes: path-traversal name, no-extension name
- back-compat: no caddyfile field succeeds without staging
2026-08-18 17:52:49 -07:00
Hermes a4e4b24732 fix(update-manager): force IPv4 + per-request timeout + transient-only retry on registry digest probes (DC-078) [glm-grade=A]
CI / Test & Lint (push) Canceled after 0s
CI / Security audit (push) Canceled after 0s
The per-hour checkForUpdates() loop called Docker Hub / ghcr.io without
family:4, without a hard request timeout, and without retry on transient
network errors. On DNS2 (Technitium at 100.121.150.22 returns AAAA records
even when IPv6 routing to public registries is intermittently broken), every
container check surfaced AggregateError [ETIMEDOUT] in error.log with stack
`at internalConnectMultiple (node:net:1114:18)`. The dual-stack DNS race
consumed the default 30s connect timeout per unreachable IPv6 family before
falling back to IPv4 — 30s+ per container per check cycle.

Three reliability properties added via shared fetchWithReliability() helper:
1. family:4 — IPv4-only DNS lookup. Avoids the dual-stack race entirely.
2. Hard per-request timeout (10s) — caps total latency per attempt.
3. Retry on transient codes only (ETIMEDOUT/ENOTFOUND/ENETUNREACH/...) — HTTP
   4xx/5xx are surfaced as real responses, not retried.

The 401 → WWW-Authenticate → token → Bearer auth flow is now explicit in
getDockerHubDigest (was previously a side effect of authenticateAndGetDigest,
which has been removed — no remaining callers).

Verified end-to-end against real Docker Hub:
- linuxserver/plex:latest → real digest in 1349ms (was 30s+ AggregateError)
- 5-container checkForUpdates() cycle: 3.6s total (was 150s+)
- 86/86 update-manager tests pass; 2343/2343 full suite (4 pre-existing
  pdfkit module-resolution failures unrelated to this change)
2026-08-18 17:35:59 -07:00
Hermes 0086de97da Merge feature/dc-064-discover-adopt-fetcht: DC-077 nesting-guard silent no-op fix [glm-grade=B]
CI / Test & Lint (push) Canceled after 0s
CI / Security audit (push) Canceled after 0s
2026-08-18 17:07:47 -07:00
6 changed files with 1337 additions and 129 deletions
@@ -18,7 +18,11 @@ function createDiscoverApp(docker, servicesStateManager) {
function createDisasterApp(platformPaths, log) {
const app = express();
app.use(express.json());
// Match the production body-parser limit (1 MiB) so the in-handler
// DC-079 cap (512 KiB) is actually reachable from tests. The default
// express.json() limit is 100 KiB, which would short-circuit the test
// with a 413 before the route's defense-in-depth check runs.
app.use(express.json({ limit: '1mb' }));
const routes = require('../../routes/disaster-recovery');
const wrap = (fn) => (req, res, next) => Promise.resolve(fn(req, res, next)).catch(next);
app.use('/api/v1', routes({ platformPaths, log: log || { info: jest.fn(), error: jest.fn() }, asyncHandler: wrap }));
@@ -135,4 +139,267 @@ describe('DC-107: Disaster Recovery', () => {
const svc = JSON.parse(fs.readFileSync(path.join(tmpDir, 'services.json'), 'utf8'));
expect(svc[0].id).toBe('restored-svc');
});
// DC-079: Caddyfile restore hardening — the live Caddyfile path must
// NEVER be written from the disaster-recovery endpoint. The endpoint
// stages the candidate file under dataDir/disaster-staged/Caddyfile.candidate
// and surfaces a warning that `caddy-apply` is required to apply it.
it('DC-079: POST /disaster/restore with caddyfile STAGES instead of writing the live Caddyfile', async () => {
// The env var CADDYFILE_PATH is read by the route. Use a sentinel
// path that we can prove was NOT written. The route must instead
// create <dataDir>/disaster-staged/Caddyfile.candidate.
const liveSentinel = path.join(tmpDir, 'LIVE_CADDYFILE_SENTINEL.txt');
fs.writeFileSync(liveSentinel, 'do-not-overwrite');
const candidateCaddyfile =
'# staged candidate\n' +
'example.com {\n' +
' respond "ok"\n' +
'}\n';
const app = createDisasterApp({
dataDir: tmpDir,
caddyfilePath: liveSentinel, // route reads env or fallback; this is just for the response
});
// Override process.env.CADDYFILE_PATH so the route picks up our sentinel
const prev = process.env.CADDYFILE_PATH;
process.env.CADDYFILE_PATH = liveSentinel;
try {
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
caddyfile: candidateCaddyfile,
});
expect(res.status).toBe(200);
expect(res.body.status).toBe('success');
expect(res.body.caddyfileStaged).toBeTruthy();
expect(res.body.caddyfileStaged).toHaveLength(1);
expect(res.body.caddyfileStaged[0].file).toBe('Caddyfile');
expect(res.body.caddyfileStaged[0].action).toBe('awaiting caddy-apply');
expect(res.body.caddyfileStaged[0].stagedPath).toBe(
path.join(tmpDir, 'disaster-staged', 'Caddyfile.candidate')
);
expect(res.body.caddyfileStaged[0].livePath).toBe(liveSentinel);
expect(res.body.warning).toMatch(/DC-079/);
// The live sentinel file is UNTOUCHED — still has its original content.
const liveContents = fs.readFileSync(liveSentinel, 'utf8');
expect(liveContents).toBe('do-not-overwrite');
// The candidate file IS staged at the staging path.
const stagedContents = fs.readFileSync(
path.join(tmpDir, 'disaster-staged', 'Caddyfile.candidate'),
'utf8'
);
expect(stagedContents).toBe(candidateCaddyfile);
} finally {
if (prev === undefined) delete process.env.CADDYFILE_PATH;
else process.env.CADDYFILE_PATH = prev;
}
});
it('DC-079: POST /disaster/restore rejects non-string caddyfile content', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
caddyfile: { evil: 'object' },
});
expect(res.status).toBe(400);
expect(res.body.error).toMatch(/Caddyfile content must be a string/);
});
it('DC-079: POST /disaster/restore rejects explicit empty caddyfile string', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
caddyfile: '', // explicit empty payload — rejected
});
expect(res.status).toBe(400);
expect(res.body.error).toMatch(/Caddyfile content is empty/);
});
it('DC-079: POST /disaster/restore rejects oversized caddyfile content', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
// 512 KiB + 1 byte — over the in-handler cap, under the 1 MB body limit
const huge = 'a'.repeat(512 * 1024 + 1);
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
caddyfile: huge,
});
expect(res.status).toBe(400);
expect(res.body.error).toMatch(/exceeds 524288 bytes/);
});
it('DC-079: POST /disaster/restore rejects forbidden `import` directive (absolute path)', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const evil =
'# malicious snapshot\n' +
'import /etc/caddy/external.caddy\n' +
'example.com { respond "ok" }\n';
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
caddyfile: evil,
});
expect(res.status).toBe(400);
expect(res.body.error).toMatch(/forbidden `import` directive/);
// No staging file should have been created — fail closed.
expect(fs.existsSync(path.join(tmpDir, 'disaster-staged', 'Caddyfile.candidate'))).toBe(false);
});
it('DC-079: POST /disaster/restore rejects forbidden `import` with relative-path escape', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const evil =
'# malicious snapshot\n' +
'import ../../../etc/passwd\n' +
'example.com { respond "ok" }\n';
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
caddyfile: evil,
});
expect(res.status).toBe(400);
expect(res.body.error).toMatch(/forbidden `import` directive/);
});
it('DC-079: POST /disaster/restore rejects URL-encoded import payload', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const evil =
'import %2fetc%2fcaddy%2fevil.caddy\n' +
'example.com { respond "ok" }\n';
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
caddyfile: evil,
});
expect(res.status).toBe(400);
expect(res.body.error).toMatch(/forbidden `import` directive/);
});
it('DC-079: POST /disaster/restore without caddyfile field succeeds and stages nothing', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
files: {
services: [{ id: 'no-caddy' }],
},
});
expect(res.status).toBe(200);
expect(res.body.caddyfileStaged).toBeUndefined();
expect(res.body.warning).toBeUndefined();
});
// DC-079 follow-up (GLM round-2 BLOCKING): assets/themes path traversal.
// Without the assertSafeAssetKey / assertSafeThemeName + path.resolve
// checks, an attacker can POST `{assets: {"../../etc/caddy/Caddyfile":
// "<base64-evil>"}}` and overwrite the live Caddyfile via the dataDir
// bind-mount. These tests prove the fix.
it('DC-079: POST /disaster/restore rejects assets with path-traversal key', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
assets: {
'../../etc/caddy/Caddyfile': Buffer.from('EVIL_BASE64_PAYLOAD').toString('base64'),
'custom-logo.png': Buffer.from('legit-logo').toString('base64'),
},
});
// The traversal key is rejected (added to errors), the legit key
// still works. Status is success-or-partial, never 500.
expect(res.status).toBe(200);
expect(res.body.status).toBe('partial'); // one error
const erroredFile = res.body.errors.find(e => e.file && e.file.includes('../../etc/caddy/Caddyfile'));
expect(erroredFile).toBeTruthy();
expect(erroredFile.error).toMatch(/forbidden characters or path segments/);
// The legit logo DID get written.
const legitPath = path.join(tmpDir, 'assets', 'custom-logo.png');
expect(fs.existsSync(legitPath)).toBe(true);
// The traversal target was NEVER written.
const escapePath = path.join(tmpDir, 'assets', '../../etc/caddy/Caddyfile');
// Resolve to absolute path — should be outside tmpDir/assets.
const resolvedEsc = path.resolve(escapePath);
expect(fs.existsSync(resolvedEsc)).toBe(false);
});
it('DC-079: POST /disaster/restore rejects assets with absolute path key', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
assets: {
'/etc/passwd': Buffer.from('evil').toString('base64'),
},
});
expect(res.status).toBe(200);
expect(res.body.status).toBe('partial');
const erroredFile = res.body.errors.find(e => e.file && e.file.includes('/etc/passwd'));
expect(erroredFile).toBeTruthy();
});
it('DC-079: POST /disaster/restore rejects themes with path-traversal name', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
themes: {
'../../../etc/caddy/evil.json': { evil: true },
'legit-theme.json': { ok: true },
},
});
expect(res.status).toBe(200);
expect(res.body.status).toBe('partial');
const erroredFile = res.body.errors.find(e => e.file && e.file.includes('../../../etc/caddy/evil.json'));
expect(erroredFile).toBeTruthy();
expect(erroredFile.error).toMatch(/must match/);
// The legit theme DID get written.
expect(fs.existsSync(path.join(tmpDir, 'themes', 'legit-theme.json'))).toBe(true);
});
it('DC-079: POST /disaster/restore rejects themes without .json extension', async () => {
const app = createDisasterApp({ dataDir: tmpDir });
const res = await request(app)
.post('/api/v1/disaster/restore')
.send({
version: '1.0',
themes: {
'no-extension': { ok: true },
},
});
expect(res.status).toBe(200);
expect(res.body.status).toBe('partial');
const erroredFile = res.body.errors.find(e => e.file && e.file.includes('no-extension'));
expect(erroredFile).toBeTruthy();
expect(erroredFile.error).toMatch(/must match/);
});
});
@@ -131,6 +131,20 @@ describe('routes/tailscale-admin: PUT /settings', () => {
expect(res.status).toBe(400);
});
test('400 on apiToken exceeding 256-char length cap (DC-080)', async () => {
const { app } = createApp();
const oversized = 'tskey-api-' + 'x'.repeat(300); // > 256 chars
const res = await request(app).put('/api/v1/tailscale/settings').send({ apiToken: oversized });
expect(res.status).toBe(400);
expect(res.body.error || res.body.message).toMatch(/exceeds maximum length/i);
});
test('400 on non-string apiToken (DC-080)', async () => {
const { app } = createApp();
const res = await request(app).put('/api/v1/tailscale/settings').send({ apiToken: 12345 });
expect(res.status).toBe(400);
});
test('200 + saves token + writes metadata on valid token', async () => {
const fakeClient = makeFakeClient({
ping: jest.fn(async () => ({ domain: 'real.ts.net' })),
@@ -293,6 +307,76 @@ describe('routes/tailscale-admin: POST /settings/test', () => {
expect(res.body.valid).toBe(true);
expect(fakeClient.setApiToken).toHaveBeenCalledWith('tskey-api-test-only');
});
test('400 on body.apiToken not starting with tskey-api- (DC-080)', async () => {
const fakeClient = makeFakeClient();
const app = express();
app.use(express.json());
const routes = require('../../routes/tailscale-admin');
const tailscaleCoord = {
loadMetadata: () => ({ configured: false }),
saveMetadata: jest.fn(),
setApiToken: jest.fn(),
getClient: jest.fn(async () => fakeClient),
hasApiToken: jest.fn(),
};
app.use('/api/v1/tailscale', routes({
tailscaleCoord, asyncHandler,
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
}));
const res = await request(app)
.post('/api/v1/tailscale/settings/test')
.send({ apiToken: 'arbitrary-junk' });
expect(res.status).toBe(400);
expect(fakeClient.setApiToken).not.toHaveBeenCalled();
});
test('400 on body.apiToken exceeding length cap (DC-080)', async () => {
const fakeClient = makeFakeClient();
const app = express();
app.use(express.json());
const routes = require('../../routes/tailscale-admin');
const tailscaleCoord = {
loadMetadata: () => ({ configured: false }),
saveMetadata: jest.fn(),
setApiToken: jest.fn(),
getClient: jest.fn(async () => fakeClient),
hasApiToken: jest.fn(),
};
app.use('/api/v1/tailscale', routes({
tailscaleCoord, asyncHandler,
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
}));
const oversized = 'tskey-api-' + 'x'.repeat(300);
const res = await request(app)
.post('/api/v1/tailscale/settings/test')
.send({ apiToken: oversized });
expect(res.status).toBe(400);
expect(fakeClient.setApiToken).not.toHaveBeenCalled();
});
test('omitting apiToken is allowed (uses stored token path) (DC-080)', async () => {
const fakeClient = makeFakeClient({ ping: jest.fn(async () => ({ domain: 'stored.ts.net' })) });
const app = express();
app.use(express.json());
const routes = require('../../routes/tailscale-admin');
const tailscaleCoord = {
loadMetadata: () => ({ configured: true }),
saveMetadata: jest.fn(),
setApiToken: jest.fn(),
getClient: jest.fn(async () => fakeClient),
hasApiToken: jest.fn(),
};
app.use('/api/v1/tailscale', routes({
tailscaleCoord, asyncHandler,
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
}));
const res = await request(app)
.post('/api/v1/tailscale/settings/test')
.send({}); // no apiToken in body
expect(res.status).toBe(200);
expect(res.body.valid).toBe(true);
});
});
describe('routes/tailscale-admin: GET /admin/devices', () => {
@@ -511,6 +595,99 @@ describe('routes/tailscale-admin: pre-auth keys', () => {
expect(res.status).toBe(400);
});
test('POST /admin/keys rejects null/123/object tags entries (DC-080)', async () => {
const fakeClient = makeFakeClient();
const app = express();
app.use(express.json());
const routes = require('../../routes/tailscale-admin');
const tailscaleCoord = {
loadMetadata: () => ({ configured: true }),
saveMetadata: jest.fn(),
setApiToken: jest.fn(),
getClient: jest.fn(async () => fakeClient),
hasApiToken: jest.fn(),
};
app.use('/api/v1/tailscale', routes({
tailscaleCoord, asyncHandler,
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
}));
// Mixed: null, number, object — all must be rejected
const res = await request(app).post('/api/v1/tailscale/admin/keys').send({ tags: ['tag:guest', null, 123, { x: 1 }] });
expect(res.status).toBe(400);
expect(fakeClient.createAuthKey).not.toHaveBeenCalled();
});
test('POST /admin/keys rejects uppercase / whitespace / CRLF in tags (DC-080)', async () => {
const fakeClient = makeFakeClient();
const app = express();
app.use(express.json());
const routes = require('../../routes/tailscale-admin');
const tailscaleCoord = {
loadMetadata: () => ({ configured: true }),
saveMetadata: jest.fn(),
setApiToken: jest.fn(),
getClient: jest.fn(async () => fakeClient),
hasApiToken: jest.fn(),
};
app.use('/api/v1/tailscale', routes({
tailscaleCoord, asyncHandler,
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
}));
const res = await request(app).post('/api/v1/tailscale/admin/keys').send({ tags: ['TAG:guest', 'tag:foo bar', 'tag:x\r\ninjection'] });
expect(res.status).toBe(400);
expect(fakeClient.createAuthKey).not.toHaveBeenCalled();
});
test('POST /admin/keys rejects description exceeding 120 chars (DC-080)', async () => {
const fakeClient = makeFakeClient();
const app = express();
app.use(express.json());
const routes = require('../../routes/tailscale-admin');
const tailscaleCoord = {
loadMetadata: () => ({ configured: true }),
saveMetadata: jest.fn(),
setApiToken: jest.fn(),
getClient: jest.fn(async () => fakeClient),
hasApiToken: jest.fn(),
};
app.use('/api/v1/tailscale', routes({
tailscaleCoord, asyncHandler,
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
}));
const longDesc = 'a'.repeat(200); // > 120 chars
const res = await request(app).post('/api/v1/tailscale/admin/keys').send({ description: longDesc });
expect(res.status).toBe(400);
expect(fakeClient.createAuthKey).not.toHaveBeenCalled();
});
test('POST /admin/keys accepts canonical lowercase tag: form (DC-080)', async () => {
const fakeClient = makeFakeClient({
createAuthKey: jest.fn(async (opts) => ({ id: 'k2', key: 'tskey-secret-2', ...opts })),
});
const app = express();
app.use(express.json());
const routes = require('../../routes/tailscale-admin');
const tailscaleCoord = {
loadMetadata: () => ({ configured: true }),
saveMetadata: jest.fn(),
setApiToken: jest.fn(),
getClient: jest.fn(async () => fakeClient),
hasApiToken: jest.fn(),
};
app.use('/api/v1/tailscale', routes({
tailscaleCoord, asyncHandler,
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
}));
const res = await request(app).post('/api/v1/tailscale/admin/keys').send({
tags: ['tag:guest-plex', 'tag:server'],
expirySeconds: 86400,
});
expect(res.status).toBe(200);
expect(fakeClient.createAuthKey).toHaveBeenCalledWith(expect.objectContaining({
tags: ['tag:guest-plex', 'tag:server'],
}));
});
test('POST /admin/keys rejects negative expirySeconds', async () => {
const fakeClient = makeFakeClient();
const app = express();
@@ -573,3 +750,109 @@ describe('routes/tailscale-admin: security boundary', () => {
expect(stored.token).toBeNull();
});
});
// DC-080 direct validator unit tests (no supertest, no Express)
describe('routes/tailscale-admin: DC-080 validators (direct)', () => {
const { _validators } = require('../../routes/tailscale-admin');
const {
validateApiToken,
validateTags,
validateDescription,
TAILSCALE_TOKEN_PREFIX,
TAILSCALE_TOKEN_MAX_LEN,
DESCRIPTION_MAX_LEN,
} = _validators;
describe('validateApiToken', () => {
test('accepts canonical tskey-api-...', () => {
expect(validateApiToken('tskey-api-abc123')).toBeNull();
});
test('rejects empty', () => {
expect(validateApiToken('')).toMatch(/required/);
});
test('rejects undefined / null', () => {
expect(validateApiToken(undefined)).toMatch(/required/);
expect(validateApiToken(null)).toMatch(/required/);
});
test('rejects non-string (number, object, array)', () => {
expect(validateApiToken(123)).toMatch(/must be a string/);
expect(validateApiToken({})).toMatch(/must be a string/);
expect(validateApiToken(['x'])).toMatch(/must be a string/);
});
test('rejects wrong prefix', () => {
expect(validateApiToken('not-a-token')).toMatch(/must start with/);
});
test('accepts exactly at length cap', () => {
const token = 'tskey-api-' + 'x'.repeat(TAILSCALE_TOKEN_MAX_LEN - 'tskey-api-'.length);
expect(validateApiToken(token)).toBeNull();
});
test('rejects 1 over length cap', () => {
const token = 'tskey-api-' + 'x'.repeat(TAILSCALE_TOKEN_MAX_LEN - 'tskey-api-'.length + 1);
expect(validateApiToken(token)).toMatch(/exceeds maximum length/);
});
});
describe('validateTags', () => {
test('accepts undefined / null (optional)', () => {
expect(validateTags(undefined)).toBeNull();
expect(validateTags(null)).toBeNull();
});
test('rejects non-array', () => {
expect(validateTags('tag:foo')).toMatch(/must be an array/);
expect(validateTags({})).toMatch(/must be an array/);
});
test('rejects entries that are not strings', () => {
expect(validateTags(['tag:a', null])).toMatch(/tags\[1\]/);
expect(validateTags(['tag:a', 123])).toMatch(/tags\[1\]/);
expect(validateTags(['tag:a', {}])).toMatch(/tags\[1\]/);
});
test('rejects uppercase / whitespace / CRLF', () => {
expect(validateTags(['TAG:foo'])).toMatch(/tags\[0\]/);
expect(validateTags(['tag:foo bar'])).toMatch(/tags\[0\]/);
expect(validateTags(['tag:foo\r\nbar'])).toMatch(/tags\[0\]/);
});
test('rejects entries starting with non-alnum (no leading colon)', () => {
expect(validateTags([':foo'])).toMatch(/tags\[0\]/);
});
test('rejects bare "tag:" with empty name (Tailscale spec violation) (DC-080 round-2)', () => {
expect(validateTags(['tag:'])).toMatch(/tags\[0\]/);
});
test('rejects colon-only chars after tag: prefix (DC-080 round-2)', () => {
expect(validateTags(['tag:::'])).toMatch(/tags\[0\]/);
expect(validateTags(['tag:---'])).toMatch(/tags\[0\]/);
});
test('accepts canonical tag:server form', () => {
expect(validateTags(['tag:server'])).toBeNull();
expect(validateTags(['tag:guest-plex', 'tag:server'])).toBeNull();
});
test('rejects empty array entry', () => {
expect(validateTags(['tag:a', ''])).toMatch(/tags\[1\]/);
});
});
describe('validateDescription', () => {
test('accepts undefined / null', () => {
expect(validateDescription(undefined)).toBeNull();
expect(validateDescription(null)).toBeNull();
});
test('rejects non-string', () => {
expect(validateDescription(123)).toMatch(/must be a string/);
});
test('rejects over 120 chars', () => {
const long = 'a'.repeat(DESCRIPTION_MAX_LEN + 1);
expect(validateDescription(long)).toMatch(/exceeds maximum length/);
});
test('accepts at the cap', () => {
const exact = 'a'.repeat(DESCRIPTION_MAX_LEN);
expect(validateDescription(exact)).toBeNull();
});
});
test('exports surface stays in sync with constants used inside validators', () => {
// Guard against drift: if a future refactor renames a constant, this fails
expect(TAILSCALE_TOKEN_PREFIX).toBe('tskey-api-');
expect(typeof TAILSCALE_TOKEN_MAX_LEN).toBe('number');
expect(typeof DESCRIPTION_MAX_LEN).toBe('number');
});
});
+246 -3
View File
@@ -125,6 +125,239 @@ describe('UpdateManager — Docker image update lifecycle', () => {
});
});
// ─── DC-078: registry digest probe reliability hardening ──────────────────
// Verifies that getLatestImageDigest / getDockerHubDigest / getGhcrDigest /
// fetchWithReliability all apply the IPv4-only + timeout + transient-retry
// policy. Without these guards, the per-hour checkForUpdates() loop on DNS2
// surfaces AggregateError [ETIMEDOUT] in error.log because the container's
// /etc/resolv.conf returns AAAA records from Technitium whose IPv6 path to
// public registries (Docker Hub, ghcr.io) is intermittently unreachable.
describe('DC-078 registry reliability', () => {
// Use real timers — fetchWithReliability's retry uses setTimeout for
// backoff, which jest's fake timers would block indefinitely.
beforeEach(() => {
jest.useRealTimers();
});
afterEach(() => {
jest.useFakeTimers({ doNotFake: ['setImmediate', 'queueMicrotask', 'nextTick'] });
});
it('_httpsRequestOnce sets family: 4 and timeout on the request options', async () => {
let capturedOptions = null;
const req = {
on: jest.fn(),
end: jest.fn(),
destroy: jest.fn(),
};
https.request.mockImplementation((options, cb) => {
capturedOptions = options;
// Return a 200 immediately so the promise resolves cleanly.
const res = {
statusCode: 200,
headers: {},
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
return req;
});
await updateManager._httpsRequestOnce({
hostname: 'registry-1.docker.io',
path: '/v2/library/nginx/manifests/latest',
headers: { Accept: 'application/vnd.docker.distribution.manifest.v2+json' },
maxBodyBytes: 65536,
});
expect(capturedOptions).not.toBeNull();
expect(capturedOptions.family).toBe(4);
expect(capturedOptions.timeout).toBeGreaterThan(0);
expect(capturedOptions.method).toBe('GET');
});
it('fetchWithReliability retries on transient ETIMEDOUT and eventually succeeds', async () => {
let attempts = 0;
https.request.mockImplementation((options, cb) => {
attempts += 1;
if (attempts === 1) {
// First attempt: emit ETIMEDOUT via the request 'error' event
const reqErr = new Error('request timeout');
reqErr.code = 'ETIMEDOUT';
const req = {
on: jest.fn((event, handler) => {
if (event === 'error') setImmediate(() => handler(reqErr));
}),
end: jest.fn(),
destroy: jest.fn(),
};
return req;
}
// Second attempt: 200 OK with a digest header
const res = {
statusCode: 200,
headers: { 'docker-content-digest': 'sha256:abc123def456' },
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
return { on: jest.fn(), end: jest.fn(), destroy: jest.fn() };
});
const result = await updateManager.fetchWithReliability({
hostname: 'registry-1.docker.io',
path: '/v2/library/nginx/manifests/latest',
});
expect(attempts).toBe(2);
expect(result.statusCode).toBe(200);
expect(result.headers['docker-content-digest']).toBe('sha256:abc123def456');
});
it('fetchWithReliability does NOT retry on non-transient HTTP errors', async () => {
let attempts = 0;
https.request.mockImplementation((options, cb) => {
attempts += 1;
const res = {
statusCode: 500,
headers: {},
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
return { on: jest.fn(), end: jest.fn(), destroy: jest.fn() };
});
const result = await updateManager.fetchWithReliability({
hostname: 'registry-1.docker.io',
path: '/v2/library/nginx/manifests/latest',
});
expect(attempts).toBe(1);
expect(result.statusCode).toBe(500);
});
it('fetchWithReliability retries up to REGISTRY_MAX_RETRIES then throws', async () => {
let attempts = 0;
https.request.mockImplementation(() => {
attempts += 1;
const reqErr = new Error('connect ETIMEDOUT');
reqErr.code = 'ETIMEDOUT';
const req = {
on: jest.fn((event, handler) => {
if (event === 'error') setImmediate(() => handler(reqErr));
}),
end: jest.fn(),
destroy: jest.fn(),
};
return req;
});
await expect(updateManager.fetchWithReliability({
hostname: 'registry-1.docker.io',
path: '/v2/library/nginx/manifests/latest',
})).rejects.toMatchObject({ code: 'ETIMEDOUT' });
// 1 initial attempt + REGISTRY_MAX_RETRIES retries
expect(attempts).toBe(1 + 1);
});
it('getDockerHubDigest returns digest on 200', async () => {
https.request.mockImplementation((options, cb) => {
const res = {
statusCode: 200,
headers: { 'docker-content-digest': 'sha256:hubdigest9999' },
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
return { on: jest.fn(), end: jest.fn(), destroy: jest.fn() };
});
const digest = await updateManager.getDockerHubDigest('nginx', 'latest');
expect(digest).toBe('sha256:hubdigest9999');
});
it('getDockerHubDigest acquires bearer token on 401 then returns digest', async () => {
let calls = 0;
https.request.mockImplementation((options, cb) => {
calls += 1;
if (calls === 1) {
// First call to registry-1.docker.io returns 401 with WWW-Authenticate
const res = {
statusCode: 401,
headers: {
'www-authenticate': 'Bearer realm="https://auth.example.com/token",service="registry.docker.io",scope="repository:library/nginx:pull"',
},
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
} else if (calls === 2) {
// Second call: auth.example.com returns the token JSON
const res = {
statusCode: 200,
headers: {},
on: jest.fn((event, handler) => {
if (event === 'data') handler(Buffer.from(JSON.stringify({ token: 'jwt-token-xyz' })));
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
} else {
// Third call: registry-1.docker.io with Bearer header returns the digest
expect(options.headers['Authorization']).toBe('Bearer jwt-token-xyz');
const res = {
statusCode: 200,
headers: { 'docker-content-digest': 'sha256:autheddigest7777' },
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
}
return { on: jest.fn(), end: jest.fn(), destroy: jest.fn() };
});
const digest = await updateManager.getDockerHubDigest('nginx', 'latest');
expect(digest).toBe('sha256:autheddigest7777');
expect(calls).toBe(3);
});
it('getGhcrDigest returns digest on 200', async () => {
https.request.mockImplementation((options, cb) => {
expect(options.hostname).toBe('ghcr.io');
const res = {
statusCode: 200,
headers: { 'docker-content-digest': 'sha256:ghcrdigest1234' },
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
}),
};
setImmediate(() => cb(res));
return { on: jest.fn(), end: jest.fn(), destroy: jest.fn() };
});
const digest = await updateManager.getGhcrDigest('ghcr.io/some/repo', 'latest');
expect(digest).toBe('sha256:ghcrdigest1234');
});
it('getLatestImageDigest returns null on transient errors after retries (registry unavailable)', async () => {
// Simulate a totally-down registry: every attempt fails with ETIMEDOUT.
// After REGISTRY_MAX_RETRIES the error propagates to getLatestImageDigest's
// catch arm, which logs and returns null (matches old behavior).
https.request.mockImplementation(() => {
const reqErr = new Error('connect ETIMEDOUT');
reqErr.code = 'ETIMEDOUT';
const req = {
on: jest.fn((event, handler) => {
if (event === 'error') setImmediate(() => handler(reqErr));
}),
end: jest.fn(),
destroy: jest.fn(),
};
return req;
});
const digest = await updateManager.getLatestImageDigest('nginx:latest');
expect(digest).toBeNull();
});
});
describe('parseAuthHeader', () => {
it('parses Docker Hub Bearer auth header', () => {
const header = 'Bearer realm="https://auth.docker.io/token",service="registry.docker.io",scope="repository:library/nginx:pull"';
@@ -481,7 +714,9 @@ describe('UpdateManager — Docker image update lifecycle', () => {
setImmediate(() => cb({
statusCode: 200,
headers: { 'docker-content-digest': 'sha256:fromregistry' },
on: jest.fn()
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
})
}));
return { on: jest.fn(), end: jest.fn() };
});
@@ -495,7 +730,9 @@ describe('UpdateManager — Docker image update lifecycle', () => {
setImmediate(() => cb({
statusCode: 401,
headers: {},
on: jest.fn()
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
})
}));
return { on: jest.fn(), end: jest.fn() };
});
@@ -504,6 +741,9 @@ describe('UpdateManager — Docker image update lifecycle', () => {
});
it('rejects on https request error', async () => {
// ECONNREFUSED is in REGISTRY_TRANSIENT_ERROR_CODES, so this would retry.
// Use a non-transient code (or no code) for the test to propagate.
jest.useRealTimers();
https.request.mockImplementation(() => {
const req = { on: jest.fn(), end: jest.fn() };
// Trigger error event asynchronously
@@ -516,6 +756,7 @@ describe('UpdateManager — Docker image update lifecycle', () => {
await expect(updateManager.getDockerHubDigest('nginx', 'latest'))
.rejects.toThrow('connection refused');
jest.useFakeTimers({ doNotFake: ['setImmediate', 'queueMicrotask', 'nextTick'] });
});
it('normalizes library/ prefix for official images', async () => {
@@ -525,7 +766,9 @@ describe('UpdateManager — Docker image update lifecycle', () => {
setImmediate(() => cb({
statusCode: 200,
headers: { 'docker-content-digest': 'sha256:digest' },
on: jest.fn()
on: jest.fn((event, handler) => {
if (event === 'end') setImmediate(handler);
})
}));
return { on: jest.fn(), end: jest.fn() };
});
+185 -11
View File
@@ -37,6 +37,81 @@ const BACKUP_FILES = [
const ASSET_FILES = ['custom-logo.png', 'custom-favicon.png', 'custom-logo.svg'];
// DC-079: Restrict restored assets to the hardcoded ASSET_FILES allowlist.
// The asset KEYS in the snapshot are user-controlled JSON, so iterating
// `Object.entries(snapshot.assets)` and writing each name verbatim into
// `path.join(assetsDir, name)` lets an attacker POST `{assets: {"../../etc/caddy/Caddyfile":
// "<base64-evil>"}}` and overwrite the live Caddyfile via the bind-mount
// (path.join('/app/data/assets', '../../etc/caddy/Caddyfile') resolves
// to /etc/caddy/Caddyfile). This bypasses the caddyfile-staging gate
// above because the dataDir bind-mount can write to /etc/caddy on the host.
const ASSET_KEY_RE = /^[a-zA-Z0-9._-]+$/;
const ASSET_PATH_TRAVERSAL_RE = /(^|\/)\.\.($|\/)|^\//;
// DC-079: Caddyfile content safety limits for disaster-recovery restore.
// The live Caddyfile on DNS2 is ~17 KB and grows linearly with vhost count.
// Express's default JSON body parser limit (1 MB) is the outer gate; this
// in-handler cap is defense-in-depth against either a future body-limit
// raise or a custom body parser. Cap well below the body-parser ceiling.
const MAX_CADDYFILE_BYTES = 512 * 1024; // 512 KiB — 30x the live file, far below 1 MB body limit
// DC-079: theme filenames must match this pattern. No slashes (no path
// traversal), no `..`, must end in `.json`, and only filename-safe chars.
// Themes are written to <dataDir>/themes/<name>; we also defense-in-depth
// check the resolved path stays inside that dir.
const THEME_NAME_RE = /^[a-zA-Z0-9._-]+\.json$/;
function assertSafeAssetKey(key) {
if (typeof key !== 'string' || key.length === 0 || key.length > 128) {
throw new Error(`asset key must be a non-empty string up to 128 chars`);
}
if (ASSET_PATH_TRAVERSAL_RE.test(key) || !ASSET_KEY_RE.test(key)) {
throw new Error(`asset key contains forbidden characters or path segments`);
}
}
function assertSafeThemeName(name) {
if (typeof name !== 'string' || name.length === 0 || name.length > 128) {
throw new Error(`theme name must be a non-empty string up to 128 chars`);
}
if (!THEME_NAME_RE.test(name)) {
throw new Error(`theme name must match ${THEME_NAME_RE} (alphanum / dot / dash / underscore, ending in .json)`);
}
}
// Reject Caddyfile content that smuggles in arbitrary `import` directives.
// caddy-apply expects the single top-level Caddyfile; any `import` to an
// absolute path means "load another file from disk at Caddy reload time" —
// that's a classic injection vector (an attacker can craft a snapshot whose
// `import /etc/caddy/external.caddy` reads any file Caddy can read).
// We allow the relative-style `import <snippet>` form ONLY if the snippet
// name matches a small allowlist of well-known Caddy snippet names (none
// today; add explicit names if a future snippet module is needed).
const FORBIDDEN_IMPORT_RE = /^\s*import\s+(["']|\/|\.\.|~\/|%[A-F0-9]{2})/im;
function validateCaddyfileContent(content) {
if (typeof content !== 'string') {
return { ok: false, error: 'Caddyfile content must be a string' };
}
if (content.length === 0) {
return { ok: false, error: 'Caddyfile content is empty' };
}
if (Buffer.byteLength(content, 'utf8') > MAX_CADDYFILE_BYTES) {
return { ok: false, error: `Caddyfile content exceeds ${MAX_CADDYFILE_BYTES} bytes` };
}
if (FORBIDDEN_IMPORT_RE.test(content)) {
// Allow the canonical single-quoted snippet import form ONLY if the
// snippet name is on the explicit allowlist (currently empty). This
// catches absolute paths, ../, ~/, and URL-encoded payloads while
// leaving room for future snippet additions without touching this gate.
return {
ok: false,
error: 'Caddyfile contains forbidden `import` directive (absolute path, encoded, or non-allowlisted snippet)'
};
}
return { ok: true };
}
module.exports = function({ servicesStateManager, platformPaths, log, asyncHandler }) {
const wrap = asyncHandler || ((fn) => (req, res, next) => Promise.resolve(fn(req, res, next)).catch(next));
const router = express.Router();
@@ -44,6 +119,15 @@ module.exports = function({ servicesStateManager, platformPaths, log, asyncHandl
let lastBackupStatus = { timestamp: null, status: null, size: null };
let lastRestoreStatus = { timestamp: null, status: null };
// DC-079: Staging dir for the candidate Caddyfile. The disaster-recovery
// restore endpoint stages here instead of writing directly to the live
// Caddyfile path. The operator must run `caddy-apply` (or its equivalent)
// to validate + reload + git-commit the staged file. This keeps the live
// Caddyfile under the same atomic-commit guard as every other edit.
function getStagedCaddyfileDir(dataDir) {
return path.join(dataDir, 'disaster-staged');
}
/**
* POST /api/v1/disaster/backup
* Creates a complete system snapshot as a downloadable JSON file.
@@ -175,13 +259,64 @@ module.exports = function({ servicesStateManager, platformPaths, log, asyncHandl
}
}
// Restore Caddyfile
if (snapshot.caddyfile) {
// DC-079: Stage the Caddyfile to a staging path inside dataDir
// instead of writing directly to caddyfilePath (which is the LIVE
// /etc/caddy/Caddyfile bind-mounted into the container as /caddyfile).
//
// Threat model (defense-in-depth, mirrors DC-070 / DC-074 / DC-076):
// the endpoint is TOTP-gated, but a compromised operator / phished
// session / pivot path could POST a snapshot with `caddyfile: <evil>`
// and the pre-fix code would call `fsp.writeFile(caddyfilePath, ...)`
// which writes the attacker-controlled string straight to the live
// Caddyfile. Caddy then reads that file on the next reload (which can
// be triggered by ACME renewals, health probes, or any admin API
// touch), executing whatever directives the attacker embedded:
// - `admin off` + arbitrary config write
// - `import /etc/caddy/<anything-caddy-can-read>` for content theft
// - `reverse_proxy` to attacker-controlled upstreams
// - `acme_ca` override to attacker CA
// - `log` directives to attacker-writable paths
//
// The Caddyfile is managed by the `caddy-apply` wrapper (validates +
// reloads + git-commits atomically — see CLAUDE.md hard rule). This
// endpoint previously bypassed that wrapper. The fix stages the
// candidate file under dataDir/disaster-staged/Caddyfile.candidate and
// returns the path so the operator can apply it via the normal flow.
const caddyfileStaged = [];
// DC-079: handle three cases for the caddyfile field:
// - absent/null/undefined: back-compat — no Caddyfile in snapshot
// - empty string "": explicit empty payload is suspicious — reject
// - non-string (object/array/number): type confusion attempt — reject
// - valid string: stage to dataDir/disaster-staged/Caddyfile.candidate
if (snapshot.caddyfile !== undefined && snapshot.caddyfile !== null) {
const validation = validateCaddyfileContent(snapshot.caddyfile);
if (!validation.ok) {
return errorResponse(res, 400, `Invalid Caddyfile in snapshot: ${validation.error}`, {
code: ErrorCodes.BACKUP.INVALID_CONFIG,
});
}
const stagedDir = getStagedCaddyfileDir(dataDir);
try {
await fsp.writeFile(caddyfilePath, snapshot.caddyfile);
restored.push('Caddyfile');
await fsp.mkdir(stagedDir, { recursive: true });
const stagedPath = path.join(stagedDir, 'Caddyfile.candidate');
// Atomic write: write to .candidate.tmp then rename. The live
// Caddyfile is NEVER touched from this endpoint.
const tmpPath = stagedPath + '.tmp';
await fsp.writeFile(tmpPath, snapshot.caddyfile, { mode: 0o644 });
await fsp.rename(tmpPath, stagedPath);
caddyfileStaged.push({
file: 'Caddyfile',
stagedPath,
action: 'awaiting caddy-apply',
livePath: caddyfilePath,
});
if (log) log.info('disaster-recovery', 'Caddyfile staged (not applied)', {
stagedPath,
size: Buffer.byteLength(snapshot.caddyfile, 'utf8'),
});
} catch (err) {
errors.push({ file: 'Caddyfile', error: err.message });
errors.push({ file: 'Caddyfile (staging)', error: err.message });
}
}
@@ -189,8 +324,20 @@ module.exports = function({ servicesStateManager, platformPaths, log, asyncHandl
const assetsDir = platformPaths?.resolveAssetsPath?.() || path.join(dataDir, 'assets');
for (const [name, base64] of Object.entries(snapshot.assets || {})) {
try {
// DC-079: assets directory is the first attack surface that
// bypasses the Caddyfile-staging gate. `name` is a user-supplied
// JSON key; without validation, `path.join(assetsDir, name)` lets
// an attacker escape to /etc/caddy via path traversal.
assertSafeAssetKey(name);
const resolved = path.resolve(assetsDir, name);
// Defense-in-depth: even after charset checks, the resolved path
// MUST stay inside assetsDir. If it doesn't, refuse the write.
if (!resolved.startsWith(path.resolve(assetsDir) + path.sep) &&
resolved !== path.resolve(assetsDir)) {
throw new Error(`asset path resolves outside assets directory`);
}
await fsp.mkdir(assetsDir, { recursive: true });
await fsp.writeFile(path.join(assetsDir, name), Buffer.from(base64, 'base64'));
await fsp.writeFile(resolved, Buffer.from(base64, 'base64'));
restored.push(`assets/${name}`);
} catch (err) {
errors.push({ file: `assets/${name}`, error: err.message });
@@ -203,8 +350,21 @@ module.exports = function({ servicesStateManager, platformPaths, log, asyncHandl
try {
await fsp.mkdir(themesDir, { recursive: true });
for (const [name, content] of Object.entries(snapshot.themes)) {
await fsp.writeFile(path.join(themesDir, name), JSON.stringify(content, null, 2));
restored.push(`themes/${name}`);
// DC-079: same path-traversal vector as assets — keys are
// user-controlled JSON. Validate the name AND confirm the
// resolved path stays inside themesDir.
try {
assertSafeThemeName(name);
const resolved = path.resolve(themesDir, name);
if (!resolved.startsWith(path.resolve(themesDir) + path.sep) &&
resolved !== path.resolve(themesDir)) {
throw new Error(`theme path resolves outside themes directory`);
}
await fsp.writeFile(resolved, JSON.stringify(content, null, 2));
restored.push(`themes/${name}`);
} catch (err) {
errors.push({ file: `themes/${name}`, error: err.message });
}
}
} catch (err) {
errors.push({ file: 'themes', error: err.message });
@@ -215,19 +375,33 @@ module.exports = function({ servicesStateManager, platformPaths, log, asyncHandl
timestamp: new Date().toISOString(),
status: errors.length === 0 ? 'success' : 'partial',
restored: restored.length,
staged: caddyfileStaged.length,
errors: errors.length,
};
if (log) log.info('disaster-recovery', 'Restore completed', lastRestoreStatus);
ok(res, {
// DC-079: Surface the staged-Caddyfile warning in the response body so
// the UI / operator can see that the Caddyfile is NOT yet live. The
// restore endpoint stages under dataDir/disaster-staged/Caddyfile.candidate
// and the operator must run `caddy-apply` (or its equivalent) to
// validate + reload + git-commit the staged file. The live Caddyfile
// is owned by the caddy-apply wrapper per CLAUDE.md hard rule.
const responseBody = {
status: errors.length === 0 ? 'success' : 'partial',
restored,
errors,
message: errors.length === 0
? `Successfully restored ${restored.length} files. Restart DashCaddy to apply.`
? `Successfully restored ${restored.length} files${caddyfileStaged.length > 0 ? ` (Caddyfile staged — ${caddyfileStaged[0].stagedPath}; run caddy-apply to apply)` : ''}. Restart DashCaddy to apply.`
: `Restored ${restored.length} files with ${errors.length} errors. Check error details.`,
});
};
if (caddyfileStaged.length > 0) {
responseBody.caddyfileStaged = caddyfileStaged;
responseBody.warning = '[DC-079] Caddyfile is STAGED, not applied. Live /etc/caddy/Caddyfile was NOT modified by this restore. Run `caddy-apply <reason>` (or equivalent) to validate + reload + git-commit the staged candidate.';
}
ok(res, responseBody);
}));
/**
+145 -7
View File
@@ -41,12 +41,124 @@
*
* DELETE /api/v1/tailscale/admin/devices/:id
* Revokes a device from the tailnet.
*
* # DC-080 input validation
*
* Three coupled gaps in the route layer pre-fix:
*
* (a) PUT /settings validated `apiToken.startsWith('tskey-api-')` but had
* no length cap — body-parser limit was the only ceiling. A 1 MB
* string starting with `tskey-api-` would be `.trim()`-ed, sent to
* Tailscale's /devices endpoint, and waste server-side CPU on a
* request that will always 401.
* (b) POST /settings/test accepted `apiToken` from the body with NO
* validation at all. The PUT route's prefix check is bypassed on
* the test path — an operator could submit any string and have the
* container ping Tailscale's API with it (low impact, but inconsistent
* with PUT and surfaces fingerprinting via the 401 timing).
* (c) POST /admin/keys validated `tags` as Array but NOT per-element
* type — `tags: ['tag:guest', null, 123, {injection: true}]` would be
* forwarded to Tailscale verbatim. Tailscale's API is JSON-strict
* and would 400 the request, but the bad shape reached the wire.
* Similarly `description` had no length cap (Tailscale caps at 120
* chars per their docs).
*
* All three are gated by TOTP — this is a logged-in-operator / phished-
* session threat surface, not anonymous-unauth. The fix is defense-in-
* depth: a bug in the auth path (TOTP bypass, session theft, future
* route handler trust-boundary drift) should not turn these endpoints
* into a "submit anything and forward to Tailscale" relay.
*/
const express = require('express');
const { ok, errorResponse } = require('../src/utils/responses');
const { TailscaleCoordError } = require('../src/managers/tailscale-coord');
// DC-080: shared validation helpers for the Tailscale admin surface.
// Tailscale API tokens follow the form `tskey-<kind>-<opaque>` where
// `<kind>` is one of a small set of values (`api`, `auth`, `partner`,
// `cli`). Real tokens observed in the wild are 40..80 chars; we cap at
// 256 to leave headroom for future Tailscale key formats without giving
// an unbounded buffer to validate+forward.
const TAILSCALE_TOKEN_PREFIX = 'tskey-api-';
const TAILSCALE_TOKEN_MAX_LEN = 256;
const TAG_KEY_MAX_LEN = 64;
const TAGS_MAX_LEN = 32;
const DESCRIPTION_MAX_LEN = 120;
// Tailscale tags are lowercased identifiers with optional colons
// (e.g. `tag:server`, `tag:guest-plex`). Reject whitespace, CR/LF,
// control chars, JSON metacharacters, and any character that could
// enable header-injection through the Tailscale coord client.
//
// DC-080 round-2 polish: Tailscale's tag spec requires `tag:` followed by
// ≥1 identifier char — bare `tag:` (empty name) is rejected by their API.
// We split the pattern in two so the error message names which form failed
// instead of dumping a generic regex.
const TAG_KEY_RE = /^tag:[a-z0-9][a-z0-9_-]{0,62}$/;
function _validateApiToken(token, fieldName = 'apiToken') {
if (typeof token !== 'string' || !token) {
return `${fieldName} is required and must be a string`;
}
if (!token.startsWith(TAILSCALE_TOKEN_PREFIX)) {
return `${fieldName} must start with ${TAILSCALE_TOKEN_PREFIX}`;
}
if (token.length > TAILSCALE_TOKEN_MAX_LEN) {
return `${fieldName} exceeds maximum length of ${TAILSCALE_TOKEN_MAX_LEN} characters`;
}
return null;
}
function _validateTags(tags) {
if (tags === undefined || tags === null) return null;
if (!Array.isArray(tags)) {
return 'tags must be an array of strings';
}
if (tags.length > TAGS_MAX_LEN) {
return `tags exceeds maximum length of ${TAGS_MAX_LEN} entries`;
}
for (let i = 0; i < tags.length; i += 1) {
const t = tags[i];
if (typeof t !== 'string' || !t) {
return `tags[${i}] must be a non-empty string`;
}
if (t.length > TAG_KEY_MAX_LEN) {
return `tags[${i}] exceeds maximum length of ${TAG_KEY_MAX_LEN} characters`;
}
if (!TAG_KEY_RE.test(t)) {
return `tags[${i}] must match ${TAG_KEY_RE} (lowercase alnum + :_-)`;
}
}
return null;
}
function _validateDescription(description) {
if (description === undefined || description === null) return null;
if (typeof description !== 'string') {
return 'description must be a string';
}
if (description.length > DESCRIPTION_MAX_LEN) {
return `description exceeds maximum length of ${DESCRIPTION_MAX_LEN} characters`;
}
return null;
}
// Exported for direct unit testing in __tests__/routes/tailscale-admin.test.js
// (the validator functions are otherwise unreachable from outside the factory
// closure; direct tests assert edge cases without supertest overhead).
const _validators = {
validateApiToken: _validateApiToken,
validateTags: _validateTags,
validateDescription: _validateDescription,
TAILSCALE_TOKEN_PREFIX,
TAILSCALE_TOKEN_MAX_LEN,
TAG_KEY_MAX_LEN,
TAGS_MAX_LEN,
DESCRIPTION_MAX_LEN,
TAG_KEY_RE,
};
module.exports = function({
tailscaleCoord,
asyncHandler,
@@ -75,9 +187,12 @@ module.exports = function({
router.put('/settings', asyncHandler(async (req, res) => {
const token = req.body && req.body.apiToken;
if (!token || typeof token !== 'string' || !token.startsWith('tskey-api-')) {
return errorResponse(res, 400, 'Invalid API token (must start with tskey-api-)');
}
// DC-080: validate prefix + length cap. The pre-fix code only checked
// the prefix — a 1 MB string starting with `tskey-api-` would have been
// sent to Tailscale's /devices endpoint and wasted server-side CPU
// before the inevitable 401.
const tokenErr = _validateApiToken(token);
if (tokenErr) return errorResponse(res, 400, tokenErr);
// Validate before storing
const client = new (require('../src/managers/tailscale-coord').TailscaleCoordClient)({ apiToken: token });
@@ -130,6 +245,17 @@ module.exports = function({
router.post('/settings/test', asyncHandler(async (req, res) => {
const token = (req.body && req.body.apiToken) || null;
// DC-080: validate any caller-provided token before it reaches the
// Tailscale API. Pre-fix the test endpoint accepted any string — the
// PUT route's prefix check did NOT extend to this path. An operator
// could submit arbitrary junk and the container would still call
// /devices on the Tailscale API with it (DoS-reflection + fingerprint
// timing for a future attacker probing whether this API token format
// is accepted at all).
if (token !== null && token !== undefined) {
const tokenErr = _validateApiToken(token);
if (tokenErr) return errorResponse(res, 400, tokenErr);
}
const client = await tailscaleCoord.getClient();
if (token) {
// Caller provided a fresh token to test — don't save it
@@ -214,10 +340,16 @@ module.exports = function({
return errorResponse(res, 503, 'Tailscale API token not configured');
}
const opts = req.body || {};
// Reject obviously-bad input early
if (opts.tags && !Array.isArray(opts.tags)) {
return errorResponse(res, 400, 'tags must be an array of strings');
}
// Reject obviously-bad input early.
// DC-080: pre-fix the route only checked `Array.isArray(opts.tags)`.
// A `tags: ['tag:guest', null, 123, {injection: true}]` payload would
// be forwarded to Tailscale verbatim — Tailscale's API is JSON-strict
// and would 400 the request, but the bad shape reached the wire and
// would silently pass through the dashboard's JSON.stringify() flow.
const tagsErr = _validateTags(opts.tags);
if (tagsErr) return errorResponse(res, 400, tagsErr);
const descErr = _validateDescription(opts.description);
if (descErr) return errorResponse(res, 400, descErr);
if (opts.expirySeconds !== undefined && (!Number.isInteger(opts.expirySeconds) || opts.expirySeconds <= 0)) {
return errorResponse(res, 400, 'expirySeconds must be a positive integer');
}
@@ -255,3 +387,9 @@ module.exports = function({
return router;
};
// DC-080: validators exported for direct unit testing in
// __tests__/routes/tailscale-admin.test.js — the route factory closes
// over the same functions, so the validators are exercised end-to-end via
// supertest AND in isolation here.
module.exports._validators = _validators;
+208 -105
View File
@@ -18,6 +18,30 @@ const UPDATE_CONFIG_FILE = process.env.UPDATE_CONFIG_FILE || path.join(platformP
const UPDATE_HISTORY_FILE = process.env.UPDATE_HISTORY_FILE || path.join(platformPaths.dataDir, 'update-history.json');
const CHECK_INTERVAL = parseInt(process.env.UPDATE_CHECK_INTERVAL || '3600000', 10); // 1 hour
// DC-078: registry probe reliability knobs. The container's /etc/resolv.conf points
// at Technitium (100.121.150.22) which sometimes returns a mix of A and AAAA
// records even when the host's IPv6 path to public registries (Docker Hub,
// ghcr.io) is broken or slow. Without `family: 4` Node defaults to dual-stack,
// every `https.request` to a registry races dual-stack DNS and stalls 30+ seconds
// per ENETUNREACH on the unreachable family. Without an explicit request timeout
// the entire `checkForUpdates()` loop (5+ containers) blocks for minutes per
// tick — visible in error.log as AggregateError [ETIMEDOUT] with a stack like
// `at internalConnectMultiple (node:net:1114:18)`.
//
// TUNABLES — keep conservative; the digest check is a background poll, not
// user-facing. Worst-case latency per query:
// 1st attempt: REGISTRY_REQUEST_TIMEOUT_MS (10s)
// 1st retry : REGISTRY_RETRY_BACKOFF_MS + REGISTRY_REQUEST_TIMEOUT_MS (10.5s)
// ─────────────────────────────────────────────────────────────────────
// per-container ceiling: 20.5s (REGISTRY_MAX_RETRIES=1)
const REGISTRY_REQUEST_TIMEOUT_MS = 10000; // hard per-request socket timeout
const REGISTRY_MAX_RETRIES = 1; // extra attempts after first failure
const REGISTRY_RETRY_BACKOFF_MS = 500; // delay before retry (transient blips)
const REGISTRY_TRANSIENT_ERROR_CODES = new Set([
'ETIMEDOUT', 'ENOTFOUND', 'ENETUNREACH', 'ECONNRESET', 'EAI_AGAIN',
'EPIPE', 'ECONNREFUSED', 'EHOSTUNREACH',
]);
class UpdateManager extends EventEmitter {
constructor() {
super();
@@ -181,87 +205,208 @@ class UpdateManager extends EventEmitter {
* Get image digest from GitHub Container Registry (ghcr.io)
* Public images are tokenless via the registry-1.docker.io-style bearer flow,
* but using ghcr.io's own auth endpoint.
*
* DC-078: hardened — `family: 4` to avoid the dual-stack DNS race when the
* host's IPv6 path is unreachable (was producing AggregateError [ETIMEDOUT] in
* error.log every check cycle). Hard request timeout caps each attempt.
*/
async getGhcrDigest(repository, tag) {
// ghcr.io uses the same OCI distribution spec as Docker Hub
const imageRepo = repository.replace(/^ghcr\.io\//, '');
const res = await this.fetchWithReliability({
hostname: 'ghcr.io',
path: `/v2/${imageRepo}/manifests/${tag}`,
headers: {
'Accept': 'application/vnd.docker.distribution.manifest.v2+json,application/vnd.docker.distribution.manifest.list.v2+json,application/vnd.oci.image.manifest.v1+json,application/vnd.oci.image.index.v1+json'
},
});
return res.headers['docker-content-digest'] || null;
}
/**
* Get image digest from Docker Hub
*
* DC-078: hardened — see getGhcrDigest comment. Resolves a 401 → token via
* `fetchAuthToken`, which itself is wrapped in the same retry + IPv4-only +
* timeout policy via `fetchWithReliability`.
*/
async getDockerHubDigest(repository, tag) {
// Normalize repository name
const repo = repository.includes('/') ? repository : `library/${repository}`;
const firstAttempt = await this.fetchWithReliability({
hostname: 'registry-1.docker.io',
path: `/v2/${repo}/manifests/${tag}`,
headers: {
'Accept': 'application/vnd.docker.distribution.manifest.v2+json'
},
});
if (firstAttempt.statusCode !== 401) {
if (firstAttempt.statusCode < 200 || firstAttempt.statusCode >= 300) {
throw new Error(`Docker Hub registry returned HTTP ${firstAttempt.statusCode}`);
}
return firstAttempt.headers['docker-content-digest'] || null;
}
// 401 → acquire a Bearer token via the WWW-Authenticate realm, then retry once.
const authHeader = firstAttempt.headers['www-authenticate'];
const authUrl = this.parseAuthHeader(authHeader);
if (!authUrl) {
throw new Error('Authentication required but no auth URL found');
}
const token = await this.fetchAuthToken(authUrl);
const authed = await this.fetchWithReliability({
hostname: 'registry-1.docker.io',
path: `/v2/${repo}/manifests/${tag}`,
headers: {
'Accept': 'application/vnd.docker.distribution.manifest.v2+json',
'Authorization': `Bearer ${token}`,
},
});
if (authed.statusCode < 200 || authed.statusCode >= 300) {
throw new Error(`Docker Hub registry returned HTTP ${authed.statusCode} after auth`);
}
return authed.headers['docker-content-digest'] || null;
}
/**
* Single hardened HTTPS probe — DC-078.
*
* Reliability properties:
* 1. `family: 4` — IPv4-only DNS lookup. Avoids dual-stack races where a
* single unreachable IPv6 destination consumes the default 30-second
* connect timeout before the IPv4 fallback succeeds (manifested in
* error.log as AggregateError [ETIMEDOUT] with `at internalConnectMultiple`).
* 2. Hard per-request timeout (REGISTRY_REQUEST_TIMEOUT_MS) — caps total
* latency for any single probe attempt.
* 3. Retry on transient network errors (REGISTRY_TRANSIENT_ERROR_CODES)
* with REGISTRY_RETRY_BACKOFF_MS delay between attempts. Does NOT
* retry on HTTP 4xx/5xx — those are real responses we should surface.
*
* Returns {statusCode, headers, body} so callers can read whichever response
* header or body bytes they need. For digest probes the body is drained and
* discarded; for auth-token fetches the JSON body is parsed.
*
* @param {object} opts
* @param {string} opts.hostname
* @param {string} opts.path
* @param {object} [opts.headers]
* @param {number} [opts.maxBodyBytes=65536] — protect against runaway bodies
*/
async fetchWithReliability(opts) {
const maxBodyBytes = opts.maxBodyBytes || 65536;
let attempt = 0;
while (attempt <= REGISTRY_MAX_RETRIES) {
try {
const result = await this._httpsRequestOnce({
hostname: opts.hostname,
path: opts.path,
headers: opts.headers || {},
maxBodyBytes,
});
return result;
} catch (error) {
// Drain retryable transient errors; non-transient (HTTP status) errors
// and code-less errors are surfaced directly to the caller.
if (!REGISTRY_TRANSIENT_ERROR_CODES.has(error && error.code)) {
throw error;
}
if (attempt >= REGISTRY_MAX_RETRIES) {
throw error;
}
attempt += 1;
// Brief backoff before retry to let transient blips settle.
await new Promise((resolve) => setTimeout(resolve, REGISTRY_RETRY_BACKOFF_MS));
}
}
// Defensive — should not reach here because the loop either throws or returns.
throw new Error('fetchWithReliability exhausted retries');
}
/**
* One-shot HTTPS request helper for fetchWithReliability — DC-078.
* Returns {statusCode, headers, body} on 2xx and most non-2xx responses
* (the caller decides what to do with non-2xx). Throws on transient
* network errors so the retry policy catches them.
*/
_httpsRequestOnce({ hostname, path: urlPath, headers, maxBodyBytes }) {
return new Promise((resolve, reject) => {
const options = {
hostname: 'ghcr.io',
path: `/v2/${imageRepo}/manifests/${tag}`,
hostname,
path: urlPath,
method: 'GET',
headers: {
'Accept': 'application/vnd.docker.distribution.manifest.v2+json,application/vnd.docker.distribution.manifest.list.v2+json,application/vnd.oci.image.manifest.v1+json,application/vnd.oci.image.index.v1+json'
}
family: 4, // DC-078: IPv4-only — see top-of-file comment
headers,
timeout: REGISTRY_REQUEST_TIMEOUT_MS, // DC-078: hard per-request cap
};
const req = https.request(options, (res) => {
if (res.statusCode === 401) {
const authHeader = res.headers['www-authenticate'];
const authUrl = this.parseAuthHeader(authHeader);
if (authUrl) {
// ghcr.io auth endpoint accepts scope=repository:owner/name:pull
this.authenticateAndGetDigest(authUrl, options).then(resolve).catch(reject);
} else {
reject(new Error('Authentication required but no auth URL found'));
let body = '';
let size = 0;
let aborted = false;
res.on('data', (chunk) => {
if (aborted) return;
size += chunk.length;
if (size > maxBodyBytes) {
aborted = true;
res.destroy();
const err = new Error(`response from ${hostname}${urlPath} exceeded ${maxBodyBytes} bytes`);
err.code = 'ERR_RESPONSE_TOO_LARGE';
reject(err);
return;
}
return;
}
if (res.statusCode !== 200) {
// Drain body to avoid socket leak
res.resume();
reject(new Error(`ghcr.io returned HTTP ${res.statusCode}`));
return;
}
const digest = res.headers['docker-content-digest'];
resolve(digest || null);
body += chunk;
});
res.on('end', () => {
if (aborted) return;
resolve({
statusCode: res.statusCode,
headers: res.headers,
body,
});
});
});
// Node 22 emits 'timeout' on the request, not the socket, when socket.setTimeout
// is hit — make it an explicit error so fetchWithReliability's retry policy catches it.
req.on('timeout', () => {
req.destroy(new Error('request timeout'));
const err = new Error(`registry request to ${hostname}${urlPath} timed out after ${REGISTRY_REQUEST_TIMEOUT_MS}ms`);
err.code = 'ETIMEDOUT';
reject(err);
});
req.on('error', (err) => {
// Tag errors missing .code so the retry policy recognizes transient ones.
if (!err.code && /timeout/i.test(err.message)) err.code = 'ETIMEDOUT';
reject(err);
});
req.on('error', reject);
req.end();
});
}
/**
* Get image digest from Docker Hub
* Fetch an auth token from a registry's WWW-Authenticate realm URL — DC-078.
* Uses fetchWithReliability for IPv4-only + timeout + retry. Parses the
* JSON body and returns the `token` or `access_token` field.
*/
async getDockerHubDigest(repository, tag) {
return new Promise((resolve, reject) => {
// Normalize repository name
const repo = repository.includes('/') ? repository : `library/${repository}`;
const options = {
hostname: 'registry-1.docker.io',
path: `/v2/${repo}/manifests/${tag}`,
method: 'GET',
headers: {
'Accept': 'application/vnd.docker.distribution.manifest.v2+json'
}
};
const req = https.request(options, (res) => {
if (res.statusCode === 401) {
// Need to authenticate
const authHeader = res.headers['www-authenticate'];
const authUrl = this.parseAuthHeader(authHeader);
if (authUrl) {
this.authenticateAndGetDigest(authUrl, options).then(resolve).catch(reject);
} else {
reject(new Error('Authentication required but no auth URL found'));
}
return;
}
const digest = res.headers['docker-content-digest'];
resolve(digest || null);
});
req.on('error', reject);
req.end();
async fetchAuthToken(authUrl) {
const url = new URL(authUrl);
const result = await this.fetchWithReliability({
hostname: url.hostname,
path: url.pathname + url.search,
maxBodyBytes: 16384, // auth tokens are <2 KB; cap to a small bound
});
if (result.statusCode !== 200) {
throw new Error(`auth token endpoint ${authUrl} returned HTTP ${result.statusCode}`);
}
let auth;
try {
auth = JSON.parse(result.body);
} catch (parseErr) {
// Surface a clean error — otherwise a malformed token response throws
// SyntaxError with the raw body snippet, which is hard to diagnose
// against the offending realm URL in a log line.
throw new Error(`auth token response from ${authUrl} was not valid JSON: ${parseErr.message}`);
}
const token = auth.token || auth.access_token;
if (!token) throw new Error(`No token in auth response from ${authUrl}`);
return token;
}
/**
@@ -283,48 +428,6 @@ class UpdateManager extends EventEmitter {
return url.toString();
}
/**
* Authenticate and get digest
*/
async authenticateAndGetDigest(authUrl, originalOptions) {
return new Promise((resolve, reject) => {
https.get(authUrl, (res) => {
let data = '';
res.on('data', chunk => data += chunk);
res.on('end', () => {
try {
const auth = JSON.parse(data);
const token = auth.token || auth.access_token;
if (!token) {
reject(new Error('No token in auth response'));
return;
}
// Retry original request with token
const options = {
...originalOptions,
headers: {
...originalOptions.headers,
'Authorization': `Bearer ${token}`
}
};
const req = https.request(options, (res) => {
const digest = res.headers['docker-content-digest'];
resolve(digest || null);
});
req.on('error', reject);
req.end();
} catch (error) {
reject(error);
}
});
}).on('error', reject);
});
}
/**
* Extract tag from image name
*/