@signalapp/libsignal-client 0.52.1 → 0.52.4

package/Native.d.ts

@@ -192,6 +192,9 @@ export function ChatService_unauth_send_and_debug(asyncRuntime: Wrapper<TokioAsy
 export function CiphertextMessage_FromPlaintextContent(m: Wrapper<PlaintextContent>): CiphertextMessage;
 export function CiphertextMessage_Serialize(obj: Wrapper<CiphertextMessage>): Buffer;
 export function CiphertextMessage_Type(msg: Wrapper<CiphertextMessage>): number;
+export function ComparableBackup_GetComparableString(backup: Wrapper<ComparableBackup>): string;
+export function ComparableBackup_GetUnknownFields(backup: Wrapper<ComparableBackup>): string[];
+export function ComparableBackup_ReadUnencrypted(stream: InputStream, len: bigint, purpose: number): Promise<ComparableBackup>;
 export function ConnectionManager_clear_proxy(connectionManager: Wrapper<ConnectionManager>): void;
 export function ConnectionManager_new(environment: number, userAgent: string): ConnectionManager;
 export function ConnectionManager_set_ipv6_enabled(connectionManager: Wrapper<ConnectionManager>, ipv6Enabled: boolean): void;
@@ -505,6 +508,7 @@ export function TESTING_FutureFailure(asyncRuntime: Wrapper<NonSuspendingBackgro
 export function TESTING_FutureProducesOtherPointerType(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, input: string): Promise<OtherTestingHandleType>;
 export function TESTING_FutureProducesPointerType(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, input: number): Promise<TestingHandleType>;
 export function TESTING_FutureSuccess(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, input: number): Promise<number>;
+export function TESTING_InputStreamReadIntoZeroLengthSlice(capsAlphabetInput: InputStream): Promise<Buffer>;
 export function TESTING_NonSuspendingBackgroundThreadRuntime_New(): NonSuspendingBackgroundThreadRuntime;
 export function TESTING_OnlyCompletesByCancellation(asyncRuntime: Wrapper<TokioAsyncContext>): Promise<void>;
 export function TESTING_OtherTestingHandleType_getValue(handle: Wrapper<OtherTestingHandleType>): string;
@@ -547,10 +551,13 @@ export function ValidatingMac_Initialize(key: Buffer, chunkSize: number, digests
 export function ValidatingMac_Update(mac: Wrapper<ValidatingMac>, bytes: Buffer, offset: number, length: number): number;
 export function WebpSanitizer_Sanitize(input: SyncInputStream): void;
 export function initLogger(maxLevel: LogLevel, callback: (level: LogLevel, target: string, file: string | null, line: number | null, message: string) => void): void
+export function test_only_fn_returns_123(): number;
 interface Aes256GcmSiv { readonly __type: unique symbol; }
 interface CdsiLookup { readonly __type: unique symbol; }
 interface Chat { readonly __type: unique symbol; }
 interface CiphertextMessage { readonly __type: unique symbol; }
+interface ComparableBackup { readonly __type: unique symbol; }
+interface ComparableBackup { readonly __type: unique symbol; }
 interface ConnectionManager { readonly __type: unique symbol; }
 interface DecryptionErrorMessage { readonly __type: unique symbol; }
 interface ExpiringProfileKeyCredential { readonly __type: unique symbol; }

package/dist/Errors.d.ts

@@ -36,7 +36,8 @@ export declare enum ErrorCode {
     ChatServiceInactive = 32,
     AppExpired = 33,
     DeviceDelinked = 34,
-    Cancelled = 35
+    BackupValidation = 35,
+    Cancelled = 36
 }
 export declare class LibSignalErrorBase extends Error {
     readonly code: ErrorCode;
@@ -156,6 +157,10 @@ export type SvrRestoreFailedError = LibSignalErrorCommon & {
     code: ErrorCode.SvrRestoreFailed;
     readonly triesRemaining: number;
 };
+export type BackupValidationError = LibSignalErrorCommon & {
+    code: ErrorCode.BackupValidation;
+    readonly unknownFields: ReadonlyArray<string>;
+};
 export type CancellationError = LibSignalErrorCommon & {
     code: ErrorCode.Cancelled;
 };

package/dist/Errors.js

@@ -43,7 +43,8 @@ var ErrorCode;
     ErrorCode[ErrorCode["ChatServiceInactive"] = 32] = "ChatServiceInactive";
     ErrorCode[ErrorCode["AppExpired"] = 33] = "AppExpired";
     ErrorCode[ErrorCode["DeviceDelinked"] = 34] = "DeviceDelinked";
-    ErrorCode[ErrorCode["Cancelled"] = 35] = "Cancelled";
+    ErrorCode[ErrorCode["BackupValidation"] = 35] = "BackupValidation";
+    ErrorCode[ErrorCode["Cancelled"] = 36] = "Cancelled";
 })(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
 class LibSignalErrorBase extends Error {
     constructor(message, name, operation, extraProps) {

package/dist/MessageBackup.d.ts

@@ -56,3 +56,47 @@ export declare enum Purpose {
  * @throws IoError If an IO error on the input occurs.
  */
 export declare function validate(backupKey: MessageBackupKey, purpose: Purpose, inputFactory: InputStreamFactory, length: bigint): Promise<ValidationOutcome>;
+/**
+ * An in-memory representation of a backup file used to compare contents.
+ *
+ * When comparing the contents of two backups:
+ *   1. Create a `ComparableBackup` instance for each of the inputs.
+ *   2. Check the `unknownFields()` value; if it's not empty, some parts of the
+ *      backup weren't parsed and won't be compared.
+ *   3. Produce a canonical string for each backup with `comparableString()`.
+ *   4. Compare the canonical string representations.
+ *
+ * The diff of the canonical strings (which may be rather large) will show the
+ * differences between the logical content of the input backup files.
+ */
+export declare class ComparableBackup {
+    readonly _nativeHandle: Native.ComparableBackup;
+    constructor(handle: Native.ComparableBackup);
+    /**
+     * Read an unencrypted backup file into memory for comparison.
+     *
+     * @param purpose Whether the backup is intended for device-to-device transfer or remote storage.
+     * @param input An input stream that reads the backup contents.
+     * @param length The exact length of the input stream.
+     * @returns The in-memory representation.
+     * @throws BackupValidationError If an IO error occurs or the input is invalid.
+     */
+    static fromUnencrypted(purpose: Purpose, input: InputStream, length: bigint): Promise<ComparableBackup>;
+    /**
+     * Produces a string representation of the contents.
+     *
+     * The returned strings for two backups will be equal if the backups contain
+     * the same logical content. If two backups' strings are not equal, the diff
+     * will show what is different between them.
+     *
+     * @returns a canonical string representation of the backup
+     */
+    comparableString(): string;
+    /**
+     * Unrecognized protobuf fields present in the backup.
+     *
+     * If this is not empty, some parts of the backup were not recognized and
+     * won't be present in the string representation.
+     */
+    get unknownFields(): Array<string>;
+}

package/dist/MessageBackup.js

@@ -4,7 +4,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = exports.Purpose = exports.MessageBackupKey = exports.ValidationOutcome = void 0;
+exports.ComparableBackup = exports.validate = exports.Purpose = exports.MessageBackupKey = exports.ValidationOutcome = void 0;
 /**
  * Message backup validation routines.
  *
@@ -66,4 +66,57 @@ async function validate(backupKey, purpose, inputFactory, length) {
     return new ValidationOutcome(await Native.MessageBackupValidator_Validate(backupKey, firstStream, secondStream, length, purpose));
 }
 exports.validate = validate;
+/**
+ * An in-memory representation of a backup file used to compare contents.
+ *
+ * When comparing the contents of two backups:
+ *   1. Create a `ComparableBackup` instance for each of the inputs.
+ *   2. Check the `unknownFields()` value; if it's not empty, some parts of the
+ *      backup weren't parsed and won't be compared.
+ *   3. Produce a canonical string for each backup with `comparableString()`.
+ *   4. Compare the canonical string representations.
+ *
+ * The diff of the canonical strings (which may be rather large) will show the
+ * differences between the logical content of the input backup files.
+ */
+class ComparableBackup {
+    constructor(handle) {
+        this._nativeHandle = handle;
+    }
+    /**
+     * Read an unencrypted backup file into memory for comparison.
+     *
+     * @param purpose Whether the backup is intended for device-to-device transfer or remote storage.
+     * @param input An input stream that reads the backup contents.
+     * @param length The exact length of the input stream.
+     * @returns The in-memory representation.
+     * @throws BackupValidationError If an IO error occurs or the input is invalid.
+     */
+    static async fromUnencrypted(purpose, input, length) {
+        const handle = await Native.ComparableBackup_ReadUnencrypted(input, length, purpose);
+        return new ComparableBackup(handle);
+    }
+    /**
+     * Produces a string representation of the contents.
+     *
+     * The returned strings for two backups will be equal if the backups contain
+     * the same logical content. If two backups' strings are not equal, the diff
+     * will show what is different between them.
+     *
+     * @returns a canonical string representation of the backup
+     */
+    comparableString() {
+        return Native.ComparableBackup_GetComparableString(this);
+    }
+    /**
+     * Unrecognized protobuf fields present in the backup.
+     *
+     * If this is not empty, some parts of the backup were not recognized and
+     * won't be present in the string representation.
+     */
+    get unknownFields() {
+        return Native.ComparableBackup_GetUnknownFields(this);
+    }
+}
+exports.ComparableBackup = ComparableBackup;
 //# sourceMappingURL=MessageBackup.js.map

package/dist/acknowledgments.md

@@ -669,7 +669,7 @@ For more information on this, and how to apply and follow the GNU AGPL, see
 
 ```
 
-## attest 0.1.0, libsignal-ffi 0.52.0, libsignal-jni 0.52.0, libsignal-node 0.52.0, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-bridge-types 0.1.0, libsignal-core 0.1.0, signal-crypto 0.1.0, device-transfer 0.1.0, signal-media 0.1.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, signal-pin 0.1.0, poksho 0.7.0, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
+## attest 0.1.0, libsignal-ffi 0.52.4, libsignal-jni 0.52.4, libsignal-jni-testing 0.52.4, libsignal-node 0.52.4, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-bridge-testing 0.1.0, libsignal-bridge-types 0.1.0, libsignal-core 0.1.0, signal-crypto 0.1.0, device-transfer 0.1.0, signal-media 0.1.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, signal-pin 0.1.0, poksho 0.7.0, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
 
 ```
 GNU AFFERO GENERAL PUBLIC LICENSE
@@ -5576,6 +5576,38 @@ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
 IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 
+```
+
+## zerocopy-derive 0.7.34, zerocopy 0.7.34
+
+```
+Copyright 2023 The Fuchsia Authors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+
 ```
 
 ## encoding_rs 0.8.34
@@ -6188,21 +6220,6 @@ SOFTWARE.
 
 ```
 
-## bytemuck 1.16.0
-
-```
-MIT License
-
-Copyright (c) 2019 Daniel "Lokathor" Gee.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-```
-
 ## lazycell 1.3.0
 
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/libsignal-client",
-  "version": "0.52.1",
+  "version": "0.52.4",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,7 +17,7 @@
     "prebuilds/*/*.node"
   ],
   "scripts": {
-    "install": "node-gyp-build",
+    "install": "echo Use \\`npx node-gyp rebuild\\` to build the native library from scratch if needed",
     "build": "node-gyp build",
     "build-with-debug-level-logs": "npx --libsignal-debug-level-logs node-gyp build",
     "tsc": "tsc -b",