Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
matrix-org
Olm
Commits
86d0b80b
Commit
86d0b80b
authored
Jun 26, 2015
by
Mark Haines
Browse files
Add a README explaining how to build the library
parent
8b29bd41
Changes
1
Show whitespace changes
Inline
Side-by-side
README.rst
0 → 100644
View file @
86d0b80b
Axolotlpp
=========
An implementation of the axolotl ratchet written in C++11 and exposed as a C
API.
Building
--------
To build axolotlpp as a shared library run:
.. code:: bash
./build_shared_library.py
To run the tests run:
.. code:: bash
./test.py
To build the javascript bindings run:
.. code:: bash
javascript/build.py
Design
------
Axolotlpp is designed to be easy port to different platforms and to be easy
to write bindings for.
Error Handling
~~~~~~~~~~~~~~
All C functions in the API for axolotlpp return ``axolotl_error()`` on error.
This makes it easy to check for error conditions within the language bindings.
Random Numbers
~~~~~~~~~~~~~~
Axolotlpp doesn't generate random numbers itself. Instead the caller must
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
~~~~~~
Axolotlpp avoids calling malloc or allocating memory on the heap itself.
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
~~~~~~~~~~~~
Axolotlpp uses pure C implementations of the cryptographic primitives used by
the ratchet. While this decreases the performance it makes it much easier
to compile the library for different architectures.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment