@wireapp/core-crypto 9.0.0 → 9.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wireapp/core-crypto",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "author": "Wire CoreCrypto team <team.corecrypto@wire.com>",
   "repository": {
     "type": "git",

package/src/autogenerated/core-crypto-ffi_bg.wasm.d.ts

@@ -159,6 +159,8 @@ export const __wbg_databasekey_free: (a: number, b: number) => void;
 export const databasekey_new: (a: number, b: number) => [number, number, number];
 export const migrateDatabaseKeyTypeToBytes: (a: number, b: number, c: number, d: number, e: number) => any;
 export const updateDatabaseKey: (a: number, b: number, c: number, d: number) => any;
+export const __wbg_database_free: (a: number, b: number) => void;
+export const openDatabase: (a: number, b: number, c: number) => any;
 export const __wbg_decryptedmessage_free: (a: number, b: number) => void;
 export const __wbg_get_decryptedmessage_isActive: (a: number) => number;
 export const __wbg_get_decryptedmessage_hasEpochChanged: (a: number) => number;
@@ -244,12 +246,12 @@ export const __wbg_get_decryptedmessage_senderClientId: (a: number) => number;
 export const __wbg_get_decryptedmessage_identity: (a: number) => number;
 export const __wbg_get_decryptedmessage_commitDelay: (a: number) => [number, bigint];
 export const __wbg_get_decryptedmessage_message: (a: number) => [number, number];
+export const secretkey_new: (a: number, b: number) => number;
+export const keypackage_new: (a: number, b: number) => number;
 export const welcome_new: (a: number, b: number) => number;
-export const externalsenderkey_new: (a: number, b: number) => number;
 export const conversationid_new: (a: number, b: number) => number;
 export const groupinfo_new: (a: number, b: number) => number;
-export const secretkey_new: (a: number, b: number) => number;
-export const keypackage_new: (a: number, b: number) => number;
+export const externalsenderkey_new: (a: number, b: number) => number;
 export const __wbg_proteusautoprekeybundle_free: (a: number, b: number) => void;
 export const __wbg_welcome_free: (a: number, b: number) => void;
 export const __wbg_mlstransportdata_free: (a: number, b: number) => void;
@@ -268,8 +270,8 @@ export const __wbindgen_free: (a: number, b: number, c: number) => void;
 export const __wbindgen_export_6: WebAssembly.Table;
 export const __externref_drop_slice: (a: number, b: number) => void;
 export const __externref_table_dealloc: (a: number) => void;
-export const closure1016_externref_shim: (a: number, b: number, c: any) => void;
-export const closure2577_externref_shim: (a: number, b: number, c: any) => void;
-export const closure2883_externref_shim: (a: number, b: number, c: any) => void;
-export const closure2981_externref_shim: (a: number, b: number, c: any, d: any) => void;
+export const closure2587_externref_shim: (a: number, b: number, c: any) => void;
+export const closure2899_externref_shim: (a: number, b: number, c: any) => void;
+export const closure1021_externref_shim: (a: number, b: number, c: any) => void;
+export const closure3000_externref_shim: (a: number, b: number, c: any, d: any) => void;
 export const __wbindgen_start: () => void;

package/src/corecrypto.d.ts

@@ -14,11 +14,15 @@ export function ciphersuiteDefault(): Ciphersuite;
  * Updates the key of the CoreCrypto database.
  * To be used only once, when moving from CoreCrypto <= 5.x to CoreCrypto 6.x.
  */
-export function migrateDatabaseKeyTypeToBytes(name: string, old_key: string, new_key: DatabaseKey): Promise<void>;
+export function migrateDatabaseKeyTypeToBytes(path: string, old_key: string, new_key: DatabaseKey): Promise<void>;
 /**
  * Updates the key of the CoreCrypto database.
  */
 export function updateDatabaseKey(name: string, old_key: DatabaseKey, new_key: DatabaseKey): Promise<void>;
+/**
+ * Open or create a [Database].
+ */
+export function openDatabase(name: string, key: DatabaseKey): Promise<Database>;
 /**
  * MLS ciphersuites.
  */
@@ -142,6 +146,7 @@ export enum WirePolicy {
 export class AcmeChallenge {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Contains raw JSON data of this challenge. This is parsed by the underlying Rust library hence should not be accessed
 	 */
@@ -159,6 +164,7 @@ export class AcmeChallenge {
 declare class AcmeDirectory {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * URL for fetching a new nonce. Use this only for creating a new account.
 	 */
@@ -179,6 +185,7 @@ declare class AcmeDirectory {
 declare class BufferedDecryptedMessage {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Decrypted plaintext
 	 */
@@ -227,6 +234,7 @@ export class BuildMetadata {
 	*/
 	toString(): string;
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Build Timestamp
 	 */
@@ -273,6 +281,7 @@ export class BuildMetadata {
  */
 export class ClientId {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Instantiate a client id from a byte array.
 	 */
@@ -284,6 +293,7 @@ export class ClientId {
 }
 declare class ConversationConfiguration {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a `ConversationConfiguration` from its parts.
 	 */
@@ -309,6 +319,7 @@ declare class ConversationConfiguration {
  */
 export class ConversationId {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a new instance, transferring data from the client layer to Rust.
 	 */
@@ -323,6 +334,7 @@ export class ConversationId {
 declare class CoreCryptoContext {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * See [core_crypto::transaction_context::TransactionContext::e2ei_new_enrollment]
 	 */
@@ -592,6 +604,7 @@ declare class CoreCryptoContext {
 }
 declare class CrlRegistration {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Contstruct a CRL registration from its fields
 	 */
@@ -614,6 +627,7 @@ declare class CrlRegistration {
  */
 export class CustomConfiguration {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a `CustomConfiguration` from its parts.
 	 */
@@ -639,11 +653,20 @@ export class CustomConfiguration {
 	 */
 	set wirePolicy(value: WirePolicy | null | undefined);
 }
+/**
+ * The database acting as a core crypto keystore.
+ */
+export class Database {
+	private constructor();
+	free(): void;
+	[Symbol.dispose](): void;
+}
 /**
  * The key used to encrypt the database.
  */
 export class DatabaseKey {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a new instance from a byte vector.
 	 */
@@ -652,6 +675,7 @@ export class DatabaseKey {
 declare class DecryptedMessage {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Decrypted plaintext
 	 */
@@ -700,6 +724,7 @@ declare class DecryptedMessage {
  */
 export class ExternalSenderKey {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a new instance, transferring data from the client layer to Rust.
 	 */
@@ -714,6 +739,7 @@ export class ExternalSenderKey {
 declare class FfiWireE2EIdentity {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * See [core_crypto::e2e_identity::E2eiEnrollment::directory_response]
 	 */
@@ -791,6 +817,7 @@ declare class FfiWireE2EIdentity {
  */
 export class GroupInfo {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a new instance, transferring data from the client layer to Rust.
 	 */
@@ -804,6 +831,7 @@ export class GroupInfo {
 }
 declare class KeyPackage {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a new instance, transferring data from the client layer to Rust.
 	 */
@@ -821,6 +849,7 @@ declare class KeyPackage {
  */
 export class MlsTransportData {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct `MlsTransportData` by providing data
 	 */
@@ -839,6 +868,7 @@ export class MlsTransportData {
 export class NewAcmeAuthz {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * DNS entry associated with those challenge
 	 */
@@ -861,6 +891,7 @@ export class NewAcmeAuthz {
 export class NewAcmeOrder {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Opaque raw json value
 	 */
@@ -873,6 +904,7 @@ export class NewAcmeOrder {
 declare class ProteusAutoPrekeyBundle {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Prekey id (automatically incremented)
 	 */
@@ -889,6 +921,7 @@ declare class ProteusAutoPrekeyBundle {
  */
 export class SecretKey {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a new instance, transferring data from the client layer to Rust.
 	 */
@@ -908,6 +941,7 @@ export class SecretKey {
  */
 export class Welcome {
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Construct a new instance, transferring data from the client layer to Rust.
 	 */
@@ -925,6 +959,7 @@ export class Welcome {
 export class WelcomeBundle {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Identifier of the joined conversation
 	 */
@@ -941,6 +976,7 @@ export class WelcomeBundle {
 export class WireIdentity {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * Unique client identifier e.g. `T4Coy4vdRzianwfOgXpn6A:6add501bacd1d90e@whitehouse.gov`
 	 */
@@ -971,6 +1007,7 @@ export class WireIdentity {
 export class X509Identity {
 	private constructor();
 	free(): void;
+	[Symbol.dispose](): void;
 	/**
 	 * user handle e.g. `john_wire`
 	 */
@@ -1020,11 +1057,15 @@ interface ConversationConfiguration$1 {
 	 */
 	wirePolicy?: WirePolicy;
 }
-export interface CoreCryptoRichError {
+/**
+ * The error structure produced by our rust code.
+ **/
+export interface CoreCryptoRichError<T extends ErrorType> {
 	message: string;
 	error_name?: string;
 	error_stack?: string[];
-	proteus_error_code?: number;
+	type?: T;
+	context?: ErrorContext[T];
 }
 /**
  * Error wrapper that takes care of extracting rich error details across the FFI (through JSON parsing)
@@ -1035,15 +1076,219 @@ export interface CoreCryptoRichError {
  *
  * Please note that in this case the extra properties will not be available.
  */
-export declare class CoreCryptoError extends Error {
+export declare class CoreCryptoError<T extends ErrorType> extends Error {
 	errorStack: string[];
-	proteusErrorCode: number | null;
+	context?: ErrorContext[T];
+	type?: T;
 	private constructor();
 	private static fallback;
-	static build(msg: string, ...params: unknown[]): CoreCryptoError;
-	static fromStdError(e: Error): CoreCryptoError;
-	static asyncMapErr<T>(p: Promise<T>): Promise<T>;
+	static build<E extends ErrorType>(msg: string, ...params: unknown[]): CoreCryptoError<E>;
+	static fromStdError(e: Error): CoreCryptoError<ErrorType>;
+	static asyncMapErr<T, E extends ErrorType>(p: Promise<T>): Promise<T>;
+}
+/**
+ * Helper type to ensure that error contexts match their type
+ */
+export type ErrorTypeWithContext<T> = {
+	[K in keyof T]: {
+		type: K;
+		context: T[K];
+	};
+}[keyof T];
+/**
+ * Variants of core crypto errors
+ */
+export declare enum ErrorType {
+	Mls = "Mls",
+	Proteus = "Proteus",
+	E2ei = "E2ei",
+	TransactionFailed = "TransactionFailed",
+	Other = "Other"
 }
+export declare function isCcError<E extends ErrorType>(error: unknown, errorType: E): error is CoreCryptoError<E>;
+/**
+ * Structured core crypto error
+ */
+export interface ErrorContext {
+	[ErrorType.Mls]: ErrorTypeWithContext<MlsErrorContext>;
+	[ErrorType.Proteus]: ErrorTypeWithContext<ProteusErrorContext>;
+	[ErrorType.E2ei]: {
+		e2eiError: string;
+	};
+	[ErrorType.TransactionFailed]: {
+		error: string;
+	};
+	[ErrorType.Other]: {
+		msg: string;
+	};
+}
+export declare function isE2eiError(error: unknown): error is CoreCryptoError<ErrorType.E2ei>;
+export declare function isTransactionFailedError(error: unknown): error is CoreCryptoError<ErrorType.TransactionFailed>;
+export declare function isOtherError(error: unknown): error is CoreCryptoError<ErrorType.Other>;
+/**
+ * Variants of core crypto mls errors
+ */
+export declare enum MlsErrorType {
+	ConversationAlreadyExists = "ConversationAlreadyExists",
+	DuplicateMessage = "DuplicateMessage",
+	BufferedFutureMessage = "BufferedFutureMessage",
+	WrongEpoch = "WrongEpoch",
+	BufferedCommit = "BufferedCommit",
+	MessageEpochTooOld = "MessageEpochTooOld",
+	SelfCommitIgnored = "SelfCommitIgnored",
+	UnmergedPendingGroup = "UnmergedPendingGroup",
+	StaleProposal = "StaleProposal",
+	StaleCommit = "StaleCommit",
+	/**
+	 * This happens when the DS cannot flag KeyPackages as claimed or not. In this scenario, a client
+	 * requests their old KeyPackages to be deleted but one has already been claimed by another client to create a Welcome.
+	 * In that case the only solution is that the client receiving such a Welcome tries to join the group
+	 * with an External Commit instead
+	 */
+	OrphanWelcome = "OrphanWelcome",
+	MessageRejected = "MessageRejected",
+	Other = "Other"
+}
+/**
+ * Structured core crypto mls error (embedded in a core crypto error)
+ */
+export interface MlsErrorContext {
+	[MlsErrorType.ConversationAlreadyExists]: {
+		conversationId: Array<number>;
+	};
+	[MlsErrorType.DuplicateMessage]: Record<string, never>;
+	[MlsErrorType.BufferedFutureMessage]: Record<string, never>;
+	[MlsErrorType.WrongEpoch]: Record<string, never>;
+	[MlsErrorType.BufferedCommit]: Record<string, never>;
+	[MlsErrorType.MessageEpochTooOld]: Record<string, never>;
+	[MlsErrorType.SelfCommitIgnored]: Record<string, never>;
+	[MlsErrorType.UnmergedPendingGroup]: Record<string, never>;
+	[MlsErrorType.StaleProposal]: Record<string, never>;
+	[MlsErrorType.StaleCommit]: Record<string, never>;
+	[MlsErrorType.OrphanWelcome]: Record<string, never>;
+	[MlsErrorType.MessageRejected]: {
+		reason: string;
+	};
+	[MlsErrorType.Other]: {
+		msg: string;
+	};
+}
+export declare function isMlsError<E extends MlsErrorType>(error: unknown, errorType: E): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: E;
+	}>;
+};
+export declare function isMlsConversationAlreadyExistsError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.ConversationAlreadyExists;
+	}>;
+};
+export declare function isMlsDuplicateMessageError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.DuplicateMessage;
+	}>;
+};
+export declare function isMlsBufferedFutureMessageError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.BufferedFutureMessage;
+	}>;
+};
+export declare function isMlsWrongEpochError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.WrongEpoch;
+	}>;
+};
+export declare function isMlsBufferedCommitError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.BufferedCommit;
+	}>;
+};
+export declare function isMlsSelfCommitIgnoredError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.SelfCommitIgnored;
+	}>;
+};
+export declare function isMlsUnmergedPendingGroupError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.UnmergedPendingGroup;
+	}>;
+};
+export declare function isMlsStaleProposalError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.StaleProposal;
+	}>;
+};
+export declare function isMlsStaleCommitError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.StaleCommit;
+	}>;
+};
+export declare function isMlsOrphanWelcomeError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.OrphanWelcome;
+	}>;
+};
+export declare function isMlsMessageRejectedError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.MessageRejected;
+	}>;
+};
+export declare function isMlsOtherError(error: unknown): error is CoreCryptoError<ErrorType.Mls> & {
+	context: Extract<ErrorContext[ErrorType.Mls], {
+		type: MlsErrorType.Other;
+	}>;
+};
+/**
+ * Variants of core crypto proteus errors
+ */
+export declare enum ProteusErrorType {
+	SessionNotFound = "SessionNotFound",
+	DuplicateMessage = "DuplicateMessage",
+	RemoteIdentityChanged = "RemoteIdentityChanged",
+	Other = "Other"
+}
+/**
+ * Structured core crypto proteus error (embedded in a core crypto error)
+ */
+export interface ProteusErrorContext {
+	[ProteusErrorType.SessionNotFound]: {
+		errorCode: number;
+	};
+	[ProteusErrorType.DuplicateMessage]: {
+		errorCode: number;
+	};
+	[ProteusErrorType.RemoteIdentityChanged]: {
+		errorCode: number;
+	};
+	[ProteusErrorType.Other]: {
+		errorCode: number;
+	};
+}
+export declare function isProteusError<E extends ProteusErrorType>(error: unknown, errorType: E): error is CoreCryptoError<ErrorType.Proteus> & {
+	context: Extract<ErrorContext[ErrorType.Proteus], {
+		type: E;
+	}>;
+};
+export declare function isProteusSessionNotFoundError(error: unknown): error is CoreCryptoError<ErrorType.Proteus> & {
+	context: Extract<ErrorContext[ErrorType.Proteus], {
+		type: ProteusErrorType.SessionNotFound;
+	}>;
+};
+export declare function isProteusDuplicateMessageError(error: unknown): error is CoreCryptoError<ErrorType.Proteus> & {
+	context: Extract<ErrorContext[ErrorType.Proteus], {
+		type: ProteusErrorType.DuplicateMessage;
+	}>;
+};
+export declare function isProteusRemoteIdentityChangedError(error: unknown): error is CoreCryptoError<ErrorType.Proteus> & {
+	context: Extract<ErrorContext[ErrorType.Proteus], {
+		type: ProteusErrorType.RemoteIdentityChanged;
+	}>;
+};
+export declare function isProteusOtherError(error: unknown): error is CoreCryptoError<ErrorType.Proteus> & {
+	context: Extract<ErrorContext[ErrorType.Proteus], {
+		type: ProteusErrorType.Other;
+	}>;
+};
 /**
  * Alias for proposal reference. It is a byte array of size 16.
  */