@signalapp/libsignal-client 0.27.0 → 0.29.0

package/Native.d.ts

@@ -306,6 +306,11 @@ export function ServerSecretParams_SignDeterministic(params: Serialized<ServerSe
 export function ServerSecretParams_VerifyAuthCredentialPresentation(serverSecretParams: Serialized<ServerSecretParams>, groupPublicParams: Serialized<GroupPublicParams>, presentationBytes: Buffer, currentTimeInSeconds: Timestamp): void;
 export function ServerSecretParams_VerifyProfileKeyCredentialPresentation(serverSecretParams: Serialized<ServerSecretParams>, groupPublicParams: Serialized<GroupPublicParams>, presentationBytes: Buffer, currentTimeInSeconds: Timestamp): void;
 export function ServerSecretParams_VerifyReceiptCredentialPresentation(serverSecretParams: Serialized<ServerSecretParams>, presentation: Serialized<ReceiptCredentialPresentation>): void;
+export function ServiceId_ParseFromServiceIdBinary(input: Buffer): Buffer;
+export function ServiceId_ParseFromServiceIdString(input: string): Buffer;
+export function ServiceId_ServiceIdBinary(value: Buffer): Buffer;
+export function ServiceId_ServiceIdLog(value: Buffer): string;
+export function ServiceId_ServiceIdString(value: Buffer): string;
 export function SessionBuilder_ProcessPreKeyBundle(bundle: Wrapper<PreKeyBundle>, protocolAddress: Wrapper<ProtocolAddress>, sessionStore: SessionStore, identityKeyStore: IdentityKeyStore, ctx: null): Promise<void>;
 export function SessionCipher_DecryptPreKeySignalMessage(message: Wrapper<PreKeySignalMessage>, protocolAddress: Wrapper<ProtocolAddress>, sessionStore: SessionStore, identityKeyStore: IdentityKeyStore, prekeyStore: PreKeyStore, signedPrekeyStore: SignedPreKeyStore, kyberPrekeyStore: KyberPreKeyStore, ctx: null): Promise<Buffer>;
 export function SessionCipher_DecryptSignalMessage(message: Wrapper<SignalMessage>, protocolAddress: Wrapper<ProtocolAddress>, sessionStore: SessionStore, identityKeyStore: IdentityKeyStore, ctx: null): Promise<Buffer>;
@@ -345,6 +350,8 @@ 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_DecryptUsername(entropy: Buffer, encryptedUsername: Buffer): string;
 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;

package/dist/Address.d.ts

@@ -1,9 +1,49 @@
+/// <reference types="node" />
 import * as Native from '../Native';
+declare enum ServiceIdKind {
+    Aci = 0,
+    Pni = 1
+}
+type ThisType<T extends {
+    prototype: unknown;
+}> = T['prototype'];
+export declare class ServiceId extends Object {
+    private readonly serviceIdFixedWidthBinary;
+    protected constructor(serviceIdFixedWidthBinary: Buffer);
+    protected static fromUuidBytesAndKind<T extends typeof ServiceId>(this: T, uuidBytes: ArrayLike<number>, kind: ServiceIdKind): ThisType<T>;
+    getServiceIdBinary(): Buffer;
+    getServiceIdString(): string;
+    toString(): string;
+    private static parseFromServiceIdFixedWidthBinary;
+    static parseFromServiceIdBinary(serviceIdBinary: Buffer): ServiceId;
+    static parseFromServiceIdString(serviceIdString: string): ServiceId;
+    getRawUuid(): string;
+    getRawUuidBytes(): Buffer;
+    isEqual(other: ServiceId): boolean;
+}
+export declare class Aci extends ServiceId {
+    private readonly __type?;
+    static fromUuid(uuidString: string): Aci;
+    static fromUuidBytes(uuidBytes: ArrayLike<number>): Aci;
+}
+export declare class Pni extends ServiceId {
+    private readonly __type?;
+    static fromUuid(uuidString: string): Pni;
+    static fromUuidBytes(uuidBytes: ArrayLike<number>): Pni;
+}
 export declare class ProtocolAddress {
     readonly _nativeHandle: Native.ProtocolAddress;
     private constructor();
     static _fromNativeHandle(handle: Native.ProtocolAddress): ProtocolAddress;
-    static new(name: string, deviceId: number): ProtocolAddress;
+    static new(name: string | ServiceId, deviceId: number): ProtocolAddress;
     name(): string;
+    /**
+     * Returns a ServiceId if this address contains a valid ServiceId, `null` otherwise.
+     *
+     * In a future release ProtocolAddresses will *only* support ServiceIds.
+     */
+    serviceId(): ServiceId | null;
     deviceId(): number;
+    toString(): string;
 }
+export {};

package/dist/Address.js

@@ -4,8 +4,83 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProtocolAddress = void 0;
+exports.ProtocolAddress = exports.Pni = exports.Aci = exports.ServiceId = void 0;
 const Native = require("../Native");
+const uuid = require("uuid");
+var ServiceIdKind;
+(function (ServiceIdKind) {
+    ServiceIdKind[ServiceIdKind["Aci"] = 0] = "Aci";
+    ServiceIdKind[ServiceIdKind["Pni"] = 1] = "Pni";
+})(ServiceIdKind || (ServiceIdKind = {}));
+const SERVICE_ID_FIXED_WIDTH_BINARY_LEN = 17;
+class ServiceId extends Object {
+    constructor(serviceIdFixedWidthBinary) {
+        super();
+        if (serviceIdFixedWidthBinary.length != SERVICE_ID_FIXED_WIDTH_BINARY_LEN) {
+            throw new TypeError('invalid Service-Id-FixedWidthBinary');
+        }
+        this.serviceIdFixedWidthBinary = serviceIdFixedWidthBinary;
+    }
+    static fromUuidBytesAndKind(uuidBytes, kind) {
+        const buffer = Buffer.alloc(SERVICE_ID_FIXED_WIDTH_BINARY_LEN);
+        buffer[0] = kind;
+        buffer.set(uuidBytes, 1);
+        return new this(buffer);
+    }
+    getServiceIdBinary() {
+        return Native.ServiceId_ServiceIdBinary(this.serviceIdFixedWidthBinary);
+    }
+    getServiceIdString() {
+        return Native.ServiceId_ServiceIdString(this.serviceIdFixedWidthBinary);
+    }
+    toString() {
+        return Native.ServiceId_ServiceIdLog(this.serviceIdFixedWidthBinary);
+    }
+    static parseFromServiceIdFixedWidthBinary(serviceIdFixedWidthBinary) {
+        switch (serviceIdFixedWidthBinary[0]) {
+            case ServiceIdKind.Aci:
+                return new Aci(serviceIdFixedWidthBinary);
+            case ServiceIdKind.Pni:
+                return new Pni(serviceIdFixedWidthBinary);
+            default:
+                throw new TypeError('unknown type in Service-Id-FixedWidthBinary');
+        }
+    }
+    static parseFromServiceIdBinary(serviceIdBinary) {
+        return ServiceId.parseFromServiceIdFixedWidthBinary(Native.ServiceId_ParseFromServiceIdBinary(serviceIdBinary));
+    }
+    static parseFromServiceIdString(serviceIdString) {
+        return ServiceId.parseFromServiceIdFixedWidthBinary(Native.ServiceId_ParseFromServiceIdString(serviceIdString));
+    }
+    getRawUuid() {
+        return uuid.stringify(this.serviceIdFixedWidthBinary, 1);
+    }
+    getRawUuidBytes() {
+        return Buffer.from(this.serviceIdFixedWidthBinary.buffer, 1);
+    }
+    isEqual(other) {
+        return this.serviceIdFixedWidthBinary.equals(other.serviceIdFixedWidthBinary);
+    }
+}
+exports.ServiceId = ServiceId;
+class Aci extends ServiceId {
+    static fromUuid(uuidString) {
+        return this.fromUuidBytes(uuid.parse(uuidString));
+    }
+    static fromUuidBytes(uuidBytes) {
+        return super.fromUuidBytesAndKind(uuidBytes, ServiceIdKind.Aci);
+    }
+}
+exports.Aci = Aci;
+class Pni extends ServiceId {
+    static fromUuid(uuidString) {
+        return this.fromUuidBytes(uuid.parse(uuidString));
+    }
+    static fromUuidBytes(uuidBytes) {
+        return super.fromUuidBytesAndKind(uuidBytes, ServiceIdKind.Pni);
+    }
+}
+exports.Pni = Pni;
 class ProtocolAddress {
     constructor(handle) {
         this._nativeHandle = handle;
@@ -14,14 +89,33 @@ class ProtocolAddress {
         return new ProtocolAddress(handle);
     }
     static new(name, deviceId) {
+        if (typeof name !== 'string') {
+            name = name.getServiceIdString();
+        }
         return new ProtocolAddress(Native.ProtocolAddress_New(name, deviceId));
     }
     name() {
         return Native.ProtocolAddress_Name(this);
     }
+    /**
+     * Returns a ServiceId if this address contains a valid ServiceId, `null` otherwise.
+     *
+     * In a future release ProtocolAddresses will *only* support ServiceIds.
+     */
+    serviceId() {
+        try {
+            return ServiceId.parseFromServiceIdString(this.name());
+        }
+        catch (_a) {
+            return null;
+        }
+    }
     deviceId() {
         return Native.ProtocolAddress_DeviceId(this);
     }
+    toString() {
+        return `${this.name()}.${this.deviceId()}`;
+    }
 }
 exports.ProtocolAddress = ProtocolAddress;
 //# sourceMappingURL=Address.js.map

package/dist/Errors.d.ts

@@ -17,7 +17,10 @@ export declare enum ErrorCode {
     NicknameTooLong = 13,
     IoError = 14,
     InvalidMediaInput = 15,
-    UnsupportedMediaInput = 16
+    UnsupportedMediaInput = 16,
+    InputDataTooLong = 17,
+    InvalidEntropyDataLength = 18,
+    InvalidUsernameLinkEncryptedData = 19
 }
 export declare class LibSignalErrorBase extends Error {
     readonly code: ErrorCode;
@@ -72,6 +75,15 @@ export type NicknameTooShortError = LibSignalErrorCommon & {
 export type NicknameTooLongError = LibSignalErrorCommon & {
     code: ErrorCode.NicknameTooLong;
 };
+export type InputDataTooLong = LibSignalErrorCommon & {
+    code: ErrorCode.InputDataTooLong;
+};
+export type InvalidEntropyDataLength = LibSignalErrorCommon & {
+    code: ErrorCode.InvalidEntropyDataLength;
+};
+export type InvalidUsernameLinkEncryptedData = LibSignalErrorCommon & {
+    code: ErrorCode.InvalidUsernameLinkEncryptedData;
+};
 export type IoError = LibSignalErrorCommon & {
     code: ErrorCode.IoError;
 };
@@ -81,4 +93,4 @@ export type InvalidMediaInputError = LibSignalErrorCommon & {
 export type UnsupportedMediaInputError = LibSignalErrorCommon & {
     code: ErrorCode.UnsupportedMediaInput;
 };
-export type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError | CannotBeEmptyError | CannotStartWithDigitError | MissingSeparatorError | BadNicknameCharacterError | NicknameTooShortError | NicknameTooLongError | IoError | InvalidMediaInputError | UnsupportedMediaInputError;
+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

@@ -25,6 +25,9 @@ var ErrorCode;
     ErrorCode[ErrorCode["IoError"] = 14] = "IoError";
     ErrorCode[ErrorCode["InvalidMediaInput"] = 15] = "InvalidMediaInput";
     ErrorCode[ErrorCode["UnsupportedMediaInput"] = 16] = "UnsupportedMediaInput";
+    ErrorCode[ErrorCode["InputDataTooLong"] = 17] = "InputDataTooLong";
+    ErrorCode[ErrorCode["InvalidEntropyDataLength"] = 18] = "InvalidEntropyDataLength";
+    ErrorCode[ErrorCode["InvalidUsernameLinkEncryptedData"] = 19] = "InvalidUsernameLinkEncryptedData";
 })(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
 class LibSignalErrorBase extends Error {
     constructor(message, name, operation, extraProps) {

package/dist/usernames.d.ts

@@ -1,6 +1,12 @@
 /// <reference types="node" />
+export type UsernameLink = {
+    entropy: Buffer;
+    encryptedUsername: Buffer;
+};
 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 decryptUsernameLink(usernameLink: UsernameLink): string;
+export declare function createUsernameLink(username: string): UsernameLink;
 export declare function verifyProof(proof: Buffer, hash: Buffer): void;

package/dist/usernames.js

@@ -4,7 +4,7 @@
 // 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;
+exports.verifyProof = exports.createUsernameLink = exports.decryptUsernameLink = exports.generateProofWithRandom = exports.generateProof = exports.hash = exports.generateCandidates = void 0;
 /* eslint @typescript-eslint/no-shadow: ["error", { "allow": ["hash"] }] */
 const crypto_1 = require("crypto");
 const Constants_1 = require("./zkgroup/internal/Constants");
@@ -26,6 +26,17 @@ function generateProofWithRandom(username, random) {
     return Native.Username_Proof(username, random);
 }
 exports.generateProofWithRandom = generateProofWithRandom;
+function decryptUsernameLink(usernameLink) {
+    return Native.UsernameLink_DecryptUsername(usernameLink.entropy, usernameLink.encryptedUsername);
+}
+exports.decryptUsernameLink = decryptUsernameLink;
+function createUsernameLink(username) {
+    const usernameLinkData = Native.UsernameLink_Create(username);
+    const entropy = usernameLinkData.slice(0, 32);
+    const encryptedUsername = usernameLinkData.slice(32);
+    return { entropy, encryptedUsername };
+}
+exports.createUsernameLink = createUsernameLink;
 // Only for testing. Will throw on failure.
 function verifyProof(proof, hash) {
     Native.Username_Verify(proof, hash);

package/package.json

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