@wireapp/core-crypto 0.6.0-rc.5 → 0.6.0-rc.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wireapp/core-crypto",
-  "version": "0.6.0-rc.5",
+  "version": "0.6.0-rc.7",
   "description": "CoreCrypto bindings for the Web",
   "type": "module",
   "module": "platforms/web/corecrypto.js",
@@ -11,9 +11,10 @@
     "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: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 --no-cache --runInBand --verbose"
+    "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"
@@ -39,25 +40,26 @@
     "url": "https://github.com/wireapp/core-crypto/issues"
   },
   "devDependencies": {
-    "@rollup/plugin-html": "^0.2.4",
-    "@types/jest": "^29.0.1",
+    "@rollup/plugin-html": "^1.0.2",
+    "@types/jest": "^29.4.0",
     "@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",
+    "@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",
-    "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"
+    "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,123 +1,20 @@
-declare class WireE2eIdentity {
-	free(): void;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::directory_response]
-	* @param {Uint8Array} directory
-	* @returns {any}
-	*/
-	directory_response(directory: Uint8Array): any;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_account_request]
-	* @param {any} directory
-	* @param {string} previous_nonce
-	* @returns {Uint8Array}
-	*/
-	new_account_request(directory: any, previous_nonce: string): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_account_response]
-	* @param {Uint8Array} account
-	* @returns {Uint8Array}
-	*/
-	new_account_response(account: Uint8Array): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_order_request]
-	* @param {string} handle
-	* @param {string} client_id
-	* @param {number} expiry_days
-	* @param {any} directory
-	* @param {Uint8Array} account
-	* @param {string} previous_nonce
-	* @returns {Uint8Array}
-	*/
-	new_order_request(handle: string, client_id: string, expiry_days: number, directory: any, account: Uint8Array, previous_nonce: string): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_order_response]
-	* @param {Uint8Array} order
-	* @returns {any}
-	*/
-	new_order_response(order: Uint8Array): any;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_authz_request]
-	* @param {string} url
-	* @param {Uint8Array} account
-	* @param {string} previous_nonce
-	* @returns {Uint8Array}
-	*/
-	new_authz_request(url: string, account: Uint8Array, previous_nonce: string): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_authz_response]
-	* @param {Uint8Array} authz
-	* @returns {any}
-	*/
-	new_authz_response(authz: Uint8Array): any;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::create_dpop_token]
-	* @param {string} access_token_url
-	* @param {string} user_id
-	* @param {bigint} client_id
-	* @param {string} domain
-	* @param {any} client_id_challenge
-	* @param {string} backend_nonce
-	* @param {number} expiry_days
-	* @returns {string}
-	*/
-	create_dpop_token(access_token_url: string, user_id: string, client_id: bigint, domain: string, client_id_challenge: any, backend_nonce: string, expiry_days: number): string;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_challenge_request]
-	* @param {any} handle_challenge
-	* @param {Uint8Array} account
-	* @param {string} previous_nonce
-	* @returns {Uint8Array}
-	*/
-	new_challenge_request(handle_challenge: any, account: Uint8Array, previous_nonce: string): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::new_challenge_response]
-	* @param {Uint8Array} challenge
-	*/
-	new_challenge_response(challenge: Uint8Array): void;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::check_order_request]
-	* @param {string} order_url
-	* @param {Uint8Array} account
-	* @param {string} previous_nonce
-	* @returns {Uint8Array}
-	*/
-	check_order_request(order_url: string, account: Uint8Array, previous_nonce: string): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::check_order_response]
-	* @param {Uint8Array} order
-	* @returns {Uint8Array}
-	*/
-	check_order_response(order: Uint8Array): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::finalize_request]
-	* @param {(Uint8Array)[]} domains
-	* @param {Uint8Array} order
-	* @param {Uint8Array} account
-	* @param {string} previous_nonce
-	* @returns {Uint8Array}
-	*/
-	finalize_request(domains: (Uint8Array)[], order: Uint8Array, account: Uint8Array, previous_nonce: string): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::finalize_response]
-	* @param {Uint8Array} finalize
-	* @returns {any}
-	*/
-	finalize_response(finalize: Uint8Array): any;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::certificate_request]
-	* @param {any} finalize
-	* @param {Uint8Array} account
-	* @param {string} previous_nonce
-	* @returns {Uint8Array}
-	*/
-	certificate_request(finalize: any, account: Uint8Array, previous_nonce: string): Uint8Array;
-	/**
-	* See [core_crypto::e2e_identity::WireE2eIdentity::certificate_response]
-	* @param {string} certificate_chain
-	* @returns {(Uint8Array)[]}
-	*/
-	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 +205,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 +218,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 +228,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
  */
@@ -572,8 +475,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.
 	 *
@@ -964,6 +868,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.
@@ -986,7 +895,7 @@ type AcmeOrder = Uint8Array;
 export declare class WireE2eIdentity {
 	#private;
 	/** @hidden */
-	constructor(e2ei: CoreCryptoFfiTypes.WireE2eIdentity, module: typeof CoreCryptoFfiTypes);
+	constructor(e2ei: unknown);
 	/**
 	 * 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
@@ -1103,13 +1012,13 @@ export declare class WireE2eIdentity {
 	/**
 	 * Final step before fetching the certificate.
 	 *
-	 * @param domains you want to generate a certificate for e.g. `["wire.com"]`
-	 * @param order you got from {@link checkOrderResponse}
-	 * @param account you found after {@link newAccountResponse}
-	 * @param previousNonce `replay-nonce` response header from `POST /acme/{provisioner-name}/order/{order-id}`
+	 * @param domains - domains you want to generate a certificate for e.g. `["wire.com"]`
+	 * @param order - order you got from {@link checkOrderResponse}
+	 * @param account - account you found after {@link newAccountResponse}
+	 * @param previousNonce - `replay-nonce` response header from `POST /acme/{provisioner-name}/order/{order-id}`
 	 * @see https://www.rfc-editor.org/rfc/rfc8555.html#section-7.4
 	 */
-	finalizeRequest(domains: Uint8Array[], order: AcmeOrder, account: AcmeAccount, previousNonce: string): JsonRawData;
+	finalizeRequest(domains: string[], order: AcmeOrder, account: AcmeAccount, previousNonce: string): JsonRawData;
 	/**
 	 * Parses the response from `POST /acme/{provisioner-name}/order/{order-id}/finalize`.
 	 *