Implementation of the olm and megolm cryptographic ratchets
Find a file
Richard van der Hoff d8136096c0 Merge pull request #33 from matrix-org/rav/pickle_length
Return the base64-encoded length of pickles
2016-10-24 10:43:43 +01:00
docs Spelling 2016-10-21 17:07:26 +01:00
fuzzers Add a README for the fuzzers 2016-10-19 14:59:50 +01:00
include/olm Clear random buf in olm_init_outbound_group_session 2016-10-21 17:19:59 +01:00
javascript Return the message index when decrypting group messages. 2016-10-20 09:58:55 +01:00
lib Fix Ed25519 keypair generation 2016-09-01 13:35:23 +01:00
python Merge pull request #31 from matrix-org/markjh/groupmessageindex 2016-10-21 09:57:42 +01:00
src Return the base64-encoded length of pickles 2016-10-24 10:06:06 +01:00
tests Return the base64-encoded length of pickles 2016-10-24 10:06:06 +01: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
.gitignore First stab at a megolm spec 2016-09-22 11:04:19 +01:00
CHANGELOG.rst Changelog and version bump for 1.3.0 2016-09-14 13:55:54 +01:00
jenkins.sh Fix jenkins.sh 2016-09-16 17:34:21 +01:00
LICENSE Copyright notices and a license 2015-02-26 16:56:25 +00:00
Makefile Makefile: install-headers is phony 2016-09-23 12:22:34 +01:00
README.rst Link to the megolm spec 2016-10-19 19:14:18 +01:00
version_script.ver Use a version script to restrict symbols in the .so 2016-05-20 15:15:40 +01:00

Olm
===

An implementation of the Double Ratchet cryptographic ratchet described by
https://github.com/trevp/double_ratchet/wiki, written in C and C++11 and
exposed as a C API.

The specification of the Olm ratchet can be found in ``docs/olm.rst`` or
https://matrix.org/docs/spec/olm.html.

This library also includes an implementation of the Megolm cryptographic
ratchet, as specified in ``docs/megolm.rst`` or
https://matrix.org/docs/spec/megolm.html.

Building
--------

To build olm as a shared library run:

.. code:: bash

    make

To run the tests run:

.. code:: bash

    make test

To build the javascript bindings, install emscripten from http://kripken.github.io/emscripten-site/ and then run:

.. code:: bash

    make js

Release process
---------------

.. code:: bash

    # Bump version numbers in ``Makefile`` and ``javascript/package.json``
    # Prepare changelog
    git commit
    make clean
    make test
    make js
    npm pack javascript
    VERSION=x.y.z
    scp olm-$VERSION.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/
    git tag $VERSION -s
    git push --tags

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


Design
------

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.

Memory
~~~~~~

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.

Dependencies
~~~~~~~~~~~~

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.

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/

Legal Notice
------------

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.