spec-3nweb-server 1.6.4 → 1.7.0

package/README.md

@@ -1,5 +1,4 @@
 
-
 # Spec Server
 
 This repository contains 3NWeb protocols' specification test suite and a single-machine server implementation, conforming to spec's suite.

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

@@ -1,4 +1,4 @@
 import * as express from 'express';
 import { ErrLogger } from '../lib-server/middleware/error-handler';
 import { Configurations } from '../services';
-export declare function makeApp(conf: Configurations, errLogger?: ErrLogger): express.Express;
+export declare function makeApp(conf: Configurations, errLogger?: ErrLogger, logSetup?: 'console'): express.Express;

package/build/admin/admin-app.js

@@ -33,12 +33,15 @@ function apiPart(users) {
     app.post('/' + signupApi.addUser.URL_END, (0, body_parsers_1.json)('4kb'), (0, add_1.addUser)(users.add));
     return app;
 }
-function makeApp(conf, errLogger) {
+function makeApp(conf, errLogger, logSetup) {
     const app = express();
     const noTokenFile = (conf.signup ? conf.signup.noTokenFile : undefined);
     const users = (0, users_1.makeFactory)(conf.rootFolder, noTokenFile);
     if (conf.signup) {
         app.use('/signup', apiPart(users));
+        if (logSetup === 'console') {
+            console.log(`Enabled signup service.`);
+        }
     }
     app.use((0, error_handler_1.makeErrHandler)(errLogger));
     return app;

package/build/config/cli/index.d.ts

@@ -0,0 +1,9 @@
+import { ParsedRunArgs } from "./run-cmd";
+import { ParsedSignupArgs } from "./signup-cmd";
+import { CliUsageDisplay } from "./utils";
+export { CliUsageDisplay } from "./utils";
+export declare function parseProcessArgv(): {
+    runCmd?: ParsedRunArgs;
+    signupCmd?: ParsedSignupArgs;
+    showUsage?: CliUsageDisplay;
+};

package/build/config/cli/index.js

@@ -0,0 +1,68 @@
+"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.parseProcessArgv = void 0;
+const path_1 = require("path");
+const run_cmd_1 = require("./run-cmd");
+const signup_cmd_1 = require("./signup-cmd");
+const utils_1 = require("./utils");
+function mainUsage(execName) {
+    return [
+        {
+            header: execName,
+            content: `Server of all 3NWeb utilities: MailerId, ASMail, 3NStorage.`
+        },
+        {
+            header: `Usage:`,
+            content: `${execName} [command]`
+        },
+        {
+            header: 'Available commands:',
+            content: [
+                run_cmd_1.runCmd,
+                signup_cmd_1.signupCmd
+            ]
+        },
+        {
+            header: '',
+            content: `Use "${execName} [command] --help" for more information about a command.`
+        }
+    ];
+}
+function parseProcessArgv() {
+    const args = process.argv.slice(2);
+    const execName = (0, path_1.basename)(process.argv0);
+    if (args.length === 0) {
+        return (0, utils_1.toUsageDisplay)(0, mainUsage(execName));
+    }
+    if (args[0] === run_cmd_1.runCmd.name) {
+        return (0, run_cmd_1.parseRunArgs)(args.slice(1), execName);
+    }
+    else if (args[0] === signup_cmd_1.signupCmd.name) {
+        return (0, signup_cmd_1.parseSignupArgs)(args.slice(1), execName);
+    }
+    else {
+        const opts = (0, utils_1.parseArgv)(args, [utils_1.helpOpt], { partial: true });
+        if (opts.help) {
+            return (0, utils_1.toUsageDisplay)(0, mainUsage(execName));
+        }
+        return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(mainUsage(execName), `Unknown command '${args[0]}'`));
+    }
+}
+exports.parseProcessArgv = parseProcessArgv;
+Object.freeze(exports);

package/build/config/cli/run-cmd.d.ts

@@ -0,0 +1,10 @@
+import { CliUsageDisplay, CommandDef } from "./utils";
+export declare const runCmd: CommandDef<'run'>;
+export interface ParsedRunArgs {
+    config?: string;
+    help?: boolean;
+}
+export declare function parseRunArgs(args: string[], execName: string): {
+    runCmd?: ParsedRunArgs;
+    showUsage?: CliUsageDisplay;
+};

package/build/config/cli/run-cmd.js

@@ -0,0 +1,69 @@
+"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.parseRunArgs = exports.runCmd = void 0;
+const utils_1 = require("./utils");
+exports.runCmd = {
+    name: 'run',
+    summary: 'runs 3NWeb services'
+};
+function runUsage(execName) {
+    return [
+        {
+            content: `This command runs some or all 3NWeb services. Configuration is read from a yaml file.`
+        },
+        {
+            header: 'Usage:',
+            content: `${execName} ${exports.runCmd.name} [options] [config_file]`
+        },
+        {
+            header: 'Options:',
+            optionList: runOpts
+        }
+    ];
+}
+const runOpts = [
+    {
+        name: 'config',
+        alias: 'c',
+        type: String,
+        typeLabel: '{underline <file>}',
+        description: `path of a configuration yaml file`
+    },
+    utils_1.helpOpt
+];
+function parseRunArgs(args, execName) {
+    if (args.length === 0) {
+        return (0, utils_1.toUsageDisplay)(0, runUsage(execName));
+    }
+    const runArgs = (0, utils_1.parseArgv)(args, runOpts, { partial: true });
+    if (runArgs.help) {
+        return (0, utils_1.toUsageDisplay)(0, runUsage(execName));
+    }
+    else if (runArgs.config) {
+        return { runCmd: runArgs };
+    }
+    else if (runArgs._unknown) {
+        return { runCmd: { config: runArgs._unknown[0] } };
+    }
+    else {
+        return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(runUsage(execName), `Missing configuration file path.`));
+    }
+}
+exports.parseRunArgs = parseRunArgs;
+Object.freeze(exports);

package/build/config/cli/signup-cmd.d.ts

@@ -0,0 +1,17 @@
+import { CliUsageDisplay, CommandDef } from "./utils";
+export declare const signupCmd: CommandDef<'signup'>;
+export interface ParsedSignupArgs {
+    info?: boolean;
+    config?: string;
+    help?: boolean;
+    listTokens?: boolean;
+    showToken?: boolean;
+    token?: string;
+    createToken?: boolean;
+    domain?: string[];
+    user?: string;
+}
+export declare function parseSignupArgs(args: string[], execName: string): {
+    signupCmd?: ParsedSignupArgs;
+    showUsage?: CliUsageDisplay;
+};

package/build/config/cli/signup-cmd.js

@@ -0,0 +1,194 @@
+"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.parseSignupArgs = exports.signupCmd = void 0;
+const utils_1 = require("./utils");
+exports.signupCmd = {
+    name: 'signup',
+    summary: 'controls adding new users to this instance'
+};
+function signupUsage(execName) {
+    return [
+        {
+            content: `This command controls parameters of adding new users to this instance.`
+        },
+        {
+            header: 'Usage:',
+            content: `${execName} ${exports.signupCmd.name} [command] [options] [config_file]`
+        },
+        {
+            header: 'Available commands:',
+            content: [
+                infoCmd,
+                listTokensCmd,
+                showTokenCmd,
+                createTokenCmd
+            ]
+        },
+        {
+            header: `${infoCmd.name} options:`,
+            optionList: infoOpts
+        },
+        {
+            header: `${listTokensCmd.name} options:`,
+            optionList: listTokensOpts
+        },
+        {
+            header: `${showTokenCmd.name} options:`,
+            optionList: showTokenOpts
+        },
+        {
+            header: `${createTokenCmd.name} options:`,
+            optionList: createTokenOpts
+        }
+    ];
+}
+const configOpt = {
+    name: 'config',
+    alias: 'c',
+    type: String,
+    typeLabel: '{underline <file>}',
+    description: `path of a configuration yaml file`
+};
+const infoCmd = {
+    name: 'info',
+    summary: 'shows state of signup subsystem'
+};
+const infoOpts = [
+    configOpt
+];
+const listTokensCmd = {
+    name: 'list-tokens',
+    summary: 'lists signup tokens'
+};
+const listTokensOpts = [
+    configOpt
+];
+const showTokenCmd = {
+    name: 'show-token',
+    summary: 'shows signup token with complete value'
+};
+const showTokenOpts = [
+    configOpt,
+    {
+        name: 'token',
+        alias: 't',
+        type: String,
+        typeLabel: '{underline <token_id>}',
+        description: `token id`
+    }
+];
+const createTokenCmd = {
+    name: 'create-token',
+    summary: 'creates signup token for single user, when user id is given, and for many users, when domain(s) are given'
+};
+const createTokenOpts = [
+    configOpt,
+    {
+        name: 'domain',
+        alias: 'd',
+        type: String,
+        typeLabel: '{underline <domain>}',
+        multiple: true,
+        description: `domain for new users. Several domain options will attach all domains to same token.`
+    },
+    {
+        name: 'user',
+        alias: 'u',
+        type: String,
+        typeLabel: '{underline <user_address>}',
+        description: `address of a single user`
+    }
+];
+function parseWithConfFile(args, optList) {
+    const opts = (0, utils_1.parseArgv)(args, optList, { partial: true });
+    if (opts.config) {
+        return opts;
+    }
+    else if (opts._unknown) {
+        opts.config = opts._unknown[0];
+        return opts;
+    }
+    else {
+        return;
+    }
+}
+function cmdUsageErr(execName, cmd, errTxt = `missing configuration file`) {
+    return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(signupUsage(execName), `Incorrect options for command '${exports.signupCmd.name} ${cmd}': ${errTxt}`));
+}
+function parseSignupArgs(args, execName) {
+    if (args.length === 0) {
+        return (0, utils_1.toUsageDisplay)(0, signupUsage(execName));
+    }
+    if (args[0] === infoCmd.name) {
+        const signupCmd = parseWithConfFile(args.slice(1), infoOpts);
+        if (signupCmd) {
+            signupCmd.info = true;
+            return { signupCmd };
+        }
+        else {
+            return cmdUsageErr(execName, infoCmd.name);
+        }
+    }
+    else if (args[0] === listTokensCmd.name) {
+        const signupCmd = parseWithConfFile(args.slice(1), listTokensOpts);
+        if (signupCmd) {
+            signupCmd.listTokens = true;
+            return { signupCmd };
+        }
+        else {
+            return cmdUsageErr(execName, listTokensCmd.name);
+        }
+    }
+    else if (args[0] === showTokenCmd.name) {
+        const signupCmd = parseWithConfFile(args.slice(1), showTokenOpts);
+        if (signupCmd) {
+            if (!signupCmd.token) {
+                return cmdUsageErr(execName, showTokenCmd.name, `missing token`);
+            }
+            signupCmd.showToken = true;
+            return { signupCmd };
+        }
+        else {
+            return cmdUsageErr(execName, showTokenCmd.name);
+        }
+    }
+    else if (args[0] === createTokenCmd.name) {
+        console.log(args);
+        const signupCmd = parseWithConfFile(args.slice(1), createTokenOpts);
+        if (signupCmd) {
+            if (!signupCmd.domain && !signupCmd.user) {
+                return cmdUsageErr(execName, createTokenCmd.name, `either user address, or domain(s) should be given`);
+            }
+            signupCmd.createToken = true;
+            return { signupCmd };
+        }
+        else {
+            return cmdUsageErr(execName, createTokenCmd.name);
+        }
+    }
+    else {
+        const opts = (0, utils_1.parseArgv)(args, [utils_1.helpOpt], { partial: true });
+        if (opts.help) {
+            return (0, utils_1.toUsageDisplay)(0, signupUsage(execName));
+        }
+        return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(signupUsage(execName), `Unknown command '${args[0]}'`));
+    }
+}
+exports.parseSignupArgs = parseSignupArgs;
+Object.freeze(exports);

package/build/config/cli/user-cmd.d.ts

@@ -0,0 +1,9 @@
+import { CliUsageDisplay, CommandDef } from "./utils";
+export declare const userCmd: CommandDef<'user'>;
+export interface ParsedUserArgs {
+    listAll?: true;
+}
+export declare function parseSignupArgs(args: string[], execName: string): {
+    userCmd?: ParsedUserArgs;
+    showUsage?: CliUsageDisplay;
+};

package/build/config/cli/user-cmd.js

@@ -0,0 +1,55 @@
+"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.parseSignupArgs = exports.userCmd = void 0;
+const utils_1 = require("./utils");
+exports.userCmd = {
+    name: 'user',
+    summary: 'provides information about existing users'
+};
+const listCmd = {
+    name: 'list',
+    summary: `lists users`
+};
+function userUsage(execName) {
+    return [
+        {
+            header: execName,
+            content: `Server of all 3NWeb utilities: MailerId, ASMail, 3NStorage.`
+        },
+        {
+            header: `Usage:`,
+            content: `${execName} user [command]`
+        },
+        {
+            header: 'Available commands:',
+            content: []
+        },
+        {
+            content: `Use "${execName} user [command] --help" for more information about a command.`
+        }
+    ];
+}
+function parseSignupArgs(args, execName) {
+    if (args.length === 0) {
+        return (0, utils_1.toUsageDisplay)(0, userUsage(execName));
+    }
+    // XXX
+    return {};
+}
+exports.parseSignupArgs = parseSignupArgs;

package/build/config/cli/utils.d.ts

@@ -0,0 +1,45 @@
+export interface CommandDef<T extends string> {
+    name: T;
+    summary: string;
+}
+export interface OptionDef {
+    name: string;
+    type: (typeof Boolean) | (typeof String) | (typeof Number) | ((value: string) => any);
+    alias?: string;
+    description?: string;
+    typeLabel?: string;
+    multiple?: boolean;
+    defaultOption?: boolean;
+}
+export interface UsageSection {
+    header?: string;
+    summary?: string;
+    optionList?: OptionDef[];
+    content?: string | UsageSectionContent | (string | UsageSection)[];
+}
+export interface UsageSectionContent {
+    options: any;
+    data: any;
+}
+export interface ParseOptions {
+    argv?: string[];
+    partial?: boolean;
+    stopAtFirstUnknown?: boolean;
+    camelCase?: boolean;
+    caseInsensitive?: boolean;
+}
+export interface CliUsageDisplay {
+    txtToDisplay: string;
+    exitStatus: number;
+}
+export declare const helpOpt: OptionDef;
+export interface HelpArg {
+    help?: boolean;
+}
+export declare function toUsageDisplay(exitStatus: number, usage: UsageSection[]): {
+    showUsage: CliUsageDisplay;
+};
+export declare function parseArgv<T>(argv: string[], argOpts: OptionDef[], opts?: ParseOptions): T & {
+    _unknown?: string[];
+};
+export declare function toErrorUsage(usage: UsageSection[], errTxt: string): UsageSection[];

package/build/config/cli/utils.js

@@ -0,0 +1,52 @@
+"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.toErrorUsage = exports.parseArgv = exports.toUsageDisplay = exports.helpOpt = void 0;
+const commandLineArgs = require("command-line-args");
+const commandLineUsage = require("command-line-usage");
+exports.helpOpt = {
+    name: 'help',
+    alias: 'h',
+    type: Boolean,
+    description: 'shows help'
+};
+function toUsageDisplay(exitStatus, usage) {
+    return {
+        showUsage: {
+            txtToDisplay: commandLineUsage(usage),
+            exitStatus
+        }
+    };
+}
+exports.toUsageDisplay = toUsageDisplay;
+function parseArgv(argv, argOpts, opts) {
+    if (opts) {
+        opts.argv = argv;
+    }
+    else {
+        opts = { argv };
+    }
+    return commandLineArgs(argOpts, opts);
+}
+exports.parseArgv = parseArgv;
+function toErrorUsage(usage, errTxt) {
+    usage[0] = { content: errTxt };
+    return usage;
+}
+exports.toErrorUsage = toErrorUsage;
+Object.freeze(exports);

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

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

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;