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

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

38
39
40
41
.. code:: bash

    cd android
    ./gradlew clean assembleRelease
42

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

.. code:: bash

    cd xcode
    pod install
    open OLMKit.xcworkspace

51
52
Release process
---------------
53

54
55
56
57
58
First: bump version numbers in ``Makefile``, ``javascript/package.json``, and
``OLMKit.podspec``.

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

60
61
62
63
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
64
    make clean
65
66

    # build and test C library
67
    make test
68
69

    # build and test JS wrapper
70
    make js
71
    (cd javascript && npm run test)
72
    npm pack javascript
73

74
    VERSION=x.y.z
Mark Haines's avatar
Mark Haines committed
75
76
    scp olm-$VERSION.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/
    git tag $VERSION -s
77
    git push --tags
78

79
80
    # OLMKit CocoaPod release
    # Make sure the version OLMKit.podspec is the same as the git tag
manuroe's avatar
manuroe committed
81
    # (this must be checked before git tagging)
82
83
84
85
86
    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

87

88
89
90
Design
------

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

Richard van der Hoff's avatar
Richard van der Hoff committed
94
95
96
97
98
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.

99
100
101
Error Handling
~~~~~~~~~~~~~~

102
All C functions in the API for olm return ``olm_error()`` on error.
103
104
105
106
107
This makes it easy to check for error conditions within the language bindings.

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

108
Olm doesn't generate random numbers itself. Instead the caller must
109
110
111
112
113
114
115
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
~~~~~~

116
Olm avoids calling malloc or allocating memory on the heap itself.
117
118
119
120
121
122
123
124
125
126
127
128
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
~~~~~~~~~~~~

129
Olm uses pure C implementations of the cryptographic primitives used by
130
131
the ratchet. While this decreases the performance it makes it much easier
to compile the library for different architectures.
132
133

What's an olm?
Richard van der Hoff's avatar
Richard van der Hoff committed
134
--------------
135
136

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

Legal Notice
Richard van der Hoff's avatar
Richard van der Hoff committed
140
------------
Matthew Hodgson's avatar
Matthew Hodgson committed
141
142
143
144
145

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.