spec-3nweb-server 1.7.9 → 1.7.12

package/README.md

@@ -7,9 +7,9 @@ Thus, we call it a spec server.
 Main purpose of this server is to ensure that 3NWeb protocols are implementable, and to be a testbed for possible new features.
 Secondary purpose of this server is to be packagable into a home-class server, i.e. server that can be run from a single machine.
 
-## Usage
+## Build & Test
 
-To use this repo, you need [Node.js](https://nodejs.org/) with [Typescript](http://www.typescriptlang.org/), installed globally to Node.js (with flag `-g`).
+To use this repo, you need [Node.js](https://nodejs.org/).
 
 When in the project's folder, run
 ```
@@ -32,6 +32,20 @@ Config file is `src/tests/jasmine.ts`.
 
 Please note, that support for running server on windows hasn't been introduced, yet.
 
+## ASMail (Authenticated Secure Mail) protocol overview
+
+```mermaid
+flowchart LR
+	C@{ shape: hex, label: "customer#64;x.y.z" } -- anonymous <br> connection --> VS@{ shape: lin-cyl, label: "ASMail service for a.b.c" }
+	V@{ shape: hex, label: "vendor#64;a.b.c" } -- anonymous <br> connection --> CS@{ shape: lin-cyl, label: "ASMail service for x.y.z" }
+	subgraph cg[" "]
+		CS -- owner <br> connection --> C
+	end
+	subgraph vg[" "]
+		VS -- owner <br> connection --> V
+	end
+```
+
 # License
 
 Code is provided here under GNU General Public License, version 3.

package/build/asmail/resources/inbox.js

@@ -370,7 +370,7 @@ class Inbox extends user_files_1.UserFiles {
         }
     }
     async setAuthSenderBlacklist(lst) {
-        if (isValidBalacklist(lst)) {
+        if (isValidBlacklist(lst)) {
             await this.setParam('authenticated/blacklist', lst);
             return true;
         }
@@ -435,7 +435,7 @@ function isValidListWithMsgMaxSizes(lst) {
     }
     return true;
 }
-function isValidBalacklist(lst) {
+function isValidBlacklist(lst) {
     return ('object' === typeof lst) && !!lst;
 }
 class ObjFiles {

package/build/asmail/resources/recipients.js

@@ -86,22 +86,26 @@ async function adaptToFreeSpaceLeft(inbox, msgSize) {
  */
 async function allowedMsgSizeForAnonSender(inbox, invitation) {
     const policy = await inbox.getParam('anonymous/policy');
-    if (!policy.accept) {
-        return 0;
-    }
-    if (!invitation) {
+    if (policy.accept) {
+        // XXX this misses case when invite allows for bigger messages,
+        //     while without invite messages are also allowed.
         if (policy.acceptWithInvitesOnly) {
-            return 0;
+            if (invitation) {
+                const invites = await inbox.getParam('anonymous/invites');
+                const sizeForInvite = invites[invitation];
+                return ((typeof sizeForInvite === 'number') ?
+                    adaptToFreeSpaceLeft(inbox, sizeForInvite) : 0);
+            }
+            else {
+                return 0;
+            }
+        }
+        else {
+            return await adaptToFreeSpaceLeft(inbox, policy.defaultMsgSize);
         }
-        return await adaptToFreeSpaceLeft(inbox, policy.defaultMsgSize);
     }
     else {
-        const invites = await inbox.getParam('anonymous/invites');
-        const sizeForInvite = invites[invitation];
-        if (typeof sizeForInvite !== 'number') {
-            return 0;
-        }
-        return adaptToFreeSpaceLeft(inbox, sizeForInvite);
+        return 0;
     }
 }
 /**

package/build/config/cli/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2023 3NSoft Inc.
+ Copyright (C) 2023, 2025 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
@@ -17,7 +17,7 @@
 */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseProcessArgv = void 0;
-const path_1 = require("path");
+const default_confs_1 = require("../default-confs");
 const run_cmd_1 = require("./run-cmd");
 const signup_cmd_1 = require("./signup-cmd");
 const utils_1 = require("./utils");
@@ -46,22 +46,21 @@ function mainUsage(execName) {
 }
 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));
+        return (0, utils_1.toUsageDisplay)(0, mainUsage(default_confs_1.EXECUTABLE_NAME));
     }
     if (args[0] === run_cmd_1.runCmd.name) {
-        return (0, run_cmd_1.parseRunArgs)(args.slice(1), execName);
+        return (0, run_cmd_1.parseRunArgs)(args.slice(1), default_confs_1.EXECUTABLE_NAME);
     }
     else if (args[0] === signup_cmd_1.signupCmd.name) {
-        return (0, signup_cmd_1.parseSignupArgs)(args.slice(1), execName);
+        return (0, signup_cmd_1.parseSignupArgs)(args.slice(1), default_confs_1.EXECUTABLE_NAME);
     }
     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)(0, mainUsage(default_confs_1.EXECUTABLE_NAME));
         }
-        return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(mainUsage(execName), `Unknown command '${args[0]}'`));
+        return (0, utils_1.toUsageDisplay)(-1, (0, utils_1.toErrorUsage)(mainUsage(default_confs_1.EXECUTABLE_NAME), `Unknown command '${args[0]}'`));
     }
 }
 exports.parseProcessArgv = parseProcessArgv;

package/build/config/default-confs.d.ts

@@ -0,0 +1,3 @@
+export declare const EXECUTABLE_NAME = "3nweb";
+export declare const DEFAULT_DATA_ROOT_PATH = "/var/3nweb";
+export declare const DEFAULT_CONFIG_PATH = "/etc/3nweb/conf.yaml";

package/build/config/default-confs.js

@@ -0,0 +1,22 @@
+"use strict";
+/*
+ Copyright (C) 2025 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.DEFAULT_CONFIG_PATH = exports.DEFAULT_DATA_ROOT_PATH = exports.EXECUTABLE_NAME = void 0;
+exports.EXECUTABLE_NAME = '3nweb';
+exports.DEFAULT_DATA_ROOT_PATH = '/var/3nweb';
+exports.DEFAULT_CONFIG_PATH = `/etc/3nweb/conf.yaml`;

package/build/config/from-yaml.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2023 3NSoft Inc.
+ Copyright (C) 2023, 2025 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
@@ -19,9 +19,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readYamlConfFile = void 0;
 const fs_1 = require("fs");
 const yaml = require("js-yaml");
+const default_confs_1 = require("./default-confs");
 function readYamlConfFile(path) {
     const txt = (0, fs_1.readFileSync)(path, 'utf8');
     const conf = yaml.load(txt);
+    if (conf.rootFolder) {
+        conf.rootFolder = default_confs_1.DEFAULT_DATA_ROOT_PATH;
+    }
     return conf;
 }
 exports.readYamlConfFile = readYamlConfFile;

package/build/lib-common/async-fs-node.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import * as fs from 'fs';
 import { Readable, Writable } from 'stream';
 export { Stats } from 'fs';

package/build/lib-common/buffer-utils.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 export declare const EMPTY_BUFFER: Buffer;
 /**
  * Buffer and Uint8Array are intimately linked in Node, starting with some

package/build/lib-common/objs-on-disk/file-layout.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Layout } from "xsp-files";
 export interface HeaderChunkInfo {
     len: number;

package/build/lib-common/objs-on-disk/v1-obj-file-format.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { HeaderChunkInfo, SegsChunk } from "./file-layout";
 export declare const V1_FILE_START: Buffer;
 /**

package/build/main.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/build/main.js

@@ -1,6 +1,7 @@
+#!/usr/bin/env node
 "use strict";
 /*
- Copyright (C) 2015 - 2016, 2019 3NSoft Inc.
+ Copyright (C) 2015 - 2016, 2019, 2025 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
@@ -21,6 +22,7 @@ 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");
+const default_confs_1 = require("./config/default-confs");
 async function run(conf) {
     if (!conf.servicesConnect) {
         console.error(`No connection settings found in ??.`);
@@ -112,12 +114,11 @@ function showUsage({ txtToDisplay, exitStatus }) {
     process.exit(exitStatus);
 }
 function assembleConfig(configPath) {
-    if (configPath) {
-        return (0, from_yaml_1.readYamlConfFile)(configPath);
-    }
-    else {
-        throw new Error(`Config path must be given`);
+    if (!configPath) {
+        configPath = default_confs_1.DEFAULT_CONFIG_PATH;
+        console.log(`Looking for configuration in default location: ${configPath}`);
     }
+    return (0, from_yaml_1.readYamlConfFile)(configPath);
 }
 async function displaySignupInfo(conf) {
     if (!conf.signup) {

package/build/signup/signup-tokens.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 export type SignupContext = SingleUserSignupCtx | MultiDomainSignupCtx;
 export interface SingleUserSignupCtx {
     token: string;

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "spec-3nweb-server",
-  "version": "1.7.9",
+  "version": "1.7.12",
   "description": "3NWeb spec server.",
   "main": "build/lib.js",
   "types": "build/lib.d.ts",
+  "bin": {
+    "3nweb": "build/main.js"
+  },
   "scripts": {
     "build": "tsc -p ts-code",
+    "server": "node build/main.js",
     "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": "pkg --config package.json build/main.js",
+    "pack": "echo unimplemented",
     "pack-deb": "npm run pack && bash packing/create-deb.sh",
     "postinstall": "node -e \"try{require('./postinstall')}catch(e){}\""
   },
@@ -47,16 +51,9 @@
     "@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"
 }