README.rst 2.87 KB
Newer Older
1
2
Olm
===
3

4
5
6
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.
7

Matthew Hodgson's avatar
Matthew Hodgson committed
8
9
10
The specification of the Olm ratchet can be found in docs/olm.rst or
https://matrix.org/docs/spec/olm.html

11
12
13
Building
--------

14
To build olm as a shared library run:
15
16
17

.. code:: bash

Richard van der Hoff's avatar
Richard van der Hoff committed
18
    make
19
20
21
22
23

To run the tests run:

.. code:: bash

Richard van der Hoff's avatar
Richard van der Hoff committed
24
    make test
25

Matthew Hodgson's avatar
Matthew Hodgson committed
26
To build the javascript bindings, install emscripten from http://kripken.github.io/emscripten-site/ and then run:
27
28
29

.. code:: bash

30
    make js
31

32
33
Release process
---------------
34

35
36
37
38
39
40
41
42
43
44
45
46
47
.. 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
    git push --tags
48
49
50

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.
51
52


53
54
55
Design
------

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

Richard van der Hoff's avatar
Richard van der Hoff committed
59
60
61
62
63
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.

64
65
66
Error Handling
~~~~~~~~~~~~~~

67
All C functions in the API for olm return ``olm_error()`` on error.
68
69
70
71
72
This makes it easy to check for error conditions within the language bindings.

Random Numbers
~~~~~~~~~~~~~~

73
Olm doesn't generate random numbers itself. Instead the caller must
74
75
76
77
78
79
80
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
~~~~~~

81
Olm avoids calling malloc or allocating memory on the heap itself.
82
83
84
85
86
87
88
89
90
91
92
93
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
~~~~~~~~~~~~

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

What's an olm?
Richard van der Hoff's avatar
Richard van der Hoff committed
99
--------------
100
101

It's a really cool species of European troglodytic salamander.
Matthew Hodgson's avatar
Matthew Hodgson committed
102
http://www.postojnska-jama.eu/en/come-and-visit-us/vivarium-proteus/
Matthew Hodgson's avatar
Matthew Hodgson committed
103
104

Legal Notice
Richard van der Hoff's avatar
Richard van der Hoff committed
105
------------
Matthew Hodgson's avatar
Matthew Hodgson committed
106
107
108
109
110

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.