spec-3nweb-server 1.6.4 → 1.7.1

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/services.d.ts

@@ -12,6 +12,8 @@ export interface Configurations {
         hostname?: string;
         port: number;
         sslOpts?: https.ServerOptions;
+        letsencrypt?: string;
+        skipReloadOnCertsChange?: boolean;
     };
     rootFolder: string;
     domain: string;
@@ -22,5 +24,5 @@ export interface Configurations {
         noTokenFile?: string;
     };
 }
-export declare function servicesApp(conf: Configurations, errLogger?: ErrLogger | 'console'): AppWithWSs;
-export declare function adminApp(conf: Configurations, errLogger?: ErrLogger | 'console'): 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

@@ -24,29 +24,38 @@ const asmail_app_1 = require("./asmail/asmail-app");
 const _3nstorage_app_1 = require("./3nstorage/3nstorage-app");
 const admin_app_1 = require("./admin/admin-app");
 const error_handler_1 = require("./lib-server/middleware/error-handler");
-function servicesApp(conf, errLogger) {
+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, (errLogger === 'console') ? (0, error_handler_1.makeErrLoggerToConsole)('mailerid') : errLogger));
+        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, (errLogger === 'console') ? (0, error_handler_1.makeErrLoggerToConsole)('asmail') : errLogger));
+        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, (errLogger === 'console') ? (0, error_handler_1.makeErrLoggerToConsole)('storage') : errLogger));
+        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, errLogger) {
+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));
+    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.4",
+  "version": "1.7.1",
   "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/create-deb.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",
+    "express": "^4.19.2",
+    "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, ''));
+}

package/build/run-config.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="node" />
-import { Configurations } from "./services";
-import { ServerOptions } from "https";
-export declare function getConfsFromEnv(): Configurations;
-export declare function getBindParamsFromEnv(): {
-    address?: string;
-    port: number;
-    sslOpts?: ServerOptions;
-};
-export declare function addSingleUserSignup(rootFolder: string, userId: string): Promise<string>;

package/build/run-config.js

@@ -1,146 +0,0 @@
-"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.addSingleUserSignup = 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';
-const CERTS_FILE_VAR = 'W3N_MID_CERTS_FILE';
-const ADDRESS_VAR = 'W3N_SERICE_ADDRESS';
-const PORT_VAR = 'W3N_SERICE_PORT';
-const TLS_KEY_VAR = 'W3N_SERICE_TLS_KEY';
-const TLS_CERT_VAR = 'W3N_SERICE_TLS_CERT';
-const TLS_PFX_VAR = 'W3N_SERICE_TLS_PFX';
-const DEFAULT_PORT = 8080;
-function makeConf(domain, rootFolder, midCertsFile, noTokenFile) {
-    return {
-        enabledServices: {
-            asmail: true,
-            storage: true,
-            mailerId: true
-        },
-        rootFolder,
-        domain,
-        mailerId: {
-            certs: midCertsFile
-        },
-        signup: {
-            noTokenFile
-        }
-    };
-}
-function getConfsFromEnv() {
-    const domain = process.env[DOMAIN_VAR];
-    if (!domain) {
-        throw new Error(`Environment variable ${DOMAIN_VAR} is not set with domain name, for which 3NWeb processes are served.`);
-    }
-    let dataDir = process.env[DATA_DIR_VAR];
-    if (!dataDir) {
-        dataDir = '/var/local/3nweb';
-    }
-    // Make data folders
-    ensureFolderPresence(dataDir, true);
-    dataDir = (0, fs_1.realpathSync)(dataDir);
-    let midCerts = process.env[CERTS_FILE_VAR];
-    if (!midCerts) {
-        midCerts = (0, path_1.join)(dataDir, 'mid-certs.json');
-    }
-    const noTokenFile = process.env[NO_TOKENS_FILE];
-    return makeConf(domain, dataDir, midCerts, noTokenFile);
-}
-exports.getConfsFromEnv = getConfsFromEnv;
-function ensureFolderPresence(path, doLog) {
-    if ((0, async_fs_node_1.existsFolderSync)(path)) {
-        if (doLog) {
-            console.log(`Using existing data folder ${path}`);
-        }
-    }
-    else {
-        (0, fs_1.mkdirSync)(path);
-        if (doLog) {
-            console.log(`Created ${(0, fs_1.realpathSync)(path)}`);
-        }
-    }
-}
-function getBindParamsFromEnv() {
-    const address = process.env[ADDRESS_VAR];
-    const portStr = process.env[PORT_VAR];
-    let port;
-    if (portStr) {
-        port = Number.parseInt(portStr);
-        if (!Number.isInteger(port)) {
-            port = DEFAULT_PORT;
-        }
-    }
-    else {
-        port = DEFAULT_PORT;
-    }
-    const sslOpts = getTLSParamsFromEnv();
-    return { address, port, sslOpts };
-}
-exports.getBindParamsFromEnv = getBindParamsFromEnv;
-function getTLSParamsFromEnv() {
-    const pfx = process.env[TLS_PFX_VAR];
-    if (pfx) {
-        return { pfx };
-    }
-    const cert = process.env[TLS_CERT_VAR];
-    const key = process.env[TLS_KEY_VAR];
-    if (cert && key) {
-        return { cert, key };
-    }
-    else if (!cert && !key) {
-        return;
-    }
-    else {
-        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/run.d.ts

@@ -1 +0,0 @@
-export {};

package/build/run.js

@@ -1,45 +0,0 @@
-"use strict";
-/*
- Copyright (C) 2015 - 2019 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 });
-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, 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);
-    }
-})();