Implementation of the olm and megolm cryptographic ratchets
Find a file
Matthew Hodgson 22f370c5cd add legalese
2015-10-05 14:21:08 +01:00
docs typo 2015-08-24 10:29:35 +01:00
include/olm Add docstrings for the utility class 2015-08-20 10:08:15 +01:00
javascript Add sha256 and ed25519_verify methods to javascript bindings 2015-08-04 11:55:04 +01:00
lib Add functions for signing and verifying messages using curve25519 keys 2015-03-03 11:18:07 +00:00
python Add method getting a session id. Update the python and javascript bindings 2015-07-16 11:45:20 +01:00
src 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
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 Add gdb script and psuedo-call graph generator python script for tracing calls to crypto primitives 2015-06-21 18:47:06 +01:00
.gitignore add a gitignore 2015-02-26 16:58:08 +00:00
build_shared_library.py Get build_shared_library to compile at -O3 instead of -O0 2015-07-15 13:40:32 +01:00
LICENSE Copyright notices and a license 2015-02-26 16:56:25 +00:00
README.rst add legalese 2015-10-05 14:21:08 +01:00
test.py Add methods for pickling and unpickling sessions 2015-06-09 18:03:01 +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

    ./build_shared_library.py

To run the tests run:

.. code:: bash

   ./test.py


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

.. code:: bash

    javascript/build.py

Design
------

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

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.
Matthew once tried to climb into a pool full of them in Postojnska Jama.
http://www.postojnska-jama.eu/en/about-the-cave/meet-the-dragon-s-offspring/

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.