core-3nweb-client-lib 0.34.1 → 0.35.0

package/build/api-defs/asmail.d.ts

@@ -1,5 +1,5 @@
 /*
- Copyright (C) 2016, 2020, 2022, 2024 3NSoft Inc.
+ Copyright (C) 2016, 2020, 2022, 2024 - 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,9 @@
  * This is a namespace for things used by mail functionality.
  */
 declare namespace web3n.asmail {
-	
+
 	interface Service {
-		
+
 		/**
 		 * This returns a promise resolvable to id (address) of a current signed
 		 * user.
@@ -29,9 +29,11 @@ declare namespace web3n.asmail {
 		getUserId(): Promise<string>;
 
 		inbox: InboxService;
-		
+	
 		delivery: DeliveryService;
 
+		config: ASMailConfigService;
+
 	}
 
 	interface DeliveryProgress {
@@ -56,7 +58,7 @@ declare namespace web3n.asmail {
 		};
 	}
 
-	type DeliveryException = ASMailSendException | ServLocException | ASMailSendException;
+	type DeliveryException = ASMailSendException | ServLocException;
 
 	interface DeliveryOptions {
 		/**
@@ -319,4 +321,67 @@ declare namespace web3n.asmail {
 		msgCancelled?: true;
 	}
 
+	interface ASMailConfigService {
+		getOnServer<P extends keyof ASMailConfigParams>(
+			param: P
+		): Promise<ASMailConfigParams[P]|null>;
+		setOnServer<P extends keyof ASMailConfigParams>(
+			param: P,
+			value: ASMailConfigParams[P]|null
+		): Promise<void>;
+	}
+
+	interface ASMailConfigParams {
+
+		/**
+		 * Introductory public key certificate chain, published on ASMail server for
+		 * anyone to initiate messaging with the user.
+		 */
+		"init-pub-key": keys.PKeyCertChain;
+
+		/**
+		 * Policy that ASMail server should follow with messages from senders
+		 * authenticated to server.
+		 */
+		"auth-sender/policy": {
+			acceptWithInvitesOnly: boolean;
+			acceptFromWhiteListOnly: boolean;
+			applyBlackList: boolean;
+			defaultMsgSize: number;
+		};
+
+		"auth-sender/whitelist": AddressesList;
+		"auth-sender/blacklist": AddressesList;
+		"auth-sender/invites": InvitesList;
+
+		/**
+		 * Policy that ASMail server should follow with messages from senders
+		 * anonymous to server.
+		 */
+		"anon-sender/policy": {
+			accept: boolean;
+			acceptWithInvitesOnly: boolean;
+			defaultMsgSize: number;
+		};
+
+		"anon-sender/invites": InvitesList;
+
+	}
+
+	/**
+	 * Addresses list is a map from addresses to respective maximum message size
+	 * in bytes.
+	 */
+	interface AddressesList {
+		[address: string]: number;
+	}	
+
+	/**
+	 * Invites list is a map from invites to respective maximum message size in
+	 * bytes.
+	 */
+	interface InvitesList {
+		[invite: string]: number;
+	}	
+
 }

package/build/api-defs/common-caps.d.ts

@@ -29,6 +29,7 @@ declare namespace web3n.caps.common {
 	type DevPathChecker = (path: string) => 'w'|'r'|false;
 
 	interface RequestedCAPs {
+		keyrings?: 'all';
 		mail?: MailCAPSetting;
 		storage?: StorageCAPSetting;
 		mailerid?: true;
@@ -63,6 +64,7 @@ declare namespace web3n.caps.common {
 	interface MailCAPSetting {
 		sendingTo?: 'all' | { whitelist: string[]; };
 		receivingFrom?: 'all' | { whitelist: string[]; };
+		config?: 'all';
 	}
 
 	interface W3N {
@@ -70,6 +72,7 @@ declare namespace web3n.caps.common {
 		mail?: asmail.Service;
 		storage?: storage.Service;
 		mailerid?: mailerid.Service;
+		keyrings?: keys.Keyrings;
 	}
 
 	type Logger = (

package/build/api-defs/keys.d.ts

@@ -0,0 +1,154 @@
+/*
+ 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/>.
+*/
+
+declare namespace web3n.keys {
+
+	interface JsonKeyShort {
+		/**
+		 * This is a base64 representation of key's bytes.
+		 */
+		k: string;
+		/**
+		 * This is key's id.
+		 */
+		kid: string;
+	}
+
+	interface JsonKey extends JsonKeyShort {
+		/**
+		 * This field is indicates application's use of this key, for example,
+		 * "private-mail-key". Notice that it has noting to do with crypto 
+		 * primitives, and everything to do with how key should be used by
+		 *  applications, that should check this field, so as to guard against
+		 *  miss-use of key material. Such strictness makes key reuse (bad security
+		 *  design) difficult. 
+		 */
+		use: string;
+		/**
+		 * This field indicates which crypto-box high level function should be used
+		 * with this key, for example, "NaCl-xsp-box". Notice that, unlike initial
+		 * JWK standard, alg is not for naming crypto primitive, because you,
+		 * developer, should use complete functionality, like that provided by NaCl,
+		 * and you should not be dealing with crypto primitives. Crypto primitives
+		 * are for libs, that should be written by cryptographers. If cryptographer
+		 * gives you only primitives, it is the same as car dealer giving you parts
+		 * for the car instead of an actual car. Your would call dealer's bullshit,
+		 * and you must call cryptographer's one as well. They, cryptographer, in a
+		 * 2nd decade of the 21st centure have no excuse to give us, developers,
+		 * incomplete libs with mere crypto primitives, which hurt, when assembled
+		 * incorrectly.
+		 */
+		alg: string;
+	}
+
+	interface Key {
+		/**
+		 * This is key's bytes.
+		 */
+		k: Uint8Array;
+		/**
+		 * This is key's id.
+		 */
+		kid: string;
+		/**
+		 * This field is indicates application's use of this key, for example,
+		 * "private-mail-key". Notice that it has noting to do with crypto 
+		 * primitives, and everything to do with how key should be used by
+		 *  applications, that should check this field, so as to guard against
+		 *  miss-use of key material. Such strictness makes key reuse (bad security
+		 *  design) difficult. 
+		 */
+		use: string;
+		/**
+		 * This field indicates which crypto-box high level function should be used
+		 * with this key, for example, "NaCl-xsp-box". Notice that, unlike initial
+		 * JWK standard, alg is not for naming crypto primitive, because you,
+		 * developer, should use complete functionality, like that provided by NaCl,
+		 * and you should not be dealing with crypto primitives. Crypto primitives
+		 * are for libs, that should be written by cryptographers. If cryptographer
+		 * gives you only primitives, it is the same as car dealer giving you parts
+		 * for the car instead of an actual car. Your would call dealer's bullshit,
+		 * and you must call cryptographer's one as well. They, cryptographer, in a
+		 * 2nd decade of the 21st centure have no excuse to give us, developers,
+		 * incomplete libs with mere crypto primitives, which hurt, when assembled
+		 * incorrectly.
+		 */
+		alg: string;
+	}
+
+	interface SignedLoad {
+		/**
+		 * This is a function/algorithm, used to make signature.
+		 */
+		alg: string;
+		/**
+		 * This is an id of a key that did the signature.
+		 */
+		kid: string;
+		/**
+		 * This is signature bytes, packed into base64 string.
+		 */
+		sig: string;
+		/**
+		 * This is bytes (packed into base64 string), on which signature was done.
+		 */
+		load: string;
+	}
+
+	interface KeyCert {
+		cert: {
+			publicKey: JsonKey;
+			principal: { address: string };
+		};
+		issuer: string;
+		issuedAt: number;
+		expiresAt: number;
+	}
+
+	interface Keyrings {
+
+		introKeyToPublishOnASMailServer: IntroKeyOnASMailServer;
+
+	}
+
+	interface IntroKeyOnASMailServer {
+
+		/**
+		 * Returns introductory key certificates chain that should be published on
+		 * ASMail server, and undefined, if there should be nothing on the server.
+		 */
+		getCurrent(): Promise<PKeyCertChain|undefined>;
+
+		remove(): Promise<void>;
+
+		makeNew(): Promise<PKeyCertChain>;
+
+	}
+
+	interface PKeyCertChain {
+		pkeyCert: keys.SignedLoad;
+		userCert: keys.SignedLoad;
+		provCert: keys.SignedLoad;
+	}
+
+	interface MailerIdAssertion {
+		assertion: keys.SignedLoad;
+		userCert: keys.SignedLoad;
+		provCert: keys.SignedLoad;
+	}
+
+}

package/build/api-defs/mailerid.d.ts

@@ -26,4 +26,12 @@ declare namespace web3n.mailerid {
 
 	}
 
+	interface MailerIdAssertionLoad {
+		user: string;
+		rpDomain: string;
+		sessionId: string;
+		issuedAt: number;
+		expiresAt: number;
+	}
+
 }

package/build/api-defs/web3n.d.ts

@@ -16,6 +16,7 @@
 */
 
 /// <reference path="./asmail.d.ts" />
+/// <reference path="./keys.d.ts" />
 /// <reference path="./common-caps.d.ts" />
 /// <reference path="./files.d.ts" />
 /// <reference path="./mailerid.d.ts" />

package/build/core/asmail/asmail-cap-ipc.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2020 - 2023 3NSoft Inc.
+ Copyright (C) 2020 - 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
@@ -26,6 +26,8 @@ const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const fs_1 = require("../../core-ipc/fs");
 const utils_for_observables_1 = require("../../lib-common/utils-for-observables");
+const caller_side_wrap_1 = require("../../core-ipc/json-ipc-wrapping/caller-side-wrap");
+const service_side_wrap_1 = require("../../core-ipc/json-ipc-wrapping/service-side-wrap");
 function exposeASMailCAP(cap, expServices) {
     const out = cap.delivery;
     const box = cap.inbox;
@@ -46,6 +48,7 @@ function exposeASMailCAP(cap, expServices) {
             removeMsg: removeMsg.wrapService(box.removeMsg),
             subscribe: inboxSubscribe.wrapService(box.subscribe, expServices)
         },
+        config: exposeCofigCAP(cap.config)
     };
 }
 function makeASMailCaller(caller, objPath) {
@@ -68,6 +71,7 @@ function makeASMailCaller(caller, objPath) {
             removeMsg: removeMsg.makeCaller(caller, inboxPath),
             subscribe: inboxSubscribe.makeCaller(caller, inboxPath)
         },
+        config: makeConfigCaller(caller, objPath.concat('config'))
     };
 }
 var getUserId;
@@ -553,4 +557,19 @@ var observeDelivery;
     observeDelivery.makeCaller = makeCaller;
 })(observeDelivery || (observeDelivery = {}));
 Object.freeze(observeDelivery);
+function exposeCofigCAP(cap) {
+    return {
+        getOnServer: (0, service_side_wrap_1.wrapReqReplySrvMethod)(cap, 'getOnServer'),
+        setOnServer: (0, service_side_wrap_1.wrapReqReplySrvMethod)(cap, 'setOnServer')
+    };
+}
+function callConfig(caller, objPath, method) {
+    return (0, caller_side_wrap_1.makeReqRepObjCaller)(caller, objPath, method);
+}
+function makeConfigCaller(caller, objPath) {
+    return {
+        getOnServer: callConfig(caller, objPath.concat('getOnServer'), 'getOnServer'),
+        setOnServer: callConfig(caller, objPath.concat('setOnServer'), 'setOnServer')
+    };
+}
 Object.freeze(exports);

package/build/core/asmail/config.d.ts

@@ -0,0 +1,16 @@
+import { ServiceLocator } from '../../lib-client/service-locator';
+import { ParamOnServer } from '../../lib-client/asmail/service-config';
+import { GetSigner } from '../id-manager';
+import { NetClient } from '../../lib-client/request-utils';
+type Service = web3n.asmail.ASMailConfigService;
+type ASMailConfigParams = web3n.asmail.ASMailConfigParams;
+/**
+ * Instance of this class updates and checks setting of ASMail server.
+ */
+export declare class ConfigOfASMailServer {
+    private readonly serverConfig;
+    constructor(address: string, getSigner: GetSigner, resolver: ServiceLocator, net: NetClient);
+    makeParamSetterAndGetter<P extends keyof ASMailConfigParams>(param: P): ParamOnServer<P>;
+    makeCAP(): Service;
+}
+export {};

package/build/core/asmail/config.js

@@ -0,0 +1,43 @@
+"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.ConfigOfASMailServer = void 0;
+const service_config_1 = require("../../lib-client/asmail/service-config");
+/**
+ * Instance of this class updates and checks setting of ASMail server.
+ */
+class ConfigOfASMailServer {
+    constructor(address, getSigner, resolver, net) {
+        this.serverConfig = new service_config_1.MailConfigurator(address, getSigner, () => resolver(this.serverConfig.userId), net);
+        Object.freeze(this);
+    }
+    makeParamSetterAndGetter(param) {
+        return this.serverConfig.makeParamSetterAndGetter(param);
+    }
+    makeCAP() {
+        const w = {
+            getOnServer: this.serverConfig.getParam.bind(this.serverConfig),
+            setOnServer: this.serverConfig.setParam.bind(this.serverConfig)
+        };
+        return Object.freeze(w);
+    }
+}
+exports.ConfigOfASMailServer = ConfigOfASMailServer;
+Object.freeze(ConfigOfASMailServer.prototype);
+Object.freeze(ConfigOfASMailServer);
+Object.freeze(exports);

package/build/core/asmail/delivery/common.d.ts

@@ -2,8 +2,7 @@ import { GetSigner } from '../../id-manager';
 import { AsyncSBoxCryptor } from 'xsp-files';
 import { SendingParams, SuggestedNextKeyPair } from '../msg/common';
 import { Encryptor } from '../../../lib-common/async-cryptor-wrap';
-import { JsonKey } from '../../../lib-common/jwkeys';
-import { ASMailKeyPair } from '../keyring/common';
+import { ASMailKeyPair } from '../../keyring/common';
 import { NetClient } from '../../../lib-client/request-utils';
 import { LogWarning, LogError } from '../../../lib-client/logging/log-to-file';
 import { ServiceLocator } from '../../../lib-client/service-locator';
@@ -13,6 +12,7 @@ type DeliveryOptions = web3n.asmail.DeliveryOptions;
 type AttachmentsContainer = web3n.asmail.AttachmentsContainer;
 type FS = web3n.files.FS;
 type WritableFS = web3n.files.WritableFS;
+type JsonKey = web3n.keys.JsonKey;
 export declare class Attachments {
     container: AttachmentsContainer | undefined;
     fs: FS | undefined;

package/build/core/asmail/delivery/common.js

@@ -13,7 +13,8 @@
  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 });
 exports.SEG_SIZE_IN_K_QUATS = exports.Attachments = void 0;
 exports.estimatePackedSizeOf = estimatePackedSizeOf;

package/build/core/asmail/delivery/index.d.ts

@@ -23,7 +23,7 @@ export declare class Delivery {
     private readonly allDeliveries$;
     private constructor();
     static makeAndStart(fs: WritableFS, r: ResourcesForSending): Promise<Delivery>;
-    wrap(): DeliveryService;
+    makeCAP(): DeliveryService;
     private restartDeliveryOfMsgsAtStartup;
     observeDelivery(id: string, observer: Observer<DeliveryProgress>): () => void;
     observeAllDeliveries(observer: Observer<{
@@ -38,5 +38,6 @@ export declare class Delivery {
     private listMsgs;
     private rmMsg;
     private currentState;
+    close(): Promise<void>;
 }
 export {};

package/build/core/asmail/delivery/index.js

@@ -63,7 +63,7 @@ class Delivery {
         await delivery.restartDeliveryOfMsgsAtStartup();
         return delivery;
     }
-    wrap() {
+    makeCAP() {
         const service = {
             addMsg: this.addMsg.bind(this),
             currentState: this.currentState.bind(this),
@@ -261,6 +261,9 @@ class Delivery {
         }
         return msg.progress;
     }
+    async close() {
+        // XXX what should we have here, with potentially still running sending ?
+    }
 }
 exports.Delivery = Delivery;
 Object.freeze(Delivery.prototype);

package/build/core/asmail/delivery/per-recipient-wip.js

@@ -14,7 +14,7 @@
  
  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.WIP = void 0;
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");

package/build/core/asmail/inbox/attachments/fs.d.ts

@@ -1,4 +1,4 @@
-import { StorageGetter, FolderInJSON } from '../../../../lib-client/3nstorage/xsp-fs/common';
+import { StorageGetter, FolderInJSON } from '../../../../lib-client/xsp-fs/common';
 import { AsyncSBoxCryptor } from 'xsp-files';
 import { MsgOnDisk } from '../msg-on-disk';
 import { LogError } from '../../../../lib-client/logging/log-to-file';

package/build/core/asmail/inbox/attachments/fs.js

@@ -17,8 +17,8 @@
 */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fsForAttachments = fsForAttachments;
-const common_1 = require("../../../../lib-client/3nstorage/xsp-fs/common");
-const fs_1 = require("../../../../lib-client/3nstorage/xsp-fs/fs");
+const common_1 = require("../../../../lib-client/xsp-fs/common");
+const fs_1 = require("../../../../lib-client/xsp-fs/fs");
 class AttachmentStore {
     constructor(msg, getStorages, cryptor, logError) {
         this.msg = msg;

package/build/core/asmail/inbox/index.d.ts

@@ -1,10 +1,8 @@
-import { StorageGetter } from '../../../lib-client/3nstorage/xsp-fs/common';
+import { StorageGetter } from '../../../lib-client/xsp-fs/common';
 import { ServiceLocator } from '../../../lib-client/service-locator';
 import { OpenedMsg } from '../msg/opener';
-import { MsgKeyInfo } from '../keyring';
-import * as confApi from '../../../lib-common/service-api/asmail/config';
+import { MsgKeyInfo } from '../../keyring';
 import * as delivApi from '../../../lib-common/service-api/asmail/delivery';
-import { JsonKey } from '../../../lib-common/jwkeys';
 import { GetSigner } from '../../id-manager';
 import { LogError } from '../../../lib-client/logging/log-to-file';
 import { AsyncSBoxCryptor } from 'xsp-files';
@@ -12,6 +10,8 @@ import { SendingParams } from '../msg/common';
 import { NetClient } from '../../../lib-client/request-utils';
 type WritableFS = web3n.files.WritableFS;
 type InboxService = web3n.asmail.InboxService;
+type JsonKey = web3n.keys.JsonKey;
+type PKeyCertChain = web3n.keys.PKeyCertChain;
 export interface ResourcesForReceiving {
     address: string;
     getSigner: GetSigner;
@@ -38,7 +38,7 @@ export interface ResourcesForReceiving {
          * object.
          * @param checkMidKeyCerts is a certifying function for MailerId certs.
          */
-        msgDecryptor: (msgMeta: delivApi.msgMeta.CryptoInfo, getMainObjHeader: () => Promise<Uint8Array>, getOpenedMsg: (mainObjFileKey: Uint8Array, msgKeyPackLen: number) => Promise<OpenedMsg>, checkMidKeyCerts: (certs: confApi.p.initPubKey.Certs) => Promise<{
+        msgDecryptor: (msgMeta: delivApi.msgMeta.CryptoInfo, getMainObjHeader: () => Promise<Uint8Array>, getOpenedMsg: (mainObjFileKey: Uint8Array, msgKeyPackLen: number) => Promise<OpenedMsg>, checkMidKeyCerts: (certs: PKeyCertChain) => Promise<{
             pkey: JsonKey;
             address: string;
         }>) => Promise<{
@@ -85,7 +85,7 @@ export declare class InboxOnServer {
     private constructor();
     static makeAndStart(cachePath: string, syncedFS: WritableFS, r: ResourcesForReceiving): Promise<InboxOnServer>;
     close(): Promise<void>;
-    wrap(): InboxService;
+    makeCAP(): InboxService;
     private removeMsg;
     private removeMsgFromServerAndCache;
     private msgFromDiskOrDownload;

package/build/core/asmail/inbox/index.js

@@ -72,7 +72,7 @@ class InboxOnServer {
     async close() {
         this.index.stopSyncing();
     }
-    wrap() {
+    makeCAP() {
         const service = {
             getMsg: this.getMsg.bind(this),
             listMsgs: this.listMsgs.bind(this),

package/build/core/asmail/inbox/msg-indexing/index.d.ts

@@ -1,4 +1,4 @@
-import { MsgKeyInfo, MsgKeyRole } from '../../keyring';
+import { MsgKeyInfo, MsgKeyRole } from '../../../keyring';
 type WritableFS = web3n.files.WritableFS;
 type MsgInfo = web3n.asmail.MsgInfo;
 /**

package/build/core/asmail/inbox/msg-indexing/logs-n-entries.d.ts

@@ -1,4 +1,4 @@
-import { MsgKeyInfo, MsgKeyRole } from '../../keyring';
+import { MsgKeyInfo, MsgKeyRole } from '../../../keyring';
 type WritableFS = web3n.files.WritableFS;
 type MsgInfo = web3n.asmail.MsgInfo;
 interface MsgOpenedLog {

package/build/core/asmail/index.d.ts

@@ -1,5 +1,7 @@
+import { KeyringForASMail } from '../keyring';
+import { ConfigOfASMailServer } from './config';
 import { InboxPathForUser } from '../app-files';
-import { StorageGetter } from '../../lib-client/3nstorage/xsp-fs/common';
+import { StorageGetter } from '../../lib-client/xsp-fs/common';
 import { GetSigner } from '../id-manager';
 import { AsyncSBoxCryptor } from 'xsp-files';
 import { Logger } from '../../lib-client/logging/log-to-file';
@@ -20,9 +22,7 @@ export declare class ASMail {
     private config;
     private sendingParams;
     constructor(cryptor: AsyncSBoxCryptor, makeNet: MakeNet, inboxPathForUser: InboxPathForUser, logger: Logger);
-    init(address: string, getSigner: GetSigner, syncedFS: WritableFS, localFS: WritableFS, getStorages: StorageGetter, makeResolver: ServiceLocatorMaker): Promise<void>;
-    private setupConfig;
-    private setupKeyring;
+    init(address: string, getSigner: GetSigner, syncedFS: WritableFS, localFS: WritableFS, getStorages: StorageGetter, makeResolver: ServiceLocatorMaker, config: ConfigOfASMailServer, keyring: KeyringForASMail): Promise<void>;
     private setupSendingParams;
     private setupDelivery;
     private setupInbox;