9.5 KiB
NaCl (pronounced "salt") is a new easy-to-use high-speed software library for network communication, encryption, decryption, signatures, etc.
NaCl's goal is to provide all of the core operations needed to build higher-level cryptographic tools.
Sodium is a portable, cross-compilable, installable, packageable fork of NaCl (based on the latest released upstream version nacl-20110221), with a compatible API.
Is it full of NSA backdoors?
The design of Sodium's primitives is completely free from NIST (and by association, NSA) influence, with the following minor exceptions:
- The Poly1305 MAC, used for authenticating integrity of ciphertexts, uses AES as a replaceable component,
- The Ed25519 digital signature algorithm uses SHA-512 for both key derivation and computing message digests,
- APIs are provided to SHA-512 and SHA-512/256, but are replaceable by the Blake2 hash function, which the Sodium library also provides.
The design choices, particularly in regard to the Curve25519 Diffie-Hellman function, emphasize security (whereas NIST curves emphasize "performance" at the cost of security), and "magic constants" in NaCl/Sodium are picked by theorems designed to maximize security.
The same cannot be said of NIST curves, where the specific origins of certain constants are not described by the standards and may be subject to malicious influence by the NSA.
And despite the emphasis on higher security, primitives are faster across-the-board than most implementations of the NIST standards.
Portability
In order to pick the fastest working implementation of each primitive, NaCl performs tests and benchmarks at compile-time. Unfortunately, the resulting library is not guaranteed to work on different hardware.
Sodium performs tests at run-time, so that the same binary package can still run everywhere.
Sodium is tested on a variety of compilers and operating systems, including Windows (with MingW or Visual Studio, x86 and x64), iOS and Android.
Installation
Sodium is a shared library with a machine-independent set of headers, so that it can easily be used by 3rd party projects.
The library is built using autotools, making it easy to package.
Installation is trivial, and both compilation and testing can take advantage of multiple CPU cores.
Download a tarball of libsodium, then follow the ritual:
./configure
make && make check && make install
Pre-compiled Win32 packages are available for download at the same location.
Integrity of source tarballs can currently be checked using PGP or
verified DNS queries (dig +dnssec +short txt <file>.download.libsodium.org
returns the SHA256 of any file available for download).
Pre-built binaries
Pre-built libraries for Visual studio 2010, 2012 and 2013, both for x86 and x64, are available for download at https://download.libsodium.org/libsodium/releases/ , courtesy of Samuel Neves (@sneves).
Comparison with vanilla NaCl
Sodium does not ship C++ bindings. These might be part of a distinct package.
The default public-key signature system in NaCl was a prototype that shouldn't be used any more.
Sodium ships with the SUPERCOP reference implementation of
Ed25519, and uses this system by default
for crypto_sign*
operations.
For backward compatibility, the previous system is still compiled in,
as crypto_sign_edwards25519sha512batch*
.
Additional features
The Sodium library provides some convenience functions in order to retrieve the current version of the package and of the shared library:
const char *sodium_version_string(void);
const int sodium_library_version_major(void);
const int sodium_library_version_minor(void);
Headers are installed in ${prefix}/include/sodium
.
A convenience header includes everything you need to use the library:
#include <sodium.h>
This is not required, however, before any other libsodium function, you can call:
sodium_init();
This will pick optimized implementations of some primitives, if they appear to work as expected after running some tests, and these will be used for subsequent operations. It only need to be called once.
This function is not thread-safe. No other Sodium functions should be
called until it successfully returns. In a multithreading environment,
if, for some reason, you really need to call sodium_init()
while some
other Sodium functions may be running in different threads, add locks
accordingly (both around sodium_init()
and around other functions).
Sodium also provides helper functions to generate random numbers,
leveraging /dev/urandom
or /dev/random
on *nix and the cryptographic
service provider on Windows. The interface is similar to
arc4random(3)
. It is fork(2)
-safe but not thread-safe. This holds
true for crypto_sign_keypair()
and crypto_box_keypair()
as well.
uint32_t randombytes_random(void);
Return a random 32-bit unsigned value.
void randombytes_stir(void);
Generate a new key for the pseudorandom number generator. The file descriptor for the entropy source is kept open, so that the generator can be reseeded even in a chroot() jail.
uint32_t randombytes_uniform(const uint32_t upper_bound);
Return a value between 0 and upper_bound using a uniform distribution.
void randombytes_buf(void * const buf, const size_t size);
Fill the buffer buf
with size
random bytes.
int randombytes_close(void);
Close the file descriptor or the handle for the cryptographic service provider.
A custom implementation of these functions can be registered with
randombytes_set_implementation()
.
In addition, Sodium provides a function to securely wipe a memory region:
void sodium_memzero(void * const pnt, const size_t size);
Warning: if a region has been allocated on the heap, you still have
to make sure that it can't get swapped to disk, possibly using
mlock(2)
.
In order to compare memory zones in constant time, Sodium provides:
int sodium_memcmp(const void * const b1_, const void * const b2_,
size_t size);
sodium_memcmp()
returns 0
if size
bytes at b1_
and b2_
are
equal, another value if they are not. Unlike memcmp()
,
sodium_memcmp()
cannot be used to put b1_
and b2_
into a defined
order.
And a convenience function for converting a binary buffer to a hexadecimal string:
char * sodium_bin2hex(char * const hex, const size_t hexlen,
const unsigned char *bin, const size_t binlen);
New operations
crypto_shorthash
A lot of applications and programming language implementations have been recently found to be vulnerable to denial-of-service attacks when a hash function with weak security guarantees, like Murmurhash 3, was used to construct a hash table.
In order to address this, Sodium provides the “shorthash” function, currently implemented using SipHash-2-4. This very fast hash function outputs short, but unpredictable (without knowing the secret key) values suitable for picking a list in a hash table for a given key.
See crypto_shorthash.h
for details.
crypto_generichash
This hash function provides:
- A variable output length (up to
crypto_generichash_BYTES_MAX
bytes) - A variable key length (from no key at all to
crypto_generichash_KEYBYTES_MAX
bytes) - A simple interface as well as a streaming interface.
crypto_generichash
is currently being implemented using
Blake2.
Constants available as functions
In addition to constants for key sizes, output sizes and block sizes, Sodium provides these values through function calls, so that using them from different languages is easier.
Bindings for other languages
- Erlang: Erlang-NaCl
- Erlang: Salt
- Haskell: Saltine
- Idris: Idris-Sodium
- Java: Kalium
- Java JNI: Kalium-JNI
- Julia: Sodium.jl
- .NET: libsodium-net
- Ocaml: ocaml-sodium
- Pharo/Squeak: Crypto-NaCl
- PHP: PHP-Sodium
- Python: PyNaCl
- Python: PySodium
- Racket: part of CRESTaceans
- Ruby: RbNaCl
- Ruby: Sodium
CurveCP
CurveCP tools are part of a different project, libchloride. If you are interested in an embeddable CurveCP implementation, take a look at libcurvecpr.
Mailing list
A mailing-list is available to discuss libsodium.
In order to join, just send a random mail to sodium-subscribe
{at}
pureftpd
{dot}org
.
License
See the COPYING
file for details, AUTHORS
for designers and
implementors, and THANKS
for contributors.