README.rst 3.52 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

Richard van der Hoff's avatar
Richard van der Hoff committed
8
9
10
11
12
13
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.
Matthew Hodgson's avatar
Matthew Hodgson committed
14

15
16
17
Building
--------

18
To build olm as a shared library run:
19
20
21

.. code:: bash

Richard van der Hoff's avatar
Richard van der Hoff committed
22
    make
23
24
25
26
27

To run the tests run:

.. code:: bash

Richard van der Hoff's avatar
Richard van der Hoff committed
28
    make test
29

Matthew Hodgson's avatar
Matthew Hodgson committed
30
To build the javascript bindings, install emscripten from http://kripken.github.io/emscripten-site/ and then run:
31
32
33

.. code:: bash

34
    make js
35

36
37
38
39
40
41
42
43
To build the Xcode workspace for Objective-C bindings, run:

.. code:: bash

    cd xcode
    pod install
    open OLMKit.xcworkspace

44
45
Release process
---------------
46

47
48
49
50
51
52
53
54
55
56
.. 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
Mark Haines's avatar
Mark Haines committed
57
58
    scp olm-$VERSION.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/
    git tag $VERSION -s
59
    git push --tags
60

61
62
    # OLMKit CocoaPod release
    # Make sure the version OLMKit.podspec is the same as the git tag
manuroe's avatar
manuroe committed
63
    # (this must be checked before git tagging)
64
65
66
67
68
    pod spec lint OLMKit.podspec --use-libraries --allow-warnings
    pod trunk push OLMKit.podspec --use-libraries --allow-warnings
    # Check the pod has been successully published with:
    pod search OLMKit

69
70
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.
71
72


73
74
75
Design
------

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

Richard van der Hoff's avatar
Richard van der Hoff committed
79
80
81
82
83
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.

84
85
86
Error Handling
~~~~~~~~~~~~~~

87
All C functions in the API for olm return ``olm_error()`` on error.
88
89
90
91
92
This makes it easy to check for error conditions within the language bindings.

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

93
Olm doesn't generate random numbers itself. Instead the caller must
94
95
96
97
98
99
100
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
~~~~~~

101
Olm avoids calling malloc or allocating memory on the heap itself.
102
103
104
105
106
107
108
109
110
111
112
113
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
~~~~~~~~~~~~

114
Olm uses pure C implementations of the cryptographic primitives used by
115
116
the ratchet. While this decreases the performance it makes it much easier
to compile the library for different architectures.
117
118

What's an olm?
Richard van der Hoff's avatar
Richard van der Hoff committed
119
--------------
120
121

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

Legal Notice
Richard van der Hoff's avatar
Richard van der Hoff committed
125
------------
Matthew Hodgson's avatar
Matthew Hodgson committed
126
127
128
129
130

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.