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

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
Release process
---------------
51

52
53
54
55
56
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.
57

58
59
60
61
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
62

63
    make clean
64
65

    # build and test C library
66
    make test
67
68

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

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

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

86

87
88
89
Design
------

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

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

98
99
100
Error Handling
~~~~~~~~~~~~~~

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

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

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

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

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

Richard van der Hoff's avatar
Richard van der Hoff committed
132
133
134
135
Contributing
------------
Please see `<CONTRIBUTING.rst>`_ when making contributions to the library.

136
What's an olm?
Richard van der Hoff's avatar
Richard van der Hoff committed
137
--------------
138
139

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

Legal Notice
Richard van der Hoff's avatar
Richard van der Hoff committed
143
------------
Matthew Hodgson's avatar
Matthew Hodgson committed
144
145
146
147
148

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.