@wireapp/core-crypto 0.6.0-rc.4 → 0.6.0-rc.6

package/package.json

@@ -1,63 +1,65 @@
 {
-    "name": "@wireapp/core-crypto",
-    "version": "0.6.0-rc.4",
-    "description": "CoreCrypto bindings for the Web",
-    "type": "module",
-    "module": "platforms/web/corecrypto.js",
-    "types": "platforms/web/corecrypto.d.js",
-    "scripts": {
-        "prepare": "npm run build",
-        "build": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.js",
-        "build:test": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.test.js",
-        "clean": "rm -f ./platforms/web/*.{js,ts,wasm,html} && rm -rf ./platforms/web/assets",
-        "package": "npm run build && npm pack",
-        "test:raw": "jest -c crypto-ffi/bindings/js/jest.config.js --no-cache --runInBand --verbose",
-        "test": "npm run build:test && npm run test:raw",
-        "test:cov": "npm run build:test && jest -c crypto-ffi/bindings/js/jest.config.js --coverage --no-cache --runInBand --verbose"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "files": [
-        "platforms/web"
-    ],
-    "keywords": [
-        "wire",
-        "e2ee",
-        "corecrypto",
-        "mls",
-        "proteus"
-    ],
-    "author": "Mathieu Amiot <amiot.mathieu@gmail.com>",
-    "license": "GPL-3.0",
-    "homepage": "https://github.com/wireapp/core-crypto",
-    "repository": {
-        "type": "git",
-        "url": "git@github.com:wireapp/core-crypto.git"
-    },
-    "bugs": {
-        "url": "https://github.com/wireapp/core-crypto/issues"
-    },
-    "devDependencies": {
-        "@rollup/plugin-html": "^0.2.4",
-        "@types/jest": "^29.0.1",
-        "@types/jest-dev-server": "^5.0.0",
-        "@typescript-eslint/eslint-plugin": "^5.36.2",
-        "@typescript-eslint/parser": "^5.36.2",
-        "@wasm-tool/rollup-plugin-rust": "^2.3.1",
-        "dts-bundle-generator": "^6.13.0",
-        "eslint": "^8.23.1",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "jest": "^29.0.3",
-        "jest-dev-server": "^6.1.1",
-        "prettier": "^2.7.1",
-        "puppeteer": "^17.1.3",
-        "rollup": "^2.79.0",
-        "rollup-jest": "^3.0.0",
-        "rollup-plugin-ts": "^3.0.2",
-        "ts-jest": "^29.0.0",
-        "ts-loader": "^9.3.1",
-        "typescript": "^4.8.3"
-    }
-}
+  "name": "@wireapp/core-crypto",
+  "version": "0.6.0-rc.6",
+  "description": "CoreCrypto bindings for the Web",
+  "type": "module",
+  "module": "platforms/web/corecrypto.js",
+  "types": "platforms/web/corecrypto.d.js",
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.js",
+    "build:test": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.test.js",
+    "clean": "rm -f ./platforms/web/*.{js,ts,wasm,html} && rm -rf ./platforms/web/assets",
+    "package": "npm run build && npm pack",
+    "test:raw": "jest -c crypto-ffi/bindings/js/jest.config.js --runInBand",
+    "test": "npm run build:test && npm run test:raw",
+    "test:cov": "npm run build:test && jest -c crypto-ffi/bindings/js/jest.config.js --coverage --runInBand",
+    "test:http-server": "http-server platforms/web -g -p 3000"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "platforms/web"
+  ],
+  "keywords": [
+    "wire",
+    "e2ee",
+    "corecrypto",
+    "mls",
+    "proteus"
+  ],
+  "author": "Mathieu Amiot <amiot.mathieu@gmail.com>",
+  "license": "GPL-3.0",
+  "homepage": "https://github.com/wireapp/core-crypto",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:wireapp/core-crypto.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wireapp/core-crypto/issues"
+  },
+  "devDependencies": {
+    "@rollup/plugin-html": "^1.0.2",
+    "@types/jest": "^29.4.0",
+    "@types/jest-dev-server": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.50.0",
+    "@typescript-eslint/parser": "^5.50.0",
+    "@wasm-tool/rollup-plugin-rust": "^2.3.3",
+    "dts-bundle-generator": "^7.2.0",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "http-server": "^14.1.1",
+    "jest": "^29.4.1",
+    "jest-dev-server": "^6.2.0",
+    "prettier": "^2.8.3",
+    "puppeteer": "^19.6.2",
+    "rollup": "^3.12.0",
+    "rollup-jest": "^3.1.0",
+    "rollup-plugin-ts": "^3.2.0",
+    "ts-jest": "^29.0.5",
+    "ts-loader": "^9.4.2",
+    "typescript": "^4.9.5"
+  }
+}

package/platforms/web/corecrypto.d.ts

@@ -1,4 +1,4 @@
-declare class WireE2eIdentity {
+declare class FfiWireE2EIdentity {
 	free(): void;
 	/**
 	* See [core_crypto::e2e_identity::WireE2eIdentity::directory_response]
@@ -119,6 +119,24 @@ declare class WireE2eIdentity {
 	*/
 	certificate_response(certificate_chain: string): (Uint8Array)[];
 }
+/**
+ * Error wrapper that takes care of extracting rich error details across the FFI (through JSON parsing)
+ *
+ * Whenever you're supposed to get this class (that extends `Error`) you might end up with a base `Error`
+ * in case the parsing of the message structure fails. This is unlikely but the case is still covered and fall backs automatically.
+ * More information will be found in the base `Error.cause` to inform you why the parsing has failed.
+ *
+ * Please note that in this case the extra properties will not be available.
+ */
+export declare class CoreCryptoError extends Error {
+	rustStackTrace: string;
+	proteusErrorCode: number;
+	private constructor();
+	private static fallback;
+	static build(msg: string, ...params: any[]): CoreCryptoError | Error;
+	static fromStdError(e: Error): CoreCryptoError | Error;
+	static asyncMapErr<T>(p: Promise<T>): Promise<T>;
+}
 /**
  * see [core_crypto::prelude::CiphersuiteName]
  */
@@ -308,10 +326,10 @@ export declare enum RatchetTreeType {
 	ByRef = 3
 }
 /**
- * Params for CoreCrypto initialization
+ * Params for CoreCrypto deferred initialization
  * Please note that the `entropySeed` parameter MUST be exactly 32 bytes
  */
-export interface CoreCryptoParams {
+export interface CoreCryptoDeferredParams {
 	/**
 	 * Name of the IndexedDB database
 	 */
@@ -321,11 +339,6 @@ export interface CoreCryptoParams {
 	 * This should be appropriately stored in a secure location (i.e. WebCrypto private key storage)
 	 */
 	key: string;
-	/**
-	 * MLS Client ID.
-	 * This should stay consistent as it will be verified against the stored signature & identity to validate the persisted credential
-	 */
-	clientId: ClientId;
 	/**
 	 * External PRNG entropy pool seed.
 	 * This **must** be exactly 32 bytes
@@ -336,6 +349,17 @@ export interface CoreCryptoParams {
 	 */
 	wasmFilePath?: string;
 }
+/**
+ * Params for CoreCrypto initialization
+ * Please note that the `entropySeed` parameter MUST be exactly 32 bytes
+ */
+export interface CoreCryptoParams extends CoreCryptoDeferredParams {
+	/**
+	 * MLS Client ID.
+	 * This should stay consistent as it will be verified against the stored signature & identity to validate the persisted credential
+	 */
+	clientId: ClientId;
+}
 /**
  * Data shape for adding clients to a conversation
  */
@@ -522,10 +546,11 @@ export interface CoreCryptoCallbacks {
 	 * Callback to ensure that the given `clientId` belongs to one of the provided `existingClients`
 	 * This basically allows to defer the client ID parsing logic to the caller - because CoreCrypto is oblivious to such things
 	 *
+	 * @param conversationId - id of the group/conversation
 	 * @param clientId - id of a client
 	 * @param existingClients - all the clients currently within the MLS group
 	 */
-	clientIsExistingGroupUser: (clientId: Uint8Array, existingClients: Uint8Array[]) => boolean;
+	clientIsExistingGroupUser: (conversationId: Uint8Array, clientId: Uint8Array, existingClients: Uint8Array[]) => boolean;
 }
 /**
  * Wrapper for the WASM-compiled version of CoreCrypto
@@ -571,8 +596,9 @@ export declare class CoreCrypto {
 	 * First, calling this will set up the keystore and will allow generating proteus prekeys.
 	 * Then, those keys can be traded for a clientId.
 	 * Use this clientId to initialize MLS with {@link CoreCrypto.mlsInit}.
+	 * @param params - {@link CoreCryptoDeferredParams}
 	 */
-	static deferredInit(databaseName: string, key: string, entropySeed?: Uint8Array, wasmFilePath?: string): Promise<CoreCrypto>;
+	static deferredInit({ databaseName, key, entropySeed, wasmFilePath }: CoreCryptoDeferredParams): Promise<CoreCrypto>;
 	/**
 	 * Use this after {@link CoreCrypto.deferredInit} when you have a clientId. It initializes MLS.
 	 *
@@ -963,6 +989,11 @@ export declare class CoreCrypto {
 	 * @param storeName - The name of the IndexedDB store where the data is stored
 	 */
 	proteusCryptoboxMigrate(storeName: string): Promise<void>;
+	/**
+	 * Note: this call clears out the code and resets it to 0 (aka no error)
+	 * @returns the last proteus error code that occured.
+	 */
+	proteusLastErrorCode(): Promise<number>;
 	/**
 	 * Creates an enrollment instance with private key material you can use in order to fetch
 	 * a new x509 certificate from the acme server.
@@ -985,7 +1016,7 @@ type AcmeOrder = Uint8Array;
 export declare class WireE2eIdentity {
 	#private;
 	/** @hidden */
-	constructor(e2ei: CoreCryptoFfiTypes.WireE2eIdentity, module: typeof CoreCryptoFfiTypes);
+	constructor(e2ei: CoreCryptoFfiTypes.FfiWireE2EIdentity);
 	/**
 	 * Parses the response from `GET /acme/{provisioner-name}/directory`.
 	 * Use this {@link AcmeDirectory} in the next step to fetch the first nonce from the acme server. Use