Releases: conversejs/libomemo.js
2.0.2 (2026-06-22)
Fix "Invalid public key" error when establishing new OMEMO:2 sessions.
SessionBuilder.processPreKeynow normalises the bundle's signed-pre-key and pre-key public keys to the internal 33-byte0x05-prefixed curve form, via a newnormalizeRemotePreKeyprotocol-profile hook. omemo:2 transfers these keys in their raw 32-byte curve form, which the 2.0.1 DH hardening rejected with "Invalid public key", breaking the establishment of every new omemo:2
session.
2.0.1 (2026-06-19)
Security hardeing
- Precompile the
.protoschemas into a static protobuf module (src/generated/protocol.js, regenerated withnpm run proto) instead of parsing them at runtime (which required anunsafe-evalCSP policy). - Harden
SessionRecorddeserialization against prototype-chain mutation. - Curve25519: fail closed on a nonzero WASM status, reject low-order/all-zero ECDH outputs (RFC 7748), and stop mutating/aliasing the caller's private key.
- Behaviour change: the DH/signature paths now require the 33-byte
0x05-prefixed public-key form; raw 32-byte keys are rejected. - Constant-time
util.isEqual(only used for public signatures currently) - Add
SECURITY.md
2.0.0 (2026-06-18)
OMEMO 2 (urn:xmpp:omemo:2) support
- Added support for the latest OMEMO version (
urn:xmpp:omemo:2) alongside the existingeu.siacs.conversations.axolotl(XEP-0384 v0.3.0). Versions are identified by their XML namespace. The two are selected per device via a protocol "profile" that encapsulates the differences (HKDF info strings, MAC length and associated data, the OMEMOMessage/OMEMOAuthenticatedMessage/OMEMOKeyExchange` wire format, and Ed25519↔Curve25519 identity-key handling). The Double Ratchet and X3DH mechanics are shared across both versions. - New
curvePubKeyToEd25519PubKey/ed25519PubKeyToCurvePubKeycrypto helpers (backed by two new WASM exports) for theomemo:2Ed25519 identity-key form. The Ed25519 identity key is derived from the public key with the Edwards sign
bit forced to zero, matchinglibomemo-cso theikand authentication associated data are byte-compatible with interoperating clients (e.g. Dino). - New
OMEMOVersiontype identifying the protocol version by its XML namespace.
Security: enforce the XEP-0384 MAX_SKIP storage limit
- Cap skipped Double-Ratchet message keys at 1000 per receiving chain, discarding the oldest first (FIFO). This bounds the storage-flooding DoS described in the XEP's "MAX_SKIP" section.
Breaking: version is now a required constructor argument
new SessionBuilder(store, address, version)andnew SessionCipher(store, address, version)now require an explicit OMEMO
version, given as its XML namespace ("eu.siacs.conversations.axolotl"or"urn:xmpp:omemo:2"). There is no default — wrong-version usage fails at the call site rather than silently producing undecryptable messages. A legacy-only consumer simply passes"eu.siacs.conversations.axolotl".EncryptResultgained an optionalkex?: boolean(omemo:2) andregistrationIdis now optional.- Session storage schema bumped to
v2: each stored session now records itsprotocolVersion. Existing serialized sessions are migrated automatically and treated aseu.siacs.conversations.axolotl, so persisted sessions remain valid across the upgrade.
Breaking: narrowed public API
- The package entry point now exports only the consumer-facing surface. The following low-level helpers are no longer exported (they remain internal implementation details):
encrypt,decrypt,sign,hash,HKDF,
HKDFInternal,verifyMAC,ECDHE,getRandomBytes,createKeyPair,Ed25519Sign,Ed25519Verify,internalCrypto, theCurve25519class, andgetProtocolProfile/ theProtocolProfiletype. - Still exported:
SessionBuilder,SessionCipher,KeyHelper,OMEMOAddress,FingerprintGenerator,SessionRecord,InMemoryStore,startWorker/stopWorker,util, thecurvePubKeyToEd25519PubKey/ed25519PubKeyToCurvePubKeyconversion helpers, and the public types/enums.
Breaking: decrypt methods now return a DecryptResult
SessionCipher.decryptWhisperMessageanddecryptPreKeyWhisperMessagenow resolve to aDecryptResult({ plaintext, ratchet: { counter, key } }) instead of a bare plaintextArrayBuffer. Existing callers must destructureplaintextfrom the result.ratchet.counteris the message index within the sender's current chain andratchet.keyis the sender's ratchet (DH) public key in the internal 33-byte0x05-prefixed curve form. Both are normalized identically across the legacy (0.3.0) andomemo:2profiles, and let consumers implement protocol rules such as the OMEMO heartbeat (XEP-0384).- New exported
DecryptResulttype.
v2.0.0-rc.2
Second release candidate for 2.0.0.
This RC adds ratchet-state visibility to the decrypt API so consumers can implement the OMEMO heartbeat rule.
DecryptResult
SessionCipher.decryptWhisperMessage and decryptPreKeyWhisperMessage now resolve to a DecryptResult object instead of a bare plaintext ArrayBuffer:
// Before (rc.1)
const plaintext = await cipher.decryptWhisperMessage(ciphertext, "binary");
// Now (rc.2)
const { plaintext, ratchet } = await cipher.decryptWhisperMessage(ciphertext, "binary");
```
The shape is:
```javascript
interface DecryptResult {
plaintext: ArrayBuffer;
ratchet: {
counter: number; // message index within the sender's current chain
key: ArrayBuffer; // sender's ratchet (DH) public key, 33-byte 0x05-prefixed curve form
};
}Migration: destructure plaintext from the result at every call site.
Why
The OMEMO heartbeat rule (XEP-0384: "the first message for a given ratchet key with a counter of 53 or higher" must trigger a
heartbeat) requires knowing a just-decrypted message's Double Ratchet counter and the sender's ratchet key. Both values were
already parsed internally and are now exposed. They are normalized identically across the legacy
(eu.siacs.conversations.axolotl, v0.3.0) and urn:xmpp:omemo:2 profiles, so the field shape is the same regardless of version.
Notes
- This is a prerelease. When installing from npm, target the prerelease tag explicitly (e.g. npm install libomemo.js@next).
v2.0.0-rc.1
OMEMO 2 (urn:xmpp:omemo:2) support
- Added support for the latest OMEMO version (
urn:xmpp:omemo:2) alongside the
existingeu.siacs.conversations.axolotl(XEP-0384 v0.3.0). Versions are
identified by their XML namespace. The two are selected per device via a protocol "profile" that
encapsulates the differences (HKDF info strings, MAC length and associated data,
theOMEMOMessage/OMEMOAuthenticatedMessage/OMEMOKeyExchangewire format,
and Ed25519↔Curve25519 identity-key handling). The Double Ratchet and X3DH
mechanics are shared across both versions. - New
curvePubKeyToEd25519PubKey/ed25519PubKeyToCurvePubKeycrypto helpers
(backed by two new WASM exports) for theomemo:2Ed25519 identity-key form.
The Ed25519 identity key is derived from the public key with the Edwards sign
bit forced to zero, matchinglibomemo-cso theikand authentication
associated data are byte-compatible with interoperating clients (e.g. Dino). - New
OMEMOVersiontype identifying the protocol version by its XML namespace.
Breaking: version is now a required constructor argument
new SessionBuilder(store, address, version)and
new SessionCipher(store, address, version)now require an explicit OMEMO
version, given as its XML namespace ("eu.siacs.conversations.axolotl"or
"urn:xmpp:omemo:2"). There is no default — wrong-version usage fails at the
call site rather than silently producing undecryptable messages. A legacy-only
consumer simply passes"eu.siacs.conversations.axolotl".EncryptResultgained an optionalkex?: boolean(omemo:2) andregistrationId
is now optional.- Session storage schema bumped to
v2: each stored session now records its
protocolVersion. Existing serialized sessions are migrated automatically and
treated aseu.siacs.conversations.axolotl, so persisted sessions remain valid
across the upgrade.
Breaking: narrowed public API
- The package entry point now exports only the consumer-facing surface. The
following low-level helpers are no longer exported (they remain internal
implementation details):encrypt,decrypt,sign,hash,HKDF,
HKDFInternal,verifyMAC,ECDHE,getRandomBytes,createKeyPair,
Ed25519Sign,Ed25519Verify,internalCrypto, theCurve25519class, and
getProtocolProfile/ theProtocolProfiletype. - Still exported:
SessionBuilder,SessionCipher,KeyHelper,OMEMOAddress,
FingerprintGenerator,SessionRecord,InMemoryStore,startWorker/
stopWorker,util, thecurvePubKeyToEd25519PubKey/
ed25519PubKeyToCurvePubKeyconversion helpers, and the public types/enums.
1.0.0
Breaking: OMEMOStore identity methods now receive full address string
isTrustedIdentity,loadIdentityKey, andsaveIdentitynow all receive the full OMEMOAddress string ("name.deviceId") instead of just the name. Previously,isTrustedIdentityandloadIdentityKeyreceived only the name (viagetName()), whilesaveIdentityreceived the full address (viatoString()). This was inherited from libsignal-protocol-javascript where it made sense (one identity key per account), but is incorrect for OMEMO where each device has its own identity key pair.- The
InMemoryStorereference implementation now stores identity keys per-device (keyed by full address) instead of per-name. - The
OMEMOStoreinterface parameter name changed fromnametoaddressfor clarity. - Downstream consumers implementing a custom
OMEMOStoremust update theirisTrustedIdentity,loadIdentityKey, andsaveIdentityimplementations to expect the full address string.
0.0.1
Note: This version still targets XMPP OMEMO version 0.3.0. Support for the latest version of OMEMO will be added in a subsequent release.
Here follows a breakdown of changes made to the original libsignal-protocol-javascript which this library is a fork of:
Breaking: Multiple public functions converted to async
Many functions were converted from returning plain Promises to being async functions. This changes how validation errors are surfaced:
-
Validation errors no longer throw synchronously. Previously, passing invalid arguments would throw a
TypeErrorimmediately. These errors are now returned as rejected promises. -
Synchronous
try/catchno longer works. Code like this will silently miss the error and produce an unhandled rejection:// TypeError is never caught here try { KeyHelper.generatePreKey("bad"); } catch (e) { // never reached }
-
Callers must handle the returned promise. Always use
.then()/.catch()orawait:// Correct usage try { await KeyHelper.generatePreKey(keyId); } catch (e) { // handles validation errors and crypto failures }
Affected functions
KeyHelper:
KeyHelper.generateSignedPreKey(identityKeyPair, keyId)KeyHelper.generatePreKey(keyId)
Curve.async:
Curve.async.generateKeyPair()Curve.async.createKeyPair(privKey)Curve.async.calculateAgreement(pubKey, privKey)Curve.async.verifySignature(pubKey, msg, sig)Curve.async.calculateSignature(privKey, message)
FingerprintGenerator:
FingerprintGenerator.prototype.createFor(localIdentifier, localIdentityKey, remoteIdentifier, remoteIdentityKey)
SessionCipher:
SessionCipher.prototype.decryptWhisperMessage(buffer, encoding)SessionCipher.prototype.getRemoteRegistrationId()SessionCipher.prototype.hasOpenSession()SessionCipher.prototype.closeOpenSessionForDevice()SessionCipher.prototype.deleteAllSessionsForDevice()
crypto.js exports:
encrypt(key, data, iv)decrypt(key, data, iv)sign(key, data)HKDFInternal(input, salt, info)verifyMAC(data, key, mac, length)internalCrypto.createKeyPair(privKey)internalCrypto.ECDHE(pubKey, privKey)internalCrypto.Ed25519Sign(privKey, message)internalCrypto.Ed25519Verify(pubKey, msg, sig)createKeyPair(privKey)ECDHE(pubKey, privKey)Ed25519Sign(privKey, message)Ed25519Verify(pubKey, msg, sig)
Full TypeScript Rewrite
All source files have been migrated from JavaScript to TypeScript with strict type checking. The library now ships bundled .d.ts type declarations.
Module System
- ES modules with named exports are now the primary distribution format.
- UMD bundle available as
libomemo.umd.jswith alibomemoglobal (replaces the oldlibsignalglobal). - The
Internalnamespace has been removed. All functionality is exported directly.
Package Renamed
- Package name is now
libomemo.js(waslibsignal-protocol-javascript). - Repository moved to
github:conversejs/libomemo.js.
Removed Dependencies
dcodeIO.ByteBuffer— removed. Useutil.toString()andutil.toArrayBuffer()or nativeTextEncoder/Uint8Array.Long— removed.dcodeIO.ProtoBuf— replaced withprotobufjsv8. Proto files are loaded from string variables at build time (no network fetch needed).
OMEMOAddress (formerly SignalProtocolAddress)
- Renamed from
SignalProtocolAddresstoOMEMOAddress. - Added static
OMEMOAddress.fromString(encodedAddress)for parsing"name.deviceId"format. - Added
equals(other)method for comparison. - Security fix: ReDoS vulnerability in
fromStringfixed by replacing the regex with a safe validation pattern (/^[^.]+\.\d+$/).
SessionRecord
- Completely rewritten with improved serialization/deserialization logic.
- Added
SessionRecord.isSessionOpen(sessionState)static method. getSessionByBaseKey()now acceptsArrayBuffer | string | Uint8Array.- Added
deleteAllSessions()method. - Exported as a value (not just a type) so consumers can call static methods.
InMemoryStore
- Reference implementation of
OMEMOStoreis now exported directly from the library. Useful for testing and as a template for persistent stores.
New Type Exports
The following types are now exported for consumers implementing custom stores or handling encryption results:
Direction—SENDING = 1,RECEIVING = 2PreKeyBundle— bundle format forSessionBuilder.processPreKey()OMEMOStore— interface for custom store implementationsKeyId—number | stringEncryptResult— return type ofSessionCipher.encrypt()IdentityKeyError— error with.identityKeypropertyKeyPair,PreKey,SignedPreKey,PublicPreKey
Web Worker Security
- Added
ALLOWED_METHODSwhitelist to the curve25519 worker to prevent arbitrary method calls via worker messages.
Source Maps
- Source maps are now enabled for all build outputs (ESM, UMD, and worker).
Build System
- Grunt replaced with Rollup for bundling.
npm run compilecompiles native C code with Emscripten.npm run distbuilds TypeScript to ESM + UMD bundles.npm run build:dtsgenerates.d.tstype declarations.
Curve25519 / OMEMO Spec Compliance
xed25519_signreplacescurve25519_signfor OMEMO spec compliance.xed25519_verifyreplacescurve25519_verifyto match.curve25519_signandcurve25519_verifyare no longer exported from the WASM module.
FingerprintGenerator
- New class for generating safety number fingerprints for identity verification. Constructor takes an
iterationscount. Call
createFor(localIdentifier, localIdentityKey, remoteIdentifier, remoteIdentityKey)to get a fingerprint string.
Job Queue / Locking
- All session operations for a given address are now serialized through
queueJobForNumberto prevent race conditions.
Full TypeScript Rewrite
All source files have been migrated from JavaScript to TypeScript with strict type checking. The library now ships bundled .d.ts type declarations.
Module System
- ES modules with named exports are now the primary distribution format.
- UMD bundle available as
libomemo.umd.jswith alibomemoglobal (replaces the oldlibsignalglobal). - The
Internalnamespace has been removed. All functionality is exported directly.
Package Renamed
- Package name is now
libomemo.js(waslibsignal-protocol-javascript). - Repository moved to
github:conversejs/libomemo.js.
Removed Dependencies
dcodeIO.ByteBuffer— removed. Useutil.toString()andutil.toArrayBuffer()or nativeTextEncoder/Uint8Array.Long— removed.dcodeIO.ProtoBuf— replaced withprotobufjsv8. Proto files are loaded from string variables at build time (no network fetch needed).
OMEMOAddress (formerly SignalProtocolAddress)
- Renamed from
SignalProtocolAddresstoOMEMOAddress. - Added static
OMEMOAddress.fromString(encodedAddress)for parsing"name.deviceId"format. - Added
equals(other)method for comparison. - Security fix: ReDoS vulnerability in
fromStringfixed by replacing the regex with a safe validation pattern (/^[^.]+\.\d+$/).
SessionRecord
- Completely rewritten with improved serialization/deserialization logic.
- Added
SessionRecord.isSessionOpen(sessionState)static method. getSessionByBaseKey()now acceptsArrayBuffer | string | Uint8Array.- Added
deleteAllSessions()method. - Exported as a value (not just a type) so consumers can call static methods.
InMemoryStore
- Reference implementation of
OMEMOStoreis now exported directly from the library. Useful for testing and as a template for persistent stores.
New Type Exports
The following types are now exported for consumers implementing custom stores or handling encryption results:
Direction—SENDING = 1,RECEIVING = 2PreKeyBundle— bundle format forSessionBuilder.processPreKey()OMEMOStore— interface for custom store implementationsKeyId—number | stringEncryptResult— return type ofSessionCipher.encrypt()IdentityKeyError— error with.identityKeypropertyKeyPair,PreKey,SignedPreKey,PublicPreKey
Web Worker Security
- Added
ALLOWED_METHODSwhitelist to the curve25519 worker to prevent arbitrary method calls via worker messages.
Source Maps
- Source maps are now enabled for all build outputs (ESM, UMD, and worker).
Build System
- Grunt replaced with Rollup for bundling.
npm run compilecompiles native C code with Emscripten.npm run distbuilds TypeScript to ESM + UMD bundles.npm run build:dtsgenerates.d.tstype declarations.
Curve25519 / OMEMO Spec Compliance
xed25519_signreplacescurve25519_signfor OMEMO spec compliance.xed25519_verifyreplacescurve25519_verifyto match.curve25519_signandcurve25519_verifyare no longer exported from the
WASM module.
FingerprintGenerator
- New class for generating safety number fingerprints for identity verification. Constructor takes an
iterationscount. CallcreateFor(localIdentifier, localIdentityKey, remoteIdentifier, remoteIdentityKey)to get a fingerprint string.
Job Queue / Locking
- All session operations for a given address are now serialized through
queueJobForNumberto prevent race conditions.