@signalapp/libsignal-client 0.21.0 → 0.22.0

package/Native.d.ts

@@ -293,6 +293,10 @@ 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 Username_CandidatesFrom(nickname: string, minLen: number, maxLen: number): string;
+export function Username_Hash(username: string): Buffer;
+export function Username_Proof(username: string, randomness: Buffer): Buffer;
+export function Username_Verify(proof: Buffer, hash: Buffer): void;
 export function UuidCiphertext_CheckValidContents(buffer: Buffer): void;
 export function initLogger(maxLevel: LogLevel, callback: (level: LogLevel, target: string, file: string | null, line: number | null, message: string) => void): void
 interface Aes256GcmSiv { readonly __type: unique symbol; }

package/dist/Errors.d.ts

@@ -8,7 +8,13 @@ export declare enum ErrorCode {
     InvalidRegistrationId = 4,
     VerificationFailed = 5,
     InvalidSession = 6,
-    InvalidSenderKeySession = 7
+    InvalidSenderKeySession = 7,
+    CannotBeEmpty = 8,
+    CannotStartWithDigit = 9,
+    MissingSeparator = 10,
+    BadNicknameCharacter = 11,
+    NicknameTooShort = 12,
+    NicknameTooLong = 13
 }
 export declare class LibSignalErrorBase extends Error {
     readonly code: ErrorCode;
@@ -17,32 +23,50 @@ export declare class LibSignalErrorBase extends Error {
     constructor(message: string, name: keyof typeof ErrorCode | undefined, operation: string, extraProps?: Record<string, unknown>);
     get addr(): ProtocolAddress | string;
 }
-export declare type LibSignalErrorCommon = Omit<LibSignalErrorBase, 'addr'>;
-export declare type GenericError = LibSignalErrorCommon & {
+export type LibSignalErrorCommon = Omit<LibSignalErrorBase, 'addr'>;
+export type GenericError = LibSignalErrorCommon & {
     code: ErrorCode.Generic;
 };
-export declare type DuplicatedMessageError = LibSignalErrorCommon & {
+export type DuplicatedMessageError = LibSignalErrorCommon & {
     code: ErrorCode.DuplicatedMessage;
 };
-export declare type SealedSenderSelfSendError = LibSignalErrorCommon & {
+export type SealedSenderSelfSendError = LibSignalErrorCommon & {
     code: ErrorCode.SealedSenderSelfSend;
 };
-export declare type UntrustedIdentityError = LibSignalErrorCommon & {
+export type UntrustedIdentityError = LibSignalErrorCommon & {
     code: ErrorCode.UntrustedIdentity;
     addr: string;
 };
-export declare type InvalidRegistrationIdError = LibSignalErrorCommon & {
+export type InvalidRegistrationIdError = LibSignalErrorCommon & {
     code: ErrorCode.InvalidRegistrationId;
     addr: ProtocolAddress;
 };
-export declare type VerificationFailedError = LibSignalErrorCommon & {
+export type VerificationFailedError = LibSignalErrorCommon & {
     code: ErrorCode.VerificationFailed;
 };
-export declare type InvalidSessionError = LibSignalErrorCommon & {
+export type InvalidSessionError = LibSignalErrorCommon & {
     code: ErrorCode.InvalidSession;
 };
-export declare type InvalidSenderKeySessionError = LibSignalErrorCommon & {
+export type InvalidSenderKeySessionError = LibSignalErrorCommon & {
     code: ErrorCode.InvalidSenderKeySession;
     distributionId: string;
 };
-export declare type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError;
+export type CannotBeEmptyError = LibSignalErrorCommon & {
+    code: ErrorCode.CannotBeEmpty;
+};
+export type CannotStartWithDigitError = LibSignalErrorCommon & {
+    code: ErrorCode.CannotStartWithDigit;
+};
+export type MissingSeparatorError = LibSignalErrorCommon & {
+    code: ErrorCode.MissingSeparator;
+};
+export type BadNicknameCharacterError = LibSignalErrorCommon & {
+    code: ErrorCode.BadNicknameCharacter;
+};
+export type NicknameTooShortError = LibSignalErrorCommon & {
+    code: ErrorCode.NicknameTooShort;
+};
+export type NicknameTooLongError = LibSignalErrorCommon & {
+    code: ErrorCode.NicknameTooLong;
+};
+export type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError | CannotBeEmptyError | CannotStartWithDigitError | MissingSeparatorError | BadNicknameCharacterError | NicknameTooShortError | NicknameTooLongError;

package/dist/Errors.js

@@ -16,6 +16,12 @@ var ErrorCode;
     ErrorCode[ErrorCode["VerificationFailed"] = 5] = "VerificationFailed";
     ErrorCode[ErrorCode["InvalidSession"] = 6] = "InvalidSession";
     ErrorCode[ErrorCode["InvalidSenderKeySession"] = 7] = "InvalidSenderKeySession";
+    ErrorCode[ErrorCode["CannotBeEmpty"] = 8] = "CannotBeEmpty";
+    ErrorCode[ErrorCode["CannotStartWithDigit"] = 9] = "CannotStartWithDigit";
+    ErrorCode[ErrorCode["MissingSeparator"] = 10] = "MissingSeparator";
+    ErrorCode[ErrorCode["BadNicknameCharacter"] = 11] = "BadNicknameCharacter";
+    ErrorCode[ErrorCode["NicknameTooShort"] = 12] = "NicknameTooShort";
+    ErrorCode[ErrorCode["NicknameTooLong"] = 13] = "NicknameTooLong";
 })(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
 class LibSignalErrorBase extends Error {
     constructor(message, name, operation, extraProps) {

package/dist/index.d.ts

@@ -2,6 +2,7 @@
 export * from './Errors';
 import { ProtocolAddress } from './Address';
 export * from './Address';
+export * as usernames from './usernames';
 import * as Native from '../Native';
 export declare enum CiphertextMessageType {
     Whisper = 2,
@@ -18,7 +19,7 @@ export declare enum ContentHint {
     Resendable = 1,
     Implicit = 2
 }
-export declare type Uuid = string;
+export type Uuid = string;
 export declare class HKDF {
     /**
      * @deprecated Use the top-level 'hkdf' function for standard HKDF behavior

package/dist/index.js

@@ -27,12 +27,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initLogger = exports.LogLevel = exports.HsmEnclaveClient = exports.Cds2Client = exports.sealedSenderDecryptToUsmc = exports.sealedSenderDecryptMessage = exports.sealedSenderMultiRecipientMessageForSingleRecipient = exports.sealedSenderMultiRecipientEncrypt = exports.sealedSenderEncrypt = 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.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.SignedPreKeyRecord = exports.PreKeyRecord = exports.PreKeyBundle = exports.IdentityKeyPair = exports.PrivateKey = exports.PublicKey = exports.Aes256GcmSiv = exports.Fingerprint = exports.DisplayableFingerprint = exports.ScannableFingerprint = exports.hkdf = exports.HKDF = exports.ContentHint = exports.Direction = exports.CiphertextMessageType = void 0;
+exports.LogLevel = exports.HsmEnclaveClient = exports.Cds2Client = exports.sealedSenderDecryptToUsmc = exports.sealedSenderDecryptMessage = exports.sealedSenderMultiRecipientMessageForSingleRecipient = exports.sealedSenderMultiRecipientEncrypt = exports.sealedSenderEncrypt = 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.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.SignedPreKeyRecord = exports.PreKeyRecord = exports.PreKeyBundle = exports.IdentityKeyPair = exports.PrivateKey = exports.PublicKey = exports.Aes256GcmSiv = exports.Fingerprint = exports.DisplayableFingerprint = exports.ScannableFingerprint = exports.hkdf = exports.HKDF = exports.ContentHint = exports.Direction = exports.CiphertextMessageType = exports.usernames = void 0;
+exports.initLogger = void 0;
 const uuid = require("uuid");
 const Errors = require("./Errors");
 __exportStar(require("./Errors"), exports);
 const Address_1 = require("./Address");
 __exportStar(require("./Address"), exports);
+exports.usernames = require("./usernames");
 const Native = require("../Native");
 Native.registerErrors(Errors);
 // These enums must be kept in sync with their Rust counterparts.
@@ -393,12 +395,12 @@ class SessionRecord {
 }
 exports.SessionRecord = SessionRecord;
 class ServerCertificate {
-    constructor(nativeHandle) {
-        this._nativeHandle = nativeHandle;
-    }
     static _fromNativeHandle(nativeHandle) {
         return new ServerCertificate(nativeHandle);
     }
+    constructor(nativeHandle) {
+        this._nativeHandle = nativeHandle;
+    }
     static new(keyId, serverKey, trustRoot) {
         return new ServerCertificate(Native.ServerCertificate_New(keyId, serverKey, trustRoot));
     }
@@ -423,12 +425,12 @@ class ServerCertificate {
 }
 exports.ServerCertificate = ServerCertificate;
 class SenderKeyRecord {
-    constructor(nativeHandle) {
-        this._nativeHandle = nativeHandle;
-    }
     static _fromNativeHandle(nativeHandle) {
         return new SenderKeyRecord(nativeHandle);
     }
+    constructor(nativeHandle) {
+        this._nativeHandle = nativeHandle;
+    }
     static deserialize(buffer) {
         return new SenderKeyRecord(Native.SenderKeyRecord_Deserialize(buffer));
     }
@@ -881,7 +883,7 @@ class HsmEnclaveClient {
         this._nativeHandle = nativeHandle;
     }
     static new(public_key, code_hashes) {
-        code_hashes.forEach(hash => {
+        code_hashes.forEach((hash) => {
             if (hash.length != 32) {
                 throw new Error('code hash length must be 32');
             }
@@ -915,37 +917,37 @@ function initLogger(maxLevel, callback) {
     let nativeMaxLevel;
     switch (maxLevel) {
         case LogLevel.Error:
-            nativeMaxLevel = 1 /* Error */;
+            nativeMaxLevel = 1 /* Native.LogLevel.Error */;
             break;
         case LogLevel.Warn:
-            nativeMaxLevel = 2 /* Warn */;
+            nativeMaxLevel = 2 /* Native.LogLevel.Warn */;
             break;
         case LogLevel.Info:
-            nativeMaxLevel = 3 /* Info */;
+            nativeMaxLevel = 3 /* Native.LogLevel.Info */;
             break;
         case LogLevel.Debug:
-            nativeMaxLevel = 4 /* Debug */;
+            nativeMaxLevel = 4 /* Native.LogLevel.Debug */;
             break;
         case LogLevel.Trace:
-            nativeMaxLevel = 5 /* Trace */;
+            nativeMaxLevel = 5 /* Native.LogLevel.Trace */;
             break;
     }
     Native.initLogger(nativeMaxLevel, (nativeLevel, target, file, line, message) => {
         let level;
         switch (nativeLevel) {
-            case 1 /* Error */:
+            case 1 /* Native.LogLevel.Error */:
                 level = LogLevel.Error;
                 break;
-            case 2 /* Warn */:
+            case 2 /* Native.LogLevel.Warn */:
                 level = LogLevel.Warn;
                 break;
-            case 3 /* Info */:
+            case 3 /* Native.LogLevel.Info */:
                 level = LogLevel.Info;
                 break;
-            case 4 /* Debug */:
+            case 4 /* Native.LogLevel.Debug */:
                 level = LogLevel.Debug;
                 break;
-            case 5 /* Trace */:
+            case 5 /* Native.LogLevel.Trace */:
                 level = LogLevel.Trace;
                 break;
             default:

package/dist/usernames.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+export declare function generateCandidates(nickname: string, minNicknameLength: number, maxNicknameLength: number): string[];
+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 verifyProof(proof: Buffer, hash: Buffer): void;

package/dist/usernames.js

@@ -0,0 +1,33 @@
+"use strict";
+//
+// Copyright 2023 Signal Messenger, LLC.
+// SPDX-License-Identifier: AGPL-3.0-only
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifyProof = exports.generateProofWithRandom = exports.generateProof = exports.hash = exports.generateCandidates = void 0;
+const crypto_1 = require("crypto");
+const Constants_1 = require("./zkgroup/internal/Constants");
+const Native = require("../Native");
+function generateCandidates(nickname, minNicknameLength, maxNicknameLength) {
+    return Native.Username_CandidatesFrom(nickname, minNicknameLength, maxNicknameLength).split(',');
+}
+exports.generateCandidates = generateCandidates;
+function hash(username) {
+    return Native.Username_Hash(username);
+}
+exports.hash = hash;
+function generateProof(username) {
+    const random = (0, crypto_1.randomBytes)(Constants_1.RANDOM_LENGTH);
+    return generateProofWithRandom(username, random);
+}
+exports.generateProof = generateProof;
+function generateProofWithRandom(username, random) {
+    return Native.Username_Proof(username, random);
+}
+exports.generateProofWithRandom = generateProofWithRandom;
+// Only for testing. Will throw on failure.
+function verifyProof(proof, hash) {
+    Native.Username_Verify(proof, hash);
+}
+exports.verifyProof = verifyProof;
+//# sourceMappingURL=usernames.js.map

package/dist/zkgroup/ServerSecretParams.js

@@ -11,9 +11,6 @@ const Constants_1 = require("./internal/Constants");
 const ServerPublicParams_1 = require("./ServerPublicParams");
 const NotarySignature_1 = require("./NotarySignature");
 class ServerSecretParams extends ByteArray_1.default {
-    constructor(contents) {
-        super(contents, Native.ServerSecretParams_CheckValidContents);
-    }
     static generate() {
         const random = (0, crypto_1.randomBytes)(Constants_1.RANDOM_LENGTH);
         return ServerSecretParams.generateWithRandom(random);
@@ -21,6 +18,9 @@ class ServerSecretParams extends ByteArray_1.default {
     static generateWithRandom(random) {
         return new ServerSecretParams(Native.ServerSecretParams_GenerateDeterministic(random));
     }
+    constructor(contents) {
+        super(contents, Native.ServerSecretParams_CheckValidContents);
+    }
     getPublicParams() {
         return new ServerPublicParams_1.default(Native.ServerSecretParams_GetPublicParams(this.contents));
     }

package/dist/zkgroup/groups/GroupSecretParams.js

@@ -11,9 +11,6 @@ const Constants_1 = require("../internal/Constants");
 const GroupMasterKey_1 = require("./GroupMasterKey");
 const GroupPublicParams_1 = require("./GroupPublicParams");
 class GroupSecretParams extends ByteArray_1.default {
-    constructor(contents) {
-        super(contents, Native.GroupSecretParams_CheckValidContents);
-    }
     static generate() {
         const random = (0, crypto_1.randomBytes)(Constants_1.RANDOM_LENGTH);
         return GroupSecretParams.generateWithRandom(random);
@@ -24,6 +21,9 @@ class GroupSecretParams extends ByteArray_1.default {
     static deriveFromMasterKey(groupMasterKey) {
         return new GroupSecretParams(Native.GroupSecretParams_DeriveFromMasterKey(groupMasterKey.getContents()));
     }
+    constructor(contents) {
+        super(contents, Native.GroupSecretParams_CheckValidContents);
+    }
     getMasterKey() {
         return new GroupMasterKey_1.default(Native.GroupSecretParams_GetMasterKey(this.contents));
     }

package/dist/zkgroup/internal/ByteArray.js

@@ -11,7 +11,7 @@ class ByteArray {
         this.contents = Buffer.from(contents);
     }
     static checkLength(expectedLength) {
-        return contents => {
+        return (contents) => {
             if (contents.length !== expectedLength) {
                 throw new Errors_1.LibSignalErrorBase(`Length of array supplied was ${contents.length} expected ${expectedLength}`, undefined, this.name);
             }

package/dist/zkgroup/internal/UUIDUtil.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="node" />
-export declare type UUIDType = string;
+export type UUIDType = string;
 export declare function toUUID(array: Buffer): UUIDType;
 export declare function fromUUID(uuid: UUIDType): Buffer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/libsignal-client",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,23 +33,23 @@
     "@types/chai": "^4.3.1",
     "@types/chai-as-promised": "^7.1.3",
     "@types/mocha": "^5.2.7",
-    "@types/node": "*",
+    "@types/node": "16.18.3",
     "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^4.6.0",
-    "@typescript-eslint/parser": "^4.6.0",
+    "@typescript-eslint/eslint-plugin": "^5.47.0",
+    "@typescript-eslint/parser": "^5.47.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^7.12.1",
-    "eslint-config-prettier": "^6.15.0",
+    "eslint": "^8.30.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-header": "^3.1.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-mocha": "^8.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-more": "^1.0.0",
     "mocha": "^9",
     "node-gyp": "^8.4.1",
-    "prettier": "^1.19.1",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.1",
     "source-map-support": "^0.5.19",
-    "typescript": "4.6.2"
+    "typescript": "4.9.3"
   }
 }