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

Matthew Hodgson's avatar
Matthew Hodgson committed
4
An implementation of the cryptographic ratchet described by
Matthew Hodgson's avatar
Matthew Hodgson committed
5
https://github.com/trevp/axolotl/wiki, written in C++11 and exposed as a C API
6

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

10
11
12
Building
--------

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

.. code:: bash

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

To run the tests run:

.. code:: bash

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

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

.. code:: bash

29
    make js
30

31
32
Release process
---------------
33

34
35
36
37
38
39
40
41
42
43
44
45
# Bump version numbers in ``Makefile`` and ``javascript/package.json``
# Prepare changelog
# ``git commit``
# ``make test``
# ``make js``
# ``npm pack javascript``
# ``scp olm-x.y.z.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/``
# ``git tag x.y.z``
# ``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.
46
47


48
49
50
Design
------

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

Richard van der Hoff's avatar
Richard van der Hoff committed
54
55
56
57
58
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.

59
60
61
Error Handling
~~~~~~~~~~~~~~

62
All C functions in the API for olm return ``olm_error()`` on error.
63
64
65
66
67
This makes it easy to check for error conditions within the language bindings.

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

68
Olm doesn't generate random numbers itself. Instead the caller must
69
70
71
72
73
74
75
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
~~~~~~

76
Olm avoids calling malloc or allocating memory on the heap itself.
77
78
79
80
81
82
83
84
85
86
87
88
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
~~~~~~~~~~~~

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

What's an olm?
Richard van der Hoff's avatar
Richard van der Hoff committed
94
--------------
95
96

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

Legal Notice
Richard van der Hoff's avatar
Richard van der Hoff committed
100
------------
Matthew Hodgson's avatar
Matthew Hodgson committed
101
102
103
104
105

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.