@signalapp/libsignal-client 0.58.2 → 0.59.0

package/Native.d.ts

@@ -143,6 +143,7 @@ type Serialized<T> = Buffer;
 export function registerErrors(errorsModule: Record<string, unknown>): void;
 
 export const enum LogLevel { Error = 1, Warn, Info, Debug, Trace }
+export function AccountEntropyPool_Generate(): string;
 export function Aes256GcmSiv_Decrypt(aesGcmSiv: Wrapper<Aes256GcmSiv>, ctext: Buffer, nonce: Buffer, associatedData: Buffer): Buffer;
 export function Aes256GcmSiv_Encrypt(aesGcmSivObj: Wrapper<Aes256GcmSiv>, ptext: Buffer, nonce: Buffer, associatedData: Buffer): Buffer;
 export function Aes256GcmSiv_New(key: Buffer): Aes256GcmSiv;
@@ -507,6 +508,7 @@ export function TESTING_ChatServiceResponseConvert(bodyPresent: boolean): ChatRe
 export function TESTING_ChatService_InjectConnectionInterrupted(chat: Wrapper<AuthChat>): void;
 export function TESTING_ChatService_InjectIntentionalDisconnect(chat: Wrapper<AuthChat>): void;
 export function TESTING_ChatService_InjectRawServerRequest(chat: Wrapper<AuthChat>, bytes: Buffer): void;
+export function TESTING_ConnectionManager_newLocalOverride(userAgent: string, chatPort: number, cdsiPort: number, svr2Port: number, svr3SgxPort: number, svr3NitroPort: number, svr3Tpm2SnpPort: number, rootCertificateDer: Buffer): ConnectionManager;
 export function TESTING_ErrorOnBorrowAsync(_input: null): Promise<void>;
 export function TESTING_ErrorOnBorrowIo(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, _input: null): Promise<void>;
 export function TESTING_ErrorOnBorrowSync(_input: null): void;

package/dist/AccountKeys.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The randomly-generated user-memorized entropy used to derive the backup key,
+ *    with other possible future uses.
+ *
+ * Contains log_2(36^64) = ~330 bits of entropy.
+ */
+export declare class AccountEntropyPool {
+    /**
+     * Randomly generates an Account Entropy Pool and returns the cannonical string
+     *  representation of that pool.
+     *
+     * @returns cryptographically random 64 character string of characters a-z, 0-9
+     */
+    static generate(): string;
+}

package/dist/AccountKeys.js

@@ -0,0 +1,34 @@
+"use strict";
+//
+// Copyright 2024 Signal Messenger, LLC.
+// SPDX-License-Identifier: AGPL-3.0-only
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountEntropyPool = void 0;
+/**
+ * Cryptographic hashing, randomness generation, etc. related to SVR/Backup Keys.
+ *
+ * Currently only the Account Entropy Pool is exposed, because no other functionality is used on Desktop.
+ *
+ * @module AccountKeys
+ */
+const Native = require("../Native");
+/**
+ * The randomly-generated user-memorized entropy used to derive the backup key,
+ *    with other possible future uses.
+ *
+ * Contains log_2(36^64) = ~330 bits of entropy.
+ */
+class AccountEntropyPool {
+    /**
+     * Randomly generates an Account Entropy Pool and returns the cannonical string
+     *  representation of that pool.
+     *
+     * @returns cryptographically random 64 character string of characters a-z, 0-9
+     */
+    static generate() {
+        return Native.AccountEntropyPool_Generate();
+    }
+}
+exports.AccountEntropyPool = AccountEntropyPool;
+//# sourceMappingURL=AccountKeys.js.map

package/dist/Errors.d.ts

@@ -46,6 +46,12 @@ export declare class LibSignalErrorBase extends Error {
     constructor(message: string, name: keyof typeof ErrorCode | undefined, operation: string, extraProps?: Record<string, unknown>);
     get addr(): ProtocolAddress | string;
     toString(): string;
+    is<E extends ErrorCode>(code: E): this is Extract<LibSignalError, {
+        code: E;
+    }>;
+    static is<E extends ErrorCode>(error: unknown, code: E): error is Extract<LibSignalError, {
+        code: E;
+    }>;
 }
 export type LibSignalErrorCommon = Omit<LibSignalErrorBase, 'addr'>;
 export type GenericError = LibSignalErrorCommon & {
@@ -165,4 +171,4 @@ export type BackupValidationError = LibSignalErrorCommon & {
 export type CancellationError = LibSignalErrorCommon & {
     code: ErrorCode.Cancelled;
 };
-export type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError | NicknameCannotBeEmptyError | CannotStartWithDigitError | MissingSeparatorError | BadNicknameCharacterError | NicknameTooShortError | NicknameTooLongError | DiscriminatorCannotBeEmptyError | DiscriminatorCannotBeZeroError | DiscriminatorCannotBeSingleDigitError | DiscriminatorCannotHaveLeadingZerosError | BadDiscriminatorCharacterError | DiscriminatorTooLargeError | InputDataTooLong | InvalidEntropyDataLength | InvalidUsernameLinkEncryptedData | IoError | CdsiInvalidTokenError | InvalidUriError | InvalidMediaInputError | SvrDataMissingError | SvrRestoreFailedError | SvrRequestFailedError | UnsupportedMediaInputError | ChatServiceInactive | AppExpiredError | DeviceDelinkedError | CancellationError;
+export type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError | NicknameCannotBeEmptyError | CannotStartWithDigitError | MissingSeparatorError | BadNicknameCharacterError | NicknameTooShortError | NicknameTooLongError | DiscriminatorCannotBeEmptyError | DiscriminatorCannotBeZeroError | DiscriminatorCannotBeSingleDigitError | DiscriminatorCannotHaveLeadingZerosError | BadDiscriminatorCharacterError | DiscriminatorTooLargeError | InputDataTooLong | InvalidEntropyDataLength | InvalidUsernameLinkEncryptedData | IoError | CdsiInvalidTokenError | InvalidUriError | InvalidMediaInputError | SvrDataMissingError | SvrRestoreFailedError | SvrRequestFailedError | UnsupportedMediaInputError | ChatServiceInactive | AppExpiredError | DeviceDelinkedError | RateLimitedError | BackupValidationError | CancellationError;

package/dist/Errors.js

@@ -81,6 +81,18 @@ class LibSignalErrorBase extends Error {
     toString() {
         return `${this.name} - ${this.operation}: ${this.message}`;
     }
+    /// Like `error.code === code`, but also providing access to any additional properties.
+    is(code) {
+        return this.code === code;
+    }
+    /// Like `error instanceof LibSignalErrorBase && error.code === code`, but all in one expression,
+    /// and providing access to any additional properties.
+    static is(error, code) {
+        if (error instanceof LibSignalErrorBase) {
+            return error.is(code);
+        }
+        return false;
+    }
 }
 exports.LibSignalErrorBase = LibSignalErrorBase;
 //# sourceMappingURL=Errors.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.58.2, libsignal-jni 0.58.2, libsignal-jni-testing 0.58.2, libsignal-node 0.58.2, 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, libsignal-keytrans 0.0.1, signal-media 0.1.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-net-infra 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
+## libsignal-account-keys 0.1.0, attest 0.1.0, libsignal-ffi 0.59.0, libsignal-jni 0.59.0, libsignal-jni-testing 0.59.0, libsignal-node 0.59.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-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, libsignal-keytrans 0.0.1, signal-media 0.1.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-net-infra 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

package/dist/incremental_mac.d.ts

@@ -2,6 +2,7 @@
 /// <reference types="node" />
 import * as Native from '../Native';
 import * as stream from 'stream';
+type CallbackType = (error?: Error | null) => void;
 export type ChunkSizeChoice = {
     kind: 'everyN';
     n: number;
@@ -11,20 +12,41 @@ export type ChunkSizeChoice = {
 };
 export declare function everyNthByte(n: number): ChunkSizeChoice;
 export declare function inferChunkSize(dataSize: number): ChunkSizeChoice;
+/**
+ * @deprecated Use the DigestingPassThrough instead
+ */
 export declare class DigestingWritable extends stream.Writable {
     _nativeHandle: Native.IncrementalMac;
     _digests: Buffer[];
     constructor(key: Buffer, sizeChoice: ChunkSizeChoice);
     getFinalDigest(): Buffer;
-    _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
-    _final(callback: (error?: Error | null) => void): void;
+    _write(chunk: any, encoding: BufferEncoding, callback: CallbackType): void;
+    _final(callback: CallbackType): void;
 }
+export declare class DigestingPassThrough extends stream.Transform {
+    private digester;
+    constructor(key: Buffer, sizeChoice: ChunkSizeChoice);
+    getFinalDigest(): Buffer;
+    _transform(data: Buffer, enc: BufferEncoding, callback: CallbackType): void;
+    _final(callback: CallbackType): void;
+}
+/**
+ * @deprecated Use the ValidatingPassThrough instead
+ */
 export declare class ValidatingWritable extends stream.Writable {
     _nativeHandle: Native.ValidatingMac;
     _validatedBytes: number;
     constructor(key: Buffer, sizeChoice: ChunkSizeChoice, digest: Buffer);
     validatedSize(): number;
-    _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
-    _final(callback: (error?: Error | null) => void): void;
+    _write(chunk: any, encoding: BufferEncoding, callback: CallbackType): void;
+    _final(callback: CallbackType): void;
+}
+export declare class ValidatingPassThrough extends stream.Transform {
+    private validator;
+    private buffer;
+    constructor(key: Buffer, sizeChoice: ChunkSizeChoice, digest: Buffer);
+    _transform(data: Buffer, enc: BufferEncoding, callback: CallbackType): void;
+    _final(callback: CallbackType): void;
 }
 export declare function chunkSizeInBytes(sizeChoice: ChunkSizeChoice): number;
+export {};

package/dist/incremental_mac.js

@@ -4,7 +4,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chunkSizeInBytes = exports.ValidatingWritable = exports.DigestingWritable = exports.inferChunkSize = exports.everyNthByte = void 0;
+exports.chunkSizeInBytes = exports.ValidatingPassThrough = exports.ValidatingWritable = exports.DigestingPassThrough = exports.DigestingWritable = exports.inferChunkSize = exports.everyNthByte = void 0;
 const Native = require("../Native");
 const stream = require("stream");
 const Errors_1 = require("./Errors");
@@ -16,6 +16,9 @@ function inferChunkSize(dataSize) {
     return { kind: 'chunksOf', dataSize: dataSize };
 }
 exports.inferChunkSize = inferChunkSize;
+/**
+ * @deprecated Use the DigestingPassThrough instead
+ */
 class DigestingWritable extends stream.Writable {
     constructor(key, sizeChoice) {
         super();
@@ -42,6 +45,40 @@ class DigestingWritable extends stream.Writable {
     }
 }
 exports.DigestingWritable = DigestingWritable;
+class DigestingPassThrough extends stream.Transform {
+    constructor(key, sizeChoice) {
+        super();
+        this.digester = new DigestingWritable(key, sizeChoice);
+        // We handle errors coming from write/end
+        this.digester.on('error', () => {
+            /* noop */
+        });
+    }
+    getFinalDigest() {
+        return this.digester.getFinalDigest();
+    }
+    _transform(data, enc, callback) {
+        this.digester.write(data, enc, (err) => {
+            if (err) {
+                return callback(err);
+            }
+            this.push(data);
+            callback();
+        });
+    }
+    _final(callback) {
+        this.digester.end((err) => {
+            if (err) {
+                return callback(err);
+            }
+            callback();
+        });
+    }
+}
+exports.DigestingPassThrough = DigestingPassThrough;
+/**
+ * @deprecated Use the ValidatingPassThrough instead
+ */
 class ValidatingWritable extends stream.Writable {
     constructor(key, sizeChoice, digest) {
         super();
@@ -77,6 +114,68 @@ class ValidatingWritable extends stream.Writable {
     }
 }
 exports.ValidatingWritable = ValidatingWritable;
+class ValidatingPassThrough extends stream.Transform {
+    constructor(key, sizeChoice, digest) {
+        super();
+        this.buffer = new Array();
+        this.validator = new ValidatingWritable(key, sizeChoice, digest);
+        // We handle errors coming from write/end
+        this.validator.on('error', () => {
+            /* noop */
+        });
+    }
+    _transform(data, enc, callback) {
+        const start = this.validator.validatedSize();
+        this.validator.write(data, enc, (err) => {
+            if (err) {
+                return callback(err);
+            }
+            this.buffer.push(data);
+            const end = this.validator.validatedSize();
+            const readySize = end - start;
+            // Fully buffer
+            if (readySize === 0) {
+                return callback(null);
+            }
+            const { buffer } = this;
+            this.buffer = [];
+            let validated = 0;
+            for (const chunk of buffer) {
+                validated += chunk.byteLength;
+                // Buffered chunk is fully validated - push it without slicing
+                if (validated <= readySize) {
+                    this.push(chunk);
+                    continue;
+                }
+                // Validation boundary lies within the chunk, split it
+                const notValidated = validated - readySize;
+                this.push(chunk.subarray(0, -notValidated));
+                this.buffer.push(chunk.subarray(-notValidated));
+                // Technically this chunk must be the last chunk so we could break,
+                // but for consistency keep looping.
+            }
+            callback(null);
+        });
+    }
+    _final(callback) {
+        const start = this.validator.validatedSize();
+        this.validator.end((err) => {
+            if (err) {
+                return callback(err);
+            }
+            const end = this.validator.validatedSize();
+            const readySize = end - start;
+            const buffer = Buffer.concat(this.buffer);
+            this.buffer = [];
+            if (buffer.byteLength !== readySize) {
+                return callback(new Error('Stream not fully processed'));
+            }
+            this.push(buffer);
+            callback(null);
+        });
+    }
+}
+exports.ValidatingPassThrough = ValidatingPassThrough;
 function chunkSizeInBytes(sizeChoice) {
     switch (sizeChoice.kind) {
         case 'everyN':

package/dist/net.d.ts

@@ -169,6 +169,21 @@ export declare class UnauthenticatedChatService implements ChatService {
     }): Promise<Native.ChatResponse>;
 }
 export declare function buildHttpRequest(chatRequest: ChatRequest): Wrapper<Native.HttpRequest>;
+export type NetConstructorOptions = Readonly<{
+    localTestServer?: false;
+    env: Environment;
+    userAgent: string;
+} | {
+    localTestServer: true;
+    userAgent: string;
+    TESTING_localServer_chatPort: number;
+    TESTING_localServer_cdsiPort: number;
+    TESTING_localServer_svr2Port: number;
+    TESTING_localServer_svr3SgxPort: number;
+    TESTING_localServer_svr3NitroPort: number;
+    TESTING_localServer_svr3Tpm2SnpPort: number;
+    TESTING_localServer_rootCertificateDer: Buffer;
+}>;
 export declare class Net {
     private readonly asyncContext;
     private readonly connectionManager;
@@ -176,7 +191,7 @@ export declare class Net {
      * Instance of the {@link Svr3Client} to access SVR3.
      */
     svr3: Svr3Client;
-    constructor(env: Environment, userAgent: string);
+    constructor(options: NetConstructorOptions);
     /**
      * Creates a new instance of {@link AuthenticatedChatService}.
      *

package/dist/net.js

@@ -141,9 +141,14 @@ function buildHttpRequest(chatRequest) {
 }
 exports.buildHttpRequest = buildHttpRequest;
 class Net {
-    constructor(env, userAgent) {
+    constructor(options) {
         this.asyncContext = new TokioAsyncContext(Native.TokioAsyncContext_new());
-        this.connectionManager = newNativeHandle(Native.ConnectionManager_new(env, userAgent));
+        if (options.localTestServer) {
+            this.connectionManager = newNativeHandle(Native.TESTING_ConnectionManager_newLocalOverride(options.userAgent, options.TESTING_localServer_chatPort, options.TESTING_localServer_cdsiPort, options.TESTING_localServer_svr2Port, options.TESTING_localServer_svr3SgxPort, options.TESTING_localServer_svr3NitroPort, options.TESTING_localServer_svr3Tpm2SnpPort, options.TESTING_localServer_rootCertificateDer));
+        }
+        else {
+            this.connectionManager = newNativeHandle(Native.ConnectionManager_new(options.env, options.userAgent));
+        }
         this.svr3 = new Svr3ClientImpl(this.asyncContext, this.connectionManager);
     }
     /**

package/dist/pin.d.ts

@@ -0,0 +1,3 @@
+export { 
+/** @deprecated AccountEntropyPool was moved to 'AccountKeys' */
+AccountEntropyPool, } from './AccountKeys';

package/dist/pin.js

@@ -0,0 +1,11 @@
+"use strict";
+//
+// Copyright 2024 Signal Messenger, LLC.
+// SPDX-License-Identifier: AGPL-3.0-only
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountEntropyPool = void 0;
+var AccountKeys_1 = require("./AccountKeys");
+/** @deprecated AccountEntropyPool was moved to 'AccountKeys' */
+Object.defineProperty(exports, "AccountEntropyPool", { enumerable: true, get: function () { return AccountKeys_1.AccountEntropyPool; } });
+//# sourceMappingURL=pin.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/libsignal-client",
-  "version": "0.58.2",
+  "version": "0.59.0",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",