QPQ-AG/enacl
10
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tune the README.md file a bit.

Browse Source
This commit is contained in:
Jesper Louis Andersen 2014-11-18 23:22:41 +01:00
parent 9a7f4c8d4e
commit bb9179f401
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -3,8 +3,13 @@
This library provides bindings for the NaCl cryptographic library for Erlang. Several such libraries exist, but this one is a re-write with a number of different requirements, and foci:
* Erlang/OTP 17.3. This library *needs* the newest dirty scheduler implementation.
* Uses the original NaCl sources over something like libsodium. This is a deliberate choice.
* Uses the libsodium sources. This is a deliberate choice, since it is easy to implement.
* Does not provide anything but the original NaCl code base. This is also a deliberate choice so we are not in a situation where we can't jump to a newer version of the library later at some point.
* Tests created by aggressive use of Erlang QuickCheck.
* provides gen_nacl, a gen_tcp wrapper for sending/receiving messages over a tcp socket.
This package draws heavy inspiration from "erlang-nacl" by Tony Garnock-Jones.
# Rationale
Doing crypto right in Erlang is not that easy. The obvious way to handle this is by the use of NIF implementations, but most C code will run to its conclusion once set off for processing. This is a major problem for a system which needs to keep its latency safe. The solution taken by this library is to use the new Dirty Scheduler API of Erlang in order to provide a safe way to handle the long-running cryptographic processing. It keeps the cryptographic primitives on the dirty schedulers and thus it avoids the major problem.