Go to file
Hubert Chathi 7e0c827703 release 3.2.16 2023-11-23 12:38:51 -05:00
.circleci ...in the right dir 2018-10-03 16:26:17 +01:00
android release 3.2.16 2023-11-23 12:38:51 -05:00
cmake Add CMake support 2018-10-12 16:22:03 -04:00
docs fix(megolm spec): Correct the version for the session export format. 2022-09-01 14:58:16 +02:00
fuzzing Fix unpickling error handling. 2021-07-31 01:27:43 +00:00
include improve handling of olm_session_describe when buffer is too short 2021-12-10 16:14:46 -05:00
javascript release 3.2.16 2023-11-23 12:38:51 -05:00
lib switch to doctest for unit testing 2021-12-22 13:45:33 -05:00
nix Enable darwin builds in Nix for olm 2023-03-17 16:53:50 -04:00
python release 3.2.16 2023-11-23 12:38:51 -05:00
src improve handling of olm_session_describe when buffer is too short 2021-12-10 16:14:46 -05:00
tests switch to doctest for unit testing 2021-12-22 13:45:33 -05:00
tracing switch from /usr/bin/python to /usr/bin/env python. this doesn't help folks whose python path points at python3 (e.g. Arch linux) though, but I see no choice than they have to change the shebangs, as we do on Synapse. For instance, OSX doesn't have a python2 symlink, otherwise we'd use /usr/bin/env python2 shebang. 2015-11-01 13:05:51 +00:00
xcode exposed olm_sas_calculate_mac_fixed_base64 in the bindings 2022-04-21 21:45:19 -04:00
.editorconfig Add .editorconfig. 2021-07-08 14:28:40 +00:00
.gitignore Fix type hints on the PkDecryption class 2022-05-13 11:39:44 +01:00
.gitlab-ci.yml keep testing logs 2021-11-23 22:35:10 +00:00
CHANGELOG.rst release 3.2.16 2023-11-23 12:38:51 -05:00
CMakeLists.txt release 3.2.16 2023-11-23 12:38:51 -05:00
CONTRIBUTING.md Convert CONTRIBUTING.rst to markdown 2019-05-14 12:57:54 -04:00
LICENSE Copyright notices and a license 2015-02-26 16:56:25 +00:00
Makefile aha, it's lowercase 2023-04-27 19:53:44 -04:00
OLMKit.podspec release 3.2.16 2023-11-23 12:38:51 -05:00
Package.swift release 3.2.16 2023-11-23 12:38:51 -05:00
README.md release 3.2.16 2023-11-23 12:38:51 -05:00
Windows64.cmake release 3.2.14 2022-12-05 17:58:00 -05:00
common.mk release 3.2.16 2023-11-23 12:38:51 -05:00
exports.py fix JavaScript build 2021-06-18 13:12:11 -04:00
flake.lock update nix info 2022-10-06 15:26:39 -04:00
flake.nix Enable darwin builds in Nix for olm 2023-03-17 16:53:50 -04:00
gitlab-math.lua fix doc building. Thanks to Jonas Smedegaard. 2022-01-14 11:08:58 -05:00
jenkins.sh python: Remove the python bindings. 2018-07-18 17:44:32 -04:00
lib_exports.sh Add lib_exports.sh for printing list of exported functions. 2021-07-13 10:50:27 +02:00
libolm.version make functions const where possible 2021-06-16 23:22:25 -04:00
olm.pc.in pkgconfig improvements 2022-10-06 22:22:56 -04:00
version_script.ver Use a version script to restrict symbols in the .so 2016-05-20 15:15:40 +01:00



An implementation of the Double Ratchet cryptographic ratchet described by https://whispersystems.org/docs/specifications/doubleratchet/, written in C and C++11 and exposed as a C API.

The specification of the Olm ratchet can be found in docs/olm.md.

This library also includes an implementation of the Megolm cryptographic ratchet, as specified in docs/megolm.md.


Linux and other Unix-like systems

Your distribution may have pre-compiled packages available. If not, or if you need a newer version, you will need to compile from source. See the "Building" section below for more details.


The easiest way to install on macOS is via Homebrew. If you do not have Homebrew installed, follow the instructions at https://brew.sh/ to install it.

You can then install libolm by running

brew install libolm

If you also need the Python packages, you can run

pip3 install python-olm --global-option="build_ext" --global-option="--include-dirs="`brew --prefix libolm`"/include" --global-option="--library-dirs="`brew --prefix libolm`"/lib"

Note that this will install an older version of the Python bindings, which may be missing some functions. If you need the latest version, you will need to build from source.


You will need to build from source. See the "Building" section below for more details.



You can use pre-built npm packages, available at https://gitlab.matrix.org/matrix-org/olm/-/packages?type=npm.


A Python source package and pre-built packages for certain architectures from https://pypi.org/project/python-olm/. If a pre-built package is not available for your architecture, you will need:

  • cmake (recommended) or GNU make
  • a C/C++ compiler

to build the source package.

You can then run pip install python-olm.

Currently, we try to provide packages for all supported versions of Python on x86-64, i686, and aarch64, but we cannot guarantee that packages for all versions will be available on all architectures.


Pre-built Android bindings are available at https://gitlab.matrix.org/matrix-org/olm/-/packages?type=Maven.


To build olm as a shared library run:

cmake . -Bbuild
cmake --build build

To run the tests, run:

cd build/tests
ctest .

To build olm as a static library (which still needs libstdc++ dynamically) run:

cmake . -Bbuild -DBUILD_SHARED_LIBS=NO
cmake --build build

The library can also be used as a dependency with CMake using:

find_package(Olm::Olm REQUIRED)
target_link_libraries(my_exe Olm::Olm)



The recommended way to build the JavaScript bindings is using Nix. With Nix, you can run

nix build .\#javascript

to build the bindings.

If you do not have Nix you can, install emscripten from https://emscripten.org/ and then run:

make js

Emscripten can also be run via Docker, in which case, you need to pass through the EMCC_CLOSURE_ARGS environment variable.


To build the android project for Android bindings, run:

cd android
./gradlew clean build


To build the Xcode workspace for Objective-C bindings, run:

cd xcode
pod install
open OLMKit.xcworkspace


To build the Python 3 bindings, first build olm as a library as above, and then run:

cd python

Using make instead of cmake

WARNING: Using cmake is the preferred method for building the olm library; the Makefile may be removed in the future or have functionality removed. In addition, the Makefile may make certain assumptions about your system and is not as well tested.

To build olm as a dynamic library, run:


To run the tests, run:

make test

To build olm as a static library, run:

make static


libolm can be used in different environments using bindings. In addition to the JavaScript, Python, Java (Android), and Objective-C bindings included in this repository, some bindings are (in alphabetical order):

Note that bindings may have a different license from libolm, and are not endorsed by the Matrix.org Foundation C.I.C.

Release process

First: bump version numbers in common.mk, CMakeLists.txt, javascript/package.json, python/pyproject.toml, OLMKit.podspec, Package.swift, and android/gradle.properties.

Also, ensure the changelog is up to date, and that everything is committed to git.

It's probably sensible to do the above on a release branch (release-vx.y.z by convention), and merge back to master once the release is complete.

make clean

# build and test C library
make test

# build and test JS wrapper
make js
(cd javascript && \
     npm run test && \
     sha256sum olm.js olm_legacy.js olm.wasm > checksums.txt && \
     gpg -b -a -u F75FDC22C1DE8453 checksums.txt && \
     npm publish)

git tag $VERSION -s
git push --tags

# OLMKit CocoaPod release
# Make sure the version OLMKit.podspec is the same as the git tag
# (this must be checked before git tagging)
pod spec lint OLMKit.podspec --use-libraries --allow-warnings
pod trunk push OLMKit.podspec --use-libraries --allow-warnings
# Check the pod has been successully published with:
pod search OLMKit

Python and JavaScript packages are published to the registry at https://gitlab.matrix.org/matrix-org/olm/-/packages. The GitLab documentation contains instructions on how to set up twine (Python) and npm (JavaScript) to upload to the registry.

To publish the Android library to MavenCentral (you will need some secrets), in the /android folder:

  • Run the command ./gradlew clean build publish --no-daemon --no-parallel --stacktrace. The generated AAR must be approx 500 kb.
  • Connect to https://s01.oss.sonatype.org
  • Click on Staging Repositories and check the the files have been uploaded
  • Click on close
  • Wait (check Activity tab until step "Repository closed" is displayed)
  • Click on release. The staging repository will disappear
  • Check that the release is available in https://repo1.maven.org/maven2/org/matrix/android/olm-sdk/ (it can take a few minutes)


Olm is designed to be easy port to different platforms and to be easy to write bindings for.

It was originally implemented in C++, with a plain-C layer providing the public API. As development has progressed, it has become clear that C++ gives little advantage, and new functionality is being added in C, with C++ parts being rewritten as the need ariases.

Error Handling

All C functions in the API for olm return olm_error() on error. This makes it easy to check for error conditions within the language bindings.

Random Numbers

Olm doesn't generate random numbers itself. Instead the caller must provide the random data. This makes it easier to port the library to different platforms since the caller can use whatever cryptographic random number generator their platform provides.


Olm avoids calling malloc or allocating memory on the heap itself. Instead the library calculates how much memory will be needed to hold the output and the caller supplies a buffer of the appropriate size.

Output Encoding

Binary output is encoded as base64 so that languages that prefer unicode strings will find it easier to handle the output.


Olm uses pure C implementations of the cryptographic primitives used by the ratchet. While this decreases the performance it makes it much easier to compile the library for different architectures.


Please see CONTRIBUTING.md when making contributions to the library.

Security assessment

Olm 1.3.0 was independently assessed by NCC Group's Cryptography Services Practive in September 2016 to check for security issues: you can read all about it at https://www.nccgroup.com/globalassets/our-research/us/public-reports/2016/november/ncc_group_olm_cryptogrpahic_review_2016_11_01.pdf and https://matrix.org/blog/2016/11/21/matrixs-olm-end-to-end-encryption-security-assessment-released-and-implemented-cross-platform-on-riot-at-last/

Security issues

If you think you found a security issue in libolm, any of its bindings or the Olm/Megolm protocols, please follow our Security Disclosure Policy to report.

Bug reports

For non-sensitive bugs, please file bug reports at https://github.com/matrix-org/olm/issues.

What's an olm?

It's a really cool species of European troglodytic salamander. http://www.postojnska-jama.eu/en/come-and-visit-us/vivarium-proteus/

The software may be subject to the U.S. export control laws and regulations and by downloading the software the user certifies that he/she/it is authorized to do so in accordance with those export control laws and regulations.