roster-server 2.2.2 → 2.2.5

package/README.md

@@ -64,14 +64,15 @@ You can serve all subdomains of a domain with a single handler in three ways:
 
 Wildcard SSL certificates require **DNS-01** validation (Let's Encrypt does not support HTTP-01 for wildcards). By default Roster uses `acme-dns-01-cli` through an internal wrapper (adds `propagationDelay` and modern plugin signatures).
 
-For fully automatic TXT records with Linode/Akamai DNS Manager, set:
+For fully automatic TXT records with Linode DNS, set:
 
 ```bash
 export ROSTER_DNS_PROVIDER=linode
-export LINODE_API_KEY=... # or LINODE_TOKEN / AKAMAI_API_KEY
+export LINODE_API_KEY=...
 ```
 
 Then Roster creates/removes `_acme-challenge` TXT records automatically via `api.linode.com`.
+If `LINODE_API_KEY` is present, this mode auto-enables by default for wildcard DNS-01.
 
 Override with a custom plugin:
 
@@ -221,7 +222,7 @@ When creating a new `RosterServer` instance, you can pass the following options:
 - `email` (string): Your email for Let's Encrypt notifications.
 - `wwwPath` (string): Path to your `www` directory containing your sites.
 - `greenlockStorePath` (string): Directory for Greenlock configuration.
-- `dnsChallenge` (object|false): Optional override for wildcard DNS-01 challenge config. Default is `acme-dns-01-cli` wrapper with `propagationDelay: 120000`, `autoContinue: false`, and `dryRunDelay: 120000`. Manual mode still works, but you can enable automatic DNS API mode for Linode/Akamai by setting `ROSTER_DNS_PROVIDER=linode` (or `akamai`) and `LINODE_API_KEY` (aliases: `LINODE_TOKEN`, `AKAMAI_API_KEY`). In automatic mode, Roster creates/removes TXT records itself and still polls public resolvers every 15s before continuing. Set `false` to disable DNS challenge. You can pass `{ module: '...', propagationDelay: 180000 }` to tune DNS wait time (ms). For Greenlock dry-runs (`_greenlock-dryrun-*`), delay defaults to `dryRunDelay` (same as `propagationDelay` unless overridden with `dnsChallenge.dryRunDelay` or env `ROSTER_DNS_DRYRUN_DELAY_MS`). When wildcard sites are present, Roster creates a separate wildcard certificate (`*.example.com`) that uses `dns-01`, while apex/www stay on the regular certificate flow (typically `http-01`), reducing manual TXT records.
+- `dnsChallenge` (object|false): Optional override for wildcard DNS-01 challenge config. Default is `acme-dns-01-cli` wrapper with `propagationDelay: 120000`, `autoContinue: false`, and `dryRunDelay: 120000`. Manual mode still works, but you can enable automatic Linode DNS API mode by setting `ROSTER_DNS_PROVIDER=linode` and `LINODE_API_KEY`. In automatic mode, Roster creates/removes TXT records itself and still polls public resolvers every 15s before continuing. Set `false` to disable DNS challenge. You can pass `{ module: '...', propagationDelay: 180000 }` to tune DNS wait time (ms). For Greenlock dry-runs (`_greenlock-dryrun-*`), delay defaults to `dryRunDelay` (same as `propagationDelay` unless overridden with `dnsChallenge.dryRunDelay` or env `ROSTER_DNS_DRYRUN_DELAY_MS`). When wildcard sites are present, Roster creates a separate wildcard certificate (`*.example.com`) that uses `dns-01`, while apex/www stay on the regular certificate flow (typically `http-01`), reducing manual TXT records.
 - `staging` (boolean): Set to `true` to use Let's Encrypt's staging environment (for testing).
 - `local` (boolean): Set to `true` to run in local development mode.
 - `minLocalPort` (number): Minimum port for local mode (default: 4000).

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "roster-server",
-    "version": "2.2.2",
+    "version": "2.2.5",
     "description": "👾 RosterServer - A domain host router to host multiple HTTPS.",
     "main": "index.js",
     "scripts": {

package/test/acme-dns-01-cli-wrapper.test.js

@@ -16,28 +16,28 @@ function buildChallengeOpts() {
 
 describe('acme-dns-01-cli-wrapper automatic Linode DNS', () => {
     const originalFetch = global.fetch;
-    const originalAkamaiApiKey = process.env.AKAMAI_API_KEY;
+    const originalLinodeApiKey = process.env.LINODE_API_KEY;
 
     afterEach(() => {
         global.fetch = originalFetch;
-        if (originalAkamaiApiKey === undefined) delete process.env.AKAMAI_API_KEY;
-        else process.env.AKAMAI_API_KEY = originalAkamaiApiKey;
+        if (originalLinodeApiKey === undefined) delete process.env.LINODE_API_KEY;
+        else process.env.LINODE_API_KEY = originalLinodeApiKey;
     });
 
     it('creates and removes TXT records via Linode API', async () => {
         const calls = [];
         global.fetch = async (url, options = {}) => {
             calls.push({ url, options });
-            if (url.endsWith('/domains/example.com')) {
-                return { ok: true, status: 200, json: async () => ({}) };
+            if (url.endsWith('/domains?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [{ id: 42, domain: 'example.com' }] }) };
             }
-            if (url.endsWith('/domains/example.com/records?page_size=500')) {
+            if (url.endsWith('/domains/42/records?page_size=500')) {
                 return { ok: true, status: 200, json: async () => ({ data: [] }) };
             }
-            if (url.endsWith('/domains/example.com/records') && options.method === 'POST') {
+            if (url.endsWith('/domains/42/records') && options.method === 'POST') {
                 return { ok: true, status: 200, json: async () => ({ id: 321 }) };
             }
-            if (url.endsWith('/domains/example.com/records/321') && options.method === 'DELETE') {
+            if (url.endsWith('/domains/42/records/321') && options.method === 'DELETE') {
                 return { ok: true, status: 204, json: async () => ({}) };
             }
             return { ok: false, status: 404, statusText: 'not mocked', text: async () => 'not mocked' };
@@ -55,26 +55,26 @@ describe('acme-dns-01-cli-wrapper automatic Linode DNS', () => {
         await challenger.set(opts);
         await challenger.remove(opts);
 
-        assert.ok(calls.some((c) => c.url.endsWith('/domains/example.com/records') && c.options.method === 'POST'));
-        assert.ok(calls.some((c) => c.url.endsWith('/domains/example.com/records/321') && c.options.method === 'DELETE'));
+        assert.ok(calls.some((c) => c.url.endsWith('/domains/42/records') && c.options.method === 'POST'));
+        assert.ok(calls.some((c) => c.url.endsWith('/domains/42/records/321') && c.options.method === 'DELETE'));
     });
 
-    it('accepts AKAMAI_API_KEY as Linode token alias', async () => {
-        process.env.AKAMAI_API_KEY = 'fake-ak-key';
+    it('uses LINODE_API_KEY from environment', async () => {
+        process.env.LINODE_API_KEY = 'fake-linode-key';
         const calls = [];
         global.fetch = async (url, options = {}) => {
             calls.push({ url, options });
-            if (url.endsWith('/domains/example.com')) {
-                return { ok: true, status: 200, json: async () => ({}) };
+            if (url.endsWith('/domains?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [{ id: 42, domain: 'example.com' }] }) };
             }
-            if (url.endsWith('/domains/example.com/records?page_size=500')) {
+            if (url.endsWith('/domains/42/records?page_size=500')) {
                 return { ok: true, status: 200, json: async () => ({ data: [{ id: 111, type: 'TXT', name: '_acme-challenge', target: 'test-token' }] }) };
             }
             return { ok: true, status: 204, json: async () => ({}) };
         };
 
         const challenger = wrapper.create({
-            provider: 'akamai',
+            provider: 'linode',
             verifyDnsBeforeContinue: false,
             propagationDelay: 0,
             dryRunDelay: 0
@@ -85,4 +85,166 @@ describe('acme-dns-01-cli-wrapper automatic Linode DNS', () => {
         const authHeader = calls[0].options?.headers?.Authorization || '';
         assert.ok(authHeader.startsWith('Bearer '));
     });
+
+    it('falls back to parent zone when exact zone does not exist', async () => {
+        const calls = [];
+        global.fetch = async (url, options = {}) => {
+            calls.push({ url, options });
+            if (url.endsWith('/domains?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [{ id: 99, domain: 'example.com' }] }) };
+            }
+            if (url.endsWith('/domains/99/records?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [] }) };
+            }
+            if (url.endsWith('/domains/99/records') && options.method === 'POST') {
+                return { ok: true, status: 200, json: async () => ({ id: 654 }) };
+            }
+            if (url.endsWith('/domains/99/records/654') && options.method === 'DELETE') {
+                return { ok: true, status: 204, json: async () => ({}) };
+            }
+            return { ok: false, status: 404, statusText: 'not mocked', text: async () => 'not mocked' };
+        };
+
+        const challenger = wrapper.create({
+            provider: 'linode',
+            linodeApiKey: 'fake-token',
+            verifyDnsBeforeContinue: false,
+            propagationDelay: 0,
+            dryRunDelay: 0
+        });
+
+        const opts = {
+            challenge: {
+                altname: '*.sub.example.com',
+                dnsHost: '_acme-challenge.sub.example.com',
+                dnsAuthorization: 'fallback-token'
+            }
+        };
+
+        await challenger.set(opts);
+        await challenger.remove(opts);
+
+        const postCall = calls.find((c) => c.url.endsWith('/domains/99/records') && c.options.method === 'POST');
+        assert.ok(postCall, 'expected TXT create call on parent zone');
+        const payload = JSON.parse(postCall.options.body);
+        assert.strictEqual(payload.name, '_acme-challenge.sub');
+    });
+
+    it('falls back to manual when provider mode has no API key (default)', async () => {
+        const prevLinode = process.env.LINODE_API_KEY;
+        delete process.env.LINODE_API_KEY;
+        global.fetch = async () => ({ ok: true, status: 200, json: async () => ({}) });
+
+        try {
+            const challenger = wrapper.create({
+                provider: 'linode',
+                verifyDnsBeforeContinue: false,
+                propagationDelay: 0,
+                dryRunDelay: 0
+            });
+            await challenger.set(buildChallengeOpts());
+        } finally {
+            if (prevLinode === undefined) delete process.env.LINODE_API_KEY;
+            else process.env.LINODE_API_KEY = prevLinode;
+        }
+    });
+
+    it('throws when provider mode has no API key and strict mode is enabled', async () => {
+        const prevLinode = process.env.LINODE_API_KEY;
+        delete process.env.LINODE_API_KEY;
+        global.fetch = async () => ({ ok: true, status: 200, json: async () => ({}) });
+
+        try {
+            const challenger = wrapper.create({
+                provider: 'linode',
+                dnsApiFallbackToManual: false,
+                verifyDnsBeforeContinue: false,
+                propagationDelay: 0,
+                dryRunDelay: 0
+            });
+            await assert.rejects(
+                challenger.set(buildChallengeOpts()),
+                /Linode API key not configured/
+            );
+        } finally {
+            if (prevLinode === undefined) delete process.env.LINODE_API_KEY;
+            else process.env.LINODE_API_KEY = prevLinode;
+        }
+    });
+
+    it('uses configured TXT TTL when creating Linode records', async () => {
+        const calls = [];
+        global.fetch = async (url, options = {}) => {
+            calls.push({ url, options });
+            if (url.endsWith('/domains?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [{ id: 42, domain: 'example.com' }] }) };
+            }
+            if (url.endsWith('/domains/42/records?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [] }) };
+            }
+            if (url.endsWith('/domains/42/records') && options.method === 'POST') {
+                return { ok: true, status: 200, json: async () => ({ id: 222 }) };
+            }
+            return { ok: true, status: 204, json: async () => ({}) };
+        };
+
+        const challenger = wrapper.create({
+            provider: 'linode',
+            linodeApiKey: 'fake-token',
+            txtRecordTtl: 300,
+            verifyDnsBeforeContinue: false,
+            propagationDelay: 0,
+            dryRunDelay: 0
+        });
+
+        await challenger.set(buildChallengeOpts());
+        const postCall = calls.find((c) => c.url.endsWith('/domains/42/records') && c.options.method === 'POST');
+        assert.ok(postCall, 'expected TXT create call');
+        const payload = JSON.parse(postCall.options.body);
+        assert.strictEqual(payload.ttl_sec, 300);
+    });
+
+    it('auto-enables Linode provider when API key is present', async () => {
+        process.env.LINODE_API_KEY = 'fake-token';
+        const calls = [];
+        global.fetch = async (url, options = {}) => {
+            calls.push({ url, options });
+            if (url.endsWith('/domains?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [{ id: 42, domain: 'example.com' }] }) };
+            }
+            if (url.endsWith('/domains/42/records?page_size=500')) {
+                return { ok: true, status: 200, json: async () => ({ data: [{ id: 111, type: 'TXT', name: '_acme-challenge', target: 'test-token' }] }) };
+            }
+            return { ok: true, status: 204, json: async () => ({}) };
+        };
+
+        const challenger = wrapper.create({
+            verifyDnsBeforeContinue: false,
+            propagationDelay: 0,
+            dryRunDelay: 0
+        });
+
+        await challenger.set(buildChallengeOpts());
+        assert.ok(calls.length >= 2);
+    });
+
+    it('falls back to manual flow when Linode API fails', async () => {
+        let fetchCalls = 0;
+        global.fetch = async () => {
+            fetchCalls += 1;
+            return { ok: false, status: 404, statusText: 'Not Found', text: async () => 'not found' };
+        };
+
+        const challenger = wrapper.create({
+            provider: 'linode',
+            linodeApiKey: 'fake-token',
+            dnsApiFallbackToManual: true,
+            verifyDnsBeforeContinue: false,
+            propagationDelay: 0,
+            dryRunDelay: 0
+        });
+
+        await challenger.set(buildChallengeOpts());
+        assert.ok(fetchCalls > 0);
+    });
 });

package/vendor/acme-dns-01-cli-wrapper.js

@@ -3,6 +3,19 @@
 const legacyCli = require('acme-dns-01-cli');
 const log = require('lemonlog')('acme-dns-01');
 const dns = require('node:dns').promises;
+let envFileLoadAttempted = false;
+
+function loadEnvFileSafely() {
+    if (envFileLoadAttempted) return;
+    envFileLoadAttempted = true;
+    try {
+        if (typeof process.loadEnvFile === 'function') {
+            process.loadEnvFile();
+        }
+    } catch {
+        // Ignore missing .env or unsupported runtime behavior.
+    }
+}
 
 function toPromise(fn, context) {
     if (typeof fn !== 'function') {
@@ -41,6 +54,7 @@ function toPromise(fn, context) {
 }
 
 module.exports.create = function create(config = {}) {
+    loadEnvFileSafely();
     const challenger = legacyCli.create(config);
     const propagationDelay = Number.isFinite(config.propagationDelay)
         ? config.propagationDelay
@@ -110,13 +124,14 @@ module.exports.create = function create(config = {}) {
     const configuredProvider = normalizeProvider(
         config.provider
         || process.env.ROSTER_DNS_PROVIDER
-        || (config.linodeApiKey || process.env.LINODE_API_KEY || process.env.LINODE_TOKEN || process.env.AKAMAI_API_KEY ? 'linode' : '')
+        || (config.linodeApiKey || process.env.LINODE_API_KEY ? 'linode' : '')
     );
-    const isLinodeProvider = ['linode', 'akamai', 'linode-akamai', 'akamai-linode'].includes(configuredProvider);
+    const isLinodeProvider = configuredProvider === 'linode';
+    const dnsApiFallbackToManual = config.dnsApiFallbackToManual !== undefined
+        ? parseBool(config.dnsApiFallbackToManual, true)
+        : parseBool(process.env.ROSTER_DNS_API_FALLBACK_TO_MANUAL, true);
     const linodeApiKey = config.linodeApiKey
         || process.env.LINODE_API_KEY
-        || process.env.LINODE_TOKEN
-        || process.env.AKAMAI_API_KEY
         || '';
     const linodeApiBase = String(config.linodeApiBase || process.env.LINODE_API_BASE_URL || 'https://api.linode.com/v4').replace(/\/+$/, '');
     const txtRecordTtl = Number.isFinite(config.txtRecordTtl) ? Math.max(30, Number(config.txtRecordTtl)) : 60;
@@ -184,6 +199,7 @@ module.exports.create = function create(config = {}) {
     const presentedByHost = new Map();
     const presentedByAltname = new Map();
     const linodeTxtRecordsByHost = new Map();
+    const linodeZoneCache = new Map();
 
     function buildZoneCandidates({ dnsHost, altname }) {
         const candidates = new Set();
@@ -218,7 +234,7 @@ module.exports.create = function create(config = {}) {
     async function linodeRequest(pathname, method = 'GET', body) {
         const apiKey = String(linodeApiKey || '').trim();
         if (!apiKey) {
-            throw new Error('Linode API key not configured. Set LINODE_API_KEY (or LINODE_TOKEN/AKAMAI_API_KEY).');
+            throw new Error('Linode API key not configured. Set LINODE_API_KEY.');
         }
         if (typeof fetch !== 'function') {
             throw new Error('Global fetch is unavailable in this runtime; cannot call Linode DNS API.');
@@ -245,22 +261,40 @@ module.exports.create = function create(config = {}) {
         return response.json();
     }
 
+    async function resolveLinodeZone(zone) {
+        const normalizedZone = String(zone || '').trim().toLowerCase();
+        if (!normalizedZone) return null;
+        if (linodeZoneCache.has(normalizedZone)) return linodeZoneCache.get(normalizedZone);
+
+        const domainsResult = await linodeRequest('/domains?page_size=500', 'GET');
+        const domains = Array.isArray(domainsResult?.data) ? domainsResult.data : [];
+        const matched = domains.find((entry) => String(entry?.domain || '').trim().toLowerCase() === normalizedZone);
+        if (!matched?.id) return null;
+
+        const zoneInfo = { id: matched.id, domain: String(matched.domain || normalizedZone) };
+        linodeZoneCache.set(normalizedZone, zoneInfo);
+        return zoneInfo;
+    }
+
     async function linodeUpsertTxtRecord(dnsHost, dnsAuthorization, altname) {
         const zoneCandidates = buildZoneCandidates({ dnsHost, altname });
         let lastError = null;
 
         for (const zone of zoneCandidates) {
+            let zoneInfo = null;
             try {
-                await linodeRequest(`/domains/${encodeURIComponent(zone)}`, 'GET');
+                zoneInfo = await resolveLinodeZone(zone);
             } catch (error) {
                 lastError = error;
                 continue;
             }
+            if (!zoneInfo?.id) continue;
 
             const recordName = linodeRecordNameForHost(dnsHost, zone);
             if (!recordName && dnsHost !== zone) continue;
 
-            const recordsResult = await linodeRequest(`/domains/${encodeURIComponent(zone)}/records?page_size=500`, 'GET');
+            const zoneId = zoneInfo.id;
+            const recordsResult = await linodeRequest(`/domains/${zoneId}/records?page_size=500`, 'GET');
             const existing = Array.isArray(recordsResult?.data) ? recordsResult.data : [];
             const sameRecord = existing.find((record) =>
                 record?.type === 'TXT'
@@ -269,11 +303,11 @@ module.exports.create = function create(config = {}) {
             );
 
             if (sameRecord && sameRecord.id) {
-                linodeTxtRecordsByHost.set(dnsHost, { zone, id: sameRecord.id });
-                return { zone, id: sameRecord.id, reused: true };
+                linodeTxtRecordsByHost.set(dnsHost, { zone, zoneId, id: sameRecord.id });
+                return { zone, zoneId, id: sameRecord.id, reused: true };
             }
 
-            const created = await linodeRequest(`/domains/${encodeURIComponent(zone)}/records`, 'POST', {
+            const created = await linodeRequest(`/domains/${zoneId}/records`, 'POST', {
                 type: 'TXT',
                 name: recordName,
                 target: dnsAuthorization,
@@ -281,8 +315,8 @@ module.exports.create = function create(config = {}) {
             });
 
             if (created?.id) {
-                linodeTxtRecordsByHost.set(dnsHost, { zone, id: created.id });
-                return { zone, id: created.id, reused: false };
+                linodeTxtRecordsByHost.set(dnsHost, { zone, zoneId, id: created.id });
+                return { zone, zoneId, id: created.id, reused: false };
             }
         }
 
@@ -292,9 +326,10 @@ module.exports.create = function create(config = {}) {
 
     async function linodeRemoveTxtRecord(dnsHost) {
         const stored = linodeTxtRecordsByHost.get(dnsHost);
-        if (!stored?.zone || !stored?.id) return;
-        await linodeRequest(`/domains/${encodeURIComponent(stored.zone)}/records/${stored.id}`, 'DELETE');
+        if (!stored?.zoneId || !stored?.id) return false;
+        await linodeRequest(`/domains/${stored.zoneId}/records/${stored.id}`, 'DELETE');
         linodeTxtRecordsByHost.delete(dnsHost);
+        return true;
     }
 
     async function setChallenge(opts) {
@@ -319,8 +354,16 @@ module.exports.create = function create(config = {}) {
                     (result?.zone ? ` (zone ${result.zone})` : '')
                 );
             } catch (error) {
-                log.error(`Failed to create Linode DNS TXT for ${dnsHost}: ${error?.message || error}`);
-                throw error;
+                const errorMsg = error?.message || error;
+                if (dnsApiFallbackToManual) {
+                    log.warn(
+                        `Linode DNS API failed for ${dnsHost}: ${errorMsg}. ` +
+                        'Falling back to manual/legacy DNS flow for this challenge.'
+                    );
+                } else {
+                    log.error(`Failed to create Linode DNS TXT for ${dnsHost}: ${errorMsg}`);
+                    throw error;
+                }
             }
         }
         const isDryRunChallenge = dnsHost.includes('_greenlock-dryrun-');
@@ -404,8 +447,10 @@ module.exports.create = function create(config = {}) {
 
         if (isLinodeProvider && dnsHost) {
             try {
-                await linodeRemoveTxtRecord(dnsHost);
-                log.info(`Linode DNS TXT removed for ${dnsHost}`);
+                const removed = await linodeRemoveTxtRecord(dnsHost);
+                if (removed) {
+                    log.info(`Linode DNS TXT removed for ${dnsHost}`);
+                }
                 return null;
             } catch (error) {
                 log.warn(`Failed to remove Linode DNS TXT for ${dnsHost}: ${error?.message || error}`);