@signalapp/libsignal-client 0.33.0 → 0.34.0

package/Native.d.ts

@@ -11,6 +11,13 @@ 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 LookupResponseEntry {
+  readonly aci: string | undefined;
+  readonly pni: string | undefined;
+}
+
 export abstract class IdentityKeyStore {
   _getIdentityKey(): Promise<PrivateKey>;
   _getLocalRegistrationId(): Promise<number>;
@@ -101,9 +108,11 @@ export function CallLinkSecretParams_DecryptUserId(paramsBytes: Buffer, userId:
 export function CallLinkSecretParams_DeriveFromRootKey(rootKey: Buffer): Buffer;
 export function CallLinkSecretParams_GetPublicParams(paramsBytes: Buffer): Buffer;
 export function Cds2ClientState_New(mrenclave: Buffer, attestationMsg: Buffer, currentTimestamp: Timestamp): SgxClientState;
+export function CdsiLookup(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, username: string, password: string, request: Wrapper<LookupRequest>, timeoutMillis: number): Promise<LookupResponse>;
 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 ConnectionManager_new(environment: number): ConnectionManager;
 export function CreateCallLinkCredentialPresentation_CheckValidContents(presentationBytes: Buffer): void;
 export function CreateCallLinkCredentialPresentation_Verify(presentationBytes: Buffer, roomId: Buffer, now: Timestamp, serverParamsBytes: Buffer, callLinkParamsBytes: Buffer): void;
 export function CreateCallLinkCredentialRequestContext_CheckValidContents(contextBytes: Buffer): void;
@@ -179,6 +188,10 @@ export function KyberPublicKey_Equals(lhs: Wrapper<KyberPublicKey>, rhs: Wrapper
 export function KyberPublicKey_Serialize(obj: Wrapper<KyberPublicKey>): Buffer;
 export function KyberSecretKey_Deserialize(data: Buffer): KyberSecretKey;
 export function KyberSecretKey_Serialize(obj: Wrapper<KyberSecretKey>): Buffer;
+export function LookupRequest_addAciAndAccessKey(request: Wrapper<LookupRequest>, aci: Buffer, accessKey: Buffer): void;
+export function LookupRequest_addE164(request: Wrapper<LookupRequest>, e164: string): void;
+export function LookupRequest_new(): LookupRequest;
+export function LookupRequest_setReturnAcisWithoutUaks(request: Wrapper<LookupRequest>, returnAcisWithoutUaks: boolean): void;
 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;
@@ -359,6 +372,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_CdsiLookupResponseConvert(): LookupResponse;
 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;
@@ -380,6 +394,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 TokioAsyncContext_new(): TokioAsyncContext;
 export function UnidentifiedSenderMessageContent_Deserialize(data: Buffer): UnidentifiedSenderMessageContent;
 export function UnidentifiedSenderMessageContent_GetContentHint(m: Wrapper<UnidentifiedSenderMessageContent>): number;
 export function UnidentifiedSenderMessageContent_GetContents(obj: Wrapper<UnidentifiedSenderMessageContent>): Buffer;
@@ -388,7 +403,7 @@ export function UnidentifiedSenderMessageContent_GetMsgType(m: Wrapper<Unidentif
 export function UnidentifiedSenderMessageContent_GetSenderCert(m: Wrapper<UnidentifiedSenderMessageContent>): SenderCertificate;
 export function UnidentifiedSenderMessageContent_New(message: Wrapper<CiphertextMessage>, sender: Wrapper<SenderCertificate>, contentHint: number, groupId: Buffer | null): UnidentifiedSenderMessageContent;
 export function UnidentifiedSenderMessageContent_Serialize(obj: Wrapper<UnidentifiedSenderMessageContent>): Buffer;
-export function UsernameLink_Create(username: string): 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_Hash(username: string): Buffer;
@@ -406,6 +421,7 @@ interface AuthCredentialResponse { readonly __type: unique symbol; }
 interface AuthCredentialWithPni { readonly __type: unique symbol; }
 interface AuthCredentialWithPniResponse { readonly __type: unique symbol; }
 interface CiphertextMessage { readonly __type: unique symbol; }
+interface ConnectionManager { readonly __type: unique symbol; }
 interface DecryptionErrorMessage { readonly __type: unique symbol; }
 interface ExpiringProfileKeyCredential { readonly __type: unique symbol; }
 interface ExpiringProfileKeyCredentialResponse { readonly __type: unique symbol; }
@@ -419,6 +435,7 @@ interface KyberKeyPair { readonly __type: unique symbol; }
 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 NonSuspendingBackgroundThreadRuntime { readonly __type: unique symbol; }
 interface PlaintextContent { readonly __type: unique symbol; }
 interface PreKeyBundle { readonly __type: unique symbol; }
@@ -450,6 +467,7 @@ interface SessionRecord { readonly __type: unique symbol; }
 interface SgxClientState { readonly __type: unique symbol; }
 interface SignalMessage { readonly __type: unique symbol; }
 interface SignedPreKeyRecord { readonly __type: unique symbol; }
+interface TokioAsyncContext { readonly __type: unique symbol; }
 interface UnidentifiedSenderMessageContent { readonly __type: unique symbol; }
 interface UuidCiphertext { readonly __type: unique symbol; }
 interface ValidatingMac { readonly __type: unique symbol; }

package/dist/Errors.d.ts

@@ -20,7 +20,8 @@ export declare enum ErrorCode {
     UnsupportedMediaInput = 16,
     InputDataTooLong = 17,
     InvalidEntropyDataLength = 18,
-    InvalidUsernameLinkEncryptedData = 19
+    InvalidUsernameLinkEncryptedData = 19,
+    RateLimitedError = 20
 }
 export declare class LibSignalErrorBase extends Error {
     readonly code: ErrorCode;
@@ -93,4 +94,8 @@ export type InvalidMediaInputError = LibSignalErrorCommon & {
 export type UnsupportedMediaInputError = LibSignalErrorCommon & {
     code: ErrorCode.UnsupportedMediaInput;
 };
+export type RateLimitedError = LibSignalErrorBase & {
+    code: ErrorCode.RateLimitedError;
+    readonly retryAfterSecs: number;
+};
 export type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError | CannotBeEmptyError | CannotStartWithDigitError | MissingSeparatorError | BadNicknameCharacterError | NicknameTooShortError | NicknameTooLongError | InputDataTooLong | InvalidEntropyDataLength | InvalidUsernameLinkEncryptedData | IoError | InvalidMediaInputError | UnsupportedMediaInputError;

package/dist/Errors.js

@@ -28,6 +28,7 @@ var ErrorCode;
     ErrorCode[ErrorCode["InputDataTooLong"] = 17] = "InputDataTooLong";
     ErrorCode[ErrorCode["InvalidEntropyDataLength"] = 18] = "InvalidEntropyDataLength";
     ErrorCode[ErrorCode["InvalidUsernameLinkEncryptedData"] = 19] = "InvalidUsernameLinkEncryptedData";
+    ErrorCode[ErrorCode["RateLimitedError"] = 20] = "RateLimitedError";
 })(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
 class LibSignalErrorBase extends Error {
     constructor(message, name, operation, extraProps) {

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { Aci, ProtocolAddress } from './Address';
 export * from './Address';
 export * as usernames from './usernames';
 export * as io from './io';
+export * as Net from './net';
 export * as Mp4Sanitizer from './Mp4Sanitizer';
 export * as WebpSanitizer from './WebpSanitizer';
 import * as Native from '../Native';

package/dist/index.js

@@ -27,8 +27,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sealedSenderEncryptMessage = exports.signalDecryptPreKey = exports.signalDecrypt = exports.signalEncrypt = exports.processPreKeyBundle = exports.DecryptionErrorMessage = exports.PlaintextContent = exports.CiphertextMessage = exports.SealedSenderDecryptionResult = exports.groupDecrypt = exports.groupEncrypt = exports.SenderKeyStore = exports.KyberPreKeyStore = exports.SignedPreKeyStore = exports.PreKeyStore = exports.IdentityKeyStore = exports.SessionStore = exports.UnidentifiedSenderMessageContent = exports.SenderKeyMessage = exports.processSenderKeyDistributionMessage = exports.SenderKeyDistributionMessage = exports.SenderCertificate = exports.SenderKeyRecord = exports.ServerCertificate = exports.SessionRecord = exports.PreKeySignalMessage = exports.SignalMessage = exports.KyberPreKeyRecord = exports.SignedPreKeyRecord = exports.PreKeyRecord = exports.PreKeyBundle = exports.IdentityKeyPair = exports.KEMKeyPair = exports.KEMSecretKey = exports.KEMPublicKey = exports.PrivateKey = exports.PublicKey = exports.Aes256GcmSiv = exports.Fingerprint = exports.DisplayableFingerprint = exports.ScannableFingerprint = exports.hkdf = exports.HKDF = exports.ContentHint = exports.Direction = exports.CiphertextMessageType = exports.WebpSanitizer = exports.Mp4Sanitizer = exports.io = exports.usernames = void 0;
-exports.initLogger = exports.LogLevel = exports.HsmEnclaveClient = exports.Cds2Client = exports.sealedSenderDecryptToUsmc = exports.sealedSenderDecryptMessage = exports.sealedSenderMultiRecipientMessageForSingleRecipient = exports.sealedSenderMultiRecipientEncrypt = exports.sealedSenderEncrypt = void 0;
+exports.signalDecryptPreKey = exports.signalDecrypt = exports.signalEncrypt = exports.processPreKeyBundle = exports.DecryptionErrorMessage = exports.PlaintextContent = exports.CiphertextMessage = exports.SealedSenderDecryptionResult = exports.groupDecrypt = exports.groupEncrypt = exports.SenderKeyStore = exports.KyberPreKeyStore = exports.SignedPreKeyStore = exports.PreKeyStore = exports.IdentityKeyStore = exports.SessionStore = exports.UnidentifiedSenderMessageContent = exports.SenderKeyMessage = exports.processSenderKeyDistributionMessage = exports.SenderKeyDistributionMessage = exports.SenderCertificate = exports.SenderKeyRecord = exports.ServerCertificate = exports.SessionRecord = exports.PreKeySignalMessage = exports.SignalMessage = exports.KyberPreKeyRecord = exports.SignedPreKeyRecord = exports.PreKeyRecord = exports.PreKeyBundle = exports.IdentityKeyPair = exports.KEMKeyPair = exports.KEMSecretKey = exports.KEMPublicKey = exports.PrivateKey = exports.PublicKey = exports.Aes256GcmSiv = exports.Fingerprint = exports.DisplayableFingerprint = exports.ScannableFingerprint = exports.hkdf = exports.HKDF = exports.ContentHint = exports.Direction = exports.CiphertextMessageType = exports.WebpSanitizer = exports.Mp4Sanitizer = exports.Net = exports.io = exports.usernames = void 0;
+exports.initLogger = exports.LogLevel = exports.HsmEnclaveClient = exports.Cds2Client = exports.sealedSenderDecryptToUsmc = exports.sealedSenderDecryptMessage = exports.sealedSenderMultiRecipientMessageForSingleRecipient = exports.sealedSenderMultiRecipientEncrypt = exports.sealedSenderEncrypt = exports.sealedSenderEncryptMessage = void 0;
 const uuid = require("uuid");
 const Errors = require("./Errors");
 __exportStar(require("./Errors"), exports);
@@ -36,6 +36,7 @@ const Address_1 = require("./Address");
 __exportStar(require("./Address"), exports);
 exports.usernames = require("./usernames");
 exports.io = require("./io");
+exports.Net = require("./net");
 exports.Mp4Sanitizer = require("./Mp4Sanitizer");
 exports.WebpSanitizer = require("./WebpSanitizer");
 const Native = require("../Native");

package/dist/net.d.ts

@@ -0,0 +1,29 @@
+import type { ReadonlyDeep } from 'type-fest';
+export declare enum Environment {
+    Staging = 0,
+    Production = 1
+}
+export type CDSAuthType = {
+    username: string;
+    password: string;
+};
+export type CDSRequestOptionsType = {
+    e164s: Array<string>;
+    acisAndAccessKeys: Array<{
+        aci: string;
+        accessKey: string;
+    }>;
+    timeout: number;
+    returnAcisWithoutUaks: boolean;
+};
+export type CDSResponseEntryType<Aci, Pni> = {
+    aci: Aci | undefined;
+    pni: Pni | undefined;
+};
+export type CDSResponseType<Aci, Pni> = Map<string, CDSResponseEntryType<Aci, Pni>>;
+export declare class Net {
+    private readonly _asyncContext;
+    private readonly _connectionManager;
+    constructor(env: Environment);
+    cdsiLookup({ username, password }: Readonly<CDSAuthType>, { e164s, acisAndAccessKeys, timeout, returnAcisWithoutUaks, }: ReadonlyDeep<CDSRequestOptionsType>): Promise<CDSResponseType<string, string>>;
+}

package/dist/net.js

@@ -0,0 +1,45 @@
+"use strict";
+//
+// Copyright 2023 Signal Messenger, LLC.
+// SPDX-License-Identifier: AGPL-3.0-only
+//
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Net = exports.Environment = void 0;
+const Native = require("../Native");
+const Address_1 = require("./Address");
+// This must match the libsignal-bridge Rust enum of the same name.
+var Environment;
+(function (Environment) {
+    Environment[Environment["Staging"] = 0] = "Staging";
+    Environment[Environment["Production"] = 1] = "Production";
+})(Environment = exports.Environment || (exports.Environment = {}));
+class Net {
+    constructor(env) {
+        this._asyncContext = Native.TokioAsyncContext_new();
+        this._connectionManager = Native.ConnectionManager_new(env);
+    }
+    cdsiLookup({ username, password }, { e164s, acisAndAccessKeys, timeout, returnAcisWithoutUaks, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = { _nativeHandle: Native.LookupRequest_new() };
+            e164s.forEach((e164) => {
+                Native.LookupRequest_addE164(request, e164);
+            });
+            acisAndAccessKeys.forEach(({ aci: aciStr, accessKey: accessKeyStr }) => {
+                Native.LookupRequest_addAciAndAccessKey(request, Address_1.Aci.parseFromServiceIdString(aciStr).getServiceIdFixedWidthBinary(), Buffer.from(accessKeyStr, 'base64'));
+            });
+            Native.LookupRequest_setReturnAcisWithoutUaks(request, returnAcisWithoutUaks);
+            return yield Native.CdsiLookup({ _nativeHandle: this._asyncContext }, { _nativeHandle: this._connectionManager }, username, password, request, timeout);
+        });
+    }
+}
+exports.Net = Net;
+//# sourceMappingURL=net.js.map

package/dist/usernames.d.ts

@@ -8,5 +8,5 @@ export declare function hash(username: string): Buffer;
 export declare function generateProof(username: string): Buffer;
 export declare function generateProofWithRandom(username: string, random: Buffer): Buffer;
 export declare function decryptUsernameLink(usernameLink: UsernameLink): string;
-export declare function createUsernameLink(username: string): UsernameLink;
+export declare function createUsernameLink(username: string, previousEntropy?: Buffer): UsernameLink;
 export declare function verifyProof(proof: Buffer, hash: Buffer): void;

package/dist/usernames.js

@@ -30,8 +30,8 @@ function decryptUsernameLink(usernameLink) {
     return Native.UsernameLink_DecryptUsername(usernameLink.entropy, usernameLink.encryptedUsername);
 }
 exports.decryptUsernameLink = decryptUsernameLink;
-function createUsernameLink(username) {
-    const usernameLinkData = Native.UsernameLink_Create(username);
+function createUsernameLink(username, previousEntropy) {
+    const usernameLinkData = Native.UsernameLink_Create(username, previousEntropy !== null && previousEntropy !== void 0 ? previousEntropy : null);
     const entropy = usernameLinkData.slice(0, 32);
     const encryptedUsername = usernameLinkData.slice(32);
     return { entropy, encryptedUsername };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/libsignal-client",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "node-gyp-build": "^4.2.3",
+    "type-fest": "^3.5.0",
     "uuid": "^8.3.0"
   },
   "devDependencies": {
@@ -34,7 +35,7 @@
     "@types/chai-as-promised": "^7.1.3",
     "@types/chance": "^1.1.3",
     "@types/mocha": "^5.2.7",
-    "@types/node": "16.18.3",
+    "@types/node": "~18.15.0",
     "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^5.47.0",
     "@typescript-eslint/parser": "^5.47.0",
@@ -48,7 +49,7 @@
     "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-more": "^1.0.0",
     "mocha": "^9",
-    "node-gyp": "^8.4.1",
+    "node-gyp": "^10.0.0",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.1",
     "source-map-support": "^0.5.19",