@signalapp/libsignal-client 0.46.1 → 0.47.0

package/Native.d.ts

@@ -407,6 +407,7 @@ export function ServerCertificate_GetKeyId(obj: Wrapper<ServerCertificate>): num
 export function ServerCertificate_GetSerialized(obj: Wrapper<ServerCertificate>): Buffer;
 export function ServerCertificate_GetSignature(obj: Wrapper<ServerCertificate>): Buffer;
 export function ServerCertificate_New(keyId: number, serverKey: Wrapper<PublicKey>, trustRoot: Wrapper<PrivateKey>): ServerCertificate;
+export function ServerMessageAck_Send(asyncRuntime: Wrapper<TokioAsyncContext>, ack: Wrapper<ServerMessageAck>): Promise<void>;
 export function ServerPublicParams_CreateAuthCredentialWithPniPresentationDeterministic(serverPublicParams: Wrapper<ServerPublicParams>, randomness: Buffer, groupSecretParams: Serialized<GroupSecretParams>, authCredentialWithPniBytes: Buffer): Buffer;
 export function ServerPublicParams_CreateExpiringProfileKeyCredentialPresentationDeterministic(serverPublicParams: Wrapper<ServerPublicParams>, randomness: Buffer, groupSecretParams: Serialized<GroupSecretParams>, profileKeyCredential: Serialized<ExpiringProfileKeyCredential>): Buffer;
 export function ServerPublicParams_CreateProfileKeyCredentialRequestContextDeterministic(serverPublicParams: Wrapper<ServerPublicParams>, randomness: Buffer, userId: Buffer, profileKey: Serialized<ProfileKey>): Serialized<ProfileKeyCredentialRequestContext>;
@@ -467,6 +468,7 @@ export function SignedPreKeyRecord_GetTimestamp(obj: Wrapper<SignedPreKeyRecord>
 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 Svr3Backup(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, secret: Buffer, password: string, maxTries: number, username: string, enclavePassword: string): Promise<Buffer>;
+export function Svr3Remove(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, username: string, enclavePassword: string): Promise<void>;
 export function Svr3Restore(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, password: string, shareSet: Buffer, username: string, enclavePassword: string): Promise<Buffer>;
 export function TESTING_CdsiLookupErrorConvert(errorDescription: string): void;
 export function TESTING_CdsiLookupResponseConvert(asyncRuntime: Wrapper<TokioAsyncContext>): Promise<LookupResponse>;
@@ -479,6 +481,7 @@ export function TESTING_ChatServiceErrorConvert(): void;
 export function TESTING_ChatServiceInactiveErrorConvert(): void;
 export function TESTING_ChatServiceResponseAndDebugInfoConvert(): ResponseAndDebugInfo;
 export function TESTING_ChatServiceResponseConvert(bodyPresent: boolean): ChatResponse;
+export function TESTING_ChatService_InjectRawServerRequest(chat: Wrapper<Chat>, bytes: Buffer): void;
 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;
@@ -490,6 +493,7 @@ export function TESTING_FutureProducesOtherPointerType(asyncRuntime: Wrapper<Non
 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_NonSuspendingBackgroundThreadRuntime_New(): NonSuspendingBackgroundThreadRuntime;
+export function TESTING_OnlyCompletesByCancellation(asyncRuntime: Wrapper<TokioAsyncContext>): Promise<void>;
 export function TESTING_OtherTestingHandleType_getValue(handle: Wrapper<OtherTestingHandleType>): string;
 export function TESTING_PanicInBodyAsync(_input: null): Promise<void>;
 export function TESTING_PanicInBodyIo(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, _input: null): Promise<void>;
@@ -506,6 +510,7 @@ export function TESTING_PanicOnReturnSync(_needsCleanup: null): null;
 export function TESTING_ProcessBytestringArray(input: Buffer[]): Buffer[];
 export function TESTING_ReturnStringArray(): string[];
 export function TESTING_TestingHandleType_getValue(handle: Wrapper<TestingHandleType>): number;
+export function TokioAsyncContext_cancel(context: Wrapper<TokioAsyncContext>, rawCancellationId: bigint): void;
 export function TokioAsyncContext_new(): TokioAsyncContext;
 export function UnidentifiedSenderMessageContent_Deserialize(data: Buffer): UnidentifiedSenderMessageContent;
 export function UnidentifiedSenderMessageContent_GetContentHint(m: Wrapper<UnidentifiedSenderMessageContent>): number;
@@ -575,6 +580,7 @@ interface SenderKeyDistributionMessage { readonly __type: unique symbol; }
 interface SenderKeyMessage { readonly __type: unique symbol; }
 interface SenderKeyRecord { readonly __type: unique symbol; }
 interface ServerCertificate { readonly __type: unique symbol; }
+interface ServerMessageAck { readonly __type: unique symbol; }
 interface ServerPublicParams { readonly __type: unique symbol; }
 interface ServerSecretParams { readonly __type: unique symbol; }
 interface SessionRecord { readonly __type: unique symbol; }

package/dist/Errors.d.ts

@@ -145,5 +145,6 @@ export type SvrRequestFailedError = LibSignalErrorCommon & {
 };
 export type SvrRestoreFailedError = LibSignalErrorCommon & {
     code: ErrorCode.SvrRestoreFailed;
+    readonly triesRemaining: number;
 };
 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;

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, device-transfer 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-core 0.1.0, libsignal-ffi 0.46.1, libsignal-jni 0.46.1, libsignal-message-backup 0.1.0, libsignal-message-backup-io 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-node 0.46.1, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, poksho 0.7.0, signal-crypto 0.1.0, signal-media 0.1.0, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, signal-pin 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
+## attest 0.1.0, device-transfer 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-core 0.1.0, libsignal-ffi 0.47.0, libsignal-jni 0.47.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-node 0.47.0, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, poksho 0.7.0, signal-crypto 0.1.0, signal-media 0.1.0, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, signal-pin 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
 
 ```
 GNU AFFERO GENERAL PUBLIC LICENSE
@@ -6830,6 +6830,39 @@ SOFTWARE.
 
 ```
 
+## atomic-take 1.1.0
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2019 Alice Ryhl
+
+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.
+
+```
+
 ## crossbeam-deque 0.8.5, crossbeam-epoch 0.9.18, crossbeam-utils 0.8.19
 
 ```

package/dist/net.d.ts

@@ -170,8 +170,7 @@ export interface Svr3Client {
     /**
      * Backup a secret to SVR3.
      *
-     * Error messages are expected to be log-safe and not contain any sensitive
-     *   data.
+     * Error messages are log-safe and do not contain any sensitive data.
      *
      * @param what - The secret to be stored. Must be 32 bytes long.
      * @param password - User-provided password that will be used to derive the
@@ -204,8 +203,7 @@ export interface Svr3Client {
     /**
      * Restore a secret from SVR3.
      *
-     * Error messages are expected to be log-safe and not contain any sensitive
-     * data.
+     * Error messages are log-safe and do not contain any sensitive data.
      *
      * @param password - User-provided password that will be used to derive the
      * decryption key for the secret.
@@ -216,8 +214,8 @@ export interface Svr3Client {
      * generally good for about 15 minutes, therefore it can be reused for the
      * subsequent calls to either backup or restore that are not too far apart in
      * time.
-     * @returns A `Promise` which--when awaited--will return a byte array with the
-     * restored secret.
+     * @returns A `Promise` which--when awaited--will return a
+     * {@link RestoredSecret} object, containing the restored secret.
      *
      * The returned `Promise` can also fail due to the network issues (including
      * the connection timeout), problems establishing the Noise connection to the
@@ -237,6 +235,41 @@ export interface Svr3Client {
      * masked share set fails, or when the server requests fail for reasons
      * other than "maximum attempts exceeded".
      */
-    restore(password: string, shareSet: Buffer, auth: Readonly<ServiceAuth>): Promise<Buffer>;
+    restore(password: string, shareSet: Buffer, auth: Readonly<ServiceAuth>): Promise<RestoredSecret>;
+    /**
+     * Remove a value stored in SVR3.
+     *
+     * This method will succeed even if the data has never been backed up in the
+     * first place.
+     *
+     * Error messages are log-safe and do not contain any sensitive data.
+     *
+     * @param auth - An instance of {@link ServiceAuth} containing the username
+     * and password obtained from the Chat Server. The password is an OTP which is
+     * generally good for about 15 minutes, therefore it can be reused for the
+     * subsequent calls to either backup or restore that are not too far apart in
+     * time.
+     * @returns A `Promise` successful completion of which will mean the data has
+     * been removed.
+     *
+     * The returned `Promise` can also fail due to the network issues (including
+     * the connection timeout), problems establishing the Noise connection to the
+     * enclaves, or invalid arguments' values. {@link IoError} errors can, in
+     * general, be retried, although there is already a retry-with-backoff
+     * mechanism inside libsignal used to connect to the SVR3 servers. Other
+     * exceptions are caused by the bad input or data missing on the server. They
+     * are therefore non-actionable and are guaranteed to be thrown again when
+     * retried.
+     */
+    remove(auth: Readonly<ServiceAuth>): Promise<void>;
+}
+/**
+ * A simple data class containing the secret restored from SVR3 as well as the
+ * number of restore attempts remaining.
+ */
+export declare class RestoredSecret {
+    readonly triesRemaining: number;
+    readonly value: Buffer;
+    constructor(serialized: Buffer);
 }
 export {};

package/dist/net.js

@@ -4,7 +4,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Net = exports.ChatService = exports.Environment = void 0;
+exports.RestoredSecret = exports.Net = exports.ChatService = exports.Environment = void 0;
 const Native = require("../Native");
 const Address_1 = require("./Address");
 const DEFAULT_CHAT_REQUEST_TIMEOUT_MILLIS = 5000;
@@ -172,6 +172,17 @@ class Net {
     }
 }
 exports.Net = Net;
+/**
+ * A simple data class containing the secret restored from SVR3 as well as the
+ * number of restore attempts remaining.
+ */
+class RestoredSecret {
+    constructor(serialized) {
+        this.triesRemaining = serialized.readInt32BE();
+        this.value = serialized.subarray(4);
+    }
+}
+exports.RestoredSecret = RestoredSecret;
 class Svr3ClientImpl {
     constructor(asyncContext, connectionManager) {
         this.asyncContext = asyncContext;
@@ -181,7 +192,11 @@ class Svr3ClientImpl {
         return Native.Svr3Backup(this.asyncContext, this.connectionManager, what, password, maxTries, auth.username, auth.password);
     }
     async restore(password, shareSet, auth) {
-        return Native.Svr3Restore(this.asyncContext, this.connectionManager, password, shareSet, auth.username, auth.password);
+        const serialized = await Native.Svr3Restore(this.asyncContext, this.connectionManager, password, shareSet, auth.username, auth.password);
+        return new RestoredSecret(serialized);
+    }
+    async remove(auth) {
+        return Native.Svr3Remove(this.asyncContext, this.connectionManager, auth.username, auth.password);
     }
 }
 //# sourceMappingURL=net.js.map

package/package.json

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