spec-3nweb-server 1.6.3 → 1.7.0

package/build/main.js

@@ -13,70 +13,221 @@
  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/>. */
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 Object.defineProperty(exports, "__esModule", { value: true });
-/*
- * This script starts server, according to settings, given in config file.
- */
-const services_1 = require("./services");
-const app_1 = require("./lib-server/web-sockets/app");
-const fs_1 = require("fs");
-const async_fs_node_1 = require("./lib-common/async-fs-node");
-const child_process_1 = require("child_process");
-const processes_1 = require("./lib-common/processes");
-const PID_FILE = '/var/3nweb/service.pid';
-const confFile = process.argv[2];
-if (!confFile) {
-    console.error(`Configuration file is not given. It should be the first script argument.`);
-    process.exit(-1);
-}
-const conf = JSON.parse((0, fs_1.readFileSync)(confFile, 'utf8'));
-const noop = () => { };
-(async () => {
+const cli_1 = require("./config/cli");
+const from_yaml_1 = require("./config/from-yaml");
+const letsencrypt_1 = require("./config/letsencrypt");
+const lib_1 = require("./lib");
+const signup_1 = require("./config/signup");
+async function run(conf) {
     if (!conf.servicesConnect) {
-        console.error(`No connection settings found in ${confFile}.`);
+        console.error(`No connection settings found in ??.`);
         process.exit(-1);
         return;
     }
-    try {
-        const prevPidStr = await (0, async_fs_node_1.readFile)(PID_FILE, { encoding: 'utf8' });
-        const prevPid = Number.parseInt(prevPidStr);
-        if (!Number.isNaN(prevPid)) {
-            (0, child_process_1.execSync)(`kill -SIGTERM ${prevPid}`);
-            while (!!(0, child_process_1.execSync)(`ps ${prevPid} | grep ${prevPid}`)) {
-                await (0, processes_1.sleep)(1000);
-            }
-            await (0, async_fs_node_1.unlink)(PID_FILE).catch(noop);
-        }
-    }
-    catch (err) {
-        if (!err.notFound) {
-            throw err;
-        }
-    }
     let app = undefined;
+    function createApp(conf) {
+        const app = new lib_1.AppWithWSs();
+        app.use((0, lib_1.servicesApp)(conf, 'console', 'console'));
+        app.use((0, lib_1.adminApp)(conf, 'console', 'console'));
+        return app;
+    }
     async function stopProcess() {
         if (!app) {
             return;
         }
-        app.stop().then(err => console.log(err));
-        app = undefined;
-        (0, async_fs_node_1.unlink)(PID_FILE).catch(noop);
+        try {
+            console.log(`Stopping app ...`);
+            await app.stop();
+            console.log(`app has stopped.`);
+        }
+        catch (err) {
+            console.log(`app encounter an error, when stopping`);
+            console.error(err);
+        }
+        finally {
+            app = undefined;
+        }
     }
-    try {
-        app = new app_1.AppWithWSs();
-        app.use((0, services_1.servicesApp)(conf));
-        app.use((0, services_1.adminApp)(conf));
-        const { hostname, port, sslOpts } = conf.servicesConnect;
+    async function startAppWithTLS(sslOpts, port, hostname) {
         await app.start(sslOpts, port, hostname);
-        console.log(`Started 3NWeb server at address "${hostname}", port ${port}, ${sslOpts ? 'via TLS' : 'without TLS, and requiring TLS reverse proxy infront.'}`);
-        (0, fs_1.writeFileSync)(PID_FILE, `${process.pid}`);
+        console.log(`Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} with TLS.`);
+    }
+    async function startAppWithoutTLS(port, hostname) {
+        await app.start(undefined, port, hostname);
+        console.log(`Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} without TLS, and requiring TLS reverse proxy infront.`);
+    }
+    try {
+        app = createApp(conf);
+        const { hostname, port, letsencrypt, sslOpts, skipReloadOnCertsChange } = conf.servicesConnect;
+        const tls = (0, letsencrypt_1.sslOptsFromConfig)(letsencrypt, sslOpts, skipReloadOnCertsChange);
+        if (tls) {
+            await startAppWithTLS(tls.sslOpts, port, hostname);
+            if (!skipReloadOnCertsChange) {
+                tls.onCertsUpdate(async (newOpts, originalOpts) => {
+                    console.log(`Reloading server app server on TLS certificates change`);
+                    try {
+                        await stopProcess();
+                        app = createApp(conf);
+                        await startAppWithTLS(newOpts, port, hostname);
+                    }
+                    catch (err) {
+                        console.error(err);
+                        console.log(`Failed to reload with new TLS certs. Attempting to load with original ones.`);
+                        try {
+                            await stopProcess();
+                            app = createApp(conf);
+                            await startAppWithTLS(originalOpts, port, hostname);
+                        }
+                        catch (err) {
+                            await stopProcess();
+                            console.error(err);
+                            process.exit(-500);
+                        }
+                    }
+                });
+            }
+        }
+        else {
+            await startAppWithoutTLS(port, hostname);
+        }
         process.on('SIGINT', stopProcess);
         process.on('SIGTERM', stopProcess);
     }
     catch (err) {
-        stopProcess();
+        await stopProcess();
         console.error(err);
         process.exit(-500);
     }
-})();
+}
+function showUsage({ txtToDisplay, exitStatus }) {
+    if (exitStatus === 0) {
+        console.log(txtToDisplay);
+    }
+    else {
+        console.error(txtToDisplay);
+    }
+    process.exit(exitStatus);
+}
+function assembleConfig(configPath) {
+    if (configPath) {
+        return (0, from_yaml_1.readYamlConfFile)(configPath);
+    }
+    else {
+        throw new Error(`Config path must be given`);
+    }
+}
+async function displaySignupInfo(conf) {
+    if (!conf.signup) {
+        console.log(`\nSignup is disabled.\n`);
+    }
+    else {
+        console.log(`\nSignup is enabled.\n`);
+        if (conf.signup.noTokenFile) {
+            const ctx = await (0, signup_1.readNoTokensFile)(conf.signup.noTokenFile);
+            console.log(`Signup of user without token is allowed in domains:\n`, ctx.domains, `\n`);
+        }
+        else {
+            console.log(`Signup of users is allowed only with valid signup tokens.\n`);
+        }
+    }
+    const { multiUserTokens, singleUserTokens } = await (0, signup_1.readAllSignupTokens)(conf.rootFolder);
+    console.log(`There are ${multiUserTokens.length} multi-user tokens.\n`);
+    console.log(`There are ${singleUserTokens.length} single-user tokens.\n`);
+}
+async function displayTokensList(conf) {
+    const { multiUserTokens, singleUserTokens } = await (0, signup_1.readAllSignupTokens)(conf.rootFolder);
+    if (multiUserTokens.length > 0) {
+        console.log(`\nMulti-user signup tokens:`);
+        for (const { tokenId, ctx: { domains } } of multiUserTokens) {
+            console.log(`  id: ${tokenId}  -> domains:`, domains);
+        }
+        console.log(``);
+    }
+    else {
+        console.log(`\nThere are no multi-user signup tokens.\n`);
+    }
+    if (singleUserTokens.length > 0) {
+        console.log(`Single-user signup tokens:`);
+        for (const { tokenId, ctx: { userId } } of singleUserTokens) {
+            console.log(`  id: ${tokenId}  -> user: ${userId}`);
+        }
+        console.log(``);
+    }
+    else {
+        console.log(`There are no single-user signup tokens.\n`);
+    }
+}
+async function displayTokenValue(conf, tokenId) {
+    const ctx = await (0, signup_1.readTokenFile)(conf.rootFolder, tokenId);
+    if (!ctx) {
+        console.error(`Token ${tokenId} is not found.`);
+        process.exit(-1);
+    }
+    else if (ctx.type === 'multi-domain') {
+        console.log(`\nMulti-user signup context:`);
+        console.log(`  domains:`, ctx.domains);
+        console.log(`  value:`, ctx.token);
+        if (ctx.validTill) {
+            console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}\n`);
+        }
+        else {
+            console.log(``);
+        }
+    }
+    else if (ctx.type === 'single-user') {
+        console.log(`\nSingle-user signup context:`);
+        console.log(`  address:`, ctx.userId);
+        console.log(`  value:`, ctx.token);
+        if (ctx.validTill) {
+            console.log(`  valid till: ${(new Date(ctx.validTill)).toString()}\n`);
+        }
+        else {
+            console.log(``);
+        }
+    }
+}
+async function createMultiUserToken(conf, domains) {
+    const token = await (0, signup_1.addMultiDomainSignup)(conf.rootFolder, domains);
+    console.log(`\nToken value:\n  ${token}\n`);
+}
+async function createSingleUserToken(conf, userId) {
+    const token = await (0, signup_1.addSingleUserSignup)(conf.rootFolder, userId);
+    console.log(`\nToken value:\n  ${token}\n`);
+}
+const cmd = (0, cli_1.parseProcessArgv)();
+if (cmd.runCmd) {
+    const conf = assembleConfig(cmd.runCmd.config);
+    run(conf);
+}
+else if (cmd.signupCmd) {
+    const conf = assembleConfig(cmd.signupCmd.config);
+    if (cmd.signupCmd.info) {
+        displaySignupInfo(conf);
+    }
+    else if (cmd.signupCmd.listTokens) {
+        displayTokensList(conf);
+    }
+    else if (cmd.signupCmd.showToken) {
+        displayTokenValue(conf, cmd.signupCmd.token);
+    }
+    else if (cmd.signupCmd.createToken) {
+        if (cmd.signupCmd.user) {
+            createSingleUserToken(conf, cmd.signupCmd.user);
+        }
+        else {
+            createMultiUserToken(conf, cmd.signupCmd.domain);
+        }
+    }
+    else {
+        throw new Error(`CLI parser failed to capture invalid command`);
+    }
+}
+else if (cmd.showUsage) {
+    showUsage(cmd.showUsage);
+}
+else {
+    throw new Error(`CLI parser failed to trigger useful action`);
+}

package/build/mock/run-in-proc.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
@@ -37,8 +37,11 @@ function setTestCertsAndDNS(domains, thisSrvLoc) {
     for (const domain of domains) {
         dnsRecs[domain] = [
             ['asmail', '=', `${thisSrvLoc}/asmail`],
-            ['mailerid=', `${thisSrvLoc}/mailerid`],
-            [`3nstorage=${thisSrvLoc}/3nstorage`] // DNS txt without spaces
+            [
+                'mailerid=', `${thisSrvLoc}/mailerid`,
+                `3nstorage=${thisSrvLoc}/3nstorage`
+            ] // two 3NWeb records in one DNS TXT record
+            // XXX add other life-like records
         ];
     }
     const dnsMock = new dns_1.DNSMock(dnsRecs);

package/build/run.js

@@ -13,22 +13,32 @@
  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/>. */
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
 Object.defineProperty(exports, "__esModule", { value: true });
-const services_1 = require("./services");
-const app_1 = require("./lib-server/web-sockets/app");
-const run_config_1 = require("./run-config");
+const lib_1 = require("./lib");
 (async () => {
+    let app = undefined;
+    async function stopProcess() {
+        if (!app) {
+            return;
+        }
+        app.stop().then(err => console.log(err));
+        app = undefined;
+    }
     try {
-        const conf = (0, run_config_1.getConfsFromEnv)();
-        const app = new app_1.AppWithWSs();
-        app.use((0, services_1.servicesApp)(conf));
-        app.use((0, services_1.adminApp)(conf));
-        const { address, port, sslOpts } = (0, run_config_1.getBindParamsFromEnv)();
+        const conf = (0, lib_1.getConfsFromEnv)();
+        app = new lib_1.AppWithWSs();
+        app.use((0, lib_1.servicesApp)(conf));
+        app.use((0, lib_1.adminApp)(conf));
+        const { address, port, sslOpts } = (0, lib_1.getBindParamsFromEnv)();
         await app.start(sslOpts, port, address);
         console.log(`Started 3NWeb server at address ${address}, port ${port}, ${sslOpts ? 'via TLS' : 'without TLS, and requiring TLS reverse proxy infront.'}`);
+        process.on('SIGINT', stopProcess);
+        process.on('SIGTERM', stopProcess);
     }
     catch (err) {
+        stopProcess();
         console.error(err);
         process.exit(-500);
     }

package/build/services.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import * as https from "https";
 import { AppWithWSs } from './lib-server/web-sockets/app';
+import { ErrLogger } from "./lib-server/middleware/error-handler";
 export interface Configurations {
     enabledServices: {
         asmail?: boolean;
@@ -11,6 +12,8 @@ export interface Configurations {
         hostname?: string;
         port: number;
         sslOpts?: https.ServerOptions;
+        letsencrypt?: string;
+        skipReloadOnCertsChange?: boolean;
     };
     rootFolder: string;
     domain: string;
@@ -21,5 +24,5 @@ export interface Configurations {
         noTokenFile?: string;
     };
 }
-export declare function servicesApp(conf: Configurations): AppWithWSs;
-export declare function adminApp(conf: Configurations): AppWithWSs;
+export declare function servicesApp(conf: Configurations, errLogger?: ErrLogger | 'console', logSetup?: 'console'): AppWithWSs;
+export declare function adminApp(conf: Configurations, errLogger?: ErrLogger | 'console', logSetup?: 'console'): AppWithWSs;

package/build/services.js

@@ -23,26 +23,39 @@ const mailerId_app_1 = require("./mailerId/mailerId-app");
 const asmail_app_1 = require("./asmail/asmail-app");
 const _3nstorage_app_1 = require("./3nstorage/3nstorage-app");
 const admin_app_1 = require("./admin/admin-app");
-function servicesApp(conf) {
+const error_handler_1 = require("./lib-server/middleware/error-handler");
+function servicesApp(conf, errLogger, logSetup) {
     if (!conf.enabledServices || (typeof conf.enabledServices !== 'object')) {
         throw new Error('Missing enabled-services sections in confs.');
     }
     const app = new app_1.AppWithWSs();
     const midAuthorizer = (0, mailerid_authorizer_1.validator)(); // share, allowing for caching of certs
     if (conf.enabledServices.mailerId) {
-        app.http.use('/mailerid', (0, mailerId_app_1.makeApp)(conf.rootFolder, conf.domain, conf.mailerId.certs));
+        app.http.use('/mailerid', (0, mailerId_app_1.makeApp)(conf.rootFolder, conf.domain, conf.mailerId.certs, (errLogger === 'console') ? (0, error_handler_1.makeErrLoggerToConsole)('MailerId') : errLogger));
+        if (logSetup === 'console') {
+            console.log(`Enabled MailerId service with provider domain ${conf.domain}`);
+        }
     }
     if (conf.enabledServices.asmail) {
-        app.use('/asmail', (0, asmail_app_1.makeApp)(conf.rootFolder, conf.domain, midAuthorizer));
+        app.use('/asmail', (0, asmail_app_1.makeApp)(conf.rootFolder, conf.domain, midAuthorizer, (errLogger === 'console') ? (0, error_handler_1.makeErrLoggerToConsole)('ASMail') : errLogger));
+        if (logSetup === 'console') {
+            console.log(`Enabled ASMail service with provider domain ${conf.domain}`);
+        }
     }
     if (conf.enabledServices.storage) {
-        app.use('/3nstorage', (0, _3nstorage_app_1.makeApp)(conf.rootFolder, conf.domain, midAuthorizer));
+        app.use('/3nstorage', (0, _3nstorage_app_1.makeApp)(conf.rootFolder, conf.domain, midAuthorizer, (errLogger === 'console') ? (0, error_handler_1.makeErrLoggerToConsole)('3NStorage') : errLogger));
+        if (logSetup === 'console') {
+            console.log(`Enabled 3NStorage service with provider domain ${conf.domain}`);
+        }
     }
     return app;
 }
 exports.servicesApp = servicesApp;
-function adminApp(conf) {
-    return new app_1.AppWithWSs((0, admin_app_1.makeApp)(conf));
+function adminApp(conf, errLogger, logSetup) {
+    if (errLogger === 'console') {
+        errLogger = (0, error_handler_1.makeErrLoggerToConsole)('3NWeb server admin');
+    }
+    return new app_1.AppWithWSs((0, admin_app_1.makeApp)(conf, errLogger, logSetup));
 }
 exports.adminApp = adminApp;
 Object.freeze(exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-3nweb-server",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "description": "3NWeb spec server.",
   "main": "build/lib.js",
   "types": "build/lib.d.ts",
@@ -9,7 +9,9 @@
     "test": "node build/tests/jasmine.js",
     "clear-for-packing": "npm prune --production && bash -c \"rm -rf build/mock build/tests 'node_modules/ecma-nacl/c sources'\"",
     "clear-for-packing-mock": "npm prune --production && bash -c \"rm -rf build/tests 'node_modules/ecma-nacl/c sources'\"",
-    "pack-deb": "npm run clear-for-packing && bash packing/deb/create-bin.sh"
+    "pack": "pkg --config package.json build/main.js",
+    "pack-deb": "npm run pack && bash packing/deb/create-bin.sh",
+    "postinstall": "node -e \"try{require('./postinstall')}catch(e){}\""
   },
   "repository": {
     "type": "git",
@@ -29,8 +31,12 @@
   },
   "license": "GPL-3.0",
   "dependencies": {
+    "command-line-args": "^5.2.1",
+    "command-line-usage": "^7.0.1",
     "ecma-nacl": "^2.4.0",
     "express": "^4.18.0",
+    "js-yaml": "^4.1.0",
+    "prompts": "^2.4.2",
     "punycode": "^2.1.1",
     "ws": "^7.4.6",
     "xsp-files": "^2.0.0"
@@ -41,9 +47,16 @@
     "@types/node": "^16.11.7",
     "@types/ws": "^4.0.0",
     "jasmine": "^3.9.0",
+    "pkg": "^5.8.1",
     "rxjs": "^5.3.0",
     "typescript": "^4.7.4",
     "xhr2": "^0.1.3"
   },
+  "pkg": {
+    "targets": [
+      "node18-linux-x64"
+    ],
+    "outputPath": "dist"
+  },
   "readmeFilename": "README.md"
 }

package/postinstall.js

@@ -0,0 +1,25 @@
+
+function is(it) {
+	return !!it && it !== '0' && it !== 'false';
+}
+ 
+const env = process.env;
+
+const ADBLOCK = is(env.ADBLOCK);
+const SILENT = ['silent', 'error', 'warn'].includes(env.npm_config_loglevel) ;
+const COLOR = is(env.npm_config_color);
+
+const BANNER = `\u001B[96mThank you for using spec-server (\u001B[94m https://github.com/3nsoft/spec-server.git \u001B[96m) of 3NWeb uitlity services. This server is developed together with defining 3NWeb protocols by PrivacySafe\u001B[0m
+
+\u001B[96mThe project needs your help! Please consider supporting PrivacySafe on Open Collective: \u001B[0m
+\u001B[96m>\u001B[94m https://opencollective.com/privacysafe \u001B[0m
+`;
+
+function isBannerRequired() {
+  if (ADBLOCK || SILENT) { return false; }
+  return true;
+}
+
+if (isBannerRequired()) {
+	console.log(COLOR ? BANNER : BANNER.replace(/\u001B\[\d+m/g, ''));
+}