spec-3nweb-server 1.6.3 → 1.7.0

package/build/{run-config.js → config/from-env.js}

@@ -16,12 +16,10 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addSingleUserSignup = exports.getBindParamsFromEnv = exports.getConfsFromEnv = void 0;
-const async_fs_node_1 = require("./lib-common/async-fs-node");
+exports.getBindParamsFromEnv = exports.getConfsFromEnv = void 0;
+const async_fs_node_1 = require("../lib-common/async-fs-node");
 const path_1 = require("path");
 const fs_1 = require("fs");
-const signup_tokens_1 = require("./admin/signup-tokens");
-const server_data_folders_1 = require("./lib-server/resources/server-data-folders");
 const DOMAIN_VAR = 'W3N_DOMAIN';
 const DATA_DIR_VAR = 'W3N_DATA_DIR';
 const NO_TOKENS_FILE = 'NO_TOKENS_FILE';
@@ -116,31 +114,4 @@ function getTLSParamsFromEnv() {
         throw new Error(`Both ${TLS_CERT_VAR} and ${TLS_KEY_VAR} environment parameters should be present, but one is missing.`);
     }
 }
-async function addSingleUserSignup(rootFolder, userId) {
-    const token = await (0, signup_tokens_1.generateToken)();
-    const ctx = (0, signup_tokens_1.makeSingleUserSignupCtx)(token, userId);
-    const fPath = (0, signup_tokens_1.tokenPath)(rootFolder, token);
-    try {
-        await (0, async_fs_node_1.writeFile)(fPath, JSON.stringify(ctx), { encoding: 'utf8', flag: 'wx' });
-        return token;
-    }
-    catch (exc) {
-        if (exc.alreadyExists) {
-            return addSingleUserSignup(rootFolder, userId);
-        }
-        else if (exc.notFound) {
-            await (0, async_fs_node_1.mkdir)((0, server_data_folders_1.tokensInRootFolder)(rootFolder))
-                .catch((exc) => {
-                if (!exc.alreadyExists) {
-                    throw exc;
-                }
-            });
-            return addSingleUserSignup(rootFolder, userId);
-        }
-        else {
-            throw exc;
-        }
-    }
-}
-exports.addSingleUserSignup = addSingleUserSignup;
 Object.freeze(exports);

package/build/config/from-yaml.d.ts

@@ -0,0 +1,2 @@
+import { Configurations } from '../services';
+export declare function readYamlConfFile(path: string): Configurations;

package/build/config/from-yaml.js

@@ -0,0 +1,28 @@
+"use strict";
+/*
+ Copyright (C) 2023 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readYamlConfFile = void 0;
+const fs_1 = require("fs");
+const yaml = require("js-yaml");
+function readYamlConfFile(path) {
+    const txt = (0, fs_1.readFileSync)(path, 'utf8');
+    const conf = yaml.load(txt);
+    return conf;
+}
+exports.readYamlConfFile = readYamlConfFile;
+Object.freeze(exports);

package/build/config/letsencrypt.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { ServerOptions } from "https";
+export declare type CertsUpdateListener = (newOpts: ServerOptions, originalOpts: ServerOptions) => Promise<void>;
+export declare function sslOptsFromConfig(letsencrypt: string | undefined, sslOpts: ServerOptions | undefined, skipReloadOnCertsChange: boolean | undefined): {
+    sslOpts: ServerOptions;
+    onCertsUpdate?: (listener: CertsUpdateListener) => (() => void);
+} | undefined;

package/build/config/letsencrypt.js

@@ -0,0 +1,62 @@
+"use strict";
+/*
+ Copyright (C) 2023 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sslOptsFromConfig = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+function sslOptsFromConfig(letsencrypt, sslOpts, skipReloadOnCertsChange) {
+    if (!sslOpts) {
+        sslOpts = {};
+    }
+    if (letsencrypt) {
+        sslOpts.cert = (0, fs_1.readFileSync)((0, path_1.join)(letsencrypt, 'fullchain.pem'));
+        sslOpts.key = (0, fs_1.readFileSync)((0, path_1.join)(letsencrypt, 'privkey.pem'));
+        if (skipReloadOnCertsChange) {
+            return { sslOpts };
+        }
+        const onCertsUpdate = makeCertsUpdatesWatch();
+        return { sslOpts, onCertsUpdate };
+    }
+    else if (sslOpts.cert && sslOpts.key) {
+        sslOpts.cert = (0, fs_1.readFileSync)(sslOpts.cert);
+        sslOpts.key = (0, fs_1.readFileSync)(sslOpts.key);
+        if (skipReloadOnCertsChange) {
+            return { sslOpts };
+        }
+        const onCertsUpdate = makeCertsUpdatesWatch();
+        return { sslOpts, onCertsUpdate };
+    }
+    else if ((!sslOpts.cert && sslOpts.key)
+        || (sslOpts.cert && !sslOpts.key)) {
+        throw new Error(`servicesConnect.sslOpts section must have both key and cert fields pointing to respective files.`);
+    }
+    else {
+        return;
+    }
+}
+exports.sslOptsFromConfig = sslOptsFromConfig;
+function makeCertsUpdatesWatch(
+// XXX pass locations, or some fs watching object
+) {
+    return listener => {
+        // XXX start watching a signal
+        const stopWatching = () => { };
+        return stopWatching;
+    };
+}
+Object.freeze(exports);

package/build/config/signup.d.ts

@@ -0,0 +1,15 @@
+import { MultiDomainSignupCtx, SingleUserSignupCtx } from "../admin/signup-tokens";
+export declare function addSingleUserSignup(rootFolder: string, userId: string): Promise<string>;
+export declare function addMultiDomainSignup(rootFolder: string, domains: string[]): Promise<string>;
+export declare function readNoTokensFile(noTokenFile: string): Promise<MultiDomainSignupCtx>;
+export declare function readTokenFile(rootFolder: string, tokenId: string): Promise<SingleUserSignupCtx | MultiDomainSignupCtx | undefined>;
+export declare function readAllSignupTokens(rootFolder: string): Promise<{
+    singleUserTokens: {
+        tokenId: string;
+        ctx: SingleUserSignupCtx;
+    }[];
+    multiUserTokens: {
+        tokenId: string;
+        ctx: MultiDomainSignupCtx;
+    }[];
+}>;

package/build/config/signup.js

@@ -0,0 +1,132 @@
+"use strict";
+/*
+ Copyright (C) 2019 - 2020 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readAllSignupTokens = exports.readTokenFile = exports.readNoTokensFile = exports.addMultiDomainSignup = exports.addSingleUserSignup = void 0;
+const async_fs_node_1 = require("../lib-common/async-fs-node");
+const signup_tokens_1 = require("../admin/signup-tokens");
+const server_data_folders_1 = require("../lib-server/resources/server-data-folders");
+const error_1 = require("../lib-common/exceptions/error");
+const path_1 = require("path");
+async function addSingleUserSignup(rootFolder, userId) {
+    const token = await (0, signup_tokens_1.generateToken)();
+    const ctx = (0, signup_tokens_1.makeSingleUserSignupCtx)(token, userId);
+    const fPath = (0, signup_tokens_1.tokenPath)(rootFolder, token);
+    try {
+        await (0, async_fs_node_1.writeFile)(fPath, JSON.stringify(ctx), { encoding: 'utf8', flag: 'wx' });
+        return token;
+    }
+    catch (exc) {
+        if (exc.alreadyExists) {
+            return addSingleUserSignup(rootFolder, userId);
+        }
+        else if (exc.notFound) {
+            await (0, async_fs_node_1.mkdir)((0, server_data_folders_1.tokensInRootFolder)(rootFolder))
+                .catch((exc) => {
+                if (!exc.alreadyExists) {
+                    throw exc;
+                }
+            });
+            return addSingleUserSignup(rootFolder, userId);
+        }
+        else {
+            throw exc;
+        }
+    }
+}
+exports.addSingleUserSignup = addSingleUserSignup;
+async function addMultiDomainSignup(rootFolder, domains) {
+    const token = await (0, signup_tokens_1.generateToken)();
+    const ctx = (0, signup_tokens_1.makeMultiDomainSignupCtx)(domains, token);
+    const fPath = (0, signup_tokens_1.tokenPath)(rootFolder, token);
+    try {
+        await (0, async_fs_node_1.writeFile)(fPath, JSON.stringify(ctx), { encoding: 'utf8', flag: 'wx' });
+        return token;
+    }
+    catch (exc) {
+        if (exc.alreadyExists) {
+            return addMultiDomainSignup(rootFolder, domains);
+        }
+        else if (exc.notFound) {
+            await (0, async_fs_node_1.mkdir)((0, server_data_folders_1.tokensInRootFolder)(rootFolder))
+                .catch((exc) => {
+                if (!exc.alreadyExists) {
+                    throw exc;
+                }
+            });
+            return addMultiDomainSignup(rootFolder, domains);
+        }
+        else {
+            throw exc;
+        }
+    }
+}
+exports.addMultiDomainSignup = addMultiDomainSignup;
+async function readNoTokensFile(noTokenFile) {
+    try {
+        const str = await (0, async_fs_node_1.readFile)(noTokenFile, { encoding: 'utf8' });
+        return JSON.parse(str);
+    }
+    catch (err) {
+        throw (0, error_1.errWithCause)(err, `Fail to read "no tokens" signup context file ${noTokenFile}`);
+    }
+}
+exports.readNoTokensFile = readNoTokensFile;
+async function readTokenFile(rootFolder, tokenId) {
+    try {
+        const fPath = (0, path_1.join)((0, server_data_folders_1.tokensInRootFolder)(rootFolder), tokenId);
+        const str = await (0, async_fs_node_1.readFile)(fPath, { encoding: 'utf8' });
+        const ctx = JSON.parse(str);
+        if (!ctx.token) {
+            return;
+        }
+        else if (ctx.type === 'multi-domain') {
+            return (ctx.domains ? ctx : undefined);
+        }
+        else if (ctx.type === 'single-user') {
+            return (ctx.userId ? ctx : undefined);
+        }
+        else {
+            return;
+        }
+    }
+    catch (err) {
+        console.error(err);
+        return;
+    }
+}
+exports.readTokenFile = readTokenFile;
+async function readAllSignupTokens(rootFolder) {
+    const singleUserTokens = [];
+    const multiUserTokens = [];
+    const tokenIds = await (0, async_fs_node_1.readdir)((0, server_data_folders_1.tokensInRootFolder)(rootFolder));
+    for (const tokenId of tokenIds) {
+        const ctx = await readTokenFile(rootFolder, tokenId);
+        if (!ctx) {
+            continue;
+        }
+        if (ctx.type === 'multi-domain') {
+            multiUserTokens.push({ tokenId, ctx });
+        }
+        else {
+            singleUserTokens.push({ tokenId, ctx });
+        }
+    }
+    return { multiUserTokens, singleUserTokens };
+}
+exports.readAllSignupTokens = readAllSignupTokens;
+Object.freeze(exports);

package/build/lib-server/middleware/error-handler.d.ts

@@ -13,3 +13,4 @@ export interface HttpError extends ErrorWithCause {
 export declare function makeErr(code: number, msg: string, cause?: any): HttpError;
 export declare type ErrLogger = (err: any, req: Request) => void;
 export declare function makeErrHandler(log?: ErrLogger): ErrorRequestHandler;
+export declare function makeErrLoggerToConsole(srvName: string): ErrLogger;

package/build/lib-server/middleware/error-handler.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2016, 2020 3NSoft Inc.
+ Copyright (C) 2016, 2020, 2023 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeErrHandler = exports.makeErr = void 0;
+exports.makeErrLoggerToConsole = exports.makeErrHandler = exports.makeErr = void 0;
 const http = require("http");
 const error_1 = require("../../lib-common/exceptions/error");
 /**
@@ -63,4 +63,13 @@ function makeErrHandler(log) {
     };
 }
 exports.makeErrHandler = makeErrHandler;
+function makeErrLoggerToConsole(srvName) {
+    return (err, req) => {
+        if (typeof err.status !== 'number') {
+            console.error(`\n --- Error occured in ${srvName}, when handling ${req.method} request to ${req.originalUrl}`);
+            console.error(err);
+        }
+    };
+}
+exports.makeErrLoggerToConsole = makeErrLoggerToConsole;
 Object.freeze(exports);

package/build/lib-server/resources/dns.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2016 3NSoft Inc.
+ Copyright (C) 2015 - 2016, 2023 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -39,19 +39,57 @@ Object.freeze(DNS_ERR_CODE);
  */
 function extractPair(txtRecords, serviceLabel) {
     for (const txtRecord of txtRecords) {
-        const txt = txtRecord.join(' ');
-        const eqPos = txt.indexOf('=');
-        if (eqPos < 0) {
-            continue;
-        }
-        const name = txt.substring(0, eqPos).trim();
-        if (name === serviceLabel) {
-            const value = txt.substring(eqPos + 1).trim();
-            return value;
+        let joinedTXTstanzas = txtRecord.join('');
+        let record = getRecordAtStartOf(joinedTXTstanzas);
+        while (record) {
+            if (record.service === serviceLabel) {
+                const value = record.value.trim();
+                if (value.length > 0) {
+                    return value;
+                }
+            }
+            if (record.txtTail) {
+                record = getRecordAtStartOf(record.txtTail);
+            }
+            else {
+                break;
+            }
         }
     }
     return;
 }
+const recordsStarts = {
+    "3nstorage": '3nstorage=',
+    asmail: 'asmail=',
+    mailerid: 'mailerid='
+};
+function getRecordAtStartOf(txt) {
+    let service = undefined;
+    for (const [label, startSeq] of Object.entries(recordsStarts)) {
+        if (txt.startsWith(startSeq)) {
+            service = label;
+            txt = txt.substring(startSeq.length);
+            break;
+        }
+    }
+    if (!service) {
+        return;
+    }
+    for (const delimiter of Object.values(recordsStarts)) {
+        const endPos = txt.indexOf(delimiter);
+        if (endPos >= 0) {
+            return {
+                service,
+                value: txt.substring(0, endPos),
+                txtTail: txt.substring(endPos)
+            };
+        }
+    }
+    return {
+        service,
+        value: txt
+    };
+}
 function resolveTxt(domain) {
     return new Promise((resolve, reject) => {
         // As of March 2017, docs for node say that texts given in a callback

package/build/lib.d.ts

@@ -1,4 +1,6 @@
-export import services = require('./services');
-export import confs = require('./run-config');
-export import appUtils = require('./lib-server/web-sockets/app');
-export import mock = require('./mock/run-in-proc');
+export { AppWithWSs } from './lib-server/web-sockets/app';
+export { Configurations, servicesApp, adminApp } from './services';
+export { getConfsFromEnv, getBindParamsFromEnv } from './config/from-env';
+export { addSingleUserSignup } from './config/signup';
+export import errors = require('./lib-server/middleware/error-handler');
+export * as mock from './mock/run-in-proc';

package/build/lib.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2020 3NSoft Inc.
+ Copyright (C) 2020, 2023 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -16,8 +16,17 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.services = require("./services");
-exports.confs = require("./run-config");
-exports.appUtils = require("./lib-server/web-sockets/app");
+exports.mock = exports.addSingleUserSignup = exports.getBindParamsFromEnv = exports.getConfsFromEnv = exports.adminApp = exports.servicesApp = exports.AppWithWSs = void 0;
+var app_1 = require("./lib-server/web-sockets/app");
+Object.defineProperty(exports, "AppWithWSs", { enumerable: true, get: function () { return app_1.AppWithWSs; } });
+var services_1 = require("./services");
+Object.defineProperty(exports, "servicesApp", { enumerable: true, get: function () { return services_1.servicesApp; } });
+Object.defineProperty(exports, "adminApp", { enumerable: true, get: function () { return services_1.adminApp; } });
+var from_env_1 = require("./config/from-env");
+Object.defineProperty(exports, "getConfsFromEnv", { enumerable: true, get: function () { return from_env_1.getConfsFromEnv; } });
+Object.defineProperty(exports, "getBindParamsFromEnv", { enumerable: true, get: function () { return from_env_1.getBindParamsFromEnv; } });
+var signup_1 = require("./config/signup");
+Object.defineProperty(exports, "addSingleUserSignup", { enumerable: true, get: function () { return signup_1.addSingleUserSignup; } });
+exports.errors = require("./lib-server/middleware/error-handler");
 exports.mock = require("./mock/run-in-proc");
 Object.freeze(exports);

package/build/mailerId/mailerId-app.d.ts

@@ -3,4 +3,5 @@
  * express MailerId application.
  */
 import * as express from 'express';
-export declare function makeApp(rootFolder: string, domain: string, certFile: string): express.Express;
+import { ErrLogger } from '../lib-server/middleware/error-handler';
+export declare function makeApp(rootFolder: string, domain: string, certFile: string, errLogger?: ErrLogger): express.Express;

package/build/mailerId/mailerId-app.js

@@ -43,7 +43,7 @@ function provisioningApp(sessions, users, certifier, computeDHSharedKey) {
     app.post('/' + api.certify.URL_END, sessions.ensureAuthorizedSession(), (0, body_parsers_1.binary)('16kb'), (0, certify_1.certify)(certifier.certify));
     return app;
 }
-function makeApp(rootFolder, domain, certFile) {
+function makeApp(rootFolder, domain, certFile, errLogger) {
     const app = express();
     const certProvisSessions = (0, sessions_1.makeSessionFactory)(2 * 60);
     const users = (0, users_1.makeFactory)(rootFolder);
@@ -62,7 +62,7 @@ function makeApp(rootFolder, domain, certFile) {
         };
         res.status(200).json(json); // content type application/json
     });
-    app.use((0, error_handler_1.makeErrHandler)());
+    app.use((0, error_handler_1.makeErrHandler)(errLogger));
     return app;
 }
 exports.makeApp = makeApp;