@freesignal/protocol 0.2.4 → 0.2.6

package/api.d.ts

@@ -1,8 +1,25 @@
-import { Crypto, LocalStorage } from "@freesignal/interfaces";
+/**
+ * FreeSignal Protocol
+ *
+ * Copyright (C) 2025  Christian Braghette
+ *
+ * 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 <https://www.gnu.org/licenses/>
+ */
+import { Crypto, KeyExchangeData, KeyExchangeDataBundle, KeyExchangeSynMessage, 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;
@@ -10,6 +27,7 @@ export declare class FreeSignalAPI {
     protected readonly sessions: LocalStorage<UserId, KeySession>;
     protected readonly keyExchange: KeyExchange;
     protected readonly users: LocalStorage<UserId, IdentityKeys>;
+    readonly userId: UserId;
     constructor(opts: {
         secretSignKey: Uint8Array;
         secretBoxKey: Uint8Array;
@@ -17,10 +35,13 @@ export declare class FreeSignalAPI {
         keyExchange: LocalStorage<string, Crypto.KeyPair>;
         users: LocalStorage<UserId, IdentityKeys>;
     });
-    get userId(): Uint8Array;
     get identityKeys(): IdentityKeys;
     encryptData(data: Uint8Array, userId: string): Promise<EncryptedData>;
     decryptData(data: Uint8Array, userId: string): Promise<Uint8Array>;
+    getHandshake(url: string, userId?: UserId): Promise<KeyExchangeData>;
+    postHandshake(url: string, message: KeyExchangeSynMessage): Promise<boolean>;
+    putHandshake(url: string, publicKey: string | Uint8Array, bundle: KeyExchangeDataBundle): Promise<boolean>;
+    deleteHandshake(url: string, publicKey: string | Uint8Array): Promise<boolean>;
     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>;
@@ -29,9 +50,5 @@ export declare class FreeSignalAPI {
         identityKeys: IdentityKeys;
         userId: UserId;
     }>;
-    protected packIdList(datagramIds: DatagramId[]): Uint8Array;
-    protected unpackIdList(data: Uint8Array): DatagramId[];
-    protected packDatagrams(messages: Datagram[]): Uint8Array;
-    protected unpackDatagrams(data: Uint8Array): Datagram[];
 }
 export {};

package/api.js

@@ -1,4 +1,22 @@
 "use strict";
+/**
+ * FreeSignal Protocol
+ *
+ * Copyright (C) 2025  Christian Braghette
+ *
+ * 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 <https://www.gnu.org/licenses/>
+ */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -12,13 +30,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FreeSignalAPI = exports.FREESIGNAL_MIME = void 0;
+exports.FreeSignalAPI = 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;
@@ -27,9 +43,7 @@ class FreeSignalAPI {
         this.sessions = sessions;
         this.keyExchange = new x3dh_1.KeyExchange(secretSignKey, secretBoxKey, keyExchange);
         this.users = users;
-    }
-    get userId() {
-        return crypto_1.default.hash(this.signKey.publicKey);
+        this.userId = types_1.UserId.getUserId(this.signKey.publicKey).toString();
     }
     get identityKeys() {
         return {
@@ -59,6 +73,50 @@ class FreeSignalAPI {
             return decrypted;
         });
     }
+    getHandshake(url, userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${url}/${userId !== null && userId !== void 0 ? userId : ''}`, {
+                method: 'GET'
+            });
+            return (0, utils_1.decodeJSON)(new Uint8Array(yield res.arrayBuffer()));
+        });
+    }
+    postHandshake(url, message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': types_1.XFreeSignal.MIME
+                },
+                body: types_1.XFreeSignal.encodeBody('data', message)
+            });
+            return res.status === 200;
+        });
+    }
+    putHandshake(url, publicKey, bundle) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(url, {
+                method: 'PUT',
+                headers: {
+                    'Content-Type': types_1.XFreeSignal.MIME,
+                    authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.encodeBase64)(publicKey))
+                },
+                body: types_1.XFreeSignal.encodeBody('data', bundle)
+            });
+            return res.status === 201;
+        });
+    }
+    deleteHandshake(url, publicKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(url, {
+                method: 'DELETE',
+                headers: {
+                    authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.encodeBase64)(publicKey))
+                }
+            });
+            return res.status === 200;
+        });
+    }
     getDatagrams(publicKey, url) {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield fetch(url, {
@@ -67,50 +125,50 @@ class FreeSignalAPI {
                     authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.encodeBase64)(publicKey))
                 }
             });
-            return this.unpackDatagrams(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), types_1.UserId.getUserId(publicKey).toString()));
+            return types_1.DataEncoder.from(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), types_1.UserId.getUserId(publicKey).toString())).data.map(array => types_1.Datagram.from(array));
         });
     }
     postDatagrams(datagrams, publicKey, url) {
         return __awaiter(this, void 0, void 0, function* () {
-            const data = yield this.encryptData(this.packDatagrams(datagrams), types_1.UserId.getUserId(publicKey).toString());
+            const data = yield this.encryptData(new types_1.DataEncoder(datagrams.map(datagram => types_1.Datagram.from(datagram).encode())).encode(), types_1.UserId.getUserId(publicKey).toString());
             const res = yield fetch(url, {
                 method: 'POST',
                 headers: {
-                    'Content-Type': exports.FREESIGNAL_MIME,
+                    'Content-Type': types_1.XFreeSignal.MIME,
                     authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.encodeBase64)(publicKey))
                 },
-                body: data.encode()
+                body: types_1.XFreeSignal.encodeBody('data', data.encode())
             });
-            return (0, utils_1.numberFromUint8Array)(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), types_1.UserId.getUserId(publicKey).toString()));
+            return (0, utils_1.numberFromArray)(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), types_1.UserId.getUserId(publicKey).toString()));
         });
     }
     deleteDatagrams(datagramIds, publicKey, url) {
         return __awaiter(this, void 0, void 0, function* () {
-            const data = yield this.encryptData(this.packIdList(datagramIds), types_1.UserId.getUserId(publicKey).toString());
+            const data = yield this.encryptData(new types_1.DataEncoder(datagramIds.map(datagramId => crypto_1.default.UUID.parse(datagramId))).encode(), types_1.UserId.getUserId(publicKey).toString());
             const res = yield fetch(url, {
                 method: 'DELETE',
                 headers: {
-                    'Content-Type': exports.FREESIGNAL_MIME,
+                    'Content-Type': types_1.XFreeSignal.MIME,
                     authorization: this.createToken(publicKey instanceof Uint8Array ? publicKey : (0, utils_1.encodeBase64)(publicKey))
                 },
-                body: data.encode()
+                body: types_1.XFreeSignal.encodeBody('data', data.encode())
             });
-            return (0, utils_1.numberFromUint8Array)(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), types_1.UserId.getUserId(publicKey).toString()));
+            return (0, utils_1.numberFromArray)(yield this.decryptData(new Uint8Array(yield res.arrayBuffer()), types_1.UserId.getUserId(publicKey).toString()));
         });
     }
     createToken(publicKey) {
-        const sharedId = crypto_1.default.hash(crypto_1.default.ECDH.scalarMult(publicKey, this.boxKey.secretKey));
-        return `Bearer ${(0, utils_1.decodeBase64)(this.userId)}:${(0, utils_1.decodeBase64)(sharedId)}`;
+        const signature = crypto_1.default.EdDSA.sign(crypto_1.default.hash(crypto_1.default.ECDH.scalarMult(publicKey, this.boxKey.secretKey)), this.signKey.secretKey);
+        return `Bearer ${this.userId}:${(0, utils_1.decodeBase64)(signature)}`;
     }
     ;
     digestToken(auth) {
         return __awaiter(this, void 0, void 0, function* () {
             if (auth && auth.startsWith("Bearer ")) {
-                const [userId, sharedId] = auth.substring(7).split(":");
+                const [userId, signature] = auth.substring(7).split(":");
                 const identityKeys = yield this.users.get(userId);
                 if (!identityKeys)
                     throw new Error('User not found or invalid auth token');
-                if ((0, utils_1.verifyUint8Array)(crypto_1.default.hash(crypto_1.default.ECDH.scalarMult((0, utils_1.encodeBase64)(identityKeys.publicKey), this.boxKey.secretKey)), (0, utils_1.encodeBase64)(sharedId)))
+                if (crypto_1.default.EdDSA.verify(crypto_1.default.hash(crypto_1.default.ECDH.scalarMult((0, utils_1.encodeBase64)(identityKeys.identityKey), this.boxKey.secretKey)), (0, utils_1.encodeBase64)(signature), (0, utils_1.encodeBase64)(identityKeys.publicKey)))
                     return { identityKeys, userId: auth };
                 else
                     throw new Error('Authorization token not valid');
@@ -118,47 +176,5 @@ class FreeSignalAPI {
             throw new Error('Authorization header is required');
         });
     }
-    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();
-            return [(0, utils_1.numberToUint8Array)(encoded.length, 8), encoded];
-        })));
-    }
-    unpackDatagrams(data) {
-        const messages = [];
-        let offset = 0;
-        data = fflate_1.default.inflateSync(data);
-        while (offset < data.length) {
-            const length = data.subarray(offset, offset + 8);
-            if (length.length < 8) {
-                throw new Error('Invalid message length');
-            }
-            const messageLength = (0, utils_1.numberFromUint8Array)(length);
-            offset += 8;
-            if (offset + messageLength > data.length) {
-                throw new Error('Invalid message length');
-            }
-            const messageData = data.subarray(offset, offset + messageLength);
-            offset += messageLength;
-            try {
-                const datagram = types_1.Datagram.from(messageData);
-                messages.push(datagram);
-            }
-            catch (error) {
-                throw new Error('Invalid datagram format');
-            }
-        }
-        return messages;
-    }
 }
 exports.FreeSignalAPI = FreeSignalAPI;

package/double-ratchet.d.ts

@@ -83,14 +83,14 @@ export declare class KeySession {
     /**
      * Export the state of the session;
      */
-    export(): ExportedKeySession;
+    toJSON(): ExportedKeySession;
     /**
      * Import a state.
      *
      * @param json string returned by `export()` method.
      * @returns session with the state parsed.
      */
-    static import(json: string): KeySession;
+    static parse(json: string): KeySession;
     /**
      * The fixed key length (in bytes) used throughout the Double Ratchet session.
      * Typically 32 bytes (256 bits) for symmetric keys.

package/double-ratchet.js

@@ -117,7 +117,9 @@ class KeySession {
         var _a;
         const encrypted = types_1.EncryptedData.from(payload);
         const publicKey = encrypted.publicKey;
-        if (!(0, utils_1.verifyUint8Array)(publicKey, this._remoteKey)) {
+        if (!this._remoteKey)
+            throw new Error("Missing remoteKey");
+        if (!(0, utils_1.verifyArrays)(publicKey, this._remoteKey)) {
             while (this.receivingCount < encrypted.previous)
                 this.previousKeys.set(this.receivingCount, this.getReceivingKey());
             this.setRemoteKey(publicKey);
@@ -141,9 +143,9 @@ class KeySession {
     /**
      * Export the state of the session;
      */
-    export() {
+    toJSON() {
         return {
-            secretKey: (0, utils_1.decodeBase64)((0, utils_1.concatUint8Array)(this.keyPair.secretKey)),
+            secretKey: (0, utils_1.decodeBase64)((0, utils_1.concatArrays)(this.keyPair.secretKey)),
             remoteKey: (0, utils_1.decodeBase64)(this._remoteKey),
             rootKey: (0, utils_1.decodeBase64)(this.rootKey),
             sendingChain: (0, utils_1.decodeBase64)(this.sendingChain),
@@ -160,7 +162,7 @@ class KeySession {
      * @param json string returned by `export()` method.
      * @returns session with the state parsed.
      */
-    static import(json) {
+    static parse(json) {
         const data = JSON.parse(json);
         const session = new KeySession({ secretKey: (0, utils_1.encodeBase64)(data.secretKey), rootKey: (0, utils_1.encodeBase64)(data.rootKey) });
         session._remoteKey = (0, utils_1.encodeBase64)(data.remoteKey);

package/index.d.ts

@@ -21,12 +21,13 @@ import { LocalStorage, Crypto } from "@freesignal/interfaces";
 import { KeySession } from "./double-ratchet";
 import { KeyExchange } from "./x3dh";
 /**
- * Creates a new Double Ratchet session.
+ * Creates a new Double Ratchet session for secure message exchange.
  *
- * @param opts.remoteKey The public key of the remote party.
- * @param opts.preSharedKey An optional pre-shared key to initialize the session.
- *
- * @returns A new Double Ratchet session.
+ * @param opts - Optional parameters for session initialization.
+ * @param opts.secretKey - The local party's secret key as a Uint8Array.
+ * @param opts.remoteKey - The remote party's public key as a Uint8Array.
+ * @param opts.rootKey - An optional root key to initialize the session.
+ * @returns A new instance of {@link KeySession}.
  */
 export declare function createKeySession(opts?: {
     secretKey?: Uint8Array;
@@ -34,15 +35,23 @@ export declare function createKeySession(opts?: {
     rootKey?: Uint8Array;
 }): KeySession;
 /**
- * Creates a new X3DH session.
+ * Creates a new X3DH (Extended Triple Diffie-Hellman) key exchange session.
  *
- * @param signKeyPair
- * @param bundleStore
- * @returns A new X3DH session.
+ * @param signSecretKey - The EdDSA signing secret key as a Uint8Array.
+ * @param boxSecretKey - The ECDH box secret key as a Uint8Array.
+ * @param bundleStore - Optional local storage for key bundles.
+ * @returns A new instance of {@link KeyExchange}.
  */
 export declare function createKeyExchange(signSecretKey: Uint8Array, boxSecretKey: Uint8Array, bundleStore?: LocalStorage<string, crypto.KeyPair>): KeyExchange;
+/**
+ * Generates identity key pairs for signing and encryption.
+ *
+ * @param signSecretKey - Optional secret key for EdDSA signing.
+ * @param boxSecretKey - Optional secret key for ECDH encryption.
+ * @returns An object containing readonly signing and box key pairs.
+ */
 export declare function createIdentityKeys(signSecretKey?: Uint8Array, boxSecretKey?: Uint8Array): {
-    sign: Crypto.KeyPair;
-    box: Crypto.KeyPair;
+    readonly sign: Crypto.KeyPair;
+    readonly box: Crypto.KeyPair;
 };
-export { IdentityKeys, Protocols, EncryptedData, Datagram } from "./types";
+export { UserId, IdentityKeys, Protocols, Datagram, EncryptedData } from "./types";

package/index.js

@@ -21,7 +21,7 @@ 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.EncryptedData = exports.Datagram = exports.Protocols = exports.IdentityKeys = exports.UserId = void 0;
 exports.createKeySession = createKeySession;
 exports.createKeyExchange = createKeyExchange;
 exports.createIdentityKeys = createIdentityKeys;
@@ -29,43 +29,41 @@ const crypto_1 = __importDefault(require("@freesignal/crypto"));
 const double_ratchet_1 = require("./double-ratchet");
 const x3dh_1 = require("./x3dh");
 /**
- * Creates a new Double Ratchet session.
+ * Creates a new Double Ratchet session for secure message exchange.
  *
- * @param opts.remoteKey The public key of the remote party.
- * @param opts.preSharedKey An optional pre-shared key to initialize the session.
- *
- * @returns A new Double Ratchet session.
+ * @param opts - Optional parameters for session initialization.
+ * @param opts.secretKey - The local party's secret key as a Uint8Array.
+ * @param opts.remoteKey - The remote party's public key as a Uint8Array.
+ * @param opts.rootKey - An optional root key to initialize the session.
+ * @returns A new instance of {@link KeySession}.
  */
 function createKeySession(opts) {
     return new double_ratchet_1.KeySession(opts);
 }
 /**
- * Creates a new X3DH session.
+ * Creates a new X3DH (Extended Triple Diffie-Hellman) key exchange session.
  *
- * @param signKeyPair
- * @param bundleStore
- * @returns A new X3DH session.
+ * @param signSecretKey - The EdDSA signing secret key as a Uint8Array.
+ * @param boxSecretKey - The ECDH box secret key as a Uint8Array.
+ * @param bundleStore - Optional local storage for key bundles.
+ * @returns A new instance of {@link KeyExchange}.
  */
 function createKeyExchange(signSecretKey, boxSecretKey, bundleStore) {
     return new x3dh_1.KeyExchange(signSecretKey, boxSecretKey, bundleStore);
 }
+/**
+ * Generates identity key pairs for signing and encryption.
+ *
+ * @param signSecretKey - Optional secret key for EdDSA signing.
+ * @param boxSecretKey - Optional secret key for ECDH encryption.
+ * @returns An object containing readonly signing and box key pairs.
+ */
 function createIdentityKeys(signSecretKey, boxSecretKey) {
-    return {
-        sign: crypto_1.default.EdDSA.keyPair(signSecretKey),
-        box: crypto_1.default.ECDH.keyPair(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, "UserId", { enumerable: true, get: function () { return types_1.UserId; } });
 Object.defineProperty(exports, "IdentityKeys", { enumerable: true, get: function () { return types_1.IdentityKeys; } });
 Object.defineProperty(exports, "Protocols", { enumerable: true, get: function () { return types_1.Protocols; } });
-Object.defineProperty(exports, "EncryptedData", { enumerable: true, get: function () { return types_1.EncryptedData; } });
 Object.defineProperty(exports, "Datagram", { enumerable: true, get: function () { return types_1.Datagram; } });
+Object.defineProperty(exports, "EncryptedData", { enumerable: true, get: function () { return types_1.EncryptedData; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freesignal/protocol",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Signal Protocol implementation in javascript",
   "license": "GPL-3.0-or-later",
   "author": "Christian Braghette",
@@ -13,7 +13,7 @@
   "dependencies": {
     "@freesignal/crypto": "^0.3.0",
     "@freesignal/interfaces": "^0.1.1",
-    "@freesignal/utils": "^1.0.2",
+    "@freesignal/utils": "^1.2.0",
     "base64-js": "^1.5.1",
     "fflate": "^0.8.2",
     "js-sha3": "^0.9.3",

package/test.js

@@ -24,7 +24,6 @@ bob.digestMessage(aliceack).then(({ session: bobsession, identityKeys }) => {
             console.log("Error during handshake");
         const longmsg = _1.Datagram.create(alice.signatureKey, bob.signatureKey, _1.Protocols.MESSAGE, alicesession.encrypt(new Uint8Array(1000000).fill(33).map(val => val + Math.floor(Math.random() * 93))));
         console.log(longmsg.encode().length);
-        console.log(longmsg.encode(false).length);
     }
     else
         console.log("Error");

package/types.d.ts

@@ -23,6 +23,7 @@ export declare namespace UserId {
         private readonly array;
         constructor(array: Uint8Array);
         toString(): string;
+        toJSON(): string;
         toUint8Array(): Uint8Array;
     }
     export function getUserId(publicKey: string | Uint8Array): UserIdConstructor;
@@ -49,9 +50,9 @@ export declare namespace IdentityKeys {
 }
 export declare enum Protocols {
     NULL = "",
-    MESSAGE = "/freesignal/message/1.0.0",
-    RELAY = "/freesignal/relay/1.0.0",
-    HANDSHAKE = "/freesignal/handshake/1.0.0"
+    MESSAGE = "/freesignal/message",
+    RELAY = "/freesignal/relay",
+    HANDSHAKE = "/freesignal/handshake"
 }
 export declare namespace Protocols {
     function isProtocol(protocol: any): boolean;
@@ -68,6 +69,7 @@ export interface Datagram {
     readonly protocol: Protocols;
     readonly createdAt: number;
     payload?: Uint8Array;
+    readonly signature?: string;
 }
 export declare namespace Datagram {
     export const version = 1;
@@ -78,12 +80,18 @@ export declare namespace Datagram {
         readonly receiver: UserId;
         readonly protocol: Protocols;
         readonly createdAt: number;
-        payload?: Uint8Array;
+        _payload?: Uint8Array;
+        _signature?: Uint8Array;
+        private secretKey?;
         private static headerOffset;
         constructor(sender: Uint8Array | string, receiver: Uint8Array | string, protocol: Protocols, payload?: Uint8Array | Encodable);
         constructor(data: Uint8Array | Datagram);
-        encode(compression?: boolean): Uint8Array;
-        encodeSigned(secretKey: Uint8Array, compression?: boolean): Uint8Array;
+        get signed(): boolean;
+        get signature(): string | undefined;
+        set payload(data: Uint8Array);
+        get payload(): Uint8Array | undefined;
+        encode(): Uint8Array;
+        sign(secretKey: Uint8Array): this;
         toString(): string;
         toJSON(): string;
     }
@@ -165,14 +173,46 @@ export declare class EncryptedDataConstructor implements EncryptedData {
     get nonce(): Uint8Array;
     get ciphertext(): Uint8Array;
     encode(): Uint8Array;
-    decode(): {
-        version: number;
-        count: number;
-        previous: number;
-        publicKey: string;
-        nonce: string;
-        ciphertext: string;
-    };
     toString(): string;
     toJSON(): string;
 }
+declare enum DataType {
+    UKNOWN = -1,
+    RAW = 0,
+    NUMBER = 1,
+    STRING = 2,
+    ARRAY = 3,
+    OBJECT = 4
+}
+declare namespace DataType {
+    function getType(type: string): DataType;
+    function getName(type: DataType): string;
+    function from(data: any): DataType;
+}
+export declare class DataEncoder<T> implements Encodable {
+    readonly data: T;
+    readonly type: string;
+    constructor(data: T);
+    protected get _type(): DataType;
+    encode(): Uint8Array;
+    toString(): string;
+    toJSON(): string;
+    static from<T = any>(array: Uint8Array): DataEncoder<T>;
+}
+export declare namespace XFreeSignal {
+    export const MIME = "application/x-freesignal";
+    export const version = 1;
+    export function encodeBody(type: 'data' | 'error', data: any, compressed?: boolean): BodyInit;
+    export function decodeBody<T = any>(body: Uint8Array): Body<T>;
+    class Body<T> implements Encodable {
+        readonly type: 'data' | 'error';
+        readonly data: T;
+        constructor(type: 'data' | 'error', data: T);
+        encode(compressed?: boolean): Uint8Array;
+        toString(): string;
+        toJSON(): string;
+        static from<T = any>(array: Uint8Array): Body<T>;
+    }
+    export {};
+}
+export {};

package/types.js

@@ -21,11 +21,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EncryptedDataConstructor = exports.EncryptedData = exports.Datagram = exports.Protocols = exports.IdentityKeys = exports.UserId = void 0;
+exports.XFreeSignal = exports.DataEncoder = exports.EncryptedDataConstructor = exports.EncryptedData = exports.Datagram = exports.Protocols = exports.IdentityKeys = exports.UserId = void 0;
 const utils_1 = require("@freesignal/utils");
 const crypto_1 = __importDefault(require("@freesignal/crypto"));
-const fflate_1 = __importDefault(require("fflate"));
 const double_ratchet_1 = require("./double-ratchet");
+const fflate_1 = __importDefault(require("fflate"));
 var UserId;
 (function (UserId) {
     class UserIdConstructor {
@@ -36,6 +36,9 @@ var UserId;
         toString() {
             return (0, utils_1.decodeBase64)(this.array);
         }
+        toJSON() {
+            return JSON.stringify(this.toString());
+        }
         toUint8Array() {
             return this.array;
         }
@@ -66,13 +69,13 @@ var IdentityKeys;
             }
         }
         encode() {
-            return (0, utils_1.concatUint8Array)((0, utils_1.encodeBase64)(this.publicKey), (0, utils_1.encodeBase64)(this.identityKey));
+            return (0, utils_1.concatArrays)((0, utils_1.encodeBase64)(this.publicKey), (0, utils_1.encodeBase64)(this.identityKey));
         }
         toString() {
             throw (0, utils_1.decodeBase64)(this.encode());
         }
         toJSON() {
-            throw this.toString();
+            throw JSON.stringify(this.toString());
         }
     }
     function isIdentityKeys(obj) {
@@ -87,9 +90,9 @@ var IdentityKeys;
 var Protocols;
 (function (Protocols) {
     Protocols["NULL"] = "";
-    Protocols["MESSAGE"] = "/freesignal/message/1.0.0";
-    Protocols["RELAY"] = "/freesignal/relay/1.0.0";
-    Protocols["HANDSHAKE"] = "/freesignal/handshake/1.0.0";
+    Protocols["MESSAGE"] = "/freesignal/message";
+    Protocols["RELAY"] = "/freesignal/relay";
+    Protocols["HANDSHAKE"] = "/freesignal/handshake";
 })(Protocols || (exports.Protocols = Protocols = {}));
 (function (Protocols) {
     function isProtocol(protocol) {
@@ -105,16 +108,11 @@ var Protocols;
     }
     Protocols.toCode = toCode;
     function encode(protocol, length) {
-        /*const raw = numberToUint8Array(Protocols.toCode(protocol), length).reverse();
-        raw[0] |= (raw.length - 1) << 6;
-        return raw;*/
-        return (0, utils_1.numberToUint8Array)(Protocols.toCode(protocol), length);
+        return (0, utils_1.numberToArray)(Protocols.toCode(protocol), length);
     }
     Protocols.encode = encode;
     function decode(array) {
-        //array[0] &= 63;
-        //array = array.reverse();
-        return Protocols.fromCode((0, utils_1.numberFromUint8Array)(array));
+        return Protocols.fromCode((0, utils_1.numberFromArray)(array));
     }
     Protocols.decode = decode;
 })(Protocols || (exports.Protocols = Protocols = {}));
@@ -125,21 +123,15 @@ var Datagram;
         constructor(data, receiver, protocol, payload) {
             if (!receiver && !protocol && !payload) {
                 if (data instanceof Uint8Array) {
-                    this.version = data[0] & 63;
+                    this.version = data[0] & 127;
                     this.protocol = Protocols.decode(data.subarray(1, 2));
                     this.id = crypto_1.default.UUID.stringify(data.subarray(2, 18));
-                    this.createdAt = (0, utils_1.numberFromUint8Array)(data.subarray(18, 26));
+                    this.createdAt = (0, utils_1.numberFromArray)(data.subarray(18, 26));
                     this.sender = (0, utils_1.decodeBase64)(data.subarray(26, 26 + crypto_1.default.EdDSA.publicKeyLength));
                     this.receiver = (0, utils_1.decodeBase64)(data.subarray(26 + crypto_1.default.EdDSA.publicKeyLength, DatagramConstructor.headerOffset));
-                    if (data[0] & 128) {
-                        const signature = data.subarray(data.length - crypto_1.default.EdDSA.signatureLength);
-                        if (!crypto_1.default.EdDSA.verify(data.subarray(0, data.length - crypto_1.default.EdDSA.signatureLength), signature, data.subarray(26, 26 + crypto_1.default.EdDSA.publicKeyLength)))
-                            throw new Error('Invalid signature for Datagram');
-                    }
-                    if (data[0] & 64)
-                        this.payload = fflate_1.default.inflateSync(data.subarray(DatagramConstructor.headerOffset, data.length));
-                    else
-                        this.payload = data.subarray(DatagramConstructor.headerOffset, data.length);
+                    if (data[0] & 128)
+                        this._signature = data.subarray(data.length - crypto_1.default.EdDSA.signatureLength);
+                    this._payload = data.subarray(DatagramConstructor.headerOffset, data.length);
                 }
                 else if (Datagram.isDatagram(data)) {
                     const datagram = data;
@@ -149,7 +141,8 @@ var Datagram;
                     this.receiver = datagram.receiver;
                     this.protocol = datagram.protocol;
                     this.createdAt = datagram.createdAt;
-                    this.payload = datagram.payload;
+                    this._payload = datagram.payload;
+                    this._signature = (0, utils_1.encodeBase64)(datagram.signature);
                 }
                 else
                     throw new Error('Invalid constructor arguments for Datagram');
@@ -161,45 +154,50 @@ var Datagram;
                 this.receiver = typeof receiver === 'string' ? receiver : (0, utils_1.decodeBase64)(receiver);
                 this.protocol = protocol;
                 this.createdAt = Date.now();
-                this.payload = payload instanceof Uint8Array ? payload : payload === null || payload === void 0 ? void 0 : payload.encode();
+                this._payload = payload instanceof Uint8Array ? payload : payload === null || payload === void 0 ? void 0 : payload.encode();
             }
             else
                 throw new Error('Invalid constructor arguments for Datagram');
         }
-        encode(compression = true) {
-            var _a;
-            compression = compression && this.payload != undefined && this.payload.length > 1024;
-            return (0, utils_1.concatUint8Array)(new Uint8Array(1).fill(this.version | (compression ? 64 : 0)), //1
+        get signed() {
+            return !this._signature && !this.secretKey ? false : true;
+        }
+        get signature() {
+            if (this.signed) {
+                if (!this._signature)
+                    this.encode();
+                return (0, utils_1.decodeBase64)(this._signature);
+            }
+        }
+        set payload(data) {
+            this._signature = undefined;
+            this._payload = data;
+        }
+        get payload() {
+            return this._payload;
+        }
+        encode() {
+            var _a, _b, _c;
+            const data = (0, utils_1.concatArrays)(new Uint8Array(1).fill(this.version | (this.secretKey ? 128 : 0)), //1
             Protocols.encode(this.protocol), //1
             (_a = crypto_1.default.UUID.parse(this.id)) !== null && _a !== void 0 ? _a : [], //16
-            (0, utils_1.numberToUint8Array)(this.createdAt, 8), //8
+            (0, utils_1.numberToArray)(this.createdAt, 8), //8
             (0, utils_1.encodeBase64)(this.sender), //32
             (0, utils_1.encodeBase64)(this.receiver), //32
-            ...(this.payload ? [compression ? fflate_1.default.deflateSync(this.payload) : this.payload] : []));
+            (_b = this._payload) !== null && _b !== void 0 ? _b : new Uint8Array());
+            if (this.secretKey)
+                this._signature = crypto_1.default.EdDSA.sign(data, this.secretKey);
+            return (0, utils_1.concatArrays)(data, (_c = this._signature) !== null && _c !== void 0 ? _c : new Uint8Array());
         }
-        encodeSigned(secretKey, compression) {
-            //if (!this.payload) throw new Error('Cannot sign a datagram without payload');
-            const header = this.encode(compression);
-            header[0] |= 128; // Set the sign bit
-            const signature = crypto_1.default.EdDSA.sign(header, secretKey);
-            return (0, utils_1.concatUint8Array)(header, signature);
+        sign(secretKey) {
+            this.secretKey = secretKey;
+            return this;
         }
         toString() {
             return (0, utils_1.decodeBase64)(this.encode());
         }
         toJSON() {
-            /*return JSON.stringify({
-                id: this.id,
-                version: this.version,
-                senderKey: this.senderKey,
-                senderRelay: this.senderRelay,
-                receiverKey: this.receiverKey,
-                receiverRelay: this.receiverRelay,
-                protocol: this.protocol,
-                createdAt: this.createdAt,
-                payload: this.payload ? encodeBase64(this.payload) : undefined
-            });*/
-            return this.toString();
+            return JSON.stringify(this.toString());
         }
     }
     DatagramConstructor.headerOffset = 26 + crypto_1.default.EdDSA.publicKeyLength * 2;
@@ -241,43 +239,40 @@ class EncryptedDataConstructor {
             return this;
         }
         if (typeof arrays[0] === 'number')
-            arrays[0] = (0, utils_1.numberToUint8Array)(arrays[0], EncryptedDataConstructor.countLength);
+            arrays[0] = (0, utils_1.numberToArray)(arrays[0], EncryptedDataConstructor.countLength);
         if (typeof arrays[1] === 'number')
-            arrays[1] = (0, utils_1.numberToUint8Array)(arrays[1], EncryptedDataConstructor.countLength);
+            arrays[1] = (0, utils_1.numberToArray)(arrays[1], EncryptedDataConstructor.countLength);
         if (arrays.length === 6) {
-            arrays.unshift(typeof arrays[5] === 'number' ? (0, utils_1.numberToUint8Array)(arrays[5]) : arrays[5]);
+            arrays.unshift(typeof arrays[5] === 'number' ? (0, utils_1.numberToArray)(arrays[5]) : arrays[5]);
             arrays.pop();
         }
         else if (arrays.length > 1) {
-            arrays.unshift((0, utils_1.numberToUint8Array)(double_ratchet_1.KeySession.version));
+            arrays.unshift((0, utils_1.numberToArray)(double_ratchet_1.KeySession.version));
         }
-        this.raw = (0, utils_1.concatUint8Array)(...arrays);
+        this.raw = (0, utils_1.concatArrays)(...arrays);
     }
     get length() { return this.raw.length; }
-    get version() { return (0, utils_1.numberFromUint8Array)(new Uint8Array(this.raw.buffer, ...Offsets.version.get)); }
-    get count() { return (0, utils_1.numberFromUint8Array)(new Uint8Array(this.raw.buffer, ...Offsets.count.get)); }
-    get previous() { return (0, utils_1.numberFromUint8Array)(new Uint8Array(this.raw.buffer, ...Offsets.previous.get)); }
+    get version() { return (0, utils_1.numberFromArray)(new Uint8Array(this.raw.buffer, ...Offsets.version.get)); }
+    get count() { return (0, utils_1.numberFromArray)(new Uint8Array(this.raw.buffer, ...Offsets.count.get)); }
+    get previous() { return (0, utils_1.numberFromArray)(new Uint8Array(this.raw.buffer, ...Offsets.previous.get)); }
     get publicKey() { return new Uint8Array(this.raw.buffer, ...Offsets.publicKey.get); }
     get nonce() { return new Uint8Array(this.raw.buffer, ...Offsets.nonce.get); }
     get ciphertext() { return new Uint8Array(this.raw.buffer, Offsets.ciphertext.start); }
     encode() {
         return this.raw;
     }
-    decode() {
-        return {
+    toString() {
+        return (0, utils_1.decodeBase64)(this.raw);
+    }
+    toJSON() {
+        return JSON.stringify({
             version: this.version,
             count: this.count,
             previous: this.previous,
             publicKey: (0, utils_1.decodeBase64)(this.publicKey),
             nonce: (0, utils_1.decodeBase64)(this.nonce),
             ciphertext: (0, utils_1.decodeBase64)(this.ciphertext)
-        };
-    }
-    toString() {
-        return (0, utils_1.decodeBase64)(this.raw);
-    }
-    toJSON() {
-        return JSON.stringify(this.decode());
+        });
     }
 }
 exports.EncryptedDataConstructor = EncryptedDataConstructor;
@@ -310,3 +305,156 @@ Offsets.previous = Offsets.set(Offsets.count.end, EncryptedDataConstructor.count
 Offsets.publicKey = Offsets.set(Offsets.previous.end, EncryptedDataConstructor.publicKeyLength);
 Offsets.nonce = Offsets.set(Offsets.publicKey.end, EncryptedDataConstructor.nonceLength);
 Offsets.ciphertext = Offsets.set(Offsets.nonce.end, undefined);
+var DataType;
+(function (DataType) {
+    DataType[DataType["UKNOWN"] = -1] = "UKNOWN";
+    DataType[DataType["RAW"] = 0] = "RAW";
+    DataType[DataType["NUMBER"] = 1] = "NUMBER";
+    DataType[DataType["STRING"] = 2] = "STRING";
+    DataType[DataType["ARRAY"] = 3] = "ARRAY";
+    DataType[DataType["OBJECT"] = 4] = "OBJECT";
+})(DataType || (DataType = {}));
+(function (DataType) {
+    function getType(type) {
+        return Object.values(DataType).indexOf(type.toLocaleUpperCase());
+    }
+    DataType.getType = getType;
+    function getName(type) {
+        return DataType[type].toLowerCase();
+    }
+    DataType.getName = getName;
+    function from(data) {
+        if (data instanceof Uint8Array)
+            return DataType.RAW;
+        return getType(typeof data);
+    }
+    DataType.from = from;
+})(DataType || (DataType = {}));
+class DataEncoder {
+    constructor(data) {
+        this.data = data;
+        this.type = DataType.getName(DataType.from(this.data));
+    }
+    get _type() {
+        return DataType.getType(this.type);
+    }
+    encode() {
+        let data;
+        switch (this._type) {
+            case DataType.RAW:
+                data = this.data;
+                break;
+            case DataType.NUMBER:
+                data = (0, utils_1.numberToArray)(this._type);
+                break;
+            case DataType.STRING:
+                data = (0, utils_1.encodeUTF8)(this.data);
+                break;
+            case DataType.ARRAY:
+                data = (0, utils_1.concatArrays)(...Array.from(this.data).flatMap(value => {
+                    const data = new DataEncoder(value).encode();
+                    return [(0, utils_1.numberToArray)(data.length, 8), data];
+                }));
+                break;
+            case DataType.OBJECT:
+                data = (0, utils_1.encodeJSON)(this.data);
+                break;
+            default:
+                throw new Error("Uknown type");
+        }
+        return (0, utils_1.concatArrays)((0, utils_1.numberToArray)(this._type), data);
+    }
+    toString() {
+        return "[Object XFreeSignalData]";
+    }
+    toJSON() {
+        return JSON.stringify(this.data);
+    }
+    static from(array) {
+        const type = array[0];
+        let rawData = array.subarray(1), data;
+        switch (type) {
+            case DataType.RAW:
+                data = rawData;
+                break;
+            case DataType.NUMBER:
+                data = (0, utils_1.numberFromArray)(rawData);
+                break;
+            case DataType.STRING:
+                data = (0, utils_1.decodeUTF8)(rawData);
+                break;
+            case DataType.ARRAY:
+                const arrayData = [];
+                let offset = 0;
+                while (offset < rawData.length) {
+                    const length = rawData.subarray(offset, offset + 8);
+                    if (length.length < 8)
+                        throw new Error('Invalid data length');
+                    const messageLength = (0, utils_1.numberFromArray)(length);
+                    offset += 8;
+                    if (offset + messageLength > rawData.length) {
+                        throw new Error('Invalid data length');
+                    }
+                    arrayData.push(rawData.subarray(offset, offset + messageLength));
+                    offset += messageLength;
+                }
+                data = arrayData;
+                break;
+            case DataType.OBJECT:
+                data = (0, utils_1.decodeJSON)(rawData);
+                break;
+            default:
+                throw new Error('Invalid data format');
+        }
+        return new DataEncoder(data);
+    }
+}
+exports.DataEncoder = DataEncoder;
+var XFreeSignal;
+(function (XFreeSignal) {
+    XFreeSignal.MIME = "application/x-freesignal";
+    XFreeSignal.version = 1;
+    function encodeBody(type, data, compressed = false) {
+        return new Body(type, data).encode(compressed);
+    }
+    XFreeSignal.encodeBody = encodeBody;
+    function decodeBody(body) {
+        return Body.from(body);
+    }
+    XFreeSignal.decodeBody = decodeBody;
+    let BodyType;
+    (function (BodyType) {
+        BodyType[BodyType["DATA"] = 0] = "DATA";
+        BodyType[BodyType["ERROR"] = 1] = "ERROR";
+    })(BodyType || (BodyType = {}));
+    (function (BodyType) {
+        function getName(type) {
+            return BodyType[type].toLowerCase();
+        }
+        BodyType.getName = getName;
+    })(BodyType || (BodyType = {}));
+    class Body {
+        constructor(type, data) {
+            this.type = type;
+            this.data = data;
+        }
+        encode(compressed = false) {
+            const data = new DataEncoder(this.data).encode();
+            return (0, utils_1.concatArrays)((0, utils_1.numberToArray)(((this.type === 'data' ? BodyType.DATA : BodyType.ERROR) << 6)
+                + (compressed ? 32 : 0)
+                + XFreeSignal.version), compressed ? fflate_1.default.deflateSync(data) : data);
+        }
+        toString() {
+            return "[Object XFreeSignalBody]";
+        }
+        toJSON() {
+            return JSON.stringify({
+                type: this.type,
+                data: this.data
+            });
+        }
+        static from(array) {
+            return new Body(BodyType.getName((array[0] & 64) >> 6), DataEncoder.from((array[0] & 32) >> 5 === 1 ? fflate_1.default.inflateSync(array.subarray(1)) : array.subarray(1)).data);
+        }
+    }
+})(XFreeSignal || (exports.XFreeSignal = XFreeSignal = {}));

package/x3dh.js

@@ -94,7 +94,7 @@ class KeyExchange {
             ...onetimePreKey ? crypto_1.default.ECDH.scalarMult(ephemeralKey.secretKey, onetimePreKey) : new Uint8Array()
         ]), new Uint8Array(double_ratchet_1.KeySession.rootKeyLength).fill(0), KeyExchange.hkdfInfo, double_ratchet_1.KeySession.rootKeyLength);
         const session = new double_ratchet_1.KeySession({ remoteKey: identityKey, rootKey });
-        const cyphertext = session.encrypt((0, utils_1.concatUint8Array)(crypto_1.default.hash(this._identityKey.publicKey), crypto_1.default.hash(identityKey)));
+        const cyphertext = session.encrypt((0, utils_1.concatArrays)(crypto_1.default.hash(this._identityKey.publicKey), crypto_1.default.hash(identityKey)));
         if (!cyphertext)
             throw new Error("Decryption error");
         return {
@@ -135,7 +135,7 @@ class KeyExchange {
             const cleartext = session.decrypt((0, utils_1.encodeBase64)(message.associatedData));
             if (!cleartext)
                 throw new Error("Error decrypting ACK message");
-            if (!(0, utils_1.verifyUint8Array)(cleartext, (0, utils_1.concatUint8Array)(crypto_1.default.hash(identityKey), crypto_1.default.hash(this._identityKey.publicKey))))
+            if (!(0, utils_1.verifyArrays)(cleartext, (0, utils_1.concatArrays)(crypto_1.default.hash(identityKey), crypto_1.default.hash(this._identityKey.publicKey))))
                 throw new Error("Error verifing Associated Data");
             return {
                 session,