@freesignal/protocol 0.2.1 → 0.2.2

package/api.d.ts

@@ -2,6 +2,8 @@ import { Crypto, LocalStorage } from "@freesignal/interfaces";
 import { KeySession } from "./double-ratchet";
 import { KeyExchange } from "./x3dh";
 import { Datagram, IdentityKeys, EncryptedData, UserId } from "./types";
+export declare const FREESIGNAL_MIME = "application/x-freesignal";
+type DatagramId = string;
 export declare class FreeSignalAPI {
     protected readonly signKey: Crypto.KeyPair;
     protected readonly boxKey: Crypto.KeyPair;
@@ -16,25 +18,21 @@ export declare class FreeSignalAPI {
         users: LocalStorage<UserId, IdentityKeys>;
     });
     get userId(): Uint8Array;
+    get identityKeys(): IdentityKeys;
     encryptData(data: Uint8Array, userId: string): Promise<EncryptedData>;
     decryptData(data: Uint8Array, userId: string): Promise<Uint8Array>;
+    getDatagrams(publicKey: string | Uint8Array, url: string): Promise<Datagram[]>;
+    postDatagrams(datagrams: Datagram[], publicKey: string | Uint8Array, url: string): Promise<number>;
+    deleteDatagrams(datagramIds: DatagramId[], publicKey: string | Uint8Array, url: string): Promise<number>;
+    createToken(publicKey: Uint8Array): string;
     protected digestToken(auth?: string): Promise<{
         identityKeys: IdentityKeys;
         userId: UserId;
     }>;
-    createToken(publicKey: Uint8Array): string;
+    protected packIdList(datagramIds: DatagramId[]): Uint8Array;
+    protected unpackIdList(data: Uint8Array): DatagramId[];
     protected packDatagrams(messages: Datagram[]): Uint8Array;
     protected unpackDatagrams(data: Uint8Array): Datagram[];
-    get identityKeys(): {
-        readonly publicKey: string;
-        readonly identityKey: string;
-        encode(): Uint8Array;
-        toString(): string;
-        toJSON(): string;
-    };
-    static createSecretIdentityKeys(): {
-        secretSignKey: Uint8Array;
-        secretBoxKey: Uint8Array;
-    };
     static getUserId(publicKey: string | Uint8Array): string;
 }
+export {};

package/api.js

@@ -12,12 +12,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FreeSignalAPI = void 0;
+exports.FreeSignalAPI = exports.FREESIGNAL_MIME = void 0;
 const crypto_1 = __importDefault(require("@freesignal/crypto"));
 const x3dh_1 = require("./x3dh");
 const utils_1 = require("@freesignal/utils");
 const types_1 = require("./types");
 const fflate_1 = __importDefault(require("fflate"));
+exports.FREESIGNAL_MIME = "application/x-freesignal";
 class FreeSignalAPI {
     constructor(opts) {
         const { secretSignKey, secretBoxKey, sessions, keyExchange, users } = opts;
@@ -30,6 +31,12 @@ class FreeSignalAPI {
     get userId() {
         return crypto_1.default.hash(this.signKey.publicKey);
     }
+    get identityKeys() {
+        return {
+            publicKey: (0, utils_1.encodeBase64)(this.signKey.publicKey),
+            identityKey: (0, utils_1.encodeBase64)(this.boxKey.publicKey)
+        };
+    }
     encryptData(data, userId) {
         return __awaiter(this, void 0, void 0, function* () {
             const session = yield this.sessions.get(userId);
@@ -52,6 +59,50 @@ class FreeSignalAPI {
             return decrypted;
         });
     }
+    getDatagrams(publicKey, url) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(url, {
+                method: 'GET',
+                headers: {
+                    authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.decodeBase64)(publicKey))
+                }
+            });
+            return this.unpackDatagrams(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), FreeSignalAPI.getUserId(publicKey)));
+        });
+    }
+    postDatagrams(datagrams, publicKey, url) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.encryptData(this.packDatagrams(datagrams), FreeSignalAPI.getUserId(publicKey));
+            const res = yield fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': exports.FREESIGNAL_MIME,
+                    authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.decodeBase64)(publicKey))
+                },
+                body: data.encode()
+            });
+            return (0, utils_1.numberFromUint8Array)(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), FreeSignalAPI.getUserId(publicKey)));
+        });
+    }
+    deleteDatagrams(datagramIds, publicKey, url) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.encryptData(this.packIdList(datagramIds), FreeSignalAPI.getUserId(publicKey));
+            const res = yield fetch(url, {
+                method: 'DELETE',
+                headers: {
+                    'Content-Type': exports.FREESIGNAL_MIME,
+                    authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.decodeBase64)(publicKey))
+                },
+                body: data.encode()
+            });
+            return (0, utils_1.numberFromUint8Array)(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), FreeSignalAPI.getUserId(publicKey)));
+        });
+    }
+    createToken(publicKey) {
+        const sharedId = crypto_1.default.hash(crypto_1.default.ECDH.scalarMult(publicKey, this.boxKey.secretKey));
+        return `Bearer ${(0, utils_1.encodeBase64)(this.userId)}:${(0, utils_1.encodeBase64)(sharedId)}`;
+    }
+    ;
     digestToken(auth) {
         return __awaiter(this, void 0, void 0, function* () {
             if (auth && auth.startsWith("Bearer ")) {
@@ -67,11 +118,16 @@ class FreeSignalAPI {
             throw new Error('Authorization header is required');
         });
     }
-    createToken(publicKey) {
-        const sharedId = crypto_1.default.hash(crypto_1.default.ECDH.scalarMult(publicKey, this.boxKey.secretKey));
-        return `Bearer ${(0, utils_1.encodeBase64)(this.userId)}:${(0, utils_1.encodeBase64)(sharedId)}`;
+    packIdList(datagramIds) {
+        return datagramIds.map(datagramId => crypto_1.default.UUID.parse(datagramId)).reduce((prev, curr) => new Uint8Array([...prev, ...curr]), new Uint8Array());
+    }
+    unpackIdList(data) {
+        const ids = [];
+        for (let i = 0; i < data.length; i += 16) {
+            ids.push(crypto_1.default.UUID.stringify(data.subarray(i, i + 16)));
+        }
+        return ids;
     }
-    ;
     packDatagrams(messages) {
         return fflate_1.default.deflateSync((0, utils_1.concatUint8Array)(...messages.flatMap(datagram => {
             const encoded = types_1.Datagram.from(datagram).encode();
@@ -104,18 +160,6 @@ class FreeSignalAPI {
         }
         return messages;
     }
-    get identityKeys() {
-        return types_1.IdentityKeys.from({
-            publicKey: (0, utils_1.encodeBase64)(this.signKey.publicKey),
-            identityKey: (0, utils_1.encodeBase64)(this.boxKey.publicKey)
-        });
-    }
-    static createSecretIdentityKeys() {
-        return {
-            secretSignKey: crypto_1.default.EdDSA.keyPair().secretKey,
-            secretBoxKey: crypto_1.default.ECDH.keyPair().secretKey
-        };
-    }
     static getUserId(publicKey) {
         return (0, utils_1.encodeBase64)(crypto_1.default.hash(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.decodeBase64)(publicKey)));
     }

package/index.d.ts

@@ -20,8 +20,6 @@ import crypto from "@freesignal/crypto";
 import { LocalStorage, Crypto } from "@freesignal/interfaces";
 import { KeySession } from "./double-ratchet";
 import { KeyExchange } from "./x3dh";
-import { IdentityKeys, UserId } from "./types";
-import { FreeSignalAPI } from "./api";
 /**
  * Creates a new Double Ratchet session.
  *
@@ -43,11 +41,8 @@ export declare function createKeySession(opts?: {
  * @returns A new X3DH session.
  */
 export declare function createKeyExchange(signSecretKey: Uint8Array, boxSecretKey: Uint8Array, bundleStore?: LocalStorage<string, crypto.KeyPair>): KeyExchange;
-export declare function createAPI(opts: {
-    secretSignKey: Uint8Array;
-    secretBoxKey: Uint8Array;
-    sessions: LocalStorage<UserId, KeySession>;
-    keyExchange: LocalStorage<string, Crypto.KeyPair>;
-    users: LocalStorage<UserId, IdentityKeys>;
-}): FreeSignalAPI;
+export declare function createIdentityKeys(signSecretKey?: Uint8Array, boxSecretKey?: Uint8Array): {
+    sign: Crypto.KeyPair;
+    box: Crypto.KeyPair;
+};
 export { IdentityKeys, Protocols, EncryptedData, Datagram } from "./types";

package/index.js

@@ -17,14 +17,17 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Datagram = exports.EncryptedData = exports.Protocols = exports.IdentityKeys = void 0;
 exports.createKeySession = createKeySession;
 exports.createKeyExchange = createKeyExchange;
-exports.createAPI = createAPI;
+exports.createIdentityKeys = createIdentityKeys;
+const crypto_1 = __importDefault(require("@freesignal/crypto"));
 const double_ratchet_1 = require("./double-ratchet");
 const x3dh_1 = require("./x3dh");
-const api_1 = require("./api");
 /**
  * Creates a new Double Ratchet session.
  *
@@ -46,9 +49,21 @@ function createKeySession(opts) {
 function createKeyExchange(signSecretKey, boxSecretKey, bundleStore) {
     return new x3dh_1.KeyExchange(signSecretKey, boxSecretKey, bundleStore);
 }
-function createAPI(opts) {
-    return new api_1.FreeSignalAPI(opts);
+function createIdentityKeys(signSecretKey, boxSecretKey) {
+    return {
+        sign: crypto_1.default.EdDSA.keyPair(signSecretKey),
+        box: crypto_1.default.ECDH.keyPair(boxSecretKey)
+    };
 }
+/*export function createAPI(opts: {
+    secretSignKey: Uint8Array;
+    secretBoxKey: Uint8Array;
+    sessions: LocalStorage<UserId, KeySession>;
+    keyExchange: LocalStorage<string, Crypto.KeyPair>;
+    users: LocalStorage<UserId, IdentityKeys>;
+}): FreeSignalAPI {
+    return new FreeSignalAPI(opts);
+}*/
 var types_1 = require("./types");
 Object.defineProperty(exports, "IdentityKeys", { enumerable: true, get: function () { return types_1.IdentityKeys; } });
 Object.defineProperty(exports, "Protocols", { enumerable: true, get: function () { return types_1.Protocols; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freesignal/protocol",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Signal Protocol implementation in javascript",
   "license": "GPL-3.0-or-later",
   "author": "Christian Braghette",