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

4
An implementation of the Double Ratchet cryptographic ratchet described by
5
6
https://whispersystems.org/docs/specifications/doubleratchet/, written in C and
C++11 and exposed as a C API.
7

8
The specification of the Olm ratchet can be found in `<docs/olm.rst>`_.
Richard van der Hoff's avatar
Richard van der Hoff committed
9
10

This library also includes an implementation of the Megolm cryptographic
Richard van der Hoff's avatar
Richard van der Hoff committed
11
ratchet, as specified in `<docs/megolm.rst>`_.
Matthew Hodgson's avatar
Matthew Hodgson committed
12

13
14
15
Building
--------

16
To build olm as a shared library run:
17
18
19

.. code:: bash

Richard van der Hoff's avatar
Richard van der Hoff committed
20
    make
21
22
23
24
25

To run the tests run:

.. code:: bash

Richard van der Hoff's avatar
Richard van der Hoff committed
26
    make test
27

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

.. code:: bash

32
    make js
33

ylecollen's avatar
ylecollen committed
34
35
To build the android project for Android bindings, run:

36
37
38
39
.. code:: bash

    cd android
    ./gradlew clean assembleRelease
40

41
42
43
44
45
46
47
48
To build the Xcode workspace for Objective-C bindings, run:

.. code:: bash

    cd xcode
    pod install
    open OLMKit.xcworkspace

49
50
51
52
53
54
To build olm as a static library (which still needs libstdc++ dynamically) run:

.. code:: bash

    make static

55
56
Release process
---------------
57

58
First: bump version numbers in ``common.mk``, ``javascript/package.json``,
59
60
``OLMKit.podspec``, and ``android/olm-sdk/build.gradle`` (``versionCode``,
``versionName`` and ``version``).
61
62
63

Also, ensure the changelog is up to date, and that everyting is committed to
git.
64

65
66
67
68
It's probably sensible to do the above on a release branch (``release-vx.y.z``
by convention), and merge back to master once the release is complete.

.. code:: bash
Richard van der Hoff's avatar
Richard van der Hoff committed
69

70
    make clean
71
72

    # build and test C library
73
    make test
74
75

    # build and test JS wrapper
76
    make js
77
    (cd javascript && npm run test)
78
    npm pack javascript
79

80
    VERSION=x.y.z
81
    scp olm-$VERSION.tgz packages@ares.matrix.org:packages/npm/olm/
Mark Haines's avatar
Mark Haines committed
82
    git tag $VERSION -s
83
    git push --tags
84

85
86
    # OLMKit CocoaPod release
    # Make sure the version OLMKit.podspec is the same as the git tag
manuroe's avatar
manuroe committed
87
    # (this must be checked before git tagging)
88
89
90
91
92
    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

93

94
95
96
Design
------

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

Richard van der Hoff's avatar
Richard van der Hoff committed
100
101
102
103
104
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.

105
106
107
Error Handling
~~~~~~~~~~~~~~

108
All C functions in the API for olm return ``olm_error()`` on error.
109
110
111
112
113
This makes it easy to check for error conditions within the language bindings.

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

114
Olm doesn't generate random numbers itself. Instead the caller must
115
116
117
118
119
120
121
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
~~~~~~

122
Olm avoids calling malloc or allocating memory on the heap itself.
123
124
125
126
127
128
129
130
131
132
133
134
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
~~~~~~~~~~~~

135
Olm uses pure C implementations of the cryptographic primitives used by
136
137
the ratchet. While this decreases the performance it makes it much easier
to compile the library for different architectures.
138

Richard van der Hoff's avatar
Richard van der Hoff committed
139
140
141
142
Contributing
------------
Please see `<CONTRIBUTING.rst>`_ when making contributions to the library.

Matthew Hodgson's avatar
Matthew Hodgson committed
143
144
145
146
147
148
149
150
151
Security assessment
-------------------

Olm 1.3.0 was independently assessed by NCC Group's Cryptography Services
Practive in September 2016 to check for security issues: you can read all
about it at
https://www.nccgroup.trust/us/our-research/matrix-olm-cryptographic-review/
and https://matrix.org/blog/2016/11/21/matrixs-olm-end-to-end-encryption-security-assessment-released-and-implemented-cross-platform-on-riot-at-last/

Matthew Hodgson's avatar
Matthew Hodgson committed
152
153
154
155
Bug reports
-----------
Please file bug reports at https://github.com/matrix-org/olm/issues

156
What's an olm?
Richard van der Hoff's avatar
Richard van der Hoff committed
157
--------------
158
159

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

Legal Notice
Richard van der Hoff's avatar
Richard van der Hoff committed
163
------------
Matthew Hodgson's avatar
Matthew Hodgson committed
164
165
166
167
168

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.