Relays and mailboxes

.eslintrc.json

@@ -17,13 +17,16 @@
     "@typescript-eslint"
   ],
   "rules": {
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/no-empty-function": [
       "error",
       { "allow" : ["constructors"] }
     ],
     "indent": [
       "error",
-      2
+      2,
+      { "SwitchCase": 1 }
     ],
     "linebreak-style": [
       "error",

README.md

@@ -1,2 +1,8 @@
 # glow.ts
 Client library for interacting with Zax Cryptographic Relay
+
+## Running tests
+
+Unit tests are powered by [Jest](https://jestjs.io). The engine runs all the tests in each `describe` section serially in the order they are described in the `.spec.ts` file.
+By default, unit tests connect to a remote [Zax](https://github.com/vault12/zax) Cryptographic Relay Server on `https://z.vault12.com`.
+You may also run tests on a local or any other test server by modifying the code in [src/tests.helper.ts#L1](src/tests.helper.ts#L1).

jest.config.ts

@@ -11,6 +11,7 @@ const config: Config.InitialOptions = {
   setupFiles: ['jest-localstorage-mock'],
   preset: 'ts-jest',
   testEnvironment: 'jsdom', // TODO: run tests through both 'node' and 'jsdom'
+  testTimeout: 10000,
   verbose: true
 };
 export default config;

package.json

@@ -33,17 +33,21 @@
   "main": "dist/glow.js",
   "types": "dist/types/index.d.ts",
   "dependencies": {
+    "async-mutex": "0.3.1",
+    "axios": "0.21.1",
     "js-sha256": "0.9.0",
     "tweetnacl": "1.0.3"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "4.8.2",
-    "@typescript-eslint/parser": "4.8.2",
-    "eslint": "7.14.0",
+    "@types/jest": "26.0.20",
+    "@typescript-eslint/eslint-plugin": "4.18.0",
+    "@typescript-eslint/parser": "4.18.0",
+    "axios-mock-adapter": "1.19.0",
+    "eslint": "7.22.0",
     "jest": "26.6.3",
-    "jest-localstorage-mock": "2.4.4",
-    "ts-jest": "26.4.4",
-    "ts-node": "9.0.0",
-    "typescript": "4.1.2"
+    "jest-localstorage-mock": "2.4.8",
+    "ts-jest": "26.5.3",
+    "ts-node": "9.1.1",
+    "typescript": "4.2.3"
   }
 }

src/config.ts

@@ -1,16 +1,10 @@
 export const config = {
-
-  COMM_KEY_TAG: '__::commKey::__',
   NONCE_TAG: '__nc',
   STORAGE_ROOT: '.v2.stor.vlt12',
   // Relay tokens, keys and hashes are 32 bytes
   RELAY_TOKEN_LEN: 32,
-
-  RELAY_TOKEN_B64: 44,
-
-  // 5 min - Matched with config.x.relay.token_timeout
+  // 5 min - Token expiration on the server side, matched with config.x.relay.token_timeout on Zax server
   RELAY_TOKEN_TIMEOUT: 5 * 60 * 1000,
-
-  // 15 min - Matched with config.x.relay.session_timeout
-  RELAY_SESSION_TIMEOUT: 15 * 60 * 1000
+  // 5 sec - Ajax request timeout
+  RELAY_AJAX_TIMEOUT: 5 * 1000
 };

src/crypto-storage/crypto-storage.spec.ts

@@ -1,15 +1,12 @@
 import { CryptoStorage } from './crypto-storage';
 import { LocalStorageDriver } from './local-storage.driver';
 import { NaCl } from '../nacl/nacl';
-import { NaClDriver } from '../nacl/nacl-driver.interface';
 
 describe('CryptoStorage', () => {
-  let nacl: NaClDriver;
   let storage: CryptoStorage;
 
   beforeAll(async () => {
     NaCl.setInstance();
-    nacl = NaCl.getInstance();
     storage = await CryptoStorage.new(new LocalStorageDriver(), 'test');
   });
 

src/crypto-storage/crypto-storage.ts

@@ -29,10 +29,10 @@ export class CryptoStorage {
 
   async save(tag: string, data: unknown): Promise<boolean> {
     if (!this.driver) {
-      throw new Error('Storage driver is not set');
+      throw new Error('[CryptoStorage] Storage driver is not set');
     }
     if (!this.storageKey) {
-      throw new Error('Storage key is not set');
+      throw new Error('[CryptoStorage] Storage key is not set');
     }
     // Convert the data to JSON, then convert that string to a byte array
     const input = JSON.stringify(data);
@@ -48,10 +48,10 @@ export class CryptoStorage {
 
   async get(tag: string): Promise<unknown> {
     if (!this.driver) {
-      throw new Error('Storage driver is not set');
+      throw new Error('[CryptoStorage] Storage driver is not set');
     }
     if (!this.storageKey) {
-      throw new Error('Storage key is not set');
+      throw new Error('[CryptoStorage] Storage key is not set');
     }
     // Get cipher text and nonce from the storage
     const data = await this.driver.get(this.addPrefix(tag));
@@ -67,13 +67,13 @@ export class CryptoStorage {
       const decoded = await this.nacl.decode_utf8(source);
       return JSON.parse(decoded);
     } else {
-      throw new Error('crypto_secretbox_open: decryption error');
+      throw new Error('[CryptoStorage] crypto_secretbox_open: decryption error');
     }
   }
 
   async remove(tag: string): Promise<boolean> {
     if (!this.driver) {
-      throw new Error('Storage driver is not set');
+      throw new Error('[CryptoStorage] Storage driver is not set');
     }
     await this.driver.remove(this.addPrefix(tag));
     await this.driver.remove(this.addNonceTag(tag));

src/keyring/keyring.spec.ts

@@ -2,7 +2,6 @@ import { KeyRing } from './keyring';
 import { NaCl } from '../nacl/nacl';
 import { NaClDriver } from '../nacl/nacl-driver.interface';
 import { Keys } from '../keys/keys';
-import { config } from '../config';
 import { Utils } from '../utils/utils';
 
 describe('Keyring', () => {
@@ -40,7 +39,7 @@ describe('Keyring', () => {
 
     const aliceKey = new Keys(await nacl.crypto_box_keypair());
     await ring.addGuest('Alice', aliceKey.publicKey);
-    const hpk = Utils.toBase64(await nacl.h2(aliceKey.publicKey));
+    const hpk = Utils.toBase64(await nacl.h2(Utils.fromBase64(aliceKey.publicKey)));
     expect(ring.getTagByHpk(hpk)).not.toBeNull();
     expect(ring.getTagByHpk('Bob')).toBeNull();
   });
@@ -61,29 +60,8 @@ describe('Keyring', () => {
     for (let i = 0; i < 10; i++) {
       expect(originalRing.getGuestKey(`keys${i}`)).toEqual(restored.getGuestKey(`keys${i}`));
     }
-    expect(originalRing.getHpk()).toEqual(restored.getHpk());
+    expect(await originalRing.getHpk()).toEqual(await restored.getHpk());
 
     expect(backup).toBe(backedUpAgain);
   });
-
-  it('temporary keys', async () => {
-    jest.useFakeTimers();
-    // mock config value
-    config.RELAY_SESSION_TIMEOUT = 100;
-    const ring = await KeyRing.new('test5');
-    const keys = new Keys(await nacl.crypto_box_keypair());
-    await ring.addTempGuest('temp', keys.publicKey);
-    // the key has to exist before we run the timer
-    expect(ring.getGuestKey('temp')).not.toBeNull();
-    // the key should not have expired yet
-    expect(ring.getTimeToGuestExpiration('temp')).toBeGreaterThan(0);
-
-    jest.runAllTimers();
-
-    expect(setTimeout).toHaveBeenCalledTimes(1);
-    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 100);
-    // the key and timeout are erased
-    expect(ring.getNumberOfGuests()).toBe(0);
-    expect(ring.getTimeToGuestExpiration('temp')).toBe(0);
-  });
 });