core-3nweb-client-lib 0.37.3 → 0.38.1

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

@@ -123,6 +123,10 @@ declare namespace web3n.keys {
 
 		introKeyOnASMailServer: IntroKeyOnASMailServer;
 
+		getCorrespondentKeys: (
+			correspondentAddr: string
+		) => Promise<CorrespondentKeysInfo|undefined>;
+
 	}
 
 	interface IntroKeyOnASMailServer {
@@ -151,4 +155,45 @@ declare namespace web3n.keys {
 		provCert: keys.SignedLoad;
 	}
 
+	interface CorrespondentKeysInfo {
+		sendingPair: IntroductorySendingPairInfo|RatchetedSendingPairInfo|null;
+		receptionPairs: {
+			suggested: ReceptionPairInfo|null;
+			inUse: ReceptionPairInfo|null;
+			old: ReceptionPairInfo|null;
+		};
+	}
+
+	interface IntroductorySendingPairInfo {
+		type: 'intro';
+		recipientKId: string;
+		alg: string;
+	}
+
+	interface RatchetedSendingPairInfo {
+		type: 'ratcheted';
+		pids: string[];
+		timestamp: number;
+		alg: string;
+		senderKId: string;
+		recipientKId: string;
+		sentMsgs?: {
+			count: number;
+			lastTS: number;
+		};
+	}
+
+	interface ReceptionPairInfo {
+		pids: string[];
+		alg: string;
+		recipientKId: string;
+		isSenderIntroKey?: boolean,
+		senderKId: string;
+		receivedMsgs?: {
+			counts: number[][];
+			lastTS: number;
+		};
+		timestamp: number;
+	}
+
 }

package/build/core/keyring/correspondent-keys.d.ts

@@ -8,6 +8,7 @@ import { Decryptor } from '../../lib-common/async-cryptor-wrap';
 import { AsyncSBoxCryptor } from 'xsp-files';
 type JsonKey = web3n.keys.JsonKey;
 type JsonKeyShort = web3n.keys.JsonKeyShort;
+type CorrespondentKeysInfo = web3n.keys.CorrespondentKeysInfo;
 export interface ReceptionPair {
     pids: string[];
     recipientKey: JWKeyPair;
@@ -20,23 +21,6 @@ export interface ReceptionPair {
     };
     timestamp: number;
 }
-/**
- * Sending pairs are a rotating public key cryptography key material for sending
- * messages.
- *
- * Let's note naming convention. Since this is a sending pair, this side of
- * communication is called a sender, while the other side is a recipient.
- */
-export interface BaseSendingPair {
-    /**
-     * This is recipients' public key, to which encryption is done.
-     * If this is an introductory pair, this key is recipient's published intro
-     * public key.
-     * Else, if this is an ratcheted pair, this key comes from crypto material
-     * that recipients suggests from time to time for further use.
-     */
-    recipientPKey: JsonKeyShort;
-}
 /**
  * Introductory pair appears when the first message is sent to a new
  * correspondent. By nature it is an introductory message that uses recipient's
@@ -47,14 +31,22 @@ export interface BaseSendingPair {
  * a flag that allows to distinguish it from ratcheted pair with a clean
  * if-statement.
  */
-export interface IntroductorySendingPair extends BaseSendingPair {
+export interface IntroductorySendingPair {
     type: 'intro';
+    /**
+     * This is recipients' public key, to which encryption is done.
+     * If this is an introductory pair, this key is recipient's published intro
+     * public key.
+     * Else, if this is an ratcheted pair, this key comes from crypto material
+     * that recipients suggests from time to time for further use.
+     */
+    recipientPKey: JsonKey;
 }
 /**
  * Ratcheted sending pair is a sending pair with pair ids (pids), attached to
  * it. These ids are used to identify correct key material.
  */
-export interface RatchetedSendingPair extends BaseSendingPair {
+export interface RatchetedSendingPair {
     type: 'ratcheted';
     pids: string[];
     timestamp: number;
@@ -66,6 +58,14 @@ export interface RatchetedSendingPair extends BaseSendingPair {
      * and is moved to the sending pair when it is used by the other side.
      */
     senderKey: JWKeyPair;
+    /**
+     * This is recipients' public key, to which encryption is done.
+     * If this is an introductory pair, this key is recipient's published intro
+     * public key.
+     * Else, if this is an ratcheted pair, this key comes from crypto material
+     * that recipients suggests from time to time for further use.
+     */
+    recipientPKey: JsonKeyShort;
     /**
      * This is a precomputed message master key that comes from a given pair.
      * This exist only as a speedup measure, to save time of public key crypto
@@ -142,5 +142,6 @@ export declare class CorrespondentKeys {
         msgMasterKey: Uint8Array;
         msgCount: number;
     }>;
+    toInfo(): CorrespondentKeysInfo;
 }
 export {};

package/build/core/keyring/correspondent-keys.js

@@ -312,6 +312,17 @@ class CorrespondentKeys {
         }
         return { msgMasterKey, msgCount, currentPair };
     }
+    toInfo() {
+        const { sendingPair: sp, receptionPairs: rp } = this.keys;
+        return {
+            sendingPair: (sp ? turnSendingPairToInfo(sp) : null),
+            receptionPairs: {
+                inUse: (rp.inUse ? turnReceptionPairToInfo(rp.inUse) : null),
+                old: (rp.old ? turnReceptionPairToInfo(rp.old) : null),
+                suggested: (rp.suggested ? turnReceptionPairToInfo(rp.suggested) : null)
+            }
+        };
+    }
 }
 exports.CorrespondentKeys = CorrespondentKeys;
 Object.freeze(CorrespondentKeys.prototype);
@@ -352,4 +363,37 @@ function updateMsgCountInRatchetedSendingPair(p) {
     }
     return p.sentMsgs.count;
 }
+function turnSendingPairToInfo(sp) {
+    if (sp.type === 'ratcheted') {
+        const { pids, timestamp, sentMsgs } = sp;
+        return {
+            type: 'ratcheted',
+            recipientKId: sp.recipientPKey.kid,
+            senderKId: sp.senderKey.pkey.kid,
+            alg: sp.senderKey.pkey.alg,
+            pids,
+            timestamp,
+            sentMsgs
+        };
+    }
+    else if (sp.type === 'intro') {
+        return {
+            type: 'intro',
+            recipientKId: sp.recipientPKey.kid,
+            alg: sp.recipientPKey.alg
+        };
+    }
+    else {
+        return null;
+    }
+}
+function turnReceptionPairToInfo(rp) {
+    const { pids, timestamp, receivedMsgs, isSenderIntroKey } = rp;
+    return {
+        pids, timestamp, receivedMsgs, isSenderIntroKey,
+        alg: rp.recipientKey.pkey.alg,
+        recipientKId: rp.recipientKey.pkey.kid,
+        senderKId: rp.senderPKey.kid
+    };
+}
 Object.freeze(exports);

package/build/core/keyring/index.js

@@ -319,6 +319,11 @@ class Keyrings {
     makeKeyringsCAP() {
         const w = {
             introKeyOnASMailServer: this.publishedKeys.makeIntroKeyCAP(),
+            getCorrespondentKeys: async (addr) => {
+                var _a;
+                const cAddr = (0, canonical_address_1.toCanonicalAddress)(addr);
+                return (_a = this.corrKeys.get(cAddr)) === null || _a === void 0 ? void 0 : _a.toInfo();
+            }
         };
         return Object.freeze(w);
     }

package/build/core/keyring/keyrings-cap-ipc.js

@@ -23,6 +23,7 @@ const service_side_wrap_1 = require("../../core-ipc/json-ipc-wrapping/service-si
 function exposeKeyringsCAP(cap) {
     return {
         introKeyOnASMailServer: exposeIntroKey(cap.introKeyOnASMailServer),
+        getCorrespondentKeys: (0, service_side_wrap_1.wrapReqReplySrvMethod)(cap, 'getCorrespondentKeys')
     };
 }
 function exposeIntroKey(cap) {
@@ -45,6 +46,7 @@ function makeIntroKeyCaller(caller, objPath) {
 function makeKeyringsCaller(caller, objPath) {
     return {
         introKeyOnASMailServer: makeIntroKeyCaller(caller, objPath.concat('introKeyOnASMailServer')),
+        getCorrespondentKeys: (0, caller_side_wrap_1.makeReqRepFuncCaller)(caller, objPath.concat('getCorrespondentKeys'))
     };
 }
 Object.freeze(exports);

package/build/lib-common/service-api/asmail/retrieval.js

@@ -145,4 +145,7 @@ var msgMainObjRecieved;
     msgMainObjRecieved.EVENT_NAME = 'msg-main-obj-received';
 })(msgMainObjRecieved || (exports.msgMainObjRecieved = msgMainObjRecieved = {}));
 Object.freeze(msgMainObjRecieved);
+// XXX add event about message removal
+//   it is useful in multi-device case, pass implicit implicit signal that will
+//   have context-specific meaning.
 Object.freeze(exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.37.3",
+  "version": "0.38.1",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",