Isolate internal bot-config route from the public listener (#33)
The GET /internal/bot-config route returns the DECRYPTED Discord bot token and was mounted on the same Express app / port 3000 that Pangolin proxies publicly. Its only guard was the BOT_INTERNAL_KEY shared secret, and .env.example shipped a placeholder default — so a forwarded path or a weak/unrotated key would expose the plaintext token to the internet. Move server<->bot internal traffic onto its own listener and fail fast on a weak key: - Add server/src/internalApp.js: a standalone Express app mounting requireInternalKey + /internal (and a no-secret /health), mirroring the bot's unpublished port-4100 pattern. - server.js starts a second listener on INTERNAL_PORT (default 3001), closed on graceful shutdown. - Remove the /internal mount from the public v1.router; the public app now 404s /api/v1/internal/bot-config even with a valid key. - Fail fast: new utils/botInternalKey.js rejects an empty, placeholder, or <16-char BOT_INTERNAL_KEY — fatal in production (exit 1), warning in dev. - docker-compose: bot SITE_INTERNAL_URL -> app:3001/internal/bot-config; document that INTERNAL_PORT stays unpublished. - .env.example (root/server/bot): document INTERNAL_PORT, the fail-fast behavior, and a defense-in-depth Pangolin deny rule for /api/v1/internal. Tests: add requireInternalKey.test.js and botInternalKey.test.js (node --test: 93 pass). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019rao86n5cXpwAyjdBFEshV
This commit is contained in:
43
server/src/utils/botInternalKey.js
Normal file
43
server/src/utils/botInternalKey.js
Normal file
@@ -0,0 +1,43 @@
|
||||
// Boot-time validation of BOT_INTERNAL_KEY — the shared secret that is the ONLY
|
||||
// auth on the server<->bot /internal/* routes (which return the decrypted Discord
|
||||
// bot token). A missing, placeholder, or trivially short key would leave that
|
||||
// endpoint effectively unguarded, so in production we refuse to start; in dev we
|
||||
// warn but continue so local work isn't blocked. See issue #33.
|
||||
|
||||
// The placeholders shipped in the repo's .env.example files. If any of these
|
||||
// reaches production it means the operator never generated a real key.
|
||||
const PLACEHOLDERS = new Set([
|
||||
'change-me-to-a-long-random-string', // root .env.example
|
||||
'dev-only-change-me-bot-key', // server/.env.example, bot/.env.example
|
||||
])
|
||||
|
||||
const MIN_LENGTH = 16
|
||||
|
||||
// Returns { ok, fatal, message }. `fatal` is only ever true in production —
|
||||
// callers should exit non-zero on fatal, and log a warning (but continue) when
|
||||
// !ok && !fatal.
|
||||
function evaluateBotInternalKey({ key, nodeEnv } = {}) {
|
||||
const value = key || ''
|
||||
|
||||
let reason = null
|
||||
if (value.length === 0) reason = 'BOT_INTERNAL_KEY is not set'
|
||||
else if (PLACEHOLDERS.has(value)) reason = 'BOT_INTERNAL_KEY is still the documented placeholder value'
|
||||
else if (value.length < MIN_LENGTH) reason = `BOT_INTERNAL_KEY is too short (< ${MIN_LENGTH} chars)`
|
||||
|
||||
if (!reason) return { ok: true, fatal: false, message: null }
|
||||
|
||||
const production = nodeEnv === 'production'
|
||||
const detail =
|
||||
`${reason}. It is the only guard on /internal/bot-config, which returns the ` +
|
||||
'decrypted Discord bot token.'
|
||||
|
||||
return {
|
||||
ok: false,
|
||||
fatal: production,
|
||||
message: production
|
||||
? `${detail} Refusing to start in production — set a long random BOT_INTERNAL_KEY (matching bot/.env).`
|
||||
: `${detail} Continuing because NODE_ENV is not "production" — set a strong value before deploying.`,
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { evaluateBotInternalKey, PLACEHOLDERS, MIN_LENGTH }
|
||||
Reference in New Issue
Block a user