@signalapp/libsignal-client 0.39.2 → 0.40.0

package/Native.d.ts

@@ -11,7 +11,10 @@ type Uuid = Buffer;
 /// what's important is that it's an integer less than Number.MAX_SAFE_INTEGER.
 type Timestamp = number;
 
-type LookupResponse = Map<string, LookupResponseEntry>;
+interface LookupResponse {
+  entries: Map<string, LookupResponseEntry>;
+  debugPermitsUsed: number;
+}
 
 interface LookupResponseEntry {
   readonly aci: string | undefined;
@@ -96,6 +99,11 @@ interface Wrapper<T> {
   readonly _nativeHandle: T;
 }
 
+interface MessageBackupValidationOutcome {
+  errorMessage: string | null;
+  unknownFieldMessages: Array<string>;
+}
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 type Serialized<T> = Buffer;
 
@@ -196,6 +204,7 @@ export function GroupSendCredentialResponse_CheckValidContents(responseBytes: Bu
 export function GroupSendCredentialResponse_DefaultExpirationBasedOnCurrentTime(): Timestamp;
 export function GroupSendCredentialResponse_IssueDeterministic(concatenatedGroupMemberCiphertexts: Buffer, requester: Serialized<UuidCiphertext>, expiration: Timestamp, serverParams: Serialized<ServerSecretParams>, randomness: Buffer): Buffer;
 export function GroupSendCredentialResponse_Receive(responseBytes: Buffer, groupMembers: Buffer, localAci: Buffer, now: Timestamp, serverParams: Serialized<ServerPublicParams>, groupParams: Serialized<GroupSecretParams>): Buffer;
+export function GroupSendCredentialResponse_ReceiveWithCiphertexts(responseBytes: Buffer, concatenatedGroupMemberCiphertexts: Buffer, requester: Serialized<UuidCiphertext>, now: Timestamp, serverParams: Serialized<ServerPublicParams>, groupParams: Serialized<GroupSecretParams>): Buffer;
 export function GroupSendCredential_CheckValidContents(paramsBytes: Buffer): void;
 export function GroupSendCredential_PresentDeterministic(credentialBytes: Buffer, serverParams: Serialized<ServerPublicParams>, randomness: Buffer): Buffer;
 export function HKDF_DeriveSecrets(outputLength: number, ikm: Buffer, label: Buffer | null, salt: Buffer | null): Buffer;
@@ -235,6 +244,9 @@ export function LookupRequest_addPreviousE164(request: Wrapper<LookupRequest>, e
 export function LookupRequest_new(): LookupRequest;
 export function LookupRequest_setReturnAcisWithoutUaks(request: Wrapper<LookupRequest>, returnAcisWithoutUaks: boolean): void;
 export function LookupRequest_setToken(request: Wrapper<LookupRequest>, token: Buffer): void;
+export function MessageBackupKey_New(masterKey: Buffer, aci: Buffer): MessageBackupKey;
+export function MessageBackupValidator_Validate(key: Wrapper<MessageBackupKey>, firstStream: InputStream, secondStream: InputStream, len: Buffer): Promise<MessageBackupValidationOutcome>;
+export function MinidumpToJSONString(buffer: Buffer): string;
 export function Mp4Sanitizer_Sanitize(input: InputStream, len: Buffer): Promise<SanitizedMetadata>;
 export function PlaintextContent_Deserialize(data: Buffer): PlaintextContent;
 export function PlaintextContent_FromDecryptionErrorMessage(m: Wrapper<DecryptionErrorMessage>): PlaintextContent;
@@ -416,6 +428,7 @@ export function SignedPreKeyRecord_GetSignature(obj: Wrapper<SignedPreKeyRecord>
 export function SignedPreKeyRecord_GetTimestamp(obj: Wrapper<SignedPreKeyRecord>): Timestamp;
 export function SignedPreKeyRecord_New(id: number, timestamp: Timestamp, pubKey: Wrapper<PublicKey>, privKey: Wrapper<PrivateKey>, signature: Buffer): SignedPreKeyRecord;
 export function SignedPreKeyRecord_Serialize(obj: Wrapper<SignedPreKeyRecord>): Buffer;
+export function TESTING_CdsiLookupErrorConvert(): void;
 export function TESTING_CdsiLookupResponseConvert(): LookupResponse;
 export function TESTING_ErrorOnBorrowAsync(_input: null): Promise<void>;
 export function TESTING_ErrorOnBorrowIo(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, _input: null): Promise<void>;
@@ -441,6 +454,7 @@ export function TESTING_PanicOnLoadSync(_needsCleanup: null, _input: null): void
 export function TESTING_PanicOnReturnAsync(_needsCleanup: null): Promise<null>;
 export function TESTING_PanicOnReturnIo(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, _needsCleanup: null): Promise<null>;
 export function TESTING_PanicOnReturnSync(_needsCleanup: null): null;
+export function TESTING_ReturnStringArray(): string[];
 export function TESTING_TestingHandleType_getValue(handle: Wrapper<TestingHandleType>): number;
 export function TokioAsyncContext_new(): TokioAsyncContext;
 export function UnidentifiedSenderMessageContent_Deserialize(data: Buffer): UnidentifiedSenderMessageContent;
@@ -453,7 +467,7 @@ export function UnidentifiedSenderMessageContent_New(message: Wrapper<Ciphertext
 export function UnidentifiedSenderMessageContent_Serialize(obj: Wrapper<UnidentifiedSenderMessageContent>): Buffer;
 export function UsernameLink_Create(username: string, entropy: Buffer | null): Buffer;
 export function UsernameLink_DecryptUsername(entropy: Buffer, encryptedUsername: Buffer): string;
-export function Username_CandidatesFrom(nickname: string, minLen: number, maxLen: number): string;
+export function Username_CandidatesFrom(nickname: string, minLen: number, maxLen: number): string[];
 export function Username_Hash(username: string): Buffer;
 export function Username_HashFromParts(nickname: string, discriminator: string, minLen: number, maxLen: number): Buffer;
 export function Username_Proof(username: string, randomness: Buffer): Buffer;
@@ -486,6 +500,7 @@ interface KyberPreKeyRecord { readonly __type: unique symbol; }
 interface KyberPublicKey { readonly __type: unique symbol; }
 interface KyberSecretKey { readonly __type: unique symbol; }
 interface LookupRequest { readonly __type: unique symbol; }
+interface MessageBackupKey { readonly __type: unique symbol; }
 interface NonSuspendingBackgroundThreadRuntime { readonly __type: unique symbol; }
 interface OtherTestingHandleType { readonly __type: unique symbol; }
 interface PlaintextContent { readonly __type: unique symbol; }

package/dist/MessageBackup.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="node" />
+/**
+ * Message backup validation routines.
+ *
+ * @module MessageBackup
+ */
+import * as Native from '../Native';
+import { Aci } from './Address';
+import { InputStream } from './io';
+export type InputStreamFactory = () => InputStream;
+/**
+ * Result of validating a message backup bundle.
+ */
+export declare class ValidationOutcome {
+    /**
+     * A developer-facing message about the error encountered during validation,
+     * if any.
+     */
+    errorMessage: string | null;
+    /**
+     * Information about unknown fields encountered during validation.
+     */
+    unknownFieldMessages: string[];
+    /**
+     * `true` if the backup is valid, `false` otherwise.
+     *
+     * If this is `true`, there might still be messages about unknown fields.
+     */
+    get ok(): boolean;
+    constructor(outcome: Native.MessageBackupValidationOutcome);
+}
+/**
+ * Key used to encrypt and decrypt a message backup bundle.
+ */
+export declare class MessageBackupKey {
+    readonly _nativeHandle: Native.MessageBackupKey;
+    /**
+     * Create a public key from the given master key and ACI.
+     *
+     * `masterKeyBytes` should contain exactly 32 bytes.
+     */
+    constructor(masterKeyBytes: Buffer, aci: Aci);
+}
+/**
+ * Validate a backup file
+ *
+ * @param backupKey The key to use to decrypt the backup contents.
+ * @param inputFactory A function that returns new input streams that read the backup contents.
+ * @param length The exact length of the input stream.
+ * @returns The outcome of validation, including any errors and warnings.
+ * @throws IoError If an IO error on the input occurs.
+ */
+export declare function validate(backupKey: MessageBackupKey, inputFactory: InputStreamFactory, length: bigint): Promise<ValidationOutcome>;

package/dist/MessageBackup.js

@@ -0,0 +1,63 @@
+"use strict";
+//
+// Copyright 2024 Signal Messenger, LLC.
+// SPDX-License-Identifier: AGPL-3.0-only
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.MessageBackupKey = exports.ValidationOutcome = void 0;
+/**
+ * Message backup validation routines.
+ *
+ * @module MessageBackup
+ */
+const Native = require("../Native");
+const BigIntUtil_1 = require("./zkgroup/internal/BigIntUtil");
+/**
+ * Result of validating a message backup bundle.
+ */
+class ValidationOutcome {
+    /**
+     * `true` if the backup is valid, `false` otherwise.
+     *
+     * If this is `true`, there might still be messages about unknown fields.
+     */
+    get ok() {
+        return this.errorMessage == null;
+    }
+    constructor(outcome) {
+        const { errorMessage, unknownFieldMessages } = outcome;
+        this.errorMessage = errorMessage;
+        this.unknownFieldMessages = unknownFieldMessages;
+    }
+}
+exports.ValidationOutcome = ValidationOutcome;
+/**
+ * Key used to encrypt and decrypt a message backup bundle.
+ */
+class MessageBackupKey {
+    /**
+     * Create a public key from the given master key and ACI.
+     *
+     * `masterKeyBytes` should contain exactly 32 bytes.
+     */
+    constructor(masterKeyBytes, aci) {
+        this._nativeHandle = Native.MessageBackupKey_New(masterKeyBytes, aci.getServiceIdFixedWidthBinary());
+    }
+}
+exports.MessageBackupKey = MessageBackupKey;
+/**
+ * Validate a backup file
+ *
+ * @param backupKey The key to use to decrypt the backup contents.
+ * @param inputFactory A function that returns new input streams that read the backup contents.
+ * @param length The exact length of the input stream.
+ * @returns The outcome of validation, including any errors and warnings.
+ * @throws IoError If an IO error on the input occurs.
+ */
+async function validate(backupKey, inputFactory, length) {
+    const firstStream = inputFactory();
+    const secondStream = inputFactory();
+    return new ValidationOutcome(await Native.MessageBackupValidator_Validate(backupKey, firstStream, secondStream, (0, BigIntUtil_1.bufferFromBigUInt64BE)(length)));
+}
+exports.validate = validate;
+//# sourceMappingURL=MessageBackup.js.map

package/dist/Minidump.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export declare function toJSONString(buffer: Buffer): string;

package/dist/Minidump.js

@@ -0,0 +1,13 @@
+"use strict";
+//
+// Copyright 2024 Signal Messenger, LLC.
+// SPDX-License-Identifier: AGPL-3.0-only
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toJSONString = void 0;
+const Native = require("../Native");
+function toJSONString(buffer) {
+    return Native.MinidumpToJSONString(buffer);
+}
+exports.toJSONString = toJSONString;
+//# sourceMappingURL=Minidump.js.map

package/dist/Mp4Sanitizer.d.ts

@@ -34,17 +34,17 @@ export declare class SanitizedMetadata {
     static _fromNativeHandle(handle: Native.SanitizedMetadata): SanitizedMetadata;
     /**
      * Get the sanitized metadata, if any.
-     * @return The sanitized metadata, or {@code null} if it didn't need to be sanitized.
+     * @returns The sanitized metadata, or {@code null} if it didn't need to be sanitized.
      */
     getMetadata(): Buffer | null;
     /**
      * Get the offset of the media data in the processed input.
-     * @return The offset of the media data in the processed input.
+     * @returns The offset of the media data in the processed input.
      */
     getDataOffset(): bigint;
     /**
      * Get the length of the media data in the processed input.
-     * @return The length of the media data in the processed input.
+     * @returns The length of the media data in the processed input.
      */
     getDataLen(): bigint;
 }
@@ -53,7 +53,7 @@ export declare class SanitizedMetadata {
  *
  * @param input An MP4 format input stream.
  * @param length The exact length of the input stream.
- * @return The sanitized metadata.
+ * @returns The sanitized metadata.
  * @throws IoError If an IO error on the input occurs.
  * @throws InvalidMediaInputError If the input could not be parsed because it was invalid.
  * @throws UnsupportedMediaInputError If the input could not be parsed because it's unsupported in some way.

package/dist/Mp4Sanitizer.js

@@ -43,7 +43,7 @@ class SanitizedMetadata {
     }
     /**
      * Get the sanitized metadata, if any.
-     * @return The sanitized metadata, or {@code null} if it didn't need to be sanitized.
+     * @returns The sanitized metadata, or {@code null} if it didn't need to be sanitized.
      */
     getMetadata() {
         const metadata = Native.SanitizedMetadata_GetMetadata(this);
@@ -54,7 +54,7 @@ class SanitizedMetadata {
     }
     /**
      * Get the offset of the media data in the processed input.
-     * @return The offset of the media data in the processed input.
+     * @returns The offset of the media data in the processed input.
      */
     getDataOffset() {
         const buffer = Native.SanitizedMetadata_GetDataOffset(this);
@@ -62,7 +62,7 @@ class SanitizedMetadata {
     }
     /**
      * Get the length of the media data in the processed input.
-     * @return The length of the media data in the processed input.
+     * @returns The length of the media data in the processed input.
      */
     getDataLen() {
         const buffer = Native.SanitizedMetadata_GetDataLen(this);
@@ -75,7 +75,7 @@ exports.SanitizedMetadata = SanitizedMetadata;
  *
  * @param input An MP4 format input stream.
  * @param length The exact length of the input stream.
- * @return The sanitized metadata.
+ * @returns The sanitized metadata.
  * @throws IoError If an IO error on the input occurs.
  * @throws InvalidMediaInputError If the input could not be parsed because it was invalid.
  * @throws UnsupportedMediaInputError If the input could not be parsed because it's unsupported in some way.

package/dist/SealedSenderMultiRecipientMessage.d.ts

@@ -35,7 +35,7 @@ export default class SealedSenderMultiRecipientMessage {
     /**
      * Returns the service IDs of recipients excluded from receiving the message.
      *
-     * This is enforced to be disjoint from the recipients in {@link recipientsByServiceIdString}; it
+     * This is enforced to be disjoint from the recipients in {@link #recipientsByServiceIdString}; it
      * may be used for authorization purposes or just to check that certain recipients were
      * deliberately excluded rather than accidentally.
      */
@@ -44,7 +44,7 @@ export default class SealedSenderMultiRecipientMessage {
      * Returns the Sealed Sender V2 "ReceivedMessage" payload for delivery to a particular recipient.
      *
      * `recipient` must be one of the recipients in the map returned by
-     * {@link recipientsByServiceIdString}. The same payload should be sent to all of the recipient's
+     * {@link #recipientsByServiceIdString}. The same payload should be sent to all of the recipient's
      * devices.
      */
     messageForRecipient(recipient: Recipient): Buffer;

package/dist/SealedSenderMultiRecipientMessage.js

@@ -30,7 +30,7 @@ class SealedSenderMultiRecipientMessage {
     /**
      * Returns the service IDs of recipients excluded from receiving the message.
      *
-     * This is enforced to be disjoint from the recipients in {@link recipientsByServiceIdString}; it
+     * This is enforced to be disjoint from the recipients in {@link #recipientsByServiceIdString}; it
      * may be used for authorization purposes or just to check that certain recipients were
      * deliberately excluded rather than accidentally.
      */
@@ -41,7 +41,7 @@ class SealedSenderMultiRecipientMessage {
      * Returns the Sealed Sender V2 "ReceivedMessage" payload for delivery to a particular recipient.
      *
      * `recipient` must be one of the recipients in the map returned by
-     * {@link recipientsByServiceIdString}. The same payload should be sent to all of the recipient's
+     * {@link #recipientsByServiceIdString}. The same payload should be sent to all of the recipient's
      * devices.
      */
     messageForRecipient(recipient) {