Implementation of the olm and megolm cryptographic ratchets
Find a file
2016-05-23 18:03:32 +01:00
docs Correct a couple of errors in the spec 2016-05-18 18:17:29 +01:00
include/olm Remove functions which return strings 2016-05-20 15:07:10 +01:00
javascript Add support for building the JS wrappers to the Makefile 2016-05-20 15:15:40 +01:00
lib Use header files where possible 2015-12-03 17:08:04 +00:00
python Refactor python wrappers 2016-05-20 15:25:43 +01:00
src crypto.cpp: Fix comments 2016-05-20 15:37:33 +01:00
tests Replace hard coded references to the 32-byte key length with a constant, add utilities for copying data to and from fixed sized arrays 2015-08-19 17:32: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 Document process for building npm package 2015-12-03 15:46:11 +00:00
LICENSE Copyright notices and a license 2015-02-26 16:56:25 +00:00
Makefile Fix make clean to remove the library and all the .d files 2016-05-23 16:35:34 +01:00
README.rst Add support for building the JS wrappers to the Makefile 2016-05-20 15:15:40 +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 cryptographic ratchet described by
https://github.com/trevp/axolotl/wiki, written in 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

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
    npm pack javascript  # packages olm.js into olm-x.y.z.tgz

Remember to make a tag after releasing a tarball:

.. code:: bash

    git tag x.y.z
    git push --tags

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.